From b2ed2cd111ca5c065a4a8af82259435b49e17de0 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 20 Sep 2023 19:48:59 +0200 Subject: [PATCH] Added more examples to documentation --- docs/setup/changing-the-colors.md | 6 ++++++ docs/setup/ensuring-data-privacy.md | 4 ++++ docs/setup/setting-up-tags.md | 6 ++++++ 3 files changed, 16 insertions(+) diff --git a/docs/setup/changing-the-colors.md b/docs/setup/changing-the-colors.md index a7d0e6ba6..444c81d82 100644 --- a/docs/setup/changing-the-colors.md +++ b/docs/setup/changing-the-colors.md @@ -166,6 +166,7 @@ See our guide below to learn how to set [custom colors]. + Offering a light _and_ dark color palette makes your documentation pleasant to read at different times of the day, so the user can choose accordingly. Add the @@ -235,6 +236,7 @@ The following properties must be set for each toggle: + Each color palette can be linked to the user's system preference for light and dark appearance by using a media query. Simply add a `media` property next to @@ -268,6 +270,7 @@ default color palette. + Newer operating system allow to automatically switch between light and dark appearance during day and night times. [Insiders] adds support for automatic @@ -313,6 +316,9 @@ reload the site. ### Custom colors + + + Material for MkDocs implements colors using [CSS variables] (custom properties). If you want to customize the colors beyond the palette (e.g. to use your brand-specific colors), you can add an [additional style sheet] and diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 739708384..3b53fb12f 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -16,6 +16,7 @@ automatically downloaded for [self-hosting]. + Material for MkDocs ships a native and extensible cookie consent form which asks the user for consent prior to sending requests to third parties. Add the @@ -284,6 +285,9 @@ For a list of all settings, please consult the [plugin documentation]. ### Custom cookies + + + If you've customized the [cookie consent] and added a `custom` cookie, the user will be prompted to accept or reject your custom cookie. Once the user accepts or rejects the cookie consent, or [changes the settings], the page reloads[^1]. diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index c182fe4c5..8ceaf1273 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -112,6 +112,9 @@ setting: ### Adding tags + + + When the [built-in tags plugin] is enabled, tags can be added for a document with the front matter `tags` property. Add the following lines at the top of a Markdown file: @@ -153,6 +156,9 @@ search preview, which now allows to __find pages by tags__. ### Adding a tags index + + + The [built-in tags plugin] allows to define a file to render a [tags index] [tags.tags_file], which can be any page that is part of the `nav` section. To add a tags index, create a page, e.g. `tags.md`: