/
schema
165 lines (164 loc) · 5.25 KB
/
schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/idoc",
"title": "JSON schema for idoc.yaml",
"definitions": {
"idoc": {
"type": "object",
"additionalProperties": false,
"properties": {
"dir": {
"type": "string",
"description": "directory of document source files. defalut: `docs`"
},
"output": {
"type": "string",
"description": "output directory of generated documents. defalut: `dist`"
},
"site": {
"type": "string",
"description": "Website name"
},
"homepage": {
"type": "string",
"description": "Mainly used to generate [sitemap.txt] files"
},
"tocs": {
"type": "boolean",
"description": "page table of contents hidden"
},
"cacheFileStat": {
"type": "boolean",
"description": "cache md file stat"
},
"minify": {
"type": "boolean",
"description": "Compressed HTML"
},
"scope": {
"description": "chapters scopes",
"type": "array",
"items": {
"type": "string"
}
},
"copyAssets": {
"description": "copy assets",
"type": "array",
"items": {
"type": "string"
}
},
"scopePrivate": {
"description": "chapters scopes",
"type": "array",
"items": {
"type": "string"
}
},
"sideEffectFiles": {
"description": "Add Markdown files that are not in the specified directory.",
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string",
"description": "Content displayed at browser tabs, Default Markdown document first heading <h1>"
},
"description": {
"type": "string",
"description": "A brief overview of the web page, the first text of the current Markdown page is obtained by default"
},
"logo": {
"type": "string",
"description": "Website logo icon"
},
"favicon": {
"type": "string",
"description": "Website favicon icon"
},
"keywords": {
"type": "string",
"description": "The keywords of your website. Supports multiple values"
},
"theme": {
"type": "string",
"description": "Customize theme settings. defalut: `default`"
},
"openSource": {
"type": "string",
"format": "uri",
"description": "Show open source button",
"qt-uri-protocols": [
"https"
]
},
"editButton": {
"$ref": "#/definitions/EditButton",
"description": "Display the edit button."
},
"menus": {
"description": "Navigation Menu.",
"type": [
"string",
"object"
],
"properties": {
"url": {
"type": "string"
},
"active": {
"type": "boolean"
},
"target": {
"type": "string",
"pattern": "(__blank|_parent|_top|_self)",
"enum": [
"__blank",
"_parent",
"_top",
"_self"
]
}
}
},
"footer": {
"type": "string",
"description": "The footer content is displayed."
},
"data": {
"$ref": "#/definitions/Data",
"description": "Template Data"
}
}
},
"Data": {
"type": "object",
"additionalProperties": true,
"title": "Template Data"
},
"EditButton": {
"type": "object",
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri",
"qt-uri-protocols": [
"https"
]
}
},
"required": [
"label",
"url"
],
"title": "Display the edit button"
}
}
}