-
-
Notifications
You must be signed in to change notification settings - Fork 27
/
schema.json
192 lines (192 loc) · 7.87 KB
/
schema.json
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "RSS and JSON feeds (i.e. a channel of items) using git log and page metadata.",
"description": "Support multiple instances in a single Mkdocs website.",
"oneOf": [
{
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/",
"enum": [
"rss"
]
},
{
"type": "object",
"properties": {
"rss": {
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/",
"type": "object",
"properties": {
"abstract_chars_count": {
"title": "Number of characters to use as item description if it's not present within the page metadata. If this value is set to -1, then the articles' full HTML content will be filled into the description element.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#abstract_chars_count-item-description-length",
"type": "integer",
"default": 160,
"minimum": -1
},
"abstract_delimiter": {
"title": "String to mark where the description ends. Also called excerpt.",
"default": "<!-- more -->",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#abstract_delimiter",
"type": "string"
},
"categories": {
"title": "List of page metadata keys to use as item categories.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#categories",
"type": "array",
"default": null,
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"comments_path": {
"title": "Part of URL to the items' comment div.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#comments_path",
"type": "string",
"default": null,
"format": "uri-reference"
},
"date_from_meta": {
"title": "Use date from page metadata instead of git log.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#date_from_meta-override-dates-from-git-log-with-pagemeta",
"type": "object",
"default": null,
"properties": {
"as_creation": {
"type": [
"boolean",
"string"
]
},
"as_update": {
"type": [
"string"
]
},
"datetime_format": {
"type": [
"null",
"string"
]
},
"default_timezone": {
"type": [
"null",
"string"
],
"default": "UTC"
},
"default_time": {
"examples": [
"08:15",
"16:47",
"22:22"
],
"description": "Default time in 24h-clock syntax (i.e. 16:30) to apply to pages with date but time specified.",
"type": [
"null",
"string"
],
"default": null
}
}
},
"enabled": {
"title": "Enable/Disable plugin",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#enabled-enablingdisabling-the-plugin",
"type": "boolean",
"default": true
},
"feed_ttl": {
"title": "Number of pages to include as feed items (entries).",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feed_ttl-feeds-cache-time",
"type": "integer",
"default": 1440
},
"feeds_filenames": {
"title": "Customize output RSS and JSON feeds names.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feeds_filenames",
"type": "object",
"properties": {
"json_created": {
"default": "feed_json_created.json",
"type": "string"
},
"json_updated": {
"default": "feed_json_updated.json",
"type": "string"
},
"rss_created": {
"default": "feed_rss_created.xml",
"type": "string"
},
"rss_updated": {
"default": "feed_rss_updated.xml",
"type": "string"
}
}
},
"image": {
"title": "Feed channel illustration",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#image-set-the-channel-image",
"type": "string",
"default": null
},
"json_feed_enabled": {
"title": "Enable/Disable export to JSON Feed.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#json_feed_enabled-enablingdisabling-export-to-json-feed",
"type": "boolean",
"default": true
},
"length": {
"title": "Number of pages to include as feed items (entries).",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#length-number-of-items-to-include-in-feed",
"type": "integer",
"default": 20
},
"match_path": {
"title": "Regex match pattern to filter pages.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#match_path-filter-pages-to-include-in-feed",
"type": "string",
"default": ".*"
},
"pretty_print": {
"title": "Minify/Prettify output",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#pretty_print-prettified-xml",
"type": "boolean",
"default": false
},
"rss_feed_enabled": {
"title": "Enable/Disable export to RSS.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#enabled-enablingdisabling-the-plugin",
"type": "boolean",
"default": true
},
"url_parameters": {
"title": "URL parameters to include in the item URL.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#url_parameters-additional-url-parameters",
"type": "object",
"default": null
},
"use_git": {
"title": "Enable/Disable git use.",
"description": "Disable it if you want to use only page.meta values.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#use_git-enabledisable-git-log",
"type": "boolean",
"default": true
},
"use_material_social_cards": {
"title": "Enable/Disable integration with Social Cards plugin from Material theme.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}