Skip to content

Commit 3969411

Browse files
committed
Prepare 8.5.0 release
1 parent 5181ed4 commit 3969411

11 files changed

+86
-63
lines changed

CHANGELOG

+19
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
mkdocs-material-8.5.0+insiders-4.23.3 (2022-09-13)
2+
3+
* Fixed previous and next page links for drafts of blog posts
4+
5+
mkdocs-material-8.5.0 (2022-09-13)
6+
7+
* Added support for social cards
8+
* Added support for code annotation anchor links (deep linking)
9+
* Added support for code annotation comment stripping (syntax modifier)
10+
* Added support for sidebars scrolling automatically to active item
11+
* Added support for anchor following table of contents (= auto scroll)
12+
* Added support for tag icons
13+
14+
mkdocs-material-8.4.4+insiders-4.23.2 (2022-09-13)
15+
16+
* Fixed #4348: Blog plugin crashes on custom `nav` title
17+
* Fixed blog plugin crashing when category contained only drafts
18+
* Fixed rendering of content from blog index file
19+
120
mkdocs-material-8.4.4+insiders-4.23.1 (2022-09-12)
221

322
* Fixed #4345: Blog plugin errors with default settings

docs/changelog/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ template: overrides/main.html
66

77
## Material for MkDocs
88

9+
### 8.5.0 <small>_ September 13, 2022</small> { id="8.5.0" }
10+
11+
- Added support for social cards
12+
- Added support for code annotation anchor links (deep linking)
13+
- Added support for code annotation comment stripping (syntax modifier)
14+
- Added support for sidebars scrolling automatically to active item
15+
- Added support for anchor following table of contents (= auto scroll)
16+
- Added support for tag icons
17+
918
### 8.4.4 <small>_ September 12, 2022</small> { id="8.4.4" }
1019

1120
- Moved comments integration to separate partial (`comments.html`)

docs/insiders/changelog.md

+10
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ template: overrides/main.html
66

77
## Material for MkDocs Insiders
88

9+
### 4.23.3 <small>_ September 13, 2022</small> { id="4.23.3" }
10+
11+
- Fixed previous and next page links for drafts of blog posts
12+
13+
### 4.23.2 <small>_ September 13, 2022</small> { id="4.23.2" }
14+
15+
- Fixed #4348: Blog plugin crashes on custom `nav` title
16+
- Fixed blog plugin crashing when category contained only drafts
17+
- Fixed rendering of content from blog index file
18+
919
### 4.23.1 <small>_ September 12, 2022</small> { id="4.23.1" }
1020

1121
- Fixed #4345: Blog plugin errors with default settings

docs/insiders/index.md

+16-22
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ a handful of them, [thanks to our awesome sponsors]!
8282
## What's in for me?
8383

8484
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
85-
access to 27 additional features__ that you can start using right away, and
85+
access to 21 additional features__ that you can start using right away, and
8686
which are currently exclusively available to sponsors:
8787

8888
<div class="mdx-columns" markdown>
@@ -98,22 +98,16 @@ which are currently exclusively available to sponsors:
9898
- [x] [Navigation pruning]
9999
- [x] [Tooltips]
100100
- [x] [Chinese search support]
101-
- [x] [Tag icons]
102101
- [x] [Card grids]
103102
- [x] [Offline plugin]
104103
- [x] [Privacy plugin]
105-
- [x] [Table of contents anchor following]
106104
- [x] [Annotations]
107105
- [x] [Navigation icons]
108-
- [x] Sidebars automatically scroll to active item
109-
- [x] [Code annotations: anchor links]
110-
- [x] [Code annotations: strip comments]
111106
- [x] [Brand new search plugin]
112107
- [x] [Rich search previews]
113108
- [x] [Tokenizer with lookahead]
114109
- [x] [Advanced search highlighting]
115110
- [x] [Excluding content from search]
116-
- [x] [Social cards]
117111

118112
</div>
119113

@@ -236,21 +230,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
236230
: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
237231
are released for general availability.
238232

