diff --git a/CHANGELOG b/CHANGELOG index 9c577cddb..9d0706c02 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,11 @@ +mkdocs-material-9.0.5+insiders-4.28.0 (2022-01-14) + + * Added support for navigation paths (breadcrumbs) + +mkdocs-material-9.0.5 (2022-01-14) + + * Fixed #4842: Improve accessibility of search result list + mkdocs-material-9.0.4 (2022-01-12) * Fixed #4823: Improved contrast ratio in footer (9.0.2 regression) diff --git a/docs/assets/screenshots/navigation-path-off.png b/docs/assets/screenshots/navigation-path-off.png new file mode 100644 index 000000000..b212e7839 Binary files /dev/null and b/docs/assets/screenshots/navigation-path-off.png differ diff --git a/docs/assets/screenshots/navigation-path-on.png b/docs/assets/screenshots/navigation-path-on.png new file mode 100644 index 000000000..0afb80f67 Binary files /dev/null and b/docs/assets/screenshots/navigation-path-on.png differ diff --git a/docs/insiders/index.md b/docs/insiders/index.md index d6d18e6b3..f99fc3193 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -88,14 +88,15 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in it for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 20 additional features__ that you can start using right away, and +access to 21 additional features__ that you can start using right away, and which are currently exclusively available to sponsors:
+- [x] [Navigation path] (Breadcrumbs): :material-alert-decagram:{ .mdx-pulse title="Added on january 14, 2023" } - [x] [Typeset plugin]: :material-alert-decagram:{ .mdx-pulse title="Added on December 20, 2022" } - [x] [Privacy plugin: external links] :material-alert-decagram:{ .mdx-pulse title="Added on October 18, 2022" } -- [x] [Navigation subtitles] :material-alert-decagram:{ .mdx-pulse title="Added on October 2, 2022" } +- [x] [Navigation subtitles] - [x] [Tags plugin: allow list] + [custom sorting] - [x] [Blog plugin: custom index pages] - [x] [Blog plugin: related links] @@ -300,11 +301,13 @@ are released for general availability. - [x] [Typeset plugin] - [x] [Privacy plugin: external links] +- [x] [Navigation path] (Breadcrumbs) - [ ] [Instant previews] - ... more to be announced [Typeset plugin]: ../reference/index.md#built-in-typeset-plugin [Privacy plugin: external links]: ../setup/ensuring-data-privacy.md#+privacy.external_links + [Navigation path]: ../setup/setting-up-navigation.md#navigation-path [Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743 ### Goals completed diff --git a/docs/reference/index.md b/docs/reference/index.md index fd9b1e224..87c4c5cb2 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -198,7 +198,7 @@ The following status identifiers are currently supported: - :material-alert-decagram: – `new` - :material-trash-can: – `deprecated` -### Setting the page `subtitle` :material-alert-decagram:{ .mdx-pulse title="Added on October 2, 2022" } +### Setting the page `subtitle` [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: insiders-4.25.0][Insiders] · diff --git a/docs/schema/theme.json b/docs/schema/theme.json index 0b6d29093..c65f04d56 100644 --- a/docs/schema/theme.json +++ b/docs/schema/theme.json @@ -660,6 +660,13 @@ "navigation.instant" ] }, + { + "title": "Navigation path (Breadcrumbs)", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path", + "enum": [ + "navigation.path" + ] + }, { "title": "Navigation pruning", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning", diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index ae4bd89df..ff869fca9 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -1,7 +1,3 @@ ---- -status: new ---- - # Setting up a blog Material for MkDocs makes it very easy to build a blog, either as a sidecar to diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 40dd75892..dbb91bf55 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -173,6 +173,34 @@ theme: [Navigation expansion enabled]: ../assets/screenshots/navigation-expand.png [Navigation expansion disabled]: ../assets/screenshots/navigation.png +### Navigation path Breadcrumbs { id=navigation-path } + +[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · +[:octicons-tag-24: insiders-4.28.0][Insiders] · +:octicons-beaker-24: Experimental + +When navigation paths are activated, a breadcrumb navigation is rendered above +the title of each page, which might make orientation easier for users visiting your +documentation on devices with smaller screens. Add the following lines to +`mkdocs.yml`: + +``` yaml +theme: + features: + - navigation.path +``` + +=== "With navigation path" + + [![Navigation path enabled]][Navigation path enabled] + +=== "Without" + + [![Navigation path disabled]][Navigation path disabled] + + [Navigation path enabled]: ../assets/screenshots/navigation-path-on.png + [Navigation path disabled]: ../assets/screenshots/navigation-path-off.png + ### Navigation pruning [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · diff --git a/material/base.html b/material/base.html index 0f9bcf582..cbf70c7dd 100644 --- a/material/base.html +++ b/material/base.html @@ -28,7 +28,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index 6f61f6024..185745503 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mkdocs-material", - "version": "9.0.4", + "version": "9.0.5", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mkdocs-material", - "version": "9.0.4", + "version": "9.0.5", "license": "MIT", "dependencies": { "array-flat-polyfill": "^1.0.1", diff --git a/package.json b/package.json index dd73fc8f1..4604c455a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "9.0.4", + "version": "9.0.5", "description": "Documentation that simply works", "keywords": [ "mkdocs",