OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Prepare 9.5.0 release

Browse Source
This commit is contained in:
squidfunk 2023-12-07 11:56:18 +01:00
parent aa62bcc4f6
commit a8bd480c39
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
12 changed files with 45 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/insiders/index.md
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 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: which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>
@ -112,12 +112,6 @@ which are currently exclusively available to sponsors:
- [x] [Blog plugin: related links] - [x] [Blog plugin: related links]
- [x] [Meta plugin] - [x] [Meta plugin]
- [x] [Tags plugin: additional indexes] - [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> </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 :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.
#### $ 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 #### $ 16,000 – Chipotle
- [x] [Meta plugin] - [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 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.
#### $ 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 #### $ 12,000 – Piri Piri
- [x] [Blog plugin] - [x] [Blog plugin]

31
docs/plugins/privacy.md
View File

@ -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 automatically identify and download external assets, making GDPR compliance
as effortless as it can possibly be. 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 ## Objective
### How it works ### How it works
@ -106,8 +99,7 @@ pipelines tailored to your project:
## Configuration ## Configuration
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.9.0 -->
<!-- md:plugin [privacy] – built-in --> <!-- md:plugin [privacy] – built-in -->
<!-- md:flag multiple --> <!-- md:flag multiple -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
@ -135,8 +127,7 @@ The following settings are available:
#### <!-- md:setting config.enabled --> #### <!-- md:setting config.enabled -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.10.0 -->
<!-- md:default `true` --> <!-- md:default `true` -->
Use this setting to enable or disable the plugin when [building your project]. 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:setting config.concurrency -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.30.0 -->
<!-- md:default available CPUs - 1 --> <!-- md:default available CPUs - 1 -->
With more CPUs available, the plugin can do more work in parallel, and thus 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:setting config.cache -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.30.0 -->
<!-- md:default `true` --> <!-- md:default `true` -->
Use this setting to instruct the plugin to bypass the cache, in order to 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:setting config.cache_dir -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.30.0 -->
<!-- md:default `.cache/plugin/privacy` --> <!-- md:default `.cache/plugin/privacy` -->
It is normally not necessary to specify this setting, except for when you want 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:setting config.assets -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.37.0 -->
<!-- md:default `true` --> <!-- md:default `true` -->
Use this setting to control whether the plugin should download external Use this setting to control whether the plugin should download external
@ -253,8 +240,7 @@ plugins:
#### <!-- md:setting config.assets_fetch --> #### <!-- md:setting config.assets_fetch -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.37.0 -->
<!-- md:default `true` --> <!-- md:default `true` -->
Use this setting to control whether the plugin should downloads or only report 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:setting config.assets_fetch_dir -->
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.37.0 -->
<!-- md:default `assets/external` --> <!-- md:default `assets/external` -->
It is normally not necessary to specify this setting, except for when you want It is normally not necessary to specify this setting, except for when you want

9
docs/reference/content-tabs.md
View File

@ -32,13 +32,12 @@ See additional configuration options:
### Anchor links ### Anchor links
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.17.0 -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
In order to link to content tabs and share them more easily, [Insiders] adds In order to link to content tabs and share them more easily, an anchor link is
an anchor link to each content tab automatically, which you can copy via right automatically added to each content tab, which you can copy via right click or
click or open in a new tab: open in a new tab:
=== "Open me in a new tab ..." === "Open me in a new tab ..."

6
docs/reference/grids.md
View File

@ -45,8 +45,7 @@ elements in a rectangular shape.
### Using card grids ### Using card grids
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.12.0 -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
Card grids wrap each grid item with a beautiful hover card that levitates on Card grids wrap each grid item with a beautiful hover card that levitates on
@ -226,8 +225,7 @@ to the grid.
### Using generic grids ### Using generic grids
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.12.0 -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
Generic grids allow for arranging arbitrary block elements in a grid, including Generic grids allow for arranging arbitrary block elements in a grid, including

3
docs/reference/tooltips.md
View File

@ -35,8 +35,7 @@ See additional configuration options:
### Improved tooltips ### Improved tooltips
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.15.0 -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
When improved tooltips are enabled, Material for MkDocs replaces the browser's When improved tooltips are enabled, Material for MkDocs replaces the browser's

11
docs/setup/adding-a-git-repository.md
View File

@ -248,8 +248,7 @@ them at your own risk.
#### Document contributors #### Document contributors
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.19.0 -->
<!-- md:plugin [git-committers] --> <!-- md:plugin [git-committers] -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
@ -324,8 +323,7 @@ them at your own risk.
#### Document authors #### Document authors
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.19.0 -->
<!-- md:plugin [git-authors] --> <!-- md:plugin [git-authors] -->
<!-- md:flag experimental --> <!-- 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 [git-committers] plugin and extracts the authors of a document from git to display
them at the bottom of each page. 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 pip install mkdocs-git-authors-plugin

3
docs/setup/changing-the-colors.md
View File

@ -267,8 +267,7 @@ default color palette.
#### Automatic light / dark mode #### Automatic light / dark mode
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.18.0 -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
<!-- md:example color-palette-system-preference --> <!-- md:example color-palette-system-preference -->

3
docs/setup/ensuring-data-privacy.md
View File

@ -147,8 +147,7 @@ copyright: >
### Built-in privacy plugin ### Built-in privacy plugin
<!-- md:sponsors --> <!-- md:version 9.5.0 -->
<!-- md:version insiders-4.9.0 -->
<!-- md:plugin [privacy][built-in privacy plugin] --> <!-- md:plugin [privacy][built-in privacy plugin] -->
<!-- md:flag experimental --> <!-- md:flag experimental -->

2
material/__init__.py
View File

@ -18,4 +18,4 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE. # IN THE SOFTWARE.
__version__ = "9.4.14" __version__ = "9.5.0"

2
material/templates/base.html
View File

@ -32,7 +32,7 @@
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}"> <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
{% endif %} {% endif %}
<link rel="icon" href="{{ config.theme.favicon | url }}"> <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 %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page.meta and page.meta.title %} {% if page.meta and page.meta.title %}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.4.14", "version": "9.5.0",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.4.14", "version": "9.5.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"clipboard": "^2.0.11", "clipboard": "^2.0.11",

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.4.14", "version": "9.5.0",
"description": "Documentation that simply works", "description": "Documentation that simply works",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",