diff --git a/CHANGELOG b/CHANGELOG index 261e0671dc3..b95013644e7 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,17 @@ +mkdocs-material-8.3.1+insiders-4.17.0 (2022-06-04) + + * Added support for content tabs anchor links (deep linking) + * Fixed #3975: Detect composition events in search interface (Chinese) + * Fixed #3980: Search plugin doesn't use title set via front matter + +mkdocs-material-8.3.1 (2022-06-04) + + * Bump required Jinja version to 3.0.2 + * Removed unnecessary conditions in templates + * Fixed scroll offset when content tabs are brought into view + * Fixed #3977: Content tabs snapping oddly in Firefox + * Fixed #3983: Missing condition in footer partial (8.3.0 regression) + mkdocs-material-8.3.0 (2022-06-02) * Added support for custom admonition icons diff --git a/docs/changelog/index.md b/docs/changelog/index.md index e2bdde1972e..7d332ad082a 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -6,6 +6,14 @@ template: overrides/main.html ## Material for MkDocs +### 8.3.1 _ June 4, 2022 { id="8.3.1" } + +- Bump required Jinja version to 3.0.2 +- Removed unnecessary conditions in templates +- Fixed scroll offset when content tabs are brought into view +- Fixed #3977: Content tabs snapping oddly in Firefox +- Fixed #3983: Missing condition in footer partial (8.3.0 regression) + ### 8.3.0 _ June 2, 2022 { id="8.3.0" } - Added support for custom admonition icons diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 46d84eed522..bebc6273e4a 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,6 +6,12 @@ template: overrides/main.html ## Material for MkDocs Insiders +### 4.17.0 _ June 4, 2022 { id="4.17.0" } + +- Added support for content tabs anchor links (deep linking) +- Fixed #3975: Detect composition events in search interface (Chinese) +- Fixed #3980: Search plugin doesn't use title set via front matter + ### 4.16.2 _ May 29, 2022 { id="4.16.2" } - Fixed #3961: Nested sections triggered build error for navigation tabs diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 2a428bb1bd2..dd75c5020c6 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -174,9 +174,10 @@ which are currently exclusively available to sponsors:
+- [x] [Content tabs: anchor links] :material-alert-decagram:{ title="Added on June 4, 2022" } - [x] [Navigation pruning] :material-alert-decagram:{ title="Added on May 25, 2022" } - [x] [Tooltips] :material-alert-decagram:{ title="Added on May 8, 2022" } -- [x] [Chinese search support] :material-alert-decagram:{ title="Added on May 5, 2022" } +- [x] [Chinese search support] - [x] [Tag icons] - [x] [Card grids] - [x] [Offline plugin] @@ -256,7 +257,7 @@ are released for general availability. - [x] [Navigation icons] - [x] [Navigation pruning] - [ ] Navigation status badges -- [ ] Blog +- [ ] Blog plugin [Annotations]: ../reference/annotations.md [Chinese search support]: ../blog/2022/chinese-search-support.md @@ -268,13 +269,20 @@ are released for general availability. - [x] [Privacy plugin] - [x] [Card grids] - [x] [Tooltips] -- [ ] [Instant previews] +- [x] [Content tabs: anchor links] - [ ] Intelligent color palette (system preference) - [ ] Document authors/contributors [Privacy plugin]: ../setup/ensuring-data-privacy.md [Card grids]: ../reference/grids.md [Tooltips]: ../reference/tooltips.md + [Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links + +#### $ 16,000 – Chipotle + +- [ ] [Instant previews] +- [ ] ... more to be announced + [Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743 ### Goals completed diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md index 2f92ece1760..6fd322adefe 100644 --- a/docs/reference/content-tabs.md +++ b/docs/reference/content-tabs.md @@ -31,6 +31,30 @@ See additional configuration options: [SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences [Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed +### Anchor links :material-alert-decagram:{ title="Added on June 4, 2022" } + +[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · +[:octicons-tag-24: insiders-4.17.0][Insiders] · +:octicons-beaker-24: Experimental + +In order to link to content tabs and share them more easily, [Insiders] adds +an anchor link to each content tab automatically, which you can copy via right +click or open in a new tab: + +=== "Open me in a new tab ..." + +=== "... or me ..." + +=== "... or even me" + +You can copy the link of the tab and create a link on the same or any other +page. For example, you can [jump to the third tab above this paragraph][tab_1] +or to the [publishing guide for Insiders][tab_2]. + + [Insiders]: ../insiders/index.md + [tab_1]: #__tabbed_1_3 + [tab_2]: ../publishing-your-site.md#__tabbed_1_2 + ### Linked content tabs [:octicons-tag-24: 8.3.0][link support] · diff --git a/docs/reference/tooltips.md b/docs/reference/tooltips.md index 0a60c446ba7..fa167b84cb3 100644 --- a/docs/reference/tooltips.md +++ b/docs/reference/tooltips.md @@ -33,7 +33,7 @@ See additional configuration options: [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists [Snippets]: ../setup/extensions/python-markdown-extensions.md#snippets -### Improved tooltips +### Improved tooltips :material-alert-decagram:{ title="Added on May 8, 2022" } [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: insiders-4.15.0][Insiders] · diff --git a/docs/setup/extensions/python-markdown.md b/docs/setup/extensions/python-markdown.md index 097085814eb..5b51fa65336 100644 --- a/docs/setup/extensions/python-markdown.md +++ b/docs/setup/extensions/python-markdown.md @@ -168,7 +168,7 @@ No configuration options are available. See reference for usage: - [Setting the page icon] - [Setting the page template] - [Adding tags] -- [Hiding the tags] +- [Hiding tags on a page] - [Hiding the sidebars] - [Hiding the feedback widget] @@ -179,7 +179,7 @@ No configuration options are available. See reference for usage: [Setting the page icon]: ../../reference/index.md#setting-the-page-icon [Setting the page template]: ../../reference/index.md#setting-the-page-template [Adding tags]: ../../setup/setting-up-tags.md#adding-tags - [Hiding the tags]: ../../setup/setting-up-tags.md#hiding-the-tags + [Hiding tags on a page]: ../../setup/setting-up-tags.md#hiding-tags-on-a-page [Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars [Hiding the feedback widget]: ../../setup/setting-up-site-analytics.md#hiding-the-feedback-widget diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index acf915b7aa4..28d0aa0e224 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -180,7 +180,7 @@ theme: [navigation.expand enabled]: ../assets/screenshots/navigation-expand.png [navigation.expand disabled]: ../assets/screenshots/navigation.png -### Navigation pruning +### Navigation pruning :material-alert-decagram:{ title="Added on May 25, 2022" } [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: insiders-4.16.0][Insiders] · diff --git a/docs/setup/setting-up-the-footer.md b/docs/setup/setting-up-the-footer.md index b1698661202..3507765e3d6 100644 --- a/docs/setup/setting-up-the-footer.md +++ b/docs/setup/setting-up-the-footer.md @@ -148,6 +148,26 @@ extra: [Generator notice support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0 [Insiders]: ../insiders/index.md +## Usage + +### Hiding prev/next links + +When [Metadata] is enabled, the footer navigation showing links to the previous +and next page can be hidden by adding the following lines to the front matter of +a page: + +``` sh +--- +hide: + - footer +--- + +# Document title +... +``` + +[Metadata]: extensions/python-markdown.md#metadata + ## Customization ### Custom copyright diff --git a/material/base.html b/material/base.html index 709336e5675..8eca608dfa6 100644 --- a/material/base.html +++ b/material/base.html @@ -22,7 +22,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index d5597ec9224..9532eab6af6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mkdocs-material", - "version": "8.3.0", + "version": "8.3.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mkdocs-material", - "version": "8.3.0", + "version": "8.3.1", "license": "MIT", "dependencies": { "array-flat-polyfill": "^1.0.1", diff --git a/package.json b/package.json index a806a70d840..f23147ceb88 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "8.3.0", + "version": "8.3.1", "description": "Documentation that simply works", "keywords": [ "mkdocs",