forked from vs-krasnov/exporter-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
exporter.json
288 lines (288 loc) · 13.3 KB
/
exporter.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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
{
"id": "io.supernova.documentation-main",
"name": "Documentation",
"description": "Base Documentation Exporter",
"author": "Jiri Trecak",
"organization": "Supernova",
"source_dir": "src",
"assets_dir": "assets",
"version": "1.28",
"usesBrands": false,
"config": {
"sources": "sources.json",
"output": "output.json"
},
"engines": {
"pulsar": "1.0.0",
"supernova": "1.0.0"
},
"type": "documentation",
"tags": [
"Documentation"
],
"contributes": {
"configuration": [{
"key": "googleAnalyticsAPIKey",
"default": "",
"type": "string",
"label": "Google Analytics API key",
"description": "Add Google Analytics tracking to your documentation site by providing an API key",
"category": "Analytics"
},
{
"key": "intercomAPIKey",
"default": "",
"type": "string",
"label": "Intercom API key",
"description": "Add Intercom to your documentation site by providing an API key",
"category": "Analytics"
},
{
"key": "headerLogo",
"type": "image",
"label": "Top Menu Logo",
"description": "Company logo to be shown on all pages inside the documentation site. 200x30px .svg or .png is recommended",
"category": "Look & Feel"
},
{
"key": "favicon",
"type": "image",
"label": "Site Favicon",
"description": "Documentation site favicon. 32x32px .png is recommended, using legacy .ico is discouraged",
"category": "Look & Feel"
},
{
"key": "lookAndFeelHeaderBackgroundImage",
"type": "image",
"label": "Page Header Background Image",
"description": "If provided, the header background image for each page will use this image. You can still change the setting per-page",
"category": "Look & Feel"
},
{
"key": "lookAndFeelHeaderBackgroundColor",
"type": "color",
"label": "Page Header Background Color",
"description": "If provided, the header background color for each page will use this color. You can still change the setting per-page",
"category": "Look & Feel"
},
{
"key": "lookAndFeelHeaderTextColor",
"type": "color",
"label": "Page Header Text Color",
"description": "If provided, the header text color for each page will use this color. You can still change the setting per-page",
"category": "Look & Feel"
},
{
"key": "lookAndFeelHeaderHeight",
"type": "number",
"label": "Page Header Height (px)",
"description": "If provided, the header for each page will be this tall (px). You can still change the setting per-page. Use 0 to disable",
"category": "Look & Feel",
"default": 0
},
{
"key": "seoEnableIndexing",
"type": "boolean",
"label": "Enable Search Engine Indexing",
"description": "When enabled, documentation site will be indexed by search engines. Note that only public documentation sites can be indexed",
"category": "Search Engines",
"default": true
},
{
"key": "seoEnableLinkFollowing",
"type": "boolean",
"label": "Enable Search Engine Link Follow",
"description": "When enabled, search robots will follow the links on the indexed pages",
"category": "Search Engines",
"default": true
},
{
"key": "seoGenerateSitemap",
"type": "boolean",
"label": "Generate Sitemap",
"description": "When enabled, documentation sitemap will be re-generated on every publish",
"category": "Search Engines",
"default": true
},
{
"key": "seoTitlePrefix",
"type": "string",
"label": "Site Title Prefix",
"description": "When provided, page title will be prefixed with this string",
"category": "Search Engines",
"default": ""
},
{
"key": "seoTitleSuffix",
"type": "string",
"label": "Site Title Suffix",
"description": "When provided, page title will be suffixed with this string",
"category": "Search Engines",
"default": " | Made with Supernova"
},
{
"key": "seoTitleOverride",
"type": "string",
"label": "Site Title Override",
"description": "When provided, title will be completely overriden by this string for all site pages. Prefix is ignored in this case",
"category": "Search Engines",
"default": ""
},
{
"key": "seoDescriptionPrefix",
"type": "string",
"label": "Site Description Prefix",
"description": "When provided, page description will be prefixed with this string",
"category": "Search Engines",
"default": ""
},
{
"key": "seoDescriptionSuffix",
"type": "string",
"label": "Site Description Suffix",
"description": "When provided, page description will be suffixed with this string",
"category": "Search Engines",
"default": " | Design system documentation, made with ❤️ using Supernova"
},
{
"key": "seoDescriptionOverride",
"type": "string",
"label": "Site Description Override",
"description": "When provided, page description will use this string. Otherwise, page description is generated dynamically from page subheading (if any) or its content.",
"category": "Search Engines",
"default": ""
},
{
"key": "seoSiteImage",
"type": "image",
"label": "Site Image Override",
"description": "When provided, page description will use this string. Otherwise, page description is generated dynamically from page subheading (if any) or its content.",
"category": "Search Engines"
},
{
"key": "advancedCustomizationShowNextPreviousNavigation",
"type": "boolean",
"label": "Show Next / Previous navigation",
"description": "When enabled, will show bottom page navigation with quick links to next and previous pages",
"category": "Advanced",
"default": true
},
{
"key": "advancedCustomizationShowFooter",
"type": "boolean",
"label": "Show Footer",
"description": "Any custom javascript to change the documentation behavior. Custom JS will be injected last after DOM is loaded.",
"category": "Advanced",
"default": true
},
{
"key": "advancedCustomizationCustomFooter",
"type": "string",
"label": "Custom Footer Code",
"description": "When footer is shown, the footer can be fully customized by changing its HTML representation. Add links, lines or even images, any html will work.",
"category": "Advanced",
"isMultiline": true,
"inputType": "code",
"default": "<div class=\"container-footer\"\">\r\n <div class=\"slider\">\r\n <div class=\"row\">\r\n <div class=\"col-5\">\r\n <h5>My Doc Site<\/h5>\r\n <p class=\"d-block mb-3\">This footer can be completely changed through Supernova customization options. Head to site advanced customization to learn more!<\/p>\r\n <p class=\"d-block mb-3 text-muted\">© 2022 My Amazing Company<\/p>\r\n <\/div>\r\n <div class=\"col-3 offset-1\">\r\n <h5>Resources<\/h5>\r\n <ul class=\"list-unstyled\">\r\n <li><a href=\"#\">Changelog<\/a><\/li>\r\n <li><a href=\"#\">Storybook<\/a><\/li>\r\n <li><a href=\"#\">Figma<\/a><\/li>\r\n <\/ul>\r\n <\/div>\r\n <div class=\"col-3\">\r\n <h5>Support<\/h5>\r\n <ul class=\"list-unstyled\">\r\n <li><a href=\"#\">Report issue<\/a><\/li>\r\n <li><a href=\"#\">Terms & Conditions<\/a><\/li>\r\n <li><a href=\"#\">Privacy Policy<\/a><\/li>\r\n <\/ul>\r\n <\/div>\r\n <\/div>\r\n <\/div>\r\n<\/div>"
},
{
"key": "advancedCustomizationCustomCSS",
"type": "string",
"label": "Custom CSS",
"description": "Any custom styles to change the documentation look & feel. Custom CSS is injected last, overriding everything before it.",
"category": "Advanced",
"default": "body,\r\nhtml {\r\n font-family: Inter, sans-serif;\r\n}",
"isMultiline": true,
"inputType": "code"
},
{
"key": "advancedCustomizationCustomFonts",
"type": "string",
"label": "Custom Font - Header",
"description": "Fonts you want loaded into your site. You can load multiple fonts at the same time. Icon fonts are also supported.",
"category": "Advanced",
"default": "<link href=\"https:\/\/fonts.googleapis.com\/css2?family=Inter:wght@400;500;700&display=swap\" rel=\"stylesheet\">",
"isMultiline": true,
"inputType": "code"
},
{
"key": "advancedCustomizationShowCTA",
"type": "boolean",
"label": "Show Site CTA",
"description": "When enabled, documentation will add CTA button into the top bar. CTA can lead to any link you provide.",
"category": "Advanced",
"default": false
},
{
"key": "advancedCustomizationCTAText",
"type": "string",
"label": "Site CTA - Text",
"description": "Text of the CTA button.",
"category": "Advanced",
"default": "Open site",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "advancedCustomizationCTAUrl",
"type": "string",
"label": "Site CTA - URL to open",
"description": "Link which will open when CTA button is clicked by the user.",
"category": "Advanced",
"default": "",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "advancedCustomizationOpenInNewTab",
"type": "boolean",
"label": "Site CTA - Open in new tab",
"description": "When enabled, CTA url you provided will open in a new tab.",
"category": "Advanced",
"default": true
},
{
"key": "codeEditableReactWidgets",
"type": "boolean",
"label": "Editable React Widgets",
"description": "When React code widget is used, users can edit the code to see the components change in real-time.",
"category": "Code",
"default": true
},
{
"key": "codeOpenInCodesandbox",
"type": "boolean",
"label": "Open in Codesandbox.io",
"description": "When React code widget is used, users can open its code and play around with it in Codesandbox.io.",
"category": "Code",
"default": true
}
],
"blocks": [{
"key": "io.supernova.documentation-main.markdown",
"category": "Remote Data Blocks",
"title": "Markdown",
"description": "Embed and process markdown from remote URL",
"icon": "icons/markdown.png",
"mode": "block",
"properties": [{
"key": "markdownUrl",
"default": "",
"type": "string",
"label": "Markdown URL"
}]
}],
"blockVariants": {
"Tabs": [{
"name": "Tabs",
"key": "tabs",
"isDefault": true
},
{
"name": "Pills",
"key": "pills"
}
]
}
}
}