Select Git revision
release-notes.md 24.36 KiB
Release notes
Upgrading
To upgrade Material to the latest version, use pip
:
pip install --upgrade mkdocs-material
To inspect the currently installed version, use the following command:
pip show mkdocs-material
Material 1.x to 2.x
-
Material for MkDocs 2.x 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
becomestheme.feature
-
extra.palette
becomestheme.palette
-
extra.font
becomestheme.font
-
extra.logo
becomestheme.logo
-
-
Favicon support has been dropped by MkDocs, it must now be defined in
theme.favicon
(previouslysite_favicon
). -
Localization is now separated into 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. See the getting started guide for more guidance.
-
The search tokenizer can now be set through
extra.search.tokenizer
.
Changelog
2.6.5 _ February 22, 2018
- Reverted
--dev-addr
flag removal fromDockerfile
2.6.4 _ February 21, 2018
- Added Catalan translations
- Fixed incorrect margins for buttons in Firefox and Safari
- Replaced package manager
yarn
withnpm 5.6
- Reverted GitHub stars rounding method
- Removed
--dev-addr
flag fromDockerfile
for Windows compatibility
2.6.3 _ February 18, 2018
- Added Vietnamese translations
2.6.2 _ February 12, 2018
- Added Arabic translations
- Fixed incorrect rounding of amount of GitHub stars
- Fixed double-layered borders for tables
2.6.1 _ February 11, 2018
- Fixed #690: Duplicate slashes in source file URLs
- Fixed #696: Active page highlight not working with default palette
- Added ability to override Disqus integration using metadata
- Adjusted German translations
2.6.0 _ February 2, 2018
- Moved default search configuration to default translation (English)
- Added support to automatically set text direction from translation
- Added support to disable search stop word filter in translation
- Added support to disable search trimmer in translation
- Added Persian translations
- Fixed support for Polish search
- Fixed disappearing GitHub, GitLab and Bitbucket repository icons
2.5.5 _ January 31, 2018
- Added Hungarian translations
2.5.4 _ January 29, 2018
- Fixed #683:
gh-deploy
fails inside Docker
2.5.3 _ January 25, 2018
- Added Ukrainian translations
2.5.2 _ January 22, 2018
- Added default search language mappings for all localizations
- Fixed #673: Error loading non-existent search language
- Fixed #675: Uncaught reference error when search plugin disabled
2.5.1 _ January 20, 2018
- Fixed permalink for main headline
- Improved missing translation handling with English as a fallback
- Improved accessibility with skip-to-content link
2.5.0 _ January 13, 2018
- Added support for right-to-left languages
2.4.0 _ January 11, 2018
- Added focus state for clipboard buttons
- Fixed #400: Search bar steals tab focus
- Fixed search not closing on ++enter++ when result is selected
- Fixed search not closing when losing focus due to ++tab++
- Fixed collapsed navigation links getting focus
- Fixed
outline
being cut off on ++tab++ focus of navigation links - Fixed bug with first search result navigation being ignored
- Removed search result navigation via ++tab++ (use ++up++ and ++down++)
- Removed
outline
resets for links - Improved general tabbing behavior on desktop
2.3.0 _ January 9, 2018
- Added
example
(synonym:snippet
) style for Admonition - Added synonym
abstract
forsummary
style for Admonition
2.2.6 _ December 27, 2017
- Added Turkish translations
- Fixed unclickable area below header in case JavaScript is not available