Building documentation

<- back to README.md

This repo uses MkDocs with Material theme to build the website version of documentation.

Documentation can be build locally through a rather simple process described below.

Important

Building documentation website is entirely optional, all docs are made to work locally as regular markdown files connected through relative links. Building it as a website does, however, provide a nicer experience.

Installing dependencies

python3 can be downloaded from the official website or using a package manager:

sudo apt update &&
sudo apt install python3

To install necessary dependencies run:

pip install mkdocs-material &&
pip install mkdocs-material[imaging] &&
pip install markdown-callouts &&
pip install mkdocs-awesome-nav

Note

When building for public deployment, social preview plugin also requires Cairo Graphics libraries. These libraries come preinstalled on Github Actions (Ubuntu), otherwise they can be manually downloaded with apt.

Building the docs

To build documentation locally navigate to the project directory and run:

mkdocs serve

The link to open local documentation in the browser will appear in the terminal after the build.