Theme for creating team manuals

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

Usage

Install the theme

pip install mkdocs-manuals-theme

Use the theme in mkdocs.yml

theme:
    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]'

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

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

Uploaded Sep 21, 2022 Source

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

Uploaded Sep 21, 2022 Python 3

Details for the file mkdocs-manuals-theme-0.10.0.tar.gz.

Details for the file mkdocs_manuals_theme-0.10.0-py3-none-any.whl.

Hashes for mkdocs_manuals_theme-0.10.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f898a8d409de914cc399032e60887a6ddfc9faf814061e6b2a946fb7ad18d9bc`
MD5	`2c3d1327c0697b08d7bcbc0adb547ae8`
BLAKE2b-256	`8ec27b09e657293645e48614c66c37d949bf2ed7a6ba01ba3565592bf6ecf0bc`