1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-23 23:21:00 +01:00

Documentation

This commit is contained in:
squidfunk 2023-07-06 17:38:39 +02:00
parent 03d065ca20
commit 580b0b9d02
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
6 changed files with 47 additions and 51 deletions

View File

@ -88,7 +88,7 @@ a handful of them, [thanks to our awesome sponsors]!
## What's in it for me? ## What's in it for me?
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
access to 28 additional features__ that you can __start using now__, and access to 22 additional features__ that you can __start using now__, and
which are currently exclusively available to sponsors: which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>
@ -107,20 +107,14 @@ which are currently exclusively available to sponsors:
- [x] [Tags plugin: allow list] + [custom sorting] - [x] [Tags plugin: allow list] + [custom sorting]
- [x] [Blog plugin: custom index pages] - [x] [Blog plugin: custom index pages]
- [x] [Blog plugin: related links] - [x] [Blog plugin: related links]
- [x] [Blog plugin]
- [x] [Navigation status]
- [x] [Meta plugin] - [x] [Meta plugin]
- [x] [Tags plugin: additional indexes] - [x] [Tags plugin: additional indexes]
- [x] [Document contributors] - [x] [Document contributors]
- [x] [Automatic light / dark mode] - [x] [Automatic light / dark mode]
- [x] [Content tabs: anchor links] - [x] [Content tabs: anchor links]
- [x] [Navigation pruning]
- [x] [Tooltips] - [x] [Tooltips]
- [x] [Chinese search support]
- [x] [Card grids] - [x] [Card grids]
- [x] [Privacy plugin] - [x] [Privacy plugin]
- [x] [Annotations]
- [x] [Navigation icons]
</div> </div>
@ -264,22 +258,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
: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 :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
are released for general availability. are released for general availability.
#### $ 12,000 Piri Piri
- [x] [Blog plugin]
- [x] [Chinese search support]
- [x] [Annotations]
- [x] [Navigation icons]
- [x] [Navigation pruning]
- [x] [Navigation status]
[Blog plugin]: ../setup/setting-up-a-blog.md
[Chinese search support]: ../blog/posts/chinese-search-support.md
[Annotations]: ../reference/annotations.md
[Navigation icons]: ../reference/index.md#setting-the-page-icon
[Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning
[Navigation status]: ../reference/index.md#setting-the-page-status
#### $ 14,000 Goat's Horn #### $ 14,000 Goat's Horn
- [x] [Privacy plugin] - [x] [Privacy plugin]
@ -348,6 +326,22 @@ This section lists all funding goals that were previously completed, which means
that those features were part of Insiders, but are now generally available and that those features were part of Insiders, but are now generally available and
can be used by all users. can be used by all users.
#### $ 12,000 Piri Piri
- [x] [Blog plugin]
- [x] [Chinese search support]
- [x] [Annotations]
- [x] [Navigation icons]
- [x] [Navigation pruning]
- [x] [Navigation status]
[Blog plugin]: ../setup/setting-up-a-blog.md
[Chinese search support]: ../blog/posts/chinese-search-support.md
[Annotations]: ../reference/annotations.md
[Navigation icons]: ../reference/index.md#setting-the-page-icon
[Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning
[Navigation status]: ../reference/index.md#setting-the-page-status
#### $ 10,000 Carolina Reaper #### $ 10,000 Carolina Reaper
- [x] [Brand new search plugin] - [x] [Brand new search plugin]

View File

@ -35,8 +35,7 @@ See additional configuration options:
### Using annotations ### Using annotations
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Annotation support] ·
[:octicons-tag-24: insiders-4.6.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
Annotations consist of two parts: a marker, which can be placed anywhere in Annotations consist of two parts: a marker, which can be placed anywhere in
@ -65,7 +64,7 @@ Note that the `annotate` class must only be added to the outermost block. All
nested elements can use the same list to define annotations, except when nested elements can use the same list to define annotations, except when
annotations are nested themselves. annotations are nested themselves.
[Insiders]: ../insiders/index.md [Annotation support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
#### in annotations #### in annotations

View File

@ -121,8 +121,7 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
### Setting the page `icon` ### Setting the page `icon`
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Page icon support] ·
[:octicons-tag-24: insiders-4.5.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
An icon can be assigned to each page, which is then rendered as part of the An icon can be assigned to each page, which is then rendered as part of the
@ -150,14 +149,14 @@ icon: material/emoticon-happy # (1)!
</div> </div>
</div> </div>
[Page icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
[Insiders]: ../insiders/index.md [Insiders]: ../insiders/index.md
[icon search]: icons-emojis.md#search [icon search]: icons-emojis.md#search
[navigation tabs]: ../setup/setting-up-navigation.md#navigation-tabs [navigation tabs]: ../setup/setting-up-navigation.md#navigation-tabs
### Setting the page `status` ### Setting the page `status`
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Page status support] ·
[:octicons-tag-24: insiders-4.22.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
A status can be assigned to each page, which is then displayed as part of the A status can be assigned to each page, which is then displayed as part of the
@ -198,6 +197,8 @@ The following status identifiers are currently supported:
- :material-alert-decagram: `new` - :material-alert-decagram: `new`
- :material-trash-can: `deprecated` - :material-trash-can: `deprecated`
[Page status support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
### Setting the page `subtitle` ### Setting the page `subtitle`
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·

View File

@ -19,8 +19,7 @@ __Check out our [blog], which is created with the new [built-in blog plugin]!__
### Built-in blog plugin ### Built-in blog plugin
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Blog plugin support] ·
[:octicons-tag-24: insiders-4.23.0][Insiders] ·
:octicons-cpu-24: Plugin · :octicons-cpu-24: Plugin ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
@ -127,6 +126,7 @@ back here later for fine-tuning the output.__
--- ---
[Blog plugin support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
[Insiders]: ../insiders/index.md [Insiders]: ../insiders/index.md
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins [built-in plugins]: ../insiders/getting-started.md#built-in-plugins
[this is configurable]: #+blog.blog_dir [this is configurable]: #+blog.blog_dir
@ -1133,6 +1133,10 @@ linked with their titles.
#### Adding related links #### Adding related links
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.23.0][Insiders] ·
:octicons-beaker-24: Experimental
Related links offer the perfect way to prominently add a _further reading_ Related links offer the perfect way to prominently add a _further reading_
section to your post that is included in the left sidebar, guiding the user to section to your post that is included in the left sidebar, guiding the user to
other destinations of your documentation. Use the front matter `links` property other destinations of your documentation. Use the front matter `links` property
@ -1293,6 +1297,7 @@ nav:
### Custom index pages ### Custom index pages
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.24.0][Insiders] · [:octicons-tag-24: insiders-4.24.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental

View File

@ -52,6 +52,8 @@ theme:
- navigation.instant.prefetch - navigation.instant.prefetch
``` ```
[Insiders]: ../insiders/index.md
### Anchor tracking ### Anchor tracking
[:octicons-tag-24: 8.0.0][Anchor tracking support] · [:octicons-tag-24: 8.0.0][Anchor tracking support] ·
@ -221,8 +223,7 @@ theme:
### Navigation pruning ### Navigation pruning
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Navigation pruning support] ·
[:octicons-tag-24: insiders-4.16.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
When pruning is enabled, only the visible navigation items are included in the When pruning is enabled, only the visible navigation items are included in the
@ -244,7 +245,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 Navigation pruning will replace all expandable sections with links to the first
page in that section (or the section index page). page in that section (or the section index page).
[Insiders]: ../insiders/index.md [Navigation pruning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
[navigation.expand]: #navigation-expansion [navigation.expand]: #navigation-expansion
### Section index pages ### Section index pages

View File

@ -191,27 +191,24 @@ The following configuration options are supported:
#### Chinese language support #### Chinese language support
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.2.0b0][Chinese language support] ·
[:octicons-tag-24: insiders-4.14.0][Insiders] ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
[Insiders] adds search support for the Chinese language (see our [blog article] In order to add support for Chinese languages to the [built-in search plugin],
[chinese search] from May 2022) by integrating with the text segmentation install the text segmentation library [jieba] via `pip`, and the plugin will
library [jieba], which can be installed with `pip`. run all text through the segmenter:
``` sh ``` sh
pip install jieba pip install jieba
``` ```
If [jieba] is installed, the [built-in search plugin] automatically detects The following configuration options are available:
Chinese characters and runs them through the segmenter. The following
configuration options are available:
[`jieba_dict`](#+search.jieba_dict){ #+search.jieba_dict } [`jieba_dict`](#+search.jieba_dict){ #+search.jieba_dict }
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24: : :octicons-milestone-24: Default: _none_ This option allows for specifying
Default: _none_ This option allows for specifying a [custom dictionary] a [custom dictionary] to be used by [jieba] for segmenting text, replacing
to be used by [jieba] for segmenting text, replacing the default dictionary: the default dictionary:
``` yaml ``` yaml
plugins: plugins:
@ -226,10 +223,9 @@ configuration options are available:
[`jieba_dict_user`](#+search.jieba_dict_user){ #+search.jieba_dict_user } [`jieba_dict_user`](#+search.jieba_dict_user){ #+search.jieba_dict_user }
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24: : :octicons-milestone-24: Default: _none_ This option allows for specifying
Default: _none_ This option allows for specifying an additional an additional [user dictionary] to be used by [jieba] for segmenting text,
[user dictionary] to be used by [jieba] for segmenting text, augmenting the augmenting the default dictionary:
default dictionary:
``` yaml ``` yaml
plugins: plugins:
@ -240,7 +236,7 @@ configuration options are available:
User dictionaries can be used for tuning the segmenter to preserve User dictionaries can be used for tuning the segmenter to preserve
technical terms. technical terms.
[Insiders]: ../insiders/index.md [Chinese language support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0
[chinese search]: ../blog/posts/chinese-search-support.md [chinese search]: ../blog/posts/chinese-search-support.md
[jieba]: https://pypi.org/project/jieba/ [jieba]: https://pypi.org/project/jieba/
[built-in search plugin]: #built-in-search-plugin [built-in search plugin]: #built-in-search-plugin