Skip to content

Commit

Permalink
Documentation (#7102)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexvoss authored Apr 28, 2024
1 parent 4001083 commit 57d82dc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/setup/setting-up-a-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 57d82dc

Please sign in to comment.