A theme for rendering manuals using mkdocs
Project description
Theme for creating team manuals
This theme is based on top of mkdocs-basic-theme.
https://github.com/mkdocs/mkdocs-basic-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
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.2.0.tar.gz
(14.1 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 467cbdd152d7a7e4839a5e7d0dbe810aed5ea32f19058afae88995c8de23f352 |
|
MD5 | 3763e584f0f395c2b4964e937b04a51a |
|
BLAKE2b-256 | 553974d9c0800ea7b49b86e16b1c495854f4eb8b3d19987770a8d998b514a1c4 |
Close
Hashes for mkdocs_manuals_theme-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d085a72e32ea3ddea12339fd8bb8225e4234d584814e66ec605be23181fb1af4 |
|
MD5 | c2ce346329dc83cb84137b87ce076a12 |
|
BLAKE2b-256 | ab509c98d3b9ea1698646208da4ad82cb35870af46749bead768847082be5663 |