1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-30 18:24:35 +01:00

Prepare 2.0.0 release

This commit is contained in:
squidfunk 2017-10-31 20:25:30 +01:00 committed by Martin Donath
parent a36bfae62a
commit c5143e890f
6 changed files with 35 additions and 13 deletions

View File

@ -1,3 +1,11 @@
mkdocs-material-2.0.0 (2017-10-31)
* Added support for MkDocs 0.17.1 theme configuration options
* Added support for easier configuration of search tokenizer
* Added support to disable search
* Added Korean translations
* Removed support for MkDocs 0.16.x
mkdocs-material-1.12.2 (2017-10-26) mkdocs-material-1.12.2 (2017-10-26)
* Added Italian, Norwegian, French and Chinese translations * Added Italian, Norwegian, French and Chinese translations

View File

@ -473,18 +473,20 @@ automatically included.
### From 1.x to 2.0 ### From 1.x to 2.0
Material for MkDocs 2.0 requires MkDocs 0.17.1, as this version introduced * 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 changes to the way themes can define options. The following variables inside
your project's `mkdocs.yml` need to be renamed: your project's `mkdocs.yml` need to be renamed:
* `extra.feature` becomes `theme.feature` * `extra.feature` becomes `theme.feature`
* `extra.palette` becomes `theme.palette` * `extra.palette` becomes `theme.palette`
* `extra.font` becomes `theme.font` * `extra.font` becomes `theme.font`
* `extra.logo` becomes `theme.logo` * `extra.logo` becomes `theme.logo`
Localization is now separate in theme language and search language. While * Localization is now separate in theme language and search language. While
there can only be a single language on theme-level, the search supports there can only be a single language on theme-level, the search supports
multiple languages which can be separated by commas. multiple languages which can be separated by commas.
* The search tokenizer can now be set through `extra.search.tokenizer`.
## Extensions ## Extensions

View File

@ -12,11 +12,19 @@ To determine the currently installed version, use the following command:
``` sh ``` sh
pip show mkdocs-material | grep -E ^Version pip show mkdocs-material | grep -E ^Version
# Version 1.12.2 # Version 2.0.0
``` ```
## Changelog ## Changelog
### 2.0.0 <small>_ October 31, 2017</small>
* Added support for MkDocs 0.17.1 theme configuration options
* Added support for easier configuration of search tokenizer
* Added support to disable search
* Added Korean translations
* Removed support for MkDocs 0.16.x
### 1.12.2 <small>_ October 26, 2017</small> ### 1.12.2 <small>_ October 26, 2017</small>
* Added Italian, Norwegian, French and Chinese translations * Added Italian, Norwegian, French and Chinese translations

View File

@ -38,7 +38,7 @@
{% else %} {% else %}
<link rel="shortcut icon" href="{{ base_url }}/assets/images/favicon.png"> <link rel="shortcut icon" href="{{ base_url }}/assets/images/favicon.png">
{% endif %} {% endif %}
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-1.12.2"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.0.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page and page.meta.title %} {% if page and page.meta.title %}

View File

@ -36,6 +36,10 @@ theme:
name: null name: null
custom_dir: material custom_dir: material
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml # Default values, taken from mkdocs_theme.yml
language: en language: en
feature: feature:

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "1.12.2", "version": "2.0.0",
"description": "A Material Design theme for MkDocs", "description": "A Material Design theme for MkDocs",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",