1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 17:30:56 +01:00
mkdocs-material/docs/schema/plugins/privacy.json

101 lines
3.9 KiB
JSON
Raw Normal View History

2022-02-21 12:03:36 +01:00
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in privacy plugin",
"oneOf": [
{
2022-07-17 16:36:42 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
2022-02-21 12:03:36 +01:00
"enum": [
"privacy"
]
},
{
"type": "object",
"properties": {
"privacy": {
2022-07-17 16:36:42 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
2022-02-21 12:03:36 +01:00
"type": "object",
"properties": {
2022-02-27 13:12:42 +01:00
"enabled": {
"title": "Enable plugin",
2022-09-11 19:25:40 +02:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled",
2022-02-21 12:03:36 +01:00
"type": "boolean",
"default": true
},
2022-10-03 20:07:28 +02:00
"cache": {
"title": "Enable caching of downloads",
"type": "boolean",
"default": true
},
"cache_dir": {
"title": "Cache directory",
"type": "string",
"default": ".cache/plugin/privacy"
},
"external_assets": {
2022-02-27 13:12:42 +01:00
"title": "External assets",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets",
2022-02-27 13:12:42 +01:00
"oneOf": [
{
"title": "Bundle external assets",
"enum": [
"bundle"
]
},
{
"title": "Report external assets as warnings",
"enum": [
"report"
]
}
],
"default": "bundle"
},
"external_assets_dir": {
2022-02-27 13:12:42 +01:00
"title": "External assets download directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_dir",
2022-02-21 12:03:36 +01:00
"type": "string",
"default": "assets/external"
2022-03-05 13:52:56 +01:00
},
"external_assets_exclude": {
2022-03-05 13:52:56 +01:00
"title": "External assets to be excluded",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
2022-03-05 13:52:56 +01:00
"type": "array",
"items": {
"title": "External assets matching this pattern will not be bundled",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
2022-03-05 13:52:56 +01:00
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
},
"external_links": {
"title": "External links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links",
"type": "boolean",
"default": true
},
"external_links_attr_map": {
"title": "Custom attributes to add to external links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links_attr_map",
"type": "object",
"patternProperties": {
"^[\\w_]+$": {
"type": "string"
}
}
},
"external_links_noopener": {
"title": "Behavior for external links that open in new windows",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links_noopener",
"type": "boolean",
"default": true
2022-02-21 12:03:36 +01:00
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}