docs: Update docs

This commit is contained in:
Michael Currin
2020-10-17 16:23:20 +02:00
parent b842ce958e
commit 5e8b217c8d
4 changed files with 47 additions and 28 deletions

View File

@@ -83,9 +83,7 @@ site/
venv
```
### Config
#### Sample navbar
### Navbar
```yaml
nav:
@@ -93,19 +91,29 @@ nav:
- About: about.md
```
#### Sample theme
### Themes
#### Builtin
Use a builtin theme that comes with MkDocs.
The default.
Use a builtin theme.
```yaml
theme: mkdocs
```
Or
Using ReadTheDocs theme and alternative config syntax.
```yaml
theme: readthedocs
theme:
name: readthedocs
```
Find more [supported themes](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes). If it doesn't immediately, you'll have to use `pip` to install it and add to a `requirements.txt` file.
#### ReadTheDocs Dropdown theme
See below using [mkdocs-rtd-dropdown](https://github.com/cjsheets/mkdocs-rtd-dropdown).
`requirements.txt`
@@ -118,3 +126,18 @@ mkdocs-rtd-dropdown
theme:
name: 'rtd-dropdown'
```
### Material for MkdDocs theme
See the [MkDocs for Material](https://squidfunk.github.io/mkdocs-material/) homepage. See the Setup page for config options.
`requirements.txt`
```
mkdocs-material-extensions>=1.0
```
`mkdocs.yml`
```yaml
theme:
name: 'material'
```