Getting Started

Prerequisites

  • Python 3.10 or newer
  • pip

Install

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Run locally

mkdocs serve

MkDocs serves the site locally and reloads when content changes.

Build

mkdocs build

The compiled static site is written to site/.