mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-27 17:00:54 +01:00
Prepare 9.5.0 release
This commit is contained in:
squidfunk
parent
aa62bcc4f6
commit
a8bd480c39
@ -88,7 +88,7 @@ a handful of them, [thanks to our awesome sponsors]!
|
||||
## What's in it for me?
|
||||
|
||||
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
|
||||
access to 25 additional features__ that you can __start using now__, and
|
||||
access to 19 additional features__ that you can __start using now__, and
|
||||
which are currently exclusively available to sponsors:
|
||||
|
||||
<div class="mdx-columns" markdown>
|
||||
@ -112,12 +112,6 @@ which are currently exclusively available to sponsors:
|
||||
- [x] [Blog plugin: related links]
|
||||
- [x] [Meta plugin]
|
||||
- [x] [Tags plugin: additional indexes]
|
||||
- [x] [Document contributors]
|
||||
- [x] [Automatic light / dark mode]
|
||||
- [x] [Content tabs: anchor links]
|
||||
- [x] [Tooltips]
|
||||
- [x] [Card grids]
|
||||
- [x] [Privacy plugin]
|
||||
|
||||
</div>
|
||||
|
||||
@ -270,22 +264,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
|
||||
are released for general availability.
|
||||
|
||||
#### $ 14,000 – Goat's Horn
|
||||
|
||||
- [x] [Privacy plugin]
|
||||
- [x] [Card grids]
|
||||
- [x] [Tooltips]
|
||||
- [x] [Content tabs: anchor links]
|
||||
- [x] [Automatic light / dark mode]
|
||||
- [x] [Document contributors]
|
||||
|
||||
[Privacy plugin]: ../setup/ensuring-data-privacy.md
|
||||
[Card grids]: ../reference/grids.md
|
||||
[Tooltips]: ../reference/tooltips.md
|
||||
[Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links
|
||||
[Automatic light / dark mode]: ../setup/changing-the-colors.md#automatic-light-dark-mode
|
||||
[Document contributors]: ../setup/adding-a-git-repository.md#document-contributors
|
||||
|
||||
#### $ 16,000 – Chipotle
|
||||
|
||||
- [x] [Meta plugin]
|
||||
@ -344,6 +322,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
|
||||
can be used by all users.
|
||||
|
||||
#### $ 14,000 – Goat's Horn
|
||||
|
||||
- [x] [Privacy plugin]
|
||||
- [x] [Card grids]
|
||||
- [x] [Tooltips]
|
||||
- [x] [Content tabs: anchor links]
|
||||
- [x] [Automatic light / dark mode]
|
||||
- [x] [Document contributors]
|
||||
|
||||
[Privacy plugin]: ../setup/ensuring-data-privacy.md#built-in-privacy-plugin
|
||||
[Card grids]: ../reference/grids.md
|
||||
[Tooltips]: ../reference/tooltips.md
|
||||
[Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links
|
||||
[Automatic light / dark mode]: ../setup/changing-the-colors.md#automatic-light-dark-mode
|
||||
[Document contributors]: ../setup/adding-a-git-repository.md#document-contributors
|
||||
|
||||
#### $ 12,000 – Piri Piri
|
||||
|
||||
- [x] [Blog plugin]
|
||||
|
||||
@ -11,13 +11,6 @@ external assets. With just a single line of configuration, the plugin can
|
||||
automatically identify and download external assets, making GDPR compliance
|
||||
as effortless as it can possibly be.
|
||||
|
||||
---
|
||||
|
||||
<!-- md:sponsors --> __Sponsors only__ – this plugin is currently reserved to
|
||||
[our awesome sponsors].
|
||||
|
||||
[our awesome sponsors]: ../insiders/index.md
|
||||
|
||||
## Objective
|
||||
|
||||
### How it works
|
||||
@ -106,8 +99,7 @@ pipelines tailored to your project:
|
||||
|
||||
## Configuration
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.9.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:plugin [privacy] – built-in -->
|
||||
<!-- md:flag multiple -->
|
||||
<!-- md:flag experimental -->
|
||||
@ -135,8 +127,7 @@ The following settings are available:
|
||||
|
||||
#### <!-- md:setting config.enabled -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.10.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `true` -->
|
||||
|
||||
Use this setting to enable or disable the plugin when [building your project].
|
||||
@ -155,8 +146,7 @@ This configuration enables the plugin only during continuous integration (CI).
|
||||
|
||||
#### <!-- md:setting config.concurrency -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.30.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default available CPUs - 1 -->
|
||||
|
||||
With more CPUs available, the plugin can do more work in parallel, and thus
|
||||
@ -186,8 +176,7 @@ The following settings are available for caching:
|
||||
|
||||
#### <!-- md:setting config.cache -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.30.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `true` -->
|
||||
|
||||
Use this setting to instruct the plugin to bypass the cache, in order to
|
||||
@ -205,8 +194,7 @@ plugins:
|
||||
|
||||
#### <!-- md:setting config.cache_dir -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.30.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `.cache/plugin/privacy` -->
|
||||
|
||||
It is normally not necessary to specify this setting, except for when you want
|
||||
@ -233,8 +221,7 @@ The following settings are available for external assets:
|
||||
|
||||
#### <!-- md:setting config.assets -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.37.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `true` -->
|
||||
|
||||
Use this setting to control whether the plugin should download external
|
||||
@ -253,8 +240,7 @@ plugins:
|
||||
|
||||
#### <!-- md:setting config.assets_fetch -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.37.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `true` -->
|
||||
|
||||
Use this setting to control whether the plugin should downloads or only report
|
||||
@ -272,8 +258,7 @@ plugins:
|
||||
|
||||
#### <!-- md:setting config.assets_fetch_dir -->
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.37.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:default `assets/external` -->
|
||||
|
||||
It is normally not necessary to specify this setting, except for when you want
|
||||
|
||||
@ -32,13 +32,12 @@ See additional configuration options:
|
||||
|
||||
### Anchor links
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.17.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
In order to link to content tabs and share them more easily, [Insiders] adds
|
||||
an anchor link to each content tab automatically, which you can copy via right
|
||||
click or open in a new tab:
|
||||
In order to link to content tabs and share them more easily, an anchor link is
|
||||
automatically added to each content tab, which you can copy via right click or
|
||||
open in a new tab:
|
||||
|
||||
=== "Open me in a new tab ..."
|
||||
|
||||
|
||||
@ -45,8 +45,7 @@ elements in a rectangular shape.
|
||||
|
||||
### Using card grids
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.12.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
Card grids wrap each grid item with a beautiful hover card that levitates on
|
||||
@ -226,8 +225,7 @@ to the grid.
|
||||
|
||||
### Using generic grids
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.12.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
Generic grids allow for arranging arbitrary block elements in a grid, including
|
||||
|
||||
@ -35,8 +35,7 @@ See additional configuration options:
|
||||
|
||||
### Improved tooltips
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.15.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
When improved tooltips are enabled, Material for MkDocs replaces the browser's
|
||||
|
||||
@ -248,8 +248,7 @@ them at your own risk.
|
||||
|
||||
#### Document contributors
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.19.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:plugin [git-committers] -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
@ -324,8 +323,7 @@ them at your own risk.
|
||||
|
||||
#### Document authors
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.19.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:plugin [git-authors] -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
@ -333,7 +331,10 @@ The [git-authors] plugin is a lightweight alternative to the
|
||||
[git-committers] plugin and extracts the authors of a document from git to display
|
||||
them at the bottom of each page.
|
||||
|
||||
[Insiders] offers deep integration for [git-authors]. This means the [customized overrides](https://timvink.github.io/mkdocs-git-authors-plugin/usage.html#mkdocs-material-theme) are not necessary, and additional styling (such as nice icons) are added. Simply install it with `pip`:
|
||||
Material for MkDocs offers deep integration for [git-authors]. This means the
|
||||
[customized overrides](https://timvink.github.io/mkdocs-git-authors-plugin/usage.html#mkdocs-material-theme)
|
||||
are not necessary, and additional styling (such as nice icons) are added.
|
||||
Simply install it with `pip`:
|
||||
|
||||
```
|
||||
pip install mkdocs-git-authors-plugin
|
||||
|
||||
@ -267,8 +267,7 @@ default color palette.
|
||||
|
||||
#### Automatic light / dark mode
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.18.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:flag experimental -->
|
||||
<!-- md:example color-palette-system-preference -->
|
||||
|
||||
|
||||
@ -147,8 +147,7 @@ copyright: >
|
||||
|
||||
### Built-in privacy plugin
|
||||
|
||||
<!-- md:sponsors -->
|
||||
<!-- md:version insiders-4.9.0 -->
|
||||
<!-- md:version 9.5.0 -->
|
||||
<!-- md:plugin [privacy][built-in privacy plugin] -->
|
||||
<!-- md:flag experimental -->
|
||||
|
||||
|
||||
@ -18,4 +18,4 @@
|
||||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||
# IN THE SOFTWARE.
|
||||
|
||||
__version__ = "9.4.14"
|
||||
__version__ = "9.5.0"
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
|
||||
{% endif %}
|
||||
<link rel="icon" href="{{ config.theme.favicon | url }}">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.4.14">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.5.0">
|
||||
{% endblock %}
|
||||
{% block htmltitle %}
|
||||
{% if page.meta and page.meta.title %}
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.4.14",
|
||||
"version": "9.5.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.4.14",
|
||||
"version": "9.5.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"clipboard": "^2.0.11",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.4.14",
|
||||
"version": "9.5.0",
|
||||
"description": "Documentation that simply works",
|
||||
"keywords": [
|
||||
"mkdocs",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user