Skip to main content

A theme for rendering manuals using mkdocs

Project description

Theme for creating team manuals

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


Install the theme

pip install mkdocs-manuals-theme

Use the theme in mkdocs.yml

    name: manuals-theme


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 :)

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

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-manuals-theme-0.10.0.tar.gz (47.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page