Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
quarto-dev
GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/schema/definitions.yml
12921 views
1
- id: date
2
anyOf:
3
- string
4
- object:
5
properties:
6
value: string
7
format: string
8
required: [value]
9
10
- id: date-format
11
schema: string
12
13
- id: math-methods
14
enum:
15
values: [plain, webtex, gladtex, mathml, mathjax, katex]
16
17
- id: pandoc-format-request-headers
18
arrayOf:
19
arrayOf:
20
schema: string
21
length: 2
22
23
- id: pandoc-format-output-file
24
anyOf:
25
- path
26
- enum:
27
values: [null]
28
hidden: true
29
30
- id: filter-entry-point
31
enum:
32
[
33
pre-ast,
34
post-ast,
35
pre-quarto,
36
post-quarto,
37
pre-render,
38
post-render,
39
pre-finalize,
40
post-finalize,
41
]
42
43
- id: pandoc-format-filters
44
arrayOf:
45
anyOf:
46
- path
47
- object:
48
properties:
49
type: string
50
path: path
51
required: [path]
52
- object:
53
properties:
54
type: string
55
path: path
56
at:
57
ref: filter-entry-point
58
required: [path, at]
59
- record:
60
type:
61
enum: [citeproc]
62
63
- id: pandoc-shortcodes
64
arrayOf: path
65
66
- id: page-column
67
enum:
68
[
69
body,
70
body-outset,
71
body-outset-left,
72
body-outset-right,
73
page,
74
page-left,
75
page-right,
76
page-inset,
77
page-inset-left,
78
page-inset-right,
79
screen,
80
screen-left,
81
screen-right,
82
screen-inset,
83
screen-inset-shaded,
84
screen-inset-left,
85
screen-inset-right,
86
margin,
87
]
88
89
- id: contents-auto
90
object:
91
properties:
92
auto:
93
anyOf:
94
- boolean
95
- maybeArrayOf: string
96
description:
97
short: Automatically generate sidebar contents.
98
long: |
99
Automatically generate sidebar contents. Pass `true` to include all documents
100
in the site, a directory name to include only documents in that directory,
101
or a glob (or list of globs) to include documents based on a pattern.
102
103
Subdirectories will create sections (use an `index.qmd` in the directory to
104
provide its title). Order will be alphabetical unless a numeric `order` field
105
is provided in document metadata.
106
107
- id: navigation-item
108
anyOf:
109
- path
110
- ref: navigation-item-object
111
112
- id: navigation-item-object
113
object:
114
closed: true
115
properties:
116
aria-label:
117
string:
118
description: "Accessible label for the item."
119
file:
120
hidden: true
121
string:
122
description: |
123
Alias for href
124
href:
125
string:
126
description: |
127
Link to file contained with the project or external URL
128
icon:
129
string:
130
description:
131
short: Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)
132
long: |
133
Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)
134
See <https://icons.getbootstrap.com/> for a list of available icons
135
id:
136
# "core identification"
137
# this field is only used in typescript
138
schema: string
139
hidden: true
140
menu:
141
arrayOf:
142
schema:
143
ref: navigation-item
144
text:
145
string:
146
description: |
147
Text to display for item (defaults to the
148
document title if not provided)
149
url:
150
hidden: true
151
string:
152
description: |
153
Alias for href
154
rel:
155
string:
156
description: |
157
Value for rel attribute. Multiple space-separated values are permitted.
158
See <https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel>
159
for a details.
160
target:
161
string:
162
description: |
163
Value for target attribute.
164
See <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target>
165
for details.
166
167
- id: giscus-themes
168
enum:
169
values:
170
[
171
light,
172
light_high_contrast,
173
light_protanopia,
174
light_tritanopia,
175
dark,
176
dark_high_contrast,
177
dark_protanopia,
178
dark_tritanopia,
179
dark_dimmed,
180
transparent_dark,
181
cobalt,
182
purple_dark,
183
noborder_light,
184
noborder_dark,
185
noborder_gray,
186
preferred_color_scheme,
187
]
188
189
- id: giscus-configuration
190
object:
191
closed: true
192
properties:
193
repo:
194
string:
195
description:
196
short: The Github repo that will be used to store comments.
197
long: |
198
The Github repo that will be used to store comments.
199
200
In order to work correctly, the repo must be public, with the giscus app installed, and
201
the discussions feature must be enabled.
202
repo-id:
203
string:
204
description:
205
short: The Github repository identifier.
206
long: |
207
The Github repository identifier.
208
209
You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
210
If this is not provided, Quarto will attempt to discover it at render time.
211
category:
212
string:
213
description:
214
short: The discussion category where new discussions will be created.
215
long: |
216
The discussion category where new discussions will be created. It is recommended
217
to use a category with the **Announcements** type so that new discussions
218
can only be created by maintainers and giscus.
219
category-id:
220
string:
221
description:
222
short: The Github category identifier.
223
long: |
224
The Github category identifier.
225
226
You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
227
If this is not provided, Quarto will attempt to discover it at render time.
228
mapping:
229
schema:
230
anyOf:
231
- string
232
- number
233
completions:
234
- pathname
235
- url
236
- title
237
- og:title
238
description:
239
short: The mapping between the page and the embedded discussion.
240
long: |
241
The mapping between the page and the embedded discussion.
242
243
- `pathname`: The discussion title contains the page path
244
- `url`: The discussion title contains the page url
245
- `title`: The discussion title contains the page title
246
- `og:title`: The discussion title contains the `og:title` metadata value
247
- any other string or number: Any other strings will be passed through verbatim and a discussion title
248
containing that value will be used. Numbers will be treated
249
as a discussion number and automatic discussion creation is not supported.
250
reactions-enabled:
251
boolean:
252
description: Display reactions for the discussion's main post before the comments.
253
loading:
254
enum: [lazy]
255
description: "Specify `loading: lazy` to defer loading comments until the user scrolls near the comments container."
256
input-position:
257
enum: [top, bottom]
258
description: Place the comment input box above or below the comments.
259
theme:
260
anyOf:
261
- string
262
- ref: giscus-themes
263
- object:
264
closed: true
265
properties:
266
light:
267
anyOf:
268
- string
269
- ref: giscus-themes
270
description: The light theme name.
271
dark:
272
anyOf:
273
- string
274
- ref: giscus-themes
275
description: The dark theme name.
276
277
description:
278
short: The giscus theme to use when displaying comments.
279
long: |
280
The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key:
281
282
```yaml
283
website:
284
comments:
285
giscus:
286
theme:
287
light: light # giscus theme used for light website theme
288
dark: dark_dimmed # giscus theme used for dark website theme
289
```
290
language:
291
string:
292
description: The language that should be used when displaying the commenting interface.
293
required: [repo]
294
295
- id: external-engine
296
schema:
297
object:
298
closed: true
299
properties:
300
path:
301
path:
302
description: Path to the TypeScript module for the execution engine
303
required: [path]
304
description: An execution engine not pre-loaded in Quarto
305
306
- id: document-comments-configuration
307
anyOf:
308
- enum: [false]
309
- object:
310
closed: true
311
properties:
312
utterances:
313
object:
314
closed: true
315
properties:
316
repo:
317
string:
318
description: The Github repo that will be used to store comments.
319
label:
320
string:
321
description: The label that will be assigned to issues created by Utterances.
322
theme:
323
string:
324
description:
325
short: The Github theme that should be used for Utterances.
326
long: |
327
The Github theme that should be used for Utterances
328
(`github-light`, `github-dark`, `github-dark-orange`,
329
`icy-dark`, `dark-blue`, `photon-dark`, `body-light`,
330
or `gruvbox-dark`)
331
completions:
332
- github-light
333
- github-dark
334
- github-dark-orange
335
- icy-dark
336
- dark-blue
337
- photon-dark
338
- body-light
339
- gruvbox-dark
340
issue-term:
341
string:
342
description:
343
short: How posts should be mapped to Github issues
344
long: |
345
How posts should be mapped to Github issues
346
(`pathname`, `url`, `title` or `og:title`)
347
completions:
348
- pathname
349
- url
350
- title
351
- og:title
352
required: [repo]
353
giscus:
354
ref: giscus-configuration
355
hypothesis:
356
anyOf:
357
- boolean
358
- object:
359
closed: true
360
properties:
361
client-url:
362
string:
363
description: Override the default hypothesis client url with a custom client url.
364
openSidebar:
365
boolean:
366
default: false
367
description: Controls whether the sidebar opens automatically on startup.
368
showHighlights:
369
anyOf:
370
- boolean
371
- enum: ["always", "whenSidebarOpen", "never"]
372
default: "always"
373
description: Controls whether the in-document highlights are shown by default (`always`, `whenSidebarOpen` or `never`)
374
theme:
375
enum: ["classic", "clean"]
376
default: classic
377
description: Controls the overall look of the sidebar (`classic` or `clean`)
378
enableExperimentalNewNoteButton:
379
boolean:
380
default: false
381
description: |
382
Controls whether the experimental New Note button
383
should be shown in the notes tab in the sidebar.
384
usernameUrl:
385
schema: string
386
description: |
387
Specify a URL to direct a user to,
388
in a new tab. when they click on the annotation author
389
link in the header of an annotation.
390
services:
391
arrayOf:
392
object:
393
properties:
394
apiUrl:
395
string:
396
description: The base URL of the service API.
397
authority:
398
string:
399
description: The domain name which the annotation service is associated with.
400
grantToken:
401
string:
402
description: An OAuth 2 grant token which the client can send to the service in order to get an access token for making authenticated requests to the service.
403
allowLeavingGroups:
404
boolean:
405
default: true
406
description: A flag indicating whether users should be able to leave groups of which they are a member.
407
enableShareLinks:
408
boolean:
409
default: true
410
description: A flag indicating whether annotation cards should show links that take the user to see an annotation in context.
411
groups:
412
anyOf:
413
- enum: ["$rpc:requestGroups"]
414
- arrayOf: string
415
description: An array of Group IDs or the literal string `$rpc:requestGroups`
416
icon:
417
string:
418
description: The URL to an image for the annotation service. This image will appear to the left of the name of the currently selected group.
419
required: [apiUrl, authority, grantToken]
420
description: |
421
Alternative annotation services which the client should
422
connect to instead of connecting to the public Hypothesis
423
service at hypothes.is.
424
branding:
425
object:
426
properties:
427
accentColor:
428
string:
429
description: Secondary color for elements of the commenting UI.
430
appBackgroundColor:
431
string:
432
description: The main background color of the commenting UI.
433
ctaBackgroundColor:
434
string:
435
description: The background color for call to action buttons.
436
selectionFontFamily:
437
string:
438
description: The font family for selection text in the annotation card.
439
annotationFontFamily:
440
string:
441
description: The font family for the actual annotation value that the user writes about the page or selection.
442
description: Settings to adjust the commenting sidebar's look and feel.
443
externalContainerSelector:
444
string:
445
description: A CSS selector specifying the containing element into which the sidebar iframe will be placed.
446
focus:
447
object:
448
properties:
449
user:
450
object:
451
properties:
452
username:
453
string:
454
description: The username of the user to focus on.
455
userid:
456
string:
457
description: The userid of the user to focus on.
458
displayName:
459
string:
460
description: The display name of the user to focus on.
461
required: [user]
462
description: Defines a focused filter set for the available annotations on a page.
463
requestConfigFromFrame:
464
object:
465
properties:
466
origin:
467
string:
468
description: Host url and port number of receiving iframe
469
ancestorLevel:
470
number:
471
description: Number of nested iframes deep the client is relative from the receiving iframe.
472
assetRoot:
473
string:
474
description: The root URL from which assets are loaded.
475
sidebarAppUrl:
476
string:
477
description: The URL for the sidebar application which displays annotations.
478
default: "https://hypothes.is/app.html"
479
480
- id: social-metadata
481
object:
482
closed: true
483
properties:
484
title:
485
string:
486
description:
487
short: "The title of the page"
488
long: |
489
The title of the page. Note that by default Quarto will automatically
490
use the title metadata from the page. Specify this field if you’d like
491
to override the title for this provider.
492
description:
493
string:
494
description:
495
short: "A short description of the content."
496
long: |
497
A short description of the content. Note that by default Quarto will
498
automatically use the description metadata from the page. Specify this
499
field if you’d like to override the description for this provider.
500
image:
501
path:
502
description:
503
short: "The path to a preview image for the content."
504
long: |
505
The path to a preview image for the content. By default, Quarto will use
506
the `image` value from the format metadata. If you provide an
507
image, you may also optionally provide an `image-width` and `image-height`.
508
image-alt:
509
path:
510
description:
511
short: "The alt text for the preview image."
512
long: |
513
The alt text for the preview image. By default, Quarto will use
514
the `image-alt` value from the format metadata. If you provide an
515
image, you may also optionally provide an `image-width` and `image-height`.
516
image-width:
517
number:
518
description: "Image width (pixels)"
519
image-height:
520
number:
521
description: "Image height (pixels)"
522
523
- id: page-footer-region
524
anyOf:
525
- string
526
- arrayOf:
527
ref: navigation-item
528
529
- id: sidebar-contents
530
anyOf:
531
- string
532
- ref: contents-auto
533
- arrayOf:
534
anyOf:
535
- ref: navigation-item
536
- path
537
- object:
538
closed: true
539
properties:
540
section:
541
anyOf:
542
- string
543
- null
544
contents:
545
ref: sidebar-contents
546
- ref: contents-auto
547
548
- id: project-preview
549
object:
550
closed: true
551
properties:
552
port:
553
number:
554
description: Port to listen on (defaults to random value between 3000 and 8000)
555
host:
556
string:
557
description: Hostname to bind to (defaults to 127.0.0.1)
558
serve:
559
description: Use an exernal application to preview the project.
560
schema:
561
ref: project-serve
562
browser:
563
boolean:
564
description: Open a web browser to view the preview (defaults to true)
565
watch-inputs:
566
boolean:
567
description: Re-render input files when they change (defaults to true)
568
navigate:
569
boolean:
570
description: Navigate the browser automatically when outputs are updated (defaults to true)
571
timeout:
572
number:
573
description: Time (in seconds) after which to exit if there are no active clients
574
575
- id: project-serve
576
object:
577
closed: true
578
properties:
579
cmd:
580
string:
581
description: |
582
Serve project preview using the specified command.
583
Interpolate the `--port` into the command using `{port}`.
584
args:
585
string:
586
description: Additional command line arguments for preview command.
587
env:
588
object:
589
description: Environment variables to set for preview command.
590
ready:
591
string:
592
description: Regular expression for detecting when the server is ready.
593
required: [cmd, ready]
594
595
- id: publish
596
description: Sites published from project
597
schema:
598
object:
599
closed: true
600
properties:
601
netlify:
602
arrayOf:
603
ref: publish-record
604
description: "Sites published to Netlify"
605
606
- id: publish-record
607
object:
608
closed: true
609
properties:
610
id:
611
string:
612
description: "Unique identifier for site"
613
url:
614
string:
615
description: "Published URL for site"
616
617
- id: twitter-card-config
618
object:
619
super:
620
resolveRef: social-metadata
621
closed: true
622
properties:
623
card-style:
624
enum: [summary, summary_large_image]
625
description:
626
short: "Card style"
627
long: |
628
Card style (`summary` or `summary_large_image`).
629
630
If this is not provided, the best style will automatically
631
selected based upon other metadata. You can learn more about Twitter Card
632
styles [here](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards).
633
creator:
634
string:
635
description: "`@username` of the content creator (must be a quoted string)"
636
site:
637
string:
638
description: "`@username` of the website (must be a quoted string)"
639
640
- id: open-graph-config
641
object:
642
super:
643
resolveRef: social-metadata
644
closed: true
645
properties:
646
locale:
647
string:
648
description: "Locale of open graph metadata"
649
site-name:
650
string:
651
description:
652
short: "Name that should be displayed for the overall site"
653
long: |
654
Name that should be displayed for the overall site. If not explicitly
655
provided in the `open-graph` metadata, Quarto will use the website or
656
book `title` by default.
657
658
- id: page-footer
659
object:
660
properties:
661
left:
662
ref: page-footer-region
663
description: "Footer left content"
664
right:
665
ref: page-footer-region
666
description: "Footer right content"
667
center:
668
ref: page-footer-region
669
description: "Footer center content"
670
border:
671
anyOf:
672
- boolean
673
- string
674
description: "Footer border (`true`, `false`, or a border color)"
675
background:
676
schema: string
677
description: "Footer background color"
678
foreground:
679
schema: string
680
description: "Footer foreground color"
681
closed: true
682
683
- id: base-website
684
object:
685
closed: true
686
properties:
687
title:
688
string:
689
description: "Website title"
690
description:
691
string:
692
description: "Website description"
693
favicon:
694
string:
695
description: "The path to the favicon for this website"
696
site-url:
697
string:
698
description: "Base URL for published website"
699
site-path:
700
string:
701
description: |
702
Path to site (defaults to `/`). Not required if you specify `site-url`.
703
repo-url:
704
string:
705
description: "Base URL for website source code repository"
706
repo-link-target:
707
string:
708
description: "The value of the target attribute for repo links"
709
repo-link-rel:
710
string:
711
description: "The value of the rel attribute for repo links"
712
repo-subdir:
713
string:
714
description: "Subdirectory of repository containing website"
715
repo-branch:
716
string:
717
description: "Branch of website source code (defaults to `main`)"
718
issue-url:
719
string:
720
description: "URL to use for the 'report an issue' repository action."
721
repo-actions:
722
maybeArrayOf:
723
enum: [none, edit, source, issue]
724
description:
725
short: "Links to source repository actions"
726
long: "Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`)"
727
reader-mode:
728
boolean:
729
description: |
730
Displays a 'reader-mode' tool which allows users to hide the sidebar and table of contents when viewing a page.
731
llms-txt:
732
boolean:
733
description: |
734
Generate llms.txt and .llms.md files for LLM-friendly content consumption.
735
google-analytics:
736
anyOf:
737
- string
738
- object:
739
properties:
740
tracking-id:
741
schema: string
742
description: "The Google tracking Id or measurement Id of this website."
743
storage:
744
enum: [cookies, none]
745
description:
746
short: "Storage options for Google Analytics data"
747
long: |
748
Storage option for Google Analytics data using on of these two values:
749
750
`cookies`: Use cookies to store unique user and session identification (default).
751
752
`none`: Do not use cookies to store unique user and session identification.
753
754
For more about choosing storage options see [Storage](https://quarto.org/docs/websites/website-tools.html#storage).
755
anonymize-ip:
756
schema: boolean
757
description:
758
short: "Anonymize the user ip address."
759
long: |
760
Anonymize the user ip address. For more about this feature, see
761
[IP Anonymization (or IP masking) in Google Analytics](https://support.google.com/analytics/answer/2763052?hl=en).
762
version:
763
enum: [3, 4]
764
description:
765
short: "The version number of Google Analytics to use."
766
long: |
767
The version number of Google Analytics to use.
768
769
- `3`: Use analytics.js
770
- `4`: use gtag.
771
772
This is automatically detected based upon the `tracking-id`, but you may specify it.
773
description: "Enable Google Analytics for this website"
774
plausible-analytics:
775
anyOf:
776
- string
777
- object:
778
closed: true
779
properties:
780
path:
781
path:
782
description: "Path to a file containing the Plausible Analytics script snippet"
783
required: [path]
784
description:
785
short: "Enable Plausible Analytics for this website by providing a script snippet or path to snippet file"
786
long: |
787
Enable Plausible Analytics for this website by pasting the script snippet from your Plausible dashboard,
788
or by providing a path to a file containing the snippet.
789
790
Plausible is a privacy-friendly, GDPR-compliant web analytics service that does not use cookies and does not require cookie consent.
791
792
**Option 1: Inline snippet**
793
794
```yaml
795
website:
796
plausible-analytics: |
797
<script async src="https://plausible.io/js/script.js"></script>
798
```
799
800
**Option 2: File path**
801
802
```yaml
803
website:
804
plausible-analytics:
805
path: _plausible_snippet.html
806
```
807
808
To get your script snippet:
809
810
1. Log into your Plausible account at <https://plausible.io>
811
2. Go to your site settings
812
3. Copy the JavaScript snippet provided
813
4. Either paste it directly in your configuration or save it to a file
814
815
For more information, see <https://plausible.io/docs/plausible-script>
816
announcement:
817
anyOf:
818
- string
819
- object:
820
properties:
821
content:
822
schema: string
823
description: "The content of the announcement"
824
dismissable:
825
schema: boolean
826
description: "Whether this announcement may be dismissed by the user."
827
icon:
828
schema: string
829
description:
830
short: "The icon to display in the announcement"
831
long: |
832
Name of bootstrap icon (e.g. `github`, `twitter`, `share`) for the announcement.
833
See <https://icons.getbootstrap.com/> for a list of available icons
834
position:
835
schema:
836
enum: ["above-navbar", "below-navbar"]
837
description:
838
short: "The position of the announcement."
839
long: |
840
The position of the announcement. One of `above-navbar` (default) or `below-navbar`.
841
type:
842
schema:
843
enum:
844
[
845
primary,
846
secondary,
847
success,
848
danger,
849
warning,
850
info,
851
light,
852
dark,
853
]
854
description:
855
short: "The type of announcement. Affects the appearance of the announcement."
856
long: |
857
The type of announcement. One of `primary`, `secondary`, `success`, `danger`, `warning`,
858
`info`, `light` or `dark`. Affects the appearance of the announcement.
859
860
description: Provides an announcement displayed at the top of the page.
861
cookie-consent:
862
anyOf:
863
- enum: [express, implied]
864
- boolean
865
- object:
866
properties:
867
type:
868
enum: [express, implied]
869
description:
870
short: "The type of consent that should be requested"
871
long: |
872
The type of consent that should be requested, using one of these two values:
873
874
- `express` (default): This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn’t agree).
875
876
- `implied`: This will notify the user that the site uses cookies and permit them to change preferences, but not block cookies unless the user changes their preferences.
877
878
style:
879
enum: [simple, headline, interstitial, standalone]
880
description:
881
short: "The style of the consent banner that is displayed"
882
long: |
883
The style of the consent banner that is displayed:
884
885
- `simple` (default): A simple dialog in the lower right corner of the website.
886
887
- `headline`: A full width banner across the top of the website.
888
889
- `interstitial`: An semi-transparent overlay of the entire website.
890
891
- `standalone`: An opaque overlay of the entire website.
892
palette:
893
enum: [light, dark]
894
description: "Whether to use a dark or light appearance for the consent banner (`light` or `dark`)."
895
policy-url:
896
schema: string
897
description: "The url to the website’s cookie or privacy policy."
898
language:
899
schema: string
900
description:
901
short: "The language to be used when diplaying the cookie consent prompt (defaults to document language)."
902
long: |
903
The language to be used when diplaying the cookie consent prompt specified using an IETF language tag.
904
905
If not specified, the document language will be used.
906
prefs-text:
907
schema: string
908
description:
909
short: "The text to display for the cookie preferences link in the website footer."
910
description:
911
short: "Request cookie consent before enabling scripts that set cookies"
912
long: |
913
Quarto includes the ability to request cookie consent before enabling scripts that set cookies, using [Cookie Consent](https://www.cookieconsent.com/).
914
915
The user’s cookie preferences will automatically control Google Analytics (if enabled) and can be used to control custom scripts you add as well. For more information see [Custom Scripts and Cookie Consent](https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent).
916
search:
917
anyOf:
918
- boolean
919
- object:
920
properties:
921
location:
922
enum: [navbar, sidebar]
923
description: "Location for search widget (`navbar` or `sidebar`)"
924
type:
925
enum: [overlay, textbox]
926
description: "Type of search UI (`overlay` or `textbox`)"
927
limit:
928
schema: number
929
description: "Number of matches to display (defaults to 20)"
930
collapse-after:
931
schema: number
932
description: "Matches after which to collapse additional results"
933
copy-button:
934
schema: boolean
935
description: "Provide button for copying search link"
936
merge-navbar-crumbs:
937
schema: boolean
938
default: true
939
description: "When false, do not merge navbar crumbs into the crumbs in `search.json`."
940
keyboard-shortcut:
941
maybeArrayOf:
942
string:
943
description: "One or more keys that will act as a shortcut to launch search (single characters)"
944
show-item-context:
945
schema:
946
anyOf:
947
- enum: ["tree", "parent", "root"]
948
- boolean
949
description: "Whether to include search result parents when displaying items in search results (when possible)."
950
algolia:
951
object:
952
properties:
953
index-name:
954
schema: string
955
description: "The name of the index to use when performing a search"
956
application-id:
957
schema: string
958
description: "The unique ID used by Algolia to identify your application"
959
search-only-api-key:
960
schema: string
961
description: "The Search-Only API key to use to connect to Algolia"
962
analytics-events:
963
boolean:
964
description: "Enable tracking of Algolia analytics events"
965
show-logo:
966
boolean:
967
description: "Enable the display of the Algolia logo in the search results footer."
968
index-fields:
969
object:
970
properties:
971
href:
972
schema: string
973
description: "Field that contains the URL of index entries"
974
title:
975
schema: string
976
description: "Field that contains the title of index entries"
977
text:
978
schema: string
979
description: "Field that contains the text of index entries"
980
section:
981
schema: string
982
description: "Field that contains the section of index entries"
983
closed: true
984
params:
985
object:
986
description: "Additional parameters to pass when executing a search"
987
closed: true
988
description: "Use external Algolia search index"
989
closed: true
990
description: "Provide full text search for website"
991
992
navbar:
993
anyOf:
994
- boolean
995
- object:
996
properties:
997
title:
998
anyOf:
999
- string
1000
- boolean
1001
description: "The navbar title. Uses the project title if none is specified."
1002
logo:
1003
ref: logo-light-dark-specifier
1004
description: "Specification of image that will be displayed to the left of the title."
1005
logo-alt:
1006
string:
1007
description: "Alternate text for the logo image."
1008
logo-href:
1009
string:
1010
description: "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."
1011
background:
1012
string:
1013
description: "The navbar's background color (named or hex color)."
1014
completions:
1015
- primary
1016
- secondary
1017
- success
1018
- danger
1019
- warning
1020
- info
1021
- light
1022
- dark
1023
foreground:
1024
string:
1025
description: "The navbar's foreground color (named or hex color)."
1026
completions:
1027
- primary
1028
- secondary
1029
- success
1030
- danger
1031
- warning
1032
- info
1033
- light
1034
- dark
1035
search:
1036
boolean:
1037
description: "Include a search box in the navbar."
1038
pinned:
1039
boolean:
1040
description: "Always show the navbar (keeping it pinned)."
1041
default: false
1042
collapse:
1043
boolean:
1044
description: "Collapse the navbar into a menu when the display becomes narrow."
1045
default: true
1046
collapse-below:
1047
enum: [sm, md, lg, xl, xxl]
1048
description: "The responsive breakpoint below which the navbar will collapse into a menu (`sm`, `md`, `lg` (default), `xl`, `xxl`)."
1049
default: "lg"
1050
left:
1051
arrayOf:
1052
ref: navigation-item
1053
description: "List of items for the left side of the navbar."
1054
right:
1055
arrayOf:
1056
ref: navigation-item
1057
description: "List of items for the right side of the navbar."
1058
toggle-position:
1059
schema:
1060
enum: [left, right]
1061
description: "The position of the collapsed navbar toggle when in responsive mode"
1062
default: "left"
1063
tools-collapse:
1064
boolean:
1065
description: "Collapse tools into the navbar menu when the display becomes narrow."
1066
default: false
1067
1068
description: "Top navigation options"
1069
1070
sidebar:
1071
anyOf:
1072
- boolean
1073
- maybeArrayOf:
1074
object:
1075
properties:
1076
id:
1077
string:
1078
description: "The identifier for this sidebar."
1079
title:
1080
anyOf:
1081
- string
1082
- boolean
1083
description: "The sidebar title. Uses the project title if none is specified."
1084
logo:
1085
ref: logo-light-dark-specifier
1086
description: "Specification of image that will be displayed in the sidebar."
1087
logo-alt:
1088
string:
1089
description: "Alternate text for the logo image."
1090
logo-href:
1091
string:
1092
description: "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."
1093
search:
1094
boolean:
1095
description: "Include a search control in the sidebar."
1096
tools:
1097
arrayOf:
1098
ref: navigation-item-object
1099
description: "List of sidebar tools"
1100
contents:
1101
ref: sidebar-contents
1102
description: "List of items for the sidebar"
1103
style:
1104
enum: ["docked", "floating"]
1105
description: "The style of sidebar (`docked` or `floating`)."
1106
default: "floating"
1107
background:
1108
schema: string
1109
completions:
1110
- primary
1111
- secondary
1112
- success
1113
- danger
1114
- warning
1115
- info
1116
- light
1117
- dark
1118
description: "The sidebar's background color (named or hex color)."
1119
foreground:
1120
schema: string
1121
completions:
1122
- primary
1123
- secondary
1124
- success
1125
- danger
1126
- warning
1127
- info
1128
- light
1129
- dark
1130
description: "The sidebar's foreground color (named or hex color)."
1131
border:
1132
boolean:
1133
description: "Whether to show a border on the sidebar (defaults to true for 'docked' sidebars)"
1134
alignment:
1135
enum: ["left", "right", "center"]
1136
description: "Alignment of the items within the sidebar (`left`, `right`, or `center`)"
1137
collapse-level:
1138
number:
1139
description: "The depth at which the sidebar contents should be collapsed by default."
1140
default: 2
1141
pinned:
1142
boolean:
1143
description: "When collapsed, pin the collapsed sidebar to the top of the page."
1144
header:
1145
maybeArrayOf: string
1146
description: "Markdown to place above sidebar content (text or file path)"
1147
footer:
1148
maybeArrayOf: string
1149
description: "Markdown to place below sidebar content (text or file path)"
1150
description: "Side navigation options"
1151
body-header:
1152
string:
1153
description: "Markdown to insert at the beginning of each page’s body (below the title and author block)."
1154
body-footer:
1155
string:
1156
description: "Markdown to insert below each page’s body."
1157
margin-header:
1158
maybeArrayOf: string
1159
description: "Markdown to place above margin content (text or file path)"
1160
margin-footer:
1161
maybeArrayOf: string
1162
description: "Markdown to place below margin content (text or file path)"
1163
page-navigation:
1164
boolean:
1165
description: "Provide next and previous article links in footer"
1166
back-to-top-navigation:
1167
boolean:
1168
description: "Provide a 'back to top' navigation button"
1169
bread-crumbs:
1170
boolean:
1171
description: "Whether to show navigation breadcrumbs for pages more than 1 level deep"
1172
page-footer:
1173
anyOf:
1174
- string
1175
- ref: page-footer
1176
description: "Shared page footer"
1177
image:
1178
path:
1179
description: |
1180
Default site thumbnail image for `twitter` /`open-graph`
1181
image-alt:
1182
path:
1183
description: |
1184
Default site thumbnail image alt text for `twitter` /`open-graph`
1185
comments:
1186
schema:
1187
ref: document-comments-configuration
1188
1189
open-graph:
1190
anyOf:
1191
- boolean
1192
- ref: open-graph-config
1193
description: "Publish open graph metadata"
1194
twitter-card:
1195
anyOf:
1196
- boolean
1197
- ref: twitter-card-config
1198
description: "Publish twitter card metadata"
1199
other-links:
1200
schema:
1201
ref: other-links
1202
tags:
1203
formats: [$html-doc]
1204
description: "A list of other links to appear below the TOC."
1205
code-links:
1206
schema:
1207
anyOf:
1208
- boolean
1209
- ref: code-links-schema
1210
tags:
1211
formats: [$html-doc]
1212
description: "A list of code links to appear with this document."
1213
drafts:
1214
schema:
1215
maybeArrayOf: path
1216
description: "A list of input documents that should be treated as drafts"
1217
draft-mode:
1218
schema:
1219
enum: ["visible", "unlinked", "gone"]
1220
description:
1221
short: "How to handle drafts that are encountered."
1222
long: |
1223
How to handle drafts that are encountered.
1224
1225
`visible` - the draft will visible and fully available
1226
`unlinked` - the draft will be rendered, but will not appear in navigation, search, or listings.
1227
`gone` - the draft will have no content and will not be linked to (default).
1228
1229
- id: book-schema
1230
schema:
1231
object:
1232
closed: true
1233
super:
1234
resolveRef: base-website
1235
properties:
1236
title:
1237
string:
1238
description: "Book title"
1239
subtitle:
1240
string:
1241
description: "Book subtitle"
1242
author:
1243
maybeArrayOf:
1244
anyOf: [string, object]
1245
description: "Author or authors of the book"
1246
date:
1247
string:
1248
description: "Book publication date"
1249
date-format:
1250
string:
1251
description: "Format string for dates in the book"
1252
abstract:
1253
string:
1254
description: "Book abstract"
1255
description:
1256
string:
1257
description: "Description metadata for HTML version of book"
1258
chapters:
1259
schema:
1260
ref: chapter-list
1261
description: "Book part and chapter files"
1262
hidden: true
1263
appendices:
1264
schema:
1265
ref: chapter-list
1266
description: "Book appendix files"
1267
hidden: true
1268
references:
1269
path:
1270
description: "Book references file"
1271
output-file:
1272
path:
1273
description: "Base name for single-file output (e.g. PDF, ePub, docx)"
1274
cover-image:
1275
path:
1276
description: "Cover image (used in HTML and ePub formats)"
1277
cover-image-alt:
1278
string:
1279
description: "Alternative text for cover image (used in HTML format)"
1280
sharing:
1281
maybeArrayOf:
1282
enum: [twitter, facebook, linkedin]
1283
description: |
1284
Sharing buttons to include on navbar or sidebar
1285
(one or more of `twitter`, `facebook`, `linkedin`)
1286
downloads:
1287
maybeArrayOf:
1288
enum: [pdf, epub, docx]
1289
description: |
1290
Download buttons for other formats to include on navbar or sidebar
1291
(one or more of `pdf`, `epub`, and `docx`)
1292
tools:
1293
arrayOf:
1294
schema:
1295
ref: navigation-item
1296
description: "Custom tools for navbar or sidebar"
1297
doi:
1298
string:
1299
tags:
1300
formats: [$html-doc]
1301
description: The Digital Object Identifier for this book.
1302
1303
- id: chapter-item
1304
anyOf:
1305
- ref: navigation-item
1306
- object:
1307
properties:
1308
part:
1309
string:
1310
description: "Part title or path to input file"
1311
chapters:
1312
arrayOf:
1313
ref: navigation-item
1314
description: "Path to chapter input file"
1315
required: [part]
1316
1317
- id: chapter-list
1318
arrayOf:
1319
ref: chapter-item
1320
1321
- id: other-links
1322
arrayOf:
1323
object:
1324
properties:
1325
text:
1326
string:
1327
description: "The text for the link."
1328
href:
1329
string:
1330
description: "The href for the link."
1331
icon:
1332
string:
1333
description: "The bootstrap icon name for the link."
1334
rel:
1335
string:
1336
description: "The rel attribute value for the link."
1337
target:
1338
string:
1339
description: "The target attribute value for the link."
1340
required: [text, href]
1341
1342
- id: crossref-labels-schema
1343
string:
1344
completions:
1345
- alpha
1346
- arabic
1347
- roman
1348
1349
- id: epub-contributor
1350
anyOf:
1351
- string
1352
- maybeArrayOf:
1353
object:
1354
closed: true
1355
properties:
1356
role:
1357
string:
1358
description:
1359
short: The role of this creator or contributor.
1360
long: |
1361
The role of this creator or contributor using
1362
[MARC relators](https://loc.gov/marc/relators/relaterm.html). Human readable
1363
translations to commonly used relators (e.g. 'author', 'editor') will
1364
attempt to be automatically translated.
1365
file-as:
1366
string:
1367
description: An alternate version of the creator or contributor text used for alphabatizing.
1368
text:
1369
string:
1370
description: The text describing the creator or contributor (for example, creator name).
1371
1372
- id: format-language
1373
object:
1374
properties:
1375
toc-title-document: string
1376
toc-title-website: string
1377
related-formats-title: string
1378
related-notebooks-title: string
1379
callout-tip-title: string
1380
callout-note-title: string
1381
callout-warning-title: string
1382
callout-important-title: string
1383
callout-caution-title: string
1384
section-title-abstract: string
1385
section-title-footnotes: string
1386
section-title-appendices: string
1387
code-summary: string
1388
code-tools-menu-caption: string
1389
code-tools-show-all-code: string
1390
code-tools-hide-all-code: string
1391
code-tools-view-source: string
1392
code-tools-source-code: string
1393
search-no-results-text: string
1394
copy-button-tooltip: string
1395
copy-button-tooltip-success: string
1396
repo-action-links-edit: string
1397
repo-action-links-source: string
1398
repo-action-links-issue: string
1399
search-matching-documents-text: string
1400
search-copy-link-title: string
1401
search-hide-matches-text: string
1402
search-more-match-text: string
1403
search-more-matches-text: string
1404
search-clear-button-title: string
1405
search-text-placeholder: string
1406
search-detached-cancel-button-title: string
1407
search-submit-button-title: string
1408
crossref-fig-title: string
1409
crossref-tbl-title: string
1410
crossref-lst-title: string
1411
crossref-thm-title: string
1412
crossref-lem-title: string
1413
crossref-cor-title: string
1414
crossref-prp-title: string
1415
crossref-cnj-title: string
1416
crossref-def-title: string
1417
crossref-exm-title: string
1418
crossref-exr-title: string
1419
crossref-fig-prefix: string
1420
crossref-tbl-prefix: string
1421
crossref-lst-prefix: string
1422
crossref-ch-prefix: string
1423
crossref-apx-prefix: string
1424
crossref-sec-prefix: string
1425
crossref-eq-prefix: string
1426
crossref-thm-prefix: string
1427
crossref-lem-prefix: string
1428
crossref-cor-prefix: string
1429
crossref-prp-prefix: string
1430
crossref-cnj-prefix: string
1431
crossref-def-prefix: string
1432
crossref-exm-prefix: string
1433
crossref-exr-prefix: string
1434
crossref-lof-title: string
1435
crossref-lot-title: string
1436
crossref-lol-title: string
1437
errorDescription: "be a format language description object"
1438
1439
- id: website-about
1440
object:
1441
closed: true
1442
required: [template]
1443
properties:
1444
id:
1445
string:
1446
description:
1447
short: "The target id for the about page."
1448
long: |
1449
The target id of this about page. When the about page is rendered, it will
1450
place read the contents of a `div` with this id into the about template that you
1451
have selected (and replace the contents with the rendered about content).
1452
1453
If no such `div` is defined on the page, a `div` with this id will be created
1454
and appended to the end of the page.
1455
template:
1456
anyOf:
1457
- enum: [jolla, trestles, solana, marquee, broadside]
1458
- path
1459
description:
1460
short: "The template to use to layout this about page."
1461
long: |
1462
The template to use to layout this about page. Choose from:
1463
1464
- `jolla`
1465
- `trestles`
1466
- `solana`
1467
- `marquee`
1468
- `broadside`
1469
image:
1470
path:
1471
description:
1472
short: "The path to the main image on the about page."
1473
long: |
1474
The path to the main image on the about page. If not specified,
1475
the `image` provided for the document itself will be used.
1476
image-alt:
1477
path:
1478
description: "The alt text for the main image on the about page."
1479
image-title:
1480
path:
1481
description: "The title for the main image on the about page."
1482
image-width:
1483
string:
1484
description:
1485
short: "A valid CSS width for the about page image."
1486
long: |
1487
A valid CSS width for the about page image.
1488
image-shape:
1489
enum: [rectangle, round, rounded]
1490
description:
1491
short: "The shape of the image on the about page."
1492
long: |
1493
The shape of the image on the about page.
1494
1495
- `rectangle`
1496
- `round`
1497
- `rounded`
1498
links:
1499
arrayOf:
1500
ref: navigation-item
1501
1502
- id: website-listing
1503
object:
1504
closed: true
1505
properties:
1506
id:
1507
string:
1508
description:
1509
short: "The id of this listing."
1510
long: |
1511
The id of this listing. When the listing is rendered, it will
1512
place the contents into a `div` with this id. If no such `div` is defined on the
1513
page, a `div` with this id will be created and appended to the end of the page.
1514
1515
If no `id` is provided for a listing, Quarto will synthesize one when rendering the page.
1516
type:
1517
enum: [default, table, grid, custom]
1518
description:
1519
short: "The type of listing to create."
1520
long: |
1521
The type of listing to create. Choose one of:
1522
1523
- `default`: A blog style list of items
1524
- `table`: A table of items
1525
- `grid`: A grid of item cards
1526
- `custom`: A custom template, provided by the `template` field
1527
contents:
1528
maybeArrayOf:
1529
anyOf:
1530
- string
1531
- ref: website-listing-contents-object
1532
description: "The files or path globs of Quarto documents or YAML files that should be included in the listing."
1533
sort:
1534
anyOf:
1535
- boolean
1536
- maybeArrayOf: string
1537
description:
1538
short: "Sort items in the listing by these fields."
1539
long: |
1540
Sort items in the listing by these fields. The sort key is made up of a
1541
field name followed by a direction `asc` or `desc`.
1542
1543
For example:
1544
`date asc`
1545
1546
Use `sort:false` to use the unsorted original order of items.
1547
max-items:
1548
number:
1549
description: The maximum number of items to include in this listing.
1550
page-size:
1551
number:
1552
description: The number of items to display on a page.
1553
sort-ui:
1554
anyOf:
1555
- boolean
1556
- arrayOf: string
1557
description:
1558
short: "Shows or hides the sorting control for the listing."
1559
long: |
1560
Shows or hides the sorting control for the listing. To control the
1561
fields that will be displayed in the sorting control, provide a list
1562
of field names.
1563
filter-ui:
1564
anyOf:
1565
- boolean
1566
- arrayOf: string
1567
description:
1568
short: "Shows or hides the filtering control for the listing."
1569
long: |
1570
Shows or hides the filtering control for the listing. To control the
1571
fields that will be used to filter the listing, provide a list
1572
of field names. By default all fields of the listing will be used
1573
when filtering.
1574
categories:
1575
anyOf:
1576
- boolean
1577
- enum: [numbered, unnumbered, cloud]
1578
description:
1579
short: "Display item categories from this listing in the margin of the page."
1580
long: |
1581
Display item categories from this listing in the margin of the page.
1582
1583
- `numbered`: Category list with number of items
1584
- `unnumbered`: Category list
1585
- `cloud`: Word cloud style categories
1586
1587
feed:
1588
anyOf:
1589
- boolean
1590
- object:
1591
closed: true
1592
properties:
1593
items:
1594
number:
1595
description: |
1596
The number of items to include in your feed. Defaults to 20.
1597
type:
1598
enum: [full, partial, metadata]
1599
description:
1600
short: Whether to include full or partial content in the feed.
1601
long: |
1602
Whether to include full or partial content in the feed.
1603
1604
- `full` (default): Include the complete content of the document in the feed.
1605
- `partial`: Include only the first paragraph of the document in the feed.
1606
- `metadata`: Use only the title, description, and other document metadata in the feed.
1607
title:
1608
string:
1609
description:
1610
short: The title for this feed.
1611
long: |
1612
The title for this feed. Defaults to the site title provided the Quarto project.
1613
image:
1614
path:
1615
description:
1616
short: The path to an image for this feed.
1617
long: |
1618
The path to an image for this feed. If not specified, the image for the page the listing
1619
appears on will be used, otherwise an image will be used if specified for the site
1620
in the Quarto project.
1621
description:
1622
string:
1623
description:
1624
short: The description of this feed.
1625
long: |
1626
The description of this feed. If not specified, the description for the page the
1627
listing appears on will be used, otherwise the description
1628
of the site will be used if specified in the Quarto project.
1629
language:
1630
string:
1631
description:
1632
short: The language of the feed.
1633
long: |
1634
The language of the feed. Omitted if not specified.
1635
See [https://www.rssboard.org/rss-language-codes](https://www.rssboard.org/rss-language-codes)
1636
for a list of valid language codes.
1637
categories:
1638
maybeArrayOf:
1639
string:
1640
description: A list of categories for which to create separate RSS feeds containing only posts with that category
1641
xml-stylesheet:
1642
path:
1643
description: The path to an XML stylesheet (XSL file) used to style the RSS feed.
1644
description: Enables an RSS feed for the listing.
1645
date-format:
1646
string:
1647
description:
1648
short: "The date format to use when displaying dates (e.g. d-M-yyy)."
1649
long: |
1650
The date format to use when displaying dates (e.g. d-M-yyy).
1651
Learn more about supported date formatting values [here](https://quarto.org/docs/reference/dates.html).
1652
max-description-length:
1653
number:
1654
description:
1655
short: "The maximum length (in characters) of the description displayed in the listing."
1656
long: |
1657
The maximum length (in characters) of the description displayed in the listing.
1658
Defaults to 175.
1659
image-placeholder:
1660
string:
1661
description: "The default image to use if an item in the listing doesn't have an image."
1662
image-lazy-loading:
1663
boolean:
1664
description: "If false, images in the listing will be loaded immediately. If true, images will be loaded as they come into view."
1665
default: true
1666
image-align:
1667
enum: [left, right]
1668
description: In `default` type listings, whether to place the image on the right or left side of the post content (`left` or `right`).
1669
image-height:
1670
string:
1671
description:
1672
short: "The height of the image being displayed."
1673
long: |
1674
The height of the image being displayed (a CSS height string).
1675
1676
The width is automatically determined and the image will fill the rectangle without scaling (cropped to fill).
1677
grid-columns:
1678
number:
1679
description:
1680
short: "In `grid` type listings, the number of columns in the grid display."
1681
long: |
1682
In grid type listings, the number of columns in the grid display.
1683
Defaults to 3.
1684
grid-item-border:
1685
boolean:
1686
description:
1687
short: "In `grid` type listings, whether to display a border around the item card."
1688
long: |
1689
In grid type listings, whether to display a border around the item card. Defaults to `true`.
1690
grid-item-align:
1691
enum: [left, right, center]
1692
description:
1693
short: "In `grid` type listings, the alignment of the content within the card."
1694
long: |
1695
In grid type listings, the alignment of the content within the card (`left` (default), `right`, or `center`).
1696
table-striped:
1697
boolean:
1698
description:
1699
short: "In `table` type listings, display the table rows with alternating background colors."
1700
long: |
1701
In table type listings, display the table rows with alternating background colors.
1702
Defaults to `false`.
1703
table-hover:
1704
boolean:
1705
description:
1706
short: "In `table` type listings, highlight rows of the table when the user hovers the mouse over them."
1707
long: |
1708
In table type listings, highlight rows of the table when the user hovers the mouse over them.
1709
Defaults to false.
1710
template:
1711
path:
1712
description:
1713
short: "The path to a custom listing template."
1714
long: |
1715
The path to a custom listing template.
1716
template-params:
1717
schema: object
1718
description: "Parameters that are passed to the custom template."
1719
fields:
1720
arrayOf: string
1721
description:
1722
short: "The list of fields to include in this listing"
1723
long: |
1724
The list of fields to include in this listing.
1725
field-display-names:
1726
object:
1727
description:
1728
short: "A mapping of display names for listing fields."
1729
long: |
1730
A mapping that provides display names for specific fields. For example, to display the title column as ‘Report’ in a table listing you would write:
1731
1732
```yaml
1733
listing:
1734
field-display-names:
1735
title: "Report"
1736
```
1737
field-types:
1738
object:
1739
description:
1740
short: "Provides the date type for the field of a listing item."
1741
long: |
1742
Provides the date type for the field of a listing item. Unknown fields are treated
1743
as strings unless a type is provided. Valid types are `date`, `number`.
1744
field-links:
1745
arrayOf: string
1746
description:
1747
short: "This list of fields to display as links in a table listing."
1748
long: |
1749
The list of fields to display as hyperlinks to the source document
1750
when the listing type is a table. By default, only the `title` or
1751
`filename` is displayed as a link.
1752
field-required:
1753
arrayOf: string
1754
description:
1755
short: "Fields that items in this listing must have populated."
1756
long: |
1757
Fields that items in this listing must have populated.
1758
If a listing is rendered and one more items in this listing
1759
is missing a required field, an error will occur and the render will.
1760
include:
1761
maybeArrayOf: object
1762
description: "Items with matching field values will be included in the listing."
1763
exclude:
1764
maybeArrayOf: object
1765
description: "Items with matching field values will be excluded from the listing."
1766
1767
- id: website-listing-contents-object
1768
object:
1769
properties:
1770
author:
1771
maybeArrayOf: string
1772
date: string
1773
title: string
1774
subtitle: string
1775
1776
- id: csl-date
1777
anyOf:
1778
- string
1779
- maybeArrayOf: number
1780
- object:
1781
properties:
1782
year:
1783
number:
1784
description: The year
1785
month:
1786
number:
1787
description: The month
1788
day:
1789
number:
1790
description: The day
1791
1792
- id: csl-person
1793
anyOf:
1794
- maybeArrayOf: string
1795
- maybeArrayOf:
1796
object:
1797
properties:
1798
family-name:
1799
string:
1800
description: The family name.
1801
given-name:
1802
string:
1803
description: The given name.
1804
1805
- id: csl-number
1806
anyOf:
1807
- number
1808
- string
1809
1810
- id: csl-item-shared
1811
object:
1812
properties:
1813
abstract-url:
1814
string:
1815
description: A url to the abstract for this item.
1816
accessed:
1817
ref: csl-date
1818
description: Date the item has been accessed.
1819
annote:
1820
string:
1821
description:
1822
short: Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review).
1823
long: |
1824
Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review);
1825
1826
For descriptive text (e.g., in an annotated bibliography), use `note` instead
1827
archive:
1828
string:
1829
description: Archive storing the item
1830
archive-collection:
1831
string:
1832
description: Collection the item is part of within an archive.
1833
archive_collection:
1834
schema: string
1835
hidden: true
1836
archive-location:
1837
string:
1838
description: Storage location within an archive (e.g. a box and folder number).
1839
archive_location:
1840
schema: string
1841
hidden: true
1842
archive-place:
1843
string:
1844
description: Geographic location of the archive.
1845
authority:
1846
string:
1847
description: Issuing or judicial authority (e.g. "USPTO" for a patent, "Fairfax Circuit Court" for a legal case).
1848
available-date:
1849
ref: csl-date
1850
description:
1851
short: Date the item was initially available
1852
long: |
1853
Date the item was initially available (e.g. the online publication date of a journal
1854
article before its formal publication date; the date a treaty was made available for signing).
1855
call-number:
1856
string:
1857
description: Call number (to locate the item in a library).
1858
chair:
1859
ref: csl-person
1860
description: The person leading the session containing a presentation (e.g. the organizer of the `container-title` of a `speech`).
1861
chapter-number:
1862
ref: csl-number
1863
description: Chapter number (e.g. chapter number in a book; track number on an album).
1864
citation-key:
1865
string:
1866
description:
1867
short: Identifier of the item in the input data file (analogous to BiTeX entrykey).
1868
long: |
1869
Identifier of the item in the input data file (analogous to BiTeX entrykey);
1870
1871
Use this variable to facilitate conversion between word-processor and plain-text writing systems;
1872
For an identifer intended as formatted output label for a citation
1873
(e.g. “Ferr78”), use `citation-label` instead
1874
citation-label:
1875
string:
1876
description:
1877
short: Label identifying the item in in-text citations of label styles (e.g. "Ferr78").
1878
long: |
1879
Label identifying the item in in-text citations of label styles (e.g. "Ferr78");
1880
1881
May be assigned by the CSL processor based on item metadata; For the identifier of the item
1882
in the input data file, use `citation-key` instead
1883
citation-number:
1884
schema:
1885
ref: csl-number
1886
description: Index (starting at 1) of the cited reference in the bibliography (generated by the CSL processor).
1887
hidden: true
1888
collection-editor:
1889
ref: csl-person
1890
description: Editor of the collection holding the item (e.g. the series editor for a book).
1891
collection-number:
1892
ref: csl-number
1893
description: Number identifying the collection holding the item (e.g. the series number for a book)
1894
collection-title:
1895
string:
1896
description: Title of the collection holding the item (e.g. the series title for a book; the lecture series title for a presentation).
1897
compiler:
1898
ref: csl-person
1899
description: Person compiling or selecting material for an item from the works of various persons or bodies (e.g. for an anthology).
1900
composer:
1901
ref: csl-person
1902
description: Composer (e.g. of a musical score).
1903
container-author:
1904
ref: csl-person
1905
description: Author of the container holding the item (e.g. the book author for a book chapter).
1906
container-title:
1907
string:
1908
description:
1909
short: Title of the container holding the item.
1910
long: |
1911
Title of the container holding the item (e.g. the book title for a book chapter,
1912
the journal title for a journal article; the album title for a recording;
1913
the session title for multi-part presentation at a conference)
1914
container-title-short:
1915
string:
1916
description: Short/abbreviated form of container-title;
1917
hidden: true
1918
contributor:
1919
ref: csl-person
1920
description: A minor contributor to the item; typically cited using with before the name when listed in a bibliography.
1921
curator:
1922
ref: csl-person
1923
description: Curator of an exhibit or collection (e.g. in a museum).
1924
dimensions:
1925
string:
1926
description: Physical (e.g. size) or temporal (e.g. running time) dimensions of the item.
1927
director:
1928
ref: csl-person
1929
description: Director (e.g. of a film).
1930
division:
1931
string:
1932
description: Minor subdivision of a court with a `jurisdiction` for a legal item
1933
DOI:
1934
schema: string
1935
hidden: true
1936
edition:
1937
ref: csl-number
1938
description: (Container) edition holding the item (e.g. "3" when citing a chapter in the third edition of a book).
1939
editor:
1940
ref: csl-person
1941
description: The editor of the item.
1942
editorial-director:
1943
ref: csl-person
1944
description: Managing editor ("Directeur de la Publication" in French).
1945
editor-translator:
1946
ref: csl-person
1947
description:
1948
short: Combined editor and translator of a work.
1949
long: |
1950
Combined editor and translator of a work.
1951
1952
The citation processory must be automatically generate if editor and translator variables
1953
are identical; May also be provided directly in item data.
1954
event:
1955
schema: string
1956
hidden: true
1957
event-date:
1958
ref: csl-date
1959
description: Date the event related to an item took place.
1960
event-title:
1961
string:
1962
description: Name of the event related to the item (e.g. the conference name when citing a conference paper; the meeting where presentation was made).
1963
event-place:
1964
string:
1965
description: Geographic location of the event related to the item (e.g. "Amsterdam, The Netherlands").
1966
executive-producer:
1967
ref: csl-person
1968
description: Executive producer of the item (e.g. of a television series).
1969
first-reference-note-number:
1970
schema:
1971
ref: csl-number
1972
description:
1973
short: Number of a preceding note containing the first reference to the item.
1974
long: |
1975
Number of a preceding note containing the first reference to the item
1976
1977
Assigned by the CSL processor; Empty in non-note-based styles or when the item hasn't
1978
been cited in any preceding notes in a document
1979
hidden: true
1980
fulltext-url:
1981
string:
1982
description: A url to the full text for this item.
1983
genre:
1984
string:
1985
description:
1986
short: Type, class, or subtype of the item
1987
long: |
1988
Type, class, or subtype of the item (e.g. "Doctoral dissertation" for a PhD thesis; "NIH Publication" for an NIH technical report);
1989
1990
Do not use for topical descriptions or categories (e.g. "adventure" for an adventure movie)
1991
guest:
1992
ref: csl-person
1993
description: Guest (e.g. on a TV show or podcast).
1994
host:
1995
ref: csl-person
1996
description: Host of the item (e.g. of a TV show or podcast).
1997
id:
1998
anyOf:
1999
- string
2000
- number
2001
description: A value which uniquely identifies this item.
2002
illustrator:
2003
ref: csl-person
2004
description: Illustrator (e.g. of a childrens book or graphic novel).
2005
interviewer:
2006
ref: csl-person
2007
description: Interviewer (e.g. of an interview).
2008
isbn:
2009
string:
2010
description: International Standard Book Number (e.g. "978-3-8474-1017-1").
2011
ISBN:
2012
schema: string
2013
hidden: true
2014
issn:
2015
string:
2016
description: International Standard Serial Number.
2017
ISSN:
2018
schema: string
2019
hidden: true
2020
issue:
2021
ref: csl-number
2022
description:
2023
short: Issue number of the item or container holding the item
2024
long: |
2025
Issue number of the item or container holding the item (e.g. "5" when citing a
2026
journal article from journal volume 2, issue 5);
2027
2028
Use `volume-title` for the title of the issue, if any.
2029
issued:
2030
ref: csl-date
2031
description: Date the item was issued/published.
2032
jurisdiction:
2033
string:
2034
description: Geographic scope of relevance (e.g. "US" for a US patent; the court hearing a legal case).
2035
keyword:
2036
string:
2037
description: Keyword(s) or tag(s) attached to the item.
2038
language:
2039
string:
2040
description:
2041
short: The language of the item (used only for citation of the item).
2042
long: |
2043
The language of the item (used only for citation of the item).
2044
2045
Should be entered as an ISO 639-1 two-letter language code (e.g. "en", "zh"),
2046
optionally with a two-letter locale code (e.g. "de-DE", "de-AT").
2047
2048
This does not change the language of the item, instead it documents
2049
what language the item uses (which may be used in citing the item).
2050
license:
2051
string:
2052
description:
2053
short: The license information applicable to an item.
2054
long: |
2055
The license information applicable to an item (e.g. the license an article
2056
or software is released under; the copyright information for an item;
2057
the classification status of a document)
2058
locator:
2059
ref: csl-number
2060
description:
2061
short: A cite-specific pinpointer within the item.
2062
long: |
2063
A cite-specific pinpointer within the item (e.g. a page number within a book,
2064
or a volume in a multi-volume work).
2065
2066
Must be accompanied in the input data by a label indicating the locator type
2067
(see the Locators term list).
2068
2069
medium:
2070
string:
2071
description: Description of the items format or medium (e.g. "CD", "DVD", "Album", etc.)
2072
narrator:
2073
ref: csl-person
2074
description: Narrator (e.g. of an audio book).
2075
note:
2076
string:
2077
description: Descriptive text or notes about an item (e.g. in an annotated bibliography).
2078
number:
2079
ref: csl-number
2080
description: Number identifying the item (e.g. a report number).
2081
number-of-pages:
2082
ref: csl-number
2083
description: Total number of pages of the cited item.
2084
number-of-volumes:
2085
ref: csl-number
2086
description: Total number of volumes, used when citing multi-volume books and such.
2087
organizer:
2088
ref: csl-person
2089
description: Organizer of an event (e.g. organizer of a workshop or conference).
2090
original-author:
2091
ref: csl-person
2092
description:
2093
short: The original creator of a work.
2094
long: |
2095
The original creator of a work (e.g. the form of the author name
2096
listed on the original version of a book; the historical author of a work;
2097
the original songwriter or performer for a musical piece; the original
2098
developer or programmer for a piece of software; the original author of an
2099
adapted work such as a book adapted into a screenplay)
2100
original-date:
2101
ref: csl-date
2102
description: Issue date of the original version.
2103
original-publisher:
2104
string:
2105
description: Original publisher, for items that have been republished by a different publisher.
2106
original-publisher-place:
2107
string:
2108
description: Geographic location of the original publisher (e.g. "London, UK").
2109
original-title:
2110
string:
2111
description: Title of the original version (e.g. "Война и мир", the untranslated Russian title of "War and Peace").
2112
page:
2113
ref: csl-number
2114
description: Range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).
2115
page-first:
2116
ref: csl-number
2117
description: First page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).
2118
page-last:
2119
ref: csl-number
2120
description: Last page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).
2121
part-number:
2122
ref: csl-number
2123
description:
2124
short: Number of the specific part of the item being cited (e.g. part 2 of a journal article).
2125
long: |
2126
Number of the specific part of the item being cited (e.g. part 2 of a journal article).
2127
2128
Use `part-title` for the title of the part, if any.
2129
part-title:
2130
string:
2131
description: Title of the specific part of an item being cited.
2132
pdf-url:
2133
string:
2134
description: A url to the pdf for this item.
2135
performer:
2136
ref: csl-person
2137
description: Performer of an item (e.g. an actor appearing in a film; a muscian performing a piece of music).
2138
pmcid:
2139
string:
2140
description: PubMed Central reference number.
2141
PMCID:
2142
schema: string
2143
hidden: true
2144
pmid:
2145
string:
2146
description: PubMed reference number.
2147
PMID:
2148
schema: string
2149
hidden: true
2150
printing-number:
2151
ref: csl-number
2152
description: Printing number of the item or container holding the item.
2153
producer:
2154
ref: csl-person
2155
description: Producer (e.g. of a television or radio broadcast).
2156
public-url:
2157
string:
2158
description: A public url for this item.
2159
publisher:
2160
string:
2161
description: The publisher of the item.
2162
publisher-place:
2163
string:
2164
description: The geographic location of the publisher.
2165
recipient:
2166
ref: csl-person
2167
description: Recipient (e.g. of a letter).
2168
reviewed-author:
2169
ref: csl-person
2170
description: Author of the item reviewed by the current item.
2171
reviewed-genre:
2172
string:
2173
description: Type of the item being reviewed by the current item (e.g. book, film).
2174
reviewed-title:
2175
string:
2176
description: Title of the item reviewed by the current item.
2177
scale:
2178
string:
2179
description: Scale of e.g. a map or model.
2180
script-writer:
2181
ref: csl-person
2182
description: Writer of a script or screenplay (e.g. of a film).
2183
section:
2184
ref: csl-number
2185
description: Section of the item or container holding the item (e.g. "§2.0.1" for a law; "politics" for a newspaper article).
2186
series-creator:
2187
ref: csl-person
2188
description: Creator of a series (e.g. of a television series).
2189
source:
2190
string:
2191
description: Source from whence the item originates (e.g. a library catalog or database).
2192
status:
2193
string:
2194
description: Publication status of the item (e.g. "forthcoming"; "in press"; "advance online publication"; "retracted")
2195
submitted:
2196
ref: csl-date
2197
description: Date the item (e.g. a manuscript) was submitted for publication.
2198
supplement-number:
2199
ref: csl-number
2200
description: Supplement number of the item or container holding the item (e.g. for secondary legal items that are regularly updated between editions).
2201
title-short:
2202
string:
2203
description: Short/abbreviated form of`title`.
2204
hidden: true
2205
translator:
2206
ref: csl-person
2207
description: Translator
2208
type:
2209
enum:
2210
[
2211
"article",
2212
"article-journal",
2213
"article-magazine",
2214
"article-newspaper",
2215
"bill",
2216
"book",
2217
"broadcast",
2218
"chapter",
2219
"classic",
2220
"collection",
2221
"dataset",
2222
"document",
2223
"entry",
2224
"entry-dictionary",
2225
"entry-encyclopedia",
2226
"event",
2227
"figure",
2228
"graphic",
2229
"hearing",
2230
"interview",
2231
"legal_case",
2232
"legislation",
2233
"manuscript",
2234
"map",
2235
"motion_picture",
2236
"musical_score",
2237
"pamphlet",
2238
"paper-conference",
2239
"patent",
2240
"performance",
2241
"periodical",
2242
"personal_communication",
2243
"post",
2244
"post-weblog",
2245
"regulation",
2246
"report",
2247
"review",
2248
"review-book",
2249
"software",
2250
"song",
2251
"speech",
2252
"standard",
2253
"thesis",
2254
"treaty",
2255
"webpage",
2256
]
2257
description: The [type](https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types) of the item.
2258
url:
2259
string:
2260
description: Uniform Resource Locator (e.g. "https://aem.asm.org/cgi/content/full/74/9/2766")
2261
URL:
2262
schema: string
2263
hidden: true
2264
version:
2265
ref: csl-number
2266
description: Version of the item (e.g. "2.0.9" for a software program).
2267
volume:
2268
ref: csl-number
2269
description:
2270
short: Volume number of the item (e.g. 2 when citing volume 2 of a book) or the container holding the item.
2271
long: |
2272
Volume number of the item (e.g. "2" when citing volume 2 of a book) or the container holding the
2273
item (e.g. "2" when citing a chapter from volume 2 of a book).
2274
2275
Use `volume-title` for the title of the volume, if any.
2276
volume-title:
2277
string:
2278
description:
2279
short: Title of the volume of the item or container holding the item.
2280
long: |
2281
Title of the volume of the item or container holding the item.
2282
2283
Also use for titles of periodical special issues, special sections, and the like.
2284
year-suffix:
2285
string:
2286
description: Disambiguating year suffix in author-date styles (e.g. "a" in "Doe, 1999a").
2287
2288
- id: csl-item
2289
object:
2290
super:
2291
resolveRef: csl-item-shared
2292
closed: true
2293
properties:
2294
abstract:
2295
string:
2296
description: Abstract of the item (e.g. the abstract of a journal article)
2297
author:
2298
ref: csl-person
2299
description: The author(s) of the item.
2300
doi:
2301
string:
2302
description: Digital Object Identifier (e.g. "10.1128/AEM.02591-07")
2303
references:
2304
string:
2305
description:
2306
short: Resources related to the procedural history of a legal case or legislation.
2307
long: |
2308
Resources related to the procedural history of a legal case or legislation;
2309
2310
Can also be used to refer to the procedural history of other items (e.g.
2311
"Conference canceled" for a presentation accepted as a conference that was subsequently
2312
canceled; details of a retraction or correction notice)
2313
title:
2314
string:
2315
description: The primary title of the item.
2316
id:
2317
anyOf:
2318
- string
2319
- number
2320
description: Citation identifier for the item (e.g. "item1"). Will be autogenerated if not provided.
2321
2322
- id: citation-item
2323
object:
2324
super:
2325
resolveRef: csl-item
2326
closed: true
2327
properties:
2328
article-id:
2329
maybeArrayOf:
2330
anyOf:
2331
- string
2332
- object:
2333
properties:
2334
type:
2335
string:
2336
description: The type of identifier
2337
value:
2338
string:
2339
description: The value for the identifier
2340
description: The unique identifier for this article.
2341
elocation-id:
2342
string:
2343
description: Bibliographic identifier for a document that does not have traditional printed page numbers.
2344
eissn:
2345
string:
2346
description: Electronic International Standard Serial Number.
2347
pissn:
2348
string:
2349
description: Print International Standard Serial Number.
2350
art-access-id:
2351
string:
2352
description: Generic article accession identifier.
2353
publisher-location:
2354
string:
2355
description: The location of the publisher of this item.
2356
subject:
2357
string:
2358
description: The name of a subject or topic describing the article.
2359
categories:
2360
maybeArrayOf:
2361
string:
2362
description: A list of subjects or topics describing the article.
2363
container-id:
2364
maybeArrayOf:
2365
anyOf:
2366
- string
2367
- object:
2368
properties:
2369
type:
2370
string:
2371
description: The type of identifier (e.g. `nlm-ta` or `pmc`).
2372
value:
2373
string:
2374
description: The value for the identifier
2375
description:
2376
short: External identifier of a publication or journal.
2377
long: |
2378
External identifier, typically assigned to a journal by
2379
a publisher, archive, or library to provide a unique identifier for
2380
the journal or publication.
2381
jats-type:
2382
string:
2383
description: The type used for the JATS `article` tag.
2384
2385
- id: smart-include
2386
anyOf:
2387
- record:
2388
text:
2389
string:
2390
description: Textual content to add to includes
2391
- record:
2392
file:
2393
string:
2394
description: Name of file with content to add to includes
2395
2396
- id: semver
2397
string:
2398
# from https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
2399
pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
2400
description: Version number according to Semantic Versioning
2401
2402
- id: quarto-date
2403
anyOf:
2404
- string
2405
- object:
2406
closed: true
2407
properties:
2408
format: string
2409
value: string
2410
required: [value]
2411
2412
- id: project-profile
2413
schema:
2414
object:
2415
closed: true
2416
properties:
2417
default:
2418
maybeArrayOf: string
2419
description: |
2420
Default profile to apply if QUARTO_PROFILE is not defined.
2421
group:
2422
maybeArrayOf:
2423
arrayOf: string
2424
description: |
2425
Define a profile group for which at least one profile is always active.
2426
description: Specify a default profile and profile groups
2427
2428
- id: bad-parse-schema
2429
schema:
2430
object:
2431
propertyNames:
2432
string:
2433
pattern: "^[^\\s]+$"
2434
2435
- id: quarto-dev-schema
2436
schema:
2437
object:
2438
properties:
2439
_quarto:
2440
hidden: true
2441
object:
2442
properties:
2443
trace-filters: string
2444
tests:
2445
object:
2446
properties:
2447
run:
2448
object:
2449
description: "Control when tests should run"
2450
properties:
2451
ci:
2452
boolean:
2453
description: "Run tests on CI (true = run, false = skip)"
2454
default: true
2455
skip:
2456
description: "Skip test unconditionally (true = skip with default message, string = skip with custom message)"
2457
anyOf:
2458
- boolean
2459
- string
2460
os:
2461
description: "Run tests ONLY on these platforms (whitelist)"
2462
anyOf:
2463
- enum: [linux, darwin, windows]
2464
- arrayOf:
2465
enum: [linux, darwin, windows]
2466
not_os:
2467
description: "Don't run tests on these platforms (blacklist)"
2468
anyOf:
2469
- enum: [linux, darwin, windows]
2470
- arrayOf:
2471
enum: [linux, darwin, windows]
2472
2473
- id: notebook-view-schema
2474
schema:
2475
object:
2476
properties:
2477
notebook:
2478
string:
2479
description: "The path to the locally referenced notebook."
2480
title:
2481
description: "The title of the notebook when viewed."
2482
anyOf:
2483
- string
2484
- boolean
2485
url:
2486
string:
2487
description: "The url to use when viewing this notebook."
2488
download-url:
2489
string:
2490
description: "The url to use when downloading the notebook from the preview"
2491
required: [notebook]
2492
2493
- id: code-links-schema
2494
schema:
2495
anyOf:
2496
- boolean
2497
- maybeArrayOf:
2498
anyOf:
2499
- object:
2500
properties:
2501
icon:
2502
string:
2503
description: The bootstrap icon for this code link.
2504
text:
2505
string:
2506
description: The text for this code link.
2507
href:
2508
string:
2509
description: The href for this code link.
2510
rel:
2511
string:
2512
description: The rel used in the `a` tag for this code link.
2513
target:
2514
string:
2515
description: The target used in the `a` tag for this code link.
2516
- enum: ["repo", "binder", "devcontainer"]
2517
2518
- id: manuscript-schema
2519
schema:
2520
object:
2521
closed: true
2522
properties:
2523
"article":
2524
path:
2525
description: "The input document that will serve as the root document for this manuscript"
2526
"code-links":
2527
schema:
2528
ref: code-links-schema
2529
description: "Code links to display for this manuscript."
2530
"manuscript-url":
2531
string:
2532
description: "The deployed url for this manuscript"
2533
"meca-bundle":
2534
anyOf:
2535
- boolean
2536
- string
2537
description: "Whether to generate a MECA bundle for this manuscript"
2538
"notebooks":
2539
arrayOf:
2540
anyOf:
2541
- string
2542
- ref: notebook-view-schema
2543
"resources":
2544
maybeArrayOf:
2545
schema: path
2546
description: "Additional file resources to be copied to output directory"
2547
"environment":
2548
maybeArrayOf:
2549
schema: path
2550
description: "Files that specify the execution environment (e.g. renv.lock, requirements.text, etc...)"
2551
2552
- id: brand-meta
2553
description: >
2554
Metadata for a brand, including the brand name and important links.
2555
object:
2556
closed: false
2557
properties:
2558
name:
2559
description: The brand name.
2560
anyOf:
2561
- string
2562
- object:
2563
properties:
2564
full:
2565
string:
2566
description: The full, official or legal name of the company or brand.
2567
short:
2568
string:
2569
description: The short, informal, or common name of the company or brand.
2570
link:
2571
description: >
2572
Important links for the brand, including social media links.
2573
If a single string, it is the brand's home page or website.
2574
Additional fields are allowed for internal use.
2575
anyOf:
2576
- string
2577
- object:
2578
properties:
2579
home:
2580
string:
2581
description: The brand's home page or website.
2582
mastodon:
2583
string:
2584
description: The brand's Mastodon URL.
2585
bluesky:
2586
string:
2587
description: The brand's Bluesky URL.
2588
github:
2589
string:
2590
description: The brand's GitHub URL.
2591
linkedin:
2592
string:
2593
description: The brand's LinkedIn URL.
2594
twitter:
2595
string:
2596
description: The brand's Twitter URL.
2597
facebook:
2598
string:
2599
description: The brand's Facebook URL.
2600
2601
- id: brand-string-light-dark
2602
anyOf:
2603
- string
2604
- object:
2605
closed: true
2606
properties:
2607
light:
2608
schema: string
2609
description: >
2610
A link or path to the brand's light-colored logo or icon.
2611
dark:
2612
schema: string
2613
description: >
2614
A link or path to the brand's dark-colored logo or icon.
2615
2616
- id: brand-logo-explicit-resource
2617
object:
2618
closed: true
2619
properties:
2620
path: path
2621
alt:
2622
schema: string
2623
description: >
2624
Alternative text for the logo, used for accessibility.
2625
required: [path]
2626
2627
- id: brand-logo-resource
2628
anyOf:
2629
- string
2630
- ref: brand-logo-explicit-resource
2631
2632
- id: brand-logo-single
2633
description: >
2634
Provide definitions and defaults for brand's logo in various formats and sizes.
2635
object:
2636
closed: true
2637
properties:
2638
images:
2639
description: A dictionary of named logo resources.
2640
schema:
2641
object:
2642
additionalProperties:
2643
schema: { ref: brand-logo-resource }
2644
small:
2645
description: >
2646
A link or path to the brand's small-sized logo or icon.
2647
schema: string
2648
medium:
2649
description: >
2650
A link or path to the brand's medium-sized logo.
2651
schema: string
2652
large:
2653
description: >
2654
A link or path to the brand's large- or full-sized logo.
2655
schema: string
2656
2657
- id: brand-logo-unified
2658
description: >
2659
Provide definitions and defaults for brand's logo in various formats and sizes.
2660
object:
2661
closed: true
2662
properties:
2663
images:
2664
description: A dictionary of named logo resources.
2665
schema:
2666
object:
2667
additionalProperties:
2668
schema: { ref: brand-logo-resource }
2669
small:
2670
description: >
2671
A link or path to the brand's small-sized logo or icon, or a link or path
2672
to both the light and dark versions.
2673
schema:
2674
ref: brand-string-light-dark
2675
medium:
2676
description: >
2677
A link or path to the brand's medium-sized logo, or a link or path
2678
to both the light and dark versions.
2679
schema:
2680
ref: brand-string-light-dark
2681
large:
2682
description: >
2683
A link or path to the brand's large- or full-sized logo, or a link or path
2684
to both the light and dark versions.
2685
schema:
2686
ref: brand-string-light-dark
2687
2688
- id: brand-named-logo
2689
description: Names of customizeable logos
2690
enum: [small, medium, large]
2691
2692
- id: logo-options
2693
object:
2694
closed: false # e.g. to allow typst location, padding, padding-*, width
2695
properties:
2696
path:
2697
schema: path
2698
description: >
2699
Path or brand.yml logo resource name.
2700
alt:
2701
schema: string
2702
description: >
2703
Alternative text for the logo, used for accessibility.
2704
required: [path]
2705
2706
- id: logo-specifier
2707
anyOf:
2708
- string
2709
- schema:
2710
ref: logo-options
2711
2712
- id: logo-options-path-optional
2713
object:
2714
closed: false # e.g. to allow typst location, padding, padding-*, width
2715
properties:
2716
path:
2717
schema: path
2718
description: >
2719
Path or brand.yml logo resource name.
2720
alt:
2721
schema: string
2722
description: >
2723
Alternative text for the logo, used for accessibility.
2724
2725
- id: logo-specifier-path-optional
2726
anyOf:
2727
- string
2728
- schema:
2729
ref: logo-options-path-optional
2730
2731
- id: logo-light-dark-specifier
2732
description: >
2733
Any of the ways a logo can be specified: string, object, or light/dark object of
2734
string or object. Use `false` to explicitly disable the logo.
2735
anyOf:
2736
- enum: [false]
2737
- ref: logo-specifier
2738
- object:
2739
closed: true
2740
properties:
2741
light:
2742
schema:
2743
ref: logo-specifier
2744
description: >
2745
Specification of a light logo
2746
dark:
2747
schema:
2748
ref: logo-specifier
2749
description: >
2750
Specification of a dark logo
2751
2752
- id: logo-light-dark-specifier-path-optional
2753
description: >
2754
Any of the ways a logo can be specified: string, object, or light/dark object of
2755
string or object. Use `false` to explicitly disable the logo.
2756
anyOf:
2757
- enum: [false]
2758
- ref: logo-specifier-path-optional
2759
- object:
2760
closed: true
2761
properties:
2762
light:
2763
schema:
2764
ref: logo-specifier-path-optional
2765
description: >
2766
Specification of a light logo
2767
dark:
2768
schema:
2769
ref: logo-specifier-path-optional
2770
description: >
2771
Specification of a dark logo
2772
2773
# normalized version of logo-light-dark-specifier
2774
- id: normalized-logo-light-dark-specifier
2775
description: >
2776
Any of the ways a logo can be specified: string, object, or light/dark object of
2777
string or object
2778
object:
2779
closed: true
2780
properties:
2781
light:
2782
schema:
2783
ref: logo-options
2784
description: >
2785
Options for a light logo
2786
dark:
2787
schema:
2788
ref: logo-options
2789
description: >
2790
Options for a dark logo
2791
2792
- id: brand-color-value
2793
schema: string
2794
2795
- id: brand-color-single
2796
description: >
2797
The brand's custom color palette and theme.
2798
object:
2799
closed: true
2800
properties:
2801
palette:
2802
description: >
2803
The brand's custom color palette. Any number of colors can be defined,
2804
each color having a custom name.
2805
object:
2806
additionalProperties:
2807
schema:
2808
ref: brand-color-value
2809
foreground:
2810
description: The foreground color, used for text.
2811
schema:
2812
ref: brand-color-value
2813
default: black
2814
background:
2815
description: The background color, used for the page background.
2816
schema:
2817
ref: brand-color-value
2818
default: white
2819
primary:
2820
description: >
2821
The primary accent color, i.e. the main theme color. Typically used for
2822
hyperlinks, active states, primary action buttons, etc.
2823
schema:
2824
ref: brand-color-value
2825
secondary:
2826
description: >
2827
The secondary accent color. Typically used for lighter text or disabled states.
2828
schema:
2829
ref: brand-color-value
2830
tertiary:
2831
description: >
2832
The tertiary accent color. Typically an even lighter color, used for hover states,
2833
accents, and wells.
2834
schema:
2835
ref: brand-color-value
2836
success:
2837
description: The color used for positive or successful actions and information.
2838
schema:
2839
ref: brand-color-value
2840
info:
2841
description: The color used for neutral or informational actions and information.
2842
schema:
2843
ref: brand-color-value
2844
warning:
2845
description: The color used for warning or cautionary actions and information.
2846
schema:
2847
ref: brand-color-value
2848
danger:
2849
description: The color used for errors, dangerous actions, or negative information.
2850
schema:
2851
ref: brand-color-value
2852
light:
2853
description: >
2854
A bright color, used as a high-contrast foreground color on dark elements
2855
or low-contrast background color on light elements.
2856
schema:
2857
ref: brand-color-value
2858
dark:
2859
description: >
2860
A dark color, used as a high-contrast foreground color on light elements
2861
or high-contrast background color on light elements.
2862
schema:
2863
ref: brand-color-value
2864
link:
2865
description: >
2866
The color used for hyperlinks. If not defined, the `primary` color is used.
2867
schema:
2868
ref: brand-color-value
2869
2870
- id: brand-color-light-dark
2871
anyOf:
2872
- ref: brand-color-value
2873
- object:
2874
closed: true
2875
properties:
2876
light:
2877
schema:
2878
ref: brand-color-value
2879
description: >
2880
A link or path to the brand's light-colored logo or icon.
2881
dark:
2882
schema:
2883
ref: brand-color-value
2884
description: >
2885
A link or path to the brand's dark-colored logo or icon.
2886
2887
- id: brand-color-unified
2888
description: >
2889
The brand's custom color palette and theme.
2890
object:
2891
closed: true
2892
properties:
2893
palette:
2894
description: >
2895
The brand's custom color palette. Any number of colors can be defined,
2896
each color having a custom name.
2897
object:
2898
additionalProperties:
2899
schema:
2900
ref: brand-color-value
2901
foreground:
2902
description: The foreground color, used for text.
2903
schema:
2904
ref: brand-color-light-dark
2905
default: black
2906
background:
2907
description: The background color, used for the page background.
2908
schema:
2909
ref: brand-color-light-dark
2910
default: white
2911
primary:
2912
description: >
2913
The primary accent color, i.e. the main theme color. Typically used for
2914
hyperlinks, active states, primary action buttons, etc.
2915
schema:
2916
ref: brand-color-light-dark
2917
secondary:
2918
description: >
2919
The secondary accent color. Typically used for lighter text or disabled states.
2920
schema:
2921
ref: brand-color-light-dark
2922
tertiary:
2923
description: >
2924
The tertiary accent color. Typically an even lighter color, used for hover states,
2925
accents, and wells.
2926
schema:
2927
ref: brand-color-light-dark
2928
success:
2929
description: The color used for positive or successful actions and information.
2930
schema:
2931
ref: brand-color-light-dark
2932
info:
2933
description: The color used for neutral or informational actions and information.
2934
schema:
2935
ref: brand-color-light-dark
2936
warning:
2937
description: The color used for warning or cautionary actions and information.
2938
schema:
2939
ref: brand-color-light-dark
2940
danger:
2941
description: The color used for errors, dangerous actions, or negative information.
2942
schema:
2943
ref: brand-color-light-dark
2944
light:
2945
description: >
2946
A bright color, used as a high-contrast foreground color on dark elements
2947
or low-contrast background color on light elements.
2948
schema:
2949
ref: brand-color-light-dark
2950
dark:
2951
description: >
2952
A dark color, used as a high-contrast foreground color on light elements
2953
or high-contrast background color on light elements.
2954
schema:
2955
ref: brand-color-light-dark
2956
link:
2957
description: >
2958
The color used for hyperlinks. If not defined, the `primary` color is used.
2959
schema:
2960
ref: brand-color-light-dark
2961
2962
- id: brand-maybe-named-color
2963
description: >
2964
A color, which may be a named brand color.
2965
anyOf:
2966
- ref: brand-named-theme-color
2967
- schema: string
2968
2969
- id: brand-maybe-named-color-light-dark
2970
anyOf:
2971
- ref: brand-maybe-named-color
2972
- object:
2973
closed: true
2974
properties:
2975
light:
2976
schema:
2977
ref: brand-maybe-named-color
2978
description: >
2979
A link or path to the brand's light-colored logo or icon.
2980
dark:
2981
schema:
2982
ref: brand-maybe-named-color
2983
description: >
2984
A link or path to the brand's dark-colored logo or icon.
2985
2986
- id: brand-named-theme-color
2987
description: >
2988
A named brand color, taken either from `color.theme` or `color.palette` (in that order).
2989
enum:
2990
[
2991
foreground,
2992
background,
2993
primary,
2994
secondary,
2995
tertiary,
2996
success,
2997
info,
2998
warning,
2999
danger,
3000
light,
3001
dark,
3002
link,
3003
]
3004
3005
- id: brand-typography-single
3006
description: Typography definitions for the brand.
3007
object:
3008
closed: true
3009
properties:
3010
fonts:
3011
description: Font files and definitions for the brand.
3012
arrayOf:
3013
ref: brand-font
3014
base:
3015
description: >
3016
The base font settings for the brand. These are used as the default for
3017
all text.
3018
ref: brand-typography-options-base
3019
headings:
3020
description: Settings for headings, or a string specifying the font family only.
3021
ref: brand-typography-options-headings-single
3022
monospace:
3023
description: Settings for monospace text, or a string specifying the font family only.
3024
ref: brand-typography-options-monospace-single
3025
monospace-inline:
3026
description: Settings for inline code, or a string specifying the font family only.
3027
ref: brand-typography-options-monospace-inline-single
3028
monospace-block:
3029
description: Settings for code blocks, or a string specifying the font family only.
3030
ref: brand-typography-options-monospace-block-single
3031
link:
3032
description: Settings for links.
3033
ref: brand-typography-options-link-single
3034
3035
- id: brand-typography-unified
3036
description: Typography definitions for the brand.
3037
object:
3038
closed: true
3039
properties:
3040
fonts:
3041
description: Font files and definitions for the brand.
3042
arrayOf:
3043
ref: brand-font
3044
base:
3045
description: >
3046
The base font settings for the brand. These are used as the default for
3047
all text.
3048
ref: brand-typography-options-base
3049
headings:
3050
description: Settings for headings, or a string specifying the font family only.
3051
ref: brand-typography-options-headings-unified
3052
monospace:
3053
description: Settings for monospace text, or a string specifying the font family only.
3054
ref: brand-typography-options-monospace-unified
3055
monospace-inline:
3056
description: Settings for inline code, or a string specifying the font family only.
3057
ref: brand-typography-options-monospace-inline-unified
3058
monospace-block:
3059
description: Settings for code blocks, or a string specifying the font family only.
3060
ref: brand-typography-options-monospace-block-unified
3061
link:
3062
description: Settings for links.
3063
ref: brand-typography-options-link-unified
3064
3065
- id: brand-typography-options-base
3066
description: Base typographic options.
3067
anyOf:
3068
- string
3069
- object:
3070
closed: true
3071
properties:
3072
family: string
3073
size: string
3074
weight:
3075
ref: brand-font-weight
3076
line-height:
3077
ref: line-height-number-string
3078
3079
- id: brand-typography-options-headings-single
3080
description: Typographic options for headings.
3081
anyOf:
3082
- string
3083
- object:
3084
closed: true
3085
properties:
3086
family: string
3087
weight:
3088
ref: brand-font-weight
3089
style:
3090
ref: brand-font-style
3091
color:
3092
ref: brand-maybe-named-color
3093
line-height:
3094
ref: line-height-number-string
3095
3096
- id: brand-typography-options-headings-unified
3097
description: Typographic options for headings.
3098
anyOf:
3099
- string
3100
- object:
3101
closed: true
3102
properties:
3103
family: string
3104
weight:
3105
ref: brand-font-weight
3106
style:
3107
ref: brand-font-style
3108
color:
3109
ref: brand-maybe-named-color-light-dark
3110
line-height:
3111
ref: line-height-number-string
3112
3113
- id: brand-typography-options-monospace-single
3114
description: Typographic options for monospace elements.
3115
anyOf:
3116
- string
3117
- object:
3118
closed: true
3119
properties:
3120
family: string
3121
size: string
3122
weight:
3123
ref: brand-font-weight
3124
color:
3125
ref: brand-maybe-named-color
3126
background-color:
3127
ref: brand-maybe-named-color
3128
3129
- id: brand-typography-options-monospace-unified
3130
description: Typographic options for monospace elements.
3131
anyOf:
3132
- string
3133
- object:
3134
closed: true
3135
properties:
3136
family: string
3137
size: string
3138
weight:
3139
ref: brand-font-weight
3140
color:
3141
ref: brand-maybe-named-color-light-dark
3142
background-color:
3143
ref: brand-maybe-named-color-light-dark
3144
3145
- id: brand-typography-options-monospace-inline-single
3146
description: Typographic options for inline monospace elements.
3147
anyOf:
3148
- string
3149
- object:
3150
closed: true
3151
properties:
3152
family: string
3153
size: string
3154
weight:
3155
ref: brand-font-weight
3156
color:
3157
ref: brand-maybe-named-color
3158
background-color:
3159
ref: brand-maybe-named-color
3160
3161
- id: brand-typography-options-monospace-inline-unified
3162
description: Typographic options for inline monospace elements.
3163
anyOf:
3164
- string
3165
- object:
3166
closed: true
3167
properties:
3168
family: string
3169
size: string
3170
weight:
3171
ref: brand-font-weight
3172
color:
3173
ref: brand-maybe-named-color-light-dark
3174
background-color:
3175
ref: brand-maybe-named-color-light-dark
3176
3177
- id: line-height-number-string
3178
description: Line height
3179
anyOf: [number, string]
3180
3181
- id: brand-typography-options-monospace-block-single
3182
description: Typographic options for block monospace elements.
3183
anyOf:
3184
- string
3185
- object:
3186
closed: true
3187
properties:
3188
family: string
3189
size: string
3190
weight:
3191
ref: brand-font-weight
3192
color:
3193
ref: brand-maybe-named-color
3194
background-color:
3195
ref: brand-maybe-named-color
3196
line-height:
3197
ref: line-height-number-string
3198
3199
- id: brand-typography-options-monospace-block-unified
3200
description: Typographic options for block monospace elements.
3201
anyOf:
3202
- string
3203
- object:
3204
closed: true
3205
properties:
3206
family: string
3207
size: string
3208
weight:
3209
ref: brand-font-weight
3210
color:
3211
ref: brand-maybe-named-color-light-dark
3212
background-color:
3213
ref: brand-maybe-named-color-light-dark
3214
line-height:
3215
ref: line-height-number-string
3216
3217
- id: brand-typography-options-link-single
3218
description: Typographic options for inline monospace elements.
3219
anyOf:
3220
- string
3221
- object:
3222
closed: true
3223
properties:
3224
weight:
3225
ref: brand-font-weight
3226
color:
3227
ref: brand-maybe-named-color
3228
background-color:
3229
ref: brand-maybe-named-color
3230
decoration: string
3231
3232
- id: brand-typography-options-link-unified
3233
description: Typographic options for inline monospace elements.
3234
anyOf:
3235
- string
3236
- object:
3237
closed: true
3238
properties:
3239
weight:
3240
ref: brand-font-weight
3241
color:
3242
ref: brand-maybe-named-color-light-dark
3243
background-color:
3244
ref: brand-maybe-named-color-light-dark
3245
decoration: string
3246
3247
- id: brand-named-typography-elements
3248
description: Names of customizeable typography elements
3249
enum: [base, headings, monospace, monospace-inline, monospace-block, link]
3250
3251
- id: brand-font
3252
description: Font files and definitions for the brand.
3253
anyOf:
3254
- ref: brand-font-google
3255
- ref: brand-font-bunny
3256
- ref: brand-font-file
3257
- ref: brand-font-system
3258
# a font definition missing source information,
3259
# from which we will assume a default source
3260
#
3261
# in Quarto, the default source for typst is `google`
3262
# and the default source for html formats is `bunny`
3263
3264
- id: brand-font-weight
3265
description: A font weight.
3266
enum:
3267
[
3268
100,
3269
200,
3270
300,
3271
400,
3272
500,
3273
600,
3274
700,
3275
800,
3276
900,
3277
thin,
3278
extra-light,
3279
ultra-light,
3280
light,
3281
normal,
3282
regular,
3283
medium,
3284
semi-bold,
3285
demi-bold,
3286
bold,
3287
extra-bold,
3288
ultra-bold,
3289
black,
3290
]
3291
default: 400
3292
3293
- id: brand-font-style
3294
description: A font style.
3295
enum: [normal, italic, oblique]
3296
default: normal
3297
3298
- id: brand-font-common
3299
schema:
3300
object:
3301
closed: true
3302
properties:
3303
family:
3304
description: The font family name, which must match the name of the font on the foundry website.
3305
schema: string
3306
weight:
3307
description: The font weights to include.
3308
maybeArrayOf:
3309
ref: brand-font-weight
3310
default: [400, 700]
3311
style:
3312
description: The font styles to include.
3313
maybeArrayOf:
3314
ref: brand-font-style
3315
default: [normal, italic]
3316
display:
3317
description: >
3318
The font display method, determines how a font face is font face is shown
3319
depending on its download status and readiness for use.
3320
enum: [auto, block, swap, fallback, optional]
3321
default: swap
3322
3323
- id: brand-font-system
3324
description: A system font definition.
3325
object:
3326
super:
3327
resolveRef: brand-font-common
3328
closed: true
3329
properties:
3330
source:
3331
enum: [system]
3332
required: [source]
3333
3334
- id: brand-font-google
3335
description: A font definition from Google Fonts.
3336
object:
3337
super:
3338
resolveRef: brand-font-common
3339
closed: true
3340
properties:
3341
source:
3342
enum: [google]
3343
required: [source]
3344
3345
- id: brand-font-bunny
3346
description: A font definition from fonts.bunny.net.
3347
object:
3348
super:
3349
resolveRef: brand-font-common
3350
closed: true
3351
properties:
3352
source:
3353
enum: [bunny]
3354
required: [source]
3355
3356
- id: brand-font-file
3357
description: A method for providing font files directly, either locally or from an online location.
3358
object:
3359
closed: true
3360
properties:
3361
source:
3362
enum: [file]
3363
family:
3364
description: The font family name.
3365
schema: string
3366
files:
3367
arrayOf:
3368
anyOf:
3369
- path
3370
- schema:
3371
object:
3372
properties:
3373
path:
3374
schema: path
3375
description: >
3376
The path to the font file. This can be a local path or a URL.
3377
weight:
3378
ref: brand-font-weight
3379
style:
3380
ref: brand-font-style
3381
required:
3382
[path]
3383
# We might want to eventually support these but not on 1.0
3384
#
3385
# display:
3386
# description: >
3387
# The font display method, determines how a font face is font face is shown
3388
# depending on its download status and readiness for use.
3389
# enum: [auto, block, swap, fallback, optional]
3390
# default: swap
3391
# unicode-range:
3392
# description: >
3393
# The range of unicode characters included in the font. Examples:
3394
# - `U+0025-00FF` includes all characters from `U+0025` to `U+00FF`.
3395
# - `U+0131,U+0152-0153` includes the characters `U+0131`, `U+0152`, and `U+0153`.
3396
# schema:
3397
# string:
3398
# pattern: '^U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?(?:,U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?)*$'
3399
description: >
3400
The font files to include. These can be local or online.
3401
Local file paths should be relative to the `brand.yml` file.
3402
Online paths should be complete URLs.
3403
required: [files, family, source]
3404
3405
- id: brand-font-family
3406
description: >
3407
A locally-installed font family name. When used, the end-user is responsible
3408
for ensuring that the font is installed on their system.
3409
schema: string
3410
3411
- id: brand-single
3412
object:
3413
closed: true
3414
properties:
3415
meta:
3416
ref: brand-meta
3417
logo:
3418
ref: brand-logo-single
3419
color:
3420
ref: brand-color-single
3421
typography:
3422
ref: brand-typography-single
3423
defaults:
3424
ref: brand-defaults
3425
3426
- id: brand-unified
3427
object:
3428
closed: true
3429
properties:
3430
meta:
3431
ref: brand-meta
3432
logo:
3433
ref: brand-logo-unified
3434
color:
3435
ref: brand-color-unified
3436
typography:
3437
ref: brand-typography-unified
3438
defaults:
3439
ref: brand-defaults
3440
3441
- id: brand-path-only-light-dark
3442
anyOf:
3443
- string
3444
- object:
3445
closed: true
3446
properties:
3447
light: string
3448
dark: string
3449
description: |
3450
A path to a brand.yml file, or an object with light and dark paths to brand.yml
3451
3452
- id: brand-path-bool-light-dark
3453
anyOf:
3454
- string # a file path
3455
- boolean # if false, don't use branding on this document
3456
- object:
3457
closed: true
3458
properties:
3459
light:
3460
anyOf:
3461
- string
3462
- ref: brand-single
3463
description: >
3464
The path to a light brand file or an inline light brand definition.
3465
dark:
3466
anyOf:
3467
- string
3468
- ref: brand-single
3469
description: >
3470
The path to a dark brand file or an inline dark brand definition.
3471
- ref: brand-unified
3472
description: |
3473
Branding information to use for this document. If a string, the path to a brand file.
3474
If false, don't use branding on this document. If an object, an inline (unified) brand
3475
definition, or an object with light and dark brand paths or definitions.
3476
3477
- id: brand-defaults
3478
object:
3479
properties:
3480
bootstrap:
3481
ref: brand-defaults-bootstrap
3482
quarto:
3483
schema: object
3484
3485
- id: brand-defaults-bootstrap
3486
object:
3487
properties:
3488
defaults:
3489
schema:
3490
object:
3491
additionalProperties:
3492
schema:
3493
anyOf:
3494
- string
3495
- boolean
3496
- number
3497
- id: marginalia-side-geometry
3498
object:
3499
closed: true
3500
properties:
3501
far:
3502
string:
3503
description: "Distance from page edge to wideblock boundary."
3504
width:
3505
string:
3506
description: "Width of the margin note column."
3507
separation:
3508
string:
3509
description: "Gap between margin column and body text."
3510
3511
# - id: quarto-extension
3512
3513