Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.04 KB

README.adoc

File metadata and controls

28 lines (17 loc) · 1.04 KB
Raw

XTDB Documentation

We use Antora to build the XTDB documentation.

The full website build/deploy is available (to JUXTers) in the private website 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

    • Troubleshooting: npm install

  • ./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 main branch. These are located by branch name convention - branches prefixed with docs-v* will be included.

Release checklist:

To follow the docs release checklist, please read RELEASING.adoc