Skip to content

Commit 3f3e11a

Browse files
committed
Prepare 9.0.5 release
1 parent a200e7d commit 3f3e11a

File tree

11 files changed

+53
-11
lines changed

11 files changed

+53
-11
lines changed

Diff for: CHANGELOG

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
mkdocs-material-9.0.5+insiders-4.28.0 (2022-01-14)
2+
3+
* Added support for navigation paths (breadcrumbs)
4+
5+
mkdocs-material-9.0.5 (2022-01-14)
6+
7+
* Fixed #4842: Improve accessibility of search result list
8+
19
mkdocs-material-9.0.4 (2022-01-12)
210

311
* Fixed #4823: Improved contrast ratio in footer (9.0.2 regression)

Diff for: docs/assets/screenshots/navigation-path-off.png

158 KB
Loading

Diff for: docs/assets/screenshots/navigation-path-on.png

158 KB
Loading

Diff for: docs/insiders/index.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,15 @@ a handful of them, [thanks to our awesome sponsors]!
8888
## What's in it for me?
8989

9090
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
91-
access to 20 additional features__ that you can start using right away, and
91+
access to 21 additional features__ that you can start using right away, and
9292
which are currently exclusively available to sponsors:
9393

9494
<div class="mdx-columns" markdown>
9595

96+
- [x] [Navigation path] (Breadcrumbs): :material-alert-decagram:{ .mdx-pulse title="Added on january 14, 2023" }
9697
- [x] [Typeset plugin]: :material-alert-decagram:{ .mdx-pulse title="Added on December 20, 2022" }
9798
- [x] [Privacy plugin: external links] :material-alert-decagram:{ .mdx-pulse title="Added on October 18, 2022" }
98-
- [x] [Navigation subtitles] :material-alert-decagram:{ .mdx-pulse title="Added on October 2, 2022" }
99+
- [x] [Navigation subtitles]
99100
- [x] [Tags plugin: allow list] + [custom sorting]
100101
- [x] [Blog plugin: custom index pages]
101102
- [x] [Blog plugin: related links]
@@ -300,11 +301,13 @@ are released for general availability.
300301

301302
- [x] [Typeset plugin]
302303
- [x] [Privacy plugin: external links]
304+
- [x] [Navigation path] (Breadcrumbs)
303305
- [ ] [Instant previews]
304306
- ... more to be announced
305307

306308
[Typeset plugin]: ../reference/index.md#built-in-typeset-plugin
307309
[Privacy plugin: external links]: ../setup/ensuring-data-privacy.md#+privacy.external_links
310+
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path
308311
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
309312

310313
### Goals completed

Diff for: docs/reference/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ The following status identifiers are currently supported:
198198
- :material-alert-decagram: – `new`
199199
- :material-trash-can: – `deprecated`
200200

201-
### Setting the page `subtitle` :material-alert-decagram:{ .mdx-pulse title="Added on October 2, 2022" }
201+
### Setting the page `subtitle`
202202

203203
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
204204
[:octicons-tag-24: insiders-4.25.0][Insiders] ·

Diff for: docs/schema/theme.json

+7
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,13 @@
660660
"navigation.instant"
661661
]
662662
},
663+
{
664+
"title": "Navigation path (Breadcrumbs)",
665+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path",
666+
"enum": [
667+
"navigation.path"
668+
]
669+
},
663670
{
664671
"title": "Navigation pruning",
665672
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning",

Diff for: docs/setup/setting-up-a-blog.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
status: new
3-
---
4-
51
# Setting up a blog
62

73
Material for MkDocs makes it very easy to build a blog, either as a sidecar to

Diff for: docs/setup/setting-up-navigation.md

+28
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,34 @@ theme:
173173
[Navigation expansion enabled]: ../assets/screenshots/navigation-expand.png
174174
[Navigation expansion disabled]: ../assets/screenshots/navigation.png
175175

176+
### Navigation path <small>Breadcrumbs</small> { id=navigation-path }
177+
178+
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
179+
[:octicons-tag-24: insiders-4.28.0][Insiders] ·
180+
:octicons-beaker-24: Experimental
181+
182+
When navigation paths are activated, a breadcrumb navigation is rendered above
183+
the title of each page, which might make orientation easier for users visiting your
184+
documentation on devices with smaller screens. Add the following lines to
185+
`mkdocs.yml`:
186+
187+
``` yaml
188+
theme:
189+
features:
190+
- navigation.path
191+
```
192+
193+
=== "With navigation path"
194+
195+
[![Navigation path enabled]][Navigation path enabled]
196+
197+
=== "Without"
198+
199+
[![Navigation path disabled]][Navigation path disabled]
200+
201+
[Navigation path enabled]: ../assets/screenshots/navigation-path-on.png
202+
[Navigation path disabled]: ../assets/screenshots/navigation-path-off.png
203+
176204
### Navigation pruning
177205

178206
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·

Diff for: material/base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="next" href="{{ page.next_page.url | url }}">
2929
{% endif %}
3030
<link rel="icon" href="{{ config.theme.favicon | url }}">
31-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.0.4">
31+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.0.5">
3232
{% endblock %}
3333
{% block htmltitle %}
3434
{% if page.meta and page.meta.title %}

Diff for: package-lock.json

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

Diff for: package.json

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

0 commit comments

Comments
 (0)