Skip to content

Commit d1ffeb2

Browse files
committed
Prepare 9.2.0 release
1 parent de0fc51 commit d1ffeb2

File tree

9 files changed

+101
-14
lines changed

9 files changed

+101
-14
lines changed

CHANGELOG

+49
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
1+
mkdocs-material-9.2.0 (2023-08-21)
2+
3+
Additions and improvements
4+
5+
* Added blogging support via built-in blog plugin
6+
* Added support for Chinese language segmentaiton in search plugin
7+
* Added support for adding custom dates to blog posts
8+
* Added support for paginating archive and category pages
9+
* Added support for annotations (outside of code blocks)
10+
* Added support for navigation icons
11+
* Added support for navigation pruning
12+
* Added support for navigation status
13+
* Added support for customizing site icons
14+
* Added support for customizing (code) annotation icons
15+
* Added focus outline to admonitions and details
16+
* Added prompt for bug report name to info plugin
17+
* Added Luxembourgish translations
18+
* Improved rendering of (code) annotation markers
19+
* Improved print styles for (code) annotations
20+
* Improved customizability of navigation tabs
21+
* Improved interop of plugins with external tools like mike
22+
* Improved interop of blog plugin with awesome pages plugin
23+
* Improved header partial by moving buttons into separate partials
24+
* Improved clarity of site_url warning in social plugin
25+
* Improved blog plugin to automatically setup directory structure
26+
* Switched info plugin to importlib to mitigate deprecations
27+
* Automatically download ResizeObserver polyfill when necessary
28+
* Automatically add iframe-worker polyfill when necessary in offline plugin
29+
* Automatically focus and bring up keyboard on touch devices
30+
* Updated Serbo-Croatian translations
31+
* Updated MkDocs to 1.5.2
32+
33+
Removals
34+
35+
* Removed Universal Analytics integration
36+
* Removed ancient polyfills to reduce size of bundled JavaScript by 20%
37+
* Removed necessity for Array.flat and Array.flatMap polyfill
38+
* Removed announcement bar button when JavaScript is not available
39+
40+
Fixes
41+
42+
* Fixed rendering of tags when announcement bar is present
43+
* Fixed tags plugin rendering pages excluded by other plugins
44+
* Fixed #5132: Blog plugin requires nav entry in mkdocs.yml
45+
* Fixed #5599: Insufficient contrast for default link color
46+
* Fixed #5715: Blog plugin missing integrated table of contents in pagination
47+
* Fixed #5806: Version selector not hoverable on some Android devices
48+
* Fixed #5826: Blog post drafts with tags show up in tags index
49+
150
mkdocs-material-9.1.21+insiders-4.39.0 (2023-08-01)
251

352
* Added support for hoisting theme media files when building projects

docs/changelog/index.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,52 @@
44

55
### 9.2.0 <small>July 6, 2023</small> { id="9.2.0" }
66

