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 2023-01-01 17:44:37 +01:00
parent 2144c2fae8
commit acb48fdab9
2 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/setup/building-for-offline-usage.md
View File

@ -11,8 +11,7 @@ support for many of its features.
### Built-in offline plugin ### Built-in offline plugin
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 9.0.0][offline support] ·
[:octicons-tag-24: insiders-4.10.0][Insiders] ·
:octicons-cpu-24: Plugin :octicons-cpu-24: Plugin
The built-in offline plugin makes sure that the [site search] works when you The built-in offline plugin makes sure that the [site search] works when you
@ -24,13 +23,9 @@ plugins:
- offline - offline
``` ```
> If you need to be able to build your documentation with and without The plugin will automatically disable the [`use_directory_urls`][use_directory_urls]
> [Insiders], please refer to the [built-in plugins] section to learn how setting, ensuring that users can open your documentation directly from the local
> shared configurations help to achieve this. file system.
The plugin will automatically disable [`use_directory_urls`][use_directory_urls]
via `mkdocs.yml`, ensuring that users can open your documentation directly
from the local file system.
The following configuration options are available: The following configuration options are available:
@ -52,14 +47,13 @@ hosted on a regular server.
!!! tip "Automatically bundle all external assets" !!! tip "Automatically bundle all external assets"
The brand-new [built-in privacy plugin] makes it easy to use external assets The [built-in privacy plugin] makes it easy to use external assets
while building documentation for offline usage, as it will automatically while building documentation for offline usage, as it will automatically
download all external assets to distribute them with your documentation. download all external assets to distribute them with your documentation.
[Insiders]: ../insiders/index.md [offline support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.0.0
[site search]: setting-up-site-search.md [site search]: setting-up-site-search.md
[site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir [site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
[use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls [use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin [built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin

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

@ -64,7 +64,7 @@ theme:
!!! tip "Automatically bundle Google Fonts" !!! tip "Automatically bundle Google Fonts"
The brand-new [built-in privacy plugin] makes it easy to use Google Fonts The [built-in privacy plugin] makes it easy to use Google Fonts
while complying with the __General Data Protection Regulation__ (GDPR), while complying with the __General Data Protection Regulation__ (GDPR),
by automatically downloading and self-hosting the web font files. by automatically downloading and self-hosting the web font files.