2022-01-29 19:14:23 +01:00
|
|
|
{
|
|
|
|
"$schema": "https://json-schema.org/draft-07/schema",
|
|
|
|
"title": "Built-in social plugin",
|
|
|
|
"oneOf": [
|
|
|
|
{
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/",
|
2022-01-29 19:14:23 +01:00
|
|
|
"enum": [
|
|
|
|
"social"
|
|
|
|
]
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"type": "object",
|
|
|
|
"properties": {
|
|
|
|
"social": {
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/",
|
2022-01-29 19:14:23 +01:00
|
|
|
"type": "object",
|
|
|
|
"properties": {
|
2023-05-08 18:58:32 +02:00
|
|
|
"enabled": {
|
|
|
|
"title": "Enable plugin",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.enabled",
|
2022-02-21 12:03:36 +01:00
|
|
|
"type": "boolean",
|
|
|
|
"default": true
|
2022-01-29 19:14:23 +01:00
|
|
|
},
|
2023-05-08 18:58:32 +02:00
|
|
|
"concurrency": {
|
|
|
|
"title": "Concurrency (number of CPUs)",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.concurrency",
|
2023-07-29 17:58:01 +02:00
|
|
|
"type": "number"
|
2022-01-29 19:14:23 +01:00
|
|
|
},
|
2023-09-15 11:30:01 +02:00
|
|
|
"cache": {
|
|
|
|
"title": "Enable caching",
|
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache",
|
|
|
|
"type": "boolean",
|
|
|
|
"default": true
|
|
|
|
},
|
|
|
|
"cache_dir": {
|
|
|
|
"title": "Cache directory",
|
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache_dir",
|
|
|
|
"type": "string",
|
|
|
|
"default": ".cache/plugins/social"
|
|
|
|
},
|
2023-05-08 18:58:32 +02:00
|
|
|
"cards": {
|
|
|
|
"title": "Social cards",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "boolean",
|
|
|
|
"default": true
|
2022-01-29 19:14:23 +01:00
|
|
|
},
|
2022-06-19 08:17:14 +02:00
|
|
|
"cards_dir": {
|
2023-05-08 18:58:32 +02:00
|
|
|
"title": "Social cards directory",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_dir",
|
2022-01-29 19:14:23 +01:00
|
|
|
"type": "string",
|
|
|
|
"default": "assets/images/social"
|
2023-05-08 18:58:32 +02:00
|
|
|
},
|
|
|
|
"cards_layout_dir": {
|
|
|
|
"title": "Social cards layout directory",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_dir",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "string",
|
|
|
|
"default": "layouts"
|
|
|
|
},
|
|
|
|
"cards_layout": {
|
|
|
|
"title": "Social cards layout",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout",
|
2023-05-08 18:58:32 +02:00
|
|
|
"default": "default",
|
2023-09-15 11:30:01 +02:00
|
|
|
"oneOf": [
|
|
|
|
{
|
|
|
|
"enum": [
|
|
|
|
"default",
|
|
|
|
"default/accent",
|
|
|
|
"default/invert",
|
|
|
|
"default/variant"
|
|
|
|
]
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"type": "string"
|
|
|
|
}
|
2023-05-08 18:58:32 +02:00
|
|
|
]
|
|
|
|
},
|
|
|
|
"cards_layout_options": {
|
|
|
|
"title": "Social cards layout options",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_options",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "object"
|
|
|
|
},
|
2023-05-20 17:23:53 +02:00
|
|
|
"cards_include": {
|
|
|
|
"title": "Pages or folders to include",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include",
|
2023-05-20 17:23:53 +02:00
|
|
|
"type": "array",
|
|
|
|
"items": {
|
|
|
|
"title": "Pages or folders matching this pattern will be included",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include",
|
2023-05-20 17:23:53 +02:00
|
|
|
"pattern": ".*"
|
|
|
|
},
|
|
|
|
"uniqueItems": true,
|
|
|
|
"minItems": 1
|
|
|
|
},
|
|
|
|
"cards_exclude": {
|
|
|
|
"title": "Pages or folders to exclude",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude",
|
2023-05-20 17:23:53 +02:00
|
|
|
"type": "array",
|
|
|
|
"items": {
|
|
|
|
"title": "Pages or folders matching this pattern will be excluded",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude",
|
2023-05-20 17:23:53 +02:00
|
|
|
"pattern": ".*"
|
|
|
|
},
|
|
|
|
"uniqueItems": true,
|
|
|
|
"minItems": 1
|
|
|
|
},
|
2023-05-08 18:58:32 +02:00
|
|
|
"debug": {
|
|
|
|
"title": "Debug mode",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "boolean",
|
|
|
|
"default": true
|
|
|
|
},
|
2023-05-20 11:01:27 +02:00
|
|
|
"debug_on_build": {
|
|
|
|
"title": "Always disable debug mode on build",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_on_build",
|
2023-05-20 11:01:27 +02:00
|
|
|
"type": "boolean",
|
|
|
|
"default": false
|
|
|
|
},
|
2023-05-08 18:58:32 +02:00
|
|
|
"debug_grid": {
|
|
|
|
"title": "Debug grid",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "boolean",
|
|
|
|
"default": true
|
|
|
|
},
|
|
|
|
"debug_grid_step": {
|
|
|
|
"title": "Debug grid step size",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid_step",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "number",
|
|
|
|
"default": 32
|
|
|
|
},
|
|
|
|
"debug_color": {
|
|
|
|
"title": "Debug color",
|
2023-09-15 11:30:01 +02:00
|
|
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_color",
|
2023-05-08 18:58:32 +02:00
|
|
|
"type": "string",
|
|
|
|
"default": "yellow"
|
2022-01-29 19:14:23 +01:00
|
|
|
}
|
|
|
|
},
|
2023-05-08 18:58:32 +02:00
|
|
|
"additionalProperties": false
|
2022-01-29 19:14:23 +01:00
|
|
|
}
|
|
|
|
},
|
|
|
|
"additionalProperties": false
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|