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

Added notes on configuration inheritance to all Insiders plugins

Browse Source
This commit is contained in:
squidfunk 2022-04-02 15:31:38 +02:00
parent e93ce257c3
commit 27efd1dd61
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -40,6 +40,10 @@ plugins:
[Insiders]. Note, however, that setup might be challenging if you're not [Insiders]. Note, however, that setup might be challenging if you're not
experienced with MkDocs. experienced with MkDocs.
> If you need to be able to build your documentation with and without
> [Insiders], please refer to the [built-in plugins] section to learn how
> shared configurations help to achieve this.
The plugin will automatically disable [`use_directory_urls`][use_directory_urls] The plugin will automatically disable [`use_directory_urls`][use_directory_urls]
via `mkdocs.yml`, ensuring that users can open your documentation directly via `mkdocs.yml`, ensuring that users can open your documentation directly
from the local file system. from the local file system.
@ -72,6 +76,7 @@ hosted on a regular server.
[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
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/ [localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
[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

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

@ -116,6 +116,10 @@ plugins:
replace. If a plugin after the privacy plugin adds further replace. If a plugin after the privacy plugin adds further
[external assets], these assets will not be downloaded. [external assets], these assets will not be downloaded.
> If you need to be able to build your documentation with and without
> [Insiders], please refer to the [built-in plugins] section to learn how
> shared configurations help to achieve this.
The following configuration options are available: The following configuration options are available:
`enabled`{ #enabled } `enabled`{ #enabled }
@ -192,6 +196,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].
[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
[Giscus can be self-hosted]: https://github.com/giscus/giscus/blob/main/SELF-HOSTING.md [Giscus can be self-hosted]: https://github.com/giscus/giscus/blob/main/SELF-HOSTING.md

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

@ -53,6 +53,10 @@ plugins:
- social - social
``` ```
> If you need to be able to build your documentation with and without
> [Insiders], please refer to the [built-in plugins] section to learn how
> shared configurations help to achieve this.
The following configuration options are available: The following configuration options are available:
`cards`{ #cards } `cards`{ #cards }
@ -113,6 +117,7 @@ The following configuration options are available:
[Insiders]: ../insiders/index.md [Insiders]: ../insiders/index.md
[dependencies]: #dependencies [dependencies]: #dependencies
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url [site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords [CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords
[Google Fonts]: https://fonts.google.com [Google Fonts]: https://fonts.google.com