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
Usage
Install the theme
pip install mkdocs-manuals-theme
Use the theme in mkdocs.yml
theme:
name: 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
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.9.0.tar.gz
(47.9 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ea06910db066cf019705b707981d977a4818ac62701cf558c294e9f446caf16 |
|
MD5 | e583aefbc4061e56ad37b7b9ff9124a9 |
|
BLAKE2b-256 | e10463bb1cb8f8ef29ff34d3bc3c906c5a0a56b5fc846d27163e4f7528c25f1b |
Close
Hashes for mkdocs_manuals_theme-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 093b615d9e5e6cc16ffa866dc9a562d53d2064ed313125440658734fb02022dc |
|
MD5 | fabd58be197173ebe35f10f4fae5b3c4 |
|
BLAKE2b-256 | fcc308f4a6aeaed2ebdbe5c9b0f1c85314223d45bc341f4ca3064fef8a487752 |