Deploying to GitHub Pages - weavejester/codox GitHub Wiki

The Github Pages feature is an excellent way to share codox documentation with your users.

  1. Set the :output-path in your project file to "codox"
  2. Add /codox to your project's .gitignore file.
  3. Inside your project directory, run the following commands:
rm -rf codox && mkdir codox
git clone [email protected]:<user-name>/<project-name>.git codox
cd codox
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
cd ..
  1. Build your documentation with lein codox.
  2. To publish your docs to Github Pages, run the following commands:
cd codox
git add .
git commit -am "Add project documentation"
git push -u origin gh-pages
cd ..

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

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️