Den of Clojure: Community Docs

Contributing

General

This site is built on GitHub Pages hosting solution, and uses Jekyll.

Jekyll is a static website generator. It is a somewhat complex piece of software with its own comprehensive documentation.

GitHub Pages has great documentation, the most relevant of which to this site is probably “Using Jekyll with Pages”.

Local setup

You need some Ruby basics. There’s a million ways to do this, but in general you must:

  • Install Ruby >= 2.0.0
  • Install the Bundler gem
  • Run bundle install

If you use RVM or rbenv, there are .ruby-version and .ruby-gemset files in the project root.

To compile and view the site locally, run

bundle exec jekyll serve

then view the site at localhost:4000/community-docs.

Guidelines

  • Fork the repository, check out the gh-pages branch, edit, commit, push, and issue a PR!
  • The front matter YAML section is required.
  • Think about page URLs and use the permalink setting in the front matter if the default URL isn’t appropriate.
  • Den of Clojure members have commit rights for the repository. If you are not a member of the group please just contact one of the owners, who will add you.