Skip to content

Commit e9092a6

Browse files
committed
Added note on order of meta and blog plugin
1 parent a4a1a27 commit e9092a6

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/reference/index.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ tags. Add the following lines to `mkdocs.yml`:
2424

2525
``` yaml
2626
plugins:
27-
- meta
27+
- meta # (1)!
2828
```
2929
30+
1. Note that the meta plugin should be located at the beginning of the list
31+
of `plugins`, so that other plugins (including the [built-in blog plugin])
32+
will pick up the set defaults.
33+
3034
> If you need to be able to build your documentation with and without
3135
> [Insiders], please refer to the [built-in plugins] section to learn how
3236
> shared configurations help to achieve this.
@@ -48,6 +52,7 @@ The following configuration options are available:
4852
1. Note that it's strongly recommended to prefix meta files with a `.`,
4953
since otherwise they would be included in the build output.
5054

55+
[built-in blog plugin]: ../setup/setting-up-a-blog.md#built-in-blog-plugin
5156
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
5257

5358
## Usage

docs/setup/setting-up-a-blog.md

+10
Original file line numberDiff line numberDiff line change
@@ -1165,6 +1165,16 @@ authors, and add a `.meta.yml` file to set common properties:
11651165
- World
11661166
```
11671167

1168+
Note that order matters – the [built-in meta plugin] must be defined before the
1169+
blog plugin in `mkdocs.yml`, so that all set defaults are correctly picked up
1170+
by the [built-in blog plugin]:
1171+
1172+
``` yaml
1173+
plugins:
1174+
- meta
1175+
- blog
1176+
```
1177+
11681178
Lists and dictionaries in `.meta.yml` files are merged and deduplicated with the
11691179
values defined for a post, which means you can define common properties in
11701180
`.meta.yml` and then add specific properties or overrides for each post.

0 commit comments

Comments
 (0)