Skip to content

Commit 96560b8

Browse files
committed
Fixed links to plugin settings in JSON schema
1 parent d373e7a commit 96560b8

File tree

12 files changed

+229
-147
lines changed

12 files changed

+229
-147
lines changed

docs/schema/plugins/blog.json

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

docs/schema/plugins/group.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@
66
"type": "object",
77
"properties": {
88
"group": {
9-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#built-in-group-plugin",
9+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/",
1010
"type": "object",
1111
"properties": {
1212
"enabled": {
1313
"title": "Enable plugin",
14-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#+group.enabled",
14+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.enabled",
1515
"type": "boolean",
1616
"default": true
1717
},
1818
"plugins": {
19+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.plugins",
1920
"$ref": "../plugins.json"
2021
}
2122
},

docs/schema/plugins/info.json

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in info plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/",
77
"enum": [
88
"info"
99
]
@@ -12,12 +12,30 @@
1212
"type": "object",
1313
"properties": {
1414
"info": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {
1919
"title": "Enable plugin",
20-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled",
21+
"type": "boolean",
22+
"default": true
23+
},
24+
"enabled_on_serve": {
25+
"title": "Enable plugin when previewing",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled_on_serve",
27+
"type": "boolean",
28+
"default": false
29+
},
30+
"archive": {
31+
"title": "Enable creation of archive",
32+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive",
33+
"type": "boolean",
34+
"default": true
35+
},
36+
"archive_stop_on_violation": {
37+
"title": "Stop creation of archive on violation",
38+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive_stop_on_violation",
2139
"type": "boolean",
2240
"default": true
2341
}

docs/schema/plugins/meta.json

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in meta plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
77
"enum": [
88
"meta"
99
]
@@ -12,12 +12,18 @@
1212
"type": "object",
1313
"properties": {
1414
"meta": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
1616
"type": "object",
1717
"properties": {
18+
"enabled": {
19+
"title": "Enable plugin",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.enabled",
21+
"type": "boolean",
22+
"default": true
23+
},
1824
"meta_file": {
1925
"title": "Meta file name",
20-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+meta.meta_file",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.meta_file",
2127
"pattern": "\\.yml$",
2228
"default": "\"**/.meta.yml\""
2329
}

docs/schema/plugins/offline.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in offline plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/",
77
"enum": [
88
"offline"
99
]
@@ -12,12 +12,12 @@
1212
"type": "object",
1313
"properties": {
1414
"offline": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#built-in-offline-plugin",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {
1919
"title": "Enable plugin",
20-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#+offline.enabled",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/#config.enabled",
2121
"type": "boolean",
2222
"default": true
2323
}

docs/schema/plugins/optimize.json

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in optimize plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/",
77
"enum": [
88
"optimize"
99
]
@@ -12,75 +12,101 @@
1212
"type": "object",
1313
"properties": {
1414
"optimize": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {
1919
"title": "Enable plugin",
20-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.enabled",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.enabled",
2121
"type": "boolean",
2222
"default": true
2323
},
2424
"concurrency": {
2525
"title": "Concurrency (number of CPUs)",
26-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.concurrency",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.concurrency",
2727
"type": "number"
2828
},
2929
"cache": {
3030
"title": "Enable caching",
31-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache",
31+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache",
3232
"type": "boolean",
3333
"default": true
3434
},
3535
"cache_dir": {
3636
"title": "Cache directory",
37-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache_dir",
37+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache_dir",
3838
"type": "string",
39-
"default": ".cache/plugins/social"
39+
"default": ".cache/plugins/optimize"
4040
},
4141
"optimize_png": {
4242
"title": "Optimization of PNGs",
43-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png",
43+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png",
4444
"type": "boolean",
4545
"default": true
4646
},
4747
"optimize_png_speed": {
4848
"title": "Speed/quality tradeoff [1,10]",
49-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_speed",
49+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed",
5050
"type": "number",
5151
"default": 4
5252
},
5353
"optimize_png_strip": {
5454
"title": "Strip unnecessary metadata from PNGs",
55-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_strip",
55+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip",
5656
"type": "boolean",
5757
"default": true
5858
},
5959
"optimize_jpg": {
6060
"title": "Optimization of JPGs",
61-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg",
61+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg",
6262
"type": "boolean",
6363
"default": true
6464
},
6565
"optimize_jpg_quality": {
6666
"title": "Speed/quality tradeoff for pngquant [0,10]",
67-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_quality",
67+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality",
6868
"type": "number",
6969
"default": 60
7070
},
7171
"optimize_jpg_progressive": {
7272
"title": "Progressive encoding (faster rendering)",
73-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_progressive",
73+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive",
7474
"type": "boolean",
7575
"default": true
7676
},
77+
"optimize_include": {
78+
"title": "Files or folders to include",
79+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include",
80+
"type": "array",
81+
"items": {
82+
"title": "Files or folders matching this pattern will be included",
83+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include",
84+
"pattern": ".*"
85+
},
86+
"uniqueItems": true,
87+
"minItems": 1
88+
},
89+
"optimize_exclude": {
90+
"title": "Files or folders to exclude",
91+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude",
92+
"type": "array",
93+
"items": {
94+
"title": "Files or folders matching this pattern will be excluded",
95+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude",
96+
"pattern": ".*"
97+
},
98+
"uniqueItems": true,
99+
"minItems": 1
100+
},
77101
"print_gain": {
78102
"title": "Print optimization gain",
103+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain",
79104
"type": "boolean",
80105
"default": true
81106
},
82107
"print_gain_summary": {
83108
"title": "Print optimization gain summary",
109+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary",
84110
"type": "boolean",
85111
"default": true
86112
}

docs/schema/plugins/privacy.json

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Built-in privacy plugin",
44
"oneOf": [
55
{
6-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
6+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/",
77
"enum": [
88
"privacy"
99
]
@@ -12,71 +12,83 @@
1212
"type": "object",
1313
"properties": {
1414
"privacy": {
15-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
15+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/",
1616
"type": "object",
1717
"properties": {
1818
"enabled": {
1919
"title": "Enable plugin",
20-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.enabled",
2121
"type": "boolean",
2222
"default": true
2323
},
2424
"concurrency": {
2525
"title": "Concurrency (number of CPUs)",
26-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.concurrency",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.concurrency",
2727
"type": "number"
2828
},
29+
"cache": {
30+
"title": "Enable caching",
31+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache",
32+
"type": "boolean",
33+
"default": true
34+
},
35+
"cache_dir": {
36+
"title": "Cache directory",
37+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache_dir",
38+
"type": "string",
39+
"default": ".cache/plugins/privacy"
40+
},
2941
"assets": {
3042
"title": "Process external assets",
31-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets",
43+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets",
3244
"type": "boolean",
3345
"default": true
3446
},
3547
"assets_fetch": {
3648
"title": "Download external assets",
37-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_fetch",
49+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch",
3850
"type": "boolean",
3951
"default": true
4052
},
4153
"assets_fetch_dir": {
4254
"title": "Download external assets to this directory",
43-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_fetch_dir",
55+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch_dir",
4456
"type": "string",
4557
"default": "assets/external"
4658
},
4759
"assets_include": {
4860
"title": "External assets to include",
49-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_include",
61+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include",
5062
"type": "array",
5163
"items": {
5264
"title": "External assets matching this pattern will be downloaded",
53-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_include",
65+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include",
5466
"pattern": ".*"
5567
},
5668
"uniqueItems": true,
5769
"minItems": 1
5870
},
5971
"assets_exclude": {
6072
"title": "External assets to exclude",
61-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_exclude",
73+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude",
6274
"type": "array",
6375
"items": {
6476
"title": "External assets matching this pattern will not be downloaded",
65-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.assets_exclude",
77+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude",
6678
"pattern": ".*"
6779
},
6880
"uniqueItems": true,
6981
"minItems": 1
7082
},
7183
"links": {
7284
"title": "Process external links",
73-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links",
85+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links",
7486
"type": "boolean",
7587
"default": true
7688
},
7789
"links_attr_map": {
7890
"title": "Custom attributes to add to external links",
79-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links_attr_map",
91+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map",
8092
"type": "object",
8193
"patternProperties": {
8294
"^[\\w_]+$": {
@@ -86,7 +98,7 @@
8698
},
8799
"links_noopener": {
88100
"title": "Behavior for external links that open in new windows",
89-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.links_noopener",
101+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_noopener",
90102
"type": "boolean",
91103
"default": true
92104
}

0 commit comments

Comments
 (0)