pmaports/docs
2025-09-25 19:55:30 +00:00
..
modules/ROOT docs/device-categorization: avoid nesting and repetions 2025-09-25 19:55:30 +00:00
antora.yml docs: initial documentation for pmaports 2025-09-24 12:37:31 +02:00
README.md docs: initial documentation for pmaports 2025-09-24 12:37:31 +02:00

pmaports docs

This is part of the postmarketOS handbook. The documentation is built using Antora since it allows pulling information from different repositories, which is a great benefit on a distributed project like ours. To build the documentation locally install nodejs and npm from your favorite package manager, and from the top folder of the repository run:

npm install antora
npx antora --clean antora-test.yml

After running the commands Antora should print the location of the generated documentation.

Alternatively, you can use pmbootstrap ci build-docs.