MkDocs

How-to Guide

Download for Local Development

Install mkdocs and mkdocs-material on Ubuntu-like systems from the command line, e.g.,

sudo apt install mkdocs
pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-exclude-search

or on Windows with Chocolatey by:

choco install mkdocs
pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-exclude-search

Run the Local Development Server

Run in a terminal:

mkdocs serve

After the initialisation is complete, mkdocs serve yields a link in the terminal. You can open it with a browser to view the docs, including hot reloading.