From db294a18c63ae7b90b08076db41a7e7f77afd96c Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 19 Jun 2022 08:17:14 +0200 Subject: [PATCH] Updated schema and documentation --- docs/schema/plugins/privacy.json | 4 ++-- docs/schema/plugins/social.json | 4 ++-- docs/setup/ensuring-data-privacy.md | 4 ++-- docs/setup/setting-up-social-cards.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/schema/plugins/privacy.json b/docs/schema/plugins/privacy.json index 62c0e851d..a2af61182 100644 --- a/docs/schema/plugins/privacy.json +++ b/docs/schema/plugins/privacy.json @@ -40,9 +40,9 @@ ], "default": "bundle" }, - "externals_directory": { + "externals_dir": { "title": "External assets download directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-directory", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-dir", "type": "string", "default": "assets/externals" }, diff --git a/docs/schema/plugins/social.json b/docs/schema/plugins/social.json index b062cbf61..f68deb305 100644 --- a/docs/schema/plugins/social.json +++ b/docs/schema/plugins/social.json @@ -46,9 +46,9 @@ "cards_font": { "$ref": "../assets/fonts.json" }, - "cards_directory": { + "cards_dir": { "title": "Social card directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-directory", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-dir", "type": "string", "default": "assets/images/social" } diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index a044b337c..048672528 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -206,7 +206,7 @@ The following configuration options are available: [customization]: ../customization.md [strict mode]: https://www.mkdocs.org/user-guide/configuration/#strict -`externals_directory`{ #externals-directory } +`externals_dir`{ #externals-dir } : :octicons-milestone-24: Default: `assets/externals` – This option specifies where the downloaded [external assets] will be stored. It's @@ -215,7 +215,7 @@ The following configuration options are available: ``` yaml plugins: - privacy: - externals_directory: assets/externals + externals_dir: assets/externals ``` `externals_exclude`{ #externals-exclude } diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index a6233721a..c47246f17 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -102,7 +102,7 @@ The following configuration options are available: cards_font: Roboto ``` -`cards_directory`{ #cards-directory } +`cards_dir`{ #cards-dir } : :octicons-milestone-24: Default: `assets/images/social` – This option specifies where the generated social card images will be written to. It's @@ -111,7 +111,7 @@ The following configuration options are available: ``` yaml plugins: - social: - cards_directory: assets/images/social + cards_dir: assets/images/social ``` [Insiders]: ../insiders/index.md