Documentation is written in markdown and stored in the
docs/ subfolder. Images go in
This repo is meant for storing and quick glances. Official output is https://docs.armbian.com.
Armbian Documentation is available in the following formats:
Armbian Documentation naming of document files follows this rules:
Child-Topic-Name are separated by an underscore
- are automatically converted to space.
Please try to avoid creating new parent topics unless absolutely necessary.
Current Parent Topics:
- User Guide
- Hardware notes
- Developer Guide
- Contributor Process
- Release management
See the document template before you writing any content.
Working on the content
git clone https://github.com/armbian/documentation pip install -r requirements.txt mkdocs build --clean && mkdocs serve
You will be able to make edits to existing files and observe the results in real time.
After changing text in an existing file, use this command to rebuild and view the documentation:
mkdocs build --clean && mkdocs serve
After adding a new file, either hand-edit
mkdocs.yml, or re-run
tools/mkArmbianDocs.py unless making changes to the structure of the
docs/ folder. (See below)
mkdocs.yml based on the contents of
- Command-line options for input and output directories
- Requires install requirement
- You don't need to run it every time unless making changes to the structure of the
mkArmbianDocs.py -hfor help
From the parent folder of the repo, run:
python3 tools/mkArmbianDocs.py && mkdocs build
This will generate the
mkdocs.yml and publish built HTML to the