mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation (#6549)
This is in response to https://github.com/squidfunk/mkdocs-material/discussions/6542 to add a section on setting up navigation for a blog so that the archive and category pages appear in the right place.
This commit is contained in:
parent
175df61397
commit
6b690e9acd
@ -153,6 +153,35 @@ installed.
|
|||||||
[blog]: blog.md
|
[blog]: blog.md
|
||||||
[built-in plugins]: index.md
|
[built-in plugins]: index.md
|
||||||
|
|
||||||
|
### Navigation
|
||||||
|
|
||||||
|
If you do not have site navigation configured in your `mkdocs.yml` then there is
|
||||||
|
nothing more to do. The blog [archive] and [category] pages will automatically
|
||||||
|
appear underneath the automatically generated navigation.
|
||||||
|
|
||||||
|
If you do have a navigation structure defined then you will need to specify
|
||||||
|
where the blog should appear in this. Create a [navigation section with an index
|
||||||
|
page] for the blog:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
features:
|
||||||
|
- navigation.indexes
|
||||||
|
nav:
|
||||||
|
- ...
|
||||||
|
- Blog:
|
||||||
|
- blog/index.md
|
||||||
|
```
|
||||||
|
|
||||||
|
The [archive] and [category] pages will appear within that section as
|
||||||
|
subsections beneath pages in the blog section. In this case, they would appear
|
||||||
|
after `index.md`. The path to the `index.md` file must match
|
||||||
|
[blog_dir][config.blog_dir]. This means that you can name the blog navigation
|
||||||
|
entry anything you like: 'Blog' or 'News' or perhaps 'Tips'.
|
||||||
|
|
||||||
|
[navigation section with an index page]: ../setup/setting-up-navigation.md#section-index-pages
|
||||||
|
|
||||||
### General
|
### General
|
||||||
|
|
||||||
The following settings are available:
|
The following settings are available:
|
||||||
|
Loading…
Reference in New Issue
Block a user