These instructions assume a UNIX-like (OSX in particular) OS.
You should be able to get a local rendering system going to preview your edits by following these instructions:
xcodeselect --install
.brew install ruby
Then you should be able to:
$ cd docs
$ bundle install
$ bundle exec jekyll serve --incremental
and then use the URL it gives you. It will recompile on save, but you have to reload the browser page to see changes.
Do edits on the develop
branch unless it is some kind of hot fix (in
which case you should use git flow hotfix).
The live website is auto-generated from the current master
. So, merging
and pushing to master will update the website.
Remember to update the live tutorial javascript in the Tutorial project!
$ lein do clean, cljsbuild once tutorial-live
and copy the result to docs/js/tutorial.js
. You should run through some of the
live pages to check it is ok:
$ cd docs
$ open tutorial.html
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close