Skip to content

Commit 88cfdce

Browse files
committed
Added note in upgrade guide on renaming plugins in partials
1 parent 5a228db commit 88cfdce

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/upgrade.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,24 @@ The templates have undergone a series of changes. If you have customized
7979
Material for MkDocs with theme extension, be sure to incorporate the latest
8080
changes into your templates. A good starting point is to [inspect the diff].
8181

82+
!!! warning "Built-in plugins not working after upgrade?"
83+
84+
If one of the built-in plugins (search or tags) doesn't work anymore without
85+
any apparent error or cause, it is very likely related to custom overrides.
86+
[MkDocs 1.4.1] and above allow themes to namespace built-in plugins, which
87+
Material for MkDocs 9 now does in order to allow authors to use third-party
88+
plugins with the same name as built-in plugins. Search your overrides for
89+
[`"in config.plugins"`][in config.plugins] and add the `material/` namespace.
90+
Affected partials:
91+
92+
- [`content.html`][content.html]
93+
- [`header.html`][header.html]
94+
8295
[inspect the diff]: https://github.com/squidfunk/mkdocs-material/pull/4628/files#diff-3ca112736b9164701b599f34780107abf14bb79fe110c478cac410be90899828
96+
[MkDocs 1.4.1]: https://github.com/mkdocs/mkdocs/releases/tag/1.4.1
97+
[in config.plugins]: https://github.com/squidfunk/mkdocs-material/search?q=%22in+config.plugins%22
98+
[content.html]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/content.html
99+
[header.html]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/header.html
83100

84101
## Upgrading from 7.x to 8.x
85102

0 commit comments

Comments
 (0)