quine-global-labs/mirror-cockpit-project-cockpit
1
0
Fork 0
mirror of https://github.com/cockpit-project/cockpit.git synced 2026-11-03 21:49:50 -09:00
Code Issues Projects Releases Packages Wiki Activity

README: Add Antora preview commands

Browse source 
To preview Antora on this repo is just a few commands, lets add it to
the doc README so it makes it easier to work with.

Signed-off-by: Freya Gustavsson <freya@venefilyn.se>
This commit is contained in:
Freya Gustavsson 2026-06-26 15:34:35 +02:00
parent ad404ae3f2
commit 7127825f31
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/README.md
View file

@ -25,3 +25,21 @@ Since Antora is a versatile documentation tool, they have structured directories
> Antora assigns preset, content-specific behavior to the source files stored in the family directories.
https://docs.antora.org/antora/latest/family-directories/
## Local testing
We do not need to run Antora from cockpit-docs repo to make updates here, instead you can run Antora from NPM to compile it, then simply open the output or run a http server.
With NPM
```
npm exec antora generate antora-playbook.yml
```
With PNPM
```
pnpx antora generate antora-playbook.yml
```
You'll get an output for site generation completed followed by a file to open. If you run Flatpak you might have to run a simple server instead
```
python -m http.server -d ./doc/output/antora
```