From a8bd480c394b30815fd724408f6a2168e6957af7 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 7 Dec 2023 11:56:18 +0100 Subject: [PATCH] Prepare 9.5.0 release --- docs/insiders/index.md | 40 ++++++++++++--------------- docs/plugins/privacy.md | 31 ++++++--------------- docs/reference/content-tabs.md | 9 +++--- docs/reference/grids.md | 6 ++-- docs/reference/tooltips.md | 3 +- docs/setup/adding-a-git-repository.md | 11 ++++---- docs/setup/changing-the-colors.md | 3 +- docs/setup/ensuring-data-privacy.md | 3 +- material/__init__.py | 2 +- material/templates/base.html | 2 +- package-lock.json | 4 +-- package.json | 2 +- 12 files changed, 45 insertions(+), 71 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index d67a7d69d..f90da3354 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -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:
@@ -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]
@@ -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] diff --git a/docs/plugins/privacy.md b/docs/plugins/privacy.md index d58d29238..ce3000984 100644 --- a/docs/plugins/privacy.md +++ b/docs/plugins/privacy.md @@ -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. ---- - - __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 - - + @@ -135,8 +127,7 @@ The following settings are available: #### - - + 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). #### - - + 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: #### - - + Use this setting to instruct the plugin to bypass the cache, in order to @@ -205,8 +194,7 @@ plugins: #### - - + 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: #### - - + Use this setting to control whether the plugin should download external @@ -253,8 +240,7 @@ plugins: #### - - + Use this setting to control whether the plugin should downloads or only report @@ -272,8 +258,7 @@ plugins: #### - - + It is normally not necessary to specify this setting, except for when you want diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md index 5d08715ee..4c3d2d4b8 100644 --- a/docs/reference/content-tabs.md +++ b/docs/reference/content-tabs.md @@ -32,13 +32,12 @@ See additional configuration options: ### Anchor links - - + -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 ..." diff --git a/docs/reference/grids.md b/docs/reference/grids.md index 46b9f0e1b..10af8d55b 100644 --- a/docs/reference/grids.md +++ b/docs/reference/grids.md @@ -45,8 +45,7 @@ elements in a rectangular shape. ### Using card grids - - + Card grids wrap each grid item with a beautiful hover card that levitates on @@ -226,8 +225,7 @@ to the grid. ### Using generic grids - - + Generic grids allow for arranging arbitrary block elements in a grid, including diff --git a/docs/reference/tooltips.md b/docs/reference/tooltips.md index 75ea532b2..d1dc583c3 100644 --- a/docs/reference/tooltips.md +++ b/docs/reference/tooltips.md @@ -35,8 +35,7 @@ See additional configuration options: ### Improved tooltips - - + When improved tooltips are enabled, Material for MkDocs replaces the browser's diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 9b54aef6f..955bdb951 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -248,8 +248,7 @@ them at your own risk. #### Document contributors - - + @@ -324,8 +323,7 @@ them at your own risk. #### Document authors - - + @@ -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 diff --git a/docs/setup/changing-the-colors.md b/docs/setup/changing-the-colors.md index dd65c8729..319407a06 100644 --- a/docs/setup/changing-the-colors.md +++ b/docs/setup/changing-the-colors.md @@ -267,8 +267,7 @@ default color palette. #### Automatic light / dark mode - - + diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 3b53fb12f..a4565993f 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -147,8 +147,7 @@ copyright: > ### Built-in privacy plugin - - + diff --git a/material/__init__.py b/material/__init__.py index 57b9d8c9f..70fdbc469 100644 --- a/material/__init__.py +++ b/material/__init__.py @@ -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" diff --git a/material/templates/base.html b/material/templates/base.html index 12502273e..bc3cafaa9 100644 --- a/material/templates/base.html +++ b/material/templates/base.html @@ -32,7 +32,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index 258215f66..c227274c1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -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", diff --git a/package.json b/package.json index 56f8071ad..bf1f5c508 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "9.4.14", + "version": "9.5.0", "description": "Documentation that simply works", "keywords": [ "mkdocs",