forked from Supernova-Studio/exporter-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
exporter.json
1589 lines (1589 loc) · 59.9 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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"id": "io.supernova.documentation-ubisoft",
"name": "Ubisoft Documentation",
"description": "Customized documentation exporter for Ubisoft Design Systems",
"author": "Ubisoft",
"organization": "Ubisoft",
"source_dir": "src",
"assets_dir": "assets",
"version": "0.0.3",
"usesBrands": false,
"config": {
"sources": "sources.json",
"output": "output.json",
"js": "src/js_helpers.js"
},
"engines": {
"pulsar": "1.0.0",
"supernova": "1.0.0"
},
"routing": "2",
"type": "documentation",
"tags": ["Documentation", "Template", "Docs", "Reference site", "Styleguide"],
"contributes": {
"configuration": [
{
"key": "headerLogo",
"type": "image",
"label": "Site logo",
"description": "A company logo that will be displayed on all pages on your documentation site. We recommend using a 200 x 30px .svg or .png file. ",
"category": "Look & feel"
},
{
"key": "headerLogoHeight",
"type": "number",
"label": "Site logo height",
"description": "The height of your site logo in the top navigation bar, measured in pixels.",
"category": "Look & feel",
"default": 28
},
{
"key": "favicon",
"type": "image",
"label": "Site favicon",
"description": "The favicon that will be used for your documentation site. We recommend using a 32 x 32px .png file. Using legacy .ico is not recommended.",
"category": "Look & feel"
},
{
"key": "lookAndFeelAccentColor",
"type": "color",
"label": "Accent color",
"description": "This is your main accent color, used for all links, selected states, and active items. Default color: #0f62fe.",
"category": "Look & feel"
},
{
"key": "lookAndFeelAccentAlternativeColor",
"type": "color",
"label": "Alternative accent color",
"description": "Used in hover states for links, selected items, and active states. Usually darker or lighter than the main accent color. Default color: #0043ce.",
"category": "Look & feel"
},
{
"key": "lookAndFeelAccentInkColor",
"type": "color",
"label": "On accent color",
"description": "Used as a foreground color on an accent surface. Default color: #ffffff.",
"category": "Look & feel"
},
{
"key": "lookAndFeelAccentSurfaceColor",
"type": "color",
"label": "Surface accent color",
"description": "Used for backgrounds of active and selected items. This color should meet AA+ contract criteria against the main accent color. Default color: #ecf4ff.",
"category": "Look & feel"
},
{
"key": "lookAndFeelInkPrimaryColor",
"type": "color",
"label": "Main text",
"description": "Used for the color of the main text. Default color: #141618.",
"category": "Look & feel"
},
{
"key": "lookAndFeelInkSecondaryColor",
"type": "color",
"label": "Secondary text",
"description": "Used for the color of the secondary text. Default color: #515964.",
"category": "Look & feel"
},
{
"key": "lookAndFeelInkTertiaryColor",
"type": "color",
"label": "Tertiary text",
"description": "Used for the color of the tertiary text (eyebrow headings). Default color: #6a707a.",
"category": "Look & feel"
},
{
"key": "lookAndFeelInkInvertedColor",
"type": "color",
"label": "Inverted text",
"description": "Used for the color of the inverted text, e.g. for use on dark bg. Default color: #ffffff.",
"category": "Look & feel"
},
{
"key": "iconStrokeWidth",
"type": "number",
"label": "Icon stroke width",
"description": "The stroke width for all icons, measured in pixels. Default width: 2px.",
"category": "Look & feel",
"default": 2
},
{
"key": "customFontFamily",
"type": "string",
"description": "Font used in published documentation. If you use a custom font family (e.g. from Google Fonts), you might need to embed it below.",
"label": "Font family",
"category": "Look & feel",
"default": "Inter, Arial, sans-serif"
},
{
"key": "advancedCustomizationCustomFonts",
"type": "string",
"label": "Custom font embed",
"description": "Fonts that will be added to your site <head> (e.g. for typography token previews). You can load multiple fonts if needed.",
"category": "Look & feel",
"default": "<link href=\"https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700;800&display=swap\" rel=\"stylesheet\">",
"isMultiline": true,
"inputType": "code"
},
{
"key": "themeConfiguration",
"type": "string",
"label": "Theme overrides",
"description": "Overrides of CSS custom properties (variables) for the theme. You can use this to change the look and feel of the published documentation.",
"category": "Look & feel",
"default": ":root {\r\n \r\n}",
"isMultiline": true,
"inputType": "code"
},
{
"key": "customCSS",
"type": "string",
"label": "Custom CSS",
"description": "Need even more customization? You can add custom CSS, which will override everything before it. Please note, there is some risk that the CSS classes and DOM structure may change in the future.",
"category": "Look & feel",
"default": "body,\r\nhtml {\r\n\r\n}",
"isMultiline": true,
"inputType": "code"
},
{
"key": "limitSiteMaxWidth",
"type": "boolean",
"label": "Limit maximum site width",
"description": "On big screens, the side navigation will be aligned to the left of the content.",
"category": "Layout",
"default": false
},
{
"key": "siteMaxWidth",
"type": "number",
"label": "Maximum site width",
"description": "The maximum site width, measured in pixels. This applies if you have chosen to limit the maximum site width. Minimum width: 1400px.",
"category": "Layout",
"default": 1400
},
{
"key": "limitContentMaxWidth",
"type": "boolean",
"label": "Limit maximum content container width",
"description": "Content will take the whole width if unchecked",
"category": "Layout",
"default": true
},
{
"key": "contentContainerWidth",
"type": "number",
"label": "Content maximum container width",
"description": "The maximum width of the content container, measured in pixels. Default (and minimum) width: 756px.",
"category": "Layout",
"default": 756
},
{
"key": "topNavigationStyle",
"type": "enum",
"label": "Color style",
"description": "The overall color style used for the top navigation throughout your published documentation.",
"category": "Top navigation",
"values": ["Light", "Dark"],
"default": "Dark"
},
{
"key": "topNavigationBackground",
"type": "color",
"label": "Background color",
"description": "Used for the background of the top navigation bar. Should be complementary to your selected color style.",
"category": "Top navigation"
},
{
"key": "topNavigationHeight",
"type": "number",
"label": "Height",
"description": "Used to set the height of your top navigation bar, measured in pixels. Minimum height: 44px.",
"category": "Top navigation",
"default": 68
},
{
"key": "searchButtonType",
"type": "enum",
"label": "Search button type",
"description": "The type of the search button in top navigation.",
"category": "Top navigation",
"values": ["Only icon", "Icon + label"],
"default": "Only icon"
},
{
"key": "advancedCustomizationShowVersionDropdown",
"type": "boolean",
"label": "Show version dropdown",
"description": "When enabled, the version dropdown will be shown in your documentation, allowing visitors to select which version they'd like to see.",
"category": "Top navigation",
"default": false
},
{
"key": "advancedCustomizationShowCTA",
"type": "boolean",
"label": "Show CTA in site header",
"description": "When enabled, a CTA button will be added to the top navigation bar in your documentation. You can then add the link and CTA text of your choice.",
"category": "Top navigation",
"default": false
},
{
"key": "advancedCustomizationCTAText",
"type": "string",
"label": "Site CTA: Label",
"description": "The text for the CTA button in your top navigation bar.",
"category": "Top navigation",
"default": "Open site",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "advancedCustomizationCTAUrl",
"type": "string",
"label": "Site CTA: Link",
"description": "The URL you want the CTA button in your top navigation bar to link to.",
"category": "Top navigation",
"default": "",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "advancedCustomizationOpenInNewTab",
"type": "boolean",
"label": "Site CTA: Open in new tab",
"description": "When enabled, the link will open in a new tab once the user clicks on the CTA button.",
"category": "Top navigation",
"default": true
},
{
"key": "topNavHideCompletely",
"type": "boolean",
"label": "Hide top navigation",
"description": "When enabled, the top navigation bar will be completely hidden, and only the side navigation will be shown, with logo and search icon at the top of it.",
"category": "Top navigation",
"default": false
},
{
"key": "topNavigationShowQuickLinks",
"type": "boolean",
"label": "Show Quick Links in site header",
"description": "When enabled, a list of quick links will be added to the top navigation bar in your documentation.",
"category": "Top navigation",
"default": false
},
{
"key": "topNavigationQuickLinkUrl1",
"type": "string",
"label": "Quick Link 1: Url",
"description": "The url for the Quick Link 1.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkAriaLabel1",
"type": "string",
"label": "Quick Link 1: aria-label",
"description": "The aria-label for the Quick Link 1.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkIcon1",
"type": "image",
"label": "Quick Link 1: icon",
"description": "The icon for the Quick Link 1.",
"category": "Top navigation"
},
{
"key": "topNavigationQuickLinkUrl2",
"type": "string",
"label": "Quick Link 2: Url",
"description": "The url for the Quick Link 2.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkAriaLabel2",
"type": "string",
"label": "Quick Link 2: aria-label",
"description": "The aria-label for the Quick Link 2.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkIcon2",
"type": "image",
"label": "Quick Link 2: icon",
"description": "The icon for the Quick Link 2.",
"category": "Top navigation"
},
{
"key": "topNavigationQuickLinkUrl3",
"type": "string",
"label": "Quick Link 3: Url",
"description": "The url for the Quick Link 3.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkAriaLabel3",
"type": "string",
"label": "Quick Link 3: aria-label",
"description": "The aria-label for the Quick Link 3.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkIcon3",
"type": "image",
"label": "Quick Link 3: icon",
"description": "The icon for the Quick Link 3.",
"category": "Top navigation"
},
{
"key": "topNavigationQuickLinkUrl4",
"type": "string",
"label": "Quick Link 4: Url",
"description": "The url for the Quick Link 4",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkAriaLabel4",
"type": "string",
"label": "Quick Link 4: aria-label",
"description": "The aria-label for the Quick Link 4.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkIcon4",
"type": "image",
"label": "Quick Link 4: icon",
"description": "The icon for the Quick Link 4.",
"category": "Top navigation"
},
{
"key": "topNavigationQuickLinkUrl5",
"type": "string",
"label": "Quick Link 5: Url",
"description": "The url for the Quick Link 5.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkAriaLabel5",
"type": "string",
"label": "Quick Link 5: aria-label",
"description": "The aria-label for the Quick Link 5.",
"default": "",
"category": "Top navigation",
"isMultiline": false,
"inputType": "plain"
},
{
"key": "topNavigationQuickLinkIcon5",
"type": "image",
"label": "Quick Link 5: icon",
"description": "The icon for the Quick Link 5.",
"category": "Top navigation"
},
{
"key": "sideNavigationStyle",
"type": "enum",
"label": "Color style",
"description": "The overall color style used for the side navigation throughout your published documentation.",
"category": "Side navigation",
"values": ["Light", "Dark"],
"default": "Light"
},
{
"key": "sideNavigationBackground",
"type": "color",
"label": "Background color",
"description": "Used for the background of the side navigation. Should be complementary to your selected color style.",
"category": "Side navigation"
},
{
"key": "navigationShowSectionLabel",
"type": "boolean",
"label": "Show section label",
"description": "When enabled, a section label will be displayed at the top of the side navigation.",
"category": "Side navigation",
"default": false
},
{
"key": "navigationFirstLevelExpanded",
"type": "boolean",
"label": "Expand the first level of navigation",
"description": "When enabled, all first-level groups will be expanded, and the group label will be styled as an eyebrow heading. This won't be applied to pages with tabs.",
"category": "Side navigation",
"default": false
},
{
"key": "navigationShowTabs",
"type": "boolean",
"label": "Show page tabs in navigation",
"description": "When enabled, page tabs will be displayed in the side navigation.",
"category": "Side navigation",
"default": true
},
{
"key": "showSupernovaBranding",
"type": "boolean",
"label": "Show Supernova branding",
"description": "When enabled, \"Powered by Supernova\" will be displayed at the bottom of the side navigation. Optional, but highly appreciated ♥️",
"category": "Side navigation",
"default": true
},
{
"key": "showHomepageNextPreviousNavigation",
"type": "boolean",
"label": "Show navigation at bottom of page",
"description": "When enabled, navigation will be displayed at the bottom of the homepage allowing visitors to navigate to the next documentation page.",
"category": "Homepage",
"default": true
},
{
"key": "tocShowOnHomepage",
"type": "boolean",
"label": "Show table of contents",
"description": "When enabled, a table of contents will be displayed on the homepage.",
"category": "Homepage",
"default": true
},
{
"key": "navigationOverrideHomepageLabel",
"type": "string",
"label": "Override homepage label in menus",
"description": "E.g. Home. When defined, it'll be used as a menu label for homepage in published documentation. This will allow you to have e.g. 'Welcome to our design system' as your page title for the homepage without displaying it in menus.",
"category": "Homepage",
"default": ""
},
{
"key": "headerLayoutStyleHomepage",
"type": "enum",
"label": "Homepage header style",
"description": "The visual style of the header specific for the homepage. Choose between Default (edge to edge) and Boxed (with space surrounding the header).",
"category": "Homepage",
"values": ["Default", "Boxed"],
"default": "Default"
},
{
"key": "lookAndFeelHeaderLayoutStyle",
"type": "enum",
"label": "Page header style",
"description": "The visual style of the header in your documentation. Choose between Default (edge to edge) and Boxed (with space surrounding the header).",
"category": "Pages",
"values": ["Default", "Boxed"],
"default": "Default"
},
{
"key": "lookAndFeelHeaderBackgroundImage",
"type": "image",
"label": "Default page header image",
"description": "The default background image used in the page header throughout your documentation. You can still choose a different image for individual pages. If none is uploaded, no image will be used.",
"category": "Pages"
},
{
"key": "lookAndFeelHeaderBackgroundColor",
"type": "color",
"label": "Main background color in page header",
"description": "The background color used in the page header throughout your documentation. You can still choose a different color for individual pages.",
"category": "Pages"
},
{
"key": "lookAndFeelPageBackgroundColor",
"type": "color",
"label": "Main background color in page",
"description": "The background color used in the page throughout your documentation.",
"category": "Pages"
},
{
"key": "lookAndFeelHeaderTextColor",
"type": "color",
"label": "Default page title color",
"description": "The page title color throughout your documentation. You can still choose a different page title color for individual pages.",
"category": "Pages"
},
{
"key": "lookAndFeelHeaderHeight",
"type": "number",
"label": "Default page header height",
"description": "The height of the page header throughout your documentation, measured in pixels. You can still choose a different height for individual pages. To enable automatic height adjustment based on the page header content, enter a value of 0px.",
"category": "Pages",
"default": 0
},
{
"key": "tocShow",
"type": "boolean",
"label": "Show table of contents",
"description": "When enabled, a table of contents will be displayed on each page.",
"category": "Pages",
"default": true
},
{
"key": "tocCustomLabel",
"type": "string",
"label": "Custom label for table of contents",
"description": "Customize the label for the table of contents section on each page.",
"category": "Pages",
"default": "On this page"
},
{
"key": "tocHideHeading3",
"type": "boolean",
"label": "Hide Heading 3 from table of contents",
"description": "When enabled, all Heading 3 levels will be hidden in table of contents.",
"category": "Pages",
"default": false
},
{
"key": "blockConfigAssetsItemActions",
"type": "enum",
"label": "Asset block: Asset actions",
"description": "Select which actions should be available for each asset in the list. Visible only in published documentation.",
"category": "Blocks",
"values": ["None", "Open in Figma"],
"default": "None"
},
{
"key": "blockConfigAssetsDefaultBackground",
"type": "enum",
"label": "Asset block: Default background style",
"description": "Choose default background style for all assets. Can be changed per block if needed. Visible only in published documentation.",
"category": "Blocks",
"values": [
"Plain background",
"Subtle checkered background",
"Prominent checkered background"
],
"default": "Plain background"
},
{
"key": "advancedCustomizationShowNextPreviousNavigation",
"type": "boolean",
"label": "Show navigation at bottom of page",
"description": "When enabled, navigation will be displayed at the bottom of each page allowing visitors to navigate to the previous, and next, documentation page.",
"category": "Pages",
"default": true
},
{
"key": "footerShow",
"type": "boolean",
"label": "Show footer",
"description": "A small footer on each page will be displayed.",
"category": "Footer",
"default": true
},
{
"key": "footerShowLastPublished",
"type": "boolean",
"label": "Show last published date",
"description": "When enabled, the date on which the page was last published will be displayed in the footer.",
"category": "Footer",
"default": true
},
{
"key": "advancedCustomizationShowFooter",
"type": "boolean",
"label": "Show custom footer",
"description": "A custom footer will be added on top of the regular footer. Great for additional links, information, etc.",
"category": "Footer",
"default": false
},
{
"key": "advancedCustomizationCustomFooter",
"type": "string",
"label": "Edit custom footer using HTML code",
"description": "If a custom footer is enabled, you can edit the custom footer by changing its HTML representation. Any HTML will work.",
"category": "Footer",
"isMultiline": true,
"inputType": "code",
"default": "<div class=\"container-footer\">\r\n <div class=\"slider\">\r\n <div class=\"row\">\r\n <div class=\"col-sm-5 mb-3\">\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</div>\r\n <div class=\"col-sm-3 offset-sm-1 mb-3\">\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-sm-3 mb-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": "seoEnableIndexing",
"type": "boolean",
"label": "Allow search engine indexing",
"description": "If enabled, your documentation site will be indexable by search engines. Note that only public documentation sites can be indexed.",
"category": "Search engines",
"default": true
},
{
"key": "seoEnableLinkFollowing",
"type": "boolean",
"label": "Allow search engines to follow links",
"description": "If enabled, search engine robots will 'follow' the links on your indexed documentation pages.",
"category": "Search engines",
"default": true
},
{
"key": "seoGenerateSitemap",
"type": "boolean",
"label": "Generate sitemap.xml",
"description": "If enabled, your documentation sitemap will be automatically regenerated every time you publish.",
"category": "Search engines",
"default": true
},
{
"key": "seoSiteImage",
"type": "image",
"label": "Site thumbnail image",
"description": "The site thumbnail will use this image. If no image is uploaded, the thumbnail will be empty.",
"category": "Search engines"
},
{
"key": "seoTitlePrefix",
"type": "string",
"label": "Site title prefix",
"description": "If provided, page title will be prepended with this text.",
"category": "Search engines",
"default": ""
},
{
"key": "seoTitleSuffix",
"type": "string",
"label": "Site title suffix",
"description": "When provided, page title will be appended with this text.",
"category": "Search engines",
"default": " | Made with Supernova"
},
{
"key": "seoTitleOverride",
"type": "string",
"label": "Site title override",
"description": "This string of text will completely override the site title on all documentation pages.",
"category": "Search engines",
"default": ""
},
{
"key": "seoDescriptionPrefix",
"type": "string",
"label": "Site description prefix",
"description": "When provided, page description will be prepended with this string.",
"category": "Search engines",
"default": ""
},
{
"key": "seoDescriptionSuffix",
"type": "string",
"label": "Site description suffix",
"description": "When provided, page description will be appended with this string.",
"category": "Search engines",
"default": " | Design system documentation, made with ❤️ using Supernova"
},
{
"key": "seoDescriptionOverride",
"type": "string",
"label": "Site description",
"description": "This string of text will be used as the main page description for all documentation pages. If empty, the page description will be dynamically generated from the page subheader (if any) or its content.",
"category": "Search engines",
"default": ""
},
{
"key": "googleAnalyticsAPIKey",
"default": "",
"type": "string",
"label": "Google Analytics Measurement ID",
"description": "Add Google Analytics tracking to your documentation site by providing a Measurement ID. You must set it up as Google Analytics 4 (recommended).",
"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": "hotjarSiteId",
"default": "",
"type": "string",
"label": "Hotjar site ID",
"description": "Add Hotjar to your documentation site by providing a Site ID.",
"category": "Analytics"
},
{
"key": "enableCookiesBanner",
"type": "boolean",
"label": "Show cookies banner",
"description": "If enabled, a cookies banner will be displayed on your documentation site. This banner will give users option to allow tracking cookies.",
"category": "Analytics",
"default": false
},
{
"key": "cookiesBannerTitle",
"type": "string",
"label": "Cookies banner: Title",
"description": "Override the title in your cookies banner. Emojis supported.",
"category": "Analytics",
"default": "🍪 Cookie settings"
},
{
"key": "cookiesBannerDescription",
"type": "string",
"label": "Cookies banner: Description",
"description": "Override the description in your cookies banner. Basic HTML tags (eg. links) are supported.",
"category": "Analytics",
"isMultiline": true,
"default": "We use cookies to personalize content and analyze traffic to our documentation."
},
{
"key": "codeEditableReactWidgets",
"type": "boolean",
"label": "Editable React widgets",
"description": "When a React code block is used, viewers of the documentation can edit the code to see the components change in real-time.",
"category": "Code snippets",
"default": true
},
{
"key": "codeOpenInCodesandbox",
"type": "boolean",
"label": "Open in Codesandbox.io",
"description": "When a React code block is used, viewers of the documentation can open its code and play around with it in codesandbox.io.",
"category": "Code snippets",
"default": true
},
{
"key": "contentIncludeLottiePlayer",
"type": "boolean",
"label": "Enable Lottie player",
"description": "The Lottie Player will be enabled in your documentation, and allow Lottie videos to play. Please note: this will add around 250 Kb to the initial page load of your documentation.",
"category": "Other",
"default": false
},
{
"key": "contentMarkdownToken",
"type": "string",
"label": "Private Markdown token",
"description": "If provided, your markdown will be authenticated using this token. The token can contain its type , format: ['basic' | 'Bearer' | 'token'] [token]. If no type of format is provided, 'token' is assumed.",
"category": "Other",
"default": ""
},
{
"key": "advancedCustomizationCustomHeadInject",
"type": "string",
"label": "Custom <head> code",
"description": "Any custom <head> code you want to inject into the head. You can add new meta tags, CSS or JS using this method. Please note, this is at your own risk!",
"category": "Other",
"default": "<script>\r\n \r\n</script>",
"isMultiline": true,
"inputType": "code"
},
{
"key": "advancedCustomizationCustomCSS",
"type": "string",
"label": "Custom CSS (deprecated, do not use)",
"description": "Deprecated custom CSS. The content of this field will not applied to published documentation site.",
"category": "Other",
"default": "body,\r\nhtml {\r\n\r\n}",
"isMultiline": true,
"inputType": "code"
}
],
"blocks": [
{
"key": "io.supernova.documentation-main.markdown",
"category": "Remote Data Blocks",
"title": "Markdown",
"description": "Embed and process markdown from remote URL",
"icon": "icons/custom-block-markdown.png",
"mode": "block",
"properties": [
{
"key": "markdownUrl",
"default": "",
"type": "string",
"label": "Markdown URL"
}
]
},
{
"key": "io.supernova.documentation-main.component-health",
"category": "Components",
"title": "Component Health",
"description": "Show component health and additional attributes",
"icon": "icons/custom-block-health.png",
"mode": "block",
"properties": [
{
"key": "componentId",
"type": "component",
"label": "Component"
},
{
"key": "propertiesToHighlight",
"type": "componentProperties",
"label": "Properties"
}
]
},
{
"key": "io.supernova.documentation-main.release-notes",
"category": "Versioning",
"title": "Release Notes",
"description": "Show formatted release notes from all previously released versions",
"icon": "icons/custom-block-release-notes.png",
"mode": "block",
"properties": []
},
{
"key": "io.supernova.documentation-main.component-checklist",
"category": "Components",
"title": "Component Checklist",
"description": "Highlight specific properties of your components",
"icon": "icons/custom-block-checklist.png",
"mode": "block",
"properties": [
{
"key": "componentId",
"type": "component",
"label": "Component"
},
{
"key": "propertiesToHighlight",
"type": "componentProperties",
"label": "Properties"
},
{
"key": "showPropertyDescription",
"type": "boolean",
"default": true,
"label": "Show descriptions"
},
{
"key": "header",
"type": "string",
"default": "",
"label": "Title"
}
]
},
{
"key": "io.supernova.documentation-main.lottie-preview",
"category": "Media Blocks",
"title": "Lottie Preview",
"description": "Preview Lottie animation",
"icon": "icons/custom-block-lottie-preview.png",
"mode": "block",
"properties": [
{
"key": "jsonURL",
"default": "",
"type": "string",
"label": "JSON URL"
},
{
"key": "width",
"type": "number",
"default": 480,
"label": "Width (px)"
},
{
"key": "height",
"type": "number",
"default": 270,
"label": "Height (px)"
},
{
"key": "autoplay",
"default": true,
"type": "boolean",
"label": "Autoplay"
},
{
"key": "playerControls",
"default": false,
"type": "boolean",
"label": "Controls"
}
]
},
{
"key": "io.supernova.documentation-main.component-checklist-all",
"category": "Components",
"title": "Component Overview Table",
"description": "Show the overview of all of your components",
"icon": "icons/custom-block-checklist-all.png",
"mode": "block",
"properties": [
{
"key": "propertiesToHighlight",
"type": "componentProperties",
"label": "Properties"
},
{
"key": "showLastUpdatedColumn",
"type": "boolean",
"default": true,
"label": "Date of update"
}
]
},
{
"key": "io.ubisoft.documentation-main.ux-guidebook",
"category": "Media Blocks",
"title": "UX Guidebook",
"description": "Embed a UX Guidebook page",
"icon": "icons/custom-block-checklist-all.png",
"mode": "block",
"properties": [
{
"key": "url",
"default": "",
"type": "string",
"label": "UX Guidebook URL"
},
{
"key": "height",
"default": 700,
"type": "number",
"label": "Custom height (in pixel)"
},
{
"key": "caption",
"default": "",
"type": "string",
"label": "Caption"
}
]
},
{
"key": "io.ubisoft.documentation-main.key-shortcut",
"category": "Text Blocks",
"title": "Key shortcut",
"description": "Display a key shortcut",
"icon": "icons/custom-block-checklist-all.png",
"mode": "block",
"properties": [
{
"key": "key",
"default": "",
"type": "string",
"label": "The key shortcut"
},
{
"key": "description",
"default": "",
"type": "string",
"label": "Description"
}
]
}
],
"blockVariants": {
"Tabs": [
{
"name": "Tabs",
"key": "tabs",
"isDefault": true,
"description": "Tabs displayed at the top of the container.",