Skip to content

Commit e2556d8

Browse files
committed
Merge of features tied to 'Trinidad Scorpion' funding goal
1 parent a3f457e commit e2556d8

File tree

89 files changed

+13710
-299
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+13710
-299
lines changed

CHANGELOG

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
mkdocs-material-8.3.0 (2022-06-02)
2+
3+
* Added support for custom admonition icons
4+
* Added support for linking of content tabs
5+
* Added support for boosting pages in search
6+
* Added previous/next next indicators to content tabs
7+
* Improved typeset link colors in light and dark modes
8+
* Fixed #3954: add option to hide footer navigation
9+
110
mkdocs-material-8.2.16+insiders-4.16.2 (2022-05-28)
211

312
* Fixed #3961: Nested sections triggered build error for navigation tabs
-44.1 KB
Binary file not shown.
-46.1 KB
Binary file not shown.

docs/changelog/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ template: overrides/main.html
66

77
## Material for MkDocs
88

9+
### 8.3.0 <small>_ June 2, 2022</small> { id="8.3.0" }
10+
11+
- Added support for custom admonition icons
12+
- Added support for linking of content tabs
13+
- Added support for boosting pages in search
14+
- Added previous/next next indicators to content tabs
15+
- Fixed #3954: add option to hide footer navigation
16+
- Improved typeset link colors in light and dark modes
17+
918
### 8.2.16 <small>_ May 28, 2022</small> { id="8.2.16" }
1019

1120
- Fixed #3957: Only animate code annotations when visible (save CPU cycles)

docs/insiders/index.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,6 @@ which are currently exclusively available to sponsors:
195195
- [x] [Excluding content from search]
196196
- [x] [Social cards]
197197
- [x] [Cookie consent]
198-
- [x] [Linking content tabs]
199-
- [x] [Boosting pages in search]
200-
- [x] [Custom admonition icons]
201198

202199
</div>
203200

@@ -211,16 +208,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
211208
: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
212209
are released for general availability.
213210

214-
#### $ 6,000 – Trinidad Scorpion
215-
216-
- [x] [Boosting pages in search]
217-
- [x] [Custom admonition icons]
218-
- [x] [Linking content tabs]
219-
220-
[Boosting pages in search]: ../setup/setting-up-site-search.md#search-boosting
221-
[Custom admonition icons]: ../reference/admonitions.md#admonition-icons
222-
[Linking content tabs]: ../reference/content-tabs.md#linked-content-tabs
223-
224211
#### $ 7,000 – Royal Gold
225212

226213
- [x] [Cookie consent]
@@ -296,6 +283,16 @@ This section lists all funding goals that were previously completed, which means
296283
that those features were part of Insiders, but are now generally available and
297284
can be used by all users.
298285

286+
#### $ 6,000 – Trinidad Scorpion
287+
288+
- [x] [Boosting pages in search]
289+
- [x] [Custom admonition icons]
290+
- [x] [Linking content tabs]
291+
292+
[Boosting pages in search]: ../setup/setting-up-site-search.md#search-boosting
293+
[Custom admonition icons]: ../reference/admonitions.md#admonition-icons
294+
[Linking content tabs]: ../reference/content-tabs.md#linked-content-tabs
295+
299296
#### $ 5,000 – Aji Panca
300297

301298
- [x] [Mermaid.js integration]

docs/reference/admonitions.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ See additional configuration options:
3535
3636
### Admonition icons
3737
38-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
39-
[:octicons-tag-24: insiders-2.4.0][Insiders]
38+
[:octicons-tag-24: 8.3.0][icon support] ·
39+
:octicons-beaker-24: Experimental
4040
4141
Each of the supported admonition types has a distinct icon, which can be changed
4242
to any icon bundled with the theme, or even a [custom icon]. Add the following
@@ -82,12 +82,6 @@ theme:
8282
quote: octicons/quote-16
8383
```
8484

85-
<div class="result" markdown>
86-
87-
[![Octicons]][Octicons]
88-
89-
</div>
90-
9185

9286
=== ":fontawesome-brands-font-awesome: FontAwesome"
9387

@@ -109,18 +103,10 @@ theme:
109103
quote: fontawesome/solid/quote-left
110104
```
111105

