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.8.0.tar.gz
(47.9 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78111bca20ffd5fc4698434b181859922934026b12de049d719e2430fc3dc405 |
|
MD5 | 39cc613884202a06165118e45d0c81d4 |
|
BLAKE2b-256 | bcaf4e610697d0ac16cabaa07895fa904fb2fcd676b727de8a550705d6163be9 |
Close
Hashes for mkdocs_manuals_theme-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f710cc1d2f637c7f08a9df38e46c4b4eaec56a8c40e33fd1d7ad6333af76eab6 |
|
MD5 | 7b1c21a3eb4968ffb3f1e56ba524a73a |
|
BLAKE2b-256 | 7f4df5bde48f99fb29bb159307eb3dd58148217c60a7f0ee407de197beca8422 |