From 27efd1dd6149cdc96e3b4fb3f4ac8e58a895762e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 2 Apr 2022 15:31:38 +0200 Subject: [PATCH] Added notes on configuration inheritance to all Insiders plugins --- docs/setup/building-for-offline-usage.md | 5 +++++ docs/setup/ensuring-data-privacy.md | 5 +++++ docs/setup/setting-up-social-cards.md | 5 +++++ 3 files changed, 15 insertions(+) diff --git a/docs/setup/building-for-offline-usage.md b/docs/setup/building-for-offline-usage.md index b3a5e4aec..e1d193c5d 100644 --- a/docs/setup/building-for-offline-usage.md +++ b/docs/setup/building-for-offline-usage.md @@ -40,6 +40,10 @@ plugins: [Insiders]. Note, however, that setup might be challenging if you're not 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] via `mkdocs.yml`, ensuring that users can open your documentation directly from the local file system. @@ -72,6 +76,7 @@ hosted on a regular server. [site search]: setting-up-site-search.md [site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir [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 [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables [built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 1573a50e9..43b696707 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -116,6 +116,10 @@ plugins: replace. If a plugin after the privacy plugin adds further [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: `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 plugin due to [technical limitations]. + [built-in plugins]: ../insiders/getting-started.md#built-in-plugins [MathJax]: ../reference/mathjax.md [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 diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index bf3e095b1..b50e426c3 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -53,6 +53,10 @@ plugins: - 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: `cards`{ #cards } @@ -113,6 +117,7 @@ The following configuration options are available: [Insiders]: ../insiders/index.md [dependencies]: #dependencies [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 [CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords [Google Fonts]: https://fonts.google.com