Metadata-Version: 2.1
Name: mkdocs-manuals-theme
Version: 0.9.0
Summary: A theme for rendering manuals using mkdocs
Author-email: Mittal Analytics Pvt Ltd <pratyush@hey.com>
Project-URL: Homepage, https://github.com/Mittal-Analytics/mkdocs-manuals-theme
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# 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

```bash
pip install mkdocs-manuals-theme
```

Use the theme in `mkdocs.yml`

```yaml
theme:
    name: manuals-theme
```


## Development

Setting up dev environment:

```bash
# 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`
