Repository files navigation

Armbian Documentation serves as the central knowledge base for the entire Armbian ecosystem. It covers everything from theArmbian OS andarmbian-config utility tosoftware modules and theArmbian build framework. Whether you're installing Armbian for the first time, configuring advanced features, or building custom images from source, the documentation provides step-by-step guides, best practices, and technical references to support both beginners and experienced developers.

You can contribute to Armbian Documentation directly onGitHub by editing or submitting pull requests.
However, toenjoy a fully rendered local preview with proper styling and live reload, we recommend setting up the documentation site locally usingmkdocs.

sudo apt-get updatesudo apt-get install python3 python3-pip python3-venv python3.12-dev

If using Debian, you may need to install the following packages formkdocs-material:

sudo apt-get install libcairo2 pango1.0-tools

Next, clone the Armbian documentation repository:

git clone https://github.com/armbian/documentationcd documentation

Set up a Python virtual environment to isolate the project dependencies:

python3 -m venv .venvsource .venv/bin/activatepip install --use-pep517 -r requirements.txt

To preview the documentation locally:

mkdocs build --cleanmkdocs serve -a 0.0.0.0:8000

Then open your browser and go tohttp://localhost:8000The site will automatically reload when you make changes to .md files.

💡 Tip: Use the local preview to verify formatting and layout before committing your changes.