The site is generated from the AsciiDoc files in thedoc folder of nREPL’s GitHub repo and is published tohttps://docs.cider.mx.Antora is used to convert the manual into HTML.The filesystem layout is described athttps://docs.antora.org/antora/3.1/component-structure/

To make changes to the manual you simply have to change the files underdoc.The manual will be regenerated manually periodically.

Installing the Antora is super simple:

Check outthe detailed installation instructionsif you run into any problems.

You can build the documentation locally from this repo.

To check the generated site you can simply openbuild/site/index.html in your favourite browser.

The site is automatically deployed to GitHub pages using a GitHub Action.The action will be triggered by any push to themaster branch.It can also be triggered manually if needed.

If you prefer not to install Antora on your local machine, you can build the documentationinside a Docker container like this:

Note that despite the message sayingOpen file:///antora/build/site/index.html in a browser to view your site., youyou should actually look forbuild/site/index.html in the current directory. (that’s because we’ve mounted thecurrent directory as/antora in the container)

When cutting new releases you’ll have to updatedantora-playbook.yml to mentiontheir relevant tags from which the documentation needs to be build. Here’s how thislooks for one of the projects:

The most common mistake that people make is to forget to update the version of an Antora docs moduleafter cutting a release. This will result in an error saying you’ve got the same version in two branches (e.g.masterandv1.0). Fixing this is pretty simple - just update the version tomaster inantora.yml.