From db09bd0cf0478c76d62dcfbc18a561ea942fcdb3 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 13 Nov 2021 12:22:30 +0100 Subject: [PATCH 1/3] Updated Insiders documentation --- docs/insiders/index.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index be4b4ea45..1bb5111e6 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -174,10 +174,7 @@ The following features are solely available via Material for MkDocs Insiders: - [x] [Boosting pages in search] - [x] [Tags] with search integration - [x] [Stay on page when switching versions] -- [x] [Version warning] - [x] [Custom admonition icons] -- [x] [Code annotations] -- [x] [Anchor tracking] - [x] [Mermaid.js integration] @@ -192,16 +189,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features are released for general availability. -#### $ 4,000 – Ghost Pepper - -- [x] [Anchor tracking] -- [x] [Code annotations] -- [x] [Version warning] - - [Anchor tracking]: ../setup/setting-up-navigation.md#anchor-tracking - [Code annotations]: ../reference/code-blocks.md#adding-annotations - [Version warning]: ../setup/setting-up-versioning.md#version-warning - #### $ 5,000 – Aji Panca - [x] [Mermaid.js integration] @@ -259,6 +246,16 @@ This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users. +#### $ 4,000 – Ghost Pepper + +- [x] [Anchor tracking] +- [x] [Code annotations] +- [x] [Version warning] + + [Anchor tracking]: ../setup/setting-up-navigation.md#anchor-tracking + [Code annotations]: ../reference/code-blocks.md#adding-annotations + [Version warning]: ../setup/setting-up-versioning.md#version-warning + #### $ 3,000 – Caribbean Red - [x] [Sticky navigation tabs] From 6e0e7997531056c1ba756ca76b7917fba9221a39 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 13 Nov 2021 14:45:44 +0100 Subject: [PATCH 2/3] Documentation --- docs/reference/code-blocks.md | 5 ++--- docs/setup/setting-up-navigation.md | 5 ++--- docs/setup/setting-up-versioning.md | 7 ++++--- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index 7aab50578..29f7048f7 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -43,8 +43,7 @@ See additional configuration options: ### Code annotations -[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-2.2.0][Insiders] · +[:octicons-tag-24: 8.0.0b1][Code annotations support] · :octicons-unlock-24: Feature flag · :octicons-beaker-24: Experimental @@ -78,7 +77,7 @@ theme: Note that the language shortcode which has to come first must now also be prefixed by a `.`. - [Insiders]: ../insiders/index.md + [Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1 [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists ## Usage diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 292039a20..04b136d3c 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -41,8 +41,7 @@ especially useful for large documentation sites. ### Anchor tracking -[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-2.1.0][Insiders] · +[:octicons-tag-24: 8.0.0b1][Anchor tracking support] · :octicons-unlock-24: Feature flag · :octicons-beaker-24: Experimental @@ -56,7 +55,7 @@ theme: - navigation.tracking ``` - [Insiders]: ../insiders/index.md + [Anchor tracking support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1 ### Navigation tabs diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index 37c07c1a4..923dd57e2 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -62,8 +62,7 @@ Check out the versioning example to see it in action – ### Version warning -[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-2.5.0][Insiders] · +[:octicons-tag-24: 8.0.0b1][Version warning support] · :octicons-file-symlink-file-24: Customization If you're using versioning, you might want to display a warning when the user @@ -103,7 +102,7 @@ extra: Make sure that this matches the [default version]. - [Insiders]: ../insiders/index.md + [Version warning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1 [theme extension]: ../customization.md#extending-the-theme [overriding blocks]: ../customization.md#overriding-blocks [Version warning preview]: ../assets/screenshots/version-warning.png @@ -134,6 +133,8 @@ the current page: docs.example.com/0.1/bar/ -> docs.example.com/0.2/ ``` + [Insiders]: ../insiders/index.md + ## Usage While this section outlines the basic workflow for publishing new versions, From 9dd23f6926ca5910d4323d87653f4fb3df17369d Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 13 Nov 2021 14:54:08 +0100 Subject: [PATCH 3/3] Added note on new beta to getting started guide --- docs/getting-started.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 8643b5908..fbda5e5b9 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -16,6 +16,16 @@ If not, we recommended using [`docker`][docker]. ## Installation +!!! danger "8.0.0 Beta 1 is out!" + + Help test the latest version of Material for MkDocs, introducing many new + features and improvements like [code annotations], [anchor tracking] and + [version warnings]. See #3219 for installation and upgrade instructions. + + [code annotations]: reference/code-blocks.md#code-annotations + [anchor tracking]: setup/setting-up-navigation.md#anchor-tracking + [version warnings]: setup/setting-up-versioning.md#version-warning + ### with pip recommended { #with-pip data-toc-label="with pip" } Material for MkDocs can be installed with `pip`: