diff --git a/CHANGELOG b/CHANGELOG index 12ff2671220dd6e5232ff086e3b4060618c58dfb..3e320849662863b6d369a86740804796e9351310 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -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) * Added Italian, Norwegian, French and Chinese translations diff --git a/docs/getting-started.md b/docs/getting-started.md index 34992e8fa3b46e180b146c8ef7e0a259b9f71593..fb8993d7e0a64e452e19eb14ca38fbdc5dcec291 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -473,18 +473,20 @@ automatically included. ### 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. +* 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. + +* The search tokenizer can now be set through `extra.search.tokenizer`. ## Extensions diff --git a/docs/release-notes.md b/docs/release-notes.md index 134ec9a38ac04771a752d0cc16c10a8b4c68c622..3f3b39e6bde3c083bceac4eb3120681013ae14d9 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -12,11 +12,19 @@ To determine the currently installed version, use the following command: ``` sh pip show mkdocs-material | grep -E ^Version -# Version 1.12.2 +# Version 2.0.0 ``` ## 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> * Added Italian, Norwegian, French and Chinese translations diff --git a/material/base.html b/material/base.html index e6aa6990bafdad8eda60d08902f9b9479b1296af..6c327896968f409fd6e807f713f7b44c826f44a9 100644 --- a/material/base.html +++ b/material/base.html @@ -38,7 +38,7 @@ {% else %} <link rel="shortcut icon" href="{{ base_url }}/assets/images/favicon.png"> {% 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 %} {% block htmltitle %} {% if page and page.meta.title %} diff --git a/mkdocs.yml b/mkdocs.yml index 8c95833da25b64835c2ed3523a403d2ffd211979..f84e5e10f4aa5e19c1817114f0a4a11c40bcad78 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,10 @@ theme: name: null custom_dir: material + # Don't include MkDocs' JavaScript + include_search_page: false + search_index_only: true + # Default values, taken from mkdocs_theme.yml language: en feature: diff --git a/package.json b/package.json index 59d2c603c0cc28384e97e121653e06d9f679ecbf..1bacc816d4ace0dfd359c5314e91b5be29f523ca 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "1.12.2", + "version": "2.0.0", "description": "A Material Design theme for MkDocs", "keywords": [ "mkdocs",