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.7.0.tar.gz
(47.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-manuals-theme-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76509e50239a9855d3fdd83bab01b566d9fb75d6309ec059a6d47cf5637ae185 |
|
MD5 | c36069cdd771810cbc5bb51d6935dcca |
|
BLAKE2b-256 | e93578d4ba34f2a329abb46fbcb1d96a293ab5401c79bbc851f479097641e5da |
Close
Hashes for mkdocs_manuals_theme-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a632a12d79cb16f8d72c7b8fa28045e9152b9ad90e229fa2511d9803f38cc136 |
|
MD5 | 13a11e7c5e5bd1992b8329198c706bee |
|
BLAKE2b-256 | 779a3d66b2131d3ff3226fbf334c9bfa5947ab3a47b3a697b4c79ef96cc5c921 |