OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Prepare 3.0.0 release

Browse Source
This commit is contained in:
squidfunk 2018-08-05 18:59:58 +02:00
parent 07ff68631b
commit 2d7e9341f7
5 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -25,6 +25,10 @@
/node_modules /node_modules
/npm-debug.log* /npm-debug.log*
# Python-related
__pycache__
# Files generated by build # Files generated by build
/build /build
/material/manifest.json /material/manifest.json

2
CHANGELOG
View File

@ -1,4 +1,4 @@
mkdocs-material-3.0.0 (2018-08-xx) mkdocs-material-3.0.0 (2018-08-05)
* Upgraded MkDocs to 1.0 * Upgraded MkDocs to 1.0
* Upgraded Python in official Docker image to 3.6 * Upgraded Python in official Docker image to 3.6

18
docs/release-notes.md
View File

@ -14,6 +14,18 @@ To inspect the currently installed version, use the following command:
pip show mkdocs-material pip show mkdocs-material
``` ```
### Material 2.x to 3.x
* Material for MkDocs 3.x requires MkDocs 1.0 because the way paths are resolved
internally changed significantly. Furthermore, `pages` was renamed to `nav`,
so remember to adjust your `mkdocs.yml` file.
* All extended templates *should* continue to work but in order to make them
future-proof the `url` filter should be introduced on all paths. Please see
the [official release notes][_1] for further guidance.
[_1]: https://www.mkdocs.org/about/release-notes/#version-10-2018-08-03
### Material 1.x to 2.x ### Material 1.x to 2.x
* Material for MkDocs 2.x requires MkDocs 0.17.1, as this version introduced * Material for MkDocs 2.x requires MkDocs 0.17.1, as this version introduced
@ -37,6 +49,12 @@ pip show mkdocs-material
## Changelog ## Changelog
### 3.0.0 <small>_ August 5, 2018</small>
* Upgraded MkDocs to 1.0
* Upgraded Python in official Docker image to 3.6
* Added Serbian and Serbo-Croatian translations
### 2.9.4 <small>_ July 29, 2018</small> ### 2.9.4 <small>_ July 29, 2018</small>
* Fixed build error after MkDocs upgrade * Fixed build error after MkDocs upgrade

2
material/base.html
View File

@ -36,7 +36,7 @@
<meta name="lang:{{ key }}" content="{{ lang.t(key) }}"> <meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
{% endfor %} {% endfor %}
<link rel="shortcut icon" href="{{ config.theme.favicon | url }}"> <link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.9.4"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-3.0.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page and page.meta and page.meta.title %} {% if page and page.meta and page.meta.title %}

2
package.json
View File

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