From c5143e890f454eb1293e2b51f114b14978020642 Mon Sep 17 00:00:00 2001
From: squidfunk <martin.donath@squidfunk.com>
Date: Tue, 31 Oct 2017 20:25:30 +0100
Subject: [PATCH] Prepare 2.0.0 release
---
CHANGELOG | 8 ++++++++
docs/getting-started.md | 26 ++++++++++++++------------
docs/release-notes.md | 10 +++++++++-
material/base.html | 2 +-
mkdocs.yml | 4 ++++
package.json | 2 +-
6 files changed, 37 insertions(+), 15 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
index 12ff2671..3e320849 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 34992e8f..fb8993d7 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 134ec9a3..3f3b39e6 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 e6aa6990..6c327896 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 8c95833d..f84e5e10 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 59d2c603..1bacc816 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",
--
GitLab