OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated JSON schema

Browse Source
This commit is contained in:
squidfunk 2023-07-18 14:02:13 +01:00
parent 545fb27418
commit c2e55585fa
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
3 changed files with 132 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/schema/plugins.json
View File

@ -34,6 +34,9 @@
{ {
"$ref": "plugins/offline.json" "$ref": "plugins/offline.json"
}, },
{
"$ref": "plugins/optimize.json"
},
{ {
"$ref": "plugins/privacy.json" "$ref": "plugins/privacy.json"
}, },
@ -45,6 +48,9 @@
}, },
{ {
"$ref": "plugins/tags.json" "$ref": "plugins/tags.json"
},
{
"$ref": "plugins/typeset.json"
} }
] ]
}, },

95
docs/schema/plugins/optimize.json Normal file
View File

@ -0,0 +1,95 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in optimize plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
"enum": [
"optimize"
]
},
{
"type": "object",
"properties": {
"optimize": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.enabled",
"type": "boolean",
"default": true
},
"concurrency": {
"title": "Concurrency (number of CPUs)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.concurrency",
"type": "number",
"default": 1
},
"cache": {
"title": "Enable caching",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache",
"type": "boolean",
"default": true
},
"cache_dir": {
"title": "Cache directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache_dir",
"type": "string",
"default": ".cache/plugins/social"
},
"optimize_png": {
"title": "Optimization of PNGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png",
"type": "boolean",
"default": true
},
"optimize_png_speed": {
"title": "Speed/quality tradeoff [1,10]",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_speed",
"type": "number",
"default": 4
},
"optimize_png_strip": {
"title": "Strip unnecessary metadata from PNGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_strip",
"type": "boolean",
"default": true
},
"optimize_jpg": {
"title": "Optimization of JPGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg",
"type": "boolean",
"default": true
},
"optimize_jpg_quality": {
"title": "Speed/quality tradeoff for pngquant [0,10]",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_quality",
"type": "number",
"default": 60
},
"optimize_jpg_progressive": {
"title": "Progressive encoding (faster rendering)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_progressive",
"type": "boolean",
"default": true
},
"print_gain": {
"title": "Print optimization gain",
"type": "boolean",
"default": true
},
"print_gain_summary": {
"title": "Print optimization gain summary",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

31
docs/schema/plugins/typeset.json Normal file
View File

@ -0,0 +1,31 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in typeset plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin",
"enum": [
"typeset"
]
},
{
"type": "object",
"properties": {
"typeset": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+typeset.enabled",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}