Skip to content

Commit 8a1e52a

Browse files
committed
Added JSON schema
1 parent bcba266 commit 8a1e52a

File tree

7 files changed

+1476
-0
lines changed

7 files changed

+1476
-0
lines changed

docs/schema.json

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"$schema": "https://json-schema.org/draft-07/schema",
3+
"title": "Material for MkDocs",
4+
"markdownDescription": "Configuration syntax",
5+
"type": "object",
6+
"properties": {
7+
"site_name": {
8+
"title": "Site name – set in header, title and drawer",
9+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_name",
10+
"type": "string"
11+
},
12+
"site_url": {
13+
"title": "Site URL",
14+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_url",
15+
"type": "string"
16+
},
17+
"site_author": {
18+
"title": "Site author, set as meta tag",
19+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_author",
20+
"type": "string"
21+
},
22+
"site_description": {
23+
"title": "Site description, set as meta tag and in social cards",
24+
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_description",
25+
"type": "string"
26+
},
27+
"theme": {
28+
"$ref": "schema/theme.json"
29+
},
30+
"plugins": {
31+
"$ref": "schema/plugins.json"
32+
},
33+
"markdown_extensions": {
34+
"$ref": "schema/extensions.json"
35+
}
36+
},
37+
"additionalProperties": false,
38+
"required": [
39+
"site_name"
40+
]
41+
}

0 commit comments

Comments
 (0)