-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstackbit.yaml
1689 lines (1689 loc) · 46.2 KB
/
stackbit.yaml
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
stackbitVersion: ~0.3.0
ssgName: nextjs
ssgVersion: 9.4.4
buildCommand: npm run build
publishDir: out
staticDir: public
uploadDir: images
dataDir: content/data
pagesDir: content/pages
pageLayoutKey: layout
logicFields:
- blog_feed_section.recent_count
- blog_feed_section.background_image_opacity
- features_section.background_image_opacity
- hero_section.background_image_opacity
- grid_section.background_image_opacity
- cta_section.background_image_opacity
- form_section.background_image_opacity
models:
config:
type: data
label: Site configuration
fields:
- type: string
name: title
label: Title
description: Site title
required: true
- type: string
name: path_prefix
label: Base URL
description: >-
The base URL of this site. Useful for sites hosted under specific
path, e.g.: https://www.example.com/my-site/
required: true
hidden: true
- type: string
name: domain
label: Domain
description: >-
The domain of your site, including the protocol, e.g.
https://mysite.com/
- type: image
name: favicon
label: Favicon
description: A square icon that represents your website
- type: enum
name: layout_type
label: Layout
options:
- full-width
- boxed
default: full-width
description: The layout of the site
required: true
- type: enum
name: style
label: Style
options:
- minimal
- classic
- bold
default: classic
description: The style of the site
required: true
- type: enum
name: palette
label: Palette
options:
- blue
- green
- red
- gray
default: blue
description: The palette of the site
required: true
- type: enum
name: mode
label: Mode
options:
- light
- dark
default: dark
description: The color scheme of the site
required: true
- type: enum
name: base_font
label: Font
options:
- sans-serif
- serif
default: sans-serif
required: true
- type: model
name: header
label: Header configuration
models:
- header
- type: model
name: footer
label: Footer configuration
models:
- footer
file: config.json
header:
type: object
label: Header configuration
labelField: title
fields:
- type: string
name: title
label: Header title
description: The title displayed in the header if logo image not specified
- type: image
name: logo
label: Logo
description: The logo image displayed on the left side
- type: string
name: logo_alt
label: Logo alt text
description: The alt text of the logo image
- type: boolean
name: has_primary_nav
label: Enable primary navigation menu
description: >-
Display the navigation menu on the left side, next to the site
title/logo
default: true
- type: list
name: primary_nav_links
label: Primary navigation menu links
description: List of navigation links
items:
type: model
models:
- action
- type: boolean
name: has_secondary_nav
label: Enable secondary navigation menu
description: Display the navigation menu on the right side
default: true
- type: list
name: secondary_nav_links
label: Secondary navigation menu links
description: List of navigation links
items:
type: model
models:
- action
- type: boolean
name: has_anncmnt
label: Enable announcement
description: Display the announcement above the site header
default: false
- type: markdown
name: anncmnt_content
label: Announcement content
description: The text content of the announcement
- type: enum
name: anncmnt_align
label: Announcement horizontal alignment
options:
- left
- right
- center
default: left
description: The horizontal alignment of the announcement content
- type: boolean
name: anncmnt_is_home_only
label: Show on home page
description: Display the announcement on the home page only.
default: false
- type: boolean
name: anncmnt_has_close
label: Enable announcement close
description: Display the announcement close button
default: false
- type: string
name: anncmnt_id
label: Announcement ID
description: >-
A unique identifier, required if close button is enabled. Must be
updated each time the announcement content changes
footer:
type: object
label: Footer configuration
labelField: content
fields:
- type: image
name: logo
label: Logo
description: The logo image displayed on the left side
- type: string
name: logo_alt
label: Logo alt text
description: The alt text of the logo image
- type: boolean
name: has_primary_nav
label: Enable primary navigation menu
description: Display the primary navigation menu
default: true
- type: string
name: primary_nav_title
label: Primary navigation title
description: The title of the primary navigation menu
- type: list
name: primary_nav_links
label: Primary navigation menu links
description: List of primary navigation links
items:
type: model
models:
- action
- type: boolean
name: has_secondary_nav
label: Enable secondary navigation menu
description: Display the secondary navigation menu
default: true
- type: string
name: secondary_nav_title
label: Secondary navigation title
description: The title of the secondary navigation menu
- type: list
name: secondary_nav_links
label: Secondary navigation menu links
description: List of secondary navigation links
items:
type: model
models:
- action
- type: boolean
name: has_tertiary_nav
label: Enable tertiary navigation menu
description: Display the tertiary navigation menu
default: true
- type: string
name: tertiary_nav_title
label: Tertiary navigation title
description: The title of the tertiary navigation menu
- type: list
name: tertiary_nav_links
label: Tertiary navigation menu links
description: List of tertiary navigation links
items:
type: model
models:
- action
- type: boolean
name: has_social
label: Enable social links
description: Display the social links
default: true
- type: list
name: social_links
label: Social links
description: List of social links
items:
type: model
models:
- action
- type: string
name: content
label: Footer content
description: The copyright text
- type: list
name: links
label: Links
description: A list of links displayed next to the copyright text
items:
type: model
models:
- action
person:
type: data
label: Person
folder: team
fields:
- type: string
name: id
label: ID
description: 'A unique identifier used when filtering posts, e.g. "john-doe"'
required: true
- type: string
name: link
label: Link
description: 'The link to the author page, e.g. "blog/author/john-doe"'
- type: string
name: first_name
label: First name
required: true
- type: string
name: last_name
label: Last name
- type: image
name: photo
label: Image
- type: string
name: photo_alt
label: Image alt text
category:
type: data
label: Category
folder: categories
fields:
- type: string
name: id
label: ID
description: 'A unique identifier used when filtering posts, e.g. "news"'
required: true
- type: string
name: link
label: Link
description: 'The link to the category page, e.g. "blog/category/news"'
- type: string
name: title
label: Title
required: true
description: The title of the category
tag:
type: data
label: Tag
folder: tags
fields:
- type: string
name: id
label: ID
description: 'A unique identifier used when filtering posts, e.g. "jamstack"'
required: true
- type: string
name: link
label: Link
description: 'The link to the tag page, e.g. "blog/tag/jamstack"'
- type: string
name: title
label: Title
required: true
description: The title of the tag
page:
type: page
label: Page
layout: page
exclude: blog/**/*
fields:
- type: string
name: title
label: Title
description: The title of the page
required: true
- type: model
name: seo
models:
- stackbit_page_meta
post:
type: page
urlPath: '/blog/{slug}'
label: Post
layout: post
folder: blog
exclude:
- index.md
- category/**
- author/**
- tag/**
fields:
- type: string
name: title
label: Title
description: The title of the post
required: true
- type: string
name: subtitle
label: Subtitle
description: The subtitle of the post
- type: date
name: date
label: Date
description: The publish date of the post
required: true
- type: reference
name: author
label: Author
description: The author of the post
models:
- person
- type: list
name: categories
label: Categories
description: The categories of the post
items:
type: reference
models:
- category
- type: list
name: tags
label: Tags
description: The tags of the post
items:
type: reference
models:
- tag
- type: string
name: excerpt
label: Excerpt
description: The excerpt of the post displayed in the blog feed
- type: image
name: thumb_image
label: Image (blog feed)
description: The image displayed in the blog feed
- type: string
name: thumb_image_alt
label: Image alt text (blog feed)
description: The alt text of the blog feed image
- type: image
name: image
label: Image (single post)
description: The image displayed in the single post
- type: string
name: image_alt
label: Image alt text (single post)
description: The alt text of the single post image
- type: enum
name: image_position
label: Image position (single post)
options:
- left
- right
- top
default: top
description: >-
The featured image position in the blog post relative to the post
header content
- type: model
name: seo
models:
- stackbit_page_meta
advanced:
type: page
label: Advanced page
layout: advanced
hideContent: true
fields:
- type: string
name: title
label: Title
description: The title of the page
required: true
- type: list
name: sections
label: Sections
description: Page sections
items:
type: model
models:
- hero_section
- features_section
- grid_section
- blog_feed_section
- cta_section
- form_section
- type: model
name: seo
models:
- stackbit_page_meta
hero_section:
type: object
label: Hero section
labelField: title
fields:
- type: string
name: title
label: Title
description: The title of the section
- type: string
name: subtitle
label: Subtitle
description: The subtitle of the section displayed below the title
- type: markdown
name: content
label: Content
description: The text content of the section
- type: list
name: actions
label: Action buttons
items:
type: model
models:
- action
- type: image
name: image
label: Image
description: The image of the section
- type: string
name: image_alt
label: Image alt text
description: The alt text of the section image
- type: text
name: video_embed_html
label: Video Embed Code
description: The HTML embed code for your video
- type: enum
name: media_position
label: Image or video position
options:
- left
- right
- top
- bottom
default: top
description: The position of the image or video relative to the text content
- type: enum
name: media_width
label: Image or video width
options:
- fourty
- fifty
- sixty
default: fifty
description: >-
The image or video container width as a percentage of the section
width. Used only when the image or video position is set to "left" or
"right"
- type: enum
name: align
label: Section alignment
options:
- left
- right
- center
default: left
description: The horizontal alignment of the section content
- type: enum
name: padding_top
label: Section top padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the top of the section
- type: enum
name: padding_bottom
label: Section bottom padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the bottom of the section
- type: boolean
name: has_border
label: Section border
default: false
description: Add section bottom border
- type: enum
name: background_color
label: Background color
options:
- none
- primary
- secondary
default: none
description: The background color of the section
- type: image
name: background_image
label: Background image
description: The image displayed in the background of the section
- type: number
name: background_image_opacity
label: Background image opacity
description: >-
An integer between 0 and 100. A lower value makes the image more
transparent
- type: enum
name: background_image_size
label: Background image size
options:
- auto
- contain
- cover
default: cover
description: The size of the background image
- type: enum
name: background_image_position
label: Background image position
options:
- left top
- left center
- left bottom
- center top
- center center
- center bottom
- right top
- right center
- right bottom
default: center center
description: >-
The starting position of a background image. The first value is the
horizontal position, and the second value is the vertical
- type: enum
name: background_image_repeat
label: Background image repeat
options:
- repeat
- no-repeat
default: no-repeat
description: Repeat the image to cover the whole area
features_section:
type: object
label: Features section
labelField: title
fields:
- type: string
name: title
label: Title
description: The title of the section
- type: string
name: subtitle
label: Subtitle
description: The subtitle of the section displayed above the title
- type: list
name: features
label: Features
items:
type: model
models:
- feature
- type: enum
name: feature_padding_vert
label: Feature padding vertical
options:
- small
- medium
- large
default: medium
description: The vertical spacing between section features
- type: enum
name: align
label: Section alignment
options:
- left
- right
- center
default: center
description: 'The horizontal alignment of the section content (title, subtitle)'
- type: enum
name: padding_top
label: Section top padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the top of the section
- type: enum
name: padding_bottom
label: Section bottom padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the bottom of the section
- type: boolean
name: has_border
label: Section border
default: false
description: Add section bottom border
- type: enum
name: background_color
label: Background color
options:
- none
- primary
- secondary
default: none
description: The background color of the section
- type: image
name: background_image
label: Background image
description: The image displayed in the background of the section
- type: number
name: background_image_opacity
label: Background image opacity
description: >-
An integer between 0 and 100. A lower value makes the image more
transparent
- type: enum
name: background_image_size
label: Background image size
options:
- auto
- contain
- cover
default: cover
description: The size of the background image
- type: enum
name: background_image_position
label: Background image position
options:
- left top
- left center
- left bottom
- center top
- center center
- center bottom
- right top
- right center
- right bottom
default: center center
description: >-
The starting position of a background image. The first value is the
horizontal position, and the second value is the vertical
- type: enum
name: background_image_repeat
label: Background image repeat
options:
- repeat
- no-repeat
default: no-repeat
description: Repeat the image to cover the whole area
grid_section:
type: object
label: Grid section
labelField: title
fields:
- type: string
name: title
label: Title
description: The title of the section
- type: string
name: subtitle
label: Subtitle
description: The subtitle of the section displayed above the title
- type: list
name: actions
label: Action buttons
items:
type: model
models:
- action
description: Action buttons displayed below section items
- type: list
name: grid_items
label: Grid items
items:
type: model
models:
- grid_item
- type: enum
name: grid_cols
label: Grid columns
options:
- two
- three
- four
default: three
description: Show the specified number of items in a grid row
- type: enum
name: grid_gap_vert
label: Grid gap vertical
options:
- small
- medium
- large
default: small
description: The vertical spacing between grid items
- type: enum
name: grid_gap_horiz
label: Grid gap horizontal
options:
- small
- medium
- large
default: small
description: The horizontal spacing between grid items
- type: boolean
name: enable_cards
label: Enable cards
description: >-
Display items as cards, i.e. add border, background and some padding
around the item content
default: false
- type: enum
name: align
label: Section alignment
options:
- left
- right
- center
default: center
description: >-
The horizontal alignment of the section content (title, subtitle,
action buttons)
- type: enum
name: padding_top
label: Section top padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the top of the section
- type: enum
name: padding_bottom
label: Section bottom padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the bottom of the section
- type: boolean
name: has_border
label: Section border
default: false
description: Add section bottom border
- type: enum
name: background_color
label: Background color
options:
- none
- primary
- secondary
default: none
description: The background color of the section
- type: image
name: background_image
label: Background image
description: The image displayed in the background of the section
- type: number
name: background_image_opacity
label: Background image opacity
description: >-
An integer between 0 and 100. A lower value makes the image more
transparent
- type: enum
name: background_image_size
label: Background image size
options:
- auto
- contain
- cover
default: cover
description: The size of the background image
- type: enum
name: background_image_position
label: Background image position
options:
- left top
- left center
- left bottom
- center top
- center center
- center bottom
- right top
- right center
- right bottom
default: center center
description: >-
The starting position of a background image. The first value is the
horizontal position, and the second value is the vertical
- type: enum
name: background_image_repeat
label: Background image repeat
options:
- repeat
- no-repeat
default: no-repeat
description: Repeat the image to cover the whole area
blog_feed_section:
type: object
label: Blog feed section
labelField: title
fields:
- type: string
name: title
label: Title
description: The title of the section
- type: string
name: subtitle
label: Subtitle
description: The subtitle of the section displayed above the title
- type: list
name: actions
label: Action buttons
items:
type: model
models:
- action
description: Action buttons displayed below blog posts
- type: enum
name: blog_feed_cols
label: Blog feed columns
options:
- two
- three
default: three
description: Show the specified number of posts in a blog feed grid row
- type: boolean
name: enable_cards
label: Enable cards
description: >-
Display posts as cards, i.e. add border, background and some padding
around post content
default: false
- type: boolean
name: show_recent
label: Show recent posts only
description: >-
Show the specified number of recent posts. Should not be used with
author, category and tag filters
default: false
required: true
- type: number
name: recent_count
label: Number of recent posts to show
- type: reference
name: author
label: Author filter
description: Filter posts by an author
models:
- person
- type: reference
name: category
label: Category filter
description: Filter posts by a category
models:
- category
- type: reference
name: tag
label: Tag filter
description: Filter posts by a tag
models:
- tag
- type: boolean
name: show_date
label: Show date
description: Show the publish date of the post
default: true
- type: boolean
name: show_categories
label: Show categories
description: Show the categories of the post
default: false
- type: boolean
name: show_author
label: Show author
description: Show the author of the post
default: false
- type: boolean
name: show_excerpt
label: Show excerpt
description: Show the excerpt of the post
default: false
- type: boolean
name: show_image
label: Show image
description: Show the post image thumbnail
default: true
- type: enum
name: align
label: Section alignment
options:
- left
- right
- center
default: center
description: >-
The horizontal alignment of the section content (title, subtitle,
action buttons)
- type: enum
name: padding_top
label: Section top padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the top of the section
- type: enum
name: padding_bottom
label: Section bottom padding
options:
- none
- small
- medium
- large
default: medium
description: The padding area (space) on the bottom of the section
- type: boolean
name: has_border
label: Section border
default: false