From a36bfae62af241b38846a1fb21fc2991845cf13f Mon Sep 17 00:00:00 2001 From: squidfunk <martin.donath@squidfunk.com> Date: Tue, 31 Oct 2017 20:01:15 +0100 Subject: [PATCH] Added documentation on migration --- docs/getting-started.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 234d2743..34992e8f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -32,7 +32,7 @@ pip install mkdocs && mkdocs --version !!! warning "MkDocs version requirements" - As of 2.0, Material requires MkDocs >= 0.17.1 + Material requires MkDocs >= 0.17.1 [2]: http://www.mkdocs.org @@ -469,6 +469,23 @@ automatically included. [22]: https://disqus.com +## Migration + +### From 1.x to 2.0 + +Material for MkDocs 2.0 requires MkDocs 0.17.1, as this version introduced +changes to the way themes can define options. The following variables inside +your project's `mkdocs.yml` need to be renamed: + +* `extra.feature` becomes `theme.feature` +* `extra.palette` becomes `theme.palette` +* `extra.font` becomes `theme.font` +* `extra.logo` becomes `theme.logo` + +Localization is now separate in theme language and search language. While +there can only be a single language on theme-level, the search supports +multiple languages which can be separated by commas. + ## Extensions MkDocs supports several [Markdown extensions][23]. The following extensions -- GitLab