From 47801173ed1474d168e3e6aba6d6bd5af8bb4df1 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 20 Jul 2022 17:51:29 +0200 Subject: [PATCH] Documentation --- docs/insiders/index.md | 25 ++++++++++------------- docs/setup/ensuring-data-privacy.md | 27 ++++++++++++------------- docs/setup/setting-up-site-analytics.md | 8 ++++---- docs/setup/setting-up-the-header.md | 5 ++--- 4 files changed, 30 insertions(+), 35 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index a437314fd..0406a18e6 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -82,7 +82,7 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 27 additional features__ that you can start using right away, and +access to 24 additional features__ that you can start using right away, and which are currently exclusively available to sponsors:
@@ -105,15 +105,12 @@ which are currently exclusively available to sponsors: - [x] Sidebars automatically scroll to active item - [x] [Code annotations: anchor links] - [x] [Code annotations: strip comments] -- [x] [Dismissable announcement bar] -- [x] [Was this page helpful?] - [x] [Brand new search plugin] - [x] [Rich search previews] - [x] [Tokenizer with lookahead] - [x] [Advanced search highlighting] - [x] [Excluding content from search] - [x] [Social cards] -- [x] [Cookie consent]
@@ -232,16 +229,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. -#### $ 7,000 – Royal Gold - -- [x] [Cookie consent] -- [x] [Was this page helpful?] -- [x] [Dismissable announcement bar] - - [Cookie consent]: ../setup/ensuring-data-privacy.md#native-cookie-consent - [Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful - [Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read - #### $ 8,000 – Scotch Bonnet - [x] [Social cards] @@ -320,6 +307,16 @@ 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. +#### $ 7,000 – Royal Gold + +- [x] [Cookie consent] +- [x] [Was this page helpful?] +- [x] [Dismissable announcement bar] + + [Cookie consent]: ../setup/ensuring-data-privacy.md#native-cookie-consent + [Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful + [Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read + #### $ 6,000 – Trinidad Scorpion - [x] [Boosting pages in search] diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 048672528..68bd1ea5a 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -17,9 +17,9 @@ automatically downloaded for [self-hosting]. ### Cookie consent { #native-cookie-consent } -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-2.10.0][Insiders] · -:octicons-milestone-24: Default: _none_ +[:octicons-tag-24: 8.4.0rc1][cookie consent support] · +:octicons-milestone-24: Default: _none_ · +:octicons-beaker-24: Experimental Material for MkDocs ships a native and extensible cookie consent form which asks the user for consent prior to sending any data via analytics. Add the @@ -55,12 +55,11 @@ The following properties are available: `cookies`{ #consent-cookies } -: [:octicons-tag-24: insiders-4.5.1][Insiders] · :octicons-milestone-24: - Default: _none_ – This property allows to add custom cookies or change the - initial `checked` state and name of the `analytics` cookie. Each cookie must - receive a unique identifier which is used as a key in the `cookies` map, and - can be either set to a string, or to a map defining `name` and `checked` - state: +: :octicons-milestone-24: Default: _none_ – This property allows to add custom + cookies or change the initial `checked` state and name of the `analytics` + cookie. Each cookie must receive a unique identifier which is used as a key + in the `cookies` map, and can be either set to a string, or to a map + defining `name` and `checked` state: === "Custom cookie name" @@ -102,10 +101,9 @@ The following properties are available: `actions`{ #consent-actions } -: [:octicons-tag-24: insiders-4.17.1][Insiders] · :octicons-milestone-24: - Default: `[accept, manage]` – This property defines which buttons are shown - and in which order, e.g. to allow the user to accept cookies and manage - settings: +: :octicons-milestone-24: Default: `[accept, manage]` – This property defines + which buttons are shown and in which order, e.g. to allow the user to accept + cookies and manage settings: ``` yaml extra: @@ -125,8 +123,8 @@ When a user first visits your site, a cookie consent form is rendered: [![cookie consent enabled]][cookie consent enabled] - [Insiders]: ../insiders/index.md [Custom cookies]: #custom-cookies + [cookie consent support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0rc1 [cookie consent enabled]: ../assets/screenshots/consent.png #### Change cookie settings @@ -244,6 +242,7 @@ The following configuration options are available: dynamically created or relative URLs, which can't be resolved by the privacy plugin due to [technical limitations]. + [Insiders]: ../insiders/index.md [built-in plugins]: ../insiders/getting-started.md#built-in-plugins [MathJax]: ../reference/mathjax.md [MathJax can be self-hosted]: https://docs.mathjax.org/en/latest/web/hosting.html diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index 9eaa86875..c31852816 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -70,9 +70,9 @@ following lines to `mkdocs.yml`: ### Was this page helpful? -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-3.2.0][Insiders] · -:octicons-milestone-24: Default: _none_ +[:octicons-tag-24: 8.4.0rc1][feedback support] · +:octicons-milestone-24: Default: _none_ · +:octicons-beaker-24: Experimental A simple [feedback widget] can be included at the bottom of each page, encouraging users to give instant feedback whether a page was helpful or not. @@ -221,7 +221,7 @@ The following properties are available for each rating: An alternative to GitHub issues is [Google Forms]. - [Insiders]: ../insiders/index.md + [feedback support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0rc1 [feedback widget]: #feedback [analytics]: #google-analytics [feedback report]: ../assets/screenshots/feedback-report.png diff --git a/docs/setup/setting-up-the-header.md b/docs/setup/setting-up-the-header.md index 9b4123a4a..f84c4e076 100644 --- a/docs/setup/setting-up-the-header.md +++ b/docs/setup/setting-up-the-header.md @@ -56,8 +56,7 @@ block][overriding blocks], which is empty by default: #### Mark as read -[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · -[:octicons-tag-24: insiders-4.2.0][Insiders] · +[:octicons-tag-24: 8.4.0rc1][dismiss support] · :octicons-unlock-24: Feature flag · :octicons-beaker-24: Experimental @@ -77,5 +76,5 @@ automatically. [Scroll to the top of this page][top] to see it in action. - [Insiders]: ../insiders/index.md + [dismiss support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0rc1 [top]: #