239-
#### $ 8,000 – Scotch Bonnet
240-
241-
- [x] [Social cards]
242-
- [x] [Code annotations: anchor links]
243-
- [x] [Code annotations: strip comments]
244-
- [x] [Tag icons]
245-
- [x] [Table of contents anchor following]
246-
- [x] Sidebars automatically scroll to active item
247-
248-
[Social cards]: ../setup/setting-up-social-cards.md
249-
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
250-
[Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments
251-
[Tag icons]: ../setup/setting-up-tags.md#tag-icons
252-
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
253-
254233
#### $ 10,000 – Carolina Reaper
255234

256235
- [x] [Brand new search plugin]
@@ -319,6 +298,21 @@ This section lists all funding goals that were previously completed, which means
319298
that those features were part of Insiders, but are now generally available and
320299
can be used by all users.
321300

301+
#### $ 8,000 – Scotch Bonnet
302+
303+
- [x] [Social cards]
304+
- [x] [Code annotations: anchor links]
305+
- [x] [Code annotations: strip comments]
306+
- [x] [Tag icons]
307+
- [x] [Table of contents anchor following]
308+
- [x] Sidebars automatically scroll to active item
309+
310+
[Social cards]: ../setup/setting-up-social-cards.md
311+
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
312+
[Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments
313+
[Tag icons]: ../setup/setting-up-tags.md#tag-icons
314+
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
315+
322316
#### $ 7,000 – Royal Gold
323317

324318
- [x] [Cookie consent]

docs/reference/code-blocks.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,12 @@ theme:
8383

8484
#### Anchor links
8585

86-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
87-
[:octicons-tag-24: insiders-4.4.0][Insiders] ·
86+
[:octicons-tag-24: 8.5.0][Anchor links support] ·
8887
:octicons-beaker-24: Experimental
8988

90-
In order to link to code annotations and share them more easily, [Insiders] adds
91-
an anchor link to each annotation automatically, which you can copy via right
92-
click or open in a new tab:
89+
In order to be able to link to code annotations and share them more easily, and
90+
anchor link is automatically added to each annotation, which you can copy via
91+
right click or open in a new tab:
9392

9493
``` yaml
9594
# (1)!
@@ -99,7 +98,7 @@ click or open in a new tab:
9998
rendered open in a new tab. You can also right-click me to __copy link
10099
address__ to share me with others.
101100

102-
[Insiders]: ../insiders/index.md
101+
[Anchor links support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
103102

104103
## Usage
105104

@@ -191,13 +190,11 @@ theme:
191190

192191
#### Stripping comments
193192

194-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
195-
[:octicons-tag-24: insiders-4.4.0][Insiders] ·
193+
[:octicons-tag-24: 8.5.0][Stripping comments support] ·
196194
:octicons-beaker-24: Experimental
197195

198196
If you wish to strip the comment characters surrounding a code annotation,
199-
[Insiders] adds a new syntax that allows for just that. Simply add an `!` after
200-
the closing parens of the code annotation:
197+
simply add an `!` after the closing parenthesis of the code annotation:
201198

202199
```` markdown title="Code block with annotation, stripped"
203200
``` yaml
@@ -221,6 +218,8 @@ Note that this only allows for a single code annotation to be rendered per
221218
comment. If you want to add multiple code annotations, comments cannot be
222219
stripped for technical reasons.
223220

221+
[Stripping comments support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
222+
224223
### Adding line numbers
225224

226225
Line numbers can be added to a code block by using the `linenums="<start>"`

docs/setup/setting-up-navigation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ This feature flag is especially useful for documentation sites with 100+ or even
203203
Navigation pruning will replace all expandable sections with links to the first
204204
page in that section (or the section index page).
205205

206+
[Insiders]: ../insiders/index.md
206207
[navigation.expand]: #navigation-expansion
207208

208209
### Section index pages
@@ -253,8 +254,7 @@ nav:
253254

254255
#### Anchor following
255256

256-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
257-
[:octicons-tag-24: insiders-4.8.0][Insiders] ·
257+
[:octicons-tag-24: 8.5.0][Anchor following support] ·
258258
:octicons-beaker-24: Experimental
259259

260260
When anchor following for the [table of contents] is enabled, the sidebar is
@@ -267,7 +267,7 @@ theme:
267267
- toc.follow
268268
```
269269

270-
[Insiders]: ../insiders/index.md
270+
[Anchor following support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
271271

272272
#### Navigation integration
273273

docs/setup/setting-up-social-cards.md

+10-18
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ The social preview image for the page on [setting up site analytics].
3939

4040
### Built-in social plugin
4141

42-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
43-
[:octicons-tag-24: insiders-2.12.0][Insiders] ·
42+
[:octicons-tag-24: 8.5.0][Social cards support] ·
4443
:octicons-cpu-24: Plugin ·
4544
:octicons-beaker-24: Experimental
4645

@@ -53,10 +52,6 @@ plugins:
5352
- social
5453
```
5554
56-
> If you need to be able to build your documentation with and without
57-
> [Insiders], please refer to the [built-in plugins] section to learn how
58-
> shared configurations help to achieve this.
59-
6055
The following configuration options are available:
6156
6257
[`cards`](#+social.cards){ #+social.cards }
@@ -73,10 +68,9 @@ The following configuration options are available:
7368

7469
[`cards_color`](#+social.cards_color){ #+social.cards_color }
7570

76-
: [:octicons-tag-24: insiders-2.13.0][Insiders] · :octicons-milestone-24:
77-
Default: [`theme.palette.primary`][palette.primary] – This option specifies
78-
the colors for the background `fill` and foreground `text` when generating
79-
the social card:
71+
: :octicons-milestone-24: Default: [`theme.palette.primary`][palette.primary]
72+
– This option specifies the colors for the background `fill` and foreground
73+
`text` when generating the social card:
8074

8175
``` yaml
8276
plugins:
@@ -91,10 +85,9 @@ The following configuration options are available:
9185

9286
[`cards_font`](#+social.cards_font){ #+social.cards_font }
9387

94-
: [:octicons-tag-24: insiders-4.3.0][Insiders] · :octicons-milestone-24:
95-
Default: [`theme.font.text`][font.text] – This option specifies which font
96-
to use for rendering the social card, which can be any font hosted on
97-
[Google Fonts]:
88+
: :octicons-milestone-24: Default: [`theme.font.text`][font.text] – This
89+
option specifies which font to use for rendering the social card, which can
90+
be any font hosted on [Google Fonts]:
9891

9992
``` yaml
10093
plugins:
@@ -114,10 +107,9 @@ The following configuration options are available:
114107
cards_dir: path/to/folder
115108
```
116109

117-
[Insiders]: ../insiders/index.md
110+
[Social cards support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
118111
[dependencies]: #dependencies
119112
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
120-
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
121113
[palette.primary]: changing-the-colors.md#primary-color
122114
[font.text]: changing-the-fonts.md#regular-font
123115
[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:
132124
- [Pillow] – Python imaging library
133125
- [CairoSVG] – Converter for `*.svg` files
134126

135-
The [Docker image] for Insiders comes with all dependencies pre-installed. If
127+
The [Docker image] comes with all dependencies pre-installed. If
136128
you don't want to use Docker, see the following section which explains how to
137129
install all dependencies on your system:
138130

@@ -179,7 +171,7 @@ install all dependencies on your system:
179171
[Cairo Graphics]: https://www.cairographics.org/
180172
[Pillow]: https://pillow.readthedocs.io/
181173
[CairoSVG]: https://cairosvg.org/
182-
[Docker image]: ../insiders/getting-started.md#with-docker
174+
[Docker image]: https://hub.docker.com/r/squidfunk/mkdocs-material/
183175
[Homebrew]: https://brew.sh/
184176
[installation guide]: https://www.cairographics.org/download/
185177
[GTK+]: https://www.gtk.org/docs/installations/windows/

docs/setup/setting-up-tags.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ The following configuration options are available:
8787
See #3864 for additional use cases.
8888

8989
[Tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0
90+
[Insiders]: ../insiders/index.md
9091
[tag identifiers]: #tag-icons
9192

9293
### Tag icons
9394

94-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
95-
[:octicons-tag-24: insiders-4.13.0][Insiders] ·
95+
[:octicons-tag-24: 8.5.0][Tag icons support] ·
9696
:octicons-beaker-24: Experimental
9797

9898
Each tag can be associated with an icon, which is then rendered inside the tag.
@@ -118,9 +118,9 @@ extra:
118118
Identifiers can be reused between tags. Tags which are not explicitly
119119
associated will use the default tag icon which is :material-pound:
120120

121-
Next, each identifier can be associated with an icon, or even a [custom icon],
122-
by adding the following lines to `mkdocs.yml` under the `theme.icon`
123-
configuration setting:
121+
Next, each identifier can be associated with an icon, even a [custom icon], by
122+
adding the following lines to `mkdocs.yml` under the `theme.icon` configuration
123+
setting:
124124

125125
=== "Tag icon"
126126

@@ -167,7 +167,7 @@ configuration setting:
167167
CSS: css
168168
```
169169

170-
[Insiders]: ../insiders/index.md
170+
[Tag icons support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
171171
[custom icon]: changing-the-logo-and-icons.md#additional-icons
172172
[icon search]: ../reference/icons-emojis.md#search
173173

material/base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<link rel="canonical" href="{{ page.canonical_url }}">
2323
{% endif %}
2424
<link rel="icon" href="{{ config.theme.favicon | url }}">
25-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.4.4">
25+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.5.0">
2626
{% endblock %}
2727
{% block htmltitle %}
2828
{% if page.meta and page.meta.title %}

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "8.4.4",
3+
"version": "8.5.0",
44
"description": "Documentation that simply works",
55
"keywords": [
66
"mkdocs",

0 commit comments

Comments
 (0)