mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-07-29 09:12:35 -04:00
Prepare 8.5.0 release
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
@@ -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/
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user