Updated schema and documentation

This commit is contained in:
squidfunk
2022-06-19 08:17:14 +02:00
parent 0fea20fca3
commit db294a18c6
4 changed files with 8 additions and 8 deletions

View File

@@ -40,9 +40,9 @@
], ],
"default": "bundle" "default": "bundle"
}, },
"externals_directory": { "externals_dir": {
"title": "External assets download directory", "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", "type": "string",
"default": "assets/externals" "default": "assets/externals"
}, },

View File

@@ -46,9 +46,9 @@
"cards_font": { "cards_font": {
"$ref": "../assets/fonts.json" "$ref": "../assets/fonts.json"
}, },
"cards_directory": { "cards_dir": {
"title": "Social card directory", "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", "type": "string",
"default": "assets/images/social" "default": "assets/images/social"
} }

View File

@@ -206,7 +206,7 @@ The following configuration options are available:
[customization]: ../customization.md [customization]: ../customization.md
[strict mode]: https://www.mkdocs.org/user-guide/configuration/#strict [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 : :octicons-milestone-24: Default: `assets/externals` This option
specifies where the downloaded [external assets] will be stored. It's specifies where the downloaded [external assets] will be stored. It's
@@ -215,7 +215,7 @@ The following configuration options are available:
``` yaml ``` yaml
plugins: plugins:
- privacy: - privacy:
externals_directory: assets/externals externals_dir: assets/externals
``` ```
`externals_exclude`{ #externals-exclude } `externals_exclude`{ #externals-exclude }

View File

@@ -102,7 +102,7 @@ The following configuration options are available:
cards_font: Roboto cards_font: Roboto
``` ```
`cards_directory`{ #cards-directory } `cards_dir`{ #cards-dir }
: :octicons-milestone-24: Default: `assets/images/social` This option : :octicons-milestone-24: Default: `assets/images/social` This option
specifies where the generated social card images will be written to. It's specifies where the generated social card images will be written to. It's
@@ -111,7 +111,7 @@ The following configuration options are available:
``` yaml ``` yaml
plugins: plugins:
- social: - social:
cards_directory: assets/images/social cards_dir: assets/images/social
``` ```
[Insiders]: ../insiders/index.md [Insiders]: ../insiders/index.md