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

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-02-27 13:19:44 +01:00
parent 65d68de238
commit 6447166560
7 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/blog/2021/search-better-faster-smaller.md
View File

@ -68,7 +68,7 @@ const index$ = document.forms.namedItem("search")
[lunr]: https://lunrjs.com
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
[built-in search plugin]: ../../setup/setting-up-site-search.md#built-in-search
[built-in search plugin]: ../../setup/setting-up-site-search.md#built-in-search-plugin
### Search index

4
docs/setup/changing-the-fonts.md
View File

@ -68,13 +68,13 @@ theme:
!!! tip "Automatically bundle Google Fonts"
The brand-new [built-in privacy] plugin makes it easy to use Google Fonts
The brand-new [built-in privacy plugin] makes it easy to use Google Fonts
while complying with the __General Data Protection Regulation__ (GDPR),
by automatically downloading and self-hosting the web font files.
[data privacy]: https://developers.google.com/fonts/faq#what_does_using_the_google_fonts_api_mean_for_the_privacy_of_my_users
[font=false support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
[built-in privacy]: ensuring-data-privacy.md#built-in-privacy
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
## Customization

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

@ -14,7 +14,7 @@ automatically bundled as part of the build process.
## Configuration
### Built-in privacy
### Built-in privacy plugin
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.9.0][Insiders] ·
@ -99,7 +99,7 @@ The following configuration options are available:
authors might add external assets like third-party scripts or stylesheets
that would need to be remembered to be defined as further local assets.
This is the very reason the [built-in privacy] plugin exists — it automates
This is the very reason the [built-in privacy plugin] exists — it automates
the process of downloading all external assets manually to ensure compliance
with GDPR. Note that there are some [technical limitations].
@ -110,7 +110,7 @@ The following configuration options are available:
#### How it works
The [built-in privacy] plugin scans the resulting HTML for links to external
The [built-in privacy plugin] scans the resulting HTML for links to external
resources, including external scripts, style sheets, images and web fonts, and
downloads them to bundle them with your documentation site. Every URL refering
to an external resource, no matter if part of a template or Markdown file is
@ -129,7 +129,7 @@ The external script is downloaded, and the link is replaced with:
Style sheets are scanned for external `url(...)` references, e.g. images and
web fonts, which are then also downloaded and bundled with your documentation
site. This means that [Google Fonts] can be configured in `mkdocs.yml` as usual,
as the [built-in privacy] plugin automatically downloads and bundles all
as the [built-in privacy plugin] automatically downloads and bundles all
dependent resources.
As a third measure, [`preconnect`][preconnect] hints used for DNS pre-fetching
@ -138,7 +138,7 @@ removed during the build process.
??? example "Expand to inspect example"
For the official documentation, the [built-in privacy] plugin downloads the
For the official documentation, the [built-in privacy plugin] downloads the
following resources:
``` { .sh id="example" }
@ -206,7 +206,7 @@ removed during the build process.
└─ polyfill.io/v3/polyfill.min.js
```
[built-in privacy]: #built-in-privacy
[built-in privacy plugin]: #built-in-privacy-plugin
[preconnect]: https://developer.mozilla.org/en-US/docs/Web/Performance/dns-prefetch
#### Caching <small>recommended</small> { #caching data-toc-label="Caching" }
@ -248,7 +248,7 @@ carried out. You might want to:
#### Limitations
Note that dynamically created URLs as part of scripts are not detected, and thus
cannot be automatically downloaded. The [built-in privacy] plugin does not
cannot be automatically downloaded. The [built-in privacy plugin] does not
execute scripts – it can only detect fully qualified URLs to download and
replace.

2
docs/setup/setting-up-site-search.md
View File

@ -15,7 +15,7 @@ not be compliant with privacy regulations. Moreover, search even works
## Configuration
### Built-in search
### Built-in search plugin
[:octicons-tag-24: 0.1.0][search support] ·
:octicons-cpu-24: Plugin

10
docs/setup/setting-up-social-cards.md
View File

@ -37,7 +37,7 @@ The social preview image for the page on [setting up site analytics].
## Configuration
### Built-in social cards
### Built-in social plugin
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-2.12.0][Insiders] ·
@ -179,8 +179,8 @@ install all dependencies on your system:
#### Caching <small>recommended</small> { #caching data-toc-label="Caching" }
The [built-in social cards] plugin automatically fetches the fonts you define
in `mkdocs.yml` from Google Fonts, and uses them to render the text that is
The [built-in social plugin] automatically fetches the fonts you define in
`mkdocs.yml` from Google Fonts, and uses them to render the text that is
displayed on the social card. The font files and generated cards are both
written to the `.cache` directory, which is used in subsequent builds to detect
whether the social cards need to be regenerated. You might want to:
@ -213,12 +213,12 @@ whether the social cards need to be regenerated. You might want to:
- run: mkdocs gh-deploy --force
```
[built-in social cards]: #built-in-social-cards
[built-in social plugin]: #built-in-social-plugin
[publishing guide]: ../publishing-your-site.md#with-github-actions
#### Meta tags
The [built-in social cards] plugin automatically sets all necessary `meta` tags,
The [built-in social plugin] automatically sets all necessary `meta` tags,
equivalent to the following two customizations, which you can set manually when
you don't want to use it:

8
docs/setup/setting-up-tags.md
View File

@ -11,7 +11,7 @@ can help to discover relevant information faster.
## Configuration
### Built-in tags
### Built-in tags plugin
[:octicons-tag-24: 8.2.0][tags support] ·
:octicons-cpu-24: Plugin ·
@ -53,7 +53,7 @@ The following configuration options are available:
### Adding tags
When both, the [built-in tags] plugin and [Metadata] extension are enabled,
When both, the [built-in tags plugin] and [Metadata] extension are enabled,
tags can be added for a document with custom front matter. Add the following
lines at the top of a Markdown file:
@ -79,14 +79,14 @@ following screenshots:
[![Tag search preview]][Tag search preview]
[built-in tags]: #built-in-tags
[built-in tags plugin]: #built-in-tags-plugin
[Metadata]: extensions/python-markdown.md#metadata
[Tags preview]: ../assets/screenshots/tags.png
[Tag search preview]: ../assets/screenshots/tags-search.png
### Adding a tags index
The [built-in tags] plugin allows to define a file to render 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`:

4
docs/upgrade.md
View File

@ -1037,7 +1037,7 @@ matches the new structure:
[CSS variables]: setup/changing-the-colors.md#custom-colors
[icon integration]: reference/icons-emojis.md#search
[prebuilt search indexes]: setup/setting-up-site-search.md#built-in-search
[prebuilt search indexes]: setup/setting-up-site-search.md#built-in-search-plugin
### Changes to `mkdocs.yml`
@ -1135,7 +1135,7 @@ was renamed to `separator`:
tokenizer: '[\s\-\.]+'
```
[plugin options]: setup/setting-up-site-search.md#built-in-search
[plugin options]: setup/setting-up-site-search.md#built-in-search-plugin
#### `extra.social.*`