mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2025-02-12 00:23:01 +01:00
Documentation
This commit is contained in:
parent
fefdd42c96
commit
050c299ec8
@ -7,15 +7,15 @@ for you to __start using now__.
|
||||
|
||||
## Features
|
||||
|
||||
Our sponsors currently enjoy access to the following 26 additional features. New
|
||||
Our sponsors currently enjoy access to the following 20 additional features. New
|
||||
features are added regularly, so be sure to check back regularly to stay
|
||||
updated.
|
||||
|
||||
<div class="mdx-columns" markdown>
|
||||
|
||||
- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" }
|
||||
- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
|
||||
- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
|
||||
- [x] [Blog plugin: pinned posts]
|
||||
- [x] [Instant previews]
|
||||
- [x] [Footnote tooltips]
|
||||
- [x] [Tags plugin: advanced settings]
|
||||
- [x] [Tags plugin: nested tags]
|
||||
- [x] [Tags plugin: shadow tags]
|
||||
@ -33,12 +33,6 @@ updated.
|
||||
- [x] [Navigation path] (Breadcrumbs)
|
||||
- [x] [Typeset plugin]
|
||||
- [x] [Privacy plugin: external links]
|
||||
- [x] [Navigation subtitles]
|
||||
- [x] [Tags plugin: allow list] + [custom sorting]
|
||||
- [x] [Blog plugin: custom index pages]
|
||||
- [x] [Blog plugin: related links]
|
||||
- [x] [Meta plugin]
|
||||
- [x] [Tags plugin: configurable listings]
|
||||
|
||||
</div>
|
||||
|
||||
@ -100,23 +94,6 @@ planned, but not yet implemented. This means that each funding goal unlocks new
|
||||
features for general availability in the community edition, after sponsors have
|
||||
used them for a while.
|
||||
|
||||
#### $ 16,000 – Chipotle
|
||||
|
||||
- [x] [Meta plugin]
|
||||
- [x] [Blog plugin: related links]
|
||||
- [x] [Blog plugin: custom index pages]
|
||||
- [x] [Tags plugin: configurable listings]
|
||||
- [x] [Tags plugin: allow list] + [custom sorting]
|
||||
- [x] [Navigation subtitles]
|
||||
|
||||
[Meta plugin]: ../plugins/meta.md
|
||||
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
|
||||
[Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages
|
||||
[Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings
|
||||
[Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed
|
||||
[custom sorting]: ../plugins/tags.md#config.tags_sort_by
|
||||
[Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle
|
||||
|
||||
#### $ 18,000 – Lemon Drop
|
||||
|
||||
- [x] [Optimize plugin]
|
||||
@ -184,6 +161,23 @@ sponsors. Those features were once part of Material for MkDocs Insiders, and
|
||||
therefore only available to our sponsors, and are now generally available to
|
||||
be used by all users.
|
||||
|
||||
#### $ 16,000 – Chipotle
|
||||
|
||||
- [x] [Meta plugin]
|
||||
- [x] [Blog plugin: related links]
|
||||
- [x] [Blog plugin: custom index pages]
|
||||
- [x] [Tags plugin: configurable listings]
|
||||
- [x] [Tags plugin: allow list] + [custom sorting]
|
||||
- [x] [Navigation subtitles]
|
||||
|
||||
[Meta plugin]: ../plugins/meta.md
|
||||
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
|
||||
[Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages
|
||||
[Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings
|
||||
[Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed
|
||||
[custom sorting]: ../plugins/tags.md#config.tags_sort_by
|
||||
[Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle
|
||||
|
||||
#### $ 14,000 – Goat's Horn
|
||||
|
||||
- [x] [Privacy plugin]
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -26,7 +26,7 @@ See additional configuration options:
|
||||
|
||||
[Footnotes]: ../setup/extensions/python-markdown.md#footnotes
|
||||
|
||||
### Footnote tooltips :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
|
||||
### Footnote tooltips
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.51.0 -->
|
||||
|
@ -144,8 +144,7 @@ page status] to get you started.
|
||||
|
||||
### Setting the page `subtitle`
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.25.0 -->
|
||||
<!-- md:version 9.6.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
Each page can define a subtitle, which is then rendered below the title as part
|
||||
|
@ -447,8 +447,7 @@ slug: hello-world
|
||||
|
||||
#### Adding related links
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.23.0 -->
|
||||
<!-- md:version 9.6.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
Related links offer the perfect way to prominently add a _further reading_
|
||||
@ -519,7 +518,7 @@ when the site is being built. Of course, you can also reference assets from
|
||||
posts outside of the `posts` directory. The [built-in blog plugin] ensures that
|
||||
all links are correct.
|
||||
|
||||
#### Pinning a post :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" }
|
||||
#### Pinning a post
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.53.0 -->
|
||||
@ -571,8 +570,7 @@ This will disable automatic reading time computation.
|
||||
|
||||
#### Setting defaults
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.21.0 -->
|
||||
<!-- md:version 9.6.0 -->
|
||||
<!-- md:plugin [meta][built-in meta plugin] – built-in -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
@ -638,8 +636,7 @@ nav:
|
||||
|
||||
### Custom index pages
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.24.0 -->
|
||||
<!-- md:version 9.6.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
If you want to add custom content to automatically generated [archive] and
|
||||
|
@ -91,7 +91,7 @@ The progress indicator will only show if the page hasn't finished loading after
|
||||
400ms, so that fast connections will never show it for a better instant
|
||||
experience.
|
||||
|
||||
### Instant previews :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
|
||||
### Instant previews
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.52.0 -->
|
||||
|
@ -224,8 +224,7 @@ for an arbitrary number of tags indexes (listings), [scoped listings],
|
||||
|
||||
#### Configurable listings
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.48.0 -->
|
||||
<!-- md:version 9.6.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
Listings can be configured in `mkdocs.yml` or directly at the location of the
|
||||
|
Loading…
x
Reference in New Issue
Block a user