OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation on migration

Browse Source
This commit is contained in:
squidfunk 2017-10-31 20:01:15 +01:00 committed by Martin Donath
parent b913a607e9
commit a36bfae62a
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/getting-started.md
View File

@ -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