nREPL's official site
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update site docs Feb 7, 2019
supplemental-ui Add some navbar items Jan 9, 2019
.gitignore
README.adoc Mention the deploy script Jan 9, 2019
antora Autocreate .nojekyll after running antora Oct 7, 2018
deploy Mention the deploy script Jan 9, 2019
package-lock.json antora: 1.1.1 -> 2.0.x Feb 5, 2019
package.json antora: 1.1.1 -> 2.0.x Feb 5, 2019
site.yml

README.adoc

nREPL.org

The site is generated from the asciidoc files in the doc folder of nREPL’s GitHub repo and is published to https://nrepl.org. Antora is used to convert the manual into HTML. The filesystem layout is described at https://docs.antora.org/antora/1.1/component-structure/

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

You can build the documentation locally from the nrepl.org repo.

$ cd nrepl.org
$ npm install
$ ./antora site.yml
Tip
If npm install fails, see Antora’s troubleshooting documentation.

After you’re done with the initial setup you can use the deploy script to push changes to the site:

./deploy
Note
You’ll need commit access to the repository for this to work.

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

If you want to make changes to the manual’s page structure you’ll have to edit nav.adoc.