1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-23 23:21:00 +01:00

Prepare 9.2.0 release

This commit is contained in:
squidfunk 2023-08-21 19:18:59 +02:00
parent de0fc512e9
commit d1ffeb22eb
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
9 changed files with 101 additions and 14 deletions

View File

@ -1,3 +1,52 @@
mkdocs-material-9.2.0 (2023-08-21)
Additions and improvements
* Added blogging support via built-in blog plugin
* Added support for Chinese language segmentaiton in search plugin
* Added support for adding custom dates to blog posts
* Added support for paginating archive and category pages
* Added support for annotations (outside of code blocks)
* Added support for navigation icons
* Added support for navigation pruning
* Added support for navigation status
* Added support for customizing site icons
* Added support for customizing (code) annotation icons
* Added focus outline to admonitions and details
* Added prompt for bug report name to info plugin
* Added Luxembourgish translations
* Improved rendering of (code) annotation markers
* Improved print styles for (code) annotations
* Improved customizability of navigation tabs
* Improved interop of plugins with external tools like mike
* Improved interop of blog plugin with awesome pages plugin
* Improved header partial by moving buttons into separate partials
* Improved clarity of site_url warning in social plugin
* Improved blog plugin to automatically setup directory structure
* Switched info plugin to importlib to mitigate deprecations
* Automatically download ResizeObserver polyfill when necessary
* Automatically add iframe-worker polyfill when necessary in offline plugin
* Automatically focus and bring up keyboard on touch devices
* Updated Serbo-Croatian translations
* Updated MkDocs to 1.5.2
Removals
* Removed Universal Analytics integration
* Removed ancient polyfills to reduce size of bundled JavaScript by 20%
* Removed necessity for Array.flat and Array.flatMap polyfill
* Removed announcement bar button when JavaScript is not available
Fixes
* Fixed rendering of tags when announcement bar is present
* Fixed tags plugin rendering pages excluded by other plugins
* Fixed #5132: Blog plugin requires nav entry in mkdocs.yml
* Fixed #5599: Insufficient contrast for default link color
* Fixed #5715: Blog plugin missing integrated table of contents in pagination
* Fixed #5806: Version selector not hoverable on some Android devices
* Fixed #5826: Blog post drafts with tags show up in tags index
mkdocs-material-9.1.21+insiders-4.39.0 (2023-08-01) mkdocs-material-9.1.21+insiders-4.39.0 (2023-08-01)
* Added support for hoisting theme media files when building projects * Added support for hoisting theme media files when building projects

View File

@ -4,8 +4,12 @@
### 9.2.0 <small>July 6, 2023</small> { id="9.2.0" } ### 9.2.0 <small>July 6, 2023</small> { id="9.2.0" }
__Additions and improvements__
- Added blogging support via built-in blog plugin - Added blogging support via built-in blog plugin
- Added Chinese language support to built-in search plugin - Added support for Chinese language segmentaiton in search plugin
- Added support for adding custom dates to blog posts
- Added support for paginating archive and category pages
- Added support for annotations (outside of code blocks) - Added support for annotations (outside of code blocks)
- Added support for navigation icons - Added support for navigation icons
- Added support for navigation pruning - Added support for navigation pruning
@ -13,17 +17,39 @@
- Added support for customizing site icons - Added support for customizing site icons
- Added support for customizing (code) annotation icons - Added support for customizing (code) annotation icons
- Added focus outline to admonitions and details - Added focus outline to admonitions and details
- Added prompt for bug report name to info plugin
- Added Luxembourgish translations
- Improved rendering of (code) annotation markers - Improved rendering of (code) annotation markers
- Improved print styles for (code) annotations - Improved print styles for (code) annotations
- Improved customizability of navigation tabs - Improved customizability of navigation tabs
- Improved plugin inter-op with external tools like mike - Improved interop of plugins with external tools like mike
- Improved interop of blog plugin with awesome pages plugin
- Improved header partial by moving buttons into separate partials
- Improved clarity of `site_url` warning in social plugin
- Improved blog plugin to automatically setup directory structure
- Switched info plugin to `importlib` to mitigate deprecations
- Automatically download ResizeObserver polyfill when necessary
- Automatically add iframe-worker polyfill when necessary in offline plugin
- Automatically focus and bring up keyboard on touch devices
- Updated Serbo-Croatian translations
- Updated MkDocs to 1.5.2
__Removals__
- Removed Universal Analytics integration - Removed Universal Analytics integration
- Removed ancient polyfills to reduce size of bundled JavaScript by 20% - Removed ancient polyfills to reduce size of bundled JavaScript by 20%
- Removed necessity for `Array.flat` and `Array.flatMap` polyfill - Removed necessity for `Array.flat` and `Array.flatMap` polyfill
- Removed announcement bar button when JavaScript is not available - Removed announcement bar button when JavaScript is not available
- Automatically download ResizeObserver polyfill when necessary
- Updated MkDocs to 1.5.0 __Fixes__
- Fixed rendering of tags when announcement bar is present - Fixed rendering of tags when announcement bar is present
- Fixed tags plugin rendering pages excluded by other plugins
- Fixed #5132: Blog plugin requires `nav` entry in `mkdocs.yml`
- Fixed #5599: Insufficient contrast for default link color
- Fixed #5715: Blog plugin missing integrated table of contents in pagination
- Fixed #5806: Version selector not hoverable on some Android devices
- Fixed #5826: Blog post drafts with tags show up in tags index
### 9.1.21 <small>July 27, 2023</small> { id="9.1.20" } ### 9.1.21 <small>July 27, 2023</small> { id="9.1.20" }

