Liking cljdoc? Tell your friends :D

Crux Documentation

We use Antora to build the Crux documentation.

The full website build/deploy is available (to JUXTers) in the private crux-site repo - for more details, see the README over there.

From here, though, you can build the documentation section in isolation, to check any changes.

Install:

  • Requires Node/NPM installed.

Build:

  • ./bin/build.sh

  • ./bin/open-local-site.sh to open up the built version of the site in your browser.

  • ./bin/run-local-server.sh to open the site if you require plugins (like Dark Reader) which work poorly with file:// URLs.

Versions:

The documentation site includes documentation for previous releases as well as the current master branch. These are located by branch name convention - branches prefixed with docs-v* will be included.

Release checklist:

  1. Create a docs-v<new-version> branch

  2. Update docs/reference/antora.yml:

    1. Delete prerelease: indeed and display-version: master lines

    2. Update version: master to version: <new-version>

  3. Commit, push branch to the main JUXT Crux repo

  4. Head over to crux-site to deploy the docs.

about-nav❯

Can you improve this documentation? These fine people already did:
James Henderson, Dan Mason, Steven Deobald & Jeremy TaylorEdit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close