10000 Merge pull request #7082 from squidfunk/chore/update-to-mkdocs-1.6 · squidfunk/mkdocs-material@023e177 · GitHub
[go: up one dir, main page]
Skip to content

Commit 023e177

Browse files
squidfunksquidfunk
authored
Merge pull request #7082 from squidfunk/chore/update-to-mkdocs-1.6
Updated MkDocs to 1.6.0
2 parents 2d07a6a + 2585b82 commit 023e177

14 files changed

+25
-39
lines changed

‎docs/blog/posts/blog-support-just-landed.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ nav:
7878
project, and not in a subdirectory. For more information, see the
7979
[`blog_dir`][blog_dir] configuration option.
8080

81-
[blog_dir]: ../../setup/setting-up-a-blog.md#+blog.blog_dir
81+
[blog_dir]: ../../plugins/blog.md#config.blog_dir
8282

8383
#### Blog setup
8484

@@ -182,12 +182,12 @@ which allow for fine-tuning the output. You can configure post slugs, general
182182
behavior and much more.
183183

184184
[exact same Markdown flavor]: ../../reference/index.md
185-
[post slugs]: ../../setup/setting-up-a-blog.md#+blog.post_url_format
186-
[draft]: ../../setup/setting-up-a-blog.md#drafts
187-
[This behavior can be changed]: ../../setup/setting-up-a-blog.md#+blog.draft
185+
[post slugs]: ../../plugins/blog.md#config.post_url_format
186+
[draft]: ../../plugins/blog.md#meta.draft
187+
[This behavior can be changed]: ../../plugins/blog.md#config.draft
188188
[live preview server]: ../../creating-your-site.md#previewing-as-you-write
189-
[archive]: ../../setup/setting-up-a-blog.md#archive
190-
[category]: ../../setup/setting-up-a-blog.md#categories
189+
[archive]: ../../plugins/blog.md#config.archive
190+
[category]: ../../plugins/blog.md#config.categories
191191
[Blog]: blog-support-just-landed/blog.png
192192
[Blog post]: blog-support-just-landed/blog-post.png
193193
[Adding an excerpt]: ../../setup/setting-up-a-blog.md#adding-an-excerpt

‎docs/blog/posts/chinese-search-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,6 @@ improved, please [open an issue].
7878
7979
[jieba]: https://pypi.org/project/jieba/
8080
[zero-width whitespace]: https://en.wikipedia.org/wiki/Zero-width_space
81-
[separator]: ../../setup/setting-up-site-search.md#separator
81+
[separator]: ../../plugins/search.md#config.separator
8282
[q=支持]: ?q=支持
8383
[open an issue]: https://github.com/squidfunk/mkdocs-material/issues/new/choose

