diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 6dd732d6d..7c9599a13 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -50,7 +50,7 @@ body: description: >- Please create a __minimal reproduction__ for the bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/) - that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#built-in-info-plugin) (mandatory) to create a self-contained + that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#creating-a-zip-file) (mandatory) to create a self-contained .zip file with the reproduction. Without a reproduction, it can be challenging to fix the bug. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction) placeholder: |- diff --git a/docs/bug-report/index.md b/docs/bug-report/index.md index 6c7b841cd..39fd87569 100644 --- a/docs/bug-report/index.md +++ b/docs/bug-report/index.md @@ -265,7 +265,7 @@ automatically upload it to GitHub. have trouble creating repositories. [Create reproduction]: reproduction.md - [built-in info plugin]: reproduction.md#built-in-info-plugin + [built-in info plugin]: reproduction.md#creating-a-zip-file ### Steps to reproduce diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index f2121ed5c..4eac4d266 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -34,8 +34,7 @@ See additional configuration options: ### Admonition icons -[:octicons-tag-24: 8.3.0][Admonition icons support] · -:octicons-beaker-24: Experimental +[:octicons-tag-24: 8.3.0][Admonition icons support] Each of the supported admonition types has a distinct icon, which can be changed to any icon bundled with the theme, or even a [custom icon]. Add the following @@ -230,9 +229,6 @@ Adding a `+` after the `???` token renders the block expanded: ### Inline blocks -[:octicons-tag-24: 7.0.0][Inline blocks support] · -:octicons-beaker-24: Experimental - Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing them to the right using the `inline` + `end` modifiers, or to the left using only the `inline` modifier: @@ -282,8 +278,6 @@ prior to the content block you want to place them beside. If there's insufficient space to render the admonition next to the block, the admonition will stretch to the full width of the viewport, e.g. on mobile viewports. - [Inline blocks support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0 - ### Supported types Following is a list of type qualifiers provided by Material for MkDocs, whereas diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md index 15fe47c73..fc01226d7 100644 --- a/docs/reference/content-tabs.md +++ b/docs/reference/content-tabs.md @@ -75,8 +75,7 @@ or to the [publishing guide for Insiders][tab_2]. ### Linked content tabs [:octicons-tag-24: 8.3.0][Linked content tabs support] · -:octicons-unlock-24: Feature flag · -:octicons-beaker-24: Experimental +:octicons-unlock-24: Feature flag When enabled, all content tabs across the whole documentation site will be linked and switch to the same label when the user clicks on a tab. Add the diff --git a/docs/reference/diagrams.md b/docs/reference/diagrams.md index 0521ef7cf..458ef8f1d 100644 --- a/docs/reference/diagrams.md +++ b/docs/reference/diagrams.md @@ -13,8 +13,7 @@ popular and flexible solution for drawing diagrams. ## Configuration -[:octicons-tag-24: 8.2.0][Diagrams support] · -:octicons-beaker-24: Experimental +[:octicons-tag-24: 8.2.0][Diagrams support] This configuration enables native support for [Mermaid.js] diagrams. Material for MkDocs will automatically initialize the JavaScript runtime when a page diff --git a/docs/reference/images.md b/docs/reference/images.md index cbb30f2bb..729107dab 100644 --- a/docs/reference/images.md +++ b/docs/reference/images.md @@ -154,8 +154,7 @@ browsers without support: ### Light and dark mode -[:octicons-tag-24: 8.1.1][Light and dark mode support] · -:octicons-beaker-24: Experimental +[:octicons-tag-24: 8.1.1][Light and dark mode support] If you added a [color palette toggle] and want to show different images for light and dark color schemes, you can append a `#only-light` or `#only-dark` diff --git a/docs/schema/plugins/info.json b/docs/schema/plugins/info.json index de4b18f5f..26cc6236a 100644 --- a/docs/schema/plugins/info.json +++ b/docs/schema/plugins/info.json @@ -3,7 +3,7 @@ "title": "Built-in info plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#built-in-info-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", "enum": [ "info" ] @@ -12,12 +12,12 @@ "type": "object", "properties": { "info": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#built-in-info-plugin", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#+info.enabled", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file", "type": "boolean", "default": true } diff --git a/docs/setup/changing-the-language.md b/docs/setup/changing-the-language.md index 7d6888aa7..baa4c2424 100644 --- a/docs/setup/changing-the-language.md +++ b/docs/setup/changing-the-language.md @@ -105,8 +105,7 @@ the default slug function works. Consider using a [Unicode-aware slug function]. ### Site language selector [:octicons-tag-24: 7.0.0][Site language selector support] · -:octicons-milestone-24: Default: _none_ · -:octicons-beaker-24: Experimental +:octicons-milestone-24: Default: _none_ If your documentation is available in multiple languages, a language selector pointing to those languages can be added to the header. Alternate languages diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 0ac14e9e3..40dd75892 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -37,8 +37,7 @@ especially useful for large documentation sites. ### Anchor tracking [:octicons-tag-24: 8.0.0][Anchor tracking support] · -:octicons-unlock-24: Feature flag · -:octicons-beaker-24: Experimental +:octicons-unlock-24: Feature flag When anchor tracking is enabled, the URL in the address bar is automatically updated with the active anchor as highlighted in the table of contents. Add the diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index 9ec16ca0c..e27c1f143 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -67,8 +67,7 @@ following lines to `mkdocs.yml`: ### Was this page helpful? [:octicons-tag-24: 8.4.0][Was this page helpful? support] · -:octicons-milestone-24: Default: _none_ · -:octicons-beaker-24: Experimental +:octicons-milestone-24: Default: _none_ A simple [feedback widget] can be included at the bottom of each page, encouraging users to give instant feedback whether a page was helpful or not. diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index 8b84cecc6..30ed0c935 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -12,8 +12,7 @@ can help to discover relevant information faster. ### Built-in tags plugin [:octicons-tag-24: 8.2.0][Tags support] · -:octicons-cpu-24: Plugin · -:octicons-beaker-24: Experimental +:octicons-cpu-24: Plugin The built-in tags plugin adds the ability to categorize any page with tags as part of the front matter of the page. In order to add support for tags, add diff --git a/docs/upgrade.md b/docs/upgrade.md index fe9ad9ab1..3e03fea77 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -3,7 +3,7 @@ Upgrade to the latest version with: ``` -pip install --upgrade mkdocs-material +pip install --upgrade --force-reinstall mkdocs-material ``` Show the currently installed version with: