mkdocs-manuals-theme 0.4.0

A theme for rendering manuals using mkdocs

Theme for creating team manuals

This theme is based on top of mkdocs-basic-theme.

https://github.com/mkdocs/mkdocs-basic-theme

Usage

Install the theme

pip install mkdocs-manuals-theme

Use the theme in mkdocs.yml

theme:
    name: mkdocs-manuals-theme

Development

Setting up dev environment:

# create and activate virtual env
python3 -m venv .venv
source .venv/bin/activate

# install requirements
pip install '.[dev]'

Summary of understanding

The documentation around templating is pretty good. It is all on one page :) https://www.mkdocs.org/dev-guide/themes/#navigation-objects

There are 2 global variables on each page: nav and toc

Nav is an iterable of 3 kinds of page: section, page and link