Skip to content
Snippets Groups Projects
Commit 3b6ee1e1 authored by squidfunk's avatar squidfunk Committed by Martin Donath
Browse files

Prepare 1.8.0 release

parent 14f85c52
Branches
Tags 1.8.0
No related merge requests found
mkdocs-material-1.8.0 (2017-08-02)
* Added support for lazy-loading of search results for better performance
* Added support for customization of search tokenizer/separator
* Fixed #424: Search doesn't handle capital letters anymore
* Fixed #419: Search doesn't work on whole words
mkdocs-material-1.7.5 (2017-07-25) mkdocs-material-1.7.5 (2017-07-25)
* Fixed #398: Forms broken due to search shortcuts * Fixed #398: Forms broken due to search shortcuts
......
...@@ -403,8 +403,6 @@ section on [overriding partials][18] and the general guide on ...@@ -403,8 +403,6 @@ section on [overriding partials][18] and the general guide on
#### Site search #### Site search
##### Language
Site search is implemented using [lunr.js][21], which includes stemmers for the Site search is implemented using [lunr.js][21], which includes stemmers for the
English language by default, while stemmers for other languages are included English language by default, while stemmers for other languages are included
with [lunr-languages][22], both of which are integrated with this theme. Support with [lunr-languages][22], both of which are integrated with this theme. Support
...@@ -434,6 +432,17 @@ Norwegian `no`, Swedish `sv` and Turkish `tr`. ...@@ -434,6 +432,17 @@ Norwegian `no`, Swedish `sv` and Turkish `tr`.
JavaScript payload by around 20kb (without gzip) and by another 15-30kb per JavaScript payload by around 20kb (without gzip) and by another 15-30kb per
language. language.
The separator for tokenization can also be customized, which makes it possible
to index parts of words that are separated by `-` or `.` for example:
``` jinja
{% macro t(key) %}{{ {
...
"search.tokenizer": "[\s\-\.]+",
...
}[key] }}{% endmacro %}
```
[21]: https://lunrjs.com [21]: https://lunrjs.com
[22]: https://github.com/MihaiValentin/lunr-languages [22]: https://github.com/MihaiValentin/lunr-languages
......
...@@ -12,11 +12,18 @@ To determine the currently installed version, use the following command: ...@@ -12,11 +12,18 @@ 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.7.5 # Version 1.8.0
``` ```
## Changelog ## Changelog
### 1.8.0 <small> _ August 2, 2017</small>
* Added support for lazy-loading of search results for better performance
* Added support for customization of search tokenizer/separator
* Fixed [#424][424]: Search doesn't handle capital letters anymore
* Fixed [#419][419]: Search doesn't work on whole words
### 1.7.5 <small> _ July 25, 2017</small> ### 1.7.5 <small> _ July 25, 2017</small>
* Fixed [#398][398]: Forms broken due to search shortcuts * Fixed [#398][398]: Forms broken due to search shortcuts
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,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.7.5"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-1.8.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page and page.meta.title %} {% if page and page.meta.title %}
......
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "1.7.5", "version": "1.8.0",
"description": "A Material Design theme for MkDocs", "description": "A Material Design theme for MkDocs",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment