From 57d82dc253d1f2581677f85eff69d008efea6b86 Mon Sep 17 00:00:00 2001 From: Alexander Voss Date: Sun, 28 Apr 2024 04:49:40 +0200 Subject: [PATCH] Documentation (#7102) --- docs/setup/setting-up-a-blog.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index 666dac06f..1c48a89f7 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -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