7+
__Additions and improvements__
8+
79
- Added blogging support via built-in blog plugin
8-
- Added Chinese language support to built-in search plugin
10+
- Added support for Chinese language segmentaiton in search plugin
11+
- Added support for adding custom dates to blog posts
12+
- Added support for paginating archive and category pages
913
- Added support for annotations (outside of code blocks)
1014
- Added support for navigation icons
1115
- Added support for navigation pruning
1216
- Added support for navigation status
1317
- Added support for customizing site icons
1418
- Added support for customizing (code) annotation icons
1519
- Added focus outline to admonitions and details
20+
- Added prompt for bug report name to info plugin
21+
- Added Luxembourgish translations
1622
- Improved rendering of (code) annotation markers
1723
- Improved print styles for (code) annotations
1824
- Improved customizability of navigation tabs
19-
- Improved plugin inter-op with external tools like mike
25+
- Improved interop of plugins with external tools like mike
26+
- Improved interop of blog plugin with awesome pages plugin
27+
- Improved header partial by moving buttons into separate partials
28+
- Improved clarity of `site_url` warning in social plugin
29+
- Improved blog plugin to automatically setup directory structure
30+
- Switched info plugin to `importlib` to mitigate deprecations
31+
- Automatically download ResizeObserver polyfill when necessary
32+
- Automatically add iframe-worker polyfill when necessary in offline plugin
33+
- Automatically focus and bring up keyboard on touch devices
34+
- Updated Serbo-Croatian translations
35+
- Updated MkDocs to 1.5.2
36+
37+
__Removals__
38+
2039
- Removed Universal Analytics integration
2140
- Removed ancient polyfills to reduce size of bundled JavaScript by 20%
2241
- Removed necessity for `Array.flat` and `Array.flatMap` polyfill
2342
- Removed announcement bar button when JavaScript is not available
24-
- Automatically download ResizeObserver polyfill when necessary
25-
- Updated MkDocs to 1.5.0
43+
44+
__Fixes__
45+
2646
- Fixed rendering of tags when announcement bar is present
47+
- Fixed tags plugin rendering pages excluded by other plugins
48+
- Fixed #5132: Blog plugin requires `nav` entry in `mkdocs.yml`
49+
- Fixed #5599: Insufficient contrast for default link color
50+
- Fixed #5715: Blog plugin missing integrated table of contents in pagination
51+
- Fixed #5806: Version selector not hoverable on some Android devices
52+
- Fixed #5826: Blog post drafts with tags show up in tags index
2753

2854
### 9.1.21 <small>July 27, 2023</small> { id="9.1.20" }
2955

docs/setup/setting-up-a-blog.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1021,8 +1021,22 @@ categories:
10211021
output. [This behavior can be changed], e.g. for rendering drafts when
10221022
building deploy previews.
10231023

1024-
2. You can use `date_updated` to signal when you updated a blog posts. The
1025-
date will be rendered as part of the sidebar.
1024+
2. If you wish to provide multiple dates, you can use the following syntax,
1025+
allowing you to define a date when you last updated the blog post +
1026+
further custom dates you can add to the template:
1027+
1028+
``` yaml
1029+
---
1030+
date:
1031+
created: 2022-01-31
1032+
updated: 2022-02-02
1033+
---
1034+
1035+
# Hello world!
1036+
```
1037+
1038+
Note that the creation date __must__ be set under `date.created`, as each
1039+
blog post must have a creation date set.
10261040

10271041
When you spin up the [live preview server], you should be greeted by your first
10281042
post! You'll also realize, that [archive] and [category] indexes have been

material/assets/stylesheets/main.cad15034.min.css

-1
This file was deleted.

material/assets/stylesheets/main.cad15034.min.css.map

-1
This file was deleted.

material/base.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
3333
{% endif %}
3434
<link rel="icon" href="{{ config.theme.favicon | url }}">
35-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.0-b3">
35+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.2.0">
3636
{% endblock %}
3737
{% block htmltitle %}
3838
{% if page.meta and page.meta.title %}
@@ -44,7 +44,7 @@
4444
{% endif %}
4545
{% endblock %}
4646
{% block styles %}
47-
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.cad15034.min.css' | url }}">
47+
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.0e669242.min.css' | url }}">
4848
{% if config.theme.palette %}
4949
{% set palette = config.theme.palette %}
5050
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.85d0ee34.min.css' | url }}">

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "9.2.0-b3",
3+
"version": "9.2.0",
44
"description": "Documentation that simply works",
55
"keywords": [
66
"mkdocs",

requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# Requirements for core
2222
jinja2>=3.0
2323
markdown>=3.2
24-
mkdocs>=1.5.1
24+
mkdocs>=1.5.2
2525
mkdocs-material-extensions>=1.1
2626
pygments>=2.14
2727
pymdown-extensions>=9.9.1

0 commit comments

Comments
 (0)