From 396941144db28a32d9d4e76fd7d4f8fe5a6daa19 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 13 Sep 2022 13:27:13 +0200 Subject: [PATCH] Prepare 8.5.0 release --- CHANGELOG | 19 ++++++++++++++ docs/changelog/index.md | 9 +++++++ docs/insiders/changelog.md | 10 +++++++ docs/insiders/index.md | 38 +++++++++++---------------- docs/reference/code-blocks.md | 19 +++++++------- docs/setup/setting-up-navigation.md | 6 ++--- docs/setup/setting-up-social-cards.md | 28 +++++++------------- docs/setup/setting-up-tags.md | 12 ++++----- material/base.html | 2 +- package-lock.json | 4 +-- package.json | 2 +- 11 files changed, 86 insertions(+), 63 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index bfd48068a..dd0c41fea 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,22 @@ +mkdocs-material-8.5.0+insiders-4.23.3 (2022-09-13) + + * Fixed previous and next page links for drafts of blog posts + +mkdocs-material-8.5.0 (2022-09-13) + + * Added support for social cards + * Added support for code annotation anchor links (deep linking) + * Added support for code annotation comment stripping (syntax modifier) + * Added support for sidebars scrolling automatically to active item + * Added support for anchor following table of contents (= auto scroll) + * Added support for tag icons + +mkdocs-material-8.4.4+insiders-4.23.2 (2022-09-13) + + * Fixed #4348: Blog plugin crashes on custom `nav` title + * Fixed blog plugin crashing when category contained only drafts + * Fixed rendering of content from blog index file + mkdocs-material-8.4.4+insiders-4.23.1 (2022-09-12) * Fixed #4345: Blog plugin errors with default settings diff --git a/docs/changelog/index.md b/docs/changelog/index.md index c5706624f..c8fe2eb59 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -6,6 +6,15 @@ template: overrides/main.html ## Material for MkDocs +### 8.5.0 _ September 13, 2022 { id="8.5.0" } + +- Added support for social cards +- Added support for code annotation anchor links (deep linking) +- Added support for code annotation comment stripping (syntax modifier) +- Added support for sidebars scrolling automatically to active item +- Added support for anchor following table of contents (= auto scroll) +- Added support for tag icons + ### 8.4.4 _ September 12, 2022 { id="8.4.4" } - Moved comments integration to separate partial (`comments.html`) diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 4fe307048..ca5135cef 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,6 +6,16 @@ template: overrides/main.html ## Material for MkDocs Insiders +### 4.23.3 _ September 13, 2022 { id="4.23.3" } + +- Fixed previous and next page links for drafts of blog posts + +### 4.23.2 _ September 13, 2022 { id="4.23.2" } + +- Fixed #4348: Blog plugin crashes on custom `nav` title +- Fixed blog plugin crashing when category contained only drafts +- Fixed rendering of content from blog index file + ### 4.23.1 _ September 12, 2022 { id="4.23.1" } - Fixed #4345: Blog plugin errors with default settings diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 57c1c6aa6..3790aad68 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -82,7 +82,7 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 27 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:
@@ -98,22 +98,16 @@ which are currently exclusively available to sponsors: - [x] [Navigation pruning] - [x] [Tooltips] - [x] [Chinese search support] -- [x] [Tag icons] - [x] [Card grids] - [x] [Offline plugin] - [x] [Privacy plugin] -- [x] [Table of contents anchor following] - [x] [Annotations] - [x] [Navigation icons] -- [x] Sidebars automatically scroll to active item -- [x] [Code annotations: anchor links] -- [x] [Code annotations: strip comments] - [x] [Brand new search plugin] - [x] [Rich search previews] - [x] [Tokenizer with lookahead] - [x] [Advanced search highlighting] - [x] [Excluding content from search] -- [x] [Social cards]
@@ -236,21 +230,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. -#### $ 8,000 – Scotch Bonnet - -- [x] [Social cards] -- [x] [Code annotations: anchor links] -- [x] [Code annotations: strip comments] -- [x] [Tag icons] -- [x] [Table of contents anchor following] -- [x] Sidebars automatically scroll to active item - - [Social cards]: ../setup/setting-up-social-cards.md - [Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links - [Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments - [Tag icons]: ../setup/setting-up-tags.md#tag-icons - [Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following - #### $ 10,000 – Carolina Reaper - [x] [Brand new search plugin] @@ -319,6 +298,21 @@ 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. +#### $ 8,000 – Scotch Bonnet + +- [x] [Social cards] +- [x] [Code annotations: anchor links] +- [x] [Code annotations: strip comments] +- [x] [Tag icons] +- [x] [Table of contents anchor following] +- [x] Sidebars automatically scroll to active item + + [Social cards]: ../setup/setting-up-social-cards.md + [Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links + [Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments + [Tag icons]: ../setup/setting-up-tags.md#tag-icons + [Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following + #### $ 7,000 – Royal Gold - [x] [Cookie consent] diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index e6b770aab..b2fc7da4e 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -83,13 +83,12 @@ theme: #### Anchor links -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-4.4.0][Insiders] · +[:octicons-tag-24: 8.5.0][Anchor links support] · :octicons-beaker-24: Experimental -In order to link to code annotations and share them more easily, [Insiders] adds -an anchor link to each annotation automatically, which you can copy via right -click or open in a new tab: +In order to be able to link to code annotations and share them more easily, and +anchor link is automatically added to each annotation, which you can copy via +right click or open in a new tab: ``` yaml # (1)! @@ -99,7 +98,7 @@ click or open in a new tab: rendered open in a new tab. You can also right-click me to __copy link address__ to share me with others. - [Insiders]: ../insiders/index.md + [Anchor links support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0 ## Usage @@ -191,13 +190,11 @@ theme: #### Stripping comments -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-4.4.0][Insiders] · +[:octicons-tag-24: 8.5.0][Stripping comments support] · :octicons-beaker-24: Experimental If you wish to strip the comment characters surrounding a code annotation, -[Insiders] adds a new syntax that allows for just that. Simply add an `!` after -the closing parens of the code annotation: +simply add an `!` after the closing parenthesis of the code annotation: ```` markdown title="Code block with annotation, stripped" ``` yaml @@ -221,6 +218,8 @@ Note that this only allows for a single code annotation to be rendered per comment. If you want to add multiple code annotations, comments cannot be stripped for technical reasons. + [Stripping comments support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0 + ### Adding line numbers Line numbers can be added to a code block by using the `linenums=""` diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 3f59faae8..d3be1cef6 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -203,6 +203,7 @@ This feature flag is especially useful for documentation sites with 100+ or even Navigation pruning will replace all expandable sections with links to the first page in that section (or the section index page). + [Insiders]: ../insiders/index.md [navigation.expand]: #navigation-expansion ### Section index pages @@ -253,8 +254,7 @@ nav: #### Anchor following -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-4.8.0][Insiders] · +[:octicons-tag-24: 8.5.0][Anchor following support] · :octicons-beaker-24: Experimental When anchor following for the [table of contents] is enabled, the sidebar is @@ -267,7 +267,7 @@ theme: - toc.follow ``` - [Insiders]: ../insiders/index.md + [Anchor following support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0 #### Navigation integration diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index 3acd47c69..0e64a87e4 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -39,8 +39,7 @@ The social preview image for the page on [setting up site analytics]. ### Built-in social plugin -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-2.12.0][Insiders] · +[:octicons-tag-24: 8.5.0][Social cards support] · :octicons-cpu-24: Plugin · :octicons-beaker-24: Experimental @@ -53,10 +52,6 @@ plugins: - social ``` -> If you need to be able to build your documentation with and without -> [Insiders], please refer to the [built-in plugins] section to learn how -> shared configurations help to achieve this. - The following configuration options are available: [`cards`](#+social.cards){ #+social.cards } @@ -73,10 +68,9 @@ The following configuration options are available: [`cards_color`](#+social.cards_color){ #+social.cards_color } -: [:octicons-tag-24: insiders-2.13.0][Insiders] · :octicons-milestone-24: - Default: [`theme.palette.primary`][palette.primary] – This option specifies - the colors for the background `fill` and foreground `text` when generating - the social card: +: :octicons-milestone-24: Default: [`theme.palette.primary`][palette.primary] + – This option specifies the colors for the background `fill` and foreground + `text` when generating the social card: ``` yaml plugins: @@ -91,10 +85,9 @@ The following configuration options are available: [`cards_font`](#+social.cards_font){ #+social.cards_font } -: [:octicons-tag-24: insiders-4.3.0][Insiders] · :octicons-milestone-24: - Default: [`theme.font.text`][font.text] – This option specifies which font - to use for rendering the social card, which can be any font hosted on - [Google Fonts]: +: :octicons-milestone-24: Default: [`theme.font.text`][font.text] – This + option specifies which font to use for rendering the social card, which can + be any font hosted on [Google Fonts]: ``` yaml plugins: @@ -114,10 +107,9 @@ The following configuration options are available: cards_dir: path/to/folder ``` - [Insiders]: ../insiders/index.md + [Social cards support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0 [dependencies]: #dependencies [site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url - [built-in plugins]: ../insiders/getting-started.md#built-in-plugins [palette.primary]: changing-the-colors.md#primary-color [font.text]: changing-the-fonts.md#regular-font [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables @@ -132,7 +124,7 @@ social preview images, both of which are based on the [Cairo Graphics] library: - [Pillow] – Python imaging library - [CairoSVG] – Converter for `*.svg` files -The [Docker image] for Insiders comes with all dependencies pre-installed. If +The [Docker image] comes with all dependencies pre-installed. If you don't want to use Docker, see the following section which explains how to install all dependencies on your system: @@ -179,7 +171,7 @@ install all dependencies on your system: [Cairo Graphics]: https://www.cairographics.org/ [Pillow]: https://pillow.readthedocs.io/ [CairoSVG]: https://cairosvg.org/ - [Docker image]: ../insiders/getting-started.md#with-docker + [Docker image]: https://hub.docker.com/r/squidfunk/mkdocs-material/ [Homebrew]: https://brew.sh/ [installation guide]: https://www.cairographics.org/download/ [GTK+]: https://www.gtk.org/docs/installations/windows/ diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index e1b5dcdbd..481430ade 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -87,12 +87,12 @@ The following configuration options are available: See #3864 for additional use cases. [Tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0 + [Insiders]: ../insiders/index.md [tag identifiers]: #tag-icons ### Tag icons -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-4.13.0][Insiders] · +[:octicons-tag-24: 8.5.0][Tag icons support] · :octicons-beaker-24: Experimental Each tag can be associated with an icon, which is then rendered inside the tag. @@ -118,9 +118,9 @@ extra: Identifiers can be reused between tags. Tags which are not explicitly associated will use the default tag icon which is :material-pound: -Next, each identifier can be associated with an icon, or even a [custom icon], -by adding the following lines to `mkdocs.yml` under the `theme.icon` -configuration setting: +Next, each identifier can be associated with an icon, even a [custom icon], by +adding the following lines to `mkdocs.yml` under the `theme.icon` configuration +setting: === "Tag icon" @@ -167,7 +167,7 @@ configuration setting: CSS: css ``` - [Insiders]: ../insiders/index.md + [Tag icons support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0 [custom icon]: changing-the-logo-and-icons.md#additional-icons [icon search]: ../reference/icons-emojis.md#search diff --git a/material/base.html b/material/base.html index a4c3cc5c5..b67d5b7f6 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 d9aab7c68..9a9b6abf7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mkdocs-material", - "version": "8.4.4", + "version": "8.5.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mkdocs-material", - "version": "8.4.4", + "version": "8.5.0", "license": "MIT", "dependencies": { "array-flat-polyfill": "^1.0.1", diff --git a/package.json b/package.json index ec601ef78..a0f2384f8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "8.4.4", + "version": "8.5.0", "description": "Documentation that simply works", "keywords": [ "mkdocs",