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.5.0.tar.gz
(47.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec0f4fa84a8ff90b0e122e0743d7129211b1514ee0b586d020f3cd188e545670 |
|
MD5 | d4212e2c0fd9b645320d90cd083e6508 |
|
BLAKE2b-256 | 8b3822067e4b09c162e1fbb182677cc3977fef2a19b2dec461aa94163ba7e66c |
Close
Hashes for mkdocs_manuals_theme-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14d307f7277078151133e015043893c8c5f05039c0fbdd586909994193766962 |
|
MD5 | 13451822ab1b53ea975f3d47203af4e9 |
|
BLAKE2b-256 | f672ea7771df505004d29e34b6ded4d6a3558cd596fb5f22527dadfd1b0e1f67 |