https://github.com/apiman/apiman-docs

Apiman's Antora playbooks for generating our documentation from Asciidoc. The Apiman docs website is generated & hosted here, also.
https://github.com/apiman/apiman-docs

Last synced: over 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/apiman/apiman-docs
• Owner: apiman
• Created: 2021-06-14T13:51:48.000Z (about 5 years ago)
• Default Branch: antora
• Last Pushed: 2023-11-13T10:59:40.000Z (over 2 years ago)
• Last Synced: 2025-03-25T08:38:11.581Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 5.3 MB
• Stars: 0
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

          
= Apiman docs website & Antora playbook

This is where we generate our https://www.apiman.io/apiman-docs/[documentation^] using the https://antora.org/[wonderful Antora documentation website generator^].

The actual documentation is stored in other repositories. 

This is where we maintain our link:antora-playbook.yml[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:

```bash

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.