112-
<div class="result" markdown>
113-
114-
[![FontAwesome]][FontAwesome]
115-
116-
</div>
117-
118-
[Insiders]: ../insiders/index.md
106+
[icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
119107
[custom icon]: ../setup/changing-the-logo-and-icons.md#additional-icons
120108
[supported types]: #supported-types
121109
[icon search]: icons-emojis.md#search
122-
[Octicons]: ../assets/screenshots/admonition-octicons.png
123-
[FontAwesome]: ../assets/screenshots/admonition-fontawesome.png
124110

125111
## Usage
126112

docs/reference/code-blocks.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ See additional configuration options:
4646
### Code annotations
4747
4848
[:octicons-tag-24: 8.0.0][Code annotations support] ·
49-
:octicons-unlock-24: Feature flag ·
50-
:octicons-beaker-24: Experimental
49+
:octicons-unlock-24: Feature flag
5150
5251
Code annotations offer a comfortable and friendly way to attach arbitrary
5352
content to specific sections of code blocks by adding numeric markers in block
@@ -127,8 +126,7 @@ import tensorflow as tf
127126

128127
### Adding a title
129128

130-
[:octicons-tag-24: 7.3.6][Title support] ·
131-
:octicons-beaker-24: Experimental
129+
[:octicons-tag-24: 7.3.6][Title support]
132130

133131
In order to provide additional context, a custom title can be added to a code
134132
block by using the `title="<custom title>"` option directly after the shortcode,

docs/reference/content-tabs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ See additional configuration options:
3333
3434
### Linked content tabs
3535
36-
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
37-
[:octicons-tag-24: insiders-2.9.0][Insiders] ·
36+
[:octicons-tag-24: 8.3.0][link support] ·
3837
:octicons-unlock-24: Feature flag ·
3938
:octicons-beaker-24: Experimental
4039
@@ -61,7 +60,7 @@ integrated with [instant loading] and persisted across page loads.
6160

6261
[![content.tabs.link disabled]][content.tabs.link disabled]
6362

64-
[Insiders]: ../insiders/index.md
63+
[link support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
6564
[instant loading]: ../setup/setting-up-navigation.md#instant-loading
6665
[content.tabs.link enabled]: ../assets/screenshots/content-tabs-link.png
6766
[content.tabs.link disabled]: ../assets/screenshots/content-tabs.png

docs/setup/building-for-offline-usage.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ support for many of its features.
1717

1818
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
1919
[:octicons-tag-24: insiders-4.10.0][Insiders] ·
20-
:octicons-cpu-24: Plugin ·
21-
:octicons-beaker-24: Experimental
20+
:octicons-cpu-24: Plugin
2221

2322
The built-in offline plugin makes sure that the [site search] works when you
2423
distribute the contents of your [site directory] as a download. Simply add

docs/setup/setting-up-navigation.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,7 @@ theme:
9696
#### Sticky navigation tabs
9797

9898
[:octicons-tag-24: 7.3.0][navigation.tabs.sticky support] ·
99-
:octicons-unlock-24: Feature flag ·
100-
:octicons-beaker-24: Experimental
99+
:octicons-unlock-24: Feature flag
101100

102101
When sticky tabs are enabled, navigation tabs will lock below the header and
103102
always remain visible when scrolling down. Just add the following two feature
@@ -211,8 +210,7 @@ page in that section (or the section index page).
211210
### Section index pages
212211

213212
[:octicons-tag-24: 7.3.0][navigation.indexes support] ·
214-
:octicons-unlock-24: Feature flag ·
215-
:octicons-beaker-24: Experimental
213+
:octicons-unlock-24: Feature flag
216214

217215
When section index pages are enabled, documents can be directly attached to
218216
sections, which is particularly useful for providing overview pages. Add the

0 commit comments

Comments
 (0)