Deploying to GitHub Pages

The Github Pages feature is an excellent way to share codox documentation with your users. Get started with the following steps:

1. Add codox to your project's .gitignore file.
2. Inside your project directory, run the following commands:

rm -rf codox && mkdir codox
git clone git@github.com:<user-name>/<project-name>.git codox
cd codox
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
cd ..

3. Build your documentation with lein codox.
4. To publish your docs to Github Pages, run the following commands:

cd codox
git checkout gh-pages # To be sure you're on the right branch
git add .
git commit -am "new documentation push."
git push -u origin gh-pages
cd ..

That's it! Your documentation should appear within minutes at http://<user-name>.github.com/<project-name>.