codoxify

Use codox to build Clojure documentation for docsify

Usage

Follow the installation instructions and usage for codox

Add codoxify as a dependency to your project.clj:

:profiles {:codox {:dependencies [[wavejumper/codoxify "1.0.2"]]
:plugins [[lein-codox "0.10.7"]]
:codox {:writer codoxify.writer/write-docs}}}

Without any extra configuration, this will compile your documentation to target/docs

npx docsify init ./target/docs
npx docsify serve ./target/docs
lein with-profiles +codox codox

docsify configuration

Edit ./target/docs/index.html and configure docsify as such:

window.$docsify={loadSidebar: true,subMaxLevel: 3,// importantloadNavbar: true,alias: {'sidebar.md': '/_sidebar.md'//important}}

Example

An example of the ring project generated with codoxify can be found here