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.6.0.tar.gz
(47.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1aa8c90f1151ccc7e3dd6d93c4900cd6a6d48af483e9bf5d31b8150d0b35c1a |
|
MD5 | 7ee5d559c20a81016264fe6c43ec25a3 |
|
BLAKE2b-256 | 29264f157d46e8f4ded7c8a106ae394e6ac3dc069016c83d71ddb0df61ae25ba |
Close
Hashes for mkdocs_manuals_theme-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0266f0611cd7f2645d6f6fb4f1e8a5208a597e70088e7ec67c0a92ae7bc8b02f |
|
MD5 | 9f3b8a806cb232d33d94c73e61d1ebc3 |
|
BLAKE2b-256 | 82a5f316fcd9a10caa93a969920017af071157e067e3bc064db0736b225109e1 |