Documentation (#7102)

This commit is contained in:
Alexander Voss 2024-04-28 04:49:40 +02:00 committed by GitHub
parent 400108301e
commit 57d82dc253
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -32,6 +32,19 @@ plugins:
- blog
```
If you do not have a navigation (`nav`) definition in your `mkdocs.yml` then
there is nothing else to do there as the blog plugin will add navigation
automatically. If you do have a navigation defined then you need to add *the
blog index page only* to it. You need not and should not add the individual
blog posts. For example:
```yaml
nav:
- index.md
- Blog:
- blog/index.md
```
For a list of all settings, please consult the [plugin documentation].
[plugin documentation]: ../plugins/blog.md