Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mkdocs-material
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Janne Mareike Koschinski
mkdocs-material
Commits
a36bfae6
Commit
a36bfae6
authored
7 years ago
by
squidfunk
Committed by
Martin Donath
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation on migration
parent
b913a607
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/getting-started.md
+18
-1
18 additions, 1 deletion
docs/getting-started.md
with
18 additions
and
1 deletion
docs/getting-started.md
+
18
−
1
View file @
a36bfae6
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment