Skip to content

MkDocs

mkdocs is used to build this documentation.

Installation

  1. Install python31

    sudo apt-get update
sudo apt-get install python3.8 python3-pip

  2. Install mkdocs and plugins via pip32

    pip3 install mkdocs mkdocs-material mkdocs-minify-plugin mkdocs-redirects

Commands

Create a new project

mkdocs new [dir-name]

Start the live-reloading docs server

mkdocs serve

Build the documentation site

mkdocs build

Print this help message

mkdocs help

Project layout

mkdocs.yml                 # The configuration file.
docs/
   content/
      index.md             # The documentation homepage.
         ...               # Other markdown pages, images and other files.
      blog/                # Blog-like entries (with date, author, ...)
         assets/
         posts/
      developers/
      users/
   overrides/              # Theme overrides
docs_includes/             # Need to stay outside "docs"

  1. see https://realpython.com/installing-python/ ↩

  2. do not use unmaintained apt packages ↩