Documentation

This commit is contained in:
squidfunk 2022-07-20 17:51:29 +02:00
parent 5a9c295822
commit 47801173ed
4 changed files with 30 additions and 35 deletions

View File

@ -82,7 +82,7 @@ a handful of them, [thanks to our awesome sponsors]!
## What's in for me? ## What's in 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 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: which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>
@ -105,15 +105,12 @@ which are currently exclusively available to sponsors:
- [x] Sidebars automatically scroll to active item - [x] Sidebars automatically scroll to active item
- [x] [Code annotations: anchor links] - [x] [Code annotations: anchor links]
- [x] [Code annotations: strip comments] - [x] [Code annotations: strip comments]
- [x] [Dismissable announcement bar]
- [x] [Was this page helpful?]
- [x] [Brand new search plugin] - [x] [Brand new search plugin]
- [x] [Rich search previews] - [x] [Rich search previews]
- [x] [Tokenizer with lookahead] - [x] [Tokenizer with lookahead]
- [x] [Advanced search highlighting] - [x] [Advanced search highlighting]
- [x] [Excluding content from search] - [x] [Excluding content from search]
- [x] [Social cards] - [x] [Social cards]
- [x] [Cookie consent]
</div> </div>
@ -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 :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.
#### $ 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 #### $ 8,000 Scotch Bonnet
- [x] [Social cards] - [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 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.
#### $ 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 #### $ 6,000 Trinidad Scorpion
- [x] [Boosting pages in search] - [x] [Boosting pages in search]

View File

@ -17,9 +17,9 @@ automatically downloaded for [self-hosting].
### Cookie consent { #native-cookie-consent } ### Cookie consent { #native-cookie-consent }
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 8.4.0rc1][cookie consent support] ·
[:octicons-tag-24: insiders-2.10.0][Insiders] · :octicons-milestone-24: Default: _none_ ·
:octicons-milestone-24: Default: _none_ :octicons-beaker-24: Experimental
Material for MkDocs ships a native and extensible cookie consent form which 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 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 } `cookies`{ #consent-cookies }
: [:octicons-tag-24: insiders-4.5.1][Insiders] · :octicons-milestone-24: : :octicons-milestone-24: Default: _none_ This property allows to add custom
Default: _none_ This property allows to add custom cookies or change the cookies or change the initial `checked` state and name of the `analytics`
initial `checked` state and name of the `analytics` cookie. Each cookie must cookie. Each cookie must receive a unique identifier which is used as a key
receive a unique identifier which is used as a key in the `cookies` map, and in the `cookies` map, and can be either set to a string, or to a map
can be either set to a string, or to a map defining `name` and `checked` defining `name` and `checked` state:
state:
=== "Custom cookie name" === "Custom cookie name"
@ -102,10 +101,9 @@ The following properties are available:
`actions`{ #consent-actions } `actions`{ #consent-actions }
: [:octicons-tag-24: insiders-4.17.1][Insiders] · :octicons-milestone-24: : :octicons-milestone-24: Default: `[accept, manage]` This property defines
Default: `[accept, manage]` This property defines which buttons are shown which buttons are shown and in which order, e.g. to allow the user to accept
and in which order, e.g. to allow the user to accept cookies and manage cookies and manage settings:
settings:
``` yaml ``` yaml
extra: extra:
@ -125,8 +123,8 @@ When a user first visits your site, a cookie consent form is rendered:
[![cookie consent enabled]][cookie consent enabled] [![cookie consent enabled]][cookie consent enabled]
[Insiders]: ../insiders/index.md
[Custom cookies]: #custom-cookies [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 [cookie consent enabled]: ../assets/screenshots/consent.png
#### Change cookie settings #### 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 dynamically created or relative URLs, which can't be resolved by the privacy
plugin due to [technical limitations]. plugin due to [technical limitations].
[Insiders]: ../insiders/index.md
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins [built-in plugins]: ../insiders/getting-started.md#built-in-plugins
[MathJax]: ../reference/mathjax.md [MathJax]: ../reference/mathjax.md
[MathJax can be self-hosted]: https://docs.mathjax.org/en/latest/web/hosting.html [MathJax can be self-hosted]: https://docs.mathjax.org/en/latest/web/hosting.html

View File

@ -70,9 +70,9 @@ following lines to `mkdocs.yml`:
### Was this page helpful? ### Was this page helpful?
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 8.4.0rc1][feedback support] ·
[:octicons-tag-24: insiders-3.2.0][Insiders] · :octicons-milestone-24: Default: _none_ ·
:octicons-milestone-24: Default: _none_ :octicons-beaker-24: Experimental
A simple [feedback widget] can be included at the bottom of each page, 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. 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]. 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 [feedback widget]: #feedback
[analytics]: #google-analytics [analytics]: #google-analytics
[feedback report]: ../assets/screenshots/feedback-report.png [feedback report]: ../assets/screenshots/feedback-report.png

View File

@ -56,8 +56,7 @@ block][overriding blocks], which is empty by default:
#### Mark as read #### Mark as read
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 8.4.0rc1][dismiss support] ·
[:octicons-tag-24: insiders-4.2.0][Insiders] ·
:octicons-unlock-24: Feature flag · :octicons-unlock-24: Feature flag ·
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
@ -77,5 +76,5 @@ automatically.
[Scroll to the top of this page][top] to see it in action. [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]: # [top]: #