starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-08-01 18:28:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk
2025-01-31 10:46:09 +07:00
parent fefdd42c96
commit 050c299ec8
8 changed files with 50 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/plugins/meta.md
View File

@@ -10,13 +10,6 @@ pages in a folder, i.e., a subsection of your project, which is particularly
useful to ensure that a certain subset of pages features specific tags, uses a
custom template, or is attributed to an author.
---
<!-- md:sponsors --> __Sponsors only__ – this plugin is currently reserved to
[our awesome sponsors].
[our awesome sponsors]: ../insiders/index.md
## Objective
### How it works
@@ -132,8 +125,7 @@ of the meta plugin and other built-in plugins are:
## Configuration
<!-- md:sponsors -->
<!-- md:version insiders-4.21.0 -->
<!-- md:version 9.6.0 -->
<!-- md:plugin [meta] – built-in -->
<!-- md:flag experimental -->
@@ -160,8 +152,7 @@ The following settings are available:
#### <!-- md:setting config.enabled -->
<!-- md:sponsors -->
<!-- md:version insiders-4.38.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `true` -->
Use this setting to enable or disable the plugin when [building your project].
@@ -184,8 +175,7 @@ The following settings are available for meta files:
#### <!-- md:setting config.meta_file -->
<!-- md:sponsors -->
<!-- md:version insiders-4.21.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `.meta.yml` -->
Use this setting to change the meta file name the plugin will look for when

54
docs/plugins/tags.md
View File

@@ -167,8 +167,7 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
#### <!-- md:setting config.tags_slugify -->
<!-- md:sponsors -->
<!-- md:version insiders-4.25.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default [`pymdownx.slugs.slugify`][pymdownx.slugs.slugify] -->
Use this setting to change the function for generating URL-compatible slugs
@@ -194,8 +193,7 @@ more granular control.
#### <!-- md:setting config.tags_slugify_separator -->
<!-- md:sponsors -->
<!-- md:version insiders-4.25.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `-` -->
Use this setting to change the separator that is passed to the slugification
@@ -212,8 +210,7 @@ plugins:
#### <!-- md:setting config.tags_slugify_format -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `tag:{slug}` -->
Use this setting to change the format string that is used when generating tag
@@ -272,8 +269,7 @@ plugins:
#### <!-- md:setting config.tags_sort_by -->
<!-- md:sponsors -->
<!-- md:version insiders-4.26.2 -->
<!-- md:version 9.6.0 -->
<!-- md:default `material.plugins.tags.tag_name` -->
Use this setting to specify a custom function for comparing tags. By default,
@@ -294,8 +290,7 @@ or number representing the tag, that is used for sorting, and reference it in
#### <!-- md:setting config.tags_sort_reverse -->
<!-- md:sponsors -->
<!-- md:version insiders-4.26.2 -->
<!-- md:version 9.6.0 -->
<!-- md:default `false` -->
Use this setting to reverse the order in which tags are sorted when comparing
@@ -312,8 +307,7 @@ plugins:
#### <!-- md:setting config.tags_name_property -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default [`tags`][meta.tags] -->
Use this setting to change the name of the front matter property that is used by
@@ -330,8 +324,7 @@ plugins:
#### <!-- md:setting config.tags_name_variable -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `tags` -->
Use this setting to change the name of the template variable that is used by
@@ -348,8 +341,7 @@ plugins:
#### <!-- md:setting config.tags_allowed -->
<!-- md:sponsors -->
<!-- md:version insiders-4.25.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default none -->
The plugin allows to check tags against a predefined list, in order to catch
@@ -377,8 +369,7 @@ The following settings are available for listings:
#### <!-- md:setting config.listings -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `true` -->
Use this setting to enable or disable listings. It is normally not necessary to
@@ -400,8 +391,7 @@ is enabled.
#### <!-- md:setting config.listings_map -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default none -->
Use this define listing configurations that you can then reference in listings
@@ -431,8 +421,7 @@ See the [listings section] for a list of all available settings.
#### <!-- md:setting config.listings_sort_by -->
<!-- md:sponsors -->
<!-- md:version insiders-4.39.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `material.plugins.tags.item_title` -->
Use this setting to specify a custom function for comparing listing items. By
@@ -463,8 +452,7 @@ or number representing the item, that is used for sorting, and reference it in
#### <!-- md:setting config.listings_sort_reverse -->
<!-- md:sponsors -->
<!-- md:version insiders-4.39.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `false` -->
Use this setting to reverse the order in which items are sorted when comparing
@@ -481,8 +469,7 @@ plugins:
#### <!-- md:setting config.listings_tags_sort_by -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `material.plugins.tags.tag_name` -->
Use this setting to specify a custom function for comparing tags in listings. By
@@ -503,8 +490,7 @@ or number representing the tag, that is used for sorting, and reference it in
#### <!-- md:setting config.listings_tags_sort_reverse -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `false` -->
Use this setting to reverse the order in which tags are sorted when comparing
@@ -521,8 +507,7 @@ plugins:
#### <!-- md:setting config.listings_directive -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `material/tags` -->
Use this setting to change the name of the directive the plugin will look for
@@ -777,8 +762,7 @@ The following settings are available:
#### <!-- md:setting listing.scope -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default `false` -->
This setting specifies whether the listing should only consider pages that are
@@ -879,8 +863,7 @@ setting on a per-listing basis:
#### <!-- md:setting listing.include -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default none -->
Use this setting to specify which tags should be included in the listing. Each
@@ -917,8 +900,7 @@ If this setting is left empty, all tags and pages are included.
#### <!-- md:setting listing.exclude -->
<!-- md:sponsors -->
<!-- md:version insiders-4.48.0 -->
<!-- md:version 9.6.0 -->
<!-- md:default none -->
Use this setting to specify which tags should be excluded from the listing. Each