View File

@ -1021,8 +1021,22 @@ categories:
output. [This behavior can be changed], e.g. for rendering drafts when output. [This behavior can be changed], e.g. for rendering drafts when
building deploy previews. building deploy previews.
2. You can use `date_updated` to signal when you updated a blog posts. The 2. If you wish to provide multiple dates, you can use the following syntax,
date will be rendered as part of the sidebar. allowing you to define a date when you last updated the blog post +
further custom dates you can add to the template:
``` yaml
---
date:
created: 2022-01-31
updated: 2022-02-02
---
# Hello world!
```
Note that the creation date __must__ be set under `date.created`, as each
blog post must have a creation date set.
When you spin up the [live preview server], you should be greeted by your first When you spin up the [live preview server], you should be greeted by your first
post! You'll also realize, that [archive] and [category] indexes have been post! You'll also realize, that [archive] and [category] indexes have been

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -32,7 +32,7 @@
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}"> <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
{% endif %} {% endif %}
<link rel="icon" href="{{ config.theme.favicon | url }}"> <link rel="icon" href="{{ config.theme.favicon | url }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.0-b3"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page.meta and page.meta.title %} {% if page.meta and page.meta.title %}
@ -44,7 +44,7 @@
{% endif %} {% endif %}
{% endblock %} {% endblock %}
{% block styles %} {% block styles %}
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.cad15034.min.css' | url }}"> <link rel="stylesheet" href="{{ 'assets/stylesheets/main.0e669242.min.css' | url }}">
{% if config.theme.palette %} {% if config.theme.palette %}
{% set palette = config.theme.palette %} {% set palette = config.theme.palette %}
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.85d0ee34.min.css' | url }}"> <link rel="stylesheet" href="{{ 'assets/stylesheets/palette.85d0ee34.min.css' | url }}">

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.2.0-b3", "version": "9.2.0",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.2.0-b3", "version": "9.2.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"clipboard": "^2.0.11", "clipboard": "^2.0.11",

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.2.0-b3", "version": "9.2.0",
"description": "Documentation that simply works", "description": "Documentation that simply works",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",

View File

@ -21,7 +21,7 @@
# Requirements for core # Requirements for core
jinja2>=3.0 jinja2>=3.0
markdown>=3.2 markdown>=3.2
mkdocs>=1.5.1 mkdocs>=1.5.2
mkdocs-material-extensions>=1.1 mkdocs-material-extensions>=1.1
pygments>=2.14 pygments>=2.14
pymdown-extensions>=9.9.1 pymdown-extensions>=9.9.1