‎docs/blog/posts/search-better-faster-smaller.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ implementation. If you immediately want to learn what's new, skip to the
3636
[section just after that][what's new]._
3737

3838
[search]: ../../setup/setting-up-site-search.md
39-
[multilingual]: ../../setup/setting-up-site-search.md#lang
39+
[multilingual]: ../../plugins/search.md#config.lang
4040
[offline-capable]: ../../setup/building-for-offline-usage.md
4141
[what's new]: #whats-new
4242

@@ -206,7 +206,7 @@ more magic involved, e.g., search results are [post-processed] and [rescored] to
206206
account for some shortcomings of [lunr], but in general, this is how data gets
207207
into and out of the index.
208208
209-
[separator]: ../../setup/setting-up-site-search.md#search-separator
209+
[separator]: ../../plugins/search.md#config.separator
210210
[default tokenizer]: https://github.com/olivernn/lunr.js/blob/aa5a878f62a6bba1e8e5b95714899e17e8150b38/lunr.js#L413-L456
211211
[post-processed]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L249-L272
212212
[rescored]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L274-L275
@@ -486,7 +486,7 @@ digit `\d`, which leaves version numbers discoverable. Searching for
486486
[:octicons-search-24: 7.2.6][q=7.2.6] brings up the [7.2.6] release notes.
487487
488488
[q=7.2.6]: ?q=7.2.6
489-
[7.2.6]: ../../changelog/index.md#726-_-september-1-2021
489+
[7.2.6]: ../../changelog/index.md#7.2.6
490490
491491
#### HTML/XML tags
492492
@@ -499,19 +499,12 @@ following expression to the separator allows for just that:
499499
&[lg]t;
500500
```
501501
502-
Searching for [:octicons-search-24: custom search worker script][q=script]
503-
brings up the section on [custom search] and matches the `script` tag among the
504-
other search terms discovered.
505-
506502
---
507503
508504
_We've only just begun to scratch the surface of the new possibilities
509505
tokenizer lookahead brings. If you found other useful expressions, you're
510506
invited to share them in the comment section._
511507
512-
[q=script]: ?q=custom+search+worker+script
513-
[custom search]: ../../setup/setting-up-site-search.md#custom-search
514-
515508
### Accurate highlighting
516509
517510
Highlighting is the last step in the process of search and involves the

‎docs/blog/posts/the-past-present-and-future.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ __55__ times, `mkdocs-material-insiders` was shipped __72__ times.
169169
[Code annotations]: ../../reference/code-blocks.md#adding-annotations
170170
[Code annotations: strip comments]: ../../reference/code-blocks.md#stripping-comments
171171
[Code block titles]: ../../reference/code-blocks.md#adding-a-title
172-
[Code block line anchors]: ../../setup/extensions/python-markdown-extensions.md#anchor-linenums
172+
[Code block line anchors]: ../../setup/extensions/python-markdown-extensions.md#+pymdownx.highlight.anchor_linenums
173173
[Color palette toggle]: ../../setup/changing-the-colors.md#color-palette-toggle
174174
[Content tabs: improved support]: ../../reference/content-tabs.md
175175
[Content tabs: auto-linking]: ../../reference/content-tabs.md#linked-content-tabs

‎docs/conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Several features are implemented through MkDocs excellent plugin architecture,
6969
some of which are built-in and distributed with Material for MkDocs, so no
7070
installation is required.
7171

72-
### <!-- md:extension --> – Markdown extension { data-toc-label="Markdown extension" }
72+
### <!-- md:extension --> – Markdown extension { data-toc-label="Markdown extension" #extension }
7373

7474
This symbol denotes that the thing described is a Markdown extension, which can
7575
be enabled in `mkdocs.yml` and adds additional functionality to the Markdown

‎docs/insiders/faq/sponsoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ overrides via [configuration inheritance].
476476
See the [getting started guide] for more information.
477477

478478
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
479-
[getting started guide]: ../getting-started.md#caveats
479+
[getting started guide]: ../getting-started.md
480480
[Card grids]: ../../reference/grids.md?h=grids#using-card-grids
481481

482482
## Support
@@ -530,7 +530,7 @@ report it on our [issue tracker] in the public community repository. When
530530
submitting the bug report, please ensure that you do not include any private
531531
Insiders' source code, as we want to uphold our fair use policy.
532532

533-
[__How can I report an issue in my customizations?__](#customizations-issues){ #costumisations-issues }
533+
[__How can I report an issue in my customizations?__](#customizations-issues){ #customizations-issues }
534534

535535
Please note, that we do not offer support for customizations as they vary
536536
widely and are specific to individual cases. Our support is primarily focused on

‎docs/insiders/getting-started.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ your private repositories.
4242

4343
Material for MkDocs Insiders can be installed with `pip`. You will
4444
normally want to install the latest release but can also install a
45-
specific older release or even the latest development version.
45+
specific older release or even the latest development version.
4646
Make sure you have the `GH_TOKEN` variable set as instructed above.
4747

4848
=== "Specific release"
4949

50-
Pick the corresponding tag from the [list of tags] for the Insiders
51-
repository. In the `pip` command below, replace the tag at the
50+
Pick the corresponding tag from the [list of tags] for the Insiders
51+
repository. In the `pip` command below, replace the tag at the
5252
end of the URL with the one you want.
5353

5454
``` sh
@@ -180,12 +180,5 @@ Of course, you can also enable both groups with:
180180
CI=1 INSIDERS=1 mkdocs build
181181
```
182182

183-
[^1]:
184-
Previously we recommended to use [configuration inheritance] to work around
185-
this limitations, but the brand new [built-in group plugin] is a much better
186-
approach, as it allows you to use a single configuration file for building
187-
your project with the community edition and Insiders version of Material
188-
for MkDocs.
189-
190183
[built-in group plugin]: ../plugins/group.md
191184
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

‎docs/insiders/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ exclusive to Insiders, it's recommended to split configuration into a base
555555
See the [getting started guide] for more information.
556556

557557
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
558-
[getting started guide]: getting-started.md#caveats
558+
[getting started guide]: getting-started.md
559559

560560
### Payment
561561

‎docs/philosophy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ philosophy behind the project, in order to make sure it aligns with your goals.
55
This page explains the design principles anchored in Material for MkDocs, and
66
discusses the [conventions] used in this documentation.
77

8-
[conventions]: #conventions
8+
[conventions]: conventions.md
99

1010
## Design principles
1111

‎docs/plugins/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The following settings are available:
9494
9595
#### <!-- md:setting config.enabled -->
9696
97-
<!-- md:version 9.2.9 -->
97+
<!-- md:version 9.3.2 -->
9898
<!-- md:default `true` -->
9999

100100
Use this setting to enable or disable the plugin when [building your project].

0 commit comments

Comments
 (0)
0