-
Notifications
You must be signed in to change notification settings - Fork 2
/
cloudcannon.config.yml
1213 lines (1178 loc) · 28.1 KB
/
cloudcannon.config.yml
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
# Read the CloudCannon documentation for more information on how to use this file:
# https://cloudcannon.com/documentation/articles/setting-global-configuration/?ssg=Eleventy
# Collections are related sets of content files, typically grouped by folder.
# Here you can define your collections, as well as any
# CloudCannon configuration specific to those collections.
collections_config:
pages:
output: true
parse_branch_index: true
disable_add_folder: true
path: pages
icon: feed
schemas:
default:
path: src/schemas/page.md
add_options:
- name: Add Site Page
editor: content
schema: default
_enabled_editors:
- content
- visual
filter:
base: strict
Navigation:
output: true
path: _data
disable_add: true
disable_add_folder: true
icon: table_rows
filter:
base: none
include:
- nav.yml
- footer.yml
Theme_Palette:
output: true
path: _data
disable_add: true
disable_add_folder: true
icon: color_lens
filter:
base: none
include:
- theme.yml
banner:
output: true
path: _data
disable_add: true
disable_add_folder: true
icon: add_alert
filter:
base: none
include:
- banner.yml
preview:
gallery:
icon: add_alert
metadata:
- icon: date_range
text:
- key: show_until
- icon: add_alert
text:
- key: enable_banner
docs:
path: docs
base_url: /docs
icon: file
disable_add_folder: true
schemas:
default:
path: src/schemas/docs.md
add_options:
- name: Read the docs
icon: local_library
href: https://docs.cloudcannon.com
- name: Add Document
editor: content
schema: default
_enabled_editors:
- content
- visual
parse_branch_index: true
preview:
metadata:
- icon: folder
text:
- key: nav_section
- icon: format_list_numbered
text:
- key: weight
output: true
Meta_Data:
output: false
path: _data
icon: settings
disable_add: true
disable_add_folder: true
filter:
exclude:
- theme.yml
- nav.yml
- footer.yml
- banner.yml
# Control which collections are displayed in the CloudCannon site navigation,
# and how those collections are grouped.
collection_groups:
- heading: Base Pages
collections:
- pages
- heading: Docs
collections:
- docs
- heading: Site Settings
collections:
- Meta_Data
- Theme_Palette
- Navigation
- banner
# Structures
_structures:
product_logo_structure:
values:
- label: Image
icon: add_photo_alternate
description: Add as image
value:
logo_image:
logo_image_dark:
- label: Text
icon: border_color
description: Add as text
value:
logo_heading:
footer_link_structure:
values:
- label: Add Image Link
icon: add_photo_alternate
value:
url_path:
image_path:
image_alt_text:
- label: Add Text Link
icon: add_link
value:
url_path:
link_title:
nav_link_structure:
values:
- label: Link with Icon
icon: add_photo_alternate
value:
link_title:
link_url:
link_label:
link_icon_path:
- label: Text Link
icon: add_link
value:
link_label:
link_url:
preview:
text: Site Link
icon: add_link
_inputs:
trim_left:
hidden: true
trim_right:
hidden: true
permalink:
hidden: true
layout:
hidden: true
eleventyNavigation:
label: Navigation
comment: Options for displaying the page in the sidebar navigation
eleventyNavigation.key:
label: Sidebar Nav Title
comment: The name of the page shown in the sidebar navigation
eleventyNavigation.order:
comment: The order of the page in the sidebar group
tags:
comment: The name of the section the page is nested under in the sidebar navigation (use 'page' for Root pages)
title:
type: text
label: Page Title
nav_title:
type: text
label: Sidebar Nav Title
comment: The name of the page shown in the sidebar navigation
nav_section:
type: text
label: Parent Section
comment: The name of the section the page is nested under in the sidebar navigation
weight:
type: number
comment: The order of the page in the sidebar group
project_name:
type: text
default_og_image:
type: image
comment: The default image for social media sharing
logo:
type: object
label: Site Logo
comment: Choose between image or text based logos
options:
structures: _structures.product_logo_structure
footer_links:
type: array
comment: choose between image or text based links
options:
structures: _structures.footer_link_structure
footer_width:
type: select
options:
values:
- contain
- full
logo_image:
type: image
comment: Default Display
logo_image_dark:
type: image
comment: Displays when dark mode is enabled
logo_text:
type: text
side_nav_title:
type: text
label: Sidebar Nav Title
favicon:
type: object
nav_links:
type: array
label: Navigation Links
options:
structures: _structures.nav_link_structure
link_title:
type: text
comment: Name used for alt text
link_url:
type: url
comment: 'if external link, include https://'
link_label:
type: text
comment: Text displayed on the link
link_icon_path:
type: image
comment: '*prefers svgs for dark mode'
url_path:
type: text
comment: 'if external link, include https://'
light:
type: object
label: Light theme color palette
dark:
type: object
label: Dark theme color palette
typography:
type: object
label: Text
comment: Text color palette
button_colors:
type: object
label: Buttons
comment: Button color palette
background_colors:
type: object
label: BG
comment: Background color palette
code_block_colors:
type: object
label: Code Blocks
comment: Code block color palette
border_colors:
type: object
label: Borders
comment: Border color palette
focus_colors:
type: object
label: Focus
comment: Focus color palette
shortcode_colors:
type: object
label: Shortcode
comment: Shortcode color palette
scrollbar_colors:
type: object
label: Scrollbars
comment: Scrollbar color palette
pagefind_colors:
type: object
label: Pagefind
comment: Pagefind color palette
text:
type: color
label: Primary text
comment: Main text color
flip-text:
type: color
comment: Text color for dark backgrounds
highlight:
type: color
label: Highlighted text
comment: Text color for highlighted text.
body-bg-color:
type: color
comment: Main body background color.
code-element:
type: color
label: HTML element tags
comment: Next color for codeblock html element tags.
code-attribute:
type: color
label: HTML attributes
comment: Text color for codeblock html attributes.
code-bool:
type: color
label: Boolean values
comment: Text color for codeblock boolean values.
code-params:
type: color
label: Function/HTML parameters
comment: Text color for codeblock function/html parameters.
code-values:
type: color
label: Key values
comment: Text color for codeblock key values.
background-body:
type: color
comment: Main body background color.
background:
type: color
comment: Background color for main content area.
background-alt:
type: color
comment: Background color for alternate content area.
selection:
type: color
comment: Selected text background color.
text-main:
type: color
comment: Main text color.
text-bright:
type: color
comment: Text color for bright text.
text-muted:
type: color
comment: Text color for muted text.
links:
type: color
comment: Text color for links.
focus:
type: color
comment: Focus color for links.
border:
type: color
comment: Border color for elements.
code:
type: color
label: Codeblock text color
comment: Text color for codeblock text.
button-base:
type: color
comment: Background color for buttons.
button-hover:
type: color
comment: Background color for buttons on hover.
scrollbar-thumb:
type: color
comment: Scrollbar thumb color.
scrollbar-thumb-hover:
type: color
comment: Scrollbar thumb color on hover.
form-placeholder:
type: color
comment: Placeholder text color for form inputs.
form-text:
type: color
comment: Text color for form inputs.
variable:
type: color
comment: Text color for codeblock variable names.
diffcode-highlighted:
type: color
options:
format: hex
alpha: true
comment: Background color for highlighted lines in diffcode shortcode.
diffcode-added:
type: color
options:
format: hex
alpha: true
comment: Background color for added lines in diffcode shortcode.
diffcode-removed:
type: color
options:
format: hex
alpha: true
comment: Background color for removed lines in diffcode shortcode.
pagefind-ui-primary:
type: color
comment: Primary color for pagefind ui.
pagefind-ui-secondary:
type: color
comment: Secondary color for pagefind ui.
pagefind-ui-background:
type: color
comment: Background color for pagefind ui.
pagefind-ui-border:
type: color
comment: Border color for pagefind ui.
pagefind-ui-tag:
type: color
comment: Tag color for pagefind ui.
small_icon:
type: image
comment: Dimensions - 16px x 16px
large_icon:
type: image
comment: Dimensions - 32px x 32px
apple_touch_icon:
type: image
comment: Dimensions - 57px x 57px
shortcut_icon:
type: image
comment: Bookmark icon
# Snippets
_snippets_imports:
eleventy_liquid: true
_snippets:
highlight:
snippet: "{% capture content %}\n```[[lang]][[inner]]```\n{% endcapture %}{% diffcode content %}"
params:
lang:
parser: argument
options:
editor_key: language
forbidden_tokens: ["```"]
style:
output: inline
model:
editor_key: language
optional: true
inner:
parser: content
options:
editor_key: inner_code
style:
output: block
block:
leading: "\n"
trailing: "\n"
indent: ""
inline: false
preview:
text: Highlight
subtext:
- key: language
- Code block with syntax highlighting.
icon: code
picker_preview:
text: Highlight
subtext: Code block with syntax highlighting.
icon: code
_inputs:
inner_code:
type: code
label: Content
language:
type: select
options:
values: _select_data.languages
value_key: key
preview:
text:
- key: display_name
summary_divider:
snippet: "{% summary_divider %}"
inline: true
preview:
text: Summary Divider
icon: summarize
picker_preview:
text: Summary Divider
subtext: Marker to show which content to include in the article summary.
icon: summarize
param:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: param
positional_args:
- editor_key: param_name
type: string
inline: true
preview:
text: Param
icon: data_object
picker_preview:
text: Param
subtext: Front matter parameter.
icon: data_object
_inputs:
param_name:
type: text
label: Param
comment: The frontmatter parameter to display.
gist:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: gist
positional_args:
- editor_key: username
type: string
- editor_key: id
type: string
- editor_key: file
type: string
optional: true
inline: false
preview:
text: Gist
subtext:
- key: username
- GitHub Gist embed.
icon: integration_instructions
picker_preview:
text: Gist
subtext: GitHub Gist embed.
icon: integration_instructions
_inputs:
username:
type: text
comment: Name of the user that owns the Gist.
id:
label: ID
type: text
comment: ID of the Gist to embed.
file:
type: text
comment: Name of the file to embed, if the Gist contains multiple.
figure:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: figure
positional_args:
- editor_key: src
type: string
- editor_key: pageTitle
type: string
optional: true
- editor_key: alt
type: string
optional: true
- editor_key: caption
type: string
optional: true
- editor_key: link_url
type: string
optional: true
- editor_key: link_target
type: string
optional: true
- editor_key: link_rel
type: string
optional: true
- editor_key: attr
type: string
optional: true
- editor_key: attrlink
type: string
optional: true
- editor_key: className
type: string
optional: true
- editor_key: width
type: string
optional: true
- editor_key: height
type: string
optional: true
inline: false
preview:
text: Figure
subtext: Full-width image with an optional caption below.
icon: image
image:
- key: src
- No preview available
picker_preview:
text: Figure
subtext: Full-width image with an optional caption below.
icon: image
_inputs:
src:
type: image
comment: The image to display.
pageTitle:
type: text
comment: Image title.
alt:
type: text
comment: Alternate text if the image cannot be displayed.
caption:
type: text
comment: Image caption.
link_url:
type: url
label: Link
comment: URL for the image to link to.
link_target:
type: text
label: Target
comment: Target attribute for the image link.
hidden: "!link_url"
link_rel:
type: text
label: Rel
comment: Rel attribute for the image link.
hidden: "!link_url"
attr:
type: text
comment: Image attribution text.
attrlink:
type: url
comment: URL for the attribution to link to.
className:
type: text
label: Class
comment: Class attribute of the HTML figure tag.
width:
type: text
comment: Width attribute of the image.
height:
type: text
comment: Height attribute of the image.
twitter:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: twitter
positional_args:
- editor_key: user_id
type: string
- editor_key: twitter_id
type: string
inline: false
preview:
text: Tweet
subtext:
- key: user_id
- Twitter tweet embed.
icon: message
picker_preview:
text: Tweet
subtext: Twitter tweet embed.
icon: message
_inputs:
user_id:
type: text
label: User
comment: Name of the user that made the tweet.
twitter_id:
type: text
label: ID
comment: ID of the tweet to embed.
vimeo:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: vimeo
positional_args:
- editor_key: vimeo_id
type: string
- editor_key: class_name
type: string
optional: true
- editor_key: page_title
type: string
optional: true
inline: false
preview:
text:
- key: page_title
- Vimeo
subtext:
- key: vimeo_id
- Vimeo video embed.
icon: videocam
picker_preview:
text: Vimeo
subtext: Vimeo video embed.
icon: videocam
_inputs:
vimeo_id:
type: text
label: ID
comment: ID of the Vimeo video to embed.
class_name:
type: text
label: Class
comment: HTML class of the embedded video.
page_title:
type: text
comment: Title of the video embed for accessibility.
youtube:
template: eleventy_liquid_shortcode_positional_args
definitions:
shortcode_name: youtube
positional_args:
- editor_key: youtube_id
type: string
- editor_key: autoplay
type: string
optional: true
- editor_key: page_title
type: string
optional: true
- editor_key: class_name
type: string
optional: true
inline: false
preview:
text:
- key: page_title
- YouTube
subtext:
- key: youtube_id
- YouTube video embed.
icon: smart_display
picker_preview:
text: YouTube
subtext: YouTube video embed.
icon: smart_display
_inputs:
youtube_id:
type: text
label: ID
comment: ID of the YouTube video to embed.
autoplay:
comment: Automatically start video playback.
type: select
options:
values:
- "true"
page_title:
type: text
comment: Title of the video embed for accessibility.
class_name:
type: text
label: Class
comment: HTML class of the embedded video.
diffcode:
template: eleventy_liquid_include
definitions:
include_name: shortcodes/diffcode.html
named_args:
- editor_key: lang
type: string
- editor_key: inner
parser: content
options:
style:
output: block
block:
leading: "\n"
trailing: "\n"
indent: ""
inline: false
preview:
text: Diffcode
subtext: Difference formatter
icon: difference
picker_preview:
text: Diffcode
subtext: Difference formatter
icon: difference
_inputs:
lang:
type: select
options:
values: _select_data.languages
value_key: key
preview:
text:
- key: display_name
inner:
type: code
label: Inner Code
tree:
snippet: "{% capture treecontent %}[[inner]]{% endcapture %}{% tree treecontent %}"
params:
inner:
parser: content
options:
editor_key: inner_code
style:
output: block
block:
leading: "\n"
trailing: "\n"
indent: ""
inline: false
definitions:
shortcode_name: tree
content_key: inner_code
preview:
text: Tree
subtext: Tree directory formatter
icon: account_tree
picker_preview:
text: Tree
subtext: Tree directory formatter
icon: account_tree
_inputs:
inner_code:
type: code
_select_data:
languages:
- key: 1c
display_name: 1C
- key: abnf
display_name: ABNF
- key: accesslog
display_name: Access logs
- key: ada
display_name: Ada
- key: arduino
display_name: Arduino (C++ w/Arduino libs)
- key: armasm
display_name: ARM assembler
- key: avrasm
display_name: AVR assembler
- key: actionscript
display_name: Actionscript
- key: angelscript
display_name: AngelScript
- key: apache
display_name: Apache
- key: applescript
display_name: AppleScript
- key: arcade
display_name: Arcade
- key: asciidoc
display_name: AsciiDoc
- key: aspectj
display_name: AspectJ
- key: autohotkey
display_name: AutoHotkey
- key: autoit
display_name: AutoIt
- key: awk
display_name: Awk
- key: bash
display_name: Bash
- key: basic
display_name: Basic
- key: bnf
display_name: BNF
- key: brainfuck
display_name: Brainfuck
- key: csharp
display_name: C#
- key: c
display_name: C
- key: cpp
display_name: C++
- key: cal
display_name: C/AL
- key: cos
display_name: Cache Object Script
- key: cmake
display_name: CMake
- key: coq
display_name: Coq
- key: csp
display_name: CSP
- key: css
display_name: CSS
- key: capnproto
display_name: Cap'n Proto
- key: clojure
display_name: Clojure
- key: coffeescript
display_name: CoffeeScript
- key: crmsh
display_name: Crmsh
- key: crystal
display_name: Crystal
- key: d
display_name: D
- key: dart
display_name: Dart
- key: dpr
display_name: Delphi
- key: diff
display_name: Diff
- key: django
display_name: Django
- key: dns
display_name: DNS Zone file
- key: dockerfile
display_name: Dockerfile
- key: dos
display_name: DOS
- key: dsconfig
display_name: dsconfig
- key: dts
display_name: DTS (Device Tree)
- key: dust
display_name: Dust
- key: ebnf
display_name: EBNF
- key: elixir
display_name: Elixir
- key: elm
display_name: Elm
- key: erlang
display_name: Erlang
- key: excel
display_name: Excel
- key: fsharp
display_name: F#
- key: fix
display_name: FIX
- key: fortran
display_name: Fortran
- key: gcode
display_name: G-Code
- key: gams
display_name: Gams
- key: gauss
display_name: GUASS
- key: gherkin
display_name: Gherkin
- key: go
display_name: Go
- key: golo
display_name: Golo
- key: gradle
display_name: Gradle
- key: graphql
display_name: GraphQL
- key: groovy
display_name: Groovy
- key: xml
display_name: HTML, XML
- key: http
display_name: HTTP
- key: haml
display_name: Haml
- key: handlebars
display_name: Handlebars
- key: haskell
display_name: Haskell
- key: haxe
display_name: Haxe
- key: hy
display_name: Hy
- key: ini
display_name: Ini, TOML
- key: inform7
display_name: Inform7
- key: irpf90
display_name: IRPF90
- key: json
display_name: JSON
- key: java
display_name: Java
- key: javascript
display_name: JavaScript
- key: julia