Skip to content

Commit e7f1519

Browse files
squidfunksquidfunk
committed
Updated JSON schema
1 parent ffc3697 commit e7f1519

File tree

8 files changed

+416
-57
lines changed

8 files changed

+416
-57
lines changed

‎docs/schema.json

+87-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
{
22
"$schema": "https://json-schema.org/draft-07/schema",
33
"title": "Material for MkDocs",
4-
"markdownDescription": "Configuration syntax",
4+
"markdownDescription": "Configuration",
55
"type": "object",
66
"properties": {
7+
"INHERIT": {
8+
"title": "Inherit from configuration",
9+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance",
10+
"pattern": "\\.yml$"
11+
},
712
"site_name": {
8-
"title": "Site name – set in header, title and drawer",
13+
"title": "Site name, used in header, title and drawer",
914
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_name",
1015
"type": "string"
1116
},
@@ -15,15 +20,89 @@
1520
"type": "string"
1621
},
1722
"site_author": {
18-
"title": "Site author, set as meta tag",
23+
"title": "Site author, used in document head",
1924
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_author",
2025
"type": "string"
2126
},
2227
"site_description": {
23-
"title": "Site description, set as meta tag and in social cards",
28+
"title": "Site description, used in document head and in social cards",
2429
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_description",
2530
"type": "string"
2631
},
32+
"repo_name": {
33+
"title": "Repository name, used in header",
34+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-name",
35+
"type": "string"
36+
},
37+
"repo_url": {
38+
"title": "Repository URL",
39+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository",
40+
"type": "string"
41+
},
42+
"edit_uri": {
43+
"title": "Path from repository root to directory containing Markdown",
44+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#edit-button",
45+
"type": "string"
46+
},
47+
"copyright": {
48+
"title": "Copyright, used in footer",
49+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice",
50+
"type": "string"
51+
},
52+
"docs_dir": {
53+
"title": "Directory containing the Markdown sources",
54+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#docs_dir",
55+
"type": "string",
56+
"default": "docs"
57+
},
58+
"site_dir": {
59+
"title": "Directory containing the HTML output",
60+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_dir",
61+
"type": "string",
62+
"default": "site"
63+
},
64+
"use_directory_urls": {
65+
"title": "Pages are located in their own directories",
66+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#use_directory_urls",
67+
"type": "boolean",
68+
"default": false
69+
},
70+
"extra_templates": {
71+
"title": "Additional HTML files to include",
72+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates",
73+
"type": "array",
74+
"items": {
75+
"title": "Path to HTML file",
76+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates",
77+
"pattern": "\\.html$"
78+
},
79+
"uniqueItems": true,
80+
"minItems": 1
81+
},
82+
"extra_css": {
83+
"title": "Additional CSS files to include",
84+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css",
85+
"type": "array",
86+
"items": {
87+
"title": "Path to CSS file",
88+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css",
89+
"pattern": "\\.css$"
90+
},
91+
"uniqueItems": true,
92+
"minItems": 1
93+
},
94+
"extra_javascript": {
95+
"title": "Additional JavaScript files to include",
96+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript",
97+
"type": "array",
98+
"items": {
99+
"title": "Path to JavaScript file",
100+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript",
101+
"pattern": "\\.js$"
102+
},
103+
"uniqueItems": true,
104+
"minItems": 1
105+
},
27106
"theme": {
28107
"$ref": "schema/theme.json"
29108
},
@@ -32,10 +111,10 @@
32111
},
33112
"markdown_extensions": {
34113
"$ref": "schema/extensions.json"
114+
},
115+
"nav": {
116+
"$ref": "schema/nav.json"
35117
}
36118
},
37-
"additionalProperties": false,
38-
"required": [
39-
"site_name"
40-
]
119+
"additionalProperties": false
41120
}

‎docs/schema/extensions.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@
9292
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-permalink",
9393
"type": "string"
9494
}
95-
]
95+
],
96+
"default": true
9697
},
9798
"permalink_title": {
9899
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-permalink-title",
@@ -401,7 +402,7 @@
401402
{
402403
"oneOf": [
403404
{
404-
"title": "˘ark – Python Markdown Extensions",
405+
"title": "Mark – Python Markdown Extensions",
405406
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
406407
"enum": [
407408
"pymdownx.mark"
@@ -411,7 +412,7 @@
411412
"type": "object",
412413
"properties": {
413414
"pymdownx.mark": {
414-
"title": "˘ark – Python Markdown Extensions",
415+
"title": "Mark – Python Markdown Extensions",
415416
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
416417
"type": "object",
417418
"properties": {

‎docs/schema/nav.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"$schema": "https://json-schema.org/draft-07/schema",
3+
"title": "Navigation tree",
4+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
5+
"type": "array",
6+
"items": {
7+
"oneOf": [
8+
{
9+
"title": "Navigation item",
10+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
11+
"pattern": "\\.md$"
12+
},
13+
{
14+
"type": "object",
15+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
16+
"patternProperties": {
17+
".*": {
18+
"oneOf": [
19+
{
20+
"title": "Navigation item",
21+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
22+
"pattern": "\\.md$"
23+
},
24+
{
25+
"$ref": "#"
26+
}
27+
]
28+
}
29+
}
30+
}
31+
]
32+
},
33+
"additionalItems": false
34+
}

‎docs/schema/plugins/minify.json

+22-12
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"$schema": "https://json-schema.org/draft-07/schema",
33
"title": "Minify plugin",
4-
"description": "Configuration syntax",
54
"type": "object",
65
"properties": {
76
"minify": {
@@ -17,36 +16,47 @@
1716
},
1817
"properties": {
1918
"minify_html": {
20-
"description": "Minify HTML files",
21-
"type": "boolean"
19+
"title": "Minify HTML files",
20+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
21+
"type": "boolean",
22+
"default": true
2223
},
2324
"minify_js": {
24-
"description": "Minify JS files",
25-
"type": "boolean"
25+
"title": "Minify JavaScript files",
26+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
27+
"type": "boolean",
28+
"default": true
2629
},
2730
"minify_css": {
28-
"description": "Minify CSS files",
29-
"type": "boolean"
31+
"title": "Minify CSS files",
32+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
33+
"type": "boolean",
34+
"default": true
3035
},
3136
"htmlmin_opts": {
32-
"description": "Options for HTML minifier",
37+
"title": "Options for HTML minifier",
38+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
3339
"type": "object"
3440
},
3541
"js_files": {
36-
"description": "List of JS files to minify",
42+
"title": "JavaScript files to minify",
43+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
3744
"type": "array",
3845
"items": {
39-
"description": "JS file to minify",
46+
"title": "Path to JavaScript file",
47+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
4048
"pattern": "\\.js$"
4149
},
4250
"uniqueItems": true,
4351
"minItems": 1
4452
},
4553
"css_files": {
46-
"description": "List of CSS files to minify",
54+
"title": "CSS files to minify",
55+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
4756
"type": "array",
4857
"items": {
49-
"description": "CSS file to minify",
58+
"title": "Path to CSS file",
59+
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
5060
"pattern": "\\.css$"
5161
},
5262
"uniqueItems": true,

‎docs/schema/plugins/redirects.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
{
22
"$schema": "https://json-schema.org/draft-07/schema",
33
"title": "Redirects plugin",
4-
"description": "Configuration syntax",
54
"type": "object",
65
"properties": {
76
"redirects": {
87
"markdownDescription": "https://github.com/datarobot/mkdocs-redirects",
98
"type": "object",
109
"properties": {
1110
"redirect_maps": {
12-
"description": "Internal and external redirects",
11+
"title": "Mapping of Markdown files",
12+
"markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using",
1313
"type": "object",
1414
"patternProperties": {
1515
"\\.md$": {
1616
"oneOf": [
1717
{
18-
"description": "Internal redirect",
19-
"type": "string",
18+
"title": "Internal redirect",
19+
"markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using",
2020
"pattern": "\\.md$"
2121
},
2222
{
23-
"description": "External redirect",
24-
"type": "string",
23+
"title": "External redirect",
24+
"markdownDescription": "https://github.com/datarobot/mkdocs-redirects#using",
2525
"pattern": "^https?:"
2626
}
2727
]

0 commit comments

Comments
 (0)