mkdocs-material/docs/schema/plugins/privacy.json

69 lines
2.5 KiB
JSON
Raw Normal View History

2022-02-21 14:03:36 +03:00
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in privacy plugin",
"oneOf": [
{
2022-07-17 17:36:42 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
2022-02-21 14:03:36 +03:00
"enum": [
"privacy"
]
},
{
"type": "object",
"properties": {
"privacy": {
2022-07-17 17:36:42 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
2022-02-21 14:03:36 +03:00
"type": "object",
"properties": {
2022-02-27 15:12:42 +03:00
"enabled": {
"title": "Enable plugin",
2022-09-11 20:25:40 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled",
2022-02-21 14:03:36 +03:00
"type": "boolean",
"default": true
},
2022-02-27 15:12:42 +03:00
"externals": {
"title": "External assets",
2022-09-11 20:25:40 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals",
2022-02-27 15:12:42 +03:00
"oneOf": [
{
"title": "Bundle external assets",
"enum": [
"bundle"
]
},
{
"title": "Report external assets as warnings",
"enum": [
"report"
]
}
],
"default": "bundle"
},
2022-06-19 09:17:14 +03:00
"externals_dir": {
2022-02-27 15:12:42 +03:00
"title": "External assets download directory",
2022-09-11 20:25:40 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_dir",
2022-02-21 14:03:36 +03:00
"type": "string",
"default": "assets/externals"
2022-03-05 15:52:56 +03:00
},
"externals_exclude": {
"title": "External assets to be excluded",
2022-09-11 20:25:40 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_exclude",
2022-03-05 15:52:56 +03:00
"type": "array",
"items": {
"title": "External assets matching this pattern will not be bundled",
2022-09-11 20:25:40 +03:00
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_exclude",
2022-03-05 15:52:56 +03:00
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
2022-02-21 14:03:36 +03:00
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}