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

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for mkdocs-manuals-theme 0.10.0
File	Size	Uploaded
mkdocs-manuals-theme-0.10.0.tar.gz	47.9 kB	Sep 21, 2022	Details

Table of built distributions (wheels) for mkdocs-manuals-theme 0.10.0
File	Interpreter	ABI	Platform	Reset
mkdocs_manuals_theme-0.10.0-py3-none-any.whl 54.1 kB Sep 21, 2022	Python 3	none	any	Details

Total release size: 102.0 kB

Download URL	mkdocs-manuals-theme-0.10.0.tar.gz
Size	47.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`68c1340470ee29564ba30151629710abec08e1241ca5bd83c4e871c8e78589d6`
BLAKE2b-256 checksum How to use checksums	`155c9fe732d49f33d1a3617a9b1b46a0fa11976f9b6909a1da287353d589eacf`
Upload date	Sep 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.6`

Download URL	mkdocs_manuals_theme-0.10.0-py3-none-any.whl
Size	54.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f898a8d409de914cc399032e60887a6ddfc9faf814061e6b2a946fb7ad18d9bc`
BLAKE2b-256 checksum How to use checksums	`8ec27b09e657293645e48614c66c37d949bf2ed7a6ba01ba3565592bf6ecf0bc`
Upload date	Sep 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.6`