Skip to content

Commit c2e5558

Browse files
committed
Updated JSON schema
1 parent 545fb27 commit c2e5558

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

docs/schema/plugins.json

+6
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
{
3535
"$ref": "plugins/offline.json"
3636
},
37+
{
38+
"$ref": "plugins/optimize.json"
39+
},
3740
{
3841
"$ref": "plugins/privacy.json"
3942
},
@@ -45,6 +48,9 @@
4548
},
4649
{
4750
"$ref": "plugins/tags.json"
51+
},
52+
{
53+
"$ref": "plugins/typeset.json"
4854
}
4955
]
5056
},

docs/schema/plugins/optimize.json

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"$schema": "https://json-schema.org/draft-07/schema",
3+
"title": "Built-in optimize plugin",
4+
"oneOf": [
5+
{
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
7+
"enum": [
8+
"optimize"
9+
]
10+
},
11+
{
12+
"type": "object",
13+
"properties": {
14+
"optimize": {
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
16+
"type": "object",
17+
"properties": {
18+
"enabled": {
19+
"title": "Enable plugin",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.enabled",
21+
"type": "boolean",
22+
"default": true
23+
},
24+
"concurrency": {
25+
"title": "Concurrency (number of CPUs)",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.concurrency",
27+
"type": "number",
28+
"default": 1
29+
},
30+
"cache": {
31+
"title": "Enable caching",
32+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache",
33+
"type": "boolean",
34+
"default": true
35+
},
36+
"cache_dir": {
37+
"title": "Cache directory",
38+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache_dir",
39+
"type": "string",
40+
"default": ".cache/plugins/social"
41+
},
42+
"optimize_png": {
43+
"title": "Optimization of PNGs",
44+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png",
45+
"type": "boolean",
46+
"default": true
47+
},
48+
"optimize_png_speed": {
49+
"title": "Speed/quality tradeoff [1,10]",
50+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_speed",
51+
"type": "number",
52+
"default": 4
53+
},
54+
"optimize_png_strip": {
55+
"title": "Strip unnecessary metadata from PNGs",
56+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_strip",
57+
"type": "boolean",
58+
"default": true
59+
},
60+
"optimize_jpg": {
61+
"title": "Optimization of JPGs",
62+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg",
63+
"type": "boolean",
64+
"default": true
65+
},
66+
"optimize_jpg_quality": {
67+
"title": "Speed/quality tradeoff for pngquant [0,10]",
68+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_quality",
69+
"type": "number",
70+
"default": 60
71+
},
72+
"optimize_jpg_progressive": {
73+
"title": "Progressive encoding (faster rendering)",
74+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_progressive",
75+
"type": "boolean",
76+
"default": true
77+
},
78+
"print_gain": {
79+
"title": "Print optimization gain",
80+
"type": "boolean",
81+
"default": true
82+
},
83+
"print_gain_summary": {
84+
"title": "Print optimization gain summary",
85+
"type": "boolean",
86+
"default": true
87+
}
88+
},
89+
"additionalProperties": false
90+
}
91+
},
92+
"additionalProperties": false
93+
}
94+
]
95+
}

docs/schema/plugins/typeset.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"$schema": "https://json-schema.org/draft-07/schema",
3+
"title": "Built-in typeset plugin",
4+
"oneOf": [
5+
{
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin",
7+
"enum": [
8+
"typeset"
9+
]
10+
},
11+
{
12+
"type": "object",
13+
"properties": {
14+
"typeset": {
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin",
16+
"type": "object",
17+
"properties": {
18+
"enabled": {
19+
"title": "Enable plugin",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+typeset.enabled",
21+
"type": "boolean",
22+
"default": true
23+
}
24+
},
25+
"additionalProperties": false
26+
}
27+
},
28+
"additionalProperties": false
29+
}
30+
]
31+
}

0 commit comments

Comments
 (0)