Skip to content

Commit 43cdb91

Browse files
committed
Updated documentation
1 parent 1809b6c commit 43cdb91

23 files changed

+495
-574
lines changed

CHANGELOG

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ mkdocs-material-7.1.11+insiders-2.11.1 (2021-07-20)
138138

139139
mkdocs-material-7.1.11+insiders-2.11.0 (2021-07-18)
140140

141-
* Improved Mermaid.js intergration, now stable
141+
* Improved Mermaid.js integration, now stable
142142
* Added support for sequence diagrams
143143
* Added support for entity relationship diagrams
144144
* Added support for cookie consent configuration

docs/data-privacy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ CDN, which may be in breach with GDPR. The usage of Google's CDN can be [easily
1919
disabled][3] via `mkdocs.yml`.
2020

2121
[2]: setup/changing-the-fonts.md
22-
[3]: setup/changing-the-fonts.md#disabling-font-loading
22+
[3]: setup/changing-the-fonts.md#autoloading
2323

2424
### Google Analytics and Disqus
2525

docs/reference/admonitions.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@ See additional configuration options:
3535
### Admonition icons
3636
3737
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
38-
[:octicons-tag-24: insiders-2.4.0 ... present][Insiders]
38+
[:octicons-tag-24: insiders-2.4.0][Insiders]
3939
4040
Each of the supported admonition types has a distinct icon, which can be changed
41-
to any icon bundled with the theme. Add the following lines to `mkdocs.yml`:
41+
to any icon bundled with the theme, or even a [custom icon]. Add the following
42+
lines to `mkdocs.yml`:
4243

4344
``` yaml
4445
theme:
@@ -106,6 +107,7 @@ theme:
106107
[![FontAwesome]][FontAwesome]
107108

108109
[Insiders]: ../insiders/index.md
110+
[custom icon]: icons-emojis.md#additional-icons
109111
[supported types]: #supported-types
110112
[icon search]: icons-emojis.md#search
111113
[Octicons]: ../assets/screenshots/admonition-octicons.png
@@ -234,8 +236,8 @@ _Result_:
234236

235237
### Inline blocks
236238

237-
:octicons-beaker-24: Experimental ·
238-
[:octicons-tag-24: 7.0.0 ... present][Inline support]
239+
[:octicons-tag-24: 7.0.0][Inline support] ·
240+
:octicons-beaker-24: Experimental
239241

240242
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
241243
them to the right using the `inline` + `end` modifiers, or to the left using
@@ -441,7 +443,7 @@ _Example_:
441443
purus auctor massa, nec semper lorem quam in massa.
442444
```
443445

444-
=== ":octicons-file-code-16: docs/stylesheets/admonitions.css"
446+
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
445447

446448
``` css
447449
:root {
@@ -468,7 +470,7 @@ _Example_:
468470

469471
``` yaml
470472
extra_css:
471-
- stylesheets/admonitions.css
473+
- stylesheets/extra.css
472474
```
473475

474476
_Result_:

docs/reference/code-blocks.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ See additional configuration options:
4040
### Code annotations
4141
4242
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
43+
[:octicons-tag-24: insiders-2.2.0][Insiders] ·
4344
:octicons-unlock-24: Feature flag ·
44-
:octicons-beaker-24: Experimental ·
45-
[:octicons-tag-24: insiders-2.2.0 ... present][Insiders]
45+
:octicons-beaker-24: Experimental
4646
4747
Code annotations offer a comfortable and friendly way to attach arbitrary
4848
content to specific sections of code blocks by adding numeric markers in block
@@ -297,7 +297,7 @@ Let's say you want to change the color of `#!js "strings"`. While there are
297297
several [types of string tokens], they use the same color. You can assign
298298
a new color by using an [additional style sheet]:
299299

300-
=== ":octicons-file-code-16: docs/stylesheets/colors.css"
300+
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
301301

302302
``` css
303303
:root > * {
@@ -309,14 +309,14 @@ a new color by using an [additional style sheet]:
309309

310310
``` yaml
311311
extra_css:
312-
- stylesheets/colors.css
312+
- stylesheets/extra.css
313313
```
314314

315315
If you want to tweak a specific type of string, e.g. ``#!js `backticks` ``, you
316316
can lookup the specific CSS class name in the [syntax theme definition], and
317317
override it as part of your [additional style sheet]:
318318

319-
=== ":octicons-file-code-16: docs/stylesheets/colors.css"
319+
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
320320

321321
``` css
322322
.highlight .sb {
@@ -328,7 +328,7 @@ override it as part of your [additional style sheet]:
328328

329329
``` yaml
330330
extra_css:
331-
- stylesheets/colors.css
331+
- stylesheets/extra.css
332332
```
333333

334334
[colors]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/_colors.scss

docs/reference/content-tabs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ See additional configuration options:
3333
### Linked content tabs
3434
3535
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
36+
[:octicons-tag-24: insiders-2.9.0][Insiders] ·
3637
:octicons-unlock-24: Feature flag ·
37-
:octicons-beaker-24: Experimental ·
38-
[:octicons-tag-24: insiders-2.9.0 ... present][Insiders]
38+
:octicons-beaker-24: Experimental
3939
4040
When enabled, all content tabs across the whole documentation site will be
4141
linked and switch to the same label when the user clicks on a tab. Add the
@@ -54,16 +54,16 @@ integrated with [instant loading] and persisted across page loads.
5454

5555
=== ":octicons-check-circle-fill-16: Enabled"
5656

57-
[![linking enabled]][linking enabled]
57+
[![content.tabs.link enabled]][content.tabs.link enabled]
5858

5959
=== ":octicons-skip-16: Disabled"
6060

61-
[![linking disabled]][linking disabled]
61+
[![content.tabs.link disabled]][content.tabs.link disabled]
6262

6363
[Insiders]: ../insiders/index.md
6464
[instant loading]: ../setup/setting-up-navigation.md#instant-loading
65-
[linking enabled]: ../assets/screenshots/content-tabs-link.png
66-
[linking disabled]: ../assets/screenshots/content-tabs.png
65+
[content.tabs.link enabled]: ../assets/screenshots/content-tabs-link.png
66+
[content.tabs.link disabled]: ../assets/screenshots/content-tabs.png
6767

6868
## Usage
6969

docs/reference/diagrams.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ popular and flexible solution for drawing diagrams.
1414
## Configuration
1515

1616
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
17-
:octicons-beaker-24: Experimental ·
18-
[:octicons-tag-24: insiders-1.15.0 ... present][Insiders]
17+
[:octicons-tag-24: insiders-1.15.0][Insiders] ·
18+
:octicons-beaker-24: Experimental
1919

2020
This configuration enables native support for [Mermaid.js] diagrams. Material
2121
for MkDocs will automatically initialize the JavaScript runtime when a page

docs/reference/icons-emojis.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ See additional configuration options:
5757
[Material Design]: https://materialdesignicons.com/
5858
[FontAwesome]: https://fontawesome.com/icons?d=gallery&m=free
5959
[Octicons]: https://octicons.github.com/
60-
[additional icons]: ../setup/changing-the-logo-and-icons.md#additional-icons
6160
[Emoji]: ../setup/extensions/python-markdown-extensions.md#emoji
6261
[Emoji with custom icons]: ../setup/extensions/python-markdown-extensions.md#custom-icons
6362
@@ -136,7 +135,7 @@ _Example_:
136135
- :fontawesome-brands-facebook:{ .facebook } – Facebook
137136
```
138137

139-
=== ":octicons-file-code-16: docs/stylesheets/icons.css"
138+
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
140139

141140
``` css
142141
.medium {
@@ -154,7 +153,7 @@ _Example_:
154153

155154
``` yaml
156155
extra_css:
157-
- stylesheets/icons.css
156+
- stylesheets/extra.css
158157
```
159158

160159
_Result_:
@@ -181,7 +180,7 @@ _Example_:
181180
:octicons-heart-fill-24:{ .heart }
182181
```
183182

184-
=== ":octicons-file-code-16: docs/stylesheets/icons.css"
183+
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
185184

186185
``` css
187186
@keyframes heart {
@@ -201,7 +200,7 @@ _Example_:
201200

202201
``` yaml
203202
extra_css:
204-
- stylesheets/icons.css
203+
- stylesheets/extra.css
205204
```
206205

207206
_Result_:

docs/reference/meta-tags.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ See additional configuration options:
3434
3535
### Setting the page title
3636
37-
When [Metadata] is enabled, the page title can be overridden on a per-document
38-
basis with custom front matter. Add the following lines at the top of a Markdown
39-
file:
37+
When [Metadata] is enabled, the page title can be overridden for a document with
38+
some custom front matter. Add the following lines at the top of a Markdown file:
4039
4140
``` bash
4241
---
@@ -57,9 +56,9 @@ title: Lorem ipsum dolor sit amet # (1)
5756

5857
### Setting the page description
5958

60-
When [Metadata] is enabled, the page description can also be overridden on a
61-
per-document basis with custom front matter. Add the following lines at the top
62-
of a Markdown file:
59+
When [Metadata] is enabled, the page description can be overridden for a
60+
document with custom front matter. Add the following lines at the top of a
61+
Markdown file:
6362

6463
``` bash
6564
---
@@ -77,8 +76,8 @@ document `head` for the current page to the provided value.
7776

7877
### Adding a web app manifest
7978

79+
[:octicons-tag-24: 3.1.0][manifest support] ·
8080
:octicons-archive-24: Deprecated ·
81-
[:octicons-tag-24: 3.1.0 ... present][web app manifest support] ·
8281
:octicons-trash-24: 8.0.0
8382

8483
A [web app manifest] is a simple JSON file that specifies how your web
@@ -94,7 +93,7 @@ extra:
9493
can be achieved with [theme extension].
9594
9695
[web app manifest]: https://developers.google.com/web/fundamentals/web-app-manifest/
97-
[web app manifest support]: https://github.com/squidfunk/mkdocs-material/releases/tag/3.1.0
96+
[manifest support]: https://github.com/squidfunk/mkdocs-material/releases/tag/3.1.0
9897
[theme extension]: ../customization.md#extending-the-theme
9998
10099
</div>

0 commit comments

Comments
 (0)