Skip to content

Apiman's Antora playbooks for generating our documentation from Asciidoc. The Apiman docs website is generated & hosted here, also.

Notifications You must be signed in to change notification settings

apiman/apiman-docs

Repository files navigation

Apiman docs website & Antora playbook

This is where we generate our documentation using the wonderful Antora documentation website generator.

The actual documentation is stored in other repositories. This is where we maintain our Antora Playbook which pulls in the documentation sources from our various docs repos and generates the HTML for GitHub Pages.

To build the docs, you can run:

npm ci
# If you had a docs directory generated previously you want to clobber
rm -fr docs
# Use the locally installed version of Antora
npx antora generate --fetch --stacktrace antora-playbook.yml

Now you should see the website pop out in the docs directory, and you can open it in your browser of choice.

About

Apiman's Antora playbooks for generating our documentation from Asciidoc. The Apiman docs website is generated & hosted here, also.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published