Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
quarto-dev
GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/editor/tools/yaml/yaml-intelligence-resources.json
12923 views
1
{
2
"schema/cell-attributes.yml": [
3
{
4
"name": "label",
5
"schema": "string",
6
"description": {
7
"short": "Unique label for code cell",
8
"long": "Unique label for code cell. Used when other code needs to refer to the cell \n(e.g. for cross references `fig-samples` or `tbl-summary`)\n"
9
}
10
},
11
{
12
"name": "classes",
13
"schema": "string",
14
"description": "Classes to apply to cell container"
15
},
16
{
17
"name": "renderings",
18
"schema": {
19
"arrayOf": "string"
20
},
21
"description": "Array of rendering names, e.g. `[light, dark]`"
22
},
23
{
24
"name": "tags",
25
"tags": {
26
"engine": "jupyter"
27
},
28
"schema": {
29
"arrayOf": "string"
30
},
31
"description": "Array of tags for notebook cell"
32
},
33
{
34
"name": "id",
35
"tags": {
36
"engine": "jupyter"
37
},
38
"schema": "string",
39
"description": {
40
"short": "Notebook cell identifier",
41
"long": "Notebook cell identifier. Note that if there is no cell `id` then `label` \nwill be used as the cell `id` if it is present.\nSee <https://jupyter.org/enhancement-proposals/62-cell-id/cell-id.html>\nfor additional details on cell ids.\n"
42
}
43
},
44
{
45
"name": "export",
46
"tags": {
47
"engine": "jupyter"
48
},
49
"schema": null,
50
"hidden": true,
51
"description": "nbconvert tag to export cell"
52
}
53
],
54
"schema/cell-cache.yml": [
55
{
56
"name": "cache",
57
"tags": {
58
"engine": "knitr"
59
},
60
"schema": "boolean",
61
"default": false,
62
"description": {
63
"short": "Whether to cache a code chunk.",
64
"long": "Whether to cache a code chunk. When evaluating\ncode chunks for the second time, the cached chunks are skipped (unless they\nhave been modified), but the objects created in these chunks are loaded from\npreviously saved databases (`.rdb` and `.rdx` files), and these files are\nsaved when a chunk is evaluated for the first time, or when cached files are\nnot found (e.g., you may have removed them by hand). Note that the filename\nconsists of the chunk label with an MD5 digest of the R code and chunk\noptions of the code chunk, which means any changes in the chunk will produce\na different MD5 digest, and hence invalidate the cache.\n"
65
}
66
},
67
{
68
"name": "cache-path",
69
"hidden": true,
70
"tags": {
71
"engine": "knitr"
72
},
73
"schema": "path",
74
"description": "A prefix to be used to generate the paths of cache files"
75
},
76
{
77
"name": "cache-vars",
78
"tags": {
79
"engine": "knitr"
80
},
81
"schema": {
82
"maybeArrayOf": "string"
83
},
84
"description": {
85
"short": "Variable names to be saved in the cache database.",
86
"long": "Variable names to be saved in\nthe cache database. By default, all variables created in the current chunks\nare identified and saved, but you may want to manually specify the variables\nto be saved, because the automatic detection of variables may not be robust,\nor you may want to save only a subset of variables.\n"
87
}
88
},
89
{
90
"name": "cache-globals",
91
"tags": {
92
"engine": "knitr"
93
},
94
"schema": "string",
95
"description": {
96
"short": "Variables names that are not created from the current chunk",
97
"long": "Variables names that are not created from the current chunk.\n\nThis option is mainly for `autodep: true` to work more precisely---a chunk\n`B` depends on chunk `A` when any of `B`'s global variables are `A`'s local \nvariables. In case the automatic detection of global variables in a chunk \nfails, you may manually specify the names of global variables via this option.\nIn addition, `cache-globals: false` means detecting all variables in a code\nchunk, no matter if they are global or local variables.\n"
98
}
99
},
100
{
101
"name": "cache-lazy",
102
"tags": {
103
"engine": "knitr"
104
},
105
"schema": "boolean",
106
"default": true,
107
"description": {
108
"short": "Whether to `lazyLoad()` or directly `load()` objects",
109
"long": "Whether to `lazyLoad()` or directly `load()` objects. For very large objects, \nlazyloading may not work, so `cache-lazy: false` may be desirable (see\n[#572](https://github.com/yihui/knitr/issues/572)).\n"
110
}
111
},
112
{
113
"name": "cache-rebuild",
114
"tags": {
115
"engine": "knitr"
116
},
117
"schema": "boolean",
118
"default": false,
119
"description": "Force rebuild of cache for chunk"
120
},
121
{
122
"name": "cache-comments",
123
"tags": {
124
"engine": "knitr"
125
},
126
"schema": "boolean",
127
"default": true,
128
"description": "Prevent comment changes from invalidating the cache for a chunk"
129
},
130
{
131
"name": "dependson",
132
"tags": {
133
"engine": "knitr"
134
},
135
"schema": {
136
"anyOf": [
137
{
138
"maybeArrayOf": "string"
139
},
140
{
141
"maybeArrayOf": "number"
142
}
143
]
144
},
145
"description": "Explicitly specify cache dependencies for this chunk (one or more chunk labels)\n"
146
},
147
{
148
"name": "autodep",
149
"tags": {
150
"engine": "knitr"
151
},
152
"schema": "boolean",
153
"default": false,
154
"description": "Detect cache dependencies automatically via usage of global variables"
155
}
156
],
157
"schema/cell-card.yml": [
158
{
159
"name": "title",
160
"tags": {
161
"formats": [
162
"dashboard"
163
]
164
},
165
"schema": "string",
166
"description": {
167
"short": "Title displayed in dashboard card header"
168
}
169
},
170
{
171
"name": "padding",
172
"tags": {
173
"formats": [
174
"dashboard"
175
]
176
},
177
"schema": {
178
"anyOf": [
179
"string",
180
"number"
181
]
182
},
183
"description": {
184
"short": "Padding around dashboard card content (default `8px`)"
185
}
186
},
187
{
188
"name": "expandable",
189
"tags": {
190
"formats": [
191
"dashboard"
192
]
193
},
194
"schema": "boolean",
195
"default": true,
196
"description": {
197
"short": "Make dashboard card content expandable (default: `true`)"
198
}
199
},
200
{
201
"name": "width",
202
"tags": {
203
"formats": [
204
"dashboard"
205
]
206
},
207
"schema": {
208
"anyOf": [
209
"string",
210
"number"
211
]
212
},
213
"description": {
214
"short": "Percentage or absolute pixel width for dashboard card (defaults to evenly spaced across row)"
215
}
216
},
217
{
218
"name": "height",
219
"tags": {
220
"formats": [
221
"dashboard"
222
]
223
},
224
"schema": {
225
"anyOf": [
226
"string",
227
"number"
228
]
229
},
230
"description": {
231
"short": "Percentage or absolute pixel height for dashboard card (defaults to evenly spaced across column)"
232
}
233
},
234
{
235
"name": "context",
236
"tags": {
237
"formats": [
238
"dashboard"
239
],
240
"engine": [
241
"jupyter"
242
]
243
},
244
"schema": "string",
245
"description": {
246
"short": "Context to execute cell within."
247
}
248
},
249
{
250
"name": "content",
251
"tags": {
252
"formats": [
253
"dashboard"
254
]
255
},
256
"schema": {
257
"enum": [
258
"valuebox",
259
"sidebar",
260
"toolbar",
261
"card-sidebar",
262
"card-toolbar"
263
]
264
},
265
"description": {
266
"short": "The type of dashboard element being produced by this code cell."
267
}
268
},
269
{
270
"name": "color",
271
"tags": {
272
"formats": [
273
"dashboard"
274
]
275
},
276
"schema": {
277
"anyOf": [
278
"string",
279
{
280
"enum": [
281
"primary",
282
"secondary",
283
"success",
284
"info",
285
"warning",
286
"danger",
287
"light",
288
"dark"
289
]
290
}
291
]
292
},
293
"description": {
294
"short": "For code cells that produce a valuebox, the color of the valuebox.s"
295
}
296
}
297
],
298
"schema/cell-codeoutput.yml": [
299
{
300
"name": "eval",
301
"tags": {
302
"contexts": [
303
"document-execute"
304
],
305
"execute-only": true
306
},
307
"schema": "boolean",
308
"default": true,
309
"description": {
310
"short": "Evaluate code cells (if `false` just echos the code into output).",
311
"long": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
312
}
313
},
314
{
315
"name": "echo",
316
"tags": {
317
"contexts": [
318
"document-execute"
319
],
320
"execute-only": true
321
},
322
"schema": {
323
"anyOf": [
324
"boolean",
325
{
326
"enum": [
327
"fenced"
328
]
329
}
330
],
331
"errorDescription": "be `true`, `false`, or `fenced`"
332
},
333
"description": {
334
"short": "Include cell source code in rendered output.",
335
"long": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: in addition to echoing, include the cell delimiter as part of the output.\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
336
}
337
},
338
{
339
"name": "code-fold",
340
"tags": {
341
"contexts": [
342
"document-code"
343
],
344
"formats": [
345
"$html-all"
346
]
347
},
348
"schema": {
349
"anyOf": [
350
"boolean",
351
{
352
"enum": [
353
"show"
354
]
355
}
356
]
357
},
358
"default": false,
359
"description": {
360
"short": "Collapse code into an HTML `<details>` tag so the user can display it on-demand.",
361
"long": "Collapse code into an HTML `<details>` tag so the user can display it on-demand.\n\n- `true`: collapse code\n- `false` (default): do not collapse code\n- `show`: use the `<details>` tag, but show the expanded code initially.\n"
362
}
363
},
364
{
365
"name": "code-summary",
366
"tags": {
367
"contexts": [
368
"document-code"
369
],
370
"formats": [
371
"$html-all"
372
]
373
},
374
"schema": "string",
375
"default": "Code",
376
"description": "Summary text to use for code blocks collapsed using `code-fold`"
377
},
378
{
379
"name": "code-overflow",
380
"tags": {
381
"contexts": [
382
"document-code"
383
],
384
"formats": [
385
"$html-all"
386
]
387
},
388
"schema": {
389
"enum": [
390
"scroll",
391
"wrap"
392
]
393
},
394
"default": "scroll",
395
"description": {
396
"short": "Choose whether to `scroll` or `wrap` when code lines are too wide for their container.",
397
"long": "Choose how to handle code overflow, when code lines are too wide for their container. One of:\n\n- `scroll`\n- `wrap`\n"
398
}
399
},
400
{
401
"name": "code-line-numbers",
402
"tags": {
403
"contexts": [
404
"document-code"
405
],
406
"formats": [
407
"$html-all",
408
"ms",
409
"$pdf-all"
410
]
411
},
412
"schema": {
413
"anyOf": [
414
"boolean",
415
"string"
416
],
417
"tags": {
418
"doNotNarrowError": true
419
},
420
"errorDescription": "be `true`, `false`, or a string specifying the lines to highlight"
421
},
422
"default": false,
423
"description": {
424
"short": "Include line numbers in code block output (`true` or `false`)",
425
"long": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n * `3,4,5`\n * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n * `1-3,5` \n * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n * `1-3|1-3,5` first shows `1-3`, then `1-3,5`\n * `|5|5-10,12` first shows no numbering, then 5, then lines 5-10\n and 12\n"
426
}
427
},
428
{
429
"name": "lst-label",
430
"schema": "string",
431
"description": "Unique label for code listing (used in cross references)"
432
},
433
{
434
"name": "lst-cap",
435
"schema": "string",
436
"description": "Caption for code listing"
437
},
438
{
439
"name": "tidy",
440
"tags": {
441
"engine": "knitr"
442
},
443
"schema": {
444
"anyOf": [
445
"boolean",
446
{
447
"enum": [
448
"styler",
449
"formatR"
450
]
451
}
452
]
453
},
454
"default": false,
455
"description": "Whether to reformat R code."
456
},
457
{
458
"name": "tidy-opts",
459
"tags": {
460
"engine": "knitr"
461
},
462
"schema": {
463
"arrayOf": "string"
464
},
465
"description": "List of options to pass to `tidy` handler"
466
},
467
{
468
"name": "collapse",
469
"tags": {
470
"engine": "knitr"
471
},
472
"schema": "boolean",
473
"default": false,
474
"description": "Collapse all the source and output blocks from one code chunk into a single block\n"
475
},
476
{
477
"name": "prompt",
478
"tags": {
479
"engine": "knitr"
480
},
481
"schema": "boolean",
482
"default": false,
483
"description": {
484
"short": "Whether to add the prompt characters in R code.",
485
"long": "Whether to add the prompt characters in R\ncode. See `prompt` and `continue` on the help page `?base::options`. Note\nthat adding prompts can make it difficult for readers to copy R code from\nthe output, so `prompt: false` may be a better choice. This option may not\nwork well when the `engine` is not `R`\n([#1274](https://github.com/yihui/knitr/issues/1274)).\n"
486
}
487
},
488
{
489
"name": "highlight",
490
"tags": {
491
"engine": "knitr"
492
},
493
"schema": "boolean",
494
"default": false,
495
"hidden": true,
496
"description": "Whether to syntax highlight the source code"
497
},
498
{
499
"name": "class-source",
500
"tags": {
501
"engine": "knitr"
502
},
503
"schema": {
504
"maybeArrayOf": "string"
505
},
506
"description": "Class name(s) for source code blocks"
507
},
508
{
509
"name": "attr-source",
510
"tags": {
511
"engine": "knitr"
512
},
513
"schema": {
514
"maybeArrayOf": "string"
515
},
516
"description": "Attribute(s) for source code blocks"
517
}
518
],
519
"schema/cell-figure.yml": [
520
{
521
"name": "fig-width",
522
"tags": {
523
"engine": "knitr"
524
},
525
"schema": "number",
526
"description": "Default width for figures"
527
},
528
{
529
"name": "fig-height",
530
"tags": {
531
"engine": "knitr"
532
},
533
"schema": "number",
534
"description": "Default height for figures"
535
},
536
{
537
"name": "fig-cap",
538
"schema": {
539
"maybeArrayOf": "string"
540
},
541
"description": "Figure caption"
542
},
543
{
544
"name": "fig-subcap",
545
"schema": {
546
"anyOf": [
547
{
548
"enum": [
549
true
550
]
551
},
552
{
553
"maybeArrayOf": "string"
554
}
555
]
556
},
557
"description": "Figure subcaptions"
558
},
559
{
560
"name": "fig-link",
561
"schema": {
562
"maybeArrayOf": "string"
563
},
564
"description": "Hyperlink target for the figure"
565
},
566
{
567
"name": "fig-align",
568
"tags": {
569
"contexts": [
570
"document-figures"
571
],
572
"formats": [
573
"docx",
574
"rtf",
575
"$odt-all",
576
"$pdf-all",
577
"$html-all"
578
]
579
},
580
"schema": {
581
"maybeArrayOf": {
582
"enum": [
583
"default",
584
"left",
585
"right",
586
"center"
587
]
588
}
589
},
590
"default": "default",
591
"description": "Figure horizontal alignment (`default`, `left`, `right`, or `center`)"
592
},
593
{
594
"name": "fig-alt",
595
"tags": {
596
"formats": [
597
"$html-all"
598
]
599
},
600
"schema": {
601
"maybeArrayOf": "string"
602
},
603
"description": "Alternative text to be used in the `alt` attribute of HTML images.\n"
604
},
605
{
606
"name": "fig-env",
607
"tags": {
608
"formats": [
609
"$pdf-all"
610
],
611
"contexts": [
612
"document-figures"
613
]
614
},
615
"schema": {
616
"maybeArrayOf": "string"
617
},
618
"description": "LaTeX environment for figure output"
619
},
620
{
621
"name": "fig-pos",
622
"tags": {
623
"formats": [
624
"$pdf-all"
625
],
626
"contexts": [
627
"document-figures"
628
]
629
},
630
"schema": {
631
"anyOf": [
632
{
633
"maybeArrayOf": "string"
634
},
635
{
636
"enum": [
637
false
638
]
639
}
640
]
641
},
642
"description": {
643
"short": "LaTeX figure position arrangement to be used in `\\begin{figure}[]`.",
644
"long": "LaTeX figure position arrangement to be used in `\\begin{figure}[]`.\n\nComputational figure output that is accompanied by the code \nthat produced it is given a default value of `fig-pos=\"H\"` (so \nthat the code and figure are not inordinately separated).\n\nIf `fig-pos` is `false`, then we don't use any figure position\nspecifier, which is sometimes necessary with custom figure\nenvironments (such as `sidewaysfigure`).\n"
645
}
646
},
647
{
648
"name": "fig-scap",
649
"tags": {
650
"formats": [
651
"$pdf-all"
652
]
653
},
654
"schema": {
655
"maybeArrayOf": "string"
656
},
657
"description": {
658
"short": "A short caption (only used in LaTeX output)",
659
"long": "A short caption (only used in LaTeX output). A short caption is inserted in `\\caption[]`, \nand usually displayed in the “List of Figures” of a PDF document.\n"
660
}
661
},
662
{
663
"name": "fig-format",
664
"tags": {
665
"engine": "knitr"
666
},
667
"schema": {
668
"enum": [
669
"retina",
670
"png",
671
"jpeg",
672
"svg",
673
"pdf"
674
]
675
},
676
"description": "Default output format for figures (`retina`, `png`, `jpeg`, `svg`, or `pdf`)"
677
},
678
{
679
"name": "fig-dpi",
680
"tags": {
681
"engine": "knitr"
682
},
683
"schema": "number",
684
"description": "Default DPI for figures"
685
},
686
{
687
"name": "fig-asp",
688
"tags": {
689
"engine": "knitr"
690
},
691
"schema": "number",
692
"description": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified, the height of a plot \n(the option `fig-height`) is calculated from `fig-width * fig-asp`.\n"
693
},
694
{
695
"name": "out-width",
696
"tags": {
697
"engine": "knitr"
698
},
699
"schema": {
700
"anyOf": [
701
"string",
702
{
703
"schema": {
704
"null": {
705
"completions": []
706
}
707
}
708
}
709
]
710
},
711
"description": {
712
"short": "Width of plot in the output document",
713
"long": "Width of the plot in the output document, which can be different from its physical `fig-width`,\ni.e., plots can be scaled in the output document.\nWhen used without a unit, the unit is assumed to be pixels. However, any of the following unit \nidentifiers can be used: px, cm, mm, in, inch and %, for example, `3in`, `8cm`, `300px` or `50%`.\n"
714
}
715
},
716
{
717
"name": "out-height",
718
"tags": {
719
"engine": "knitr"
720
},
721
"schema": "string",
722
"description": {
723
"short": "Height of plot in the output document",
724
"long": "Height of the plot in the output document, which can be different from its physical `fig-height`, \ni.e., plots can be scaled in the output document.\nDepending on the output format, this option can take special values.\nFor example, for LaTeX output, it can be `3in`, or `8cm`;\nfor HTML, it can be `300px`.\n"
725
}
726
},
727
{
728
"name": "fig-keep",
729
"tags": {
730
"engine": "knitr"
731
},
732
"schema": {
733
"anyOf": [
734
{
735
"enum": [
736
"high",
737
"none",
738
"all",
739
"first",
740
"last"
741
]
742
},
743
{
744
"maybeArrayOf": "number"
745
}
746
]
747
},
748
"default": "high",
749
"description": {
750
"short": "How plots in chunks should be kept.",
751
"long": "How plots in chunks should be kept. Possible values are as follows:\n\n- `high`: Only keep high-level plots (merge low-level changes into\n high-level plots).\n- `none`: Discard all plots.\n- `all`: Keep all plots (low-level plot changes may produce new plots).\n- `first`: Only keep the first plot.\n- `last`: Only keep the last plot.\n- A numeric vector: In this case, the values are indices of (low-level) plots\n to keep.\n"
752
}
753
},
754
{
755
"name": "fig-show",
756
"tags": {
757
"engine": "knitr"
758
},
759
"schema": {
760
"enum": [
761
"asis",
762
"hold",
763
"animate",
764
"hide"
765
]
766
},
767
"default": "asis",
768
"description": {
769
"short": "How to show/arrange the plots",
770
"long": "How to show/arrange the plots. Possible values are as follows:\n\n- `asis`: Show plots exactly in places where they were generated (as if\n the code were run in an R terminal).\n- `hold`: Hold all plots and output them at the end of a code chunk.\n- `animate`: Concatenate all plots into an animation if there are multiple\n plots in a chunk.\n- `hide`: Generate plot files but hide them in the output document.\n"
771
}
772
},
773
{
774
"name": "out-extra",
775
"tags": {
776
"engine": "knitr"
777
},
778
"schema": "string",
779
"description": "Additional raw LaTeX or HTML options to be applied to figures"
780
},
781
{
782
"name": "external",
783
"tags": {
784
"engine": "knitr",
785
"formats": [
786
"$pdf-all"
787
]
788
},
789
"schema": "boolean",
790
"default": true,
791
"description": "Externalize tikz graphics (pre-compile to PDF)"
792
},
793
{
794
"name": "sanitize",
795
"tags": {
796
"engine": "knitr",
797
"formats": [
798
"$pdf-all"
799
]
800
},
801
"schema": "boolean",
802
"default": false,
803
"description": "sanitize tikz graphics (escape special LaTeX characters)."
804
},
805
{
806
"name": "interval",
807
"tags": {
808
"engine": "knitr"
809
},
810
"schema": "number",
811
"default": 1,
812
"description": "Time interval (number of seconds) between animation frames."
813
},
814
{
815
"name": "aniopts",
816
"tags": {
817
"engine": "knitr"
818
},
819
"schema": "string",
820
"default": "controls, loop",
821
"description": {
822
"short": "Extra options for animations",
823
"long": "Extra options for animations; see the documentation of the LaTeX [**animate**\npackage.](http://ctan.org/pkg/animate)\n"
824
}
825
},
826
{
827
"name": "animation-hook",
828
"tags": {
829
"engine": "knitr"
830
},
831
"schema": {
832
"string": {
833
"completions": [
834
"ffmpeg",
835
"gifski"
836
]
837
}
838
},
839
"default": "ffmpeg",
840
"description": {
841
"short": "Hook function to create animations in HTML output",
842
"long": "Hook function to create animations in HTML output. \n\nThe default hook (`ffmpeg`) uses FFmpeg to convert images to a WebM video.\n\nAnother hook function is `gifski` based on the\n[**gifski**](https://cran.r-project.org/package=gifski) package to\ncreate GIF animations.\n"
843
}
844
}
845
],
846
"schema/cell-include.yml": [
847
{
848
"name": "child",
849
"tags": {
850
"engine": "knitr"
851
},
852
"schema": {
853
"maybeArrayOf": "path"
854
},
855
"description": "One or more paths of child documents to be knitted and input into the main document."
856
},
857
{
858
"name": "file",
859
"tags": {
860
"engine": "knitr"
861
},
862
"schema": "path",
863
"description": "File containing code to execute for this chunk"
864
},
865
{
866
"name": "code",
867
"tags": {
868
"engine": "knitr"
869
},
870
"schema": "string",
871
"description": "String containing code to execute for this chunk"
872
},
873
{
874
"name": "purl",
875
"tags": {
876
"engine": "knitr"
877
},
878
"schema": "boolean",
879
"default": true,
880
"description": "Include chunk when extracting code with `knitr::purl()`"
881
}
882
],
883
"schema/cell-layout.yml": [
884
{
885
"name": "layout",
886
"schema": {
887
"anyOf": [
888
"string",
889
{
890
"arrayOf": {
891
"arrayOf": "number"
892
}
893
}
894
]
895
},
896
"description": {
897
"short": "2d-array of widths where the first dimension specifies columns and the second rows.",
898
"long": "2d-array of widths where the first dimension specifies columns and the second rows.\n\nFor example, to layout the first two output blocks side-by-side on the top with the third\nblock spanning the full width below, use `[[3,3], [1]]`.\n\nUse negative values to create margin. For example, to create space between the \noutput blocks in the top row of the previous example, use `[[3,-1, 3], [1]]`.\n"
899
}
900
},
901
{
902
"name": "layout-ncol",
903
"schema": "number",
904
"description": "Layout output blocks into columns"
905
},
906
{
907
"name": "layout-nrow",
908
"schema": "number",
909
"description": "Layout output blocks into rows"
910
},
911
{
912
"name": "layout-align",
913
"schema": {
914
"enum": [
915
"default",
916
"left",
917
"center",
918
"right"
919
]
920
},
921
"default": "center",
922
"description": "Horizontal alignment for layout content (`default`, `left`, `right`, or `center`)"
923
},
924
{
925
"name": "layout-valign",
926
"schema": {
927
"enum": [
928
"default",
929
"top",
930
"center",
931
"bottom"
932
]
933
},
934
"default": "top",
935
"description": "Vertical alignment for layout content (`default`, `top`, `center`, or `bottom`)"
936
}
937
],
938
"schema/cell-pagelayout.yml": [
939
{
940
"name": "column",
941
"schema": {
942
"ref": "page-column"
943
},
944
"description": {
945
"short": "Page column for output",
946
"long": "[Page column](https://quarto.org/docs/authoring/article-layout.html) for output"
947
}
948
},
949
{
950
"name": "fig-column",
951
"schema": {
952
"ref": "page-column"
953
},
954
"description": {
955
"short": "Page column for figure output",
956
"long": "[Page column](https://quarto.org/docs/authoring/article-layout.html) for figure output"
957
}
958
},
959
{
960
"name": "tbl-column",
961
"schema": {
962
"ref": "page-column"
963
},
964
"description": {
965
"short": "Page column for table output",
966
"long": "[Page column](https://quarto.org/docs/authoring/article-layout.html) for table output"
967
}
968
},
969
{
970
"name": "cap-location",
971
"tags": {
972
"contexts": [
973
"document-layout"
974
],
975
"formats": [
976
"$html-files",
977
"$pdf-all",
978
"typst"
979
]
980
},
981
"schema": {
982
"enum": [
983
"top",
984
"bottom",
985
"margin"
986
]
987
},
988
"default": "bottom",
989
"description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)"
990
},
991
{
992
"name": "fig-cap-location",
993
"tags": {
994
"contexts": [
995
"document-layout",
996
"document-figures"
997
],
998
"formats": [
999
"$html-files",
1000
"$pdf-all",
1001
"typst"
1002
]
1003
},
1004
"schema": {
1005
"enum": [
1006
"top",
1007
"bottom",
1008
"margin"
1009
]
1010
},
1011
"default": "bottom",
1012
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)"
1013
},
1014
{
1015
"name": "tbl-cap-location",
1016
"tags": {
1017
"contexts": [
1018
"document-layout",
1019
"document-tables"
1020
],
1021
"formats": [
1022
"$html-files",
1023
"$pdf-all",
1024
"typst"
1025
]
1026
},
1027
"schema": {
1028
"enum": [
1029
"top",
1030
"bottom",
1031
"margin"
1032
]
1033
},
1034
"default": "top",
1035
"description": "Where to place table captions (`top`, `bottom`, or `margin`)"
1036
}
1037
],
1038
"schema/cell-table.yml": [
1039
{
1040
"name": "tbl-cap",
1041
"schema": {
1042
"maybeArrayOf": "string"
1043
},
1044
"description": "Table caption"
1045
},
1046
{
1047
"name": "tbl-subcap",
1048
"schema": {
1049
"anyOf": [
1050
{
1051
"enum": [
1052
true
1053
]
1054
},
1055
{
1056
"maybeArrayOf": "string"
1057
}
1058
]
1059
},
1060
"description": "Table subcaptions"
1061
},
1062
{
1063
"name": "tbl-colwidths",
1064
"tags": {
1065
"contexts": [
1066
"document-tables"
1067
],
1068
"engine": [
1069
"knitr",
1070
"jupyter"
1071
],
1072
"formats": [
1073
"$pdf-all",
1074
"$html-all"
1075
]
1076
},
1077
"schema": {
1078
"anyOf": [
1079
"boolean",
1080
{
1081
"enum": [
1082
"auto"
1083
]
1084
},
1085
{
1086
"arrayOf": "number"
1087
}
1088
]
1089
},
1090
"description": {
1091
"short": "Apply explicit table column widths",
1092
"long": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n"
1093
}
1094
},
1095
{
1096
"name": "html-table-processing",
1097
"schema": {
1098
"enum": [
1099
"none"
1100
]
1101
},
1102
"description": "If `none`, do not process raw HTML table in cell output and leave it as-is"
1103
}
1104
],
1105
"schema/cell-textoutput.yml": [
1106
{
1107
"name": "output",
1108
"tags": {
1109
"contexts": [
1110
"document-execute"
1111
],
1112
"execute-only": true
1113
},
1114
"schema": {
1115
"anyOf": [
1116
"boolean",
1117
{
1118
"enum": [
1119
"asis"
1120
]
1121
},
1122
"string",
1123
"object"
1124
]
1125
},
1126
"description": {
1127
"short": "Include the results of executing the code in the output (specify `asis` to\ntreat output as raw markdown with no enclosing containers).\n",
1128
"long": "Include the results of executing the code in the output. Possible values:\n\n- `true`: Include results.\n- `false`: Do not include results.\n- `asis`: Treat output as raw markdown with no enclosing containers.\n"
1129
}
1130
},
1131
{
1132
"name": "warning",
1133
"tags": {
1134
"contexts": [
1135
"document-execute"
1136
],
1137
"execute-only": true
1138
},
1139
"schema": "boolean",
1140
"description": "Include warnings in rendered output."
1141
},
1142
{
1143
"name": "error",
1144
"tags": {
1145
"contexts": [
1146
"document-execute"
1147
],
1148
"execute-only": true
1149
},
1150
"schema": "boolean",
1151
"default": false,
1152
"description": "Include errors in the output (note that this implies that errors executing code\nwill not halt processing of the document).\n"
1153
},
1154
{
1155
"name": "include",
1156
"tags": {
1157
"contexts": [
1158
"document-execute"
1159
],
1160
"execute-only": true
1161
},
1162
"schema": "boolean",
1163
"default": false,
1164
"description": "Catch all for preventing any output (code or results) from being included in output.\n"
1165
},
1166
{
1167
"name": "panel",
1168
"schema": {
1169
"enum": [
1170
"tabset",
1171
"input",
1172
"sidebar",
1173
"fill",
1174
"center"
1175
]
1176
},
1177
"description": "Panel type for cell output (`tabset`, `input`, `sidebar`, `fill`, `center`)"
1178
},
1179
{
1180
"name": "output-location",
1181
"tags": {
1182
"formats": [
1183
"revealjs"
1184
]
1185
},
1186
"schema": {
1187
"enum": [
1188
"default",
1189
"fragment",
1190
"slide",
1191
"column",
1192
"column-fragment"
1193
]
1194
},
1195
"description": {
1196
"short": "Location of output relative to the code that generated it (`default`, `fragment`, `slide`, `column`, or `column-location`)",
1197
"long": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n"
1198
}
1199
},
1200
{
1201
"name": "message",
1202
"tags": {
1203
"engine": "knitr"
1204
},
1205
"schema": {
1206
"enum": [
1207
true,
1208
false,
1209
"NA"
1210
]
1211
},
1212
"default": true,
1213
"description": {
1214
"short": "Include messages in rendered output.",
1215
"long": "Include messages in rendered output. Possible values are `true`, `false`, or `NA`. \nIf `true`, messages are included in the output. If `false`, messages are not included. \nIf `NA`, messages are not included in output but shown in the knitr log to console.\n"
1216
}
1217
},
1218
{
1219
"name": "results",
1220
"tags": {
1221
"engine": "knitr"
1222
},
1223
"schema": {
1224
"enum": [
1225
"markup",
1226
"asis",
1227
"hold",
1228
"hide",
1229
false
1230
]
1231
},
1232
"default": "markup",
1233
"description": {
1234
"short": "How to display text results",
1235
"long": "How to display text results. Note that this option only applies to normal text output (not warnings,\nmessages, or errors). The possible values are as follows:\n\n- `markup`: Mark up text output with the appropriate environments\n depending on the output format. For example, if the text\n output is a character string `\"[1] 1 2 3\"`, the actual output that\n **knitr** produces will be:\n\n ```` md\n ```\n [1] 1 2 3\n ```\n ````\n\n In this case, `results: markup` means to put the text output in fenced\n code blocks (```` ``` ````).\n\n- `asis`: Write text output as-is, i.e., write the raw text results\n directly into the output document without any markups.\n\n ```` md\n ```{r}\n #| results: asis\n cat(\"I'm raw **Markdown** content.\\n\")\n ```\n ````\n\n- `hold`: Hold all pieces of text output in a chunk and flush them to the\n end of the chunk.\n\n- `hide` (or `false`): Hide text output.\n"
1236
}
1237
},
1238
{
1239
"name": "comment",
1240
"tags": {
1241
"engine": "knitr"
1242
},
1243
"schema": "string",
1244
"default": "##",
1245
"description": {
1246
"short": "Prefix to be added before each line of text output.",
1247
"long": "Prefix to be added before each line of text output.\nBy default, the text output is commented out by `##`, so if\nreaders want to copy and run the source code from the output document, they\ncan select and copy everything from the chunk, since the text output is\nmasked in comments (and will be ignored when running the copied text). Set\n`comment: ''` to remove the default `##`.\n"
1248
}
1249
},
1250
{
1251
"name": "class-output",
1252
"tags": {
1253
"engine": "knitr"
1254
},
1255
"schema": {
1256
"maybeArrayOf": "string"
1257
},
1258
"description": "Class name(s) for text/console output"
1259
},
1260
{
1261
"name": "attr-output",
1262
"tags": {
1263
"engine": "knitr"
1264
},
1265
"schema": {
1266
"maybeArrayOf": "string"
1267
},
1268
"description": "Attribute(s) for text/console output"
1269
},
1270
{
1271
"name": "class-warning",
1272
"tags": {
1273
"engine": "knitr"
1274
},
1275
"schema": {
1276
"maybeArrayOf": "string"
1277
},
1278
"description": "Class name(s) for warning output"
1279
},
1280
{
1281
"name": "attr-warning",
1282
"tags": {
1283
"engine": "knitr"
1284
},
1285
"schema": {
1286
"maybeArrayOf": "string"
1287
},
1288
"description": "Attribute(s) for warning output"
1289
},
1290
{
1291
"name": "class-message",
1292
"tags": {
1293
"engine": "knitr"
1294
},
1295
"schema": {
1296
"maybeArrayOf": "string"
1297
},
1298
"description": "Class name(s) for message output"
1299
},
1300
{
1301
"name": "attr-message",
1302
"tags": {
1303
"engine": "knitr"
1304
},
1305
"schema": {
1306
"maybeArrayOf": "string"
1307
},
1308
"description": "Attribute(s) for message output"
1309
},
1310
{
1311
"name": "class-error",
1312
"tags": {
1313
"engine": "knitr"
1314
},
1315
"schema": {
1316
"maybeArrayOf": "string"
1317
},
1318
"description": "Class name(s) for error output"
1319
},
1320
{
1321
"name": "attr-error",
1322
"tags": {
1323
"engine": "knitr"
1324
},
1325
"schema": {
1326
"maybeArrayOf": "string"
1327
},
1328
"description": "Attribute(s) for error output"
1329
}
1330
],
1331
"schema/definitions.yml": [
1332
{
1333
"id": "date",
1334
"anyOf": [
1335
"string",
1336
{
1337
"object": {
1338
"properties": {
1339
"value": "string",
1340
"format": "string"
1341
},
1342
"required": [
1343
"value"
1344
]
1345
}
1346
}
1347
]
1348
},
1349
{
1350
"id": "date-format",
1351
"schema": "string"
1352
},
1353
{
1354
"id": "math-methods",
1355
"enum": {
1356
"values": [
1357
"plain",
1358
"webtex",
1359
"gladtex",
1360
"mathml",
1361
"mathjax",
1362
"katex"
1363
]
1364
}
1365
},
1366
{
1367
"id": "pandoc-format-request-headers",
1368
"arrayOf": {
1369
"arrayOf": {
1370
"schema": "string",
1371
"length": 2
1372
}
1373
}
1374
},
1375
{
1376
"id": "pandoc-format-output-file",
1377
"anyOf": [
1378
"path",
1379
{
1380
"enum": {
1381
"values": [
1382
null
1383
],
1384
"hidden": true
1385
}
1386
}
1387
]
1388
},
1389
{
1390
"id": "filter-entry-point",
1391
"enum": [
1392
"pre-ast",
1393
"post-ast",
1394
"pre-quarto",
1395
"post-quarto",
1396
"pre-render",
1397
"post-render",
1398
"pre-finalize",
1399
"post-finalize"
1400
]
1401
},
1402
{
1403
"id": "pandoc-format-filters",
1404
"arrayOf": {
1405
"anyOf": [
1406
"path",
1407
{
1408
"object": {
1409
"properties": {
1410
"type": "string",
1411
"path": "path"
1412
},
1413
"required": [
1414
"path"
1415
]
1416
}
1417
},
1418
{
1419
"object": {
1420
"properties": {
1421
"type": "string",
1422
"path": "path",
1423
"at": {
1424
"ref": "filter-entry-point"
1425
}
1426
},
1427
"required": [
1428
"path",
1429
"at"
1430
]
1431
}
1432
},
1433
{
1434
"record": {
1435
"type": {
1436
"enum": [
1437
"citeproc"
1438
]
1439
}
1440
}
1441
}
1442
]
1443
}
1444
},
1445
{
1446
"id": "pandoc-shortcodes",
1447
"arrayOf": "path"
1448
},
1449
{
1450
"id": "page-column",
1451
"enum": [
1452
"body",
1453
"body-outset",
1454
"body-outset-left",
1455
"body-outset-right",
1456
"page",
1457
"page-left",
1458
"page-right",
1459
"page-inset",
1460
"page-inset-left",
1461
"page-inset-right",
1462
"screen",
1463
"screen-left",
1464
"screen-right",
1465
"screen-inset",
1466
"screen-inset-shaded",
1467
"screen-inset-left",
1468
"screen-inset-right",
1469
"margin"
1470
]
1471
},
1472
{
1473
"id": "contents-auto",
1474
"object": {
1475
"properties": {
1476
"auto": {
1477
"anyOf": [
1478
"boolean",
1479
{
1480
"maybeArrayOf": "string"
1481
}
1482
],
1483
"description": {
1484
"short": "Automatically generate sidebar contents.",
1485
"long": "Automatically generate sidebar contents. Pass `true` to include all documents\nin the site, a directory name to include only documents in that directory, \nor a glob (or list of globs) to include documents based on a pattern. \n\nSubdirectories will create sections (use an `index.qmd` in the directory to\nprovide its title). Order will be alphabetical unless a numeric `order` field\nis provided in document metadata.\n"
1486
}
1487
}
1488
}
1489
}
1490
},
1491
{
1492
"id": "navigation-item",
1493
"anyOf": [
1494
"path",
1495
{
1496
"ref": "navigation-item-object"
1497
}
1498
]
1499
},
1500
{
1501
"id": "navigation-item-object",
1502
"object": {
1503
"closed": true,
1504
"properties": {
1505
"aria-label": {
1506
"string": {
1507
"description": "Accessible label for the item."
1508
}
1509
},
1510
"file": {
1511
"hidden": true,
1512
"string": {
1513
"description": "Alias for href\n"
1514
}
1515
},
1516
"href": {
1517
"string": {
1518
"description": "Link to file contained with the project or external URL\n"
1519
}
1520
},
1521
"icon": {
1522
"string": {
1523
"description": {
1524
"short": "Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)",
1525
"long": "Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)\nSee <https://icons.getbootstrap.com/> for a list of available icons\n"
1526
}
1527
}
1528
},
1529
"id": {
1530
"schema": "string",
1531
"hidden": true
1532
},
1533
"menu": {
1534
"arrayOf": {
1535
"schema": {
1536
"ref": "navigation-item"
1537
}
1538
}
1539
},
1540
"text": {
1541
"string": {
1542
"description": "Text to display for item (defaults to the\ndocument title if not provided)\n"
1543
}
1544
},
1545
"url": {
1546
"hidden": true,
1547
"string": {
1548
"description": "Alias for href\n"
1549
}
1550
},
1551
"rel": {
1552
"string": {
1553
"description": "Value for rel attribute. Multiple space-separated values are permitted.\nSee <https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel>\nfor a details.\n"
1554
}
1555
},
1556
"target": {
1557
"string": {
1558
"description": "Value for target attribute.\nSee <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target>\nfor details.\n"
1559
}
1560
}
1561
}
1562
}
1563
},
1564
{
1565
"id": "giscus-themes",
1566
"enum": {
1567
"values": [
1568
"light",
1569
"light_high_contrast",
1570
"light_protanopia",
1571
"light_tritanopia",
1572
"dark",
1573
"dark_high_contrast",
1574
"dark_protanopia",
1575
"dark_tritanopia",
1576
"dark_dimmed",
1577
"transparent_dark",
1578
"cobalt",
1579
"purple_dark",
1580
"noborder_light",
1581
"noborder_dark",
1582
"noborder_gray",
1583
"preferred_color_scheme"
1584
]
1585
}
1586
},
1587
{
1588
"id": "giscus-configuration",
1589
"object": {
1590
"closed": true,
1591
"properties": {
1592
"repo": {
1593
"string": {
1594
"description": {
1595
"short": "The Github repo that will be used to store comments.",
1596
"long": "The Github repo that will be used to store comments.\n\nIn order to work correctly, the repo must be public, with the giscus app installed, and \nthe discussions feature must be enabled.\n"
1597
}
1598
}
1599
},
1600
"repo-id": {
1601
"string": {
1602
"description": {
1603
"short": "The Github repository identifier.",
1604
"long": "The Github repository identifier.\n\nYou can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).\nIf this is not provided, Quarto will attempt to discover it at render time.\n"
1605
}
1606
}
1607
},
1608
"category": {
1609
"string": {
1610
"description": {
1611
"short": "The discussion category where new discussions will be created.",
1612
"long": "The discussion category where new discussions will be created. It is recommended \nto use a category with the **Announcements** type so that new discussions \ncan only be created by maintainers and giscus.\n"
1613
}
1614
}
1615
},
1616
"category-id": {
1617
"string": {
1618
"description": {
1619
"short": "The Github category identifier.",
1620
"long": "The Github category identifier.\n\nYou can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).\nIf this is not provided, Quarto will attempt to discover it at render time.\n"
1621
}
1622
}
1623
},
1624
"mapping": {
1625
"schema": {
1626
"anyOf": [
1627
"string",
1628
"number"
1629
]
1630
},
1631
"completions": [
1632
"pathname",
1633
"url",
1634
"title",
1635
"og:title"
1636
],
1637
"description": {
1638
"short": "The mapping between the page and the embedded discussion.",
1639
"long": "The mapping between the page and the embedded discussion. \n\n- `pathname`: The discussion title contains the page path\n- `url`: The discussion title contains the page url\n- `title`: The discussion title contains the page title\n- `og:title`: The discussion title contains the `og:title` metadata value\n- any other string or number: Any other strings will be passed through verbatim and a discussion title\ncontaining that value will be used. Numbers will be treated\nas a discussion number and automatic discussion creation is not supported.\n"
1640
}
1641
},
1642
"reactions-enabled": {
1643
"boolean": {
1644
"description": "Display reactions for the discussion's main post before the comments."
1645
}
1646
},
1647
"loading": {
1648
"enum": [
1649
"lazy"
1650
],
1651
"description": "Specify `loading: lazy` to defer loading comments until the user scrolls near the comments container."
1652
},
1653
"input-position": {
1654
"enum": [
1655
"top",
1656
"bottom"
1657
],
1658
"description": "Place the comment input box above or below the comments."
1659
},
1660
"theme": {
1661
"anyOf": [
1662
"string",
1663
{
1664
"ref": "giscus-themes"
1665
},
1666
{
1667
"object": {
1668
"closed": true,
1669
"properties": {
1670
"light": {
1671
"anyOf": [
1672
"string",
1673
{
1674
"ref": "giscus-themes"
1675
}
1676
],
1677
"description": "The light theme name."
1678
},
1679
"dark": {
1680
"anyOf": [
1681
"string",
1682
{
1683
"ref": "giscus-themes"
1684
}
1685
],
1686
"description": "The dark theme name."
1687
}
1688
}
1689
}
1690
}
1691
],
1692
"description": {
1693
"short": "The giscus theme to use when displaying comments.",
1694
"long": "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: \n\n```yaml\nwebsite:\n comments:\n giscus:\n theme:\n light: light # giscus theme used for light website theme\n dark: dark_dimmed # giscus theme used for dark website theme\n```\n"
1695
}
1696
},
1697
"language": {
1698
"string": {
1699
"description": "The language that should be used when displaying the commenting interface."
1700
}
1701
}
1702
},
1703
"required": [
1704
"repo"
1705
]
1706
}
1707
},
1708
{
1709
"id": "external-engine",
1710
"schema": {
1711
"object": {
1712
"closed": true,
1713
"properties": {
1714
"path": {
1715
"path": {
1716
"description": "Path to the TypeScript module for the execution engine"
1717
}
1718
}
1719
},
1720
"required": [
1721
"path"
1722
]
1723
},
1724
"description": "An execution engine not pre-loaded in Quarto"
1725
}
1726
},
1727
{
1728
"id": "document-comments-configuration",
1729
"anyOf": [
1730
{
1731
"enum": [
1732
false
1733
]
1734
},
1735
{
1736
"object": {
1737
"closed": true,
1738
"properties": {
1739
"utterances": {
1740
"object": {
1741
"closed": true,
1742
"properties": {
1743
"repo": {
1744
"string": {
1745
"description": "The Github repo that will be used to store comments."
1746
}
1747
},
1748
"label": {
1749
"string": {
1750
"description": "The label that will be assigned to issues created by Utterances."
1751
}
1752
},
1753
"theme": {
1754
"string": {
1755
"description": {
1756
"short": "The Github theme that should be used for Utterances.",
1757
"long": "The Github theme that should be used for Utterances\n(`github-light`, `github-dark`, `github-dark-orange`,\n`icy-dark`, `dark-blue`, `photon-dark`, `body-light`,\nor `gruvbox-dark`)\n"
1758
},
1759
"completions": [
1760
"github-light",
1761
"github-dark",
1762
"github-dark-orange",
1763
"icy-dark",
1764
"dark-blue",
1765
"photon-dark",
1766
"body-light",
1767
"gruvbox-dark"
1768
]
1769
}
1770
},
1771
"issue-term": {
1772
"string": {
1773
"description": {
1774
"short": "How posts should be mapped to Github issues",
1775
"long": "How posts should be mapped to Github issues\n(`pathname`, `url`, `title` or `og:title`)\n"
1776
},
1777
"completions": [
1778
"pathname",
1779
"url",
1780
"title",
1781
"og:title"
1782
]
1783
}
1784
}
1785
},
1786
"required": [
1787
"repo"
1788
]
1789
}
1790
},
1791
"giscus": {
1792
"ref": "giscus-configuration"
1793
},
1794
"hypothesis": {
1795
"anyOf": [
1796
"boolean",
1797
{
1798
"object": {
1799
"closed": true,
1800
"properties": {
1801
"client-url": {
1802
"string": {
1803
"description": "Override the default hypothesis client url with a custom client url."
1804
}
1805
},
1806
"openSidebar": {
1807
"boolean": {
1808
"default": false,
1809
"description": "Controls whether the sidebar opens automatically on startup."
1810
}
1811
},
1812
"showHighlights": {
1813
"anyOf": [
1814
"boolean",
1815
{
1816
"enum": [
1817
"always",
1818
"whenSidebarOpen",
1819
"never"
1820
]
1821
}
1822
],
1823
"default": "always",
1824
"description": "Controls whether the in-document highlights are shown by default (`always`, `whenSidebarOpen` or `never`)"
1825
},
1826
"theme": {
1827
"enum": [
1828
"classic",
1829
"clean"
1830
],
1831
"default": "classic",
1832
"description": "Controls the overall look of the sidebar (`classic` or `clean`)"
1833
},
1834
"enableExperimentalNewNoteButton": {
1835
"boolean": {
1836
"default": false,
1837
"description": "Controls whether the experimental New Note button \nshould be shown in the notes tab in the sidebar.\n"
1838
}
1839
},
1840
"usernameUrl": {
1841
"schema": "string",
1842
"description": "Specify a URL to direct a user to, \nin a new tab. when they click on the annotation author \nlink in the header of an annotation.\n"
1843
},
1844
"services": {
1845
"arrayOf": {
1846
"object": {
1847
"properties": {
1848
"apiUrl": {
1849
"string": {
1850
"description": "The base URL of the service API."
1851
}
1852
},
1853
"authority": {
1854
"string": {
1855
"description": "The domain name which the annotation service is associated with."
1856
}
1857
},
1858
"grantToken": {
1859
"string": {
1860
"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."
1861
}
1862
},
1863
"allowLeavingGroups": {
1864
"boolean": {
1865
"default": true,
1866
"description": "A flag indicating whether users should be able to leave groups of which they are a member."
1867
}
1868
},
1869
"enableShareLinks": {
1870
"boolean": {
1871
"default": true,
1872
"description": "A flag indicating whether annotation cards should show links that take the user to see an annotation in context."
1873
}
1874
},
1875
"groups": {
1876
"anyOf": [
1877
{
1878
"enum": [
1879
"$rpc:requestGroups"
1880
]
1881
},
1882
{
1883
"arrayOf": "string"
1884
}
1885
],
1886
"description": "An array of Group IDs or the literal string `$rpc:requestGroups`"
1887
},
1888
"icon": {
1889
"string": {
1890
"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."
1891
}
1892
}
1893
},
1894
"required": [
1895
"apiUrl",
1896
"authority",
1897
"grantToken"
1898
]
1899
},
1900
"description": "Alternative annotation services which the client should \nconnect to instead of connecting to the public Hypothesis \nservice at hypothes.is.\n"
1901
}
1902
},
1903
"branding": {
1904
"object": {
1905
"properties": {
1906
"accentColor": {
1907
"string": {
1908
"description": "Secondary color for elements of the commenting UI."
1909
}
1910
},
1911
"appBackgroundColor": {
1912
"string": {
1913
"description": "The main background color of the commenting UI."
1914
}
1915
},
1916
"ctaBackgroundColor": {
1917
"string": {
1918
"description": "The background color for call to action buttons."
1919
}
1920
},
1921
"selectionFontFamily": {
1922
"string": {
1923
"description": "The font family for selection text in the annotation card."
1924
}
1925
},
1926
"annotationFontFamily": {
1927
"string": {
1928
"description": "The font family for the actual annotation value that the user writes about the page or selection."
1929
}
1930
}
1931
},
1932
"description": "Settings to adjust the commenting sidebar's look and feel."
1933
}
1934
},
1935
"externalContainerSelector": {
1936
"string": {
1937
"description": "A CSS selector specifying the containing element into which the sidebar iframe will be placed."
1938
}
1939
},
1940
"focus": {
1941
"object": {
1942
"properties": {
1943
"user": {
1944
"object": {
1945
"properties": {
1946
"username": {
1947
"string": {
1948
"description": "The username of the user to focus on."
1949
}
1950
},
1951
"userid": {
1952
"string": {
1953
"description": "The userid of the user to focus on."
1954
}
1955
},
1956
"displayName": {
1957
"string": {
1958
"description": "The display name of the user to focus on."
1959
}
1960
}
1961
}
1962
}
1963
}
1964
},
1965
"required": [
1966
"user"
1967
]
1968
},
1969
"description": "Defines a focused filter set for the available annotations on a page."
1970
},
1971
"requestConfigFromFrame": {
1972
"object": {
1973
"properties": {
1974
"origin": {
1975
"string": {
1976
"description": "Host url and port number of receiving iframe"
1977
}
1978
},
1979
"ancestorLevel": {
1980
"number": {
1981
"description": "Number of nested iframes deep the client is relative from the receiving iframe."
1982
}
1983
}
1984
}
1985
}
1986
},
1987
"assetRoot": {
1988
"string": {
1989
"description": "The root URL from which assets are loaded."
1990
}
1991
},
1992
"sidebarAppUrl": {
1993
"string": {
1994
"description": "The URL for the sidebar application which displays annotations.",
1995
"default": "https://hypothes.is/app.html"
1996
}
1997
}
1998
}
1999
}
2000
}
2001
]
2002
}
2003
}
2004
}
2005
}
2006
]
2007
},
2008
{
2009
"id": "social-metadata",
2010
"object": {
2011
"closed": true,
2012
"properties": {
2013
"title": {
2014
"string": {
2015
"description": {
2016
"short": "The title of the page",
2017
"long": "The title of the page. Note that by default Quarto will automatically \nuse the title metadata from the page. Specify this field if you’d like \nto override the title for this provider.\n"
2018
}
2019
}
2020
},
2021
"description": {
2022
"string": {
2023
"description": {
2024
"short": "A short description of the content.",
2025
"long": "A short description of the content. Note that by default Quarto will\nautomatically use the description metadata from the page. Specify this\nfield if you’d like to override the description for this provider.\n"
2026
}
2027
}
2028
},
2029
"image": {
2030
"path": {
2031
"description": {
2032
"short": "The path to a preview image for the content.",
2033
"long": "The path to a preview image for the content. By default, Quarto will use\nthe `image` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
2034
}
2035
}
2036
},
2037
"image-alt": {
2038
"path": {
2039
"description": {
2040
"short": "The alt text for the preview image.",
2041
"long": "The alt text for the preview image. By default, Quarto will use\nthe `image-alt` value from the format metadata. If you provide an \nimage, you may also optionally provide an `image-width` and `image-height`.\n"
2042
}
2043
}
2044
},
2045
"image-width": {
2046
"number": {
2047
"description": "Image width (pixels)"
2048
}
2049
},
2050
"image-height": {
2051
"number": {
2052
"description": "Image height (pixels)"
2053
}
2054
}
2055
}
2056
}
2057
},
2058
{
2059
"id": "page-footer-region",
2060
"anyOf": [
2061
"string",
2062
{
2063
"arrayOf": {
2064
"ref": "navigation-item"
2065
}
2066
}
2067
]
2068
},
2069
{
2070
"id": "sidebar-contents",
2071
"anyOf": [
2072
"string",
2073
{
2074
"ref": "contents-auto"
2075
},
2076
{
2077
"arrayOf": {
2078
"anyOf": [
2079
{
2080
"ref": "navigation-item"
2081
},
2082
"path",
2083
{
2084
"object": {
2085
"closed": true,
2086
"properties": {
2087
"section": {
2088
"anyOf": [
2089
"string",
2090
null
2091
]
2092
},
2093
"contents": {
2094
"ref": "sidebar-contents"
2095
}
2096
}
2097
}
2098
},
2099
{
2100
"ref": "contents-auto"
2101
}
2102
]
2103
}
2104
}
2105
]
2106
},
2107
{
2108
"id": "project-preview",
2109
"object": {
2110
"closed": true,
2111
"properties": {
2112
"port": {
2113
"number": {
2114
"description": "Port to listen on (defaults to random value between 3000 and 8000)"
2115
}
2116
},
2117
"host": {
2118
"string": {
2119
"description": "Hostname to bind to (defaults to 127.0.0.1)"
2120
}
2121
},
2122
"serve": {
2123
"description": "Use an exernal application to preview the project.",
2124
"schema": {
2125
"ref": "project-serve"
2126
}
2127
},
2128
"browser": {
2129
"boolean": {
2130
"description": "Open a web browser to view the preview (defaults to true)"
2131
}
2132
},
2133
"watch-inputs": {
2134
"boolean": {
2135
"description": "Re-render input files when they change (defaults to true)"
2136
}
2137
},
2138
"navigate": {
2139
"boolean": {
2140
"description": "Navigate the browser automatically when outputs are updated (defaults to true)"
2141
}
2142
},
2143
"timeout": {
2144
"number": {
2145
"description": "Time (in seconds) after which to exit if there are no active clients"
2146
}
2147
}
2148
}
2149
}
2150
},
2151
{
2152
"id": "project-serve",
2153
"object": {
2154
"closed": true,
2155
"properties": {
2156
"cmd": {
2157
"string": {
2158
"description": "Serve project preview using the specified command.\nInterpolate the `--port` into the command using `{port}`.\n"
2159
}
2160
},
2161
"args": {
2162
"string": {
2163
"description": "Additional command line arguments for preview command."
2164
}
2165
},
2166
"env": {
2167
"object": {
2168
"description": "Environment variables to set for preview command."
2169
}
2170
},
2171
"ready": {
2172
"string": {
2173
"description": "Regular expression for detecting when the server is ready."
2174
}
2175
}
2176
},
2177
"required": [
2178
"cmd",
2179
"ready"
2180
]
2181
}
2182
},
2183
{
2184
"id": "publish",
2185
"description": "Sites published from project",
2186
"schema": {
2187
"object": {
2188
"closed": true,
2189
"properties": {
2190
"netlify": {
2191
"arrayOf": {
2192
"ref": "publish-record"
2193
}
2194
}
2195
},
2196
"description": "Sites published to Netlify"
2197
}
2198
}
2199
},
2200
{
2201
"id": "publish-record",
2202
"object": {
2203
"closed": true,
2204
"properties": {
2205
"id": {
2206
"string": {
2207
"description": "Unique identifier for site"
2208
}
2209
},
2210
"url": {
2211
"string": {
2212
"description": "Published URL for site"
2213
}
2214
}
2215
}
2216
}
2217
},
2218
{
2219
"id": "twitter-card-config",
2220
"object": {
2221
"super": {
2222
"resolveRef": "social-metadata"
2223
},
2224
"closed": true,
2225
"properties": {
2226
"card-style": {
2227
"enum": [
2228
"summary",
2229
"summary_large_image"
2230
],
2231
"description": {
2232
"short": "Card style",
2233
"long": "Card style (`summary` or `summary_large_image`).\n\nIf this is not provided, the best style will automatically\nselected based upon other metadata. You can learn more about Twitter Card\nstyles [here](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards).\n"
2234
}
2235
},
2236
"creator": {
2237
"string": {
2238
"description": "`@username` of the content creator (must be a quoted string)"
2239
}
2240
},
2241
"site": {
2242
"string": {
2243
"description": "`@username` of the website (must be a quoted string)"
2244
}
2245
}
2246
}
2247
}
2248
},
2249
{
2250
"id": "open-graph-config",
2251
"object": {
2252
"super": {
2253
"resolveRef": "social-metadata"
2254
},
2255
"closed": true,
2256
"properties": {
2257
"locale": {
2258
"string": {
2259
"description": "Locale of open graph metadata"
2260
}
2261
},
2262
"site-name": {
2263
"string": {
2264
"description": {
2265
"short": "Name that should be displayed for the overall site",
2266
"long": "Name that should be displayed for the overall site. If not explicitly \nprovided in the `open-graph` metadata, Quarto will use the website or\nbook `title` by default.\n"
2267
}
2268
}
2269
}
2270
}
2271
}
2272
},
2273
{
2274
"id": "page-footer",
2275
"object": {
2276
"properties": {
2277
"left": {
2278
"ref": "page-footer-region",
2279
"description": "Footer left content"
2280
},
2281
"right": {
2282
"ref": "page-footer-region",
2283
"description": "Footer right content"
2284
},
2285
"center": {
2286
"ref": "page-footer-region",
2287
"description": "Footer center content"
2288
},
2289
"border": {
2290
"anyOf": [
2291
"boolean",
2292
"string"
2293
],
2294
"description": "Footer border (`true`, `false`, or a border color)"
2295
},
2296
"background": {
2297
"schema": "string",
2298
"description": "Footer background color"
2299
},
2300
"foreground": {
2301
"schema": "string",
2302
"description": "Footer foreground color"
2303
}
2304
},
2305
"closed": true
2306
}
2307
},
2308
{
2309
"id": "base-website",
2310
"object": {
2311
"closed": true,
2312
"properties": {
2313
"title": {
2314
"string": {
2315
"description": "Website title"
2316
}
2317
},
2318
"description": {
2319
"string": {
2320
"description": "Website description"
2321
}
2322
},
2323
"favicon": {
2324
"string": {
2325
"description": "The path to the favicon for this website"
2326
}
2327
},
2328
"site-url": {
2329
"string": {
2330
"description": "Base URL for published website"
2331
}
2332
},
2333
"site-path": {
2334
"string": {
2335
"description": "Path to site (defaults to `/`). Not required if you specify `site-url`.\n"
2336
}
2337
},
2338
"repo-url": {
2339
"string": {
2340
"description": "Base URL for website source code repository"
2341
}
2342
},
2343
"repo-link-target": {
2344
"string": {
2345
"description": "The value of the target attribute for repo links"
2346
}
2347
},
2348
"repo-link-rel": {
2349
"string": {
2350
"description": "The value of the rel attribute for repo links"
2351
}
2352
},
2353
"repo-subdir": {
2354
"string": {
2355
"description": "Subdirectory of repository containing website"
2356
}
2357
},
2358
"repo-branch": {
2359
"string": {
2360
"description": "Branch of website source code (defaults to `main`)"
2361
}
2362
},
2363
"issue-url": {
2364
"string": {
2365
"description": "URL to use for the 'report an issue' repository action."
2366
}
2367
},
2368
"repo-actions": {
2369
"maybeArrayOf": {
2370
"enum": [
2371
"none",
2372
"edit",
2373
"source",
2374
"issue"
2375
],
2376
"description": {
2377
"short": "Links to source repository actions",
2378
"long": "Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`)"
2379
}
2380
}
2381
},
2382
"reader-mode": {
2383
"boolean": {
2384
"description": "Displays a 'reader-mode' tool which allows users to hide the sidebar and table of contents when viewing a page.\n"
2385
}
2386
},
2387
"llms-txt": {
2388
"boolean": {
2389
"description": "Generate llms.txt and .llms.md files for LLM-friendly content consumption.\n"
2390
}
2391
},
2392
"google-analytics": {
2393
"anyOf": [
2394
"string",
2395
{
2396
"object": {
2397
"properties": {
2398
"tracking-id": {
2399
"schema": "string",
2400
"description": "The Google tracking Id or measurement Id of this website."
2401
},
2402
"storage": {
2403
"enum": [
2404
"cookies",
2405
"none"
2406
],
2407
"description": {
2408
"short": "Storage options for Google Analytics data",
2409
"long": "Storage option for Google Analytics data using on of these two values:\n\n`cookies`: Use cookies to store unique user and session identification (default).\n\n`none`: Do not use cookies to store unique user and session identification.\n\nFor more about choosing storage options see [Storage](https://quarto.org/docs/websites/website-tools.html#storage).\n"
2410
}
2411
},
2412
"anonymize-ip": {
2413
"schema": "boolean",
2414
"description": {
2415
"short": "Anonymize the user ip address.",
2416
"long": "Anonymize the user ip address. For more about this feature, see \n[IP Anonymization (or IP masking) in Google Analytics](https://support.google.com/analytics/answer/2763052?hl=en).\n"
2417
}
2418
},
2419
"version": {
2420
"enum": [
2421
3,
2422
4
2423
],
2424
"description": {
2425
"short": "The version number of Google Analytics to use.",
2426
"long": "The version number of Google Analytics to use. \n\n- `3`: Use analytics.js\n- `4`: use gtag. \n\nThis is automatically detected based upon the `tracking-id`, but you may specify it.\n"
2427
}
2428
}
2429
}
2430
}
2431
}
2432
],
2433
"description": "Enable Google Analytics for this website"
2434
},
2435
"plausible-analytics": {
2436
"anyOf": [
2437
"string",
2438
{
2439
"object": {
2440
"closed": true,
2441
"properties": {
2442
"path": {
2443
"path": {
2444
"description": "Path to a file containing the Plausible Analytics script snippet"
2445
}
2446
}
2447
},
2448
"required": [
2449
"path"
2450
]
2451
}
2452
}
2453
],
2454
"description": {
2455
"short": "Enable Plausible Analytics for this website by providing a script snippet or path to snippet file",
2456
"long": "Enable Plausible Analytics for this website by pasting the script snippet from your Plausible dashboard,\nor by providing a path to a file containing the snippet.\n\nPlausible is a privacy-friendly, GDPR-compliant web analytics service that does not use cookies and does not require cookie consent.\n\n**Option 1: Inline snippet**\n\n```yaml\nwebsite:\n plausible-analytics: |\n <script async src=\"https://plausible.io/js/script.js\"></script>\n```\n\n**Option 2: File path**\n\n```yaml\nwebsite:\n plausible-analytics:\n path: _plausible_snippet.html\n```\n\nTo get your script snippet:\n\n1. Log into your Plausible account at <https://plausible.io>\n2. Go to your site settings\n3. Copy the JavaScript snippet provided\n4. Either paste it directly in your configuration or save it to a file\n\nFor more information, see <https://plausible.io/docs/plausible-script>\n"
2457
}
2458
},
2459
"announcement": {
2460
"anyOf": [
2461
"string",
2462
{
2463
"object": {
2464
"properties": {
2465
"content": {
2466
"schema": "string",
2467
"description": "The content of the announcement"
2468
},
2469
"dismissable": {
2470
"schema": "boolean",
2471
"description": "Whether this announcement may be dismissed by the user."
2472
},
2473
"icon": {
2474
"schema": "string",
2475
"description": {
2476
"short": "The icon to display in the announcement",
2477
"long": "Name of bootstrap icon (e.g. `github`, `twitter`, `share`) for the announcement.\nSee <https://icons.getbootstrap.com/> for a list of available icons\n"
2478
}
2479
},
2480
"position": {
2481
"schema": {
2482
"enum": [
2483
"above-navbar",
2484
"below-navbar"
2485
]
2486
},
2487
"description": {
2488
"short": "The position of the announcement.",
2489
"long": "The position of the announcement. One of `above-navbar` (default) or `below-navbar`.\n"
2490
}
2491
},
2492
"type": {
2493
"schema": {
2494
"enum": [
2495
"primary",
2496
"secondary",
2497
"success",
2498
"danger",
2499
"warning",
2500
"info",
2501
"light",
2502
"dark"
2503
]
2504
},
2505
"description": {
2506
"short": "The type of announcement. Affects the appearance of the announcement.",
2507
"long": "The type of announcement. One of `primary`, `secondary`, `success`, `danger`, `warning`,\n `info`, `light` or `dark`. Affects the appearance of the announcement.\n"
2508
}
2509
}
2510
}
2511
}
2512
}
2513
],
2514
"description": "Provides an announcement displayed at the top of the page."
2515
},
2516
"cookie-consent": {
2517
"anyOf": [
2518
{
2519
"enum": [
2520
"express",
2521
"implied"
2522
]
2523
},
2524
"boolean",
2525
{
2526
"object": {
2527
"properties": {
2528
"type": {
2529
"enum": [
2530
"express",
2531
"implied"
2532
],
2533
"description": {
2534
"short": "The type of consent that should be requested",
2535
"long": "The type of consent that should be requested, using one of these two values:\n\n- `express` (default): This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn’t agree).\n\n- `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.\n"
2536
}
2537
},
2538
"style": {
2539
"enum": [
2540
"simple",
2541
"headline",
2542
"interstitial",
2543
"standalone"
2544
],
2545
"description": {
2546
"short": "The style of the consent banner that is displayed",
2547
"long": "The style of the consent banner that is displayed:\n\n- `simple` (default): A simple dialog in the lower right corner of the website.\n\n- `headline`: A full width banner across the top of the website.\n\n- `interstitial`: An semi-transparent overlay of the entire website.\n\n- `standalone`: An opaque overlay of the entire website.\n"
2548
}
2549
},
2550
"palette": {
2551
"enum": [
2552
"light",
2553
"dark"
2554
],
2555
"description": "Whether to use a dark or light appearance for the consent banner (`light` or `dark`)."
2556
},
2557
"policy-url": {
2558
"schema": "string",
2559
"description": "The url to the website’s cookie or privacy policy."
2560
},
2561
"language": {
2562
"schema": "string",
2563
"description": {
2564
"short": "The language to be used when diplaying the cookie consent prompt (defaults to document language).",
2565
"long": "The language to be used when diplaying the cookie consent prompt specified using an IETF language tag.\n\nIf not specified, the document language will be used.\n"
2566
}
2567
},
2568
"prefs-text": {
2569
"schema": "string",
2570
"description": {
2571
"short": "The text to display for the cookie preferences link in the website footer."
2572
}
2573
}
2574
}
2575
}
2576
}
2577
],
2578
"description": {
2579
"short": "Request cookie consent before enabling scripts that set cookies",
2580
"long": "Quarto includes the ability to request cookie consent before enabling scripts that set cookies, using [Cookie Consent](https://www.cookieconsent.com/).\n\nThe 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).\n"
2581
}
2582
},
2583
"search": {
2584
"anyOf": [
2585
"boolean",
2586
{
2587
"object": {
2588
"properties": {
2589
"location": {
2590
"enum": [
2591
"navbar",
2592
"sidebar"
2593
],
2594
"description": "Location for search widget (`navbar` or `sidebar`)"
2595
},
2596
"type": {
2597
"enum": [
2598
"overlay",
2599
"textbox"
2600
],
2601
"description": "Type of search UI (`overlay` or `textbox`)"
2602
},
2603
"limit": {
2604
"schema": "number",
2605
"description": "Number of matches to display (defaults to 20)"
2606
},
2607
"collapse-after": {
2608
"schema": "number",
2609
"description": "Matches after which to collapse additional results"
2610
},
2611
"copy-button": {
2612
"schema": "boolean",
2613
"description": "Provide button for copying search link"
2614
},
2615
"merge-navbar-crumbs": {
2616
"schema": "boolean",
2617
"default": true,
2618
"description": "When false, do not merge navbar crumbs into the crumbs in `search.json`."
2619
},
2620
"keyboard-shortcut": {
2621
"maybeArrayOf": {
2622
"string": {
2623
"description": "One or more keys that will act as a shortcut to launch search (single characters)"
2624
}
2625
}
2626
},
2627
"show-item-context": {
2628
"schema": {
2629
"anyOf": [
2630
{
2631
"enum": [
2632
"tree",
2633
"parent",
2634
"root"
2635
]
2636
},
2637
"boolean"
2638
]
2639
},
2640
"description": "Whether to include search result parents when displaying items in search results (when possible)."
2641
},
2642
"algolia": {
2643
"object": {
2644
"properties": {
2645
"index-name": {
2646
"schema": "string",
2647
"description": "The name of the index to use when performing a search"
2648
},
2649
"application-id": {
2650
"schema": "string",
2651
"description": "The unique ID used by Algolia to identify your application"
2652
},
2653
"search-only-api-key": {
2654
"schema": "string",
2655
"description": "The Search-Only API key to use to connect to Algolia"
2656
},
2657
"analytics-events": {
2658
"boolean": {
2659
"description": "Enable tracking of Algolia analytics events"
2660
}
2661
},
2662
"show-logo": {
2663
"boolean": {
2664
"description": "Enable the display of the Algolia logo in the search results footer."
2665
}
2666
},
2667
"index-fields": {
2668
"object": {
2669
"properties": {
2670
"href": {
2671
"schema": "string",
2672
"description": "Field that contains the URL of index entries"
2673
},
2674
"title": {
2675
"schema": "string",
2676
"description": "Field that contains the title of index entries"
2677
},
2678
"text": {
2679
"schema": "string",
2680
"description": "Field that contains the text of index entries"
2681
},
2682
"section": {
2683
"schema": "string",
2684
"description": "Field that contains the section of index entries"
2685
}
2686
},
2687
"closed": true
2688
}
2689
},
2690
"params": {
2691
"object": {
2692
"description": "Additional parameters to pass when executing a search"
2693
}
2694
}
2695
},
2696
"closed": true
2697
},
2698
"description": "Use external Algolia search index"
2699
}
2700
},
2701
"closed": true
2702
}
2703
}
2704
],
2705
"description": "Provide full text search for website"
2706
},
2707
"navbar": {
2708
"anyOf": [
2709
"boolean",
2710
{
2711
"object": {
2712
"properties": {
2713
"title": {
2714
"anyOf": [
2715
"string",
2716
"boolean"
2717
],
2718
"description": "The navbar title. Uses the project title if none is specified."
2719
},
2720
"logo": {
2721
"ref": "logo-light-dark-specifier",
2722
"description": "Specification of image that will be displayed to the left of the title."
2723
},
2724
"logo-alt": {
2725
"string": {
2726
"description": "Alternate text for the logo image."
2727
}
2728
},
2729
"logo-href": {
2730
"string": {
2731
"description": "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."
2732
}
2733
},
2734
"background": {
2735
"string": {
2736
"description": "The navbar's background color (named or hex color).",
2737
"completions": [
2738
"primary",
2739
"secondary",
2740
"success",
2741
"danger",
2742
"warning",
2743
"info",
2744
"light",
2745
"dark"
2746
]
2747
}
2748
},
2749
"foreground": {
2750
"string": {
2751
"description": "The navbar's foreground color (named or hex color).",
2752
"completions": [
2753
"primary",
2754
"secondary",
2755
"success",
2756
"danger",
2757
"warning",
2758
"info",
2759
"light",
2760
"dark"
2761
]
2762
}
2763
},
2764
"search": {
2765
"boolean": {
2766
"description": "Include a search box in the navbar."
2767
}
2768
},
2769
"pinned": {
2770
"boolean": {
2771
"description": "Always show the navbar (keeping it pinned).",
2772
"default": false
2773
}
2774
},
2775
"collapse": {
2776
"boolean": {
2777
"description": "Collapse the navbar into a menu when the display becomes narrow.",
2778
"default": true
2779
}
2780
},
2781
"collapse-below": {
2782
"enum": [
2783
"sm",
2784
"md",
2785
"lg",
2786
"xl",
2787
"xxl"
2788
],
2789
"description": "The responsive breakpoint below which the navbar will collapse into a menu (`sm`, `md`, `lg` (default), `xl`, `xxl`).",
2790
"default": "lg"
2791
},
2792
"left": {
2793
"arrayOf": {
2794
"ref": "navigation-item"
2795
},
2796
"description": "List of items for the left side of the navbar."
2797
},
2798
"right": {
2799
"arrayOf": {
2800
"ref": "navigation-item"
2801
},
2802
"description": "List of items for the right side of the navbar."
2803
},
2804
"toggle-position": {
2805
"schema": {
2806
"enum": [
2807
"left",
2808
"right"
2809
]
2810
},
2811
"description": "The position of the collapsed navbar toggle when in responsive mode",
2812
"default": "left"
2813
},
2814
"tools-collapse": {
2815
"boolean": {
2816
"description": "Collapse tools into the navbar menu when the display becomes narrow.",
2817
"default": false
2818
}
2819
}
2820
}
2821
}
2822
}
2823
],
2824
"description": "Top navigation options"
2825
},
2826
"sidebar": {
2827
"anyOf": [
2828
"boolean",
2829
{
2830
"maybeArrayOf": {
2831
"object": {
2832
"properties": {
2833
"id": {
2834
"string": {
2835
"description": "The identifier for this sidebar."
2836
}
2837
},
2838
"title": {
2839
"anyOf": [
2840
"string",
2841
"boolean"
2842
],
2843
"description": "The sidebar title. Uses the project title if none is specified."
2844
},
2845
"logo": {
2846
"ref": "logo-light-dark-specifier",
2847
"description": "Specification of image that will be displayed in the sidebar."
2848
},
2849
"logo-alt": {
2850
"string": {
2851
"description": "Alternate text for the logo image."
2852
}
2853
},
2854
"logo-href": {
2855
"string": {
2856
"description": "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."
2857
}
2858
},
2859
"search": {
2860
"boolean": {
2861
"description": "Include a search control in the sidebar."
2862
}
2863
},
2864
"tools": {
2865
"arrayOf": {
2866
"ref": "navigation-item-object"
2867
},
2868
"description": "List of sidebar tools"
2869
},
2870
"contents": {
2871
"ref": "sidebar-contents",
2872
"description": "List of items for the sidebar"
2873
},
2874
"style": {
2875
"enum": [
2876
"docked",
2877
"floating"
2878
],
2879
"description": "The style of sidebar (`docked` or `floating`).",
2880
"default": "floating"
2881
},
2882
"background": {
2883
"schema": "string",
2884
"completions": [
2885
"primary",
2886
"secondary",
2887
"success",
2888
"danger",
2889
"warning",
2890
"info",
2891
"light",
2892
"dark"
2893
],
2894
"description": "The sidebar's background color (named or hex color)."
2895
},
2896
"foreground": {
2897
"schema": "string",
2898
"completions": [
2899
"primary",
2900
"secondary",
2901
"success",
2902
"danger",
2903
"warning",
2904
"info",
2905
"light",
2906
"dark"
2907
],
2908
"description": "The sidebar's foreground color (named or hex color)."
2909
},
2910
"border": {
2911
"boolean": {
2912
"description": "Whether to show a border on the sidebar (defaults to true for 'docked' sidebars)"
2913
}
2914
},
2915
"alignment": {
2916
"enum": [
2917
"left",
2918
"right",
2919
"center"
2920
],
2921
"description": "Alignment of the items within the sidebar (`left`, `right`, or `center`)"
2922
},
2923
"collapse-level": {
2924
"number": {
2925
"description": "The depth at which the sidebar contents should be collapsed by default.",
2926
"default": 2
2927
}
2928
},
2929
"pinned": {
2930
"boolean": {
2931
"description": "When collapsed, pin the collapsed sidebar to the top of the page."
2932
}
2933
},
2934
"header": {
2935
"maybeArrayOf": "string",
2936
"description": "Markdown to place above sidebar content (text or file path)"
2937
},
2938
"footer": {
2939
"maybeArrayOf": "string",
2940
"description": "Markdown to place below sidebar content (text or file path)"
2941
}
2942
}
2943
}
2944
}
2945
}
2946
],
2947
"description": "Side navigation options"
2948
},
2949
"body-header": {
2950
"string": {
2951
"description": "Markdown to insert at the beginning of each page’s body (below the title and author block)."
2952
}
2953
},
2954
"body-footer": {
2955
"string": {
2956
"description": "Markdown to insert below each page’s body."
2957
}
2958
},
2959
"margin-header": {
2960
"maybeArrayOf": "string",
2961
"description": "Markdown to place above margin content (text or file path)"
2962
},
2963
"margin-footer": {
2964
"maybeArrayOf": "string",
2965
"description": "Markdown to place below margin content (text or file path)"
2966
},
2967
"page-navigation": {
2968
"boolean": {
2969
"description": "Provide next and previous article links in footer"
2970
}
2971
},
2972
"back-to-top-navigation": {
2973
"boolean": {
2974
"description": "Provide a 'back to top' navigation button"
2975
}
2976
},
2977
"bread-crumbs": {
2978
"boolean": {
2979
"description": "Whether to show navigation breadcrumbs for pages more than 1 level deep"
2980
}
2981
},
2982
"page-footer": {
2983
"anyOf": [
2984
"string",
2985
{
2986
"ref": "page-footer"
2987
}
2988
],
2989
"description": "Shared page footer"
2990
},
2991
"image": {
2992
"path": {
2993
"description": "Default site thumbnail image for `twitter` /`open-graph`\n"
2994
}
2995
},
2996
"image-alt": {
2997
"path": {
2998
"description": "Default site thumbnail image alt text for `twitter` /`open-graph`\n"
2999
}
3000
},
3001
"comments": {
3002
"schema": {
3003
"ref": "document-comments-configuration"
3004
}
3005
},
3006
"open-graph": {
3007
"anyOf": [
3008
"boolean",
3009
{
3010
"ref": "open-graph-config"
3011
}
3012
],
3013
"description": "Publish open graph metadata"
3014
},
3015
"twitter-card": {
3016
"anyOf": [
3017
"boolean",
3018
{
3019
"ref": "twitter-card-config"
3020
}
3021
],
3022
"description": "Publish twitter card metadata"
3023
},
3024
"other-links": {
3025
"schema": {
3026
"ref": "other-links"
3027
},
3028
"tags": {
3029
"formats": [
3030
"$html-doc"
3031
]
3032
},
3033
"description": "A list of other links to appear below the TOC."
3034
},
3035
"code-links": {
3036
"schema": {
3037
"anyOf": [
3038
"boolean",
3039
{
3040
"ref": "code-links-schema"
3041
}
3042
]
3043
},
3044
"tags": {
3045
"formats": [
3046
"$html-doc"
3047
]
3048
},
3049
"description": "A list of code links to appear with this document."
3050
},
3051
"drafts": {
3052
"schema": {
3053
"maybeArrayOf": "path"
3054
},
3055
"description": "A list of input documents that should be treated as drafts"
3056
},
3057
"draft-mode": {
3058
"schema": {
3059
"enum": [
3060
"visible",
3061
"unlinked",
3062
"gone"
3063
]
3064
},
3065
"description": {
3066
"short": "How to handle drafts that are encountered.",
3067
"long": "How to handle drafts that are encountered.\n\n`visible` - the draft will visible and fully available\n`unlinked` - the draft will be rendered, but will not appear in navigation, search, or listings.\n`gone` - the draft will have no content and will not be linked to (default).\n"
3068
}
3069
}
3070
}
3071
}
3072
},
3073
{
3074
"id": "book-schema",
3075
"schema": {
3076
"object": {
3077
"closed": true,
3078
"super": {
3079
"resolveRef": "base-website"
3080
},
3081
"properties": {
3082
"title": {
3083
"string": {
3084
"description": "Book title"
3085
}
3086
},
3087
"subtitle": {
3088
"string": {
3089
"description": "Book subtitle"
3090
}
3091
},
3092
"author": {
3093
"maybeArrayOf": {
3094
"anyOf": [
3095
"string",
3096
"object"
3097
],
3098
"description": "Author or authors of the book"
3099
}
3100
},
3101
"date": {
3102
"string": {
3103
"description": "Book publication date"
3104
}
3105
},
3106
"date-format": {
3107
"string": {
3108
"description": "Format string for dates in the book"
3109
}
3110
},
3111
"abstract": {
3112
"string": {
3113
"description": "Book abstract"
3114
}
3115
},
3116
"description": {
3117
"string": {
3118
"description": "Description metadata for HTML version of book"
3119
}
3120
},
3121
"chapters": {
3122
"schema": {
3123
"ref": "chapter-list"
3124
},
3125
"description": "Book part and chapter files",
3126
"hidden": true
3127
},
3128
"appendices": {
3129
"schema": {
3130
"ref": "chapter-list"
3131
},
3132
"description": "Book appendix files",
3133
"hidden": true
3134
},
3135
"references": {
3136
"path": {
3137
"description": "Book references file"
3138
}
3139
},
3140
"output-file": {
3141
"path": {
3142
"description": "Base name for single-file output (e.g. PDF, ePub, docx)"
3143
}
3144
},
3145
"cover-image": {
3146
"path": {
3147
"description": "Cover image (used in HTML and ePub formats)"
3148
}
3149
},
3150
"cover-image-alt": {
3151
"string": {
3152
"description": "Alternative text for cover image (used in HTML format)"
3153
}
3154
},
3155
"sharing": {
3156
"maybeArrayOf": {
3157
"enum": [
3158
"twitter",
3159
"facebook",
3160
"linkedin"
3161
],
3162
"description": "Sharing buttons to include on navbar or sidebar\n(one or more of `twitter`, `facebook`, `linkedin`)\n"
3163
}
3164
},
3165
"downloads": {
3166
"maybeArrayOf": {
3167
"enum": [
3168
"pdf",
3169
"epub",
3170
"docx"
3171
],
3172
"description": "Download buttons for other formats to include on navbar or sidebar\n(one or more of `pdf`, `epub`, and `docx`)\n"
3173
}
3174
},
3175
"tools": {
3176
"arrayOf": {
3177
"schema": {
3178
"ref": "navigation-item"
3179
},
3180
"description": "Custom tools for navbar or sidebar"
3181
}
3182
},
3183
"doi": {
3184
"string": {
3185
"tags": {
3186
"formats": [
3187
"$html-doc"
3188
]
3189
},
3190
"description": "The Digital Object Identifier for this book."
3191
}
3192
}
3193
}
3194
}
3195
}
3196
},
3197
{
3198
"id": "chapter-item",
3199
"anyOf": [
3200
{
3201
"ref": "navigation-item"
3202
},
3203
{
3204
"object": {
3205
"properties": {
3206
"part": {
3207
"string": {
3208
"description": "Part title or path to input file"
3209
}
3210
},
3211
"chapters": {
3212
"arrayOf": {
3213
"ref": "navigation-item"
3214
},
3215
"description": "Path to chapter input file"
3216
}
3217
},
3218
"required": [
3219
"part"
3220
]
3221
}
3222
}
3223
]
3224
},
3225
{
3226
"id": "chapter-list",
3227
"arrayOf": {
3228
"ref": "chapter-item"
3229
}
3230
},
3231
{
3232
"id": "other-links",
3233
"arrayOf": {
3234
"object": {
3235
"properties": {
3236
"text": {
3237
"string": {
3238
"description": "The text for the link."
3239
}
3240
},
3241
"href": {
3242
"string": {
3243
"description": "The href for the link."
3244
}
3245
},
3246
"icon": {
3247
"string": {
3248
"description": "The bootstrap icon name for the link."
3249
}
3250
},
3251
"rel": {
3252
"string": {
3253
"description": "The rel attribute value for the link."
3254
}
3255
},
3256
"target": {
3257
"string": {
3258
"description": "The target attribute value for the link."
3259
}
3260
}
3261
},
3262
"required": [
3263
"text",
3264
"href"
3265
]
3266
}
3267
}
3268
},
3269
{
3270
"id": "crossref-labels-schema",
3271
"string": {
3272
"completions": [
3273
"alpha",
3274
"arabic",
3275
"roman"
3276
]
3277
}
3278
},
3279
{
3280
"id": "epub-contributor",
3281
"anyOf": [
3282
"string",
3283
{
3284
"maybeArrayOf": {
3285
"object": {
3286
"closed": true,
3287
"properties": {
3288
"role": {
3289
"string": {
3290
"description": {
3291
"short": "The role of this creator or contributor.",
3292
"long": "The role of this creator or contributor using \n[MARC relators](https://loc.gov/marc/relators/relaterm.html). Human readable\ntranslations to commonly used relators (e.g. 'author', 'editor') will \nattempt to be automatically translated.\n"
3293
}
3294
}
3295
},
3296
"file-as": {
3297
"string": {
3298
"description": "An alternate version of the creator or contributor text used for alphabatizing."
3299
}
3300
},
3301
"text": {
3302
"string": {
3303
"description": "The text describing the creator or contributor (for example, creator name)."
3304
}
3305
}
3306
}
3307
}
3308
}
3309
}
3310
]
3311
},
3312
{
3313
"id": "format-language",
3314
"object": {
3315
"properties": {
3316
"toc-title-document": "string",
3317
"toc-title-website": "string",
3318
"related-formats-title": "string",
3319
"related-notebooks-title": "string",
3320
"callout-tip-title": "string",
3321
"callout-note-title": "string",
3322
"callout-warning-title": "string",
3323
"callout-important-title": "string",
3324
"callout-caution-title": "string",
3325
"section-title-abstract": "string",
3326
"section-title-footnotes": "string",
3327
"section-title-appendices": "string",
3328
"code-summary": "string",
3329
"code-tools-menu-caption": "string",
3330
"code-tools-show-all-code": "string",
3331
"code-tools-hide-all-code": "string",
3332
"code-tools-view-source": "string",
3333
"code-tools-source-code": "string",
3334
"search-no-results-text": "string",
3335
"copy-button-tooltip": "string",
3336
"copy-button-tooltip-success": "string",
3337
"repo-action-links-edit": "string",
3338
"repo-action-links-source": "string",
3339
"repo-action-links-issue": "string",
3340
"search-matching-documents-text": "string",
3341
"search-copy-link-title": "string",
3342
"search-hide-matches-text": "string",
3343
"search-more-match-text": "string",
3344
"search-more-matches-text": "string",
3345
"search-clear-button-title": "string",
3346
"search-text-placeholder": "string",
3347
"search-detached-cancel-button-title": "string",
3348
"search-submit-button-title": "string",
3349
"crossref-fig-title": "string",
3350
"crossref-tbl-title": "string",
3351
"crossref-lst-title": "string",
3352
"crossref-thm-title": "string",
3353
"crossref-lem-title": "string",
3354
"crossref-cor-title": "string",
3355
"crossref-prp-title": "string",
3356
"crossref-cnj-title": "string",
3357
"crossref-def-title": "string",
3358
"crossref-exm-title": "string",
3359
"crossref-exr-title": "string",
3360
"crossref-fig-prefix": "string",
3361
"crossref-tbl-prefix": "string",
3362
"crossref-lst-prefix": "string",
3363
"crossref-ch-prefix": "string",
3364
"crossref-apx-prefix": "string",
3365
"crossref-sec-prefix": "string",
3366
"crossref-eq-prefix": "string",
3367
"crossref-thm-prefix": "string",
3368
"crossref-lem-prefix": "string",
3369
"crossref-cor-prefix": "string",
3370
"crossref-prp-prefix": "string",
3371
"crossref-cnj-prefix": "string",
3372
"crossref-def-prefix": "string",
3373
"crossref-exm-prefix": "string",
3374
"crossref-exr-prefix": "string",
3375
"crossref-lof-title": "string",
3376
"crossref-lot-title": "string",
3377
"crossref-lol-title": "string"
3378
},
3379
"errorDescription": "be a format language description object"
3380
}
3381
},
3382
{
3383
"id": "website-about",
3384
"object": {
3385
"closed": true,
3386
"required": [
3387
"template"
3388
],
3389
"properties": {
3390
"id": {
3391
"string": {
3392
"description": {
3393
"short": "The target id for the about page.",
3394
"long": "The target id of this about page. When the about page is rendered, it will \nplace read the contents of a `div` with this id into the about template that you \nhave selected (and replace the contents with the rendered about content).\n\nIf no such `div` is defined on the page, a `div` with this id will be created \nand appended to the end of the page.\n"
3395
}
3396
}
3397
},
3398
"template": {
3399
"anyOf": [
3400
{
3401
"enum": [
3402
"jolla",
3403
"trestles",
3404
"solana",
3405
"marquee",
3406
"broadside"
3407
]
3408
},
3409
"path"
3410
],
3411
"description": {
3412
"short": "The template to use to layout this about page.",
3413
"long": "The template to use to layout this about page. Choose from:\n\n- `jolla`\n- `trestles`\n- `solana`\n- `marquee`\n- `broadside`\n"
3414
}
3415
},
3416
"image": {
3417
"path": {
3418
"description": {
3419
"short": "The path to the main image on the about page.",
3420
"long": "The path to the main image on the about page. If not specified, \nthe `image` provided for the document itself will be used.\n"
3421
}
3422
}
3423
},
3424
"image-alt": {
3425
"path": {
3426
"description": "The alt text for the main image on the about page."
3427
}
3428
},
3429
"image-title": {
3430
"path": {
3431
"description": "The title for the main image on the about page."
3432
}
3433
},
3434
"image-width": {
3435
"string": {
3436
"description": {
3437
"short": "A valid CSS width for the about page image.",
3438
"long": "A valid CSS width for the about page image.\n"
3439
}
3440
}
3441
},
3442
"image-shape": {
3443
"enum": [
3444
"rectangle",
3445
"round",
3446
"rounded"
3447
],
3448
"description": {
3449
"short": "The shape of the image on the about page.",
3450
"long": "The shape of the image on the about page.\n\n- `rectangle`\n- `round`\n- `rounded`\n"
3451
}
3452
},
3453
"links": {
3454
"arrayOf": {
3455
"ref": "navigation-item"
3456
}
3457
}
3458
}
3459
}
3460
},
3461
{
3462
"id": "website-listing",
3463
"object": {
3464
"closed": true,
3465
"properties": {
3466
"id": {
3467
"string": {
3468
"description": {
3469
"short": "The id of this listing.",
3470
"long": "The id of this listing. When the listing is rendered, it will \nplace the contents into a `div` with this id. If no such `div` is defined on the \npage, a `div` with this id will be created and appended to the end of the page.\n\nIf no `id` is provided for a listing, Quarto will synthesize one when rendering the page.\n"
3471
}
3472
}
3473
},
3474
"type": {
3475
"enum": [
3476
"default",
3477
"table",
3478
"grid",
3479
"custom"
3480
],
3481
"description": {
3482
"short": "The type of listing to create.",
3483
"long": "The type of listing to create. Choose one of:\n\n- `default`: A blog style list of items\n- `table`: A table of items\n- `grid`: A grid of item cards\n- `custom`: A custom template, provided by the `template` field\n"
3484
}
3485
},
3486
"contents": {
3487
"maybeArrayOf": {
3488
"anyOf": [
3489
"string",
3490
{
3491
"ref": "website-listing-contents-object"
3492
}
3493
]
3494
},
3495
"description": "The files or path globs of Quarto documents or YAML files that should be included in the listing."
3496
},
3497
"sort": {
3498
"anyOf": [
3499
"boolean",
3500
{
3501
"maybeArrayOf": "string"
3502
}
3503
],
3504
"description": {
3505
"short": "Sort items in the listing by these fields.",
3506
"long": "Sort items in the listing by these fields. The sort key is made up of a \nfield name followed by a direction `asc` or `desc`.\n\nFor example:\n`date asc`\n\nUse `sort:false` to use the unsorted original order of items.\n"
3507
}
3508
},
3509
"max-items": {
3510
"number": {
3511
"description": "The maximum number of items to include in this listing."
3512
}
3513
},
3514
"page-size": {
3515
"number": {
3516
"description": "The number of items to display on a page."
3517
}
3518
},
3519
"sort-ui": {
3520
"anyOf": [
3521
"boolean",
3522
{
3523
"arrayOf": "string"
3524
}
3525
],
3526
"description": {
3527
"short": "Shows or hides the sorting control for the listing.",
3528
"long": "Shows or hides the sorting control for the listing. To control the \nfields that will be displayed in the sorting control, provide a list\nof field names.\n"
3529
}
3530
},
3531
"filter-ui": {
3532
"anyOf": [
3533
"boolean",
3534
{
3535
"arrayOf": "string"
3536
}
3537
],
3538
"description": {
3539
"short": "Shows or hides the filtering control for the listing.",
3540
"long": "Shows or hides the filtering control for the listing. To control the \nfields that will be used to filter the listing, provide a list\nof field names. By default all fields of the listing will be used\nwhen filtering.\n"
3541
}
3542
},
3543
"categories": {
3544
"anyOf": [
3545
"boolean",
3546
{
3547
"enum": [
3548
"numbered",
3549
"unnumbered",
3550
"cloud"
3551
]
3552
}
3553
],
3554
"description": {
3555
"short": "Display item categories from this listing in the margin of the page.",
3556
"long": "Display item categories from this listing in the margin of the page.\n\n - `numbered`: Category list with number of items\n - `unnumbered`: Category list\n - `cloud`: Word cloud style categories\n"
3557
}
3558
},
3559
"feed": {
3560
"anyOf": [
3561
"boolean",
3562
{
3563
"object": {
3564
"closed": true,
3565
"properties": {
3566
"items": {
3567
"number": {
3568
"description": "The number of items to include in your feed. Defaults to 20.\n"
3569
}
3570
},
3571
"type": {
3572
"enum": [
3573
"full",
3574
"partial",
3575
"metadata"
3576
],
3577
"description": {
3578
"short": "Whether to include full or partial content in the feed.",
3579
"long": "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n- `metadata`: Use only the title, description, and other document metadata in the feed.\n"
3580
}
3581
},
3582
"title": {
3583
"string": {
3584
"description": {
3585
"short": "The title for this feed.",
3586
"long": "The title for this feed. Defaults to the site title provided the Quarto project.\n"
3587
}
3588
}
3589
},
3590
"image": {
3591
"path": {
3592
"description": {
3593
"short": "The path to an image for this feed.",
3594
"long": "The path to an image for this feed. If not specified, the image for the page the listing \nappears on will be used, otherwise an image will be used if specified for the site \nin the Quarto project.\n"
3595
}
3596
}
3597
},
3598
"description": {
3599
"string": {
3600
"description": {
3601
"short": "The description of this feed.",
3602
"long": "The description of this feed. If not specified, the description for the page the \nlisting appears on will be used, otherwise the description \nof the site will be used if specified in the Quarto project.\n"
3603
}
3604
}
3605
},
3606
"language": {
3607
"string": {
3608
"description": {
3609
"short": "The language of the feed.",
3610
"long": "The language of the feed. Omitted if not specified. \nSee [https://www.rssboard.org/rss-language-codes](https://www.rssboard.org/rss-language-codes)\nfor a list of valid language codes.\n"
3611
}
3612
}
3613
},
3614
"categories": {
3615
"maybeArrayOf": {
3616
"string": {
3617
"description": "A list of categories for which to create separate RSS feeds containing only posts with that category"
3618
}
3619
}
3620
},
3621
"xml-stylesheet": {
3622
"path": {
3623
"description": "The path to an XML stylesheet (XSL file) used to style the RSS feed."
3624
}
3625
}
3626
}
3627
}
3628
}
3629
],
3630
"description": "Enables an RSS feed for the listing."
3631
},
3632
"date-format": {
3633
"string": {
3634
"description": {
3635
"short": "The date format to use when displaying dates (e.g. d-M-yyy).",
3636
"long": "The date format to use when displaying dates (e.g. d-M-yyy). \nLearn more about supported date formatting values [here](https://quarto.org/docs/reference/dates.html).\n"
3637
}
3638
}
3639
},
3640
"max-description-length": {
3641
"number": {
3642
"description": {
3643
"short": "The maximum length (in characters) of the description displayed in the listing.",
3644
"long": "The maximum length (in characters) of the description displayed in the listing.\nDefaults to 175.\n"
3645
}
3646
}
3647
},
3648
"image-placeholder": {
3649
"string": {
3650
"description": "The default image to use if an item in the listing doesn't have an image."
3651
}
3652
},
3653
"image-lazy-loading": {
3654
"boolean": {
3655
"description": "If false, images in the listing will be loaded immediately. If true, images will be loaded as they come into view.",
3656
"default": true
3657
}
3658
},
3659
"image-align": {
3660
"enum": [
3661
"left",
3662
"right"
3663
],
3664
"description": "In `default` type listings, whether to place the image on the right or left side of the post content (`left` or `right`)."
3665
},
3666
"image-height": {
3667
"string": {
3668
"description": {
3669
"short": "The height of the image being displayed.",
3670
"long": "The height of the image being displayed (a CSS height string).\n\nThe width is automatically determined and the image will fill the rectangle without scaling (cropped to fill).\n"
3671
}
3672
}
3673
},
3674
"grid-columns": {
3675
"number": {
3676
"description": {
3677
"short": "In `grid` type listings, the number of columns in the grid display.",
3678
"long": "In grid type listings, the number of columns in the grid display.\nDefaults to 3.\n"
3679
}
3680
}
3681
},
3682
"grid-item-border": {
3683
"boolean": {
3684
"description": {
3685
"short": "In `grid` type listings, whether to display a border around the item card.",
3686
"long": "In grid type listings, whether to display a border around the item card. Defaults to `true`.\n"
3687
}
3688
}
3689
},
3690
"grid-item-align": {
3691
"enum": [
3692
"left",
3693
"right",
3694
"center"
3695
],
3696
"description": {
3697
"short": "In `grid` type listings, the alignment of the content within the card.",
3698
"long": "In grid type listings, the alignment of the content within the card (`left` (default), `right`, or `center`).\n"
3699
}
3700
},
3701
"table-striped": {
3702
"boolean": {
3703
"description": {
3704
"short": "In `table` type listings, display the table rows with alternating background colors.",
3705
"long": "In table type listings, display the table rows with alternating background colors.\nDefaults to `false`.\n"
3706
}
3707
}
3708
},
3709
"table-hover": {
3710
"boolean": {
3711
"description": {
3712
"short": "In `table` type listings, highlight rows of the table when the user hovers the mouse over them.",
3713
"long": "In table type listings, highlight rows of the table when the user hovers the mouse over them.\nDefaults to false.\n"
3714
}
3715
}
3716
},
3717
"template": {
3718
"path": {
3719
"description": {
3720
"short": "The path to a custom listing template.",
3721
"long": "The path to a custom listing template.\n"
3722
}
3723
}
3724
},
3725
"template-params": {
3726
"schema": "object",
3727
"description": "Parameters that are passed to the custom template."
3728
},
3729
"fields": {
3730
"arrayOf": "string",
3731
"description": {
3732
"short": "The list of fields to include in this listing",
3733
"long": "The list of fields to include in this listing.\n"
3734
}
3735
},
3736
"field-display-names": {
3737
"object": {
3738
"description": {
3739
"short": "A mapping of display names for listing fields.",
3740
"long": "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:\n\n```yaml\nlisting:\n field-display-names:\n title: \"Report\"\n```\n"
3741
}
3742
}
3743
},
3744
"field-types": {
3745
"object": {
3746
"description": {
3747
"short": "Provides the date type for the field of a listing item.",
3748
"long": "Provides the date type for the field of a listing item. Unknown fields are treated\nas strings unless a type is provided. Valid types are `date`, `number`.\n"
3749
}
3750
}
3751
},
3752
"field-links": {
3753
"arrayOf": "string",
3754
"description": {
3755
"short": "This list of fields to display as links in a table listing.",
3756
"long": "The list of fields to display as hyperlinks to the source document \nwhen the listing type is a table. By default, only the `title` or \n`filename` is displayed as a link.\n"
3757
}
3758
},
3759
"field-required": {
3760
"arrayOf": "string",
3761
"description": {
3762
"short": "Fields that items in this listing must have populated.",
3763
"long": "Fields that items in this listing must have populated.\nIf a listing is rendered and one more items in this listing \nis missing a required field, an error will occur and the render will.\n"
3764
}
3765
},
3766
"include": {
3767
"maybeArrayOf": "object",
3768
"description": "Items with matching field values will be included in the listing."
3769
},
3770
"exclude": {
3771
"maybeArrayOf": "object",
3772
"description": "Items with matching field values will be excluded from the listing."
3773
}
3774
}
3775
}
3776
},
3777
{
3778
"id": "website-listing-contents-object",
3779
"object": {
3780
"properties": {
3781
"author": {
3782
"maybeArrayOf": "string"
3783
},
3784
"date": "string",
3785
"title": "string",
3786
"subtitle": "string"
3787
}
3788
}
3789
},
3790
{
3791
"id": "csl-date",
3792
"anyOf": [
3793
"string",
3794
{
3795
"maybeArrayOf": "number"
3796
},
3797
{
3798
"object": {
3799
"properties": {
3800
"year": {
3801
"number": {
3802
"description": "The year"
3803
}
3804
},
3805
"month": {
3806
"number": {
3807
"description": "The month"
3808
}
3809
},
3810
"day": {
3811
"number": {
3812
"description": "The day"
3813
}
3814
}
3815
}
3816
}
3817
}
3818
]
3819
},
3820
{
3821
"id": "csl-person",
3822
"anyOf": [
3823
{
3824
"maybeArrayOf": "string"
3825
},
3826
{
3827
"maybeArrayOf": {
3828
"object": {
3829
"properties": {
3830
"family-name": {
3831
"string": {
3832
"description": "The family name."
3833
}
3834
},
3835
"given-name": {
3836
"string": {
3837
"description": "The given name."
3838
}
3839
}
3840
}
3841
}
3842
}
3843
}
3844
]
3845
},
3846
{
3847
"id": "csl-number",
3848
"anyOf": [
3849
"number",
3850
"string"
3851
]
3852
},
3853
{
3854
"id": "csl-item-shared",
3855
"object": {
3856
"properties": {
3857
"abstract-url": {
3858
"string": {
3859
"description": "A url to the abstract for this item."
3860
}
3861
},
3862
"accessed": {
3863
"ref": "csl-date",
3864
"description": "Date the item has been accessed."
3865
},
3866
"annote": {
3867
"string": {
3868
"description": {
3869
"short": "Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review).",
3870
"long": "Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review);\n\nFor descriptive text (e.g., in an annotated bibliography), use `note` instead\n"
3871
}
3872
}
3873
},
3874
"archive": {
3875
"string": {
3876
"description": "Archive storing the item"
3877
}
3878
},
3879
"archive-collection": {
3880
"string": {
3881
"description": "Collection the item is part of within an archive."
3882
}
3883
},
3884
"archive_collection": {
3885
"schema": "string",
3886
"hidden": true
3887
},
3888
"archive-location": {
3889
"string": {
3890
"description": "Storage location within an archive (e.g. a box and folder number)."
3891
}
3892
},
3893
"archive_location": {
3894
"schema": "string",
3895
"hidden": true
3896
},
3897
"archive-place": {
3898
"string": {
3899
"description": "Geographic location of the archive."
3900
}
3901
},
3902
"authority": {
3903
"string": {
3904
"description": "Issuing or judicial authority (e.g. \"USPTO\" for a patent, \"Fairfax Circuit Court\" for a legal case)."
3905
}
3906
},
3907
"available-date": {
3908
"ref": "csl-date",
3909
"description": {
3910
"short": "Date the item was initially available",
3911
"long": "Date the item was initially available (e.g. the online publication date of a journal \narticle before its formal publication date; the date a treaty was made available for signing).\n"
3912
}
3913
},
3914
"call-number": {
3915
"string": {
3916
"description": "Call number (to locate the item in a library)."
3917
}
3918
},
3919
"chair": {
3920
"ref": "csl-person",
3921
"description": "The person leading the session containing a presentation (e.g. the organizer of the `container-title` of a `speech`)."
3922
},
3923
"chapter-number": {
3924
"ref": "csl-number",
3925
"description": "Chapter number (e.g. chapter number in a book; track number on an album)."
3926
},
3927
"citation-key": {
3928
"string": {
3929
"description": {
3930
"short": "Identifier of the item in the input data file (analogous to BiTeX entrykey).",
3931
"long": "Identifier of the item in the input data file (analogous to BiTeX entrykey);\n\nUse this variable to facilitate conversion between word-processor and plain-text writing systems;\nFor an identifer intended as formatted output label for a citation \n(e.g. “Ferr78”), use `citation-label` instead\n"
3932
}
3933
}
3934
},
3935
"citation-label": {
3936
"string": {
3937
"description": {
3938
"short": "Label identifying the item in in-text citations of label styles (e.g. \"Ferr78\").",
3939
"long": "Label identifying the item in in-text citations of label styles (e.g. \"Ferr78\");\n\nMay be assigned by the CSL processor based on item metadata; For the identifier of the item \nin the input data file, use `citation-key` instead\n"
3940
}
3941
}
3942
},
3943
"citation-number": {
3944
"schema": {
3945
"ref": "csl-number",
3946
"description": "Index (starting at 1) of the cited reference in the bibliography (generated by the CSL processor)."
3947
},
3948
"hidden": true
3949
},
3950
"collection-editor": {
3951
"ref": "csl-person",
3952
"description": "Editor of the collection holding the item (e.g. the series editor for a book)."
3953
},
3954
"collection-number": {
3955
"ref": "csl-number",
3956
"description": "Number identifying the collection holding the item (e.g. the series number for a book)"
3957
},
3958
"collection-title": {
3959
"string": {
3960
"description": "Title of the collection holding the item (e.g. the series title for a book; the lecture series title for a presentation)."
3961
}
3962
},
3963
"compiler": {
3964
"ref": "csl-person",
3965
"description": "Person compiling or selecting material for an item from the works of various persons or bodies (e.g. for an anthology)."
3966
},
3967
"composer": {
3968
"ref": "csl-person",
3969
"description": "Composer (e.g. of a musical score)."
3970
},
3971
"container-author": {
3972
"ref": "csl-person",
3973
"description": "Author of the container holding the item (e.g. the book author for a book chapter)."
3974
},
3975
"container-title": {
3976
"string": {
3977
"description": {
3978
"short": "Title of the container holding the item.",
3979
"long": "Title of the container holding the item (e.g. the book title for a book chapter, \nthe journal title for a journal article; the album title for a recording; \nthe session title for multi-part presentation at a conference)\n"
3980
}
3981
}
3982
},
3983
"container-title-short": {
3984
"string": {
3985
"description": "Short/abbreviated form of container-title;"
3986
},
3987
"hidden": true
3988
},
3989
"contributor": {
3990
"ref": "csl-person",
3991
"description": "A minor contributor to the item; typically cited using “with” before the name when listed in a bibliography."
3992
},
3993
"curator": {
3994
"ref": "csl-person",
3995
"description": "Curator of an exhibit or collection (e.g. in a museum)."
3996
},
3997
"dimensions": {
3998
"string": {
3999
"description": "Physical (e.g. size) or temporal (e.g. running time) dimensions of the item."
4000
}
4001
},
4002
"director": {
4003
"ref": "csl-person",
4004
"description": "Director (e.g. of a film)."
4005
},
4006
"division": {
4007
"string": {
4008
"description": "Minor subdivision of a court with a `jurisdiction` for a legal item"
4009
}
4010
},
4011
"DOI": {
4012
"schema": "string",
4013
"hidden": true
4014
},
4015
"edition": {
4016
"ref": "csl-number",
4017
"description": "(Container) edition holding the item (e.g. \"3\" when citing a chapter in the third edition of a book)."
4018
},
4019
"editor": {
4020
"ref": "csl-person",
4021
"description": "The editor of the item."
4022
},
4023
"editorial-director": {
4024
"ref": "csl-person",
4025
"description": "Managing editor (\"Directeur de la Publication\" in French)."
4026
},
4027
"editor-translator": {
4028
"ref": "csl-person",
4029
"description": {
4030
"short": "Combined editor and translator of a work.",
4031
"long": "Combined editor and translator of a work.\n\nThe citation processory must be automatically generate if editor and translator variables \nare identical; May also be provided directly in item data.\n"
4032
}
4033
},
4034
"event": {
4035
"schema": "string",
4036
"hidden": true
4037
},
4038
"event-date": {
4039
"ref": "csl-date",
4040
"description": "Date the event related to an item took place."
4041
},
4042
"event-title": {
4043
"string": {
4044
"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)."
4045
}
4046
},
4047
"event-place": {
4048
"string": {
4049
"description": "Geographic location of the event related to the item (e.g. \"Amsterdam, The Netherlands\")."
4050
}
4051
},
4052
"executive-producer": {
4053
"ref": "csl-person",
4054
"description": "Executive producer of the item (e.g. of a television series)."
4055
},
4056
"first-reference-note-number": {
4057
"schema": {
4058
"ref": "csl-number"
4059
},
4060
"description": {
4061
"short": "Number of a preceding note containing the first reference to the item.",
4062
"long": "Number of a preceding note containing the first reference to the item\n\nAssigned by the CSL processor; Empty in non-note-based styles or when the item hasn't \nbeen cited in any preceding notes in a document\n"
4063
},
4064
"hidden": true
4065
},
4066
"fulltext-url": {
4067
"string": {
4068
"description": "A url to the full text for this item."
4069
}
4070
},
4071
"genre": {
4072
"string": {
4073
"description": {
4074
"short": "Type, class, or subtype of the item",
4075
"long": "Type, class, or subtype of the item (e.g. \"Doctoral dissertation\" for a PhD thesis; \"NIH Publication\" for an NIH technical report);\n\nDo not use for topical descriptions or categories (e.g. \"adventure\" for an adventure movie)\n"
4076
}
4077
}
4078
},
4079
"guest": {
4080
"ref": "csl-person",
4081
"description": "Guest (e.g. on a TV show or podcast)."
4082
},
4083
"host": {
4084
"ref": "csl-person",
4085
"description": "Host of the item (e.g. of a TV show or podcast)."
4086
},
4087
"id": {
4088
"anyOf": [
4089
"string",
4090
"number"
4091
],
4092
"description": "A value which uniquely identifies this item."
4093
},
4094
"illustrator": {
4095
"ref": "csl-person",
4096
"description": "Illustrator (e.g. of a children’s book or graphic novel)."
4097
},
4098
"interviewer": {
4099
"ref": "csl-person",
4100
"description": "Interviewer (e.g. of an interview)."
4101
},
4102
"isbn": {
4103
"string": {
4104
"description": "International Standard Book Number (e.g. \"978-3-8474-1017-1\")."
4105
}
4106
},
4107
"ISBN": {
4108
"schema": "string",
4109
"hidden": true
4110
},
4111
"issn": {
4112
"string": {
4113
"description": "International Standard Serial Number."
4114
}
4115
},
4116
"ISSN": {
4117
"schema": "string",
4118
"hidden": true
4119
},
4120
"issue": {
4121
"ref": "csl-number",
4122
"description": {
4123
"short": "Issue number of the item or container holding the item",
4124
"long": "Issue number of the item or container holding the item (e.g. \"5\" when citing a \njournal article from journal volume 2, issue 5);\n\nUse `volume-title` for the title of the issue, if any.\n"
4125
}
4126
},
4127
"issued": {
4128
"ref": "csl-date",
4129
"description": "Date the item was issued/published."
4130
},
4131
"jurisdiction": {
4132
"string": {
4133
"description": "Geographic scope of relevance (e.g. \"US\" for a US patent; the court hearing a legal case)."
4134
}
4135
},
4136
"keyword": {
4137
"string": {
4138
"description": "Keyword(s) or tag(s) attached to the item."
4139
}
4140
},
4141
"language": {
4142
"string": {
4143
"description": {
4144
"short": "The language of the item (used only for citation of the item).",
4145
"long": "The language of the item (used only for citation of the item).\n\nShould be entered as an ISO 639-1 two-letter language code (e.g. \"en\", \"zh\"), \noptionally with a two-letter locale code (e.g. \"de-DE\", \"de-AT\").\n\nThis does not change the language of the item, instead it documents \nwhat language the item uses (which may be used in citing the item).\n"
4146
}
4147
}
4148
},
4149
"license": {
4150
"string": {
4151
"description": {
4152
"short": "The license information applicable to an item.",
4153
"long": "The license information applicable to an item (e.g. the license an article \nor software is released under; the copyright information for an item; \nthe classification status of a document)\n"
4154
}
4155
}
4156
},
4157
"locator": {
4158
"ref": "csl-number",
4159
"description": {
4160
"short": "A cite-specific pinpointer within the item.",
4161
"long": "A cite-specific pinpointer within the item (e.g. a page number within a book, \nor a volume in a multi-volume work).\n\nMust be accompanied in the input data by a label indicating the locator type \n(see the Locators term list).\n"
4162
}
4163
},
4164
"medium": {
4165
"string": {
4166
"description": "Description of the item’s format or medium (e.g. \"CD\", \"DVD\", \"Album\", etc.)"
4167
}
4168
},
4169
"narrator": {
4170
"ref": "csl-person",
4171
"description": "Narrator (e.g. of an audio book)."
4172
},
4173
"note": {
4174
"string": {
4175
"description": "Descriptive text or notes about an item (e.g. in an annotated bibliography)."
4176
}
4177
},
4178
"number": {
4179
"ref": "csl-number",
4180
"description": "Number identifying the item (e.g. a report number)."
4181
},
4182
"number-of-pages": {
4183
"ref": "csl-number",
4184
"description": "Total number of pages of the cited item."
4185
},
4186
"number-of-volumes": {
4187
"ref": "csl-number",
4188
"description": "Total number of volumes, used when citing multi-volume books and such."
4189
},
4190
"organizer": {
4191
"ref": "csl-person",
4192
"description": "Organizer of an event (e.g. organizer of a workshop or conference)."
4193
},
4194
"original-author": {
4195
"ref": "csl-person",
4196
"description": {
4197
"short": "The original creator of a work.",
4198
"long": "The original creator of a work (e.g. the form of the author name \nlisted on the original version of a book; the historical author of a work; \nthe original songwriter or performer for a musical piece; the original \ndeveloper or programmer for a piece of software; the original author of an \nadapted work such as a book adapted into a screenplay)\n"
4199
}
4200
},
4201
"original-date": {
4202
"ref": "csl-date",
4203
"description": "Issue date of the original version."
4204
},
4205
"original-publisher": {
4206
"string": {
4207
"description": "Original publisher, for items that have been republished by a different publisher."
4208
}
4209
},
4210
"original-publisher-place": {
4211
"string": {
4212
"description": "Geographic location of the original publisher (e.g. \"London, UK\")."
4213
}
4214
},
4215
"original-title": {
4216
"string": {
4217
"description": "Title of the original version (e.g. \"Война и мир\", the untranslated Russian title of \"War and Peace\")."
4218
}
4219
},
4220
"page": {
4221
"ref": "csl-number",
4222
"description": "Range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)."
4223
},
4224
"page-first": {
4225
"ref": "csl-number",
4226
"description": "First page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)."
4227
},
4228
"page-last": {
4229
"ref": "csl-number",
4230
"description": "Last page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue)."
4231
},
4232
"part-number": {
4233
"ref": "csl-number",
4234
"description": {
4235
"short": "Number of the specific part of the item being cited (e.g. part 2 of a journal article).",
4236
"long": "Number of the specific part of the item being cited (e.g. part 2 of a journal article).\n\nUse `part-title` for the title of the part, if any.\n"
4237
}
4238
},
4239
"part-title": {
4240
"string": {
4241
"description": "Title of the specific part of an item being cited."
4242
}
4243
},
4244
"pdf-url": {
4245
"string": {
4246
"description": "A url to the pdf for this item."
4247
}
4248
},
4249
"performer": {
4250
"ref": "csl-person",
4251
"description": "Performer of an item (e.g. an actor appearing in a film; a muscian performing a piece of music)."
4252
},
4253
"pmcid": {
4254
"string": {
4255
"description": "PubMed Central reference number."
4256
}
4257
},
4258
"PMCID": {
4259
"schema": "string",
4260
"hidden": true
4261
},
4262
"pmid": {
4263
"string": {
4264
"description": "PubMed reference number."
4265
}
4266
},
4267
"PMID": {
4268
"schema": "string",
4269
"hidden": true
4270
},
4271
"printing-number": {
4272
"ref": "csl-number",
4273
"description": "Printing number of the item or container holding the item."
4274
},
4275
"producer": {
4276
"ref": "csl-person",
4277
"description": "Producer (e.g. of a television or radio broadcast)."
4278
},
4279
"public-url": {
4280
"string": {
4281
"description": "A public url for this item."
4282
}
4283
},
4284
"publisher": {
4285
"string": {
4286
"description": "The publisher of the item."
4287
}
4288
},
4289
"publisher-place": {
4290
"string": {
4291
"description": "The geographic location of the publisher."
4292
}
4293
},
4294
"recipient": {
4295
"ref": "csl-person",
4296
"description": "Recipient (e.g. of a letter)."
4297
},
4298
"reviewed-author": {
4299
"ref": "csl-person",
4300
"description": "Author of the item reviewed by the current item."
4301
},
4302
"reviewed-genre": {
4303
"string": {
4304
"description": "Type of the item being reviewed by the current item (e.g. book, film)."
4305
}
4306
},
4307
"reviewed-title": {
4308
"string": {
4309
"description": "Title of the item reviewed by the current item."
4310
}
4311
},
4312
"scale": {
4313
"string": {
4314
"description": "Scale of e.g. a map or model."
4315
}
4316
},
4317
"script-writer": {
4318
"ref": "csl-person",
4319
"description": "Writer of a script or screenplay (e.g. of a film)."
4320
},
4321
"section": {
4322
"ref": "csl-number",
4323
"description": "Section of the item or container holding the item (e.g. \"§2.0.1\" for a law; \"politics\" for a newspaper article)."
4324
},
4325
"series-creator": {
4326
"ref": "csl-person",
4327
"description": "Creator of a series (e.g. of a television series)."
4328
},
4329
"source": {
4330
"string": {
4331
"description": "Source from whence the item originates (e.g. a library catalog or database)."
4332
}
4333
},
4334
"status": {
4335
"string": {
4336
"description": "Publication status of the item (e.g. \"forthcoming\"; \"in press\"; \"advance online publication\"; \"retracted\")"
4337
}
4338
},
4339
"submitted": {
4340
"ref": "csl-date",
4341
"description": "Date the item (e.g. a manuscript) was submitted for publication."
4342
},
4343
"supplement-number": {
4344
"ref": "csl-number",
4345
"description": "Supplement number of the item or container holding the item (e.g. for secondary legal items that are regularly updated between editions)."
4346
},
4347
"title-short": {
4348
"string": {
4349
"description": "Short/abbreviated form of`title`."
4350
},
4351
"hidden": true
4352
},
4353
"translator": {
4354
"ref": "csl-person",
4355
"description": "Translator"
4356
},
4357
"type": {
4358
"enum": [
4359
"article",
4360
"article-journal",
4361
"article-magazine",
4362
"article-newspaper",
4363
"bill",
4364
"book",
4365
"broadcast",
4366
"chapter",
4367
"classic",
4368
"collection",
4369
"dataset",
4370
"document",
4371
"entry",
4372
"entry-dictionary",
4373
"entry-encyclopedia",
4374
"event",
4375
"figure",
4376
"graphic",
4377
"hearing",
4378
"interview",
4379
"legal_case",
4380
"legislation",
4381
"manuscript",
4382
"map",
4383
"motion_picture",
4384
"musical_score",
4385
"pamphlet",
4386
"paper-conference",
4387
"patent",
4388
"performance",
4389
"periodical",
4390
"personal_communication",
4391
"post",
4392
"post-weblog",
4393
"regulation",
4394
"report",
4395
"review",
4396
"review-book",
4397
"software",
4398
"song",
4399
"speech",
4400
"standard",
4401
"thesis",
4402
"treaty",
4403
"webpage"
4404
],
4405
"description": "The [type](https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types) of the item."
4406
},
4407
"url": {
4408
"string": {
4409
"description": "Uniform Resource Locator (e.g. \"https://aem.asm.org/cgi/content/full/74/9/2766\")"
4410
}
4411
},
4412
"URL": {
4413
"schema": "string",
4414
"hidden": true
4415
},
4416
"version": {
4417
"ref": "csl-number",
4418
"description": "Version of the item (e.g. \"2.0.9\" for a software program)."
4419
},
4420
"volume": {
4421
"ref": "csl-number",
4422
"description": {
4423
"short": "Volume number of the item (e.g. “2” when citing volume 2 of a book) or the container holding the item.",
4424
"long": "Volume number of the item (e.g. \"2\" when citing volume 2 of a book) or the container holding the \nitem (e.g. \"2\" when citing a chapter from volume 2 of a book).\n\nUse `volume-title` for the title of the volume, if any.\n"
4425
}
4426
},
4427
"volume-title": {
4428
"string": {
4429
"description": {
4430
"short": "Title of the volume of the item or container holding the item.",
4431
"long": "Title of the volume of the item or container holding the item.\n\nAlso use for titles of periodical special issues, special sections, and the like.\n"
4432
}
4433
}
4434
},
4435
"year-suffix": {
4436
"string": {
4437
"description": "Disambiguating year suffix in author-date styles (e.g. \"a\" in \"Doe, 1999a\")."
4438
}
4439
}
4440
}
4441
}
4442
},
4443
{
4444
"id": "csl-item",
4445
"object": {
4446
"super": {
4447
"resolveRef": "csl-item-shared"
4448
},
4449
"closed": true,
4450
"properties": {
4451
"abstract": {
4452
"string": {
4453
"description": "Abstract of the item (e.g. the abstract of a journal article)"
4454
}
4455
},
4456
"author": {
4457
"ref": "csl-person",
4458
"description": "The author(s) of the item."
4459
},
4460
"doi": {
4461
"string": {
4462
"description": "Digital Object Identifier (e.g. \"10.1128/AEM.02591-07\")"
4463
}
4464
},
4465
"references": {
4466
"string": {
4467
"description": {
4468
"short": "Resources related to the procedural history of a legal case or legislation.",
4469
"long": "Resources related to the procedural history of a legal case or legislation;\n\nCan also be used to refer to the procedural history of other items (e.g. \n\"Conference canceled\" for a presentation accepted as a conference that was subsequently \ncanceled; details of a retraction or correction notice)\n"
4470
}
4471
}
4472
},
4473
"title": {
4474
"string": {
4475
"description": "The primary title of the item."
4476
}
4477
},
4478
"id": {
4479
"anyOf": [
4480
"string",
4481
"number"
4482
],
4483
"description": "Citation identifier for the item (e.g. \"item1\"). Will be autogenerated if not provided."
4484
}
4485
}
4486
}
4487
},
4488
{
4489
"id": "citation-item",
4490
"object": {
4491
"super": {
4492
"resolveRef": "csl-item"
4493
},
4494
"closed": true,
4495
"properties": {
4496
"article-id": {
4497
"maybeArrayOf": {
4498
"anyOf": [
4499
"string",
4500
{
4501
"object": {
4502
"properties": {
4503
"type": {
4504
"string": {
4505
"description": "The type of identifier"
4506
}
4507
},
4508
"value": {
4509
"string": {
4510
"description": "The value for the identifier"
4511
}
4512
}
4513
}
4514
}
4515
}
4516
]
4517
},
4518
"description": "The unique identifier for this article."
4519
},
4520
"elocation-id": {
4521
"string": {
4522
"description": "Bibliographic identifier for a document that does not have traditional printed page numbers."
4523
}
4524
},
4525
"eissn": {
4526
"string": {
4527
"description": "Electronic International Standard Serial Number."
4528
}
4529
},
4530
"pissn": {
4531
"string": {
4532
"description": "Print International Standard Serial Number."
4533
}
4534
},
4535
"art-access-id": {
4536
"string": {
4537
"description": "Generic article accession identifier."
4538
}
4539
},
4540
"publisher-location": {
4541
"string": {
4542
"description": "The location of the publisher of this item."
4543
}
4544
},
4545
"subject": {
4546
"string": {
4547
"description": "The name of a subject or topic describing the article."
4548
}
4549
},
4550
"categories": {
4551
"maybeArrayOf": {
4552
"string": {
4553
"description": "A list of subjects or topics describing the article."
4554
}
4555
}
4556
},
4557
"container-id": {
4558
"maybeArrayOf": {
4559
"anyOf": [
4560
"string",
4561
{
4562
"object": {
4563
"properties": {
4564
"type": {
4565
"string": {
4566
"description": "The type of identifier (e.g. `nlm-ta` or `pmc`)."
4567
}
4568
},
4569
"value": {
4570
"string": {
4571
"description": "The value for the identifier"
4572
}
4573
}
4574
}
4575
}
4576
}
4577
]
4578
},
4579
"description": {
4580
"short": "External identifier of a publication or journal.",
4581
"long": "External identifier, typically assigned to a journal by \na publisher, archive, or library to provide a unique identifier for \nthe journal or publication.\n"
4582
}
4583
},
4584
"jats-type": {
4585
"string": {
4586
"description": "The type used for the JATS `article` tag."
4587
}
4588
}
4589
}
4590
}
4591
},
4592
{
4593
"id": "smart-include",
4594
"anyOf": [
4595
{
4596
"record": {
4597
"text": {
4598
"string": {
4599
"description": "Textual content to add to includes"
4600
}
4601
}
4602
}
4603
},
4604
{
4605
"record": {
4606
"file": {
4607
"string": {
4608
"description": "Name of file with content to add to includes"
4609
}
4610
}
4611
}
4612
}
4613
]
4614
},
4615
{
4616
"id": "semver",
4617
"string": {
4618
"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-]+)*))?$"
4619
},
4620
"description": "Version number according to Semantic Versioning"
4621
},
4622
{
4623
"id": "quarto-date",
4624
"anyOf": [
4625
"string",
4626
{
4627
"object": {
4628
"closed": true,
4629
"properties": {
4630
"format": "string",
4631
"value": "string"
4632
},
4633
"required": [
4634
"value"
4635
]
4636
}
4637
}
4638
]
4639
},
4640
{
4641
"id": "project-profile",
4642
"schema": {
4643
"object": {
4644
"closed": true,
4645
"properties": {
4646
"default": {
4647
"maybeArrayOf": "string",
4648
"description": "Default profile to apply if QUARTO_PROFILE is not defined.\n"
4649
},
4650
"group": {
4651
"maybeArrayOf": {
4652
"arrayOf": "string"
4653
},
4654
"description": "Define a profile group for which at least one profile is always active.\n"
4655
}
4656
}
4657
}
4658
},
4659
"description": "Specify a default profile and profile groups"
4660
},
4661
{
4662
"id": "bad-parse-schema",
4663
"schema": {
4664
"object": {
4665
"propertyNames": {
4666
"string": {
4667
"pattern": "^[^\\s]+$"
4668
}
4669
}
4670
}
4671
}
4672
},
4673
{
4674
"id": "quarto-dev-schema",
4675
"schema": {
4676
"object": {
4677
"properties": {
4678
"_quarto": {
4679
"hidden": true,
4680
"object": {
4681
"properties": {
4682
"trace-filters": "string",
4683
"tests": {
4684
"object": {
4685
"properties": {
4686
"run": {
4687
"object": {
4688
"description": "Control when tests should run",
4689
"properties": {
4690
"ci": {
4691
"boolean": {
4692
"description": "Run tests on CI (true = run, false = skip)",
4693
"default": true
4694
}
4695
},
4696
"skip": {
4697
"description": "Skip test unconditionally (true = skip with default message, string = skip with custom message)",
4698
"anyOf": [
4699
"boolean",
4700
"string"
4701
]
4702
},
4703
"os": {
4704
"description": "Run tests ONLY on these platforms (whitelist)",
4705
"anyOf": [
4706
{
4707
"enum": [
4708
"linux",
4709
"darwin",
4710
"windows"
4711
]
4712
},
4713
{
4714
"arrayOf": {
4715
"enum": [
4716
"linux",
4717
"darwin",
4718
"windows"
4719
]
4720
}
4721
}
4722
]
4723
},
4724
"not_os": {
4725
"description": "Don't run tests on these platforms (blacklist)",
4726
"anyOf": [
4727
{
4728
"enum": [
4729
"linux",
4730
"darwin",
4731
"windows"
4732
]
4733
},
4734
{
4735
"arrayOf": {
4736
"enum": [
4737
"linux",
4738
"darwin",
4739
"windows"
4740
]
4741
}
4742
}
4743
]
4744
}
4745
}
4746
}
4747
}
4748
}
4749
}
4750
}
4751
}
4752
}
4753
}
4754
}
4755
}
4756
}
4757
},
4758
{
4759
"id": "notebook-view-schema",
4760
"schema": {
4761
"object": {
4762
"properties": {
4763
"notebook": {
4764
"string": {
4765
"description": "The path to the locally referenced notebook."
4766
}
4767
},
4768
"title": {
4769
"description": "The title of the notebook when viewed.",
4770
"anyOf": [
4771
"string",
4772
"boolean"
4773
]
4774
},
4775
"url": {
4776
"string": {
4777
"description": "The url to use when viewing this notebook."
4778
}
4779
},
4780
"download-url": {
4781
"string": {
4782
"description": "The url to use when downloading the notebook from the preview"
4783
}
4784
}
4785
},
4786
"required": [
4787
"notebook"
4788
]
4789
}
4790
}
4791
},
4792
{
4793
"id": "code-links-schema",
4794
"schema": {
4795
"anyOf": [
4796
"boolean",
4797
{
4798
"maybeArrayOf": {
4799
"anyOf": [
4800
{
4801
"object": {
4802
"properties": {
4803
"icon": {
4804
"string": {
4805
"description": "The bootstrap icon for this code link."
4806
}
4807
},
4808
"text": {
4809
"string": {
4810
"description": "The text for this code link."
4811
}
4812
},
4813
"href": {
4814
"string": {
4815
"description": "The href for this code link."
4816
}
4817
},
4818
"rel": {
4819
"string": {
4820
"description": "The rel used in the `a` tag for this code link."
4821
}
4822
},
4823
"target": {
4824
"string": {
4825
"description": "The target used in the `a` tag for this code link."
4826
}
4827
}
4828
}
4829
}
4830
},
4831
{
4832
"enum": [
4833
"repo",
4834
"binder",
4835
"devcontainer"
4836
]
4837
}
4838
]
4839
}
4840
}
4841
]
4842
}
4843
},
4844
{
4845
"id": "manuscript-schema",
4846
"schema": {
4847
"object": {
4848
"closed": true,
4849
"properties": {
4850
"article": {
4851
"path": {
4852
"description": "The input document that will serve as the root document for this manuscript"
4853
}
4854
},
4855
"code-links": {
4856
"schema": {
4857
"ref": "code-links-schema"
4858
},
4859
"description": "Code links to display for this manuscript."
4860
},
4861
"manuscript-url": {
4862
"string": {
4863
"description": "The deployed url for this manuscript"
4864
}
4865
},
4866
"meca-bundle": {
4867
"anyOf": [
4868
"boolean",
4869
"string"
4870
],
4871
"description": "Whether to generate a MECA bundle for this manuscript"
4872
},
4873
"notebooks": {
4874
"arrayOf": {
4875
"anyOf": [
4876
"string",
4877
{
4878
"ref": "notebook-view-schema"
4879
}
4880
]
4881
}
4882
},
4883
"resources": {
4884
"maybeArrayOf": {
4885
"schema": "path",
4886
"description": "Additional file resources to be copied to output directory"
4887
}
4888
},
4889
"environment": {
4890
"maybeArrayOf": {
4891
"schema": "path",
4892
"description": "Files that specify the execution environment (e.g. renv.lock, requirements.text, etc...)"
4893
}
4894
}
4895
}
4896
}
4897
}
4898
},
4899
{
4900
"id": "brand-meta",
4901
"description": "Metadata for a brand, including the brand name and important links.\n",
4902
"object": {
4903
"closed": false,
4904
"properties": {
4905
"name": {
4906
"description": "The brand name.",
4907
"anyOf": [
4908
"string",
4909
{
4910
"object": {
4911
"properties": {
4912
"full": {
4913
"string": {
4914
"description": "The full, official or legal name of the company or brand."
4915
}
4916
},
4917
"short": {
4918
"string": {
4919
"description": "The short, informal, or common name of the company or brand."
4920
}
4921
}
4922
}
4923
}
4924
}
4925
]
4926
},
4927
"link": {
4928
"description": "Important links for the brand, including social media links. If a single string, it is the brand's home page or website. Additional fields are allowed for internal use.\n",
4929
"anyOf": [
4930
"string",
4931
{
4932
"object": {
4933
"properties": {
4934
"home": {
4935
"string": {
4936
"description": "The brand's home page or website."
4937
}
4938
},
4939
"mastodon": {
4940
"string": {
4941
"description": "The brand's Mastodon URL."
4942
}
4943
},
4944
"bluesky": {
4945
"string": {
4946
"description": "The brand's Bluesky URL."
4947
}
4948
},
4949
"github": {
4950
"string": {
4951
"description": "The brand's GitHub URL."
4952
}
4953
},
4954
"linkedin": {
4955
"string": {
4956
"description": "The brand's LinkedIn URL."
4957
}
4958
},
4959
"twitter": {
4960
"string": {
4961
"description": "The brand's Twitter URL."
4962
}
4963
},
4964
"facebook": {
4965
"string": {
4966
"description": "The brand's Facebook URL."
4967
}
4968
}
4969
}
4970
}
4971
}
4972
]
4973
}
4974
}
4975
}
4976
},
4977
{
4978
"id": "brand-string-light-dark",
4979
"anyOf": [
4980
"string",
4981
{
4982
"object": {
4983
"closed": true,
4984
"properties": {
4985
"light": {
4986
"schema": "string",
4987
"description": "A link or path to the brand's light-colored logo or icon.\n"
4988
},
4989
"dark": {
4990
"schema": "string",
4991
"description": "A link or path to the brand's dark-colored logo or icon.\n"
4992
}
4993
}
4994
}
4995
}
4996
]
4997
},
4998
{
4999
"id": "brand-logo-explicit-resource",
5000
"object": {
5001
"closed": true,
5002
"properties": {
5003
"path": "path",
5004
"alt": {
5005
"schema": "string",
5006
"description": "Alternative text for the logo, used for accessibility.\n"
5007
}
5008
},
5009
"required": [
5010
"path"
5011
]
5012
}
5013
},
5014
{
5015
"id": "brand-logo-resource",
5016
"anyOf": [
5017
"string",
5018
{
5019
"ref": "brand-logo-explicit-resource"
5020
}
5021
]
5022
},
5023
{
5024
"id": "brand-logo-single",
5025
"description": "Provide definitions and defaults for brand's logo in various formats and sizes.\n",
5026
"object": {
5027
"closed": true,
5028
"properties": {
5029
"images": {
5030
"description": "A dictionary of named logo resources.",
5031
"schema": {
5032
"object": {
5033
"additionalProperties": {
5034
"schema": {
5035
"ref": "brand-logo-resource"
5036
}
5037
}
5038
}
5039
}
5040
},
5041
"small": {
5042
"description": "A link or path to the brand's small-sized logo or icon.\n",
5043
"schema": "string"
5044
},
5045
"medium": {
5046
"description": "A link or path to the brand's medium-sized logo.\n",
5047
"schema": "string"
5048
},
5049
"large": {
5050
"description": "A link or path to the brand's large- or full-sized logo.\n",
5051
"schema": "string"
5052
}
5053
}
5054
}
5055
},
5056
{
5057
"id": "brand-logo-unified",
5058
"description": "Provide definitions and defaults for brand's logo in various formats and sizes.\n",
5059
"object": {
5060
"closed": true,
5061
"properties": {
5062
"images": {
5063
"description": "A dictionary of named logo resources.",
5064
"schema": {
5065
"object": {
5066
"additionalProperties": {
5067
"schema": {
5068
"ref": "brand-logo-resource"
5069
}
5070
}
5071
}
5072
}
5073
},
5074
"small": {
5075
"description": "A link or path to the brand's small-sized logo or icon, or a link or path to both the light and dark versions.\n",
5076
"schema": {
5077
"ref": "brand-string-light-dark"
5078
}
5079
},
5080
"medium": {
5081
"description": "A link or path to the brand's medium-sized logo, or a link or path to both the light and dark versions.\n",
5082
"schema": {
5083
"ref": "brand-string-light-dark"
5084
}
5085
},
5086
"large": {
5087
"description": "A link or path to the brand's large- or full-sized logo, or a link or path to both the light and dark versions.\n",
5088
"schema": {
5089
"ref": "brand-string-light-dark"
5090
}
5091
}
5092
}
5093
}
5094
},
5095
{
5096
"id": "brand-named-logo",
5097
"description": "Names of customizeable logos",
5098
"enum": [
5099
"small",
5100
"medium",
5101
"large"
5102
]
5103
},
5104
{
5105
"id": "logo-options",
5106
"object": {
5107
"closed": false,
5108
"properties": {
5109
"path": {
5110
"schema": "path",
5111
"description": "Path or brand.yml logo resource name.\n"
5112
},
5113
"alt": {
5114
"schema": "string",
5115
"description": "Alternative text for the logo, used for accessibility.\n"
5116
}
5117
},
5118
"required": [
5119
"path"
5120
]
5121
}
5122
},
5123
{
5124
"id": "logo-specifier",
5125
"anyOf": [
5126
"string",
5127
{
5128
"schema": {
5129
"ref": "logo-options"
5130
}
5131
}
5132
]
5133
},
5134
{
5135
"id": "logo-options-path-optional",
5136
"object": {
5137
"closed": false,
5138
"properties": {
5139
"path": {
5140
"schema": "path",
5141
"description": "Path or brand.yml logo resource name.\n"
5142
},
5143
"alt": {
5144
"schema": "string",
5145
"description": "Alternative text for the logo, used for accessibility.\n"
5146
}
5147
}
5148
}
5149
},
5150
{
5151
"id": "logo-specifier-path-optional",
5152
"anyOf": [
5153
"string",
5154
{
5155
"schema": {
5156
"ref": "logo-options-path-optional"
5157
}
5158
}
5159
]
5160
},
5161
{
5162
"id": "logo-light-dark-specifier",
5163
"description": "Any of the ways a logo can be specified: string, object, or light/dark object of string or object. Use `false` to explicitly disable the logo.\n",
5164
"anyOf": [
5165
{
5166
"enum": [
5167
false
5168
]
5169
},
5170
{
5171
"ref": "logo-specifier"
5172
},
5173
{
5174
"object": {
5175
"closed": true,
5176
"properties": {
5177
"light": {
5178
"schema": {
5179
"ref": "logo-specifier"
5180
},
5181
"description": "Specification of a light logo\n"
5182
},
5183
"dark": {
5184
"schema": {
5185
"ref": "logo-specifier"
5186
},
5187
"description": "Specification of a dark logo\n"
5188
}
5189
}
5190
}
5191
}
5192
]
5193
},
5194
{
5195
"id": "logo-light-dark-specifier-path-optional",
5196
"description": "Any of the ways a logo can be specified: string, object, or light/dark object of string or object. Use `false` to explicitly disable the logo.\n",
5197
"anyOf": [
5198
{
5199
"enum": [
5200
false
5201
]
5202
},
5203
{
5204
"ref": "logo-specifier-path-optional"
5205
},
5206
{
5207
"object": {
5208
"closed": true,
5209
"properties": {
5210
"light": {
5211
"schema": {
5212
"ref": "logo-specifier-path-optional"
5213
},
5214
"description": "Specification of a light logo\n"
5215
},
5216
"dark": {
5217
"schema": {
5218
"ref": "logo-specifier-path-optional"
5219
},
5220
"description": "Specification of a dark logo\n"
5221
}
5222
}
5223
}
5224
}
5225
]
5226
},
5227
{
5228
"id": "normalized-logo-light-dark-specifier",
5229
"description": "Any of the ways a logo can be specified: string, object, or light/dark object of string or object\n",
5230
"object": {
5231
"closed": true,
5232
"properties": {
5233
"light": {
5234
"schema": {
5235
"ref": "logo-options"
5236
},
5237
"description": "Options for a light logo\n"
5238
},
5239
"dark": {
5240
"schema": {
5241
"ref": "logo-options"
5242
},
5243
"description": "Options for a dark logo\n"
5244
}
5245
}
5246
}
5247
},
5248
{
5249
"id": "brand-color-value",
5250
"schema": "string"
5251
},
5252
{
5253
"id": "brand-color-single",
5254
"description": "The brand's custom color palette and theme.\n",
5255
"object": {
5256
"closed": true,
5257
"properties": {
5258
"palette": {
5259
"description": "The brand's custom color palette. Any number of colors can be defined, each color having a custom name.\n",
5260
"object": {
5261
"additionalProperties": {
5262
"schema": {
5263
"ref": "brand-color-value"
5264
}
5265
}
5266
}
5267
},
5268
"foreground": {
5269
"description": "The foreground color, used for text.",
5270
"schema": {
5271
"ref": "brand-color-value"
5272
},
5273
"default": "black"
5274
},
5275
"background": {
5276
"description": "The background color, used for the page background.",
5277
"schema": {
5278
"ref": "brand-color-value"
5279
},
5280
"default": "white"
5281
},
5282
"primary": {
5283
"description": "The primary accent color, i.e. the main theme color. Typically used for hyperlinks, active states, primary action buttons, etc.\n",
5284
"schema": {
5285
"ref": "brand-color-value"
5286
}
5287
},
5288
"secondary": {
5289
"description": "The secondary accent color. Typically used for lighter text or disabled states.\n",
5290
"schema": {
5291
"ref": "brand-color-value"
5292
}
5293
},
5294
"tertiary": {
5295
"description": "The tertiary accent color. Typically an even lighter color, used for hover states, accents, and wells.\n",
5296
"schema": {
5297
"ref": "brand-color-value"
5298
}
5299
},
5300
"success": {
5301
"description": "The color used for positive or successful actions and information.",
5302
"schema": {
5303
"ref": "brand-color-value"
5304
}
5305
},
5306
"info": {
5307
"description": "The color used for neutral or informational actions and information.",
5308
"schema": {
5309
"ref": "brand-color-value"
5310
}
5311
},
5312
"warning": {
5313
"description": "The color used for warning or cautionary actions and information.",
5314
"schema": {
5315
"ref": "brand-color-value"
5316
}
5317
},
5318
"danger": {
5319
"description": "The color used for errors, dangerous actions, or negative information.",
5320
"schema": {
5321
"ref": "brand-color-value"
5322
}
5323
},
5324
"light": {
5325
"description": "A bright color, used as a high-contrast foreground color on dark elements or low-contrast background color on light elements.\n",
5326
"schema": {
5327
"ref": "brand-color-value"
5328
}
5329
},
5330
"dark": {
5331
"description": "A dark color, used as a high-contrast foreground color on light elements or high-contrast background color on light elements.\n",
5332
"schema": {
5333
"ref": "brand-color-value"
5334
}
5335
},
5336
"link": {
5337
"description": "The color used for hyperlinks. If not defined, the `primary` color is used.\n",
5338
"schema": {
5339
"ref": "brand-color-value"
5340
}
5341
}
5342
}
5343
}
5344
},
5345
{
5346
"id": "brand-color-light-dark",
5347
"anyOf": [
5348
{
5349
"ref": "brand-color-value"
5350
},
5351
{
5352
"object": {
5353
"closed": true,
5354
"properties": {
5355
"light": {
5356
"schema": {
5357
"ref": "brand-color-value"
5358
},
5359
"description": "A link or path to the brand's light-colored logo or icon.\n"
5360
},
5361
"dark": {
5362
"schema": {
5363
"ref": "brand-color-value"
5364
},
5365
"description": "A link or path to the brand's dark-colored logo or icon.\n"
5366
}
5367
}
5368
}
5369
}
5370
]
5371
},
5372
{
5373
"id": "brand-color-unified",
5374
"description": "The brand's custom color palette and theme.\n",
5375
"object": {
5376
"closed": true,
5377
"properties": {
5378
"palette": {
5379
"description": "The brand's custom color palette. Any number of colors can be defined, each color having a custom name.\n",
5380
"object": {
5381
"additionalProperties": {
5382
"schema": {
5383
"ref": "brand-color-value"
5384
}
5385
}
5386
}
5387
},
5388
"foreground": {
5389
"description": "The foreground color, used for text.",
5390
"schema": {
5391
"ref": "brand-color-light-dark"
5392
},
5393
"default": "black"
5394
},
5395
"background": {
5396
"description": "The background color, used for the page background.",
5397
"schema": {
5398
"ref": "brand-color-light-dark"
5399
},
5400
"default": "white"
5401
},
5402
"primary": {
5403
"description": "The primary accent color, i.e. the main theme color. Typically used for hyperlinks, active states, primary action buttons, etc.\n",
5404
"schema": {
5405
"ref": "brand-color-light-dark"
5406
}
5407
},
5408
"secondary": {
5409
"description": "The secondary accent color. Typically used for lighter text or disabled states.\n",
5410
"schema": {
5411
"ref": "brand-color-light-dark"
5412
}
5413
},
5414
"tertiary": {
5415
"description": "The tertiary accent color. Typically an even lighter color, used for hover states, accents, and wells.\n",
5416
"schema": {
5417
"ref": "brand-color-light-dark"
5418
}
5419
},
5420
"success": {
5421
"description": "The color used for positive or successful actions and information.",
5422
"schema": {
5423
"ref": "brand-color-light-dark"
5424
}
5425
},
5426
"info": {
5427
"description": "The color used for neutral or informational actions and information.",
5428
"schema": {
5429
"ref": "brand-color-light-dark"
5430
}
5431
},
5432
"warning": {
5433
"description": "The color used for warning or cautionary actions and information.",
5434
"schema": {
5435
"ref": "brand-color-light-dark"
5436
}
5437
},
5438
"danger": {
5439
"description": "The color used for errors, dangerous actions, or negative information.",
5440
"schema": {
5441
"ref": "brand-color-light-dark"
5442
}
5443
},
5444
"light": {
5445
"description": "A bright color, used as a high-contrast foreground color on dark elements or low-contrast background color on light elements.\n",
5446
"schema": {
5447
"ref": "brand-color-light-dark"
5448
}
5449
},
5450
"dark": {
5451
"description": "A dark color, used as a high-contrast foreground color on light elements or high-contrast background color on light elements.\n",
5452
"schema": {
5453
"ref": "brand-color-light-dark"
5454
}
5455
},
5456
"link": {
5457
"description": "The color used for hyperlinks. If not defined, the `primary` color is used.\n",
5458
"schema": {
5459
"ref": "brand-color-light-dark"
5460
}
5461
}
5462
}
5463
}
5464
},
5465
{
5466
"id": "brand-maybe-named-color",
5467
"description": "A color, which may be a named brand color.\n",
5468
"anyOf": [
5469
{
5470
"ref": "brand-named-theme-color"
5471
},
5472
{
5473
"schema": "string"
5474
}
5475
]
5476
},
5477
{
5478
"id": "brand-maybe-named-color-light-dark",
5479
"anyOf": [
5480
{
5481
"ref": "brand-maybe-named-color"
5482
},
5483
{
5484
"object": {
5485
"closed": true,
5486
"properties": {
5487
"light": {
5488
"schema": {
5489
"ref": "brand-maybe-named-color"
5490
},
5491
"description": "A link or path to the brand's light-colored logo or icon.\n"
5492
},
5493
"dark": {
5494
"schema": {
5495
"ref": "brand-maybe-named-color"
5496
},
5497
"description": "A link or path to the brand's dark-colored logo or icon.\n"
5498
}
5499
}
5500
}
5501
}
5502
]
5503
},
5504
{
5505
"id": "brand-named-theme-color",
5506
"description": "A named brand color, taken either from `color.theme` or `color.palette` (in that order).\n",
5507
"enum": [
5508
"foreground",
5509
"background",
5510
"primary",
5511
"secondary",
5512
"tertiary",
5513
"success",
5514
"info",
5515
"warning",
5516
"danger",
5517
"light",
5518
"dark",
5519
"link"
5520
]
5521
},
5522
{
5523
"id": "brand-typography-single",
5524
"description": "Typography definitions for the brand.",
5525
"object": {
5526
"closed": true,
5527
"properties": {
5528
"fonts": {
5529
"description": "Font files and definitions for the brand.",
5530
"arrayOf": {
5531
"ref": "brand-font"
5532
}
5533
},
5534
"base": {
5535
"description": "The base font settings for the brand. These are used as the default for all text.\n",
5536
"ref": "brand-typography-options-base"
5537
},
5538
"headings": {
5539
"description": "Settings for headings, or a string specifying the font family only.",
5540
"ref": "brand-typography-options-headings-single"
5541
},
5542
"monospace": {
5543
"description": "Settings for monospace text, or a string specifying the font family only.",
5544
"ref": "brand-typography-options-monospace-single"
5545
},
5546
"monospace-inline": {
5547
"description": "Settings for inline code, or a string specifying the font family only.",
5548
"ref": "brand-typography-options-monospace-inline-single"
5549
},
5550
"monospace-block": {
5551
"description": "Settings for code blocks, or a string specifying the font family only.",
5552
"ref": "brand-typography-options-monospace-block-single"
5553
},
5554
"link": {
5555
"description": "Settings for links.",
5556
"ref": "brand-typography-options-link-single"
5557
}
5558
}
5559
}
5560
},
5561
{
5562
"id": "brand-typography-unified",
5563
"description": "Typography definitions for the brand.",
5564
"object": {
5565
"closed": true,
5566
"properties": {
5567
"fonts": {
5568
"description": "Font files and definitions for the brand.",
5569
"arrayOf": {
5570
"ref": "brand-font"
5571
}
5572
},
5573
"base": {
5574
"description": "The base font settings for the brand. These are used as the default for all text.\n",
5575
"ref": "brand-typography-options-base"
5576
},
5577
"headings": {
5578
"description": "Settings for headings, or a string specifying the font family only.",
5579
"ref": "brand-typography-options-headings-unified"
5580
},
5581
"monospace": {
5582
"description": "Settings for monospace text, or a string specifying the font family only.",
5583
"ref": "brand-typography-options-monospace-unified"
5584
},
5585
"monospace-inline": {
5586
"description": "Settings for inline code, or a string specifying the font family only.",
5587
"ref": "brand-typography-options-monospace-inline-unified"
5588
},
5589
"monospace-block": {
5590
"description": "Settings for code blocks, or a string specifying the font family only.",
5591
"ref": "brand-typography-options-monospace-block-unified"
5592
},
5593
"link": {
5594
"description": "Settings for links.",
5595
"ref": "brand-typography-options-link-unified"
5596
}
5597
}
5598
}
5599
},
5600
{
5601
"id": "brand-typography-options-base",
5602
"description": "Base typographic options.",
5603
"anyOf": [
5604
"string",
5605
{
5606
"object": {
5607
"closed": true,
5608
"properties": {
5609
"family": "string",
5610
"size": "string",
5611
"weight": {
5612
"ref": "brand-font-weight"
5613
},
5614
"line-height": {
5615
"ref": "line-height-number-string"
5616
}
5617
}
5618
}
5619
}
5620
]
5621
},
5622
{
5623
"id": "brand-typography-options-headings-single",
5624
"description": "Typographic options for headings.",
5625
"anyOf": [
5626
"string",
5627
{
5628
"object": {
5629
"closed": true,
5630
"properties": {
5631
"family": "string",
5632
"weight": {
5633
"ref": "brand-font-weight"
5634
},
5635
"style": {
5636
"ref": "brand-font-style"
5637
},
5638
"color": {
5639
"ref": "brand-maybe-named-color"
5640
},
5641
"line-height": {
5642
"ref": "line-height-number-string"
5643
}
5644
}
5645
}
5646
}
5647
]
5648
},
5649
{
5650
"id": "brand-typography-options-headings-unified",
5651
"description": "Typographic options for headings.",
5652
"anyOf": [
5653
"string",
5654
{
5655
"object": {
5656
"closed": true,
5657
"properties": {
5658
"family": "string",
5659
"weight": {
5660
"ref": "brand-font-weight"
5661
},
5662
"style": {
5663
"ref": "brand-font-style"
5664
},
5665
"color": {
5666
"ref": "brand-maybe-named-color-light-dark"
5667
},
5668
"line-height": {
5669
"ref": "line-height-number-string"
5670
}
5671
}
5672
}
5673
}
5674
]
5675
},
5676
{
5677
"id": "brand-typography-options-monospace-single",
5678
"description": "Typographic options for monospace elements.",
5679
"anyOf": [
5680
"string",
5681
{
5682
"object": {
5683
"closed": true,
5684
"properties": {
5685
"family": "string",
5686
"size": "string",
5687
"weight": {
5688
"ref": "brand-font-weight"
5689
},
5690
"color": {
5691
"ref": "brand-maybe-named-color"
5692
},
5693
"background-color": {
5694
"ref": "brand-maybe-named-color"
5695
}
5696
}
5697
}
5698
}
5699
]
5700
},
5701
{
5702
"id": "brand-typography-options-monospace-unified",
5703
"description": "Typographic options for monospace elements.",
5704
"anyOf": [
5705
"string",
5706
{
5707
"object": {
5708
"closed": true,
5709
"properties": {
5710
"family": "string",
5711
"size": "string",
5712
"weight": {
5713
"ref": "brand-font-weight"
5714
},
5715
"color": {
5716
"ref": "brand-maybe-named-color-light-dark"
5717
},
5718
"background-color": {
5719
"ref": "brand-maybe-named-color-light-dark"
5720
}
5721
}
5722
}
5723
}
5724
]
5725
},
5726
{
5727
"id": "brand-typography-options-monospace-inline-single",
5728
"description": "Typographic options for inline monospace elements.",
5729
"anyOf": [
5730
"string",
5731
{
5732
"object": {
5733
"closed": true,
5734
"properties": {
5735
"family": "string",
5736
"size": "string",
5737
"weight": {
5738
"ref": "brand-font-weight"
5739
},
5740
"color": {
5741
"ref": "brand-maybe-named-color"
5742
},
5743
"background-color": {
5744
"ref": "brand-maybe-named-color"
5745
}
5746
}
5747
}
5748
}
5749
]
5750
},
5751
{
5752
"id": "brand-typography-options-monospace-inline-unified",
5753
"description": "Typographic options for inline monospace elements.",
5754
"anyOf": [
5755
"string",
5756
{
5757
"object": {
5758
"closed": true,
5759
"properties": {
5760
"family": "string",
5761
"size": "string",
5762
"weight": {
5763
"ref": "brand-font-weight"
5764
},
5765
"color": {
5766
"ref": "brand-maybe-named-color-light-dark"
5767
},
5768
"background-color": {
5769
"ref": "brand-maybe-named-color-light-dark"
5770
}
5771
}
5772
}
5773
}
5774
]
5775
},
5776
{
5777
"id": "line-height-number-string",
5778
"description": "Line height",
5779
"anyOf": [
5780
"number",
5781
"string"
5782
]
5783
},
5784
{
5785
"id": "brand-typography-options-monospace-block-single",
5786
"description": "Typographic options for block monospace elements.",
5787
"anyOf": [
5788
"string",
5789
{
5790
"object": {
5791
"closed": true,
5792
"properties": {
5793
"family": "string",
5794
"size": "string",
5795
"weight": {
5796
"ref": "brand-font-weight"
5797
},
5798
"color": {
5799
"ref": "brand-maybe-named-color"
5800
},
5801
"background-color": {
5802
"ref": "brand-maybe-named-color"
5803
},
5804
"line-height": {
5805
"ref": "line-height-number-string"
5806
}
5807
}
5808
}
5809
}
5810
]
5811
},
5812
{
5813
"id": "brand-typography-options-monospace-block-unified",
5814
"description": "Typographic options for block monospace elements.",
5815
"anyOf": [
5816
"string",
5817
{
5818
"object": {
5819
"closed": true,
5820
"properties": {
5821
"family": "string",
5822
"size": "string",
5823
"weight": {
5824
"ref": "brand-font-weight"
5825
},
5826
"color": {
5827
"ref": "brand-maybe-named-color-light-dark"
5828
},
5829
"background-color": {
5830
"ref": "brand-maybe-named-color-light-dark"
5831
},
5832
"line-height": {
5833
"ref": "line-height-number-string"
5834
}
5835
}
5836
}
5837
}
5838
]
5839
},
5840
{
5841
"id": "brand-typography-options-link-single",
5842
"description": "Typographic options for inline monospace elements.",
5843
"anyOf": [
5844
"string",
5845
{
5846
"object": {
5847
"closed": true,
5848
"properties": {
5849
"weight": {
5850
"ref": "brand-font-weight"
5851
},
5852
"color": {
5853
"ref": "brand-maybe-named-color"
5854
},
5855
"background-color": {
5856
"ref": "brand-maybe-named-color"
5857
},
5858
"decoration": "string"
5859
}
5860
}
5861
}
5862
]
5863
},
5864
{
5865
"id": "brand-typography-options-link-unified",
5866
"description": "Typographic options for inline monospace elements.",
5867
"anyOf": [
5868
"string",
5869
{
5870
"object": {
5871
"closed": true,
5872
"properties": {
5873
"weight": {
5874
"ref": "brand-font-weight"
5875
},
5876
"color": {
5877
"ref": "brand-maybe-named-color-light-dark"
5878
},
5879
"background-color": {
5880
"ref": "brand-maybe-named-color-light-dark"
5881
},
5882
"decoration": "string"
5883
}
5884
}
5885
}
5886
]
5887
},
5888
{
5889
"id": "brand-named-typography-elements",
5890
"description": "Names of customizeable typography elements",
5891
"enum": [
5892
"base",
5893
"headings",
5894
"monospace",
5895
"monospace-inline",
5896
"monospace-block",
5897
"link"
5898
]
5899
},
5900
{
5901
"id": "brand-font",
5902
"description": "Font files and definitions for the brand.",
5903
"anyOf": [
5904
{
5905
"ref": "brand-font-google"
5906
},
5907
{
5908
"ref": "brand-font-bunny"
5909
},
5910
{
5911
"ref": "brand-font-file"
5912
},
5913
{
5914
"ref": "brand-font-system"
5915
}
5916
]
5917
},
5918
{
5919
"id": "brand-font-weight",
5920
"description": "A font weight.",
5921
"enum": [
5922
100,
5923
200,
5924
300,
5925
400,
5926
500,
5927
600,
5928
700,
5929
800,
5930
900,
5931
"thin",
5932
"extra-light",
5933
"ultra-light",
5934
"light",
5935
"normal",
5936
"regular",
5937
"medium",
5938
"semi-bold",
5939
"demi-bold",
5940
"bold",
5941
"extra-bold",
5942
"ultra-bold",
5943
"black"
5944
],
5945
"default": 400
5946
},
5947
{
5948
"id": "brand-font-style",
5949
"description": "A font style.",
5950
"enum": [
5951
"normal",
5952
"italic",
5953
"oblique"
5954
],
5955
"default": "normal"
5956
},
5957
{
5958
"id": "brand-font-common",
5959
"schema": {
5960
"object": {
5961
"closed": true,
5962
"properties": {
5963
"family": {
5964
"description": "The font family name, which must match the name of the font on the foundry website.",
5965
"schema": "string"
5966
},
5967
"weight": {
5968
"description": "The font weights to include.",
5969
"maybeArrayOf": {
5970
"ref": "brand-font-weight"
5971
},
5972
"default": [
5973
400,
5974
700
5975
]
5976
},
5977
"style": {
5978
"description": "The font styles to include.",
5979
"maybeArrayOf": {
5980
"ref": "brand-font-style"
5981
},
5982
"default": [
5983
"normal",
5984
"italic"
5985
]
5986
},
5987
"display": {
5988
"description": "The font display method, determines how a font face is font face is shown depending on its download status and readiness for use.\n",
5989
"enum": [
5990
"auto",
5991
"block",
5992
"swap",
5993
"fallback",
5994
"optional"
5995
],
5996
"default": "swap"
5997
}
5998
}
5999
}
6000
}
6001
},
6002
{
6003
"id": "brand-font-system",
6004
"description": "A system font definition.",
6005
"object": {
6006
"super": {
6007
"resolveRef": "brand-font-common"
6008
},
6009
"closed": true,
6010
"properties": {
6011
"source": {
6012
"enum": [
6013
"system"
6014
]
6015
}
6016
},
6017
"required": [
6018
"source"
6019
]
6020
}
6021
},
6022
{
6023
"id": "brand-font-google",
6024
"description": "A font definition from Google Fonts.",
6025
"object": {
6026
"super": {
6027
"resolveRef": "brand-font-common"
6028
},
6029
"closed": true,
6030
"properties": {
6031
"source": {
6032
"enum": [
6033
"google"
6034
]
6035
}
6036
},
6037
"required": [
6038
"source"
6039
]
6040
}
6041
},
6042
{
6043
"id": "brand-font-bunny",
6044
"description": "A font definition from fonts.bunny.net.",
6045
"object": {
6046
"super": {
6047
"resolveRef": "brand-font-common"
6048
},
6049
"closed": true,
6050
"properties": {
6051
"source": {
6052
"enum": [
6053
"bunny"
6054
]
6055
}
6056
},
6057
"required": [
6058
"source"
6059
]
6060
}
6061
},
6062
{
6063
"id": "brand-font-file",
6064
"description": "A method for providing font files directly, either locally or from an online location.",
6065
"object": {
6066
"closed": true,
6067
"properties": {
6068
"source": {
6069
"enum": [
6070
"file"
6071
]
6072
},
6073
"family": {
6074
"description": "The font family name.",
6075
"schema": "string"
6076
},
6077
"files": {
6078
"arrayOf": {
6079
"anyOf": [
6080
"path",
6081
{
6082
"schema": {
6083
"object": {
6084
"properties": {
6085
"path": {
6086
"schema": "path",
6087
"description": "The path to the font file. This can be a local path or a URL.\n"
6088
},
6089
"weight": {
6090
"ref": "brand-font-weight"
6091
},
6092
"style": {
6093
"ref": "brand-font-style"
6094
}
6095
},
6096
"required": [
6097
"path"
6098
]
6099
}
6100
}
6101
}
6102
]
6103
},
6104
"description": "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
6105
}
6106
},
6107
"required": [
6108
"files",
6109
"family",
6110
"source"
6111
]
6112
}
6113
},
6114
{
6115
"id": "brand-font-family",
6116
"description": "A locally-installed font family name. When used, the end-user is responsible for ensuring that the font is installed on their system.\n",
6117
"schema": "string"
6118
},
6119
{
6120
"id": "brand-single",
6121
"object": {
6122
"closed": true,
6123
"properties": {
6124
"meta": {
6125
"ref": "brand-meta"
6126
},
6127
"logo": {
6128
"ref": "brand-logo-single"
6129
},
6130
"color": {
6131
"ref": "brand-color-single"
6132
},
6133
"typography": {
6134
"ref": "brand-typography-single"
6135
},
6136
"defaults": {
6137
"ref": "brand-defaults"
6138
}
6139
}
6140
}
6141
},
6142
{
6143
"id": "brand-unified",
6144
"object": {
6145
"closed": true,
6146
"properties": {
6147
"meta": {
6148
"ref": "brand-meta"
6149
},
6150
"logo": {
6151
"ref": "brand-logo-unified"
6152
},
6153
"color": {
6154
"ref": "brand-color-unified"
6155
},
6156
"typography": {
6157
"ref": "brand-typography-unified"
6158
},
6159
"defaults": {
6160
"ref": "brand-defaults"
6161
}
6162
}
6163
}
6164
},
6165
{
6166
"id": "brand-path-only-light-dark",
6167
"anyOf": [
6168
"string",
6169
{
6170
"object": {
6171
"closed": true,
6172
"properties": {
6173
"light": "string",
6174
"dark": "string"
6175
}
6176
}
6177
}
6178
],
6179
"description": "A path to a brand.yml file, or an object with light and dark paths to brand.yml\n"
6180
},
6181
{
6182
"id": "brand-path-bool-light-dark",
6183
"anyOf": [
6184
"string",
6185
"boolean",
6186
{
6187
"object": {
6188
"closed": true,
6189
"properties": {
6190
"light": {
6191
"anyOf": [
6192
"string",
6193
{
6194
"ref": "brand-single"
6195
}
6196
],
6197
"description": "The path to a light brand file or an inline light brand definition.\n"
6198
},
6199
"dark": {
6200
"anyOf": [
6201
"string",
6202
{
6203
"ref": "brand-single"
6204
}
6205
],
6206
"description": "The path to a dark brand file or an inline dark brand definition.\n"
6207
}
6208
}
6209
}
6210
},
6211
{
6212
"ref": "brand-unified"
6213
}
6214
],
6215
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline (unified) brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
6216
},
6217
{
6218
"id": "brand-defaults",
6219
"object": {
6220
"properties": {
6221
"bootstrap": {
6222
"ref": "brand-defaults-bootstrap"
6223
},
6224
"quarto": {
6225
"schema": "object"
6226
}
6227
}
6228
}
6229
},
6230
{
6231
"id": "brand-defaults-bootstrap",
6232
"object": {
6233
"properties": {
6234
"defaults": {
6235
"schema": {
6236
"object": {
6237
"additionalProperties": {
6238
"schema": {
6239
"anyOf": [
6240
"string",
6241
"boolean",
6242
"number"
6243
]
6244
}
6245
}
6246
}
6247
}
6248
}
6249
}
6250
}
6251
},
6252
{
6253
"id": "marginalia-side-geometry",
6254
"object": {
6255
"closed": true,
6256
"properties": {
6257
"far": {
6258
"string": {
6259
"description": "Distance from page edge to wideblock boundary."
6260
}
6261
},
6262
"width": {
6263
"string": {
6264
"description": "Width of the margin note column."
6265
}
6266
},
6267
"separation": {
6268
"string": {
6269
"description": "Gap between margin column and body text."
6270
}
6271
}
6272
}
6273
}
6274
}
6275
],
6276
"schema/document-about.yml": [
6277
{
6278
"name": "about",
6279
"tags": {
6280
"formats": [
6281
"$html-doc"
6282
]
6283
},
6284
"schema": {
6285
"anyOf": [
6286
{
6287
"enum": [
6288
"jolla",
6289
"trestles",
6290
"solana",
6291
"marquee",
6292
"broadside"
6293
]
6294
},
6295
{
6296
"ref": "website-about"
6297
}
6298
]
6299
},
6300
"description": {
6301
"short": "Specifies that the page is an 'about' page and which template to use when laying out the page.",
6302
"long": "Specifies that the page is an 'about' page and which template to use when laying out the page.\n\nThe allowed values are either:\n\n- one of the possible template values (`jolla`, `trestles`, `solana`, `marquee`, or `broadside`))\n- an object describing the 'about' page in more detail. See [About Pages](https://quarto.org/docs/websites/website-about.html) for more.\n"
6303
}
6304
}
6305
],
6306
"schema/document-attributes.yml": [
6307
{
6308
"name": "title",
6309
"schema": "string",
6310
"description": "Document title"
6311
},
6312
{
6313
"name": "subtitle",
6314
"schema": "string",
6315
"tags": {
6316
"formats": [
6317
"$pdf-all",
6318
"$html-all",
6319
"context",
6320
"muse",
6321
"odt",
6322
"docx"
6323
]
6324
},
6325
"description": "Identifies the subtitle of the document."
6326
},
6327
{
6328
"name": "date",
6329
"schema": {
6330
"ref": "date"
6331
},
6332
"description": "Document date"
6333
},
6334
{
6335
"name": "date-format",
6336
"schema": {
6337
"ref": "date-format"
6338
},
6339
"description": "Date format for the document"
6340
},
6341
{
6342
"name": "date-modified",
6343
"tags": {
6344
"formats": [
6345
"$html-doc"
6346
]
6347
},
6348
"schema": {
6349
"ref": "date"
6350
},
6351
"description": "Document date modified"
6352
},
6353
{
6354
"name": "author",
6355
"schema": {
6356
"maybeArrayOf": {
6357
"anyOf": [
6358
"object",
6359
"string"
6360
]
6361
}
6362
},
6363
"description": "Author or authors of the document"
6364
},
6365
{
6366
"name": "affiliation",
6367
"schema": {
6368
"maybeArrayOf": {
6369
"anyOf": [
6370
"object",
6371
"string"
6372
]
6373
}
6374
},
6375
"tags": {
6376
"formats": [
6377
"$jats-all"
6378
]
6379
},
6380
"description": {
6381
"short": "The list of organizations with which contributors are affiliated.",
6382
"long": "The list of organizations with which contributors are\naffiliated. Each institution is added as an [`<aff>`] element to\nthe author's contrib-group. See the Pandoc [JATS documentation](https://pandoc.org/jats.html) \nfor details on `affiliation` fields.\n"
6383
}
6384
},
6385
{
6386
"name": "copyright",
6387
"schema": "object",
6388
"tags": {
6389
"formats": [
6390
"$jats-all"
6391
]
6392
},
6393
"description": {
6394
"short": "Licensing and copyright information.",
6395
"long": "Licensing and copyright information. This information is\nrendered via the [`<permissions>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/permissions.html) element.\nThe variables `type`, `link`, and `text` should always be used\ntogether. See the Pandoc [JATS documentation](https://pandoc.org/jats.html)\nfor details on `copyright` fields.\n"
6396
}
6397
},
6398
{
6399
"name": "article",
6400
"schema": "object",
6401
"tags": {
6402
"formats": [
6403
"$jats-all"
6404
]
6405
},
6406
"description": {
6407
"short": "Information concerning the article that identifies or describes it.",
6408
"long": "Information concerning the article that identifies or describes\nit. The key-value pairs within this map are typically used\nwithin the [`<article-meta>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/article-meta.html) element.\nSee the Pandoc [JATS documentation](https://pandoc.org/jats.html) for details on `article` fields.\n"
6409
}
6410
},
6411
{
6412
"name": "journal",
6413
"schema": "object",
6414
"tags": {
6415
"formats": [
6416
"$jats-all"
6417
]
6418
},
6419
"description": {
6420
"short": "Information on the journal in which the article is published.",
6421
"long": "Information on the journal in which the article is published.\nSee the Pandoc [JATS documentation](https://pandoc.org/jats.html) for details on `journal` fields.\n"
6422
}
6423
},
6424
{
6425
"name": "institute",
6426
"schema": {
6427
"maybeArrayOf": {
6428
"anyOf": [
6429
"object",
6430
"string"
6431
]
6432
}
6433
},
6434
"tags": {
6435
"formats": [
6436
"$html-pres",
6437
"beamer"
6438
]
6439
},
6440
"description": "Author affiliations for the presentation."
6441
},
6442
{
6443
"name": "abstract",
6444
"schema": "string",
6445
"tags": {
6446
"formats": [
6447
"$pdf-all",
6448
"$html-doc",
6449
"$epub-all",
6450
"$asciidoc-all",
6451
"$jats-all",
6452
"context",
6453
"ms",
6454
"odt",
6455
"docx"
6456
]
6457
},
6458
"description": "Summary of document"
6459
},
6460
{
6461
"name": "abstract-title",
6462
"schema": "string",
6463
"tags": {
6464
"formats": [
6465
"$html-doc",
6466
"$epub-all",
6467
"docx",
6468
"typst"
6469
]
6470
},
6471
"description": "Title used to label document abstract"
6472
},
6473
{
6474
"name": "notes",
6475
"schema": "string",
6476
"tags": {
6477
"formats": [
6478
"$jats-all"
6479
]
6480
},
6481
"description": "Additional notes concerning the whole article. Added to the\narticle's frontmatter via the [`<notes>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/notes.html) element.\n"
6482
},
6483
{
6484
"name": "tags",
6485
"schema": {
6486
"arrayOf": "string"
6487
},
6488
"tags": {
6489
"formats": [
6490
"$jats-all"
6491
]
6492
},
6493
"description": "List of keywords. Items are used as contents of the [`<kwd>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd.html) element; the elements are grouped in a [`<kwd-group>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd-group.html) with the [`kwd-group-type`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/kwd-group-type.html) value `author`."
6494
},
6495
{
6496
"name": "doi",
6497
"schema": "string",
6498
"tags": {
6499
"formats": [
6500
"$html-doc"
6501
]
6502
},
6503
"description": "Displays the document Digital Object Identifier in the header."
6504
},
6505
{
6506
"name": "thanks",
6507
"schema": "string",
6508
"tags": {
6509
"formats": [
6510
"$pdf-all",
6511
"typst"
6512
]
6513
},
6514
"description": "The contents of an acknowledgments footnote after the document title."
6515
},
6516
{
6517
"name": "order",
6518
"schema": "number",
6519
"description": "Order for document when included in a website automatic sidebar menu."
6520
}
6521
],
6522
"schema/document-citation.yml": [
6523
{
6524
"name": "citation",
6525
"schema": {
6526
"anyOf": [
6527
{
6528
"ref": "citation-item"
6529
},
6530
"boolean"
6531
]
6532
},
6533
"description": {
6534
"short": "Citation information for the document itself.",
6535
"long": "Citation information for the document itself specified as [CSL](https://docs.citationstyles.org/en/stable/specification.html) \nYAML in the document front matter.\n\nFor more on supported options, see [Citation Metadata](https://quarto.org/docs/reference/metadata/citation.html).\n"
6536
}
6537
}
6538
],
6539
"schema/document-code.yml": [
6540
{
6541
"name": "code-copy",
6542
"schema": {
6543
"anyOf": [
6544
{
6545
"enum": [
6546
"hover"
6547
]
6548
},
6549
"boolean"
6550
]
6551
},
6552
"tags": {
6553
"formats": [
6554
"$html-all"
6555
]
6556
},
6557
"default": "hover",
6558
"description": {
6559
"short": "Enable a code copy icon for code blocks.",
6560
"long": "Enable a code copy icon for code blocks. \n\n- `true`: Always show the icon\n- `false`: Never show the icon\n- `hover` (default): Show the icon when the mouse hovers over the code block\n"
6561
}
6562
},
6563
{
6564
"name": "code-link",
6565
"schema": "boolean",
6566
"tags": {
6567
"engine": "knitr",
6568
"formats": [
6569
"$html-files"
6570
]
6571
},
6572
"default": false,
6573
"description": {
6574
"short": "Enables hyper-linking of functions within code blocks \nto their online documentation.\n",
6575
"long": "Enables hyper-linking of functions within code blocks \nto their online documentation.\n\nCode linking is currently implemented only for the knitr engine \n(via the [downlit](https://downlit.r-lib.org/) package). \nA limitation of downlit currently prevents code linking \nif `code-line-numbers` is also `true`.\n"
6576
}
6577
},
6578
{
6579
"name": "code-annotations",
6580
"schema": {
6581
"anyOf": [
6582
"boolean",
6583
{
6584
"enum": [
6585
"hover",
6586
"select",
6587
"below",
6588
"none"
6589
]
6590
}
6591
]
6592
},
6593
"default": "below",
6594
"description": {
6595
"short": "The style to use when displaying code annotations",
6596
"long": "The style to use when displaying code annotations. Set this value\nto false to hide code annotations.\n"
6597
}
6598
},
6599
{
6600
"name": "code-tools",
6601
"tags": {
6602
"formats": [
6603
"$html-doc"
6604
]
6605
},
6606
"schema": {
6607
"anyOf": [
6608
"boolean",
6609
{
6610
"object": {
6611
"closed": true,
6612
"properties": {
6613
"source": {
6614
"anyOf": [
6615
"boolean",
6616
"string"
6617
]
6618
},
6619
"toggle": "boolean",
6620
"caption": "string"
6621
}
6622
}
6623
}
6624
]
6625
},
6626
"default": false,
6627
"description": {
6628
"short": "Include a code tools menu (for hiding and showing code).",
6629
"long": "Include a code tools menu (for hiding and showing code).\nUse `true` or `false` to enable or disable the standard code \ntools menu. Specify sub-properties `source`, `toggle`, and\n`caption` to customize the behavior and appearance of code tools.\n"
6630
}
6631
},
6632
{
6633
"name": "code-block-border-left",
6634
"tags": {
6635
"formats": [
6636
"$html-doc",
6637
"$pdf-all"
6638
]
6639
},
6640
"schema": {
6641
"anyOf": [
6642
"string",
6643
"boolean"
6644
]
6645
},
6646
"description": {
6647
"short": "Show a thick left border on code blocks.",
6648
"long": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n"
6649
}
6650
},
6651
{
6652
"name": "code-block-bg",
6653
"tags": {
6654
"formats": [
6655
"$html-doc",
6656
"$pdf-all"
6657
]
6658
},
6659
"schema": {
6660
"anyOf": [
6661
"string",
6662
"boolean"
6663
]
6664
},
6665
"description": {
6666
"short": "Show a background color for code blocks.",
6667
"long": "Specifies to apply a background color on code blocks. Provide a hex color to specify that the background color is\nenabled as well as the color of the background.\n"
6668
}
6669
},
6670
{
6671
"name": "syntax-highlighting",
6672
"tags": {
6673
"formats": [
6674
"$html-all",
6675
"docx",
6676
"ms",
6677
"$pdf-all",
6678
"typst"
6679
]
6680
},
6681
"schema": {
6682
"anyOf": [
6683
{
6684
"object": {
6685
"closed": true,
6686
"properties": {
6687
"light": "path",
6688
"dark": "path"
6689
}
6690
}
6691
},
6692
{
6693
"string": {
6694
"completions": [
6695
"a11y",
6696
"arrow",
6697
"atom-one",
6698
"ayu",
6699
"ayu-mirage",
6700
"breeze",
6701
"breezedark",
6702
"dracula",
6703
"espresso",
6704
"github",
6705
"gruvbox",
6706
"haddock",
6707
"idiomatic",
6708
"kate",
6709
"monochrome",
6710
"monokai",
6711
"none",
6712
"nord",
6713
"oblivion",
6714
"printing",
6715
"pygments",
6716
"radical",
6717
"solarized",
6718
"tango",
6719
"vim-dark",
6720
"zenburn"
6721
]
6722
}
6723
}
6724
]
6725
},
6726
"description": {
6727
"short": "Specifies the coloring style to be used in highlighted source code.",
6728
"long": "Specifies the coloring style to be used in highlighted source code.\n\nValid values:\n\n- `none`: Disables syntax highlighting for code blocks.\n- `idiomatic`: Uses the format's native syntax highlighter\n (e.g., Typst's built-in highlighting, LaTeX `listings` package,\n or reveal.js highlight.js plugin).\n- A style name (e.g., `pygments`, `tango`, `github`): Uses\n Pandoc's skylighting with the specified theme.\n- A path to a `.theme` file: Uses a custom KDE syntax\n highlighting theme.\n\nFor adaptive light/dark themes, specify an object with `light`\nand `dark` properties pointing to theme files.\n"
6729
}
6730
},
6731
{
6732
"name": "highlight-style",
6733
"hidden": true,
6734
"tags": {
6735
"formats": [
6736
"$html-all",
6737
"docx",
6738
"ms",
6739
"$pdf-all",
6740
"typst"
6741
]
6742
},
6743
"schema": {
6744
"anyOf": [
6745
{
6746
"object": {
6747
"closed": true,
6748
"properties": {
6749
"light": "path",
6750
"dark": "path"
6751
}
6752
}
6753
},
6754
"string"
6755
]
6756
},
6757
"description": {
6758
"short": "Deprecated: use `syntax-highlighting` instead.",
6759
"long": "Deprecated: use `syntax-highlighting` instead.\n\nSpecifies the coloring style to be used in highlighted source code.\n"
6760
}
6761
},
6762
{
6763
"name": "syntax-definition",
6764
"tags": {
6765
"formats": [
6766
"$html-all",
6767
"docx",
6768
"ms",
6769
"$pdf-all",
6770
"typst"
6771
]
6772
},
6773
"schema": "path",
6774
"hidden": true,
6775
"description": "KDE language syntax definition file (XML)"
6776
},
6777
{
6778
"name": "syntax-definitions",
6779
"tags": {
6780
"formats": [
6781
"$html-all",
6782
"docx",
6783
"ms",
6784
"$pdf-all",
6785
"typst"
6786
]
6787
},
6788
"schema": {
6789
"arrayOf": "path"
6790
},
6791
"description": "KDE language syntax definition files (XML)"
6792
},
6793
{
6794
"name": "listings",
6795
"tags": {
6796
"formats": [
6797
"$pdf-all"
6798
]
6799
},
6800
"schema": "boolean",
6801
"description": {
6802
"short": "Use the listings package for LaTeX code blocks.",
6803
"long": "Use the `listings` package for LaTeX code blocks. The package\ndoes not support multi-byte encoding for source code. To handle UTF-8\nyou would need to use a custom template. This issue is fully\ndocumented here: [Encoding issue with the listings package](https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue)\n"
6804
}
6805
},
6806
{
6807
"name": "indented-code-classes",
6808
"tags": {
6809
"formats": [
6810
"$html-all",
6811
"docx",
6812
"ms",
6813
"$pdf-all"
6814
]
6815
},
6816
"schema": {
6817
"arrayOf": "string"
6818
},
6819
"description": "Specify classes to use for all indented code blocks"
6820
}
6821
],
6822
"schema/document-colors.yml": [
6823
{
6824
"name": "fontcolor",
6825
"schema": "string",
6826
"tags": {
6827
"formats": [
6828
"$html-doc"
6829
]
6830
},
6831
"description": "Sets the CSS `color` property."
6832
},
6833
{
6834
"name": "linkcolor",
6835
"schema": "string",
6836
"tags": {
6837
"formats": [
6838
"$html-doc",
6839
"context",
6840
"$pdf-all",
6841
"typst"
6842
]
6843
},
6844
"description": {
6845
"short": "Sets the color of hyperlinks in the document.",
6846
"long": "For HTML output, sets the CSS `color` property on all links.\n\nFor LaTeX output, The color used for internal links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor),\nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor ConTeXt output, sets the color for both external links and links within the document.\n\nFor Typst output, sets the color of internal hyperlinks using Typst color syntax.\n"
6847
}
6848
},
6849
{
6850
"name": "monobackgroundcolor",
6851
"schema": "string",
6852
"tags": {
6853
"formats": [
6854
"html",
6855
"html4",
6856
"html5",
6857
"slidy",
6858
"slideous",
6859
"s5",
6860
"dzslides"
6861
]
6862
},
6863
"description": "Sets the CSS `background-color` property on code elements and adds extra padding."
6864
},
6865
{
6866
"name": "backgroundcolor",
6867
"schema": "string",
6868
"tags": {
6869
"formats": [
6870
"$html-doc"
6871
]
6872
},
6873
"description": "Sets the CSS `background-color` property on the html element.\n"
6874
},
6875
{
6876
"name": "filecolor",
6877
"schema": "string",
6878
"tags": {
6879
"formats": [
6880
"$pdf-all",
6881
"typst"
6882
]
6883
},
6884
"description": {
6885
"short": "The color used for external links.",
6886
"long": "For LaTeX output, the color used for external links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor),\nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor Typst output, sets the color of external file links using Typst color syntax.\n"
6887
}
6888
},
6889
{
6890
"name": "citecolor",
6891
"schema": "string",
6892
"tags": {
6893
"formats": [
6894
"$pdf-all",
6895
"typst"
6896
]
6897
},
6898
"description": {
6899
"short": "The color used for citation links.",
6900
"long": "For LaTeX output, the color used for citation links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor),\nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor Typst output, sets the color of citation links using Typst color syntax.\n"
6901
}
6902
},
6903
{
6904
"name": "urlcolor",
6905
"schema": "string",
6906
"tags": {
6907
"formats": [
6908
"$pdf-all"
6909
]
6910
},
6911
"description": {
6912
"short": "The color used for linked URLs using color options allowed by `xcolor`",
6913
"long": "The color used for linked URLs using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
6914
}
6915
},
6916
{
6917
"name": "toccolor",
6918
"schema": "string",
6919
"tags": {
6920
"formats": [
6921
"$pdf-all"
6922
]
6923
},
6924
"description": {
6925
"short": "The color used for links in the Table of Contents using color options allowed by `xcolor`",
6926
"long": "The color used for links in the Table of Contents using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
6927
}
6928
},
6929
{
6930
"name": "colorlinks",
6931
"schema": "boolean",
6932
"tags": {
6933
"formats": [
6934
"$pdf-all"
6935
]
6936
},
6937
"default": true,
6938
"description": "Add color to link text, automatically enabled if any of \n`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set.\n"
6939
},
6940
{
6941
"name": "contrastcolor",
6942
"schema": "string",
6943
"tags": {
6944
"formats": [
6945
"context"
6946
]
6947
},
6948
"description": {
6949
"short": "Color for links to other content within the document.",
6950
"long": "Color for links to other content within the document. \n\nSee [ConTeXt Color](https://wiki.contextgarden.net/Color) for additional information.\n"
6951
}
6952
}
6953
],
6954
"schema/document-comments.yml": [
6955
{
6956
"name": "comments",
6957
"tags": {
6958
"formats": [
6959
"$html-files"
6960
]
6961
},
6962
"schema": {
6963
"ref": "document-comments-configuration"
6964
},
6965
"description": "Configuration for document commenting."
6966
}
6967
],
6968
"schema/document-crossref.yml": [
6969
{
6970
"name": "crossref",
6971
"description": {
6972
"short": "Configuration for cross-reference labels and prefixes.",
6973
"long": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
6974
},
6975
"schema": {
6976
"anyOf": [
6977
{
6978
"enum": [
6979
false
6980
]
6981
},
6982
{
6983
"object": {
6984
"closed": true,
6985
"properties": {
6986
"custom": {
6987
"arrayOf": {
6988
"object": {
6989
"description": "A custom cross reference type. See [Custom](https://quarto.org/docs/reference/metadata/crossref.html#custom) for more details.",
6990
"closed": true,
6991
"required": [
6992
"kind",
6993
"reference-prefix",
6994
"key"
6995
],
6996
"properties": {
6997
"kind": {
6998
"enum": [
6999
"float"
7000
],
7001
"description": "The kind of cross reference (currently only \"float\" is supported)."
7002
},
7003
"reference-prefix": {
7004
"string": {
7005
"description": "The prefix used in rendered references when referencing this type."
7006
}
7007
},
7008
"caption-prefix": {
7009
"string": {
7010
"description": "The prefix used in rendered captions when referencing this type. If omitted, the field `reference-prefix` is used."
7011
}
7012
},
7013
"space-before-numbering": {
7014
"default": true,
7015
"boolean": {
7016
"description": "If false, use no space between crossref prefixes and numbering."
7017
}
7018
},
7019
"key": {
7020
"string": {
7021
"description": "The key used to prefix reference labels of this type, such as \"fig\", \"tbl\", \"lst\", etc."
7022
}
7023
},
7024
"latex-env": {
7025
"string": {
7026
"description": "In LaTeX output, the name of the custom environment to be used."
7027
}
7028
},
7029
"latex-list-of-file-extension": {
7030
"string": {
7031
"description": "In LaTeX output, the extension of the auxiliary file used by LaTeX to collect names to be used in the custom \"list of\" command. If omitted, a string with prefix `lo` and suffix with the value of `ref-type` is used."
7032
}
7033
},
7034
"latex-list-of-description": {
7035
"string": {
7036
"description": "The description of the crossreferenceable object to be used in the title of the \"list of\" command. If omitted, the field `reference-prefix` is used."
7037
}
7038
},
7039
"caption-location": {
7040
"enum": [
7041
"top",
7042
"bottom",
7043
"margin"
7044
],
7045
"default": "bottom",
7046
"description": "The location of the caption relative to the crossreferenceable content."
7047
}
7048
}
7049
}
7050
}
7051
},
7052
"chapters": {
7053
"boolean": {
7054
"description": "Use top level sections (H1) in this document as chapters.",
7055
"default": false
7056
}
7057
},
7058
"title-delim": {
7059
"string": {
7060
"description": "The delimiter used between the prefix and the caption."
7061
}
7062
},
7063
"fig-title": {
7064
"string": {
7065
"description": "The title prefix used for figure captions."
7066
}
7067
},
7068
"tbl-title": {
7069
"string": {
7070
"description": "The title prefix used for table captions."
7071
}
7072
},
7073
"eq-title": {
7074
"string": {
7075
"description": "The title prefix used for equation captions."
7076
}
7077
},
7078
"lst-title": {
7079
"string": {
7080
"description": "The title prefix used for listing captions."
7081
}
7082
},
7083
"thm-title": {
7084
"string": {
7085
"description": "The title prefix used for theorem captions."
7086
}
7087
},
7088
"lem-title": {
7089
"string": {
7090
"description": "The title prefix used for lemma captions."
7091
}
7092
},
7093
"cor-title": {
7094
"string": {
7095
"description": "The title prefix used for corollary captions."
7096
}
7097
},
7098
"prp-title": {
7099
"string": {
7100
"description": "The title prefix used for proposition captions."
7101
}
7102
},
7103
"cnj-title": {
7104
"string": {
7105
"description": "The title prefix used for conjecture captions."
7106
}
7107
},
7108
"def-title": {
7109
"string": {
7110
"description": "The title prefix used for definition captions."
7111
}
7112
},
7113
"exm-title": {
7114
"string": {
7115
"description": "The title prefix used for example captions."
7116
}
7117
},
7118
"exr-title": {
7119
"string": {
7120
"description": "The title prefix used for exercise captions."
7121
}
7122
},
7123
"fig-prefix": {
7124
"string": {
7125
"description": "The prefix used for an inline reference to a figure."
7126
}
7127
},
7128
"tbl-prefix": {
7129
"string": {
7130
"description": "The prefix used for an inline reference to a table."
7131
}
7132
},
7133
"eq-prefix": {
7134
"string": {
7135
"description": "The prefix used for an inline reference to an equation."
7136
}
7137
},
7138
"sec-prefix": {
7139
"string": {
7140
"description": "The prefix used for an inline reference to a section."
7141
}
7142
},
7143
"lst-prefix": {
7144
"string": {
7145
"description": "The prefix used for an inline reference to a listing."
7146
}
7147
},
7148
"thm-prefix": {
7149
"string": {
7150
"description": "The prefix used for an inline reference to a theorem."
7151
}
7152
},
7153
"lem-prefix": {
7154
"string": {
7155
"description": "The prefix used for an inline reference to a lemma."
7156
}
7157
},
7158
"cor-prefix": {
7159
"string": {
7160
"description": "The prefix used for an inline reference to a corollary."
7161
}
7162
},
7163
"prp-prefix": {
7164
"string": {
7165
"description": "The prefix used for an inline reference to a proposition."
7166
}
7167
},
7168
"cnj-prefix": {
7169
"string": {
7170
"description": "The prefix used for an inline reference to a conjecture."
7171
}
7172
},
7173
"def-prefix": {
7174
"string": {
7175
"description": "The prefix used for an inline reference to a definition."
7176
}
7177
},
7178
"exm-prefix": {
7179
"string": {
7180
"description": "The prefix used for an inline reference to an example."
7181
}
7182
},
7183
"exr-prefix": {
7184
"string": {
7185
"description": "The prefix used for an inline reference to an exercise."
7186
}
7187
},
7188
"fig-labels": {
7189
"ref": "crossref-labels-schema",
7190
"description": "The numbering scheme used for figures."
7191
},
7192
"tbl-labels": {
7193
"ref": "crossref-labels-schema",
7194
"description": "The numbering scheme used for tables."
7195
},
7196
"eq-labels": {
7197
"ref": "crossref-labels-schema",
7198
"description": "The numbering scheme used for equations."
7199
},
7200
"sec-labels": {
7201
"ref": "crossref-labels-schema",
7202
"description": "The numbering scheme used for sections."
7203
},
7204
"lst-labels": {
7205
"ref": "crossref-labels-schema",
7206
"description": "The numbering scheme used for listings."
7207
},
7208
"thm-labels": {
7209
"ref": "crossref-labels-schema",
7210
"description": "The numbering scheme used for theorems."
7211
},
7212
"lem-labels": {
7213
"ref": "crossref-labels-schema",
7214
"description": "The numbering scheme used for lemmas."
7215
},
7216
"cor-labels": {
7217
"ref": "crossref-labels-schema",
7218
"description": "The numbering scheme used for corollaries."
7219
},
7220
"prp-labels": {
7221
"ref": "crossref-labels-schema",
7222
"description": "The numbering scheme used for propositions."
7223
},
7224
"cnj-labels": {
7225
"ref": "crossref-labels-schema",
7226
"description": "The numbering scheme used for conjectures."
7227
},
7228
"def-labels": {
7229
"ref": "crossref-labels-schema",
7230
"description": "The numbering scheme used for definitions."
7231
},
7232
"exm-labels": {
7233
"ref": "crossref-labels-schema",
7234
"description": "The numbering scheme used for examples."
7235
},
7236
"exr-labels": {
7237
"ref": "crossref-labels-schema",
7238
"description": "The numbering scheme used for exercises."
7239
},
7240
"lof-title": {
7241
"string": {
7242
"description": "The title used for the list of figures."
7243
}
7244
},
7245
"lot-title": {
7246
"string": {
7247
"description": "The title used for the list of tables."
7248
}
7249
},
7250
"lol-title": {
7251
"string": {
7252
"description": "The title used for the list of listings."
7253
}
7254
},
7255
"labels": {
7256
"ref": "crossref-labels-schema",
7257
"description": "The number scheme used for references."
7258
},
7259
"subref-labels": {
7260
"ref": "crossref-labels-schema",
7261
"description": "The number scheme used for sub references."
7262
},
7263
"ref-hyperlink": {
7264
"boolean": {
7265
"default": true,
7266
"description": "Whether cross references should be hyper-linked."
7267
}
7268
},
7269
"appendix-title": {
7270
"string": {
7271
"description": "The title used for appendix."
7272
}
7273
},
7274
"appendix-delim": {
7275
"string": {
7276
"description": "The delimiter beween appendix number and title."
7277
}
7278
}
7279
}
7280
}
7281
}
7282
]
7283
}
7284
},
7285
{
7286
"name": "crossrefs-hover",
7287
"schema": "boolean",
7288
"tags": {
7289
"formats": [
7290
"$html-files"
7291
]
7292
},
7293
"default": true,
7294
"description": "Enables a hover popup for cross references that shows the item being referenced."
7295
}
7296
],
7297
"schema/document-dashboard.yml": [
7298
{
7299
"name": "logo",
7300
"tags": {
7301
"formats": [
7302
"dashboard"
7303
]
7304
},
7305
"schema": {
7306
"ref": "logo-light-dark-specifier"
7307
},
7308
"description": "Logo image(s) (placed on the left side of the navigation bar)"
7309
},
7310
{
7311
"name": "orientation",
7312
"tags": {
7313
"formats": [
7314
"dashboard"
7315
]
7316
},
7317
"schema": {
7318
"enum": [
7319
"rows",
7320
"columns"
7321
]
7322
},
7323
"description": "Default orientation for dashboard content (default `rows`)"
7324
},
7325
{
7326
"name": "scrolling",
7327
"tags": {
7328
"formats": [
7329
"dashboard"
7330
]
7331
},
7332
"schema": "boolean",
7333
"default": false,
7334
"description": "Use scrolling rather than fill layout (default: `false`)"
7335
},
7336
{
7337
"name": "expandable",
7338
"tags": {
7339
"formats": [
7340
"dashboard"
7341
]
7342
},
7343
"schema": "boolean",
7344
"default": true,
7345
"description": "Make card content expandable (default: `true`)"
7346
},
7347
{
7348
"name": "nav-buttons",
7349
"tags": {
7350
"formats": [
7351
"dashboard"
7352
]
7353
},
7354
"schema": {
7355
"maybeArrayOf": {
7356
"anyOf": [
7357
"string",
7358
{
7359
"object": {
7360
"properties": {
7361
"text": "string",
7362
"href": "string",
7363
"icon": "string",
7364
"rel": "string",
7365
"target": "string",
7366
"title": "string",
7367
"aria-label": "string"
7368
}
7369
}
7370
}
7371
]
7372
}
7373
},
7374
"description": "Links to display on the dashboard navigation bar"
7375
}
7376
],
7377
"schema/document-editor.yml": [
7378
{
7379
"name": "editor",
7380
"schema": {
7381
"anyOf": [
7382
{
7383
"enum": [
7384
"source",
7385
"visual"
7386
]
7387
},
7388
{
7389
"object": {
7390
"hidden": true,
7391
"properties": {
7392
"mode": {
7393
"enum": [
7394
"source",
7395
"visual"
7396
],
7397
"description": "Default editing mode for document"
7398
},
7399
"markdown": {
7400
"object": {
7401
"properties": {
7402
"wrap": {
7403
"anyOf": [
7404
{
7405
"enum": [
7406
"sentence",
7407
"none"
7408
]
7409
},
7410
"number"
7411
],
7412
"description": "A column number (e.g. 72), `sentence`, or `none`"
7413
},
7414
"canonical": {
7415
"boolean": {
7416
"description": "Write standard visual editor markdown from source mode."
7417
}
7418
},
7419
"references": {
7420
"object": {
7421
"properties": {
7422
"location": {
7423
"schema": {
7424
"enum": [
7425
"block",
7426
"section",
7427
"document"
7428
],
7429
"description": "Location to write references (`block`, `section`, or `document`)"
7430
}
7431
},
7432
"links": {
7433
"boolean": {
7434
"description": "Write markdown links as references rather than inline."
7435
}
7436
},
7437
"prefix": {
7438
"string": {
7439
"description": "Unique prefix for references (`none` to prevent automatic prefixes)"
7440
}
7441
}
7442
}
7443
},
7444
"description": "Reference writing options for visual editor"
7445
}
7446
}
7447
},
7448
"description": "Markdown writing options for visual editor"
7449
},
7450
"render-on-save": {
7451
"tags": {
7452
"engine": [
7453
"jupyter"
7454
]
7455
},
7456
"schema": "boolean",
7457
"description": "Automatically re-render for preview whenever document is saved (note that this requires a preview\nfor the saved document be already running). This option currently works only within VS Code.\n"
7458
}
7459
}
7460
}
7461
}
7462
]
7463
},
7464
"description": "Visual editor configuration"
7465
},
7466
{
7467
"name": "editor_options",
7468
"schema": {
7469
"object": {
7470
"properties": {
7471
"chunk_output_type": {
7472
"enum": [
7473
"inline",
7474
"console"
7475
],
7476
"description": "Determines where chunk output is shown in the editor."
7477
}
7478
}
7479
}
7480
},
7481
"description": {
7482
"short": "Editor-specific options (used by RStudio and Positron).",
7483
"long": "Editor-specific options that control IDE behavior for this document.\nThese options are used by RStudio and Positron to configure\nper-document editor settings.\n"
7484
}
7485
},
7486
{
7487
"name": "zotero",
7488
"schema": {
7489
"anyOf": [
7490
"boolean",
7491
{
7492
"maybeArrayOf": "string"
7493
}
7494
]
7495
},
7496
"description": "Enable (`true`) or disable (`false`) Zotero for a document. Alternatively, provide a list of one or\nmore Zotero group libraries to use with the document.\n"
7497
}
7498
],
7499
"schema/document-epub.yml": [
7500
{
7501
"name": "identifier",
7502
"tags": {
7503
"formats": [
7504
"$epub-all"
7505
]
7506
},
7507
"schema": {
7508
"anyOf": [
7509
"string",
7510
{
7511
"object": {
7512
"closed": true,
7513
"properties": {
7514
"text": {
7515
"string": {
7516
"description": "The identifier value."
7517
}
7518
},
7519
"schema": {
7520
"enum": [
7521
"ISBN-10",
7522
"GTIN-13",
7523
"UPC",
7524
"ISMN-10",
7525
"DOI",
7526
"LCCN",
7527
"GTIN-14",
7528
"ISBN-13",
7529
"Legal deposit number",
7530
"URN",
7531
"OCLC",
7532
"ISMN-13",
7533
"ISBN-A",
7534
"JP",
7535
"OLCC"
7536
],
7537
"description": "The identifier schema (e.g. `DOI`, `ISBN-A`, etc.)"
7538
}
7539
}
7540
}
7541
}
7542
]
7543
},
7544
"description": "The identifier for this publication."
7545
},
7546
{
7547
"name": "creator",
7548
"tags": {
7549
"formats": [
7550
"$epub-all"
7551
]
7552
},
7553
"schema": {
7554
"ref": "epub-contributor"
7555
},
7556
"description": "Creators of this publication."
7557
},
7558
{
7559
"name": "contributor",
7560
"tags": {
7561
"formats": [
7562
"$epub-all"
7563
]
7564
},
7565
"schema": {
7566
"ref": "epub-contributor"
7567
},
7568
"description": "Contributors to this publication."
7569
},
7570
{
7571
"name": "type",
7572
"tags": {
7573
"formats": [
7574
"$epub-all"
7575
]
7576
},
7577
"schema": "string",
7578
"description": {
7579
"short": "Text describing the specialized type of this publication.",
7580
"long": "Text describing the specialized type of this publication.\n\nAn informative registry of specialized EPUB Publication \ntypes for use with this element is maintained in the \n[TypesRegistry](https://www.w3.org/publishing/epub32/epub-packages.html#bib-typesregistry), \nbut Authors may use any text string as a value.\n"
7581
}
7582
},
7583
{
7584
"name": "format",
7585
"tags": {
7586
"formats": [
7587
"$epub-all"
7588
]
7589
},
7590
"schema": "string",
7591
"description": "Text describing the format of this publication."
7592
},
7593
{
7594
"name": "relation",
7595
"tags": {
7596
"formats": [
7597
"$epub-all"
7598
]
7599
},
7600
"schema": "string",
7601
"description": "Text describing the relation of this publication."
7602
},
7603
{
7604
"name": "coverage",
7605
"tags": {
7606
"formats": [
7607
"$epub-all"
7608
]
7609
},
7610
"schema": "string",
7611
"description": "Text describing the coverage of this publication."
7612
},
7613
{
7614
"name": "rights",
7615
"tags": {
7616
"formats": [
7617
"$epub-all"
7618
]
7619
},
7620
"schema": "string",
7621
"description": "Text describing the rights of this publication."
7622
},
7623
{
7624
"name": "belongs-to-collection",
7625
"tags": {
7626
"formats": [
7627
"$epub-all"
7628
]
7629
},
7630
"schema": "string",
7631
"description": "Identifies the name of a collection to which the EPUB Publication belongs."
7632
},
7633
{
7634
"name": "group-position",
7635
"tags": {
7636
"formats": [
7637
"$epub-all"
7638
]
7639
},
7640
"schema": "number",
7641
"description": "Indicates the numeric position in which this publication \nbelongs relative to other works belonging to the same \n`belongs-to-collection` field.\n"
7642
},
7643
{
7644
"name": "page-progression-direction",
7645
"tags": {
7646
"formats": [
7647
"$epub-all"
7648
]
7649
},
7650
"schema": {
7651
"enum": [
7652
"ltr",
7653
"rtl"
7654
]
7655
},
7656
"description": "Sets the global direction in which content flows (`ltr` or `rtl`)"
7657
},
7658
{
7659
"name": "ibooks",
7660
"description": "iBooks specific metadata options.",
7661
"tags": {
7662
"formats": [
7663
"$epub-all"
7664
]
7665
},
7666
"schema": {
7667
"object": {
7668
"closed": true,
7669
"properties": {
7670
"version": {
7671
"string": {
7672
"description": "What is new in this version of the book."
7673
}
7674
},
7675
"specified-fonts": {
7676
"boolean": {
7677
"description": "Whether this book provides embedded fonts in a flowing or fixed layout book."
7678
}
7679
},
7680
"scroll-axis": {
7681
"enum": [
7682
"vertical",
7683
"horizontal",
7684
"default"
7685
],
7686
"description": "The scroll direction for this book (`vertical`, `horizontal`, or `default`)"
7687
}
7688
}
7689
}
7690
}
7691
},
7692
{
7693
"name": "epub-metadata",
7694
"tags": {
7695
"formats": [
7696
"$epub-all"
7697
]
7698
},
7699
"schema": "path",
7700
"description": {
7701
"short": "Look in the specified XML file for metadata for the EPUB.\nThe file should contain a series of [Dublin Core elements](https://www.dublincore.org/specifications/dublin-core/dces/).\n",
7702
"long": "Look in the specified XML file for metadata for the EPUB.\nThe file should contain a series of [Dublin Core elements](https://www.dublincore.org/specifications/dublin-core/dces/).\nFor example:\n\n```xml\n<dc:rights>Creative Commons</dc:rights>\n<dc:language>es-AR</dc:language>\n```\n\nBy default, pandoc will include the following metadata elements:\n`<dc:title>` (from the document title), `<dc:creator>` (from the\ndocument authors), `<dc:date>` (from the document date, which should\nbe in [ISO 8601 format]), `<dc:language>` (from the `lang`\nvariable, or, if is not set, the locale), and `<dc:identifier\nid=\"BookId\">` (a randomly generated UUID). Any of these may be\noverridden by elements in the metadata file.\n\nNote: if the source document is Markdown, a YAML metadata block\nin the document can be used instead.\n"
7703
}
7704
},
7705
{
7706
"name": "epub-subdirectory",
7707
"tags": {
7708
"formats": [
7709
"$epub-all"
7710
]
7711
},
7712
"schema": {
7713
"anyOf": [
7714
"path",
7715
null
7716
]
7717
},
7718
"default": "EPUB",
7719
"description": "Specify the subdirectory in the OCF container that is to hold the\nEPUB-specific contents. The default is `EPUB`. To put the EPUB \ncontents in the top level, use an empty string.\n"
7720
},
7721
{
7722
"name": "epub-fonts",
7723
"tags": {
7724
"formats": [
7725
"$epub-all"
7726
]
7727
},
7728
"schema": {
7729
"arrayOf": "path"
7730
},
7731
"description": {
7732
"short": "Embed the specified fonts in the EPUB",
7733
"long": "Embed the specified fonts in the EPUB. Wildcards can also be used: for example,\n`DejaVuSans-*.ttf`. To use the embedded fonts, you will need to add declarations\nlike the following to your CSS:\n\n```css\n@font-face {\n font-family: DejaVuSans;\n font-style: normal;\n font-weight: normal;\n src:url(\"DejaVuSans-Regular.ttf\");\n}\n```\n"
7734
}
7735
},
7736
{
7737
"name": "epub-chapter-level",
7738
"tags": {
7739
"formats": [
7740
"$epub-all"
7741
]
7742
},
7743
"schema": "number",
7744
"default": 1,
7745
"description": {
7746
"short": "Specify the heading level at which to split the EPUB into separate\nchapter files.\n",
7747
"long": "Specify the heading level at which to split the EPUB into separate\nchapter files. The default is to split into chapters at level-1\nheadings. This option only affects the internal composition of the\nEPUB, not the way chapters and sections are displayed to users. Some\nreaders may be slow if the chapter files are too large, so for large\ndocuments with few level-1 headings, one might want to use a chapter\nlevel of 2 or 3.\n"
7748
}
7749
},
7750
{
7751
"name": "epub-cover-image",
7752
"tags": {
7753
"formats": [
7754
"$epub-all"
7755
]
7756
},
7757
"schema": "path",
7758
"description": "Use the specified image as the EPUB cover. It is recommended\nthat the image be less than 1000px in width and height.\n"
7759
},
7760
{
7761
"name": "epub-title-page",
7762
"schema": "boolean",
7763
"default": true,
7764
"tags": {
7765
"formats": [
7766
"$epub-all"
7767
]
7768
},
7769
"description": "If false, disables the generation of a title page."
7770
}
7771
],
7772
"schema/document-execute.yml": [
7773
{
7774
"name": "engine",
7775
"schema": {
7776
"string": {
7777
"completions": [
7778
"jupyter",
7779
"knitr",
7780
"julia"
7781
]
7782
}
7783
},
7784
"description": "Engine used for executable code blocks."
7785
},
7786
{
7787
"name": "jupyter",
7788
"schema": {
7789
"anyOf": [
7790
"boolean",
7791
"string",
7792
{
7793
"object": {
7794
"hidden": true,
7795
"properties": {
7796
"kernelspec": {
7797
"object": {
7798
"properties": {
7799
"display_name": {
7800
"string": {
7801
"description": "The name to display in the UI."
7802
}
7803
},
7804
"language": {
7805
"string": {
7806
"description": "The name of the language the kernel implements."
7807
}
7808
},
7809
"name": {
7810
"string": {
7811
"description": "The name of the kernel."
7812
}
7813
}
7814
},
7815
"required": "all"
7816
}
7817
}
7818
}
7819
}
7820
}
7821
]
7822
},
7823
"description": "Configures the Jupyter engine."
7824
},
7825
{
7826
"name": "julia",
7827
"schema": {
7828
"object": {
7829
"properties": {
7830
"exeflags": {
7831
"schema": {
7832
"arrayOf": "string",
7833
"description": "Arguments to pass to the Julia worker process."
7834
}
7835
},
7836
"env": {
7837
"schema": {
7838
"arrayOf": "string",
7839
"description": "Environment variables to pass to the Julia worker process."
7840
}
7841
}
7842
}
7843
}
7844
},
7845
"description": "Configures the Julia engine."
7846
},
7847
{
7848
"name": "knitr",
7849
"schema": {
7850
"anyOf": [
7851
"boolean",
7852
{
7853
"object": {
7854
"closed": true,
7855
"properties": {
7856
"opts_knit": {
7857
"object": {
7858
"description": "Knit options."
7859
}
7860
},
7861
"opts_chunk": {
7862
"object": {
7863
"description": "Knitr chunk options."
7864
}
7865
}
7866
}
7867
}
7868
}
7869
]
7870
},
7871
"description": "Set Knitr options."
7872
},
7873
{
7874
"name": "cache",
7875
"tags": {
7876
"execute-only": true
7877
},
7878
"schema": {
7879
"anyOf": [
7880
"boolean",
7881
{
7882
"enum": [
7883
"refresh"
7884
]
7885
}
7886
]
7887
},
7888
"default": false,
7889
"description": {
7890
"short": "Cache results of computations.",
7891
"long": "Cache results of computations (using the [knitr cache](https://yihui.org/knitr/demo/cache/) \nfor R documents, and [Jupyter Cache](https://jupyter-cache.readthedocs.io/en/latest/) \nfor Jupyter documents).\n\nNote that cache invalidation is triggered by changes in chunk source code \n(or other cache attributes you've defined). \n\n- `true`: Cache results\n- `false`: Do not cache results\n- `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.\n"
7892
}
7893
},
7894
{
7895
"name": "freeze",
7896
"tags": {
7897
"execute-only": true
7898
},
7899
"schema": {
7900
"anyOf": [
7901
"boolean",
7902
{
7903
"enum": [
7904
"auto"
7905
]
7906
}
7907
]
7908
},
7909
"default": false,
7910
"description": {
7911
"short": "Re-use previous computational output when rendering",
7912
"long": "Control the re-use of previous computational output when rendering.\n\n- `true`: Never recompute previously generated computational output during a global project render\n- `false` (default): Recompute previously generated computational output\n- `auto`: Re-compute previously generated computational output only in case their source file changes\n"
7913
}
7914
},
7915
{
7916
"name": "server",
7917
"hidden": true,
7918
"schema": {
7919
"anyOf": [
7920
{
7921
"enum": [
7922
"shiny"
7923
]
7924
},
7925
{
7926
"object": {
7927
"properties": {
7928
"type": {
7929
"enum": [
7930
"shiny"
7931
],
7932
"description": "Type of server to run behind the document (e.g. `shiny`)"
7933
},
7934
"ojs-export": {
7935
"maybeArrayOf": "string",
7936
"description": "OJS variables to export to server."
7937
},
7938
"ojs-import": {
7939
"maybeArrayOf": "string",
7940
"description": "Server reactive values to import into OJS."
7941
}
7942
}
7943
}
7944
}
7945
]
7946
},
7947
"description": "Document server"
7948
},
7949
{
7950
"name": "daemon",
7951
"hidden": true,
7952
"schema": {
7953
"anyOf": [
7954
"number",
7955
"boolean"
7956
]
7957
},
7958
"default": 300,
7959
"description": {
7960
"short": "Run Jupyter kernels within a peristent daemon (to mitigate kernel startup time).",
7961
"long": "Run Jupyter kernels within a peristent daemon (to mitigate kernel startup time).\nBy default a daemon with a timeout of 300 seconds will be used. Set `daemon`\nto another timeout value or to `false` to disable it altogether.\n"
7962
}
7963
},
7964
{
7965
"name": "daemon-restart",
7966
"schema": "boolean",
7967
"hidden": true,
7968
"default": false,
7969
"description": "Restart any running Jupyter daemon before rendering."
7970
},
7971
{
7972
"name": "enabled",
7973
"schema": "boolean",
7974
"default": true,
7975
"hidden": true,
7976
"description": "Enable code cell execution."
7977
},
7978
{
7979
"name": "ipynb",
7980
"schema": "boolean",
7981
"default": false,
7982
"hidden": true,
7983
"description": "Execute code cell execution in Jupyter notebooks."
7984
},
7985
{
7986
"name": "debug",
7987
"hidden": true,
7988
"schema": "boolean",
7989
"default": false,
7990
"description": "Show code-execution related debug information."
7991
}
7992
],
7993
"schema/document-figures.yml": [
7994
{
7995
"name": "fig-width",
7996
"schema": "number",
7997
"description": {
7998
"short": "Default width for figures generated by Matplotlib or R graphics",
7999
"long": "Default width for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
8000
}
8001
},
8002
{
8003
"name": "fig-height",
8004
"schema": "number",
8005
"description": {
8006
"short": "Default height for figures generated by Matplotlib or R graphics",
8007
"long": "Default height for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
8008
}
8009
},
8010
{
8011
"name": "fig-format",
8012
"schema": {
8013
"enum": [
8014
"retina",
8015
"png",
8016
"jpeg",
8017
"svg",
8018
"pdf"
8019
]
8020
},
8021
"description": "Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)"
8022
},
8023
{
8024
"name": "fig-dpi",
8025
"schema": "number",
8026
"description": {
8027
"short": "Default DPI for figures generated by Matplotlib or R graphics",
8028
"long": "Default DPI for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
8029
}
8030
},
8031
{
8032
"name": "fig-asp",
8033
"tags": {
8034
"engine": "knitr"
8035
},
8036
"schema": "number",
8037
"description": {
8038
"short": "The aspect ratio of the plot, i.e., the ratio of height/width.\n",
8039
"long": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified,\nthe height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`.\n\nThe `fig-asp` option is only available within the knitr engine.\n"
8040
}
8041
},
8042
{
8043
"name": "fig-responsive",
8044
"tags": {
8045
"formats": [
8046
"$html-all"
8047
]
8048
},
8049
"schema": "boolean",
8050
"default": true,
8051
"description": "Whether to make images in this document responsive."
8052
}
8053
],
8054
"schema/document-fonts.yml": [
8055
{
8056
"name": "mainfont",
8057
"schema": "string",
8058
"tags": {
8059
"formats": [
8060
"$html-doc",
8061
"context",
8062
"$pdf-all",
8063
"typst"
8064
]
8065
},
8066
"description": {
8067
"short": "Sets the main font for the document.",
8068
"long": "For HTML output, sets the CSS `font-family` on the HTML element.\n\nFor LaTeX output, the main font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the main font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
8069
}
8070
},
8071
{
8072
"name": "monofont",
8073
"schema": "string",
8074
"tags": {
8075
"formats": [
8076
"$html-doc",
8077
"context",
8078
"$pdf-all"
8079
]
8080
},
8081
"description": {
8082
"short": "Sets the font used for when displaying code.",
8083
"long": "For HTML output, sets the CSS font-family property on code elements.\n\nFor PowerPoint output, sets the font used for code.\n\nFor LaTeX output, the monospace font family for use with `xelatex` or \n`lualatex`: take the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the monspace font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
8084
}
8085
},
8086
{
8087
"name": "codefont",
8088
"schema": "string",
8089
"tags": {
8090
"formats": [
8091
"typst"
8092
]
8093
},
8094
"description": {
8095
"short": "Sets the font used for code in Typst output.",
8096
"long": "For Typst output, sets the font used for displaying code. Takes\nthe name of any font available to Typst (system fonts or fonts in\ndirectories specified by `font-paths`).\n"
8097
}
8098
},
8099
{
8100
"name": "fontsize",
8101
"schema": "string",
8102
"tags": {
8103
"formats": [
8104
"$html-doc",
8105
"context",
8106
"$pdf-all",
8107
"typst"
8108
]
8109
},
8110
"description": {
8111
"short": "Sets the main font size for the document.",
8112
"long": "For HTML output, sets the base CSS `font-size` property.\n\nFor LaTeX and ConTeXt output, sets the font size for the document body text.\n"
8113
}
8114
},
8115
{
8116
"name": "fontenc",
8117
"schema": "string",
8118
"tags": {
8119
"formats": [
8120
"$pdf-all"
8121
]
8122
},
8123
"default": "T1",
8124
"description": {
8125
"short": "Allows font encoding to be specified through `fontenc` package.",
8126
"long": "Allows font encoding to be specified through [`fontenc`](https://www.ctan.org/pkg/fontenc) package.\n\nSee [LaTeX Font Encodings Guide](https://ctan.org/pkg/encguide) for addition information on font encoding.\n"
8127
}
8128
},
8129
{
8130
"name": "fontfamily",
8131
"schema": "string",
8132
"tags": {
8133
"formats": [
8134
"$pdf-all",
8135
"ms"
8136
]
8137
},
8138
"default": "Latin Modern",
8139
"description": {
8140
"short": "Font package to use when compiling a PDF with the `pdflatex` `pdf-engine`.",
8141
"long": "Font package to use when compiling a PDf with the `pdflatex` `pdf-engine`. \n\nSee [The LaTeX Font Catalogue](https://tug.org/FontCatalogue/) for a \nsummary of font options available.\n\nFor groff (`ms`) files, the font family for example, `T` or `P`.\n"
8142
}
8143
},
8144
{
8145
"name": "fontfamilyoptions",
8146
"schema": {
8147
"maybeArrayOf": "string"
8148
},
8149
"tags": {
8150
"formats": [
8151
"$pdf-all"
8152
]
8153
},
8154
"description": {
8155
"short": "Options for the package used as `fontfamily`.",
8156
"long": "Options for the package used as `fontfamily`.\n\nFor example, to use the Libertine font with proportional lowercase\n(old-style) figures through the [`libertinus`](https://ctan.org/pkg/libertinus) package:\n\n```yaml\nfontfamily: libertinus\nfontfamilyoptions:\n - osf\n - p\n```\n"
8157
}
8158
},
8159
{
8160
"name": "sansfont",
8161
"schema": "string",
8162
"tags": {
8163
"formats": [
8164
"$pdf-all"
8165
]
8166
},
8167
"description": {
8168
"short": "The sans serif font family for use with `xelatex` or `lualatex`.",
8169
"long": "The sans serif font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package.\n"
8170
}
8171
},
8172
{
8173
"name": "mathfont",
8174
"schema": "string",
8175
"tags": {
8176
"formats": [
8177
"$pdf-all",
8178
"typst"
8179
]
8180
},
8181
"description": {
8182
"short": "The math font family for use with `xelatex`, `lualatex`, or Typst.",
8183
"long": "For LaTeX output, the math font family for use with `xelatex` or\n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package.\n\nFor Typst output, sets the font used for mathematical content.\n"
8184
}
8185
},
8186
{
8187
"name": "CJKmainfont",
8188
"schema": "string",
8189
"tags": {
8190
"formats": [
8191
"$pdf-all"
8192
]
8193
},
8194
"description": {
8195
"short": "The CJK main font family for use with `xelatex` or `lualatex`.",
8196
"long": "The CJK main font family for use with `xelatex` or \n`lualatex` using the [`xecjk`](https://ctan.org/pkg/xecjk) package.\n"
8197
}
8198
},
8199
{
8200
"name": "mainfontoptions",
8201
"schema": {
8202
"maybeArrayOf": "string"
8203
},
8204
"tags": {
8205
"formats": [
8206
"$pdf-all"
8207
]
8208
},
8209
"description": {
8210
"short": "The main font options for use with `xelatex` or `lualatex`.",
8211
"long": "The main font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n\nFor example, to use the [TeX Gyre](http://www.gust.org.pl/projects/e-foundry/tex-gyre) \nversion of Palatino with lowercase figures:\n\n```yaml\nmainfont: TeX Gyre Pagella\nmainfontoptions:\n - Numbers=Lowercase\n - Numbers=Proportional \n```\n"
8212
}
8213
},
8214
{
8215
"name": "sansfontoptions",
8216
"schema": {
8217
"maybeArrayOf": "string"
8218
},
8219
"tags": {
8220
"formats": [
8221
"$pdf-all"
8222
]
8223
},
8224
"description": {
8225
"short": "The sans serif font options for use with `xelatex` or `lualatex`.",
8226
"long": "The sans serif font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
8227
}
8228
},
8229
{
8230
"name": "monofontoptions",
8231
"schema": {
8232
"maybeArrayOf": "string"
8233
},
8234
"tags": {
8235
"formats": [
8236
"$pdf-all"
8237
]
8238
},
8239
"description": {
8240
"short": "The monospace font options for use with `xelatex` or `lualatex`.",
8241
"long": "The monospace font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
8242
}
8243
},
8244
{
8245
"name": "mathfontoptions",
8246
"schema": {
8247
"maybeArrayOf": "string"
8248
},
8249
"tags": {
8250
"formats": [
8251
"$pdf-all"
8252
]
8253
},
8254
"description": {
8255
"short": "The math font options for use with `xelatex` or `lualatex`.",
8256
"long": "The math font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
8257
}
8258
},
8259
{
8260
"name": "font-paths",
8261
"schema": {
8262
"maybeArrayOf": "string"
8263
},
8264
"tags": {
8265
"formats": [
8266
"typst"
8267
]
8268
},
8269
"description": {
8270
"short": "Adds additional directories to search for fonts when compiling with Typst.",
8271
"long": "Locally, Typst uses installed system fonts. In addition, some custom path \ncan be specified to add directories that should be scanned for fonts.\nSetting this configuration will take precedence over any path set in TYPST_FONT_PATHS environment variable.\n"
8272
}
8273
},
8274
{
8275
"name": "CJKoptions",
8276
"schema": {
8277
"maybeArrayOf": "string"
8278
},
8279
"tags": {
8280
"formats": [
8281
"$pdf-all"
8282
]
8283
},
8284
"description": {
8285
"short": "The CJK font options for use with `xelatex` or `lualatex`.",
8286
"long": "The CJK font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
8287
}
8288
},
8289
{
8290
"name": "microtypeoptions",
8291
"schema": {
8292
"maybeArrayOf": "string"
8293
},
8294
"tags": {
8295
"formats": [
8296
"$pdf-all"
8297
]
8298
},
8299
"description": {
8300
"short": "Options to pass to the microtype package.",
8301
"long": "Options to pass to the [microtype](https://ctan.org/pkg/microtype) package."
8302
}
8303
},
8304
{
8305
"name": "pointsize",
8306
"schema": "string",
8307
"tags": {
8308
"formats": [
8309
"ms"
8310
]
8311
},
8312
"description": "The point size, for example, `10p`."
8313
},
8314
{
8315
"name": "lineheight",
8316
"schema": "string",
8317
"tags": {
8318
"formats": [
8319
"ms"
8320
]
8321
},
8322
"description": "The line height, for example, `12p`."
8323
},
8324
{
8325
"name": "linestretch",
8326
"schema": {
8327
"anyOf": [
8328
"string",
8329
"number"
8330
]
8331
},
8332
"tags": {
8333
"formats": [
8334
"$html-doc",
8335
"context",
8336
"$pdf-all",
8337
"typst"
8338
]
8339
},
8340
"description": {
8341
"short": "Sets the line height or spacing for text in the document.",
8342
"long": "For HTML output sets the CSS `line-height` property on the html\nelement, which is preferred to be unitless.\n\nFor LaTeX output, adjusts line spacing using the\n[setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.\n\nFor Typst output, adjusts the spacing between lines of text.\n"
8343
}
8344
},
8345
{
8346
"name": "interlinespace",
8347
"schema": {
8348
"maybeArrayOf": "string"
8349
},
8350
"tags": {
8351
"formats": [
8352
"context"
8353
]
8354
},
8355
"description": "Adjusts line spacing using the `\\setupinterlinespace` command."
8356
},
8357
{
8358
"name": "linkstyle",
8359
"schema": {
8360
"string": {
8361
"completions": [
8362
"normal",
8363
"bold",
8364
"slanted",
8365
"boldslanted",
8366
"type",
8367
"cap",
8368
"small"
8369
]
8370
}
8371
},
8372
"tags": {
8373
"formats": [
8374
"context"
8375
]
8376
},
8377
"description": "The typeface style for links in the document."
8378
},
8379
{
8380
"name": "whitespace",
8381
"schema": "string",
8382
"tags": {
8383
"formats": [
8384
"context"
8385
]
8386
},
8387
"description": {
8388
"short": "Set the spacing between paragraphs, for example `none`, `small.",
8389
"long": "Set the spacing between paragraphs, for example `none`, `small` \nusing the [`setupwhitespace`](https://wiki.contextgarden.net/Command/setupwhitespace) \ncommand.\n"
8390
}
8391
}
8392
],
8393
"schema/document-footnotes.yml": [
8394
{
8395
"name": "footnotes-hover",
8396
"schema": "boolean",
8397
"tags": {
8398
"formats": [
8399
"$html-files"
8400
]
8401
},
8402
"default": true,
8403
"description": "Enables a hover popup for footnotes that shows the footnote contents."
8404
},
8405
{
8406
"name": "links-as-notes",
8407
"schema": "boolean",
8408
"tags": {
8409
"formats": [
8410
"$pdf-all"
8411
]
8412
},
8413
"default": false,
8414
"description": "Causes links to be printed as footnotes."
8415
},
8416
{
8417
"name": "reference-location",
8418
"tags": {
8419
"formats": [
8420
"$markdown-all",
8421
"muse",
8422
"$html-files",
8423
"pdf",
8424
"typst"
8425
]
8426
},
8427
"schema": {
8428
"enum": [
8429
"block",
8430
"section",
8431
"margin",
8432
"document"
8433
]
8434
},
8435
"default": "document",
8436
"description": {
8437
"short": "Location for footnotes and references\n",
8438
"long": "Specify location for footnotes. Also controls the location of references, if `reference-links` is set.\n\n- `block`: Place at end of current top-level block\n- `section`: Place at end of current section\n- `margin`: Place at the margin\n- `document`: Place at end of document\n"
8439
}
8440
}
8441
],
8442
"schema/document-formatting.yml": [
8443
{
8444
"name": "indenting",
8445
"schema": {
8446
"maybeArrayOf": {
8447
"string": {
8448
"completions": [
8449
"yes",
8450
"no",
8451
"none",
8452
"small",
8453
"medium",
8454
"big",
8455
"first",
8456
"next",
8457
"odd",
8458
"even",
8459
"normal"
8460
]
8461
}
8462
}
8463
},
8464
"tags": {
8465
"formats": [
8466
"context"
8467
]
8468
},
8469
"description": {
8470
"short": "Set the indentation of paragraphs with one or more options.",
8471
"long": "Set the indentation of paragraphs with one or more options.\n\nSee [ConTeXt Indentation](https://wiki.contextgarden.net/Indentation) for additional information.\n"
8472
}
8473
},
8474
{
8475
"name": "adjusting",
8476
"schema": {
8477
"enum": [
8478
"l",
8479
"r",
8480
"c",
8481
"b"
8482
]
8483
},
8484
"tags": {
8485
"formats": [
8486
"man"
8487
]
8488
},
8489
"description": "Adjusts text to the left, right, center, or both margins (`l`, `r`, `c`, or `b`)."
8490
},
8491
{
8492
"name": "hyphenate",
8493
"schema": "boolean",
8494
"default": true,
8495
"tags": {
8496
"formats": [
8497
"man"
8498
]
8499
},
8500
"description": {
8501
"short": "Whether to hyphenate text at line breaks even in words that do not contain hyphens.",
8502
"long": "Whether to hyphenate text at line breaks even in words that do not contain \nhyphens if it is necessary to do so to lay out words on a line without excessive spacing\n"
8503
}
8504
},
8505
{
8506
"name": "list-tables",
8507
"schema": "boolean",
8508
"default": false,
8509
"tags": {
8510
"formats": [
8511
"rst"
8512
]
8513
},
8514
"description": "If true, tables are formatted as RST list tables."
8515
},
8516
{
8517
"name": "split-level",
8518
"tags": {
8519
"formats": [
8520
"$epub-all",
8521
"chunkedhtml"
8522
]
8523
},
8524
"schema": "number",
8525
"default": 1,
8526
"description": {
8527
"short": "Specify the heading level at which to split the EPUB into separate\nchapter files.\n",
8528
"long": "Specify the heading level at which to split the EPUB into separate\nchapter files. The default is to split into chapters at level-1\nheadings. This option only affects the internal composition of the\nEPUB, not the way chapters and sections are displayed to users. Some\nreaders may be slow if the chapter files are too large, so for large\ndocuments with few level-1 headings, one might want to use a chapter\nlevel of 2 or 3.\n"
8529
}
8530
}
8531
],
8532
"schema/document-funding.yml": [
8533
{
8534
"name": "funding",
8535
"schema": {
8536
"maybeArrayOf": {
8537
"anyOf": [
8538
"string",
8539
{
8540
"object": {
8541
"closed": true,
8542
"properties": {
8543
"statement": {
8544
"string": {
8545
"description": "Displayable prose statement that describes the funding for the research on which a work was based."
8546
}
8547
},
8548
"open-access": {
8549
"string": {
8550
"description": "Open access provisions that apply to a work or the funding information that provided the open access provisions."
8551
}
8552
},
8553
"awards": {
8554
"maybeArrayOf": {
8555
"object": {
8556
"properties": {
8557
"id": {
8558
"string": {
8559
"description": "Unique identifier assigned to an award, contract, or grant."
8560
}
8561
},
8562
"name": {
8563
"string": {
8564
"description": "The name of this award"
8565
}
8566
},
8567
"description": {
8568
"string": {
8569
"description": "The description for this award."
8570
}
8571
},
8572
"source": {
8573
"maybeArrayOf": {
8574
"anyOf": [
8575
"string",
8576
{
8577
"object": {
8578
"closed": true,
8579
"properties": {
8580
"text": {
8581
"string": {
8582
"description": "The text describing the source of the funding."
8583
}
8584
},
8585
"country": {
8586
"string": {
8587
"description": {
8588
"short": "Abbreviation for country where source of grant is located.",
8589
"long": "Abbreviation for country where source of grant is located.\nWhenever possible, ISO 3166-1 2-letter alphabetic codes should be used.\n"
8590
}
8591
}
8592
}
8593
}
8594
}
8595
}
8596
]
8597
},
8598
"description": "Agency or organization that funded the research on which a work was based."
8599
},
8600
"recipient": {
8601
"maybeArrayOf": {
8602
"anyOf": [
8603
"string",
8604
{
8605
"object": {
8606
"closed": true,
8607
"properties": {
8608
"ref": {
8609
"string": {
8610
"description": "The id of an author or affiliation in the document metadata."
8611
}
8612
}
8613
}
8614
}
8615
},
8616
{
8617
"object": {
8618
"closed": true,
8619
"properties": {
8620
"name": {
8621
"string": {
8622
"description": "The name of an individual that was the recipient of the funding."
8623
}
8624
}
8625
}
8626
}
8627
},
8628
{
8629
"object": {
8630
"closed": true,
8631
"properties": {
8632
"institution": {
8633
"anyOf": [
8634
"string",
8635
"object"
8636
],
8637
"description": "The institution that was the recipient of the funding."
8638
}
8639
}
8640
}
8641
}
8642
]
8643
},
8644
"description": "Individual(s) or institution(s) to whom the award was given (for example, the principal grant holder or the sponsored individual)."
8645
},
8646
"investigator": {
8647
"maybeArrayOf": {
8648
"anyOf": [
8649
"string",
8650
{
8651
"object": {
8652
"closed": true,
8653
"properties": {
8654
"ref": {
8655
"string": {
8656
"description": "The id of an author or affiliation in the document metadata."
8657
}
8658
}
8659
}
8660
}
8661
},
8662
{
8663
"object": {
8664
"closed": true,
8665
"properties": {
8666
"name": {
8667
"string": {
8668
"description": "The name of an individual that was responsible for the intellectual content of the work reported in the document."
8669
}
8670
}
8671
}
8672
}
8673
},
8674
{
8675
"object": {
8676
"closed": true,
8677
"properties": {
8678
"institution": {
8679
"anyOf": [
8680
"string",
8681
"object"
8682
],
8683
"description": "The institution that was responsible for the intellectual content of the work reported in the document."
8684
}
8685
}
8686
}
8687
}
8688
]
8689
},
8690
"description": "Individual(s) responsible for the intellectual content of the work reported in the document."
8691
}
8692
}
8693
}
8694
}
8695
}
8696
}
8697
}
8698
}
8699
]
8700
}
8701
},
8702
"description": "Information about the funding of the research reported in the article \n(for example, grants, contracts, sponsors) and any open access fees for the article itself\n"
8703
}
8704
],
8705
"schema/document-hidden.yml": [
8706
{
8707
"name": "to",
8708
"alias": "writer",
8709
"schema": "string",
8710
"default": "html",
8711
"hidden": true,
8712
"description": {
8713
"short": "Format to write to (e.g. html)",
8714
"long": "Format to write to. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. gfm+footnotes)\n"
8715
}
8716
},
8717
{
8718
"name": "input-file",
8719
"schema": "path",
8720
"hidden": true,
8721
"description": "Input file to read from"
8722
},
8723
{
8724
"name": "input-files",
8725
"schema": {
8726
"arrayOf": "path"
8727
},
8728
"hidden": true,
8729
"description": "Input files to read from"
8730
},
8731
{
8732
"name": "defaults",
8733
"schema": {
8734
"arrayOf": "path"
8735
},
8736
"hidden": true,
8737
"description": "Include options from the specified defaults files"
8738
},
8739
{
8740
"name": "variables",
8741
"schema": "object",
8742
"hidden": true,
8743
"description": "Pandoc metadata variables"
8744
},
8745
{
8746
"name": "metadata",
8747
"schema": "object",
8748
"hidden": true,
8749
"description": "Pandoc metadata variables"
8750
},
8751
{
8752
"name": "request-headers",
8753
"schema": {
8754
"ref": "pandoc-format-request-headers"
8755
},
8756
"hidden": true,
8757
"description": "Headers to include with HTTP requests by Pandoc"
8758
},
8759
{
8760
"name": "trace",
8761
"schema": "boolean",
8762
"default": false,
8763
"description": "Display trace debug output."
8764
},
8765
{
8766
"name": "fail-if-warnings",
8767
"schema": "boolean",
8768
"default": false,
8769
"description": "Exit with error status if there are any warnings."
8770
},
8771
{
8772
"name": "dump-args",
8773
"schema": "boolean",
8774
"default": false,
8775
"hidden": true,
8776
"description": "Print information about command-line arguments to *stdout*, then exit."
8777
},
8778
{
8779
"name": "ignore-args",
8780
"schema": "boolean",
8781
"default": false,
8782
"hidden": true,
8783
"description": "Ignore command-line arguments (for use in wrapper scripts)."
8784
},
8785
{
8786
"name": "file-scope",
8787
"schema": "boolean",
8788
"hidden": true,
8789
"default": false,
8790
"description": "Parse each file individually before combining for multifile documents."
8791
},
8792
{
8793
"name": "data-dir",
8794
"schema": "path",
8795
"hidden": true,
8796
"description": "Specify the user data directory to search for pandoc data files."
8797
},
8798
{
8799
"name": "verbosity",
8800
"schema": {
8801
"enum": [
8802
"ERROR",
8803
"WARNING",
8804
"INFO"
8805
]
8806
},
8807
"default": "WARNING",
8808
"hidden": true,
8809
"description": "Level of program output (`INFO`, `ERROR`, or `WARNING`)"
8810
},
8811
{
8812
"name": "log-file",
8813
"hidden": true,
8814
"schema": "path",
8815
"description": "Write log messages in machine-readable JSON format to FILE."
8816
},
8817
{
8818
"name": "track-changes",
8819
"tags": {
8820
"formats": [
8821
"docx"
8822
]
8823
},
8824
"hidden": true,
8825
"schema": {
8826
"enum": [
8827
"accept",
8828
"reject",
8829
"all"
8830
]
8831
},
8832
"default": "accept",
8833
"description": {
8834
"short": "Specify what to do with insertions, deletions, and comments produced by \nthe MS Word “Track Changes” feature.\n",
8835
"long": "Specify what to do with insertions, deletions, and comments\nproduced by the MS Word \"Track Changes\" feature. \n\n- `accept` (default): Process all insertions and deletions.\n- `reject`: Ignore them.\n- `all`: Include all insertions, deletions, and comments, wrapped\n in spans with `insertion`, `deletion`, `comment-start`, and\n `comment-end` classes, respectively. The author and time of\n change is included. \n\nNotes:\n\n- Both `accept` and `reject` ignore comments.\n\n- `all` is useful for scripting: only\n accepting changes from a certain reviewer, say, or before a\n certain date. If a paragraph is inserted or deleted,\n `track-changes: all` produces a span with the class\n `paragraph-insertion`/`paragraph-deletion` before the\n affected paragraph break. \n\n- This option only affects the docx reader.\n"
8836
}
8837
},
8838
{
8839
"name": "keep-source",
8840
"tags": {
8841
"formats": [
8842
"$html-doc"
8843
]
8844
},
8845
"schema": "boolean",
8846
"default": false,
8847
"hidden": true,
8848
"description": {
8849
"short": "Embed the input file source code in the generated HTML",
8850
"long": "Embed the input file source code in the generated HTML. A hidden div with \nclass `quarto-embedded-source-code` will be added to the document. This\noption is not normally used directly but rather in the implementation\nof the `code-tools` option.\n"
8851
}
8852
},
8853
{
8854
"name": "keep-hidden",
8855
"tags": {
8856
"formats": [
8857
"$html-doc"
8858
]
8859
},
8860
"schema": "boolean",
8861
"default": false,
8862
"hidden": true,
8863
"description": "Keep hidden source code and output (marked with class `.hidden`)"
8864
},
8865
{
8866
"name": "prefer-html",
8867
"tags": {
8868
"formats": [
8869
"$markdown-all"
8870
]
8871
},
8872
"schema": "boolean",
8873
"default": false,
8874
"hidden": true,
8875
"description": {
8876
"short": "Generate HTML output (if necessary) even when targeting markdown.",
8877
"long": "Generate HTML output (if necessary) even when targeting markdown. Enables the \nembedding of more sophisticated output (e.g. Jupyter widgets) in markdown.\n"
8878
}
8879
},
8880
{
8881
"name": "output-divs",
8882
"schema": "boolean",
8883
"default": true,
8884
"hidden": true,
8885
"description": "Indicates that computational output should not be written within divs. \nThis is necessary for some formats (e.g. `pptx`) to properly layout\nfigures.\n"
8886
},
8887
{
8888
"name": "merge-includes",
8889
"schema": "boolean",
8890
"default": true,
8891
"hidden": true,
8892
"description": "Disable merging of string based and file based includes (some formats, \nspecifically ePub, do not correctly handle this merging)\n"
8893
}
8894
],
8895
"schema/document-includes.yml": [
8896
{
8897
"name": "header-includes",
8898
"disabled": [
8899
"$office-all",
8900
"$jats-all",
8901
"ipynb"
8902
],
8903
"hidden": true,
8904
"schema": {
8905
"maybeArrayOf": "string"
8906
},
8907
"description": "Content to include at the end of the document header."
8908
},
8909
{
8910
"name": "include-before",
8911
"disabled": [
8912
"$office-all",
8913
"$jats-all",
8914
"ipynb"
8915
],
8916
"hidden": true,
8917
"schema": {
8918
"maybeArrayOf": "string"
8919
},
8920
"description": "Content to include at the beginning of the document body (e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command in LaTeX)."
8921
},
8922
{
8923
"name": "include-after",
8924
"disabled": [
8925
"$office-all",
8926
"$jats-all",
8927
"ipynb"
8928
],
8929
"hidden": true,
8930
"schema": {
8931
"maybeArrayOf": "string"
8932
},
8933
"description": "Content to include at the end of the document body (before the `</body>` tag in HTML, or the `\\end{document}` command in LaTeX)."
8934
},
8935
{
8936
"name": "include-before-body",
8937
"disabled": [
8938
"$office-all",
8939
"$jats-all",
8940
"ipynb"
8941
],
8942
"schema": {
8943
"maybeArrayOf": {
8944
"anyOf": [
8945
"path",
8946
{
8947
"ref": "smart-include"
8948
}
8949
]
8950
}
8951
},
8952
"description": "Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command\nin LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
8953
},
8954
{
8955
"name": "include-after-body",
8956
"disabled": [
8957
"$office-all",
8958
"$jats-all",
8959
"ipynb"
8960
],
8961
"schema": {
8962
"maybeArrayOf": {
8963
"anyOf": [
8964
"path",
8965
{
8966
"ref": "smart-include"
8967
}
8968
]
8969
}
8970
},
8971
"description": "Include content at the end of the document body immediately after the markdown content. While it will be included before the closing `</body>` tag in HTML and the `\\end{document}` command in LaTeX, this option refers to the end of the markdown content.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
8972
},
8973
{
8974
"name": "include-in-header",
8975
"disabled": [
8976
"$office-all",
8977
"$jats-all",
8978
"ipynb"
8979
],
8980
"schema": {
8981
"maybeArrayOf": {
8982
"anyOf": [
8983
"path",
8984
{
8985
"ref": "smart-include"
8986
}
8987
]
8988
}
8989
},
8990
"description": "Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML\ndocuments.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
8991
},
8992
{
8993
"name": "resources",
8994
"schema": {
8995
"maybeArrayOf": "string"
8996
},
8997
"tags": {
8998
"formats": [
8999
"$html-all"
9000
]
9001
},
9002
"description": "Path (or glob) to files to publish with this document."
9003
},
9004
{
9005
"name": "headertext",
9006
"schema": {
9007
"maybeArrayOf": "string"
9008
},
9009
"tags": {
9010
"formats": [
9011
"context"
9012
]
9013
},
9014
"description": {
9015
"short": "Text to be in a running header.",
9016
"long": "Text to be in a running header.\n\nProvide a single option or up to four options for different placements\n(odd page inner, odd page outer, even page innner, even page outer).\n"
9017
}
9018
},
9019
{
9020
"name": "footertext",
9021
"schema": {
9022
"maybeArrayOf": "string"
9023
},
9024
"tags": {
9025
"formats": [
9026
"context"
9027
]
9028
},
9029
"description": {
9030
"short": "Text to be in a running footer.",
9031
"long": "Text to be in a running footer.\n\nProvide a single option or up to four options for different placements\n(odd page inner, odd page outer, even page innner, even page outer).\n\nSee [ConTeXt Headers and Footers](https://wiki.contextgarden.net/Headers_and_Footers) for more information.\n"
9032
}
9033
},
9034
{
9035
"name": "includesource",
9036
"schema": "boolean",
9037
"tags": {
9038
"formats": [
9039
"context"
9040
]
9041
},
9042
"default": false,
9043
"description": "Whether to include all source documents as file attachments in the PDF file."
9044
},
9045
{
9046
"name": "footer",
9047
"schema": "string",
9048
"tags": {
9049
"formats": [
9050
"man"
9051
]
9052
},
9053
"description": "The footer for man pages."
9054
},
9055
{
9056
"name": "header",
9057
"schema": "string",
9058
"tags": {
9059
"formats": [
9060
"man"
9061
]
9062
},
9063
"description": "The header for man pages."
9064
},
9065
{
9066
"name": "metadata-file",
9067
"schema": "path",
9068
"hidden": true,
9069
"description": {
9070
"short": "Include file with YAML metadata",
9071
"long": "Read metadata from the supplied YAML (or JSON) file. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nMetadata values specified inside the document, or by using `-M`,\noverwrite values specified with this option.\n"
9072
}
9073
},
9074
{
9075
"name": "metadata-files",
9076
"schema": {
9077
"arrayOf": "path"
9078
},
9079
"description": {
9080
"short": "Include files with YAML metadata",
9081
"long": "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside\nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
9082
}
9083
}
9084
],
9085
"schema/document-language.yml": [
9086
{
9087
"name": "lang",
9088
"schema": "string",
9089
"description": {
9090
"short": "Identifies the main language of the document (e.g. `en` or `en-GB`).",
9091
"long": "Identifies the main language of the document using IETF language tags \n(following the [BCP 47](https://www.rfc-editor.org/info/bcp47) standard), \nsuch as `en` or `en-GB`. The [Language subtag lookup](https://r12a.github.io/app-subtags/) \ntool can look up or verify these tags. \n\nThis affects most formats, and controls hyphenation \nin PDF output when using LaTeX (through [`babel`](https://ctan.org/pkg/babel) \nand [`polyglossia`](https://ctan.org/pkg/polyglossia)) or ConTeXt.\n"
9092
}
9093
},
9094
{
9095
"name": "language",
9096
"schema": {
9097
"anyOf": [
9098
"path",
9099
"object"
9100
]
9101
},
9102
"description": "YAML file containing custom language translations"
9103
},
9104
{
9105
"name": "shorthands",
9106
"tags": {
9107
"formats": [
9108
"pdf",
9109
"beamer"
9110
]
9111
},
9112
"schema": "boolean",
9113
"default": false,
9114
"description": {
9115
"short": "Enable babel language-specific shorthands in LaTeX output.",
9116
"long": "Enable babel language-specific shorthands in LaTeX output. When `true`,\nbabel's language shortcuts are enabled (e.g., French `<<`/`>>` for guillemets,\nGerman `\"` shortcuts, proper spacing around French punctuation).\n\nDefault is `false` because language shorthands can interfere with code blocks\nand other content. Only enable if you need specific typographic features\nfor your language.\n"
9117
}
9118
},
9119
{
9120
"name": "dir",
9121
"schema": {
9122
"enum": [
9123
"rtl",
9124
"ltr"
9125
]
9126
},
9127
"description": {
9128
"short": "The base script direction for the document (`rtl` or `ltr`).",
9129
"long": "The base script direction for the document (`rtl` or `ltr`).\n\nFor bidirectional documents, native pandoc `span`s and\n`div`s with the `dir` attribute can\nbe used to override the base direction in some output\nformats. This may not always be necessary if the final\nrenderer (e.g. the browser, when generating HTML) supports\nthe [Unicode Bidirectional Algorithm].\n\nWhen using LaTeX for bidirectional documents, only the\n`xelatex` engine is fully supported (use\n`--pdf-engine=xelatex`).\n"
9130
}
9131
}
9132
],
9133
"schema/document-latexmk.yml": [
9134
{
9135
"name": "latex-auto-mk",
9136
"tags": {
9137
"formats": [
9138
"pdf",
9139
"beamer"
9140
]
9141
},
9142
"schema": "boolean",
9143
"default": true,
9144
"description": {
9145
"short": "Use Quarto's built-in PDF rendering wrapper",
9146
"long": "Use Quarto's built-in PDF rendering wrapper (includes support \nfor automatically installing missing LaTeX packages)\n"
9147
}
9148
},
9149
{
9150
"name": "latex-auto-install",
9151
"tags": {
9152
"formats": [
9153
"pdf",
9154
"beamer"
9155
]
9156
},
9157
"schema": "boolean",
9158
"default": true,
9159
"description": "Enable/disable automatic LaTeX package installation"
9160
},
9161
{
9162
"name": "latex-min-runs",
9163
"tags": {
9164
"formats": [
9165
"pdf",
9166
"beamer"
9167
]
9168
},
9169
"schema": "number",
9170
"default": 1,
9171
"description": "Minimum number of compilation passes."
9172
},
9173
{
9174
"name": "latex-max-runs",
9175
"tags": {
9176
"formats": [
9177
"pdf",
9178
"beamer"
9179
]
9180
},
9181
"schema": "number",
9182
"default": 10,
9183
"description": "Maximum number of compilation passes."
9184
},
9185
{
9186
"name": "latex-clean",
9187
"tags": {
9188
"formats": [
9189
"pdf",
9190
"beamer"
9191
]
9192
},
9193
"schema": "boolean",
9194
"default": true,
9195
"description": "Clean intermediates after compilation."
9196
},
9197
{
9198
"name": "latex-makeindex",
9199
"tags": {
9200
"formats": [
9201
"pdf",
9202
"beamer"
9203
]
9204
},
9205
"schema": "string",
9206
"default": "makeindex",
9207
"description": "Program to use for `makeindex`."
9208
},
9209
{
9210
"name": "latex-makeindex-opts",
9211
"tags": {
9212
"formats": [
9213
"pdf",
9214
"beamer"
9215
]
9216
},
9217
"schema": {
9218
"arrayOf": "string"
9219
},
9220
"description": "Array of command line options for `makeindex`."
9221
},
9222
{
9223
"name": "latex-tlmgr-opts",
9224
"tags": {
9225
"formats": [
9226
"pdf",
9227
"beamer"
9228
]
9229
},
9230
"schema": {
9231
"arrayOf": "string"
9232
},
9233
"description": "Array of command line options for `tlmgr`."
9234
},
9235
{
9236
"name": "latex-output-dir",
9237
"tags": {
9238
"formats": [
9239
"pdf",
9240
"beamer"
9241
]
9242
},
9243
"schema": "string",
9244
"description": "Output directory for intermediates and PDF."
9245
},
9246
{
9247
"name": "latex-tinytex",
9248
"tags": {
9249
"formats": [
9250
"pdf",
9251
"beamer"
9252
]
9253
},
9254
"schema": "boolean",
9255
"description": "Set to `false` to prevent an installation of TinyTex from being used to compile PDF documents."
9256
},
9257
{
9258
"name": "latex-input-paths",
9259
"tags": {
9260
"formats": [
9261
"pdf",
9262
"beamer"
9263
]
9264
},
9265
"schema": {
9266
"arrayOf": "string"
9267
},
9268
"description": "Array of paths LaTeX should search for inputs."
9269
}
9270
],
9271
"schema/document-layout.yml": [
9272
{
9273
"name": "documentclass",
9274
"schema": {
9275
"string": {
9276
"completions": [
9277
"scrartcl",
9278
"scrbook",
9279
"scrreprt",
9280
"scrlttr2",
9281
"article",
9282
"book",
9283
"report",
9284
"memoir"
9285
]
9286
}
9287
},
9288
"tags": {
9289
"formats": [
9290
"$pdf-all"
9291
]
9292
},
9293
"default": "scrartcl",
9294
"description": "The document class."
9295
},
9296
{
9297
"name": "classoption",
9298
"schema": {
9299
"maybeArrayOf": "string"
9300
},
9301
"tags": {
9302
"formats": [
9303
"$html-files",
9304
"$pdf-all"
9305
]
9306
},
9307
"description": {
9308
"short": "Options for the document class,",
9309
"long": "For LaTeX/PDF output, the options set for the document\nclass.\n\nFor HTML output using KaTeX, you can render display\nmath equations flush left using `classoption: fleqn`\n"
9310
}
9311
},
9312
{
9313
"name": "pagestyle",
9314
"schema": {
9315
"string": {
9316
"completions": [
9317
"plain",
9318
"empty",
9319
"headings"
9320
]
9321
}
9322
},
9323
"tags": {
9324
"formats": [
9325
"$pdf-all"
9326
]
9327
},
9328
"default": "plain",
9329
"description": "Control the `\\pagestyle{}` for the document."
9330
},
9331
{
9332
"name": "papersize",
9333
"schema": "string",
9334
"tags": {
9335
"formats": [
9336
"$pdf-all",
9337
"typst"
9338
]
9339
},
9340
"description": "The paper size for the document.\n"
9341
},
9342
{
9343
"name": "brand-mode",
9344
"schema": {
9345
"enum": [
9346
"light",
9347
"dark"
9348
]
9349
},
9350
"default": "light",
9351
"tags": {
9352
"formats": [
9353
"typst",
9354
"revealjs"
9355
]
9356
},
9357
"description": "The brand mode to use for rendering the document, `light` or `dark`.\n"
9358
},
9359
{
9360
"name": "layout",
9361
"schema": {
9362
"maybeArrayOf": "string"
9363
},
9364
"tags": {
9365
"formats": [
9366
"context"
9367
]
9368
},
9369
"description": {
9370
"short": "The options for margins and text layout for this document.",
9371
"long": "The options for margins and text layout for this document.\n\nSee [ConTeXt Layout](https://wiki.contextgarden.net/Layout) for additional information.\n"
9372
}
9373
},
9374
{
9375
"name": "page-layout",
9376
"schema": {
9377
"enum": [
9378
"article",
9379
"full",
9380
"custom"
9381
]
9382
},
9383
"default": "article",
9384
"tags": {
9385
"formats": [
9386
"$html-doc"
9387
]
9388
},
9389
"description": "The page layout to use for this document (`article`, `full`, or `custom`)"
9390
},
9391
{
9392
"name": "page-width",
9393
"tags": {
9394
"formats": [
9395
"docx",
9396
"$odt-all"
9397
]
9398
},
9399
"schema": "number",
9400
"description": {
9401
"short": "Target page width for output (used to compute columns widths for `layout` divs)\n",
9402
"long": "Target body page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt (8.5 inches with 1 inch for each margins).\n"
9403
}
9404
},
9405
{
9406
"name": "grid",
9407
"tags": {
9408
"formats": [
9409
"$html-doc",
9410
"typst"
9411
]
9412
},
9413
"schema": {
9414
"object": {
9415
"closed": true,
9416
"properties": {
9417
"content-mode": {
9418
"enum": [
9419
"auto",
9420
"standard",
9421
"full",
9422
"slim"
9423
],
9424
"description": "Defines whether to use the standard, slim, or full content grid or to automatically select the most appropriate content grid."
9425
},
9426
"sidebar-width": {
9427
"string": {
9428
"description": "The base width of the sidebar (left) column in an HTML page."
9429
}
9430
},
9431
"margin-width": {
9432
"string": {
9433
"description": "The base width of the margin (right) column. For Typst, this controls the width of the margin note column."
9434
}
9435
},
9436
"body-width": {
9437
"string": {
9438
"description": "The base width of the body (center) column. For Typst, this is computed as the remainder after other columns."
9439
}
9440
},
9441
"gutter-width": {
9442
"string": {
9443
"description": "The width of the gutter that appears between columns. For Typst, this is the gap between the text column and margin notes."
9444
}
9445
}
9446
}
9447
}
9448
},
9449
"description": {
9450
"short": "Properties of the grid system used to layout Quarto HTML and Typst pages."
9451
}
9452
},
9453
{
9454
"name": "appendix-style",
9455
"schema": {
9456
"anyOf": [
9457
{
9458
"enum": [
9459
"default",
9460
"plain",
9461
"none"
9462
]
9463
}
9464
]
9465
},
9466
"default": "default",
9467
"tags": {
9468
"formats": [
9469
"$html-doc"
9470
]
9471
},
9472
"description": {
9473
"short": "The layout of the appendix for this document (`none`, `plain`, or `default`)",
9474
"long": "The layout of the appendix for this document (`none`, `plain`, or `default`).\n\nTo completely disable any styling of the appendix, choose the appendix style `none`. For minimal styling, choose `plain.`\n"
9475
}
9476
},
9477
{
9478
"name": "appendix-cite-as",
9479
"schema": {
9480
"anyOf": [
9481
"boolean",
9482
{
9483
"maybeArrayOf": {
9484
"enum": [
9485
"display",
9486
"bibtex"
9487
]
9488
}
9489
}
9490
]
9491
},
9492
"tags": {
9493
"formats": [
9494
"$html-doc"
9495
]
9496
},
9497
"description": {
9498
"short": "Controls the formats which are provided in the citation section of the appendix (`false`, `display`, or `bibtex`).",
9499
"long": "Controls the formats which are provided in the citation section of the appendix.\n\nUse `false` to disable the display of the 'cite as' appendix. Pass one or more of `display` or `bibtex` to enable that\nformat in 'cite as' appendix.\n"
9500
}
9501
},
9502
{
9503
"name": "title-block-style",
9504
"schema": {
9505
"anyOf": [
9506
{
9507
"enum": [
9508
"default",
9509
"plain",
9510
"manuscript",
9511
"none"
9512
]
9513
}
9514
]
9515
},
9516
"default": "default",
9517
"tags": {
9518
"formats": [
9519
"$html-doc"
9520
]
9521
},
9522
"description": {
9523
"short": "The layout of the title block for this document (`none`, `plain`, or `default`).",
9524
"long": "The layout of the title block for this document (`none`, `plain`, or `default`).\n\nTo completely disable any styling of the title block, choose the style `none`. For minimal styling, choose `plain.`\n"
9525
}
9526
},
9527
{
9528
"name": "title-block-banner",
9529
"schema": {
9530
"anyOf": [
9531
"string",
9532
"boolean"
9533
]
9534
},
9535
"tags": {
9536
"formats": [
9537
"$html-doc"
9538
]
9539
},
9540
"description": {
9541
"short": "Apply a banner style treatment to the title block.",
9542
"long": "Applies a banner style treatment for the title block. You may specify one of the following values:\n\n`true`\n: Will enable the banner style display and automatically select a background color based upon the theme.\n\n`<css color value>`\n: If you provide a CSS color value, the banner will be enabled and the background color set to the provided CSS color.\n\n`<path>`\n: If you provide the path to a file, the banner will be enabled and the background image will be set to the file path.\n\nSee `title-block-banner-color` if you'd like to control the color of the title block banner text.\n"
9543
}
9544
},
9545
{
9546
"name": "title-block-banner-color",
9547
"schema": "string",
9548
"tags": {
9549
"formats": [
9550
"$html-doc"
9551
]
9552
},
9553
"description": {
9554
"short": "Sets the color of text elements in a banner style title block.",
9555
"long": "Sets the color of text elements in a banner style title block. Use one of the following values:\n\n`body` | `body-bg`\n: Will set the text color to the body text color or body background color, respectively.\n\n`<css color value>`\n: If you provide a CSS color value, the text color will be set to the provided CSS color.\n"
9556
}
9557
},
9558
{
9559
"name": "title-block-categories",
9560
"schema": "boolean",
9561
"default": true,
9562
"tags": {
9563
"formats": [
9564
"$html-doc"
9565
]
9566
},
9567
"description": {
9568
"short": "Enables or disables the display of categories in the title block."
9569
}
9570
},
9571
{
9572
"name": "max-width",
9573
"schema": "string",
9574
"tags": {
9575
"formats": [
9576
"$html-files"
9577
]
9578
},
9579
"description": "Adds a css `max-width` to the body Element."
9580
},
9581
{
9582
"name": "margin-left",
9583
"schema": "string",
9584
"tags": {
9585
"formats": [
9586
"$html-files",
9587
"context",
9588
"$pdf-all"
9589
]
9590
},
9591
"description": {
9592
"short": "Sets the left margin of the document.",
9593
"long": "For HTML output, sets the `margin-left` property on the Body element.\n\nFor LaTeX output, sets the left margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the left margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the left page margin.\n"
9594
}
9595
},
9596
{
9597
"name": "margin-right",
9598
"schema": "string",
9599
"tags": {
9600
"formats": [
9601
"$html-files",
9602
"context",
9603
"$pdf-all"
9604
]
9605
},
9606
"description": {
9607
"short": "Sets the right margin of the document.",
9608
"long": "For HTML output, sets the `margin-right` property on the Body element.\n\nFor LaTeX output, sets the right margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the right margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the right page margin.\n"
9609
}
9610
},
9611
{
9612
"name": "margin-top",
9613
"schema": "string",
9614
"tags": {
9615
"formats": [
9616
"$html-files",
9617
"context",
9618
"$pdf-all"
9619
]
9620
},
9621
"description": {
9622
"short": "Sets the top margin of the document.",
9623
"long": "For HTML output, sets the `margin-top` property on the Body element.\n\nFor LaTeX output, sets the top margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the top margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the top page margin.\n"
9624
}
9625
},
9626
{
9627
"name": "margin-bottom",
9628
"schema": "string",
9629
"tags": {
9630
"formats": [
9631
"$html-files",
9632
"context",
9633
"$pdf-all"
9634
]
9635
},
9636
"description": {
9637
"short": "Sets the bottom margin of the document.",
9638
"long": "For HTML output, sets the `margin-bottom` property on the Body element.\n\nFor LaTeX output, sets the bottom margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the bottom margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the bottom page margin.\n"
9639
}
9640
},
9641
{
9642
"name": "margin",
9643
"tags": {
9644
"formats": [
9645
"revealjs",
9646
"typst"
9647
]
9648
},
9649
"schema": {
9650
"anyOf": [
9651
"number",
9652
{
9653
"object": {
9654
"closed": true,
9655
"properties": {
9656
"x": {
9657
"string": {
9658
"description": "Horizontal margin (e.g. 1.5in)"
9659
}
9660
},
9661
"y": {
9662
"string": {
9663
"description": "Vertical margin (e.g. 1.5in)"
9664
}
9665
},
9666
"top": {
9667
"string": {
9668
"description": "Top margin (e.g. 1.5in)"
9669
}
9670
},
9671
"bottom": {
9672
"string": {
9673
"description": "Bottom margin (e.g. 1.5in)"
9674
}
9675
},
9676
"left": {
9677
"string": {
9678
"description": "Left margin (e.g. 1.5in)"
9679
}
9680
},
9681
"right": {
9682
"string": {
9683
"description": "Right margin (e.g. 1.5in)"
9684
}
9685
}
9686
}
9687
}
9688
}
9689
]
9690
},
9691
"default": 0.1,
9692
"description": {
9693
"short": "Margin settings for Reveal.js or Typst output.",
9694
"long": "For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).\n\nFor `typst`, a dictionary specifying page margins. Use `x` and `y` for symmetric\nhorizontal/vertical margins, or `top`, `bottom`, `left`, `right` for\nindividual sides. Values should include units (e.g. `1.5in`, `2cm`).\n"
9695
}
9696
},
9697
{
9698
"name": "geometry",
9699
"schema": {
9700
"maybeArrayOf": "string"
9701
},
9702
"tags": {
9703
"formats": [
9704
"$pdf-all"
9705
]
9706
},
9707
"description": {
9708
"short": "Options for the geometry package.",
9709
"long": "Options for the [geometry](https://ctan.org/pkg/geometry) package. For example:\n\n```yaml\ngeometry:\n - top=30mm\n - left=20mm\n - heightrounded\n```\n"
9710
}
9711
},
9712
{
9713
"name": "hyperrefoptions",
9714
"schema": {
9715
"maybeArrayOf": "string"
9716
},
9717
"tags": {
9718
"formats": [
9719
"$pdf-all"
9720
]
9721
},
9722
"description": {
9723
"short": "Additional non-color options for the hyperref package.",
9724
"long": "Options for the [hyperref](https://ctan.org/pkg/hyperref) package. For example:\n\n```yaml\nhyperrefoptions:\n - linktoc=all\n - pdfwindowui\n - pdfpagemode=FullScreen \n```\n\nTo customize link colors, please see the [Quarto PDF reference](https://quarto.org/docs/reference/formats/pdf.html#colors).\n"
9725
}
9726
},
9727
{
9728
"name": "indent",
9729
"schema": {
9730
"anyOf": [
9731
"boolean",
9732
"string"
9733
]
9734
},
9735
"tags": {
9736
"formats": [
9737
"$pdf-all",
9738
"ms"
9739
]
9740
},
9741
"default": false,
9742
"description": {
9743
"short": "Whether to use document class settings for indentation.",
9744
"long": "Whether to use document class settings for indentation. If the document \nclass settings are not used, the default LaTeX template removes indentation \nand adds space between paragraphs\n\nFor groff (`ms`) documents, the paragraph indent, for example, `2m`.\n"
9745
}
9746
},
9747
{
9748
"name": "block-headings",
9749
"schema": "boolean",
9750
"tags": {
9751
"formats": [
9752
"$pdf-all"
9753
]
9754
},
9755
"description": {
9756
"short": "Make `\\paragraph` and `\\subparagraph` free-standing rather than run-in.",
9757
"long": "Make `\\paragraph` and `\\subparagraph` (fourth- and\nfifth-level headings, or fifth- and sixth-level with book\nclasses) free-standing rather than run-in; requires further\nformatting to distinguish from `\\subsubsection` (third- or\nfourth-level headings). Instead of using this option,\n[KOMA-Script](https://ctan.org/pkg/koma-script) can adjust headings \nmore extensively:\n\n```yaml\nheader-includes: |\n \\RedeclareSectionCommand[\n beforeskip=-10pt plus -2pt minus -1pt,\n afterskip=1sp plus -1sp minus 1sp,\n font=\\normalfont\\itshape]{paragraph}\n \\RedeclareSectionCommand[\n beforeskip=-10pt plus -2pt minus -1pt,\n afterskip=1sp plus -1sp minus 1sp,\n font=\\normalfont\\scshape,\n indent=0pt]{subparagraph}\n```\n"
9758
}
9759
}
9760
],
9761
"schema/document-library.yml": [
9762
{
9763
"name": "revealjs-url",
9764
"schema": "path",
9765
"tags": {
9766
"formats": [
9767
"revealjs"
9768
]
9769
},
9770
"description": "Directory containing reveal.js files."
9771
},
9772
{
9773
"name": "s5-url",
9774
"schema": "string",
9775
"tags": {
9776
"formats": [
9777
"s5"
9778
]
9779
},
9780
"description": "The base url for s5 presentations."
9781
},
9782
{
9783
"name": "slidy-url",
9784
"schema": "string",
9785
"tags": {
9786
"formats": [
9787
"slidy"
9788
]
9789
},
9790
"description": "The base url for Slidy presentations."
9791
},
9792
{
9793
"name": "slideous-url",
9794
"schema": "string",
9795
"tags": {
9796
"formats": [
9797
"slideous"
9798
]
9799
},
9800
"description": "The base url for Slideous presentations."
9801
}
9802
],
9803
"schema/document-lightbox.yml": [
9804
{
9805
"name": "lightbox",
9806
"schema": {
9807
"anyOf": [
9808
"boolean",
9809
{
9810
"enum": [
9811
"auto"
9812
]
9813
},
9814
{
9815
"object": {
9816
"closed": true,
9817
"properties": {
9818
"match": {
9819
"schema": {
9820
"enum": [
9821
"auto"
9822
]
9823
},
9824
"description": {
9825
"short": "Set this to `auto` if you'd like any image to be given lightbox treatment.",
9826
"long": "Set this to `auto` if you'd like any image to be given lightbox treatment. If you omit this, only images with the class `lightbox` will be given the lightbox treatment.\n"
9827
}
9828
},
9829
"effect": {
9830
"schema": {
9831
"enum": [
9832
"fade",
9833
"zoom",
9834
"none"
9835
]
9836
},
9837
"description": "The effect that should be used when opening and closing the lightbox. One of `fade`, `zoom`, `none`. Defaults to `zoom`."
9838
},
9839
"desc-position": {
9840
"schema": {
9841
"enum": [
9842
"top",
9843
"bottom",
9844
"left",
9845
"right"
9846
]
9847
},
9848
"description": "The position of the title and description when displaying a lightbox. One of `top`, `bottom`, `left`, `right`. Defaults to `bottom`."
9849
},
9850
"loop": {
9851
"boolean": {
9852
"description": "Whether galleries should 'loop' to first image in the gallery if the user continues past the last image of the gallery. Boolean that defaults to `true`."
9853
}
9854
},
9855
"css-class": {
9856
"string": {
9857
"description": "A class name to apply to the lightbox to allow css targeting. This will replace the lightbox class with your custom class name."
9858
}
9859
}
9860
}
9861
}
9862
}
9863
]
9864
},
9865
"tags": {
9866
"formats": [
9867
"$html-doc"
9868
]
9869
},
9870
"description": "Enable or disable lightbox treatment for images in this document. See [Lightbox Figures](https://quarto.org/docs/output-formats/html-lightbox-figures.html) for more details."
9871
}
9872
],
9873
"schema/document-links.yml": [
9874
{
9875
"name": "link-external-icon",
9876
"tags": {
9877
"formats": [
9878
"$html-doc",
9879
"revealjs"
9880
]
9881
},
9882
"schema": "boolean",
9883
"description": "Show a special icon next to links that leave the current site."
9884
},
9885
{
9886
"name": "link-external-newwindow",
9887
"tags": {
9888
"formats": [
9889
"$html-doc",
9890
"revealjs"
9891
]
9892
},
9893
"schema": "boolean",
9894
"description": "Open external links in a new browser window or tab (rather than navigating the current tab)."
9895
},
9896
{
9897
"name": "link-external-filter",
9898
"tags": {
9899
"formats": [
9900
"$html-doc",
9901
"revealjs"
9902
]
9903
},
9904
"schema": "string",
9905
"description": {
9906
"short": "A regular expression that can be used to determine whether a link is an internal link.",
9907
"long": "A regular expression that can be used to determine whether a link is an internal link. For example, \nthe following will treat links that start with `http://www.quarto.org/custom` or `https://www.quarto.org/custom`\nas internal links (and others will be considered external):\n\n```\n^(?:http:|https:)\\/\\/www\\.quarto\\.org\\/custom\n```\n"
9908
}
9909
},
9910
{
9911
"name": "format-links",
9912
"tags": {
9913
"formats": [
9914
"$html-doc"
9915
]
9916
},
9917
"schema": {
9918
"anyOf": [
9919
"boolean",
9920
{
9921
"maybeArrayOf": {
9922
"anyOf": [
9923
"string",
9924
{
9925
"object": {
9926
"properties": {
9927
"text": {
9928
"string": {
9929
"description": "The title for the link."
9930
}
9931
},
9932
"href": {
9933
"string": {
9934
"description": "The href for the link."
9935
}
9936
},
9937
"icon": {
9938
"string": {
9939
"description": "The icon for the link."
9940
}
9941
}
9942
},
9943
"required": [
9944
"text",
9945
"href"
9946
]
9947
}
9948
},
9949
{
9950
"object": {
9951
"properties": {
9952
"format": {
9953
"string": {
9954
"description": "The format that this link represents."
9955
}
9956
},
9957
"text": {
9958
"string": {
9959
"description": "The title for this link."
9960
}
9961
},
9962
"icon": {
9963
"string": {
9964
"description": "The icon for this link."
9965
}
9966
}
9967
},
9968
"required": [
9969
"text",
9970
"format"
9971
]
9972
}
9973
}
9974
]
9975
}
9976
}
9977
]
9978
},
9979
"description": {
9980
"short": "Controls whether links to other rendered formats are displayed in HTML output.",
9981
"long": "Controls whether links to other rendered formats are displayed in HTML output.\n\nPass `false` to disable the display of format lengths or pass a list of format names for which you'd\nlike links to be shown.\n"
9982
}
9983
},
9984
{
9985
"name": "notebook-links",
9986
"tags": {
9987
"formats": [
9988
"$html-doc"
9989
]
9990
},
9991
"schema": {
9992
"anyOf": [
9993
"boolean",
9994
{
9995
"enum": [
9996
"inline",
9997
"global"
9998
]
9999
}
10000
]
10001
},
10002
"description": {
10003
"short": "Controls the display of links to notebooks that provided embedded content or are created from documents.",
10004
"long": "Controls the display of links to notebooks that provided embedded content or are created from documents.\n\nSpecify `false` to disable linking to source Notebooks. Specify `inline` to show links to source notebooks beneath the content they provide. \nSpecify `global` to show a set of global links to source notebooks.\n"
10005
}
10006
},
10007
{
10008
"name": "other-links",
10009
"tags": {
10010
"formats": [
10011
"$html-doc"
10012
]
10013
},
10014
"schema": {
10015
"anyOf": [
10016
{
10017
"enum": [
10018
false
10019
]
10020
},
10021
{
10022
"ref": "other-links"
10023
}
10024
]
10025
},
10026
"description": "A list of links that should be displayed below the table of contents in an `Other Links` section."
10027
},
10028
{
10029
"name": "code-links",
10030
"tags": {
10031
"formats": [
10032
"$html-doc"
10033
]
10034
},
10035
"schema": {
10036
"anyOf": [
10037
{
10038
"enum": [
10039
false
10040
]
10041
},
10042
{
10043
"ref": "code-links-schema"
10044
}
10045
]
10046
},
10047
"description": "A list of links that should be displayed below the table of contents in an `Code Links` section."
10048
},
10049
{
10050
"name": "notebook-subarticles",
10051
"tags": {
10052
"formats": [
10053
"$jats-all"
10054
]
10055
},
10056
"schema": "boolean",
10057
"description": {
10058
"short": "Controls whether referenced notebooks are embedded in JATS output as subarticles.",
10059
"long": "Controls the display of links to notebooks that provided embedded content or are created from documents.\n\nDefaults to `true` - specify `false` to disable embedding Notebook as subarticles with the JATS output.\n"
10060
}
10061
},
10062
{
10063
"name": "notebook-view",
10064
"tags": {
10065
"formats": [
10066
"$html-doc"
10067
]
10068
},
10069
"schema": {
10070
"anyOf": [
10071
"boolean",
10072
{
10073
"maybeArrayOf": {
10074
"anyOf": [
10075
"string",
10076
{
10077
"ref": "notebook-view-schema"
10078
}
10079
]
10080
}
10081
}
10082
]
10083
},
10084
"description": "Configures the HTML viewer for notebooks that provide embedded content."
10085
},
10086
{
10087
"name": "notebook-view-style",
10088
"tags": {
10089
"formats": [
10090
"$html-doc"
10091
]
10092
},
10093
"schema": {
10094
"enum": [
10095
"document",
10096
"notebook"
10097
]
10098
},
10099
"hidden": true,
10100
"description": "The style of document to render. Setting this to `notebook` will create additional notebook style affordances."
10101
},
10102
{
10103
"name": "notebook-preview-options",
10104
"tags": {
10105
"formats": [
10106
"$html-doc"
10107
]
10108
},
10109
"schema": {
10110
"object": {
10111
"properties": {
10112
"back": {
10113
"boolean": {
10114
"description": "Whether to show a back button in the notebook preview."
10115
}
10116
}
10117
}
10118
}
10119
},
10120
"description": "Options for controlling the display and behavior of Notebook previews."
10121
},
10122
{
10123
"name": "canonical-url",
10124
"tags": {
10125
"formats": [
10126
"$html-doc"
10127
]
10128
},
10129
"schema": {
10130
"anyOf": [
10131
"boolean",
10132
"string"
10133
]
10134
},
10135
"description": {
10136
"short": "Include a canonical link tag in website pages",
10137
"long": "Include a canonical link tag in website pages. You may pass either `true` to \nautomatically generate a canonical link, or pass a canonical url that you'd like\nto have placed in the `href` attribute of the tag.\n\nCanonical links can only be generated for websites with a known `site-url`.\n"
10138
}
10139
}
10140
],
10141
"schema/document-listing.yml": [
10142
{
10143
"name": "listing",
10144
"tags": {
10145
"formats": [
10146
"$html-doc"
10147
]
10148
},
10149
"schema": {
10150
"anyOf": [
10151
"boolean",
10152
{
10153
"maybeArrayOf": {
10154
"anyOf": [
10155
"string",
10156
{
10157
"ref": "website-listing"
10158
}
10159
]
10160
}
10161
}
10162
]
10163
},
10164
"description": "Automatically generate the contents of a page from a list of Quarto documents or other custom data."
10165
}
10166
],
10167
"schema/document-mermaid.yml": [
10168
{
10169
"name": "mermaid",
10170
"tags": {
10171
"formats": [
10172
"$html-files"
10173
]
10174
},
10175
"schema": {
10176
"object": {
10177
"properties": {
10178
"theme": {
10179
"enum": [
10180
"default",
10181
"dark",
10182
"forest",
10183
"neutral"
10184
],
10185
"description": "The mermaid built-in theme to use."
10186
}
10187
}
10188
}
10189
},
10190
"description": "Mermaid diagram options"
10191
}
10192
],
10193
"schema/document-metadata.yml": [
10194
{
10195
"name": "keywords",
10196
"schema": {
10197
"maybeArrayOf": "string"
10198
},
10199
"tags": {
10200
"formats": [
10201
"$asciidoc-all",
10202
"$html-files",
10203
"$pdf-all",
10204
"context",
10205
"odt",
10206
"$office-all"
10207
]
10208
},
10209
"description": "List of keywords to be included in the document metadata."
10210
},
10211
{
10212
"name": "subject",
10213
"schema": {
10214
"anyOf": [
10215
"string",
10216
{
10217
"object": {
10218
"closed": true,
10219
"properties": {
10220
"text": {
10221
"string": {
10222
"description": "The subject text."
10223
}
10224
},
10225
"authority": {
10226
"string": {
10227
"description": "An EPUB reserved authority value."
10228
}
10229
},
10230
"term": {
10231
"string": {
10232
"description": "The subject term (defined by the schema)."
10233
}
10234
}
10235
}
10236
}
10237
}
10238
]
10239
},
10240
"tags": {
10241
"formats": [
10242
"$pdf-all",
10243
"$office-all",
10244
"odt",
10245
"$epub-all"
10246
]
10247
},
10248
"description": "The document subject"
10249
},
10250
{
10251
"name": "description",
10252
"schema": "string",
10253
"tags": {
10254
"formats": [
10255
"odt",
10256
"$office-all"
10257
]
10258
},
10259
"description": "The document description. Some applications show this as `Comments` metadata."
10260
},
10261
{
10262
"name": "category",
10263
"schema": "string",
10264
"tags": {
10265
"formats": [
10266
"$office-all"
10267
]
10268
},
10269
"description": "The document category."
10270
},
10271
{
10272
"name": "copyright",
10273
"schema": {
10274
"anyOf": [
10275
{
10276
"object": {
10277
"properties": {
10278
"year": {
10279
"maybeArrayOf": {
10280
"anyOf": [
10281
"string",
10282
"number"
10283
]
10284
},
10285
"description": "The year for this copyright"
10286
},
10287
"holder": {
10288
"maybeArrayOf": {
10289
"string": {
10290
"description": "The holder of the copyright."
10291
}
10292
}
10293
},
10294
"statement": {
10295
"maybeArrayOf": {
10296
"string": {
10297
"description": "The text to display for the license."
10298
}
10299
}
10300
}
10301
}
10302
}
10303
},
10304
"string"
10305
]
10306
},
10307
"tags": {
10308
"formats": [
10309
"$html-doc",
10310
"$jats-all"
10311
]
10312
},
10313
"description": "The copyright for this document, if any."
10314
},
10315
{
10316
"name": "license",
10317
"schema": {
10318
"maybeArrayOf": {
10319
"anyOf": [
10320
{
10321
"object": {
10322
"properties": {
10323
"type": {
10324
"string": {
10325
"description": "The type of the license."
10326
}
10327
},
10328
"link": {
10329
"string": {
10330
"description": "A URL to the license."
10331
}
10332
},
10333
"text": {
10334
"string": {
10335
"description": "The text to display for the license."
10336
}
10337
}
10338
}
10339
}
10340
},
10341
"string"
10342
]
10343
}
10344
},
10345
"tags": {
10346
"formats": [
10347
"$html-doc",
10348
"$jats-all"
10349
]
10350
},
10351
"description": {
10352
"short": "The License for this document, if any. (e.g. `CC BY`)",
10353
"long": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC`, `CC BY-NC-SA`, and `CC BY-NC-ND` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n"
10354
}
10355
},
10356
{
10357
"name": "title-meta",
10358
"schema": "string",
10359
"tags": {
10360
"formats": [
10361
"$pdf-all"
10362
]
10363
},
10364
"description": "Sets the title metadata for the document"
10365
},
10366
{
10367
"name": "pagetitle",
10368
"tags": {
10369
"formats": [
10370
"$html-files"
10371
]
10372
},
10373
"schema": "string",
10374
"description": "Sets the title metadata for the document"
10375
},
10376
{
10377
"name": "title-prefix",
10378
"tags": {
10379
"formats": [
10380
"$html-files"
10381
]
10382
},
10383
"schema": "string",
10384
"description": "Specify STRING as a prefix at the beginning of the title that appears in \nthe HTML header (but not in the title as it appears at the beginning of the body)\n"
10385
},
10386
{
10387
"name": "description-meta",
10388
"schema": "string",
10389
"tags": {
10390
"formats": [
10391
"$html-files"
10392
]
10393
},
10394
"description": "Sets the description metadata for the document"
10395
},
10396
{
10397
"name": "author-meta",
10398
"schema": "string",
10399
"tags": {
10400
"formats": [
10401
"$pdf-all",
10402
"$html-files"
10403
]
10404
},
10405
"description": "Sets the author metadata for the document"
10406
},
10407
{
10408
"name": "date-meta",
10409
"schema": "string",
10410
"tags": {
10411
"formats": [
10412
"$html-all",
10413
"$pdf-all"
10414
]
10415
},
10416
"description": "Sets the date metadata for the document"
10417
}
10418
],
10419
"schema/document-numbering.yml": [
10420
{
10421
"name": "number-sections",
10422
"schema": "boolean",
10423
"default": false,
10424
"description": {
10425
"short": "Number section headings",
10426
"long": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
10427
}
10428
},
10429
{
10430
"name": "number-depth",
10431
"schema": "number",
10432
"tags": {
10433
"formats": [
10434
"$html-all",
10435
"$pdf-all",
10436
"docx"
10437
]
10438
},
10439
"description": {
10440
"short": "The depth to which sections should be numbered.",
10441
"long": "By default, all headings in your document create a \nnumbered section. You customize numbering depth using \nthe `number-depth` option. \n\nFor example, to only number sections immediately below \nthe chapter level, use this:\n\n```yaml \nnumber-depth: 1\n```\n"
10442
}
10443
},
10444
{
10445
"name": "secnumdepth",
10446
"schema": "number",
10447
"hidden": true,
10448
"tags": {
10449
"formats": [
10450
"$pdf-all"
10451
]
10452
},
10453
"description": "The numbering depth for sections. (Use `number-depth` instead)."
10454
},
10455
{
10456
"name": "number-offset",
10457
"tags": {
10458
"formats": [
10459
"$html-all"
10460
]
10461
},
10462
"schema": {
10463
"maybeArrayOf": "number"
10464
},
10465
"default": [
10466
0,
10467
0,
10468
0,
10469
0,
10470
0,
10471
0
10472
],
10473
"description": {
10474
"short": "Offset for section headings in output (offsets are 0 by default)",
10475
"long": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
10476
}
10477
},
10478
{
10479
"name": "section-numbering",
10480
"tags": {
10481
"formats": [
10482
"typst"
10483
]
10484
},
10485
"schema": "string",
10486
"description": "Schema to use for numbering sections, e.g. `1.A.1`"
10487
},
10488
{
10489
"name": "shift-heading-level-by",
10490
"schema": "number",
10491
"description": {
10492
"short": "Shift heading levels by a positive or negative integer. For example, with \n`shift-heading-level-by: -1`, level 2 headings become level 1 headings.\n",
10493
"long": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
10494
}
10495
},
10496
{
10497
"name": "page-numbering",
10498
"schema": {
10499
"anyOf": [
10500
"boolean",
10501
"string"
10502
]
10503
},
10504
"tags": {
10505
"formats": [
10506
"typst"
10507
]
10508
},
10509
"description": {
10510
"short": "Schema to use for numbering pages, e.g. `1` or `i`, or `false` to omit page numbering.\n",
10511
"long": "Schema to use for numbering pages, e.g. `1` or `i`, or `false` to omit page numbering.\n\nSee [Typst Numbering](https://typst.app/docs/reference/model/numbering/) \nfor additional information.\n"
10512
}
10513
},
10514
{
10515
"name": "pagenumbering",
10516
"schema": {
10517
"maybeArrayOf": "string"
10518
},
10519
"tags": {
10520
"formats": [
10521
"context"
10522
]
10523
},
10524
"description": {
10525
"short": "Sets the page numbering style and location for the document.",
10526
"long": "Sets the page numbering style and location for the document using the\n`\\setuppagenumbering` command. \n\nSee [ConTeXt Page Numbering](https://wiki.contextgarden.net/Command/setuppagenumbering) \nfor additional information.\n"
10527
}
10528
},
10529
{
10530
"name": "top-level-division",
10531
"tags": {
10532
"formats": [
10533
"$pdf-all",
10534
"context",
10535
"$docbook-all",
10536
"tei"
10537
]
10538
},
10539
"schema": {
10540
"enum": [
10541
"default",
10542
"section",
10543
"chapter",
10544
"part"
10545
]
10546
},
10547
"description": {
10548
"short": "Treat top-level headings as the given division type (`default`, `section`, `chapter`, or `part`). The hierarchy\norder is part, chapter, then section; all headings are shifted such \nthat the top-level heading becomes the specified type.\n",
10549
"long": "Treat top-level headings as the given division type (`default`, `section`, `chapter`, or `part`). The hierarchy\norder is part, chapter, then section; all headings are shifted such \nthat the top-level heading becomes the specified type. \n\nThe default behavior is to determine the\nbest division type via heuristics: unless other conditions\napply, `section` is chosen. When the `documentclass`\nvariable is set to `report`, `book`, or `memoir` (unless the\n`article` option is specified), `chapter` is implied as the\nsetting for this option. If `beamer` is the output format,\nspecifying either `chapter` or `part` will cause top-level\nheadings to become `\\part{..}`, while second-level headings\nremain as their default type.\n"
10550
}
10551
}
10552
],
10553
"schema/document-ojs.yml": [
10554
{
10555
"name": "ojs-engine",
10556
"tags": {
10557
"formats": [
10558
"$html-files"
10559
]
10560
},
10561
"schema": "boolean",
10562
"description": "If `true`, force the presence of the OJS runtime. If `false`, force the absence instead.\nIf unset, the OJS runtime is included only if OJS cells are present in the document.\n"
10563
}
10564
],
10565
"schema/document-options.yml": [
10566
{
10567
"name": "reference-doc",
10568
"tags": {
10569
"formats": [
10570
"$office-all",
10571
"odt"
10572
]
10573
},
10574
"schema": "path",
10575
"description": "Use the specified file as a style reference in producing a docx, \npptx, or odt file.\n"
10576
},
10577
{
10578
"name": "brand",
10579
"schema": {
10580
"ref": "brand-path-bool-light-dark"
10581
},
10582
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition, or an object with light and dark brand paths or definitions.\n"
10583
},
10584
{
10585
"name": "theme",
10586
"tags": {
10587
"formats": [
10588
"$html-doc",
10589
"revealjs",
10590
"beamer",
10591
"dashboard"
10592
]
10593
},
10594
"schema": {
10595
"anyOf": [
10596
"string",
10597
{
10598
"arrayOf": "string"
10599
},
10600
{
10601
"object": {
10602
"closed": true,
10603
"properties": {
10604
"light": {
10605
"maybeArrayOf": {
10606
"string": {
10607
"description": "The light theme name, theme scss file, or a mix of both."
10608
}
10609
}
10610
},
10611
"dark": {
10612
"maybeArrayOf": {
10613
"string": {
10614
"description": "The dark theme name, theme scss file, or a mix of both."
10615
}
10616
}
10617
}
10618
}
10619
}
10620
}
10621
]
10622
},
10623
"description": "Theme name, theme scss file, or a mix of both."
10624
},
10625
{
10626
"name": "body-classes",
10627
"tags": {
10628
"formats": [
10629
"$html-doc"
10630
]
10631
},
10632
"schema": "string",
10633
"description": "Classes to apply to the body of the document.\n"
10634
},
10635
{
10636
"name": "minimal",
10637
"schema": "boolean",
10638
"default": false,
10639
"tags": {
10640
"formats": [
10641
"$html-doc"
10642
]
10643
},
10644
"description": "Disables the built in html features like theming, anchor sections, code block behavior, and more."
10645
},
10646
{
10647
"name": "document-css",
10648
"schema": "boolean",
10649
"hidden": true,
10650
"default": true,
10651
"tags": {
10652
"formats": [
10653
"$html-files"
10654
]
10655
},
10656
"description": "Enables inclusion of Pandoc default CSS for this document."
10657
},
10658
{
10659
"name": "css",
10660
"tags": {
10661
"formats": [
10662
"$html-all"
10663
]
10664
},
10665
"schema": {
10666
"maybeArrayOf": "path"
10667
},
10668
"description": "One or more CSS style sheets."
10669
},
10670
{
10671
"name": "anchor-sections",
10672
"schema": "boolean",
10673
"default": true,
10674
"tags": {
10675
"formats": [
10676
"$html-doc"
10677
]
10678
},
10679
"description": "Enables hover over a section title to see an anchor link."
10680
},
10681
{
10682
"name": "tabsets",
10683
"schema": "boolean",
10684
"default": true,
10685
"tags": {
10686
"formats": [
10687
"$html-doc"
10688
]
10689
},
10690
"description": "Enables tabsets to present content."
10691
},
10692
{
10693
"name": "smooth-scroll",
10694
"schema": "boolean",
10695
"default": false,
10696
"tags": {
10697
"formats": [
10698
"$html-doc"
10699
]
10700
},
10701
"description": "Enables smooth scrolling within the page."
10702
},
10703
{
10704
"name": "respect-user-color-scheme",
10705
"schema": "boolean",
10706
"default": false,
10707
"tags": {
10708
"formats": [
10709
"$html-doc"
10710
]
10711
},
10712
"description": {
10713
"short": "Enables setting dark mode based on the `prefers-color-scheme` media query.",
10714
"long": "If set, Quarto reads the `prefers-color-scheme` media query to determine whether to show\nthe user a dark or light page. Otherwise the author-preferred color scheme is shown.\n"
10715
}
10716
},
10717
{
10718
"name": "html-math-method",
10719
"tags": {
10720
"formats": [
10721
"$html-doc",
10722
"$epub-all",
10723
"gfm"
10724
]
10725
},
10726
"schema": {
10727
"anyOf": [
10728
{
10729
"ref": "math-methods"
10730
},
10731
{
10732
"object": {
10733
"properties": {
10734
"method": {
10735
"ref": "math-methods"
10736
},
10737
"url": "string"
10738
},
10739
"required": [
10740
"method"
10741
]
10742
}
10743
}
10744
]
10745
},
10746
"description": {
10747
"short": "Method use to render math in HTML output",
10748
"long": "Method use to render math in HTML output (`plain`, `webtex`, `gladtex`, `mathml`, `mathjax`, `katex`).\n\nSee the Pandoc documentation on [Math Rendering in HTML](https://pandoc.org/MANUAL.html#math-rendering-in-html)\nfor additional details.\n"
10749
}
10750
},
10751
{
10752
"name": "section-divs",
10753
"tags": {
10754
"formats": [
10755
"$html-doc"
10756
]
10757
},
10758
"schema": "boolean",
10759
"default": true,
10760
"description": "Wrap sections in `<section>` tags and attach identifiers to the enclosing `<section>`\nrather than the heading itself.\n"
10761
},
10762
{
10763
"name": "identifier-prefix",
10764
"tags": {
10765
"formats": [
10766
"$html-files",
10767
"$docbook-all",
10768
"$markdown-all",
10769
"haddock"
10770
]
10771
},
10772
"schema": "string",
10773
"description": {
10774
"short": "Specify a prefix to be added to all identifiers and internal links.",
10775
"long": "Specify a prefix to be added to all identifiers and internal links in HTML and\nDocBook output, and to footnote numbers in Markdown and Haddock output. \nThis is useful for preventing duplicate identifiers when generating fragments\nto be included in other pages.\n"
10776
}
10777
},
10778
{
10779
"name": "email-obfuscation",
10780
"tags": {
10781
"formats": [
10782
"$html-files"
10783
]
10784
},
10785
"schema": {
10786
"enum": [
10787
"none",
10788
"references",
10789
"javascript"
10790
]
10791
},
10792
"default": "none",
10793
"description": {
10794
"short": "Method for obfuscating mailto: links in HTML documents.",
10795
"long": "Specify a method for obfuscating `mailto:` links in HTML documents.\n\n- `javascript`: Obfuscate links using JavaScript.\n- `references`: Obfuscate links by printing their letters as decimal or hexadecimal character references.\n- `none` (default): Do not obfuscate links.\n"
10796
}
10797
},
10798
{
10799
"name": "html-q-tags",
10800
"tags": {
10801
"formats": [
10802
"$html-all"
10803
]
10804
},
10805
"schema": "boolean",
10806
"default": false,
10807
"description": "Use `<q>` tags for quotes in HTML."
10808
},
10809
{
10810
"name": "pdf-engine",
10811
"tags": {
10812
"formats": [
10813
"$pdf-all",
10814
"ms",
10815
"context"
10816
]
10817
},
10818
"schema": {
10819
"enum": [
10820
"pdflatex",
10821
"lualatex",
10822
"xelatex",
10823
"latexmk",
10824
"tectonic",
10825
"wkhtmltopdf",
10826
"weasyprint",
10827
"pagedjs-cli",
10828
"prince",
10829
"context",
10830
"pdfroff",
10831
"typst"
10832
]
10833
},
10834
"description": {
10835
"short": "Use the specified engine when producing PDF output.",
10836
"long": "Use the specified engine when producing PDF output. If the engine is not\nin your PATH, the full path of the engine may be specified here. If this\noption is not specified, Quarto uses the following defaults\ndepending on the output format in use:\n\n- `latex`: `lualatex` (other options: `pdflatex`, `xelatex`,\n `tectonic`, `latexmk`)\n- `context`: `context`\n- `html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`, `pagedjs-cli`;\n see [print-css.rocks](https://print-css.rocks) for a good\n introduction to PDF generation from HTML/CSS.)\n- `ms`: `pdfroff`\n- `typst`: `typst`\n"
10837
}
10838
},
10839
{
10840
"name": "pdf-engine-opt",
10841
"tags": {
10842
"formats": [
10843
"$pdf-all",
10844
"ms",
10845
"context"
10846
]
10847
},
10848
"schema": "string",
10849
"description": {
10850
"short": "Use the given string as a command-line argument to the `pdf-engine`.",
10851
"long": "Use the given string as a command-line argument to the pdf-engine.\nFor example, to use a persistent directory foo for latexmk’s auxiliary\nfiles, use `pdf-engine-opt: -outdir=foo`. Note that no check for \nduplicate options is done.\n"
10852
}
10853
},
10854
{
10855
"name": "pdf-engine-opts",
10856
"tags": {
10857
"formats": [
10858
"$pdf-all",
10859
"ms",
10860
"context"
10861
]
10862
},
10863
"schema": {
10864
"arrayOf": "string"
10865
},
10866
"description": {
10867
"short": "Pass multiple command-line arguments to the `pdf-engine`.",
10868
"long": "Use the given strings passed as a array as command-line arguments to the pdf-engine.\nThis is an alternative to `pdf-engine-opt` for passing multiple options.\n"
10869
}
10870
},
10871
{
10872
"name": "beamerarticle",
10873
"schema": "boolean",
10874
"tags": {
10875
"formats": [
10876
"pdf"
10877
]
10878
},
10879
"description": "Whether to produce a Beamer article from this presentation."
10880
},
10881
{
10882
"name": "beameroption",
10883
"schema": {
10884
"maybeArrayOf": "string"
10885
},
10886
"tags": {
10887
"formats": [
10888
"beamer"
10889
]
10890
},
10891
"description": "Add an extra Beamer option using `\\setbeameroption{}`."
10892
},
10893
{
10894
"name": "aspectratio",
10895
"schema": {
10896
"enum": [
10897
43,
10898
169,
10899
1610,
10900
149,
10901
141,
10902
54,
10903
32
10904
]
10905
},
10906
"tags": {
10907
"formats": [
10908
"beamer"
10909
]
10910
},
10911
"description": "The aspect ratio for this presentation."
10912
},
10913
{
10914
"name": "logo",
10915
"schema": "path",
10916
"tags": {
10917
"formats": [
10918
"beamer"
10919
]
10920
},
10921
"description": "The logo image."
10922
},
10923
{
10924
"name": "titlegraphic",
10925
"schema": "path",
10926
"tags": {
10927
"formats": [
10928
"beamer"
10929
]
10930
},
10931
"description": "The image for the title slide."
10932
},
10933
{
10934
"name": "navigation",
10935
"schema": {
10936
"enum": [
10937
"empty",
10938
"frame",
10939
"vertical",
10940
"horizontal"
10941
]
10942
},
10943
"tags": {
10944
"formats": [
10945
"beamer"
10946
]
10947
},
10948
"description": "Controls navigation symbols for the presentation (`empty`, `frame`, `vertical`, or `horizontal`)"
10949
},
10950
{
10951
"name": "section-titles",
10952
"schema": "boolean",
10953
"tags": {
10954
"formats": [
10955
"beamer"
10956
]
10957
},
10958
"default": true,
10959
"description": "Whether to enable title pages for new sections."
10960
},
10961
{
10962
"name": "colortheme",
10963
"schema": "string",
10964
"tags": {
10965
"formats": [
10966
"beamer"
10967
]
10968
},
10969
"description": "The Beamer color theme for this presentation, passed to `\\usecolortheme`."
10970
},
10971
{
10972
"name": "colorthemeoptions",
10973
"schema": {
10974
"maybeArrayOf": "string"
10975
},
10976
"tags": {
10977
"formats": [
10978
"beamer"
10979
]
10980
},
10981
"description": "The Beamer color theme options for this presentation, passed to `\\usecolortheme`."
10982
},
10983
{
10984
"name": "fonttheme",
10985
"schema": "string",
10986
"tags": {
10987
"formats": [
10988
"beamer"
10989
]
10990
},
10991
"description": "The Beamer font theme for this presentation, passed to `\\usefonttheme`."
10992
},
10993
{
10994
"name": "fontthemeoptions",
10995
"schema": {
10996
"maybeArrayOf": "string"
10997
},
10998
"tags": {
10999
"formats": [
11000
"beamer"
11001
]
11002
},
11003
"description": "The Beamer font theme options for this presentation, passed to `\\usefonttheme`."
11004
},
11005
{
11006
"name": "innertheme",
11007
"schema": "string",
11008
"tags": {
11009
"formats": [
11010
"beamer"
11011
]
11012
},
11013
"description": "The Beamer inner theme for this presentation, passed to `\\useinnertheme`."
11014
},
11015
{
11016
"name": "innerthemeoptions",
11017
"schema": {
11018
"maybeArrayOf": "string"
11019
},
11020
"tags": {
11021
"formats": [
11022
"beamer"
11023
]
11024
},
11025
"description": "The Beamer inner theme options for this presentation, passed to `\\useinnertheme`."
11026
},
11027
{
11028
"name": "outertheme",
11029
"schema": "string",
11030
"tags": {
11031
"formats": [
11032
"beamer"
11033
]
11034
},
11035
"description": "The Beamer outer theme for this presentation, passed to `\\useoutertheme`."
11036
},
11037
{
11038
"name": "outerthemeoptions",
11039
"schema": {
11040
"maybeArrayOf": "string"
11041
},
11042
"tags": {
11043
"formats": [
11044
"beamer"
11045
]
11046
},
11047
"description": "The Beamer outer theme options for this presentation, passed to `\\useoutertheme`."
11048
},
11049
{
11050
"name": "themeoptions",
11051
"schema": {
11052
"maybeArrayOf": "string"
11053
},
11054
"tags": {
11055
"formats": [
11056
"beamer"
11057
]
11058
},
11059
"description": "Options passed to LaTeX Beamer themes inside `\\usetheme`."
11060
},
11061
{
11062
"name": "section",
11063
"schema": "number",
11064
"tags": {
11065
"formats": [
11066
"man"
11067
]
11068
},
11069
"description": "The section number in man pages."
11070
},
11071
{
11072
"name": "variant",
11073
"tags": {
11074
"formats": [
11075
"$markdown-all"
11076
]
11077
},
11078
"schema": "string",
11079
"description": "Enable and disable extensions for markdown output (e.g. \"+emoji\")\n"
11080
},
11081
{
11082
"name": "markdown-headings",
11083
"tags": {
11084
"formats": [
11085
"$markdown-all",
11086
"ipynb"
11087
]
11088
},
11089
"schema": {
11090
"enum": [
11091
"setext",
11092
"atx"
11093
]
11094
},
11095
"default": "atx",
11096
"description": "Specify whether to use `atx` (`#`-prefixed) or\n`setext` (underlined) headings for level 1 and 2\nheadings (`atx` or `setext`).\n"
11097
},
11098
{
11099
"name": "ipynb-output",
11100
"tags": {
11101
"formats": [
11102
"ipynb"
11103
]
11104
},
11105
"schema": {
11106
"enum": [
11107
"none",
11108
"all",
11109
"best"
11110
]
11111
},
11112
"default": "best",
11113
"description": {
11114
"short": "Determines which ipynb cell output formats are rendered (`none`, `all`, or `best`).",
11115
"long": "Determines which ipynb cell output formats are rendered.\n\n- `all`: Preserve all of the data formats included in the original.\n- `none`: Omit the contents of data cells.\n- `best` (default): Instruct pandoc to try to pick the\n richest data block in each output cell that is compatible\n with the output format.\n"
11116
}
11117
},
11118
{
11119
"name": "quarto-required",
11120
"schema": "string",
11121
"description": {
11122
"short": "semver version range for required quarto version",
11123
"long": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
11124
}
11125
},
11126
{
11127
"name": "preview-mode",
11128
"schema": "string",
11129
"tags": {
11130
"formats": [
11131
"$jats-all",
11132
"gfm"
11133
]
11134
},
11135
"description": {
11136
"short": "The mode to use when previewing this document.",
11137
"long": "The mode to use when previewing this document. To disable any special\npreviewing features, pass `raw` as the preview-mode.\n"
11138
}
11139
}
11140
],
11141
"schema/document-pdfa.yml": [
11142
{
11143
"name": "pdfa",
11144
"schema": {
11145
"anyOf": [
11146
"boolean",
11147
"string"
11148
]
11149
},
11150
"tags": {
11151
"formats": [
11152
"context"
11153
]
11154
},
11155
"description": {
11156
"short": "Adds the necessary setup to the document preamble to generate PDF/A of the type specified.",
11157
"long": "Adds the necessary setup to the document preamble to generate PDF/A of the type specified.\n\nIf the value is set to `true`, `1b:2005` will be used as default.\n\nTo successfully generate PDF/A the required\nICC color profiles have to be available and the content and all\nincluded files (such as images) have to be standard conforming.\nThe ICC profiles and output intent may be specified using the\nvariables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt\nPDFA](https://wiki.contextgarden.net/PDF/A) for more details.\n"
11158
}
11159
},
11160
{
11161
"name": "pdfaiccprofile",
11162
"schema": {
11163
"maybeArrayOf": "string"
11164
},
11165
"tags": {
11166
"formats": [
11167
"context"
11168
]
11169
},
11170
"description": {
11171
"short": "When used in conjunction with `pdfa`, specifies the ICC profile to use \nin the PDF, e.g. `default.cmyk`.\n",
11172
"long": "When used in conjunction with `pdfa`, specifies the ICC profile to use \nin the PDF, e.g. `default.cmyk`.\n\nIf left unspecified, `sRGB.icc` is used as default. May be repeated to \ninclude multiple profiles. Note that the profiles have to be available \non the system. They can be obtained from \n[ConTeXt ICC Profiles](https://wiki.contextgarden.net/PDFX#ICC_profiles).\n"
11173
}
11174
},
11175
{
11176
"name": "pdfaintent",
11177
"schema": "string",
11178
"tags": {
11179
"formats": [
11180
"context"
11181
]
11182
},
11183
"description": {
11184
"short": "When used in conjunction with `pdfa`, specifies the output intent for the colors.",
11185
"long": "When used in conjunction with `pdfa`, specifies the output intent for\nthe colors, for example `ISO coated v2 300\\letterpercent\\space (ECI)`\n\nIf left unspecified, `sRGB IEC61966-2.1` is used as default.\n"
11186
}
11187
},
11188
{
11189
"name": "pdf-standard",
11190
"schema": {
11191
"maybeArrayOf": {
11192
"enum": [
11193
"1.4",
11194
"1.5",
11195
"1.6",
11196
"1.7",
11197
"2.0",
11198
"a-1b",
11199
"a-2a",
11200
"a-2b",
11201
"a-2u",
11202
"a-3a",
11203
"a-3b",
11204
"a-3u",
11205
"a-4",
11206
"a-4f",
11207
"a-1a",
11208
"a-4e",
11209
"ua-1",
11210
"ua-2",
11211
"x-4",
11212
"x-4p",
11213
"x-5g",
11214
"x-5n",
11215
"x-5pg",
11216
"x-6",
11217
"x-6n",
11218
"x-6p"
11219
]
11220
}
11221
},
11222
"tags": {
11223
"formats": [
11224
"$pdf-all",
11225
"typst"
11226
]
11227
},
11228
"description": {
11229
"short": "PDF conformance standard (e.g., ua-2, a-2b, 1.7)",
11230
"long": "Specifies PDF conformance standards and/or version for the output.\n\nAccepts a single value or array of values:\n\n**PDF versions** (both Typst and LaTeX):\n`1.4`, `1.5`, `1.6`, `1.7`, `2.0`\n\n**PDF/A standards** (both engines):\n`a-1b`, `a-2a`, `a-2b`, `a-2u`, `a-3a`, `a-3b`, `a-3u`, `a-4`, `a-4f`\n\n**PDF/A standards** (Typst only):\n`a-1a`, `a-4e`\n\n**PDF/UA standards**:\n`ua-1` (Typst), `ua-2` (LaTeX)\n\n**PDF/X standards** (LaTeX only):\n`x-4`, `x-4p`, `x-5g`, `x-5n`, `x-5pg`, `x-6`, `x-6n`, `x-6p`\n\nExample: `pdf-standard: [a-2b, ua-2]` for accessible archival PDF.\n"
11231
}
11232
}
11233
],
11234
"schema/document-references.yml": [
11235
{
11236
"name": "bibliography",
11237
"schema": {
11238
"maybeArrayOf": "path"
11239
},
11240
"description": "Document bibliography (BibTeX or CSL). May be a single file or a list of files\n"
11241
},
11242
{
11243
"name": "csl",
11244
"schema": "path",
11245
"description": "Citation Style Language file to use for formatting references."
11246
},
11247
{
11248
"name": "citations-hover",
11249
"schema": "boolean",
11250
"tags": {
11251
"formats": [
11252
"$html-files"
11253
]
11254
},
11255
"default": true,
11256
"description": "Enables a hover popup for citation that shows the reference information."
11257
},
11258
{
11259
"name": "citation-location",
11260
"schema": {
11261
"enum": [
11262
"document",
11263
"margin"
11264
]
11265
},
11266
"tags": {
11267
"formats": [
11268
"$html-doc",
11269
"typst"
11270
]
11271
},
11272
"default": "document",
11273
"description": "Where citation information should be displayed (`document` or `margin`)"
11274
},
11275
{
11276
"name": "cite-method",
11277
"tags": {
11278
"formats": [
11279
"$pdf-all"
11280
]
11281
},
11282
"schema": {
11283
"enum": [
11284
"citeproc",
11285
"natbib",
11286
"biblatex"
11287
]
11288
},
11289
"default": "citeproc",
11290
"description": "Method used to format citations (`citeproc`, `natbib`, or `biblatex`).\n"
11291
},
11292
{
11293
"name": "citeproc",
11294
"schema": "boolean",
11295
"default": true,
11296
"description": {
11297
"short": "Turn on built-in citation processing",
11298
"long": "Turn on built-in citation processing. To use this feature, you will need\nto have a document containing citations and a source of bibliographic data: \neither an external bibliography file or a list of `references` in the \ndocument's YAML metadata. You can optionally also include a `csl` \ncitation style file.\n"
11299
}
11300
},
11301
{
11302
"name": "biblatexoptions",
11303
"schema": {
11304
"maybeArrayOf": "string"
11305
},
11306
"tags": {
11307
"formats": [
11308
"$pdf-all"
11309
]
11310
},
11311
"description": "A list of options for BibLaTeX."
11312
},
11313
{
11314
"name": "natbiboptions",
11315
"schema": {
11316
"maybeArrayOf": "string"
11317
},
11318
"tags": {
11319
"formats": [
11320
"$pdf-all"
11321
]
11322
},
11323
"description": "One or more options to provide for `natbib` when generating a bibliography."
11324
},
11325
{
11326
"name": "biblio-style",
11327
"schema": "string",
11328
"tags": {
11329
"formats": [
11330
"$pdf-all"
11331
]
11332
},
11333
"description": "The bibliography style to use (e.g. `\\bibliographystyle{dinat}`) when using `natbib` or `biblatex`."
11334
},
11335
{
11336
"name": "bibliographystyle",
11337
"schema": "string",
11338
"tags": {
11339
"formats": [
11340
"typst"
11341
]
11342
},
11343
"description": "The bibliography style to use (e.g. `#set bibliography(style: \"apa\")`) when using typst built-in citation system (e.g when not `citeproc: true`)."
11344
},
11345
{
11346
"name": "biblio-title",
11347
"schema": "string",
11348
"tags": {
11349
"formats": [
11350
"$pdf-all"
11351
]
11352
},
11353
"description": "The bibliography title to use when using `natbib` or `biblatex`."
11354
},
11355
{
11356
"name": "biblio-config",
11357
"schema": "boolean",
11358
"tags": {
11359
"formats": [
11360
"$pdf-all"
11361
]
11362
},
11363
"description": "Controls whether to output bibliography configuration for `natbib` or `biblatex` when cite method is not `citeproc`."
11364
},
11365
{
11366
"name": "citation-abbreviations",
11367
"schema": "path",
11368
"description": {
11369
"short": "JSON file containing abbreviations of journals that should be used in formatted bibliographies.",
11370
"long": "JSON file containing abbreviations of journals that should be\nused in formatted bibliographies when `form=\"short\"` is\nspecified. The format of the file can be illustrated with an\nexample:\n\n```json\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n```\n"
11371
}
11372
},
11373
{
11374
"name": "link-citations",
11375
"schema": "boolean",
11376
"tags": {
11377
"formats": [
11378
"$pdf-all",
11379
"docx"
11380
]
11381
},
11382
"description": "If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false."
11383
},
11384
{
11385
"name": "link-bibliography",
11386
"schema": "boolean",
11387
"tags": {
11388
"formats": [
11389
"$pdf-all",
11390
"docx"
11391
]
11392
},
11393
"description": {
11394
"short": "If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks.",
11395
"long": "If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks. (If an entry contains a DOI, PMCID, PMID, or URL, but none of \nthese fields are rendered by the style, then the title, or in the absence of a title the whole entry, will be hyperlinked.) Defaults to true.\n"
11396
}
11397
},
11398
{
11399
"name": "notes-after-punctuation",
11400
"schema": "boolean",
11401
"tags": {
11402
"formats": [
11403
"$pdf-all",
11404
"docx"
11405
]
11406
},
11407
"description": {
11408
"short": "Places footnote references or superscripted numerical citations after following punctuation.",
11409
"long": "If true (the default for note styles), Quarto (via Pandoc) will put footnote references or superscripted numerical citations after \nfollowing punctuation. For example, if the source contains `blah blah [@jones99]`., the result will look like `blah blah.[^1]`, with \nthe note moved after the period and the space collapsed. \n\nIf false, the space will still be collapsed, but the footnote will not be moved after the punctuation. The option may also be used \nin numerical styles that use superscripts for citation numbers (but for these styles the default is not to move the citation).\n"
11410
}
11411
}
11412
],
11413
"schema/document-render.yml": [
11414
{
11415
"name": "from",
11416
"alias": "reader",
11417
"schema": "string",
11418
"default": "markdown",
11419
"description": {
11420
"short": "Format to read from",
11421
"long": "Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n"
11422
}
11423
},
11424
{
11425
"name": "output-file",
11426
"schema": {
11427
"ref": "pandoc-format-output-file"
11428
},
11429
"default": "Input filename with output extension (e.g. .pdf, .html, etc.)",
11430
"description": "Output file to write to"
11431
},
11432
{
11433
"name": "output-ext",
11434
"schema": "string",
11435
"description": "Extension to use for generated output file\n"
11436
},
11437
{
11438
"name": "template",
11439
"disabled": [
11440
"$office-all",
11441
"ipynb"
11442
],
11443
"schema": "path",
11444
"description": "Use the specified file as a custom template for the generated document.\n"
11445
},
11446
{
11447
"name": "template-partials",
11448
"disabled": [
11449
"$office-all",
11450
"ipynb"
11451
],
11452
"schema": {
11453
"maybeArrayOf": "path"
11454
},
11455
"description": "Include the specified files as partials accessible to the template for the generated content.\n"
11456
},
11457
{
11458
"name": "embed-resources",
11459
"tags": {
11460
"formats": [
11461
"$html-files"
11462
]
11463
},
11464
"schema": "boolean",
11465
"default": false,
11466
"description": {
11467
"short": "Produce a standalone HTML file with no external dependencies",
11468
"long": "Produce a standalone HTML file with no external dependencies, using\n`data:` URIs to incorporate the contents of linked scripts, stylesheets,\nimages, and videos. The resulting file should be \"self-contained,\" in the\nsense that it needs no external files and no net access to be displayed\nproperly by a browser. This option works only with HTML output formats,\nincluding `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`, `slidy`,\n`slideous`, `dzslides`, and `revealjs`. Scripts, images, and stylesheets at\nabsolute URLs will be downloaded; those at relative URLs will be sought\nrelative to the working directory (if the first source\nfile is local) or relative to the base URL (if the first source\nfile is remote). Elements with the attribute\n`data-external=\"1\"` will be left alone; the documents they\nlink to will not be incorporated in the document.\nLimitation: resources that are loaded dynamically through\nJavaScript cannot be incorporated; as a result, some\nadvanced features (e.g. zoom or speaker notes) may not work\nin an offline \"self-contained\" `reveal.js` slide show.\n"
11469
}
11470
},
11471
{
11472
"name": "self-contained",
11473
"tags": {
11474
"formats": [
11475
"$html-files"
11476
]
11477
},
11478
"schema": "boolean",
11479
"default": false,
11480
"hidden": true,
11481
"description": {
11482
"short": "Produce a standalone HTML file with no external dependencies",
11483
"long": "Produce a standalone HTML file with no external dependencies. Note that\nthis option has been deprecated in favor of `embed-resources`.\n"
11484
}
11485
},
11486
{
11487
"name": "self-contained-math",
11488
"tags": {
11489
"formats": [
11490
"$html-files"
11491
]
11492
},
11493
"schema": "boolean",
11494
"default": false,
11495
"description": {
11496
"short": "Embed math libraries (e.g. MathJax) within `self-contained` output.",
11497
"long": "Embed math libraries (e.g. MathJax) within `self-contained` output.\nNote that math libraries are not embedded by default because they are \n quite large and often time consuming to download.\n"
11498
}
11499
},
11500
{
11501
"name": "filters",
11502
"schema": {
11503
"ref": "pandoc-format-filters"
11504
},
11505
"description": "Specify executables or Lua scripts to be used as a filter transforming\nthe pandoc AST after the input is parsed and before the output is written.\n"
11506
},
11507
{
11508
"name": "shortcodes",
11509
"schema": {
11510
"ref": "pandoc-shortcodes"
11511
},
11512
"description": "Specify Lua scripts that implement shortcode handlers\n"
11513
},
11514
{
11515
"name": "keep-md",
11516
"schema": "boolean",
11517
"default": false,
11518
"tags": {
11519
"contexts": [
11520
"document-execute"
11521
]
11522
},
11523
"description": "Keep the markdown file generated by executing code"
11524
},
11525
{
11526
"name": "keep-ipynb",
11527
"schema": "boolean",
11528
"default": false,
11529
"tags": {
11530
"contexts": [
11531
"document-execute"
11532
]
11533
},
11534
"description": "Keep the notebook file generated from executing code."
11535
},
11536
{
11537
"name": "ipynb-filters",
11538
"schema": {
11539
"arrayOf": "string"
11540
},
11541
"tags": {
11542
"contexts": [
11543
"document-execute"
11544
]
11545
},
11546
"description": "Filters to pre-process ipynb files before rendering to markdown"
11547
},
11548
{
11549
"name": "ipynb-shell-interactivity",
11550
"schema": {
11551
"enum": [
11552
null,
11553
"all",
11554
"last",
11555
"last_expr",
11556
"none",
11557
"last_expr_or_assign"
11558
]
11559
},
11560
"tags": {
11561
"contexts": [
11562
"document-execute"
11563
],
11564
"engine": "jupyter"
11565
},
11566
"description": "Specify which nodes should be run interactively (displaying output from expressions)\n"
11567
},
11568
{
11569
"name": "plotly-connected",
11570
"schema": "boolean",
11571
"default": false,
11572
"tags": {
11573
"contexts": [
11574
"document-execute"
11575
],
11576
"engine": "jupyter"
11577
},
11578
"description": "If true, use the \"notebook_connected\" plotly renderer, which downloads\nits dependencies from a CDN and requires an internet connection to view.\n"
11579
},
11580
{
11581
"name": "keep-typ",
11582
"tags": {
11583
"formats": [
11584
"typst"
11585
]
11586
},
11587
"schema": "boolean",
11588
"default": false,
11589
"description": "Keep the intermediate typst file used during render."
11590
},
11591
{
11592
"name": "keep-tex",
11593
"tags": {
11594
"formats": [
11595
"pdf",
11596
"beamer"
11597
]
11598
},
11599
"schema": "boolean",
11600
"default": false,
11601
"description": "Keep the intermediate tex file used during render."
11602
},
11603
{
11604
"name": "extract-media",
11605
"schema": "path",
11606
"description": {
11607
"short": "Extract images and other media contained in or linked from the source document to the\npath DIR.\n",
11608
"long": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n"
11609
}
11610
},
11611
{
11612
"name": "resource-path",
11613
"schema": {
11614
"arrayOf": "path"
11615
},
11616
"default": [
11617
"."
11618
],
11619
"description": "List of paths to search for images and other resources.\n"
11620
},
11621
{
11622
"name": "default-image-extension",
11623
"schema": "string",
11624
"description": {
11625
"short": "Specify a default extension to use when image paths/URLs have no extension.\n",
11626
"long": "Specify a default extension to use when image paths/URLs have no\nextension. This allows you to use the same source for formats that\nrequire different kinds of images. Currently this option only affects\nthe Markdown and LaTeX readers.\n"
11627
}
11628
},
11629
{
11630
"name": "abbreviations",
11631
"schema": "string",
11632
"description": {
11633
"short": "Specifies a custom abbreviations file, with abbreviations one to a line.\n",
11634
"long": "Specifies a custom abbreviations file, with abbreviations one to a line.\nThis list is used when reading Markdown input: strings found in this list\nwill be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain\nspaces.\n"
11635
}
11636
},
11637
{
11638
"name": "dpi",
11639
"schema": "number",
11640
"default": 96,
11641
"description": {
11642
"short": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa.\n",
11643
"long": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n"
11644
}
11645
},
11646
{
11647
"name": "html-table-processing",
11648
"schema": {
11649
"enum": [
11650
"none"
11651
]
11652
},
11653
"description": "If `none`, do not process tables in HTML input."
11654
},
11655
{
11656
"name": "html-pre-tag-processing",
11657
"tags": {
11658
"formats": [
11659
"typst"
11660
]
11661
},
11662
"schema": {
11663
"enum": [
11664
"none",
11665
"parse"
11666
]
11667
},
11668
"description": "If `none`, ignore any divs with `html-pre-tag-processing=parse` enabled."
11669
},
11670
{
11671
"name": "css-property-processing",
11672
"tags": {
11673
"formats": [
11674
"typst"
11675
]
11676
},
11677
"schema": {
11678
"enum": [
11679
"none",
11680
"translate"
11681
]
11682
},
11683
"default": "translate",
11684
"description": {
11685
"short": "CSS property translation",
11686
"long": "If `translate`, translate CSS properties into output format properties. If `none`, do not process css properties."
11687
}
11688
},
11689
{
11690
"name": "use-rsvg-convert",
11691
"schema": "boolean",
11692
"default": true,
11693
"tags": {
11694
"formats": [
11695
"$pdf-all"
11696
]
11697
},
11698
"description": "If `true`, attempt to use `rsvg-convert` to convert SVG images to PDF."
11699
}
11700
],
11701
"schema/document-reveal-content.yml": [
11702
{
11703
"name": "logo",
11704
"tags": {
11705
"formats": [
11706
"revealjs"
11707
]
11708
},
11709
"schema": {
11710
"ref": "logo-light-dark-specifier"
11711
},
11712
"description": "Logo image (placed in bottom right corner of slides)"
11713
},
11714
{
11715
"name": "footer",
11716
"tags": {
11717
"formats": [
11718
"revealjs"
11719
]
11720
},
11721
"schema": "string",
11722
"description": {
11723
"short": "Footer to include on all slides",
11724
"long": "Footer to include on all slides. Can also be set per-slide by including a\ndiv with class `.footer` on the slide.\n"
11725
}
11726
},
11727
{
11728
"name": "scrollable",
11729
"tags": {
11730
"formats": [
11731
"revealjs"
11732
]
11733
},
11734
"schema": "boolean",
11735
"default": false,
11736
"description": {
11737
"short": "Allow content that overflows slides vertically to scroll",
11738
"long": "`true` to allow content that overflows slides vertically to scroll. This can also\nbe set per-slide by including the `.scrollable` class on the slide title.\n"
11739
}
11740
},
11741
{
11742
"name": "smaller",
11743
"tags": {
11744
"formats": [
11745
"revealjs"
11746
]
11747
},
11748
"schema": "boolean",
11749
"default": false,
11750
"description": {
11751
"short": "Use a smaller default font for slide content",
11752
"long": "`true` to use a smaller default font for slide content. This can also\nbe set per-slide by including the `.smaller` class on the slide title.\n"
11753
}
11754
},
11755
{
11756
"name": "output-location",
11757
"tags": {
11758
"formats": [
11759
"revealjs"
11760
]
11761
},
11762
"schema": {
11763
"enum": [
11764
"default",
11765
"fragment",
11766
"slide",
11767
"column",
11768
"column-fragment"
11769
]
11770
},
11771
"description": {
11772
"short": "Location of output relative to the code that generated it (`default`, `fragment`, `slide`, `column`, or `column-location`)",
11773
"long": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n"
11774
}
11775
}
11776
],
11777
"schema/document-reveal-hidden.yml": [
11778
{
11779
"name": "embedded",
11780
"tags": {
11781
"formats": [
11782
"revealjs"
11783
]
11784
},
11785
"schema": "boolean",
11786
"hidden": true,
11787
"default": false,
11788
"description": "Flags if the presentation is running in an embedded mode\n"
11789
},
11790
{
11791
"name": "display",
11792
"tags": {
11793
"formats": [
11794
"revealjs"
11795
]
11796
},
11797
"schema": "string",
11798
"hidden": true,
11799
"default": "block",
11800
"description": "The display mode that will be used to show slides"
11801
}
11802
],
11803
"schema/document-reveal-layout.yml": [
11804
{
11805
"name": "auto-stretch",
11806
"tags": {
11807
"formats": [
11808
"revealjs"
11809
]
11810
},
11811
"schema": "boolean",
11812
"default": true,
11813
"description": "For slides with a single top-level image, automatically stretch it to fill the slide."
11814
},
11815
{
11816
"name": "width",
11817
"tags": {
11818
"formats": [
11819
"revealjs"
11820
]
11821
},
11822
"schema": {
11823
"anyOf": [
11824
"number",
11825
"string"
11826
]
11827
},
11828
"default": 1050,
11829
"description": {
11830
"short": "The 'normal' width of the presentation",
11831
"long": "The \"normal\" width of the presentation, aspect ratio will\nbe preserved when the presentation is scaled to fit different\nresolutions. Can be specified using percentage units.\n"
11832
}
11833
},
11834
{
11835
"name": "height",
11836
"tags": {
11837
"formats": [
11838
"revealjs"
11839
]
11840
},
11841
"schema": {
11842
"anyOf": [
11843
"number",
11844
"string"
11845
]
11846
},
11847
"default": 700,
11848
"description": {
11849
"short": "The 'normal' height of the presentation",
11850
"long": "The \"normal\" height of the presentation, aspect ratio will\nbe preserved when the presentation is scaled to fit different\nresolutions. Can be specified using percentage units.\n"
11851
}
11852
},
11853
{
11854
"name": "min-scale",
11855
"tags": {
11856
"formats": [
11857
"revealjs"
11858
]
11859
},
11860
"schema": "number",
11861
"default": 0.2,
11862
"description": "Bounds for smallest possible scale to apply to content"
11863
},
11864
{
11865
"name": "max-scale",
11866
"tags": {
11867
"formats": [
11868
"revealjs"
11869
]
11870
},
11871
"schema": "number",
11872
"default": 2,
11873
"description": "Bounds for largest possible scale to apply to content"
11874
},
11875
{
11876
"name": "center",
11877
"tags": {
11878
"formats": [
11879
"revealjs"
11880
]
11881
},
11882
"schema": "boolean",
11883
"default": false,
11884
"description": "Vertical centering of slides"
11885
},
11886
{
11887
"name": "disable-layout",
11888
"tags": {
11889
"formats": [
11890
"revealjs"
11891
]
11892
},
11893
"schema": "boolean",
11894
"default": false,
11895
"description": "Disables the default reveal.js slide layout (scaling and centering)\n"
11896
},
11897
{
11898
"name": "code-block-height",
11899
"tags": {
11900
"formats": [
11901
"revealjs"
11902
]
11903
},
11904
"schema": "string",
11905
"default": "500px",
11906
"description": "Sets the maximum height for source code blocks that appear in the presentation.\n"
11907
}
11908
],
11909
"schema/document-reveal-media.yml": [
11910
{
11911
"name": "preview-links",
11912
"tags": {
11913
"formats": [
11914
"revealjs"
11915
]
11916
},
11917
"schema": {
11918
"anyOf": [
11919
{
11920
"enum": [
11921
"auto"
11922
]
11923
},
11924
"boolean"
11925
]
11926
},
11927
"default": "auto",
11928
"description": {
11929
"short": "Open links in an iframe preview overlay (`true`, `false`, or `auto`)",
11930
"long": "Open links in an iframe preview overlay.\n\n- `true`: Open links in iframe preview overlay\n- `false`: Do not open links in iframe preview overlay\n- `auto` (default): Open links in iframe preview overlay, in fullscreen mode.\n"
11931
}
11932
},
11933
{
11934
"name": "auto-play-media",
11935
"tags": {
11936
"formats": [
11937
"revealjs"
11938
]
11939
},
11940
"schema": {
11941
"enum": [
11942
null,
11943
true,
11944
false
11945
]
11946
},
11947
"default": null,
11948
"description": "Autoplay embedded media (`null`, `true`, or `false`). Default is `null` (only when `autoplay` \nattribute is specified)\n"
11949
},
11950
{
11951
"name": "preload-iframes",
11952
"tags": {
11953
"formats": [
11954
"revealjs"
11955
]
11956
},
11957
"schema": {
11958
"enum": [
11959
null,
11960
true,
11961
false
11962
]
11963
},
11964
"default": null,
11965
"description": {
11966
"short": "Global override for preloading lazy-loaded iframes (`null`, `true`, or `false`).",
11967
"long": "Global override for preloading lazy-loaded iframes\n\n- `null`: Iframes with data-src AND data-preload will be loaded when within\n the `viewDistance`, iframes with only data-src will be loaded when visible\n- `true`: All iframes with data-src will be loaded when within the viewDistance\n- `false`: All iframes with data-src will be loaded only when visible\n"
11968
}
11969
},
11970
{
11971
"name": "view-distance",
11972
"tags": {
11973
"formats": [
11974
"revealjs"
11975
]
11976
},
11977
"schema": "number",
11978
"default": 3,
11979
"description": "Number of slides away from the current slide to pre-load resources for"
11980
},
11981
{
11982
"name": "mobile-view-distance",
11983
"tags": {
11984
"formats": [
11985
"revealjs"
11986
]
11987
},
11988
"schema": "number",
11989
"default": 2,
11990
"description": "Number of slides away from the current slide to pre-load resources for (on mobile devices).\n"
11991
},
11992
{
11993
"name": "parallax-background-image",
11994
"tags": {
11995
"formats": [
11996
"revealjs"
11997
]
11998
},
11999
"schema": "path",
12000
"description": "Parallax background image"
12001
},
12002
{
12003
"name": "parallax-background-size",
12004
"tags": {
12005
"formats": [
12006
"revealjs"
12007
]
12008
},
12009
"schema": "string",
12010
"description": "Parallax background size (e.g. '2100px 900px')"
12011
},
12012
{
12013
"name": "parallax-background-horizontal",
12014
"tags": {
12015
"formats": [
12016
"revealjs"
12017
]
12018
},
12019
"schema": "number",
12020
"default": 200,
12021
"description": "Number of pixels to move the parallax background horizontally per slide."
12022
},
12023
{
12024
"name": "parallax-background-vertical",
12025
"tags": {
12026
"formats": [
12027
"revealjs"
12028
]
12029
},
12030
"schema": "number",
12031
"default": 50,
12032
"description": "Number of pixels to move the parallax background vertically per slide."
12033
}
12034
],
12035
"schema/document-reveal-navigation.yml": [
12036
{
12037
"name": "progress",
12038
"tags": {
12039
"formats": [
12040
"revealjs"
12041
]
12042
},
12043
"schema": "boolean",
12044
"default": true,
12045
"description": "Display a presentation progress bar"
12046
},
12047
{
12048
"name": "history",
12049
"tags": {
12050
"formats": [
12051
"revealjs"
12052
]
12053
},
12054
"schema": "boolean",
12055
"default": true,
12056
"description": "Push each slide change to the browser history\n"
12057
},
12058
{
12059
"name": "navigation-mode",
12060
"tags": {
12061
"formats": [
12062
"revealjs"
12063
]
12064
},
12065
"schema": {
12066
"enum": [
12067
"linear",
12068
"vertical",
12069
"grid"
12070
]
12071
},
12072
"default": "linear",
12073
"description": {
12074
"short": "Navigation progression (`linear`, `vertical`, or `grid`)",
12075
"long": "Changes the behavior of navigation directions.\n\n- `linear`: Removes the up/down arrows. Left/right arrows step through all\n slides (both horizontal and vertical).\n\n- `vertical`: Left/right arrow keys step between horizontal slides, up/down\n arrow keys step between vertical slides. Space key steps through\n all slides (both horizontal and vertical).\n\n- `grid`: When this is enabled, stepping left/right from a vertical stack\n to an adjacent vertical stack will land you at the same vertical\n index.\n"
12076
}
12077
},
12078
{
12079
"name": "touch",
12080
"tags": {
12081
"formats": [
12082
"revealjs"
12083
]
12084
},
12085
"schema": "boolean",
12086
"default": true,
12087
"description": "Enable touch navigation on devices with touch input\n"
12088
},
12089
{
12090
"name": "keyboard",
12091
"tags": {
12092
"formats": [
12093
"revealjs"
12094
]
12095
},
12096
"schema": "boolean",
12097
"default": true,
12098
"description": "Enable keyboard shortcuts for navigation"
12099
},
12100
{
12101
"name": "mouse-wheel",
12102
"tags": {
12103
"formats": [
12104
"revealjs"
12105
]
12106
},
12107
"schema": "boolean",
12108
"default": false,
12109
"description": "Enable slide navigation via mouse wheel"
12110
},
12111
{
12112
"name": "hide-inactive-cursor",
12113
"tags": {
12114
"formats": [
12115
"revealjs"
12116
]
12117
},
12118
"schema": "boolean",
12119
"default": true,
12120
"description": "Hide cursor if inactive"
12121
},
12122
{
12123
"name": "hide-cursor-time",
12124
"tags": {
12125
"formats": [
12126
"revealjs"
12127
]
12128
},
12129
"schema": "number",
12130
"default": 5000,
12131
"description": "Time before the cursor is hidden (in ms)"
12132
},
12133
{
12134
"name": "loop",
12135
"tags": {
12136
"formats": [
12137
"revealjs"
12138
]
12139
},
12140
"schema": "boolean",
12141
"default": false,
12142
"description": "Loop the presentation"
12143
},
12144
{
12145
"name": "shuffle",
12146
"tags": {
12147
"formats": [
12148
"revealjs"
12149
]
12150
},
12151
"schema": "boolean",
12152
"default": false,
12153
"description": "Randomize the order of slides each time the presentation loads"
12154
},
12155
{
12156
"name": "controls",
12157
"tags": {
12158
"formats": [
12159
"revealjs"
12160
]
12161
},
12162
"schema": {
12163
"anyOf": [
12164
"boolean",
12165
{
12166
"enum": [
12167
"auto"
12168
]
12169
}
12170
]
12171
},
12172
"default": "auto",
12173
"description": {
12174
"short": "Show arrow controls for navigating through slides (`true`, `false`, or `auto`).",
12175
"long": "Show arrow controls for navigating through slides.\n\n- `true`: Always show controls\n- `false`: Never show controls\n- `auto` (default): Show controls when vertical slides are present or when the deck is embedded in an iframe.\n"
12176
}
12177
},
12178
{
12179
"name": "controls-layout",
12180
"tags": {
12181
"formats": [
12182
"revealjs"
12183
]
12184
},
12185
"schema": {
12186
"enum": [
12187
"edges",
12188
"bottom-right"
12189
]
12190
},
12191
"default": "edges",
12192
"description": "Location for navigation controls (`edges` or `bottom-right`)"
12193
},
12194
{
12195
"name": "controls-tutorial",
12196
"tags": {
12197
"formats": [
12198
"revealjs"
12199
]
12200
},
12201
"schema": "boolean",
12202
"default": false,
12203
"description": "Help the user learn the controls by providing visual hints."
12204
},
12205
{
12206
"name": "controls-back-arrows",
12207
"tags": {
12208
"formats": [
12209
"revealjs"
12210
]
12211
},
12212
"schema": {
12213
"enum": [
12214
"faded",
12215
"hidden",
12216
"visible"
12217
]
12218
},
12219
"default": "faded",
12220
"description": "Visibility rule for backwards navigation arrows (`faded`, `hidden`, or `visible`).\n"
12221
},
12222
{
12223
"name": "auto-slide",
12224
"tags": {
12225
"formats": [
12226
"revealjs"
12227
]
12228
},
12229
"schema": {
12230
"anyOf": [
12231
"number",
12232
{
12233
"enum": [
12234
false
12235
]
12236
}
12237
]
12238
},
12239
"default": 0,
12240
"description": "Automatically progress all slides at the specified interval"
12241
},
12242
{
12243
"name": "auto-slide-stoppable",
12244
"tags": {
12245
"formats": [
12246
"revealjs"
12247
]
12248
},
12249
"schema": "boolean",
12250
"default": true,
12251
"description": "Stop auto-sliding after user input"
12252
},
12253
{
12254
"name": "auto-slide-method",
12255
"tags": {
12256
"formats": [
12257
"revealjs"
12258
]
12259
},
12260
"schema": "string",
12261
"default": "navigateNext",
12262
"description": "Navigation method to use when auto sliding (defaults to navigateNext)"
12263
},
12264
{
12265
"name": "default-timing",
12266
"tags": {
12267
"formats": [
12268
"revealjs"
12269
]
12270
},
12271
"schema": "number",
12272
"description": "Expected average seconds per slide (used by pacing timer in speaker view)"
12273
},
12274
{
12275
"name": "pause",
12276
"tags": {
12277
"formats": [
12278
"revealjs"
12279
]
12280
},
12281
"schema": "boolean",
12282
"default": true,
12283
"description": "Flags whether it should be possible to pause the presentation (blackout)\n"
12284
},
12285
{
12286
"name": "help",
12287
"tags": {
12288
"formats": [
12289
"revealjs"
12290
]
12291
},
12292
"schema": "boolean",
12293
"default": true,
12294
"description": "Show a help overlay when the `?` key is pressed\n"
12295
},
12296
{
12297
"name": "hash",
12298
"tags": {
12299
"formats": [
12300
"revealjs"
12301
]
12302
},
12303
"schema": "boolean",
12304
"default": true,
12305
"description": "Add the current slide to the URL hash"
12306
},
12307
{
12308
"name": "hash-type",
12309
"tags": {
12310
"formats": [
12311
"revealjs"
12312
]
12313
},
12314
"schema": {
12315
"enum": [
12316
"number",
12317
"title"
12318
]
12319
},
12320
"default": "title",
12321
"description": "URL hash type (`number` or `title`)"
12322
},
12323
{
12324
"name": "hash-one-based-index",
12325
"tags": {
12326
"formats": [
12327
"revealjs"
12328
]
12329
},
12330
"schema": "boolean",
12331
"default": false,
12332
"description": "Use 1 based indexing for hash links to match slide number\n"
12333
},
12334
{
12335
"name": "respond-to-hash-changes",
12336
"tags": {
12337
"formats": [
12338
"revealjs"
12339
]
12340
},
12341
"schema": "boolean",
12342
"default": true,
12343
"description": "Monitor the hash and change slides accordingly\n"
12344
},
12345
{
12346
"name": "fragment-in-url",
12347
"tags": {
12348
"formats": [
12349
"revealjs"
12350
]
12351
},
12352
"schema": "boolean",
12353
"default": false,
12354
"description": "Include the current fragment in the URL"
12355
},
12356
{
12357
"name": "slide-tone",
12358
"tags": {
12359
"formats": [
12360
"revealjs"
12361
]
12362
},
12363
"schema": "boolean",
12364
"default": false,
12365
"description": "Play a subtle sound when changing slides"
12366
},
12367
{
12368
"name": "jump-to-slide",
12369
"tags": {
12370
"formats": [
12371
"revealjs"
12372
]
12373
},
12374
"schema": "boolean",
12375
"default": true,
12376
"description": "Deactivate jump to slide feature."
12377
}
12378
],
12379
"schema/document-reveal-print.yml": [
12380
{
12381
"name": "pdf-max-pages-per-slide",
12382
"tags": {
12383
"formats": [
12384
"revealjs"
12385
]
12386
},
12387
"schema": "number",
12388
"description": {
12389
"short": "Slides that are too tall to fit within a single page will expand onto multiple pages",
12390
"long": "Slides that are too tall to fit within a single page will expand onto multiple pages. You can limit how many pages a slide may expand to using this option.\n"
12391
}
12392
},
12393
{
12394
"name": "pdf-separate-fragments",
12395
"tags": {
12396
"formats": [
12397
"revealjs"
12398
]
12399
},
12400
"schema": "boolean",
12401
"default": false,
12402
"description": "Prints each fragment on a separate slide"
12403
},
12404
{
12405
"name": "pdf-page-height-offset",
12406
"tags": {
12407
"formats": [
12408
"revealjs"
12409
]
12410
},
12411
"schema": "number",
12412
"default": -1,
12413
"description": {
12414
"short": "Offset used to reduce the height of content within exported PDF pages.",
12415
"long": "Offset used to reduce the height of content within exported PDF pages.\nThis exists to account for environment differences based on how you\nprint to PDF. CLI printing options, like phantomjs and wkpdf, can end\non precisely the total height of the document whereas in-browser\nprinting has to end one pixel before.\n"
12416
}
12417
}
12418
],
12419
"schema/document-reveal-tools.yml": [
12420
{
12421
"name": "overview",
12422
"tags": {
12423
"formats": [
12424
"revealjs"
12425
]
12426
},
12427
"schema": "boolean",
12428
"default": true,
12429
"description": "Enable the slide overview mode"
12430
},
12431
{
12432
"name": "menu",
12433
"description": "Configuration for revealjs menu.",
12434
"tags": {
12435
"formats": [
12436
"revealjs"
12437
]
12438
},
12439
"schema": {
12440
"anyOf": [
12441
"boolean",
12442
{
12443
"object": {
12444
"properties": {
12445
"side": {
12446
"enum": [
12447
"left",
12448
"right"
12449
],
12450
"default": "left",
12451
"description": "Side of the presentation where the menu will be shown (`left` or `right`)"
12452
},
12453
"width": {
12454
"string": {
12455
"completions": [
12456
"normal",
12457
"wide",
12458
"third",
12459
"half",
12460
"full"
12461
]
12462
},
12463
"default": "normal",
12464
"description": "Width of the menu"
12465
},
12466
"numbers": {
12467
"boolean": {
12468
"default": false,
12469
"description": "Add slide numbers to menu items"
12470
}
12471
},
12472
"use-text-content-for-missing-titles": {
12473
"boolean": {
12474
"default": true,
12475
"description": "For slides with no title, attempt to use the start of the text content as the title instead.\n"
12476
}
12477
}
12478
}
12479
}
12480
}
12481
]
12482
}
12483
},
12484
{
12485
"name": "chalkboard",
12486
"description": "Configuration for revealjs chalkboard.",
12487
"tags": {
12488
"formats": [
12489
"revealjs"
12490
]
12491
},
12492
"schema": {
12493
"anyOf": [
12494
"boolean",
12495
{
12496
"object": {
12497
"properties": {
12498
"theme": {
12499
"enum": [
12500
"chalkboard",
12501
"whiteboard"
12502
],
12503
"default": "chalkboard",
12504
"description": "Visual theme for drawing surface (`chalkboard` or `whiteboard`)"
12505
},
12506
"boardmarker-width": {
12507
"number": {
12508
"default": 3,
12509
"description": "The drawing width of the boardmarker. Defaults to 3. Larger values draw thicker lines.\n"
12510
}
12511
},
12512
"chalk-width": {
12513
"number": {
12514
"default": 7,
12515
"description": "The drawing width of the chalk. Defaults to 7. Larger values draw thicker lines.\n"
12516
}
12517
},
12518
"src": {
12519
"path": {
12520
"description": "Optional file name for pre-recorded drawings (download drawings using the `D` key)\n"
12521
}
12522
},
12523
"read-only": {
12524
"boolean": {
12525
"default": false,
12526
"description": "Configuration option to prevent changes to existing drawings\n"
12527
}
12528
},
12529
"buttons": {
12530
"boolean": {
12531
"default": true,
12532
"description": "Add chalkboard buttons at the bottom of the slide\n"
12533
}
12534
},
12535
"transition": {
12536
"number": {
12537
"description": "Gives the duration (in ms) of the transition for a slide change, \nso that the notes canvas is drawn after the transition is completed.\n"
12538
}
12539
}
12540
}
12541
}
12542
}
12543
]
12544
}
12545
},
12546
{
12547
"name": "multiplex",
12548
"description": "Configuration for reveal presentation multiplexing.",
12549
"tags": {
12550
"formats": [
12551
"revealjs"
12552
]
12553
},
12554
"schema": {
12555
"anyOf": [
12556
"boolean",
12557
{
12558
"object": {
12559
"properties": {
12560
"url": {
12561
"string": {
12562
"default": "https://multiplex.up.railway.app/",
12563
"description": "Multiplex token server (defaults to Reveal-hosted server)\n"
12564
}
12565
},
12566
"id": {
12567
"string": {
12568
"description": "Unique presentation id provided by multiplex token server"
12569
}
12570
},
12571
"secret": {
12572
"string": {
12573
"description": "Secret provided by multiplex token server"
12574
}
12575
}
12576
}
12577
}
12578
}
12579
]
12580
}
12581
},
12582
{
12583
"name": "scroll-view",
12584
"description": "Control the scroll view feature of Revealjs",
12585
"tags": {
12586
"formats": [
12587
"revealjs"
12588
]
12589
},
12590
"schema": {
12591
"anyOf": [
12592
"boolean",
12593
{
12594
"object": {
12595
"properties": {
12596
"activate": {
12597
"boolean": {
12598
"default": true,
12599
"description": "Activate scroll view by default for the presentation. Otherwise, it is manually avalaible by adding `?view=scroll` to url."
12600
}
12601
},
12602
"progress": {
12603
"anyOf": [
12604
"boolean",
12605
{
12606
"enum": [
12607
"auto"
12608
]
12609
}
12610
],
12611
"default": "auto",
12612
"description": "Show the scrollbar while scrolling, hide while idle (default `auto`). Set to 'true' to always show, `false` to always hide."
12613
},
12614
"snap": {
12615
"enum": [
12616
"mandatory",
12617
"proximity",
12618
false
12619
],
12620
"default": "mandatory",
12621
"description": "When scrolling, it will automatically snap to the closest slide. Only snap when close to the top of a slide using `proximity`. Disable snapping altogether by setting to `false`.\n"
12622
},
12623
"layout": {
12624
"enum": [
12625
"compact",
12626
"full"
12627
],
12628
"default": "full",
12629
"description": "By default each slide will be sized to be as tall as the viewport. If you prefer a more dense layout with multiple slides visible in parallel, set to `compact`.\n"
12630
},
12631
"activation-width": {
12632
"number": {
12633
"description": "Control scroll view activation width. The scroll view is automatically unable when the viewport reaches mobile widths. Set to `0` to disable automatic scroll view.\n"
12634
}
12635
}
12636
}
12637
}
12638
}
12639
]
12640
}
12641
}
12642
],
12643
"schema/document-reveal-transitions.yml": [
12644
{
12645
"name": "transition",
12646
"tags": {
12647
"formats": [
12648
"revealjs"
12649
]
12650
},
12651
"schema": {
12652
"enum": [
12653
"none",
12654
"fade",
12655
"slide",
12656
"convex",
12657
"concave",
12658
"zoom"
12659
]
12660
},
12661
"default": "none",
12662
"description": {
12663
"short": "Transition style for slides",
12664
"long": "Transition style for slides backgrounds.\n(`none`, `fade`, `slide`, `convex`, `concave`, or `zoom`)\n"
12665
}
12666
},
12667
{
12668
"name": "transition-speed",
12669
"tags": {
12670
"formats": [
12671
"revealjs"
12672
]
12673
},
12674
"schema": {
12675
"enum": [
12676
"default",
12677
"fast",
12678
"slow"
12679
]
12680
},
12681
"default": "default",
12682
"description": "Slide transition speed (`default`, `fast`, or `slow`)"
12683
},
12684
{
12685
"name": "background-transition",
12686
"tags": {
12687
"formats": [
12688
"revealjs"
12689
]
12690
},
12691
"schema": {
12692
"enum": [
12693
"none",
12694
"fade",
12695
"slide",
12696
"convex",
12697
"concave",
12698
"zoom"
12699
]
12700
},
12701
"default": "none",
12702
"description": {
12703
"short": "Transition style for full page slide backgrounds",
12704
"long": "Transition style for full page slide backgrounds.\n(`none`, `fade`, `slide`, `convex`, `concave`, or `zoom`)\n"
12705
}
12706
},
12707
{
12708
"name": "fragments",
12709
"tags": {
12710
"formats": [
12711
"revealjs"
12712
]
12713
},
12714
"schema": "boolean",
12715
"default": true,
12716
"description": "Turns fragments on and off globally"
12717
},
12718
{
12719
"name": "auto-animate",
12720
"tags": {
12721
"formats": [
12722
"revealjs"
12723
]
12724
},
12725
"schema": "boolean",
12726
"default": true,
12727
"description": "Globally enable/disable auto-animate (enabled by default)"
12728
},
12729
{
12730
"name": "auto-animate-easing",
12731
"tags": {
12732
"formats": [
12733
"revealjs"
12734
]
12735
},
12736
"schema": "string",
12737
"default": "ease",
12738
"description": {
12739
"short": "Default CSS easing function for auto-animation",
12740
"long": "Default CSS easing function for auto-animation.\nCan be overridden per-slide or per-element via attributes.\n"
12741
}
12742
},
12743
{
12744
"name": "auto-animate-duration",
12745
"tags": {
12746
"formats": [
12747
"revealjs"
12748
]
12749
},
12750
"schema": "number",
12751
"default": 1,
12752
"description": {
12753
"short": "Duration (in seconds) of auto-animate transition",
12754
"long": "Duration (in seconds) of auto-animate transition.\nCan be overridden per-slide or per-element via attributes.\n"
12755
}
12756
},
12757
{
12758
"name": "auto-animate-unmatched",
12759
"tags": {
12760
"formats": [
12761
"revealjs"
12762
]
12763
},
12764
"schema": "boolean",
12765
"default": true,
12766
"description": {
12767
"short": "Auto-animate unmatched elements.",
12768
"long": "Auto-animate unmatched elements.\nCan be overridden per-slide or per-element via attributes.\n"
12769
}
12770
},
12771
{
12772
"name": "auto-animate-styles",
12773
"tags": {
12774
"formats": [
12775
"revealjs"
12776
]
12777
},
12778
"schema": {
12779
"arrayOf": {
12780
"enum": [
12781
"opacity",
12782
"color",
12783
"background-color",
12784
"padding",
12785
"font-size",
12786
"line-height",
12787
"letter-spacing",
12788
"border-width",
12789
"border-color",
12790
"border-radius",
12791
"outline",
12792
"outline-offset"
12793
]
12794
}
12795
},
12796
"description": {
12797
"short": "CSS properties that can be auto-animated (positional styles like top, left, etc.\nare always animated).\n"
12798
}
12799
}
12800
],
12801
"schema/document-slides.yml": [
12802
{
12803
"name": "incremental",
12804
"tags": {
12805
"formats": [
12806
"pptx",
12807
"beamer",
12808
"$html-pres"
12809
]
12810
},
12811
"schema": "boolean",
12812
"default": false,
12813
"description": "Make list items in slide shows display incrementally (one by one). \nThe default is for lists to be displayed all at once.\n"
12814
},
12815
{
12816
"name": "slide-level",
12817
"tags": {
12818
"formats": [
12819
"pptx",
12820
"beamer",
12821
"$html-pres"
12822
]
12823
},
12824
"schema": "number",
12825
"default": 2,
12826
"description": {
12827
"short": "Specifies that headings with the specified level create slides.\nHeadings above this level in the hierarchy are used to divide \nthe slide show into sections.\n",
12828
"long": "Specifies that headings with the specified level create slides.\nHeadings above this level in the hierarchy are used to divide \nthe slide show into sections; headings below this level create \nsubheads within a slide. Valid values are 0-6. If a slide level\nof 0 is specified, slides will not be split automatically on \nheadings, and horizontal rules must be used to indicate slide \nboundaries. If a slide level is not specified explicitly, the\nslide level will be set automatically based on the contents of\nthe document\n"
12829
}
12830
},
12831
{
12832
"name": "slide-number",
12833
"tags": {
12834
"formats": [
12835
"revealjs"
12836
]
12837
},
12838
"schema": {
12839
"anyOf": [
12840
"boolean",
12841
{
12842
"enum": [
12843
"h.v",
12844
"h/v",
12845
"c",
12846
"c/t"
12847
]
12848
}
12849
]
12850
},
12851
"default": false,
12852
"description": {
12853
"short": "Display the page number of the current slide",
12854
"long": "Display the page number of the current slide\n\n- `true`: Show slide number\n- `false`: Hide slide number\n\nCan optionally be set as a string that specifies the number formatting:\n\n- `h.v`: Horizontal . vertical slide number\n- `h/v`: Horizontal / vertical slide number\n- `c`: Flattened slide number\n- `c/t`: Flattened slide number / total slides (default)\n"
12855
}
12856
},
12857
{
12858
"name": "show-slide-number",
12859
"tags": {
12860
"formats": [
12861
"revealjs"
12862
]
12863
},
12864
"schema": {
12865
"enum": [
12866
"all",
12867
"print",
12868
"speaker"
12869
]
12870
},
12871
"default": "all",
12872
"description": "Contexts in which the slide number appears (`all`, `print`, or `speaker`)"
12873
},
12874
{
12875
"name": "title-slide-attributes",
12876
"schema": {
12877
"object": {
12878
"properties": {
12879
"data-background-color": {
12880
"string": {
12881
"description": "CSS color for title slide background"
12882
}
12883
},
12884
"data-background-image": {
12885
"string": {
12886
"description": "URL or path to the background image."
12887
}
12888
},
12889
"data-background-size": {
12890
"string": {
12891
"description": "CSS background size (defaults to `cover`)"
12892
}
12893
},
12894
"data-background-position": {
12895
"string": {
12896
"description": "CSS background position (defaults to `center`)"
12897
}
12898
},
12899
"data-background-repeat": {
12900
"string": {
12901
"description": "CSS background repeat (defaults to `no-repeat`)"
12902
}
12903
},
12904
"data-background-opacity": {
12905
"string": {
12906
"description": "Opacity of the background image on a 0-1 scale. \n0 is transparent and 1 is fully opaque.\n"
12907
}
12908
}
12909
}
12910
}
12911
},
12912
"tags": {
12913
"formats": [
12914
"revealjs"
12915
]
12916
},
12917
"description": {
12918
"short": "Additional attributes for the title slide of a reveal.js presentation.",
12919
"long": "Additional attributes for the title slide of a reveal.js presentation as a map of \nattribute names and values. For example\n\n```yaml\n title-slide-attributes:\n data-background-image: /path/to/title_image.png\n data-background-size: contain \n```\n\n(Note that the data- prefix is required here, as it isn’t added automatically.)\n"
12920
}
12921
},
12922
{
12923
"name": "title-slide-style",
12924
"tags": {
12925
"formats": [
12926
"revealjs"
12927
]
12928
},
12929
"schema": {
12930
"enum": [
12931
"pandoc",
12932
"default"
12933
]
12934
},
12935
"default": "default",
12936
"description": "The title slide style. Use `pandoc` to select the Pandoc default title slide style."
12937
},
12938
{
12939
"name": "center-title-slide",
12940
"tags": {
12941
"formats": [
12942
"revealjs"
12943
]
12944
},
12945
"schema": "boolean",
12946
"default": true,
12947
"description": "Vertical centering of title slide"
12948
},
12949
{
12950
"name": "show-notes",
12951
"tags": {
12952
"formats": [
12953
"revealjs"
12954
]
12955
},
12956
"schema": {
12957
"anyOf": [
12958
"boolean",
12959
{
12960
"enum": [
12961
"separate-page"
12962
]
12963
}
12964
]
12965
},
12966
"default": false,
12967
"description": "Make speaker notes visible to all viewers\n"
12968
},
12969
{
12970
"name": "rtl",
12971
"tags": {
12972
"formats": [
12973
"revealjs"
12974
]
12975
},
12976
"schema": "boolean",
12977
"default": false,
12978
"description": "Change the presentation direction to be RTL\n"
12979
}
12980
],
12981
"schema/document-tables.yml": [
12982
{
12983
"name": "df-print",
12984
"schema": {
12985
"enum": [
12986
"default",
12987
"kable",
12988
"tibble",
12989
"paged"
12990
]
12991
},
12992
"tags": {
12993
"engine": "knitr"
12994
},
12995
"default": "kable",
12996
"description": {
12997
"short": "Method used to print tables in Knitr engine documents (`default`,\n`kable`, `tibble`, or `paged`). Uses `default` if not specified.\n",
12998
"long": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n"
12999
}
13000
}
13001
],
13002
"schema/document-text.yml": [
13003
{
13004
"name": "wrap",
13005
"tags": {
13006
"formats": [
13007
"!$pdf-all",
13008
"!$office-all",
13009
"!$odt-all",
13010
"!$html-all",
13011
"!$docbook-all"
13012
]
13013
},
13014
"schema": {
13015
"enum": [
13016
"auto",
13017
"none",
13018
"preserve"
13019
]
13020
},
13021
"default": "auto",
13022
"description": {
13023
"short": "Determine how text is wrapped in the output (`auto`, `none`, or `preserve`).",
13024
"long": "Determine how text is wrapped in the output (the source code, not the rendered\nversion). \n\n- `auto` (default): Pandoc will attempt to wrap lines to the column width specified by `columns` (default 72). \n- `none`: Pandoc will not wrap lines at all. \n- `preserve`: Pandoc will attempt to preserve the wrapping from the source\n document. Where there are nonsemantic newlines in the source, there will be\n nonsemantic newlines in the output as well.\n"
13025
}
13026
},
13027
{
13028
"name": "columns",
13029
"tags": {
13030
"formats": [
13031
"!$pdf-all",
13032
"!$office-all",
13033
"!$odt-all",
13034
"!$html-all",
13035
"!$docbook-all",
13036
"typst"
13037
]
13038
},
13039
"schema": "number",
13040
"description": {
13041
"short": "For text formats, specify length of lines in characters. For `typst`, number of columns for body text.",
13042
"long": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n"
13043
}
13044
},
13045
{
13046
"name": "tab-stop",
13047
"tags": {
13048
"formats": [
13049
"!$pdf-all",
13050
"!$office-all",
13051
"!$odt-all",
13052
"!$html-all",
13053
"!$docbook-all"
13054
]
13055
},
13056
"schema": "number",
13057
"description": {
13058
"short": "Specify the number of spaces per tab (default is 4).",
13059
"long": "Specify the number of spaces per tab (default is 4). Note that tabs\nwithin normal textual input are always converted to spaces. Tabs \nwithin code are also converted, however this can be disabled with\n`preserve-tabs: false`.\n"
13060
}
13061
},
13062
{
13063
"name": "preserve-tabs",
13064
"tags": {
13065
"formats": [
13066
"!$pdf-all",
13067
"!$office-all",
13068
"!$odt-all",
13069
"!$html-all",
13070
"!$docbook-all"
13071
]
13072
},
13073
"schema": "boolean",
13074
"default": false,
13075
"description": {
13076
"short": "Preserve tabs within code instead of converting them to spaces.\n",
13077
"long": "Preserve tabs within code instead of converting them to spaces.\n(By default, pandoc converts tabs to spaces before parsing its input.) \nNote that this will only affect tabs in literal code spans and code blocks. \nTabs in regular text are always treated as spaces.\n"
13078
}
13079
},
13080
{
13081
"name": "eol",
13082
"tags": {
13083
"formats": [
13084
"!$pdf-all",
13085
"!$office-all",
13086
"!$odt-all",
13087
"!$html-all",
13088
"!$docbook-all"
13089
]
13090
},
13091
"schema": {
13092
"enum": [
13093
"lf",
13094
"crlf",
13095
"native"
13096
]
13097
},
13098
"description": {
13099
"short": "Manually specify line endings (`lf`, `crlf`, or `native`).",
13100
"long": "Manually specify line endings: \n\n- `crlf`: Use Windows line endings\n- `lf`: Use macOS/Linux/UNIX line endings\n- `native` (default): Use line endings appropriate to the OS on which pandoc is being run).\n"
13101
}
13102
},
13103
{
13104
"name": "strip-comments",
13105
"schema": "boolean",
13106
"tags": {
13107
"formats": [
13108
"$markdown-all",
13109
"textile",
13110
"$html-files"
13111
]
13112
},
13113
"description": {
13114
"short": "Strip out HTML comments in source, rather than passing them on to output.",
13115
"long": "Strip out HTML comments in the Markdown source,\nrather than passing them on to Markdown, Textile or HTML\noutput as raw HTML. This does not apply to HTML comments\ninside raw HTML blocks when the `markdown_in_html_blocks`\nextension is not set.\n"
13116
}
13117
},
13118
{
13119
"name": "ascii",
13120
"tags": {
13121
"formats": [
13122
"$html-all",
13123
"$pdf-all",
13124
"$markdown-all",
13125
"ms"
13126
]
13127
},
13128
"schema": "boolean",
13129
"description": {
13130
"short": "Use only ASCII characters in output.",
13131
"long": "Use only ASCII characters in output. Currently supported for XML\nand HTML formats (which use entities instead of UTF-8 when this\noption is selected), CommonMark, gfm, and Markdown (which use\nentities), roff ms (which use hexadecimal escapes), and to a\nlimited degree LaTeX (which uses standard commands for accented\ncharacters when possible). roff man output uses ASCII by default.\n"
13132
}
13133
}
13134
],
13135
"schema/document-toc.yml": [
13136
{
13137
"name": "toc",
13138
"alias": "table-of-contents",
13139
"tags": {
13140
"formats": [
13141
"!man",
13142
"!$docbook-all",
13143
"!$jats-all"
13144
]
13145
},
13146
"schema": "boolean",
13147
"description": {
13148
"short": "Include an automatically generated table of contents",
13149
"long": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n"
13150
}
13151
},
13152
{
13153
"name": "toc-indent",
13154
"tags": {
13155
"formats": [
13156
"typst"
13157
]
13158
},
13159
"schema": "string",
13160
"description": "The amount of indentation to use for each level of the table of contents.\nThe default is \"1.5em\".\n"
13161
},
13162
{
13163
"name": "toc-depth",
13164
"tags": {
13165
"formats": [
13166
"!man",
13167
"!$docbook-all",
13168
"!$jats-all",
13169
"!beamer"
13170
]
13171
},
13172
"schema": "number",
13173
"description": "Specify the number of section levels to include in the table of contents.\nThe default is 3\n"
13174
},
13175
{
13176
"name": "toc-location",
13177
"schema": {
13178
"enum": [
13179
"body",
13180
"left",
13181
"right",
13182
"left-body",
13183
"right-body"
13184
]
13185
},
13186
"default": "right",
13187
"tags": {
13188
"formats": [
13189
"$html-doc"
13190
]
13191
},
13192
"description": {
13193
"short": "Location for table of contents (`body`, `left`, `right` (default), `left-body`, `right-body`).\n",
13194
"long": "Location for table of contents:\n\n- `body`: Show the Table of Contents in the center body of the document. \n- `left`: Show the Table of Contents in left margin of the document.\n- `right`(default): Show the Table of Contents in right margin of the document.\n- `left-body`: Show two Tables of Contents in both the center body and the left margin of the document.\n- `right-body`: Show two Tables of Contents in both the center body and the right margin of the document.\n"
13195
}
13196
},
13197
{
13198
"name": "toc-title",
13199
"schema": "string",
13200
"tags": {
13201
"formats": [
13202
"$epub-all",
13203
"$odt-all",
13204
"$office-all",
13205
"$pdf-all",
13206
"$html-doc",
13207
"revealjs"
13208
]
13209
},
13210
"description": "The title used for the table of contents."
13211
},
13212
{
13213
"name": "toc-expand",
13214
"schema": {
13215
"anyOf": [
13216
"number",
13217
"boolean"
13218
]
13219
},
13220
"default": 1,
13221
"tags": {
13222
"formats": [
13223
"$html-doc"
13224
]
13225
},
13226
"description": "Specifies the depth of items in the table of contents that should be displayed as expanded in HTML output. Use `true` to expand all or `false` to collapse all.\n"
13227
},
13228
{
13229
"name": "lof",
13230
"schema": "boolean",
13231
"default": false,
13232
"tags": {
13233
"formats": [
13234
"$pdf-all",
13235
"typst"
13236
]
13237
},
13238
"description": "Print a list of figures in the document."
13239
},
13240
{
13241
"name": "lot",
13242
"schema": "boolean",
13243
"default": false,
13244
"tags": {
13245
"formats": [
13246
"$pdf-all",
13247
"typst"
13248
]
13249
},
13250
"description": "Print a list of tables in the document."
13251
}
13252
],
13253
"schema/document-website.yml": [
13254
{
13255
"name": "search",
13256
"schema": "boolean",
13257
"tags": {
13258
"formats": [
13259
"$html-doc"
13260
]
13261
},
13262
"default": true,
13263
"description": "Setting this to false prevents this document from being included in searches."
13264
},
13265
{
13266
"name": "repo-actions",
13267
"schema": {
13268
"anyOf": [
13269
"boolean",
13270
{
13271
"maybeArrayOf": {
13272
"enum": [
13273
"none",
13274
"edit",
13275
"source",
13276
"issue"
13277
],
13278
"description": {
13279
"short": "Links to source repository actions",
13280
"long": "Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`)"
13281
}
13282
}
13283
}
13284
]
13285
},
13286
"tags": {
13287
"formats": [
13288
"$html-doc"
13289
]
13290
},
13291
"description": "Setting this to false prevents the `repo-actions` from appearing on this page.\nOther possible values are `none` or one or more of `edit`, `source`, and `issue`, *e.g.* `[edit, source, issue]`.\n"
13292
},
13293
{
13294
"name": "aliases",
13295
"schema": {
13296
"arrayOf": "string"
13297
},
13298
"tags": {
13299
"formats": [
13300
"$html-doc"
13301
]
13302
},
13303
"description": "URLs that alias this document, when included in a website."
13304
},
13305
{
13306
"name": "image",
13307
"schema": {
13308
"anyOf": [
13309
"path",
13310
"boolean"
13311
]
13312
},
13313
"tags": {
13314
"formats": [
13315
"$html-doc"
13316
]
13317
},
13318
"description": {
13319
"short": "The path to a preview image for this document.",
13320
"long": "The path to a preview image for this content. By default, \nQuarto will use the image value from the site: metadata. \nIf you provide an image, you may also optionally provide \nan image-width and image-height to improve \nthe appearance of your Twitter Card.\n\nIf image is not provided, Quarto will automatically attempt \nto locate a preview image.\n"
13321
}
13322
},
13323
{
13324
"name": "image-height",
13325
"schema": "string",
13326
"tags": {
13327
"formats": [
13328
"$html-doc"
13329
]
13330
},
13331
"description": "The height of the preview image for this document."
13332
},
13333
{
13334
"name": "image-width",
13335
"schema": "string",
13336
"tags": {
13337
"formats": [
13338
"$html-doc"
13339
]
13340
},
13341
"description": "The width of the preview image for this document."
13342
},
13343
{
13344
"name": "image-alt",
13345
"schema": "string",
13346
"tags": {
13347
"formats": [
13348
"$html-doc"
13349
]
13350
},
13351
"description": "The alt text for preview image on this page."
13352
},
13353
{
13354
"name": "image-lazy-loading",
13355
"schema": "boolean",
13356
"tags": {
13357
"formats": [
13358
"$html-doc"
13359
]
13360
},
13361
"description": {
13362
"short": "If true, the preview image will only load when it comes into view.",
13363
"long": "Enables lazy loading for the preview image. If true, the preview image element \nwill have `loading=\"lazy\"`, and will only load when it comes into view.\n\nIf false, the preview image will load immediately.\n"
13364
},
13365
"default": true
13366
}
13367
],
13368
"schema/extension.yml": [
13369
{
13370
"name": "title",
13371
"description": "Extension title.",
13372
"schema": "string"
13373
},
13374
{
13375
"name": "author",
13376
"description": "Extension author.",
13377
"schema": "string"
13378
},
13379
{
13380
"name": "version",
13381
"description": "Extension version.",
13382
"schema": {
13383
"ref": "semver"
13384
}
13385
},
13386
{
13387
"name": "quarto-required",
13388
"description": "Quarto version range. See https://docs.npmjs.com/cli/v6/using-npm/semver for syntax details.",
13389
"schema": "string"
13390
},
13391
{
13392
"name": "contributes",
13393
"schema": {
13394
"object": {
13395
"properties": {
13396
"shortcodes": {
13397
"arrayOf": "path"
13398
},
13399
"filters": {
13400
"arrayOf": {
13401
"anyOf": [
13402
"path",
13403
{
13404
"object": {
13405
"properties": {
13406
"path": {
13407
"schema": "path"
13408
},
13409
"at": {
13410
"ref": "filter-entry-point"
13411
}
13412
},
13413
"required": [
13414
"path"
13415
]
13416
}
13417
}
13418
]
13419
}
13420
},
13421
"formats": {
13422
"schema": "object"
13423
},
13424
"engines": {
13425
"arrayOf": {
13426
"anyOf": [
13427
"string",
13428
{
13429
"ref": "external-engine"
13430
}
13431
]
13432
}
13433
}
13434
}
13435
}
13436
}
13437
}
13438
],
13439
"schema/format-aliases.yml": {
13440
"aliases": {
13441
"epub-all": [
13442
"epub",
13443
"epub2",
13444
"epub3"
13445
],
13446
"pdf-all": [
13447
"latex",
13448
"pdf",
13449
"beamer"
13450
],
13451
"markdown-all": [
13452
"markdown",
13453
"gfm",
13454
"commonmark",
13455
"commonmark_x",
13456
"markua",
13457
"md"
13458
],
13459
"office-all": [
13460
"docx",
13461
"pptx"
13462
],
13463
"docbook-all": [
13464
"docbook",
13465
"docbook4",
13466
"docbook5"
13467
],
13468
"odt-all": [
13469
"odt",
13470
"opendocument"
13471
],
13472
"html-doc": [
13473
"html",
13474
"html4",
13475
"html5"
13476
],
13477
"html-pres": [
13478
"slidy",
13479
"slideous",
13480
"s5",
13481
"revealjs",
13482
"dzslides"
13483
],
13484
"pres-all": [
13485
"pptx",
13486
"beamer",
13487
"$html-pres"
13488
],
13489
"html-files": [
13490
"$html-doc",
13491
"$html-pres",
13492
"dashboard"
13493
],
13494
"html-all": [
13495
"$html-files",
13496
"$epub-all"
13497
],
13498
"asciidoc-all": [
13499
"asciidoc",
13500
"asciidoctor"
13501
],
13502
"jats-all": [
13503
"jats",
13504
"jats_archiving",
13505
"jats_articleauthoring",
13506
"jats_publishing"
13507
],
13508
"pandoc-all": [
13509
"asciidoc",
13510
"asciidoctor",
13511
"beamer",
13512
"biblatex",
13513
"bibtex",
13514
"chunkedhtml",
13515
"commonmark",
13516
"commonmark_x",
13517
"context",
13518
"csljson",
13519
"docbook",
13520
"docbook4",
13521
"docbook5",
13522
"docx",
13523
"dokuwiki",
13524
"dzslides",
13525
"epub",
13526
"epub2",
13527
"epub3",
13528
"fb2",
13529
"gfm",
13530
"haddock",
13531
"html",
13532
"html4",
13533
"html5",
13534
"icml",
13535
"ipynb",
13536
"jats",
13537
"jats_archiving",
13538
"jats_articleauthoring",
13539
"jats_publishing",
13540
"jira",
13541
"json",
13542
"latex",
13543
"man",
13544
"markdown",
13545
"markdown_github",
13546
"markdown_mmd",
13547
"markdown_phpextra",
13548
"markdown_strict",
13549
"markua",
13550
"mediawiki",
13551
"ms",
13552
"muse",
13553
"native",
13554
"odt",
13555
"opendocument",
13556
"opml",
13557
"org",
13558
"pdf",
13559
"plain",
13560
"pptx",
13561
"revealjs",
13562
"rst",
13563
"rtf",
13564
"s5",
13565
"slideous",
13566
"slidy",
13567
"tei",
13568
"texinfo",
13569
"textile",
13570
"typst",
13571
"xwiki",
13572
"zimwiki",
13573
"md",
13574
"dashboard"
13575
]
13576
}
13577
},
13578
"schema/groups.yml": {
13579
"cell": {
13580
"attributes": {
13581
"title": "Attributes"
13582
},
13583
"card": {
13584
"title": "Card"
13585
},
13586
"codeoutput": {
13587
"title": "Code Output"
13588
},
13589
"textoutput": {
13590
"title": "Cell Output"
13591
},
13592
"figure": {
13593
"title": "Figures"
13594
},
13595
"table": {
13596
"title": "Tables"
13597
},
13598
"layout": {
13599
"title": "Panel Layout"
13600
},
13601
"pagelayout": {
13602
"title": "Page Columns"
13603
},
13604
"cache": {
13605
"title": "Cache"
13606
},
13607
"include": {
13608
"title": "Include"
13609
}
13610
},
13611
"document": {
13612
"attributes": {
13613
"title": "Title & Author"
13614
},
13615
"dashboard": {
13616
"title": "Dashboard"
13617
},
13618
"typst": {
13619
"title": "Typst"
13620
},
13621
"options": {
13622
"title": "Format Options"
13623
},
13624
"toc": {
13625
"title": "Table of Contents"
13626
},
13627
"numbering": {
13628
"title": "Numbering"
13629
},
13630
"slides": {
13631
"title": "Slides"
13632
},
13633
"reveal-content": {
13634
"title": "Slide Content"
13635
},
13636
"reveal-tools": {
13637
"title": "Slide Tools"
13638
},
13639
"reveal-transitions": {
13640
"title": "Transitions"
13641
},
13642
"reveal-navigation": {
13643
"title": "Navigation"
13644
},
13645
"reveal-print": {
13646
"title": "Print to PDF"
13647
},
13648
"reveal-media": {
13649
"title": "Media"
13650
},
13651
"reveal-layout": {
13652
"title": "Slide Layout"
13653
},
13654
"reveal-hidden": {
13655
"title": "Reveal Hidden"
13656
},
13657
"epub": {
13658
"title": "ePub Options"
13659
},
13660
"fonts": {
13661
"title": "Fonts"
13662
},
13663
"colors": {
13664
"title": "Colors"
13665
},
13666
"layout": {
13667
"title": "Layout"
13668
},
13669
"formatting": {
13670
"title": "Formatting"
13671
},
13672
"code": {
13673
"title": "Code"
13674
},
13675
"execute": {
13676
"title": "Execution",
13677
"description": "Execution options should be specified within the `execute` key. For example:\n\n```yaml\nexecute:\n echo: false\n warning: false\n```\n"
13678
},
13679
"figures": {
13680
"title": "Figures"
13681
},
13682
"lightbox": {
13683
"title": "Lightbox Figures"
13684
},
13685
"tables": {
13686
"title": "Tables"
13687
},
13688
"links": {
13689
"title": "Links"
13690
},
13691
"references": {
13692
"title": "References"
13693
},
13694
"footnotes": {
13695
"title": "Footnotes"
13696
},
13697
"crossref": {
13698
"title": "Cross-References"
13699
},
13700
"citation": {
13701
"title": "Citation"
13702
},
13703
"language": {
13704
"title": "Language"
13705
},
13706
"comments": {
13707
"title": "Comments"
13708
},
13709
"a11y": {
13710
"title": "Accessibility"
13711
},
13712
"includes": {
13713
"title": "Includes"
13714
},
13715
"metadata": {
13716
"title": "Metadata"
13717
},
13718
"render": {
13719
"title": "Rendering"
13720
},
13721
"latexmk": {
13722
"title": "Latexmk"
13723
},
13724
"website": {
13725
"title": "Website"
13726
},
13727
"pdfa": {
13728
"title": "PDF/A"
13729
},
13730
"text": {
13731
"title": "Text Output"
13732
},
13733
"library": {
13734
"title": "Library"
13735
},
13736
"editor": {
13737
"title": "Editor"
13738
},
13739
"hidden": {
13740
"title": "Hidden"
13741
}
13742
}
13743
},
13744
"schema/project.yml": [
13745
{
13746
"name": "project",
13747
"description": "Project configuration.",
13748
"schema": {
13749
"object": {
13750
"closed": true,
13751
"properties": {
13752
"title": {
13753
"schema": "string"
13754
},
13755
"type": {
13756
"string": {
13757
"completions": [
13758
"default",
13759
"website",
13760
"book",
13761
"manuscript"
13762
],
13763
"description": "Project type (`default`, `website`, `book`, or `manuscript`)"
13764
}
13765
},
13766
"render": {
13767
"arrayOf": "path",
13768
"description": "Files to render (defaults to all files)"
13769
},
13770
"execute-dir": {
13771
"enum": [
13772
"file",
13773
"project"
13774
],
13775
"description": {
13776
"short": "Working directory for computations",
13777
"long": "Control the working directory for computations. \n\n- `file`: Use the directory of the file that is currently executing.\n- `project`: Use the root directory of the project.\n"
13778
}
13779
},
13780
"output-dir": {
13781
"path": {
13782
"description": "Output directory"
13783
}
13784
},
13785
"lib-dir": {
13786
"path": {
13787
"description": "HTML library (JS/CSS/etc.) directory"
13788
}
13789
},
13790
"resources": {
13791
"maybeArrayOf": {
13792
"schema": "path",
13793
"description": "Additional file resources to be copied to output directory"
13794
}
13795
},
13796
"brand": {
13797
"schema": {
13798
"ref": "brand-path-only-light-dark"
13799
},
13800
"description": "Path to brand.yml or object with light and dark paths to brand.yml\n"
13801
},
13802
"preview": {
13803
"description": "Options for `quarto preview`",
13804
"schema": {
13805
"ref": "project-preview"
13806
}
13807
},
13808
"pre-render": {
13809
"description": "Scripts to run as a pre-render step",
13810
"schema": {
13811
"maybeArrayOf": "string"
13812
}
13813
},
13814
"post-render": {
13815
"description": "Scripts to run as a post-render step",
13816
"schema": {
13817
"maybeArrayOf": "string"
13818
}
13819
},
13820
"detect": {
13821
"description": "Array of paths used to detect the project type within a directory",
13822
"schema": {
13823
"arrayOf": {
13824
"arrayOf": "string"
13825
}
13826
},
13827
"hidden": true
13828
}
13829
}
13830
}
13831
}
13832
},
13833
{
13834
"name": "website",
13835
"description": "Website configuration.",
13836
"schema": {
13837
"ref": "base-website"
13838
}
13839
},
13840
{
13841
"name": "book",
13842
"description": "Book configuration.",
13843
"schema": {
13844
"object": {
13845
"super": [
13846
{
13847
"resolveRef": "book-schema"
13848
},
13849
{
13850
"resolveRef": "csl-item-shared"
13851
}
13852
]
13853
}
13854
}
13855
},
13856
{
13857
"name": "manuscript",
13858
"description": "Manuscript configuration",
13859
"schema": {
13860
"ref": "manuscript-schema"
13861
}
13862
},
13863
{
13864
"name": "type",
13865
"hidden": true,
13866
"schema": {
13867
"enum": [
13868
"cd93424f-d5ba-4e95-91c6-1890eab59fc7"
13869
]
13870
},
13871
"errorMessage": "type key not supported at project type-level. Use `project: type: ...` instead.",
13872
"description": "internal-schema-hack"
13873
},
13874
{
13875
"name": "engines",
13876
"schema": {
13877
"arrayOf": {
13878
"anyOf": [
13879
"string",
13880
{
13881
"ref": "external-engine"
13882
}
13883
]
13884
}
13885
},
13886
"description": "List execution engines you want to give priority when determining which engine should render a notebook. If two engines have support for a notebook, the one listed earlier will be chosen. Quarto's default order is 'knitr', 'jupyter', 'markdown', 'julia'."
13887
}
13888
],
13889
"schema/schema.yml": [
13890
{
13891
"id": "schema/scalar",
13892
"anyOf": [
13893
"number",
13894
"boolean",
13895
"string",
13896
{
13897
"enum": [
13898
null
13899
]
13900
}
13901
]
13902
},
13903
{
13904
"id": "schema/description",
13905
"anyOf": [
13906
"string",
13907
{
13908
"object": {
13909
"closed": true,
13910
"properties": {
13911
"short": "string",
13912
"long": "string"
13913
}
13914
}
13915
}
13916
]
13917
},
13918
{
13919
"id": "schema/base",
13920
"object": {
13921
"closed": true,
13922
"properties": {
13923
"additionalCompletions": {
13924
"arrayOf": "string"
13925
},
13926
"completions": {
13927
"arrayOf": "string"
13928
},
13929
"id": "string",
13930
"hidden": "boolean",
13931
"tags": "object",
13932
"errorDescription": "string",
13933
"description": {
13934
"ref": "schema/description"
13935
},
13936
"default": "any"
13937
}
13938
}
13939
},
13940
{
13941
"id": "schema/enum",
13942
"object": {
13943
"closed": true,
13944
"super": {
13945
"resolveRef": "schema/base"
13946
},
13947
"required": [
13948
"enum"
13949
],
13950
"properties": {
13951
"enum": {
13952
"anyOf": [
13953
{
13954
"arrayOf": {
13955
"ref": "schema/scalar"
13956
}
13957
},
13958
{
13959
"object": {
13960
"closed": true,
13961
"super": {
13962
"resolveRef": "schema/base"
13963
},
13964
"properties": {
13965
"values": {
13966
"arrayOf": {
13967
"ref": "schema/scalar"
13968
}
13969
}
13970
}
13971
}
13972
}
13973
]
13974
}
13975
}
13976
}
13977
},
13978
{
13979
"id": "schema/null",
13980
"anyOf": [
13981
{
13982
"enum": [
13983
"null"
13984
]
13985
},
13986
{
13987
"object": {
13988
"closed": true,
13989
"required": [
13990
"null"
13991
],
13992
"properties": {
13993
"null": {
13994
"anyOf": [
13995
{
13996
"ref": "schema/base"
13997
}
13998
]
13999
}
14000
}
14001
}
14002
}
14003
]
14004
},
14005
{
14006
"id": "schema/explicit-schema",
14007
"object": {
14008
"closed": true,
14009
"required": [
14010
"schema"
14011
],
14012
"super": {
14013
"resolveRef": "schema/base"
14014
},
14015
"properties": {
14016
"schema": {
14017
"ref": "schema/schema"
14018
}
14019
}
14020
}
14021
},
14022
{
14023
"id": "schema/explicit-pattern-string",
14024
"object": {
14025
"closed": true,
14026
"super": {
14027
"resolveRef": "schema/base"
14028
},
14029
"required": [
14030
"pattern"
14031
],
14032
"properties": {
14033
"pattern": "string"
14034
}
14035
}
14036
},
14037
{
14038
"id": "schema/string",
14039
"anyOf": [
14040
{
14041
"enum": [
14042
"string",
14043
"path"
14044
]
14045
},
14046
{
14047
"ref": "schema/explicit-pattern-string"
14048
},
14049
{
14050
"object": {
14051
"closed": true,
14052
"super": {
14053
"resolveRef": "schema/base"
14054
},
14055
"required": [
14056
"path"
14057
],
14058
"properties": {
14059
"path": {
14060
"anyOf": [
14061
{
14062
"ref": "schema/explicit-pattern-string"
14063
},
14064
{
14065
"ref": "schema/base"
14066
}
14067
]
14068
}
14069
}
14070
}
14071
},
14072
{
14073
"object": {
14074
"closed": true,
14075
"super": {
14076
"resolveRef": "schema/base"
14077
},
14078
"required": [
14079
"string"
14080
],
14081
"properties": {
14082
"string": {
14083
"anyOf": [
14084
{
14085
"ref": "schema/explicit-pattern-string"
14086
},
14087
{
14088
"ref": "schema/base"
14089
}
14090
]
14091
}
14092
}
14093
}
14094
}
14095
]
14096
},
14097
{
14098
"id": "schema/number",
14099
"anyOf": [
14100
{
14101
"enum": [
14102
"number"
14103
]
14104
},
14105
{
14106
"object": {
14107
"closed": true,
14108
"super": {
14109
"resolveRef": "schema/base"
14110
},
14111
"required": [
14112
"number"
14113
],
14114
"properties": {
14115
"number": {
14116
"anyOf": [
14117
{
14118
"ref": "schema/schema"
14119
},
14120
{
14121
"ref": "schema/base"
14122
}
14123
]
14124
}
14125
}
14126
}
14127
}
14128
]
14129
},
14130
{
14131
"id": "schema/boolean",
14132
"anyOf": [
14133
{
14134
"enum": [
14135
"boolean"
14136
]
14137
},
14138
{
14139
"object": {
14140
"closed": true,
14141
"required": [
14142
"boolean"
14143
],
14144
"super": {
14145
"resolveRef": "schema/base"
14146
},
14147
"properties": {
14148
"boolean": {
14149
"anyOf": [
14150
{
14151
"ref": "schema/schema"
14152
},
14153
{
14154
"ref": "schema/base"
14155
}
14156
]
14157
}
14158
}
14159
}
14160
}
14161
]
14162
},
14163
{
14164
"id": "schema/resolve-ref",
14165
"object": {
14166
"closed": true,
14167
"required": [
14168
"resolveRef"
14169
],
14170
"properties": {
14171
"resolveRef": "string"
14172
}
14173
}
14174
},
14175
{
14176
"id": "schema/ref",
14177
"object": {
14178
"closed": true,
14179
"required": [
14180
"ref"
14181
],
14182
"properties": {
14183
"ref": "string",
14184
"description": {
14185
"ref": "schema/description"
14186
}
14187
}
14188
}
14189
},
14190
{
14191
"id": "schema/maybe-array-of",
14192
"object": {
14193
"closed": true,
14194
"required": [
14195
"maybeArrayOf"
14196
],
14197
"super": {
14198
"resolveRef": "schema/base"
14199
},
14200
"properties": {
14201
"maybeArrayOf": {
14202
"ref": "schema/schema"
14203
}
14204
}
14205
}
14206
},
14207
{
14208
"id": "schema/array-of",
14209
"object": {
14210
"closed": true,
14211
"super": {
14212
"resolveRef": "schema/base"
14213
},
14214
"required": [
14215
"arrayOf"
14216
],
14217
"properties": {
14218
"arrayOf": {
14219
"anyOf": [
14220
{
14221
"ref": "schema/schema"
14222
},
14223
{
14224
"object": {
14225
"closed": true,
14226
"super": {
14227
"resolveRef": "schema/base"
14228
},
14229
"properties": {
14230
"length": "number",
14231
"schema": {
14232
"ref": "schema/schema"
14233
}
14234
}
14235
}
14236
}
14237
]
14238
}
14239
}
14240
}
14241
},
14242
{
14243
"id": "schema/all-of",
14244
"object": {
14245
"closed": true,
14246
"super": {
14247
"resolveRef": "schema/base"
14248
},
14249
"required": [
14250
"allOf"
14251
],
14252
"properties": {
14253
"allOf": {
14254
"anyOf": [
14255
{
14256
"arrayOf": {
14257
"ref": "schema/schema"
14258
}
14259
},
14260
{
14261
"object": {
14262
"super": {
14263
"resolveRef": "schema/base"
14264
},
14265
"properties": {
14266
"schemas": {
14267
"arrayOf": {
14268
"ref": "schema/schema"
14269
}
14270
}
14271
}
14272
}
14273
}
14274
]
14275
}
14276
}
14277
}
14278
},
14279
{
14280
"id": "schema/any-of",
14281
"object": {
14282
"closed": true,
14283
"super": {
14284
"resolveRef": "schema/base"
14285
},
14286
"required": [
14287
"anyOf"
14288
],
14289
"properties": {
14290
"anyOf": {
14291
"anyOf": [
14292
{
14293
"arrayOf": {
14294
"ref": "schema/schema"
14295
}
14296
},
14297
{
14298
"object": {
14299
"super": {
14300
"resolveRef": "schema/base"
14301
},
14302
"properties": {
14303
"schemas": {
14304
"arrayOf": {
14305
"ref": "schema/schema"
14306
}
14307
}
14308
}
14309
}
14310
}
14311
]
14312
}
14313
}
14314
}
14315
},
14316
{
14317
"id": "schema/record",
14318
"object": {
14319
"closed": true,
14320
"super": {
14321
"resolveRef": "schema/base"
14322
},
14323
"required": [
14324
"record"
14325
],
14326
"properties": {
14327
"record": {
14328
"anyOf": [
14329
{
14330
"object": {
14331
"additionalProperties": {
14332
"ref": "schema/schema"
14333
}
14334
}
14335
},
14336
{
14337
"object": {
14338
"closed": true,
14339
"super": {
14340
"resolveRef": "schema/base"
14341
},
14342
"properties": {
14343
"properties": {
14344
"object": {
14345
"additionalProperties": {
14346
"ref": "schema/schema"
14347
}
14348
}
14349
}
14350
},
14351
"required": [
14352
"properties"
14353
]
14354
}
14355
}
14356
]
14357
}
14358
}
14359
}
14360
},
14361
{
14362
"id": "schema/object",
14363
"anyOf": [
14364
{
14365
"enum": [
14366
"object"
14367
]
14368
},
14369
{
14370
"object": {
14371
"closed": true,
14372
"super": {
14373
"resolveRef": "schema/base"
14374
},
14375
"required": [
14376
"object"
14377
],
14378
"properties": {
14379
"object": {
14380
"object": {
14381
"super": {
14382
"resolveRef": "schema/base"
14383
},
14384
"closed": true,
14385
"properties": {
14386
"namingConvention": {
14387
"anyOf": [
14388
{
14389
"enum": [
14390
"ignore"
14391
]
14392
},
14393
{
14394
"arrayOf": {
14395
"enum": [
14396
"camelCase",
14397
"camel-case",
14398
"camel_case",
14399
"capitalizationCase",
14400
"capitalization-case",
14401
"capitalization_case",
14402
"underscoreCase",
14403
"underscore-case",
14404
"underscore_case",
14405
"snakeCase",
14406
"snake-case",
14407
"snake_case",
14408
"dashCase",
14409
"dash-case",
14410
"dash_case",
14411
"kebabCase",
14412
"kebab-case",
14413
"kebab_case"
14414
]
14415
}
14416
}
14417
]
14418
},
14419
"properties": {
14420
"object": {
14421
"additionalProperties": {
14422
"ref": "schema/schema"
14423
}
14424
}
14425
},
14426
"patternProperties": {
14427
"object": {
14428
"additionalProperties": {
14429
"ref": "schema/schema"
14430
}
14431
}
14432
},
14433
"propertyNames": {
14434
"ref": "schema/schema"
14435
},
14436
"additionalProperties": {
14437
"ref": "schema/schema"
14438
},
14439
"super": {
14440
"maybeArrayOf": {
14441
"ref": "schema/schema"
14442
}
14443
},
14444
"required": {
14445
"anyOf": [
14446
{
14447
"enum": [
14448
"all"
14449
]
14450
},
14451
{
14452
"arrayOf": "string"
14453
}
14454
]
14455
},
14456
"closed": "boolean",
14457
"description": {
14458
"ref": "schema/description"
14459
},
14460
"completions": {
14461
"arrayOf": "string"
14462
}
14463
}
14464
}
14465
}
14466
}
14467
}
14468
}
14469
]
14470
},
14471
{
14472
"id": "schema/schema",
14473
"anyOf": [
14474
{
14475
"ref": "schema/enum"
14476
},
14477
{
14478
"ref": "schema/null"
14479
},
14480
{
14481
"ref": "schema/explicit-schema"
14482
},
14483
{
14484
"ref": "schema/string"
14485
},
14486
{
14487
"ref": "schema/number"
14488
},
14489
{
14490
"ref": "schema/boolean"
14491
},
14492
{
14493
"ref": "schema/ref"
14494
},
14495
{
14496
"ref": "schema/resolve-ref"
14497
},
14498
{
14499
"ref": "schema/any-of"
14500
},
14501
{
14502
"ref": "schema/array-of"
14503
},
14504
{
14505
"ref": "schema/maybe-array-of"
14506
},
14507
{
14508
"ref": "schema/all-of"
14509
},
14510
{
14511
"ref": "schema/record"
14512
},
14513
{
14514
"ref": "schema/object"
14515
},
14516
{
14517
"enum": [
14518
null,
14519
"any"
14520
]
14521
}
14522
],
14523
"description": "be a yaml schema"
14524
},
14525
{
14526
"id": "schema/schema-field",
14527
"object": {
14528
"properties": {
14529
"name": "string",
14530
"schema": {
14531
"ref": "schema/schema"
14532
},
14533
"hidden": "boolean",
14534
"alias": "string",
14535
"disabled": {
14536
"maybeArrayOf": "string"
14537
},
14538
"enabled": {
14539
"maybeArrayOf": "string"
14540
},
14541
"description": {
14542
"ref": "schema/description"
14543
},
14544
"tags": "object",
14545
"errorMessage": "string"
14546
},
14547
"namingConvention": "ignore",
14548
"required": [
14549
"name",
14550
"schema",
14551
"description"
14552
],
14553
"propertyNames": {
14554
"enum": [
14555
"name",
14556
"schema",
14557
"hidden",
14558
"alias",
14559
"disabled",
14560
"enabled",
14561
"description",
14562
"tags",
14563
"errorMessage",
14564
"default"
14565
]
14566
}
14567
}
14568
}
14569
],
14570
"pandoc/formats.yml": [
14571
"ansi",
14572
"asciidoc",
14573
"asciidoc_legacy",
14574
"asciidoctor",
14575
"bbcode",
14576
"bbcode_fluxbb",
14577
"bbcode_hubzilla",
14578
"bbcode_phpbb",
14579
"bbcode_steam",
14580
"bbcode_xenforo",
14581
"beamer",
14582
"biblatex",
14583
"bibtex",
14584
"chunkedhtml",
14585
"commonmark",
14586
"commonmark_x",
14587
"context",
14588
"csljson",
14589
"djot",
14590
"docbook",
14591
"docbook4",
14592
"docbook5",
14593
"docx",
14594
"dokuwiki",
14595
"dzslides",
14596
"epub",
14597
"epub2",
14598
"epub3",
14599
"fb2",
14600
"gfm",
14601
"haddock",
14602
"html",
14603
"html4",
14604
"html5",
14605
"icml",
14606
"ipynb",
14607
"jats",
14608
"jats_archiving",
14609
"jats_articleauthoring",
14610
"jats_publishing",
14611
"jira",
14612
"json",
14613
"latex",
14614
"man",
14615
"markdown",
14616
"markdown_github",
14617
"markdown_mmd",
14618
"markdown_phpextra",
14619
"markdown_strict",
14620
"markua",
14621
"mediawiki",
14622
"ms",
14623
"muse",
14624
"native",
14625
"odt",
14626
"opendocument",
14627
"opml",
14628
"org",
14629
"pdf",
14630
"plain",
14631
"pptx",
14632
"revealjs",
14633
"rst",
14634
"rtf",
14635
"s5",
14636
"slideous",
14637
"slidy",
14638
"tei",
14639
"texinfo",
14640
"textile",
14641
"typst",
14642
"vimdoc",
14643
"xml",
14644
"xwiki",
14645
"zimwiki"
14646
],
14647
"schema/html-descriptions.yml": [
14648
{
14649
"short": "Automatically generate sidebar contents.",
14650
"long": "Automatically generate sidebar contents. Pass <code>true</code> to\ninclude all documents in the site, a directory name to include only\ndocuments in that directory, or a glob (or list of globs) to include\ndocuments based on a pattern.\nSubdirectories will create sections (use an <code>index.qmd</code> in\nthe directory to provide its title). Order will be alphabetical unless a\nnumeric <code>order</code> field is provided in document metadata."
14651
},
14652
"Accessible label for the item.",
14653
"Alias for href",
14654
"Link to file contained with the project or external URL",
14655
{
14656
"short": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>bluesky</code>, <code>share</code>)",
14657
"long": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>bluesky</code>, <code>share</code>) See <a href=\"https://icons.getbootstrap.com/\" class=\"uri\">https://icons.getbootstrap.com/</a> for a list of available\nicons"
14658
},
14659
"Text to display for item (defaults to the document title if not\nprovided)",
14660
"Alias for href",
14661
"Value for rel attribute. Multiple space-separated values are\npermitted. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel\" class=\"uri\">https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel</a>\nfor a details.",
14662
"Value for target attribute. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target\" class=\"uri\">https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target</a>\nfor details.",
14663
{
14664
"short": "The Github repo that will be used to store comments.",
14665
"long": "The Github repo that will be used to store comments.\nIn order to work correctly, the repo must be public, with the giscus\napp installed, and the discussions feature must be enabled."
14666
},
14667
{
14668
"short": "The Github repository identifier.",
14669
"long": "The Github repository identifier.\nYou can quickly find this by using the configuration tool at <a href=\"https://giscus.app\">https://giscus.app</a>. If this is not\nprovided, Quarto will attempt to discover it at render time."
14670
},
14671
{
14672
"short": "The discussion category where new discussions will be created.",
14673
"long": "The discussion category where new discussions will be created. It is\nrecommended to use a category with the <strong>Announcements</strong>\ntype so that new discussions can only be created by maintainers and\ngiscus."
14674
},
14675
{
14676
"short": "The Github category identifier.",
14677
"long": "The Github category identifier.\nYou can quickly find this by using the configuration tool at <a href=\"https://giscus.app\">https://giscus.app</a>. If this is not\nprovided, Quarto will attempt to discover it at render time."
14678
},
14679
{
14680
"short": "The mapping between the page and the embedded discussion.",
14681
"long": "The mapping between the page and the embedded discussion."
14682
},
14683
"Display reactions for the discussion’s main post before the\ncomments.",
14684
"Specify <code>loading: lazy</code> to defer loading comments until\nthe user scrolls near the comments container.",
14685
"Place the comment input box above or below the comments.",
14686
{
14687
"short": "The giscus theme to use when displaying comments.",
14688
"long": "The giscus theme to use when displaying comments. Light and dark\nthemes are supported. If a single theme is provided by name, it will be\nused as light and dark theme. To use different themes, use\n<code>light</code> and <code>dark</code> key:"
14689
},
14690
"The light theme name.",
14691
"The dark theme name.",
14692
"The language that should be used when displaying the commenting\ninterface.",
14693
"An execution engine not pre-loaded in Quarto",
14694
"Path to the TypeScript module for the execution engine",
14695
"The Github repo that will be used to store comments.",
14696
"The label that will be assigned to issues created by Utterances.",
14697
{
14698
"short": "The Github theme that should be used for Utterances.",
14699
"long": "The Github theme that should be used for Utterances\n(<code>github-light</code>, <code>github-dark</code>,\n<code>github-dark-orange</code>, <code>icy-dark</code>,\n<code>dark-blue</code>, <code>photon-dark</code>,\n<code>body-light</code>, or <code>gruvbox-dark</code>)"
14700
},
14701
{
14702
"short": "How posts should be mapped to Github issues",
14703
"long": "How posts should be mapped to Github issues (<code>pathname</code>,\n<code>url</code>, <code>title</code> or <code>og:title</code>)"
14704
},
14705
"Override the default hypothesis client url with a custom client\nurl.",
14706
"Controls whether the sidebar opens automatically on startup.",
14707
"Controls whether the in-document highlights are shown by default\n(<code>always</code>, <code>whenSidebarOpen</code> or\n<code>never</code>)",
14708
"Controls the overall look of the sidebar (<code>classic</code> or\n<code>clean</code>)",
14709
"Controls whether the experimental New Note button should be shown in\nthe notes tab in the sidebar.",
14710
"Specify a URL to direct a user to, in a new tab. when they click on\nthe annotation author link in the header of an annotation.",
14711
"Alternative annotation services which the client should connect to\ninstead of connecting to the public Hypothesis service at\nhypothes.is.",
14712
"The base URL of the service API.",
14713
"The domain name which the annotation service is associated with.",
14714
"An OAuth 2 grant token which the client can send to the service in\norder to get an access token for making authenticated requests to the\nservice.",
14715
"A flag indicating whether users should be able to leave groups of\nwhich they are a member.",
14716
"A flag indicating whether annotation cards should show links that\ntake the user to see an annotation in context.",
14717
"An array of Group IDs or the literal string\n<code>$rpc:requestGroups</code>",
14718
"The URL to an image for the annotation service. This image will\nappear to the left of the name of the currently selected group.",
14719
"Settings to adjust the commenting sidebar’s look and feel.",
14720
"Secondary color for elements of the commenting UI.",
14721
"The main background color of the commenting UI.",
14722
"The background color for call to action buttons.",
14723
"The font family for selection text in the annotation card.",
14724
"The font family for the actual annotation value that the user writes\nabout the page or selection.",
14725
"A CSS selector specifying the containing element into which the\nsidebar iframe will be placed.",
14726
"Defines a focused filter set for the available annotations on a\npage.",
14727
"The username of the user to focus on.",
14728
"The userid of the user to focus on.",
14729
"The display name of the user to focus on.",
14730
"Host url and port number of receiving iframe",
14731
"Number of nested iframes deep the client is relative from the\nreceiving iframe.",
14732
"The root URL from which assets are loaded.",
14733
"The URL for the sidebar application which displays annotations.",
14734
{
14735
"short": "The title of the page",
14736
"long": "The title of the page. Note that by default Quarto will automatically\nuse the title metadata from the page. Specify this field if you’d like\nto override the title for this provider."
14737
},
14738
{
14739
"short": "A short description of the content.",
14740
"long": "A short description of the content. Note that by default Quarto will\nautomatically use the description metadata from the page. Specify this\nfield if you’d like to override the description for this provider."
14741
},
14742
{
14743
"short": "The path to a preview image for the content.",
14744
"long": "The path to a preview image for the content. By default, Quarto will\nuse the <code>image</code> value from the format metadata. If you\nprovide an image, you may also optionally provide an\n<code>image-width</code> and <code>image-height</code>."
14745
},
14746
{
14747
"short": "The alt text for the preview image.",
14748
"long": "The alt text for the preview image. By default, Quarto will use the\n<code>image-alt</code> value from the format metadata. If you provide an\nimage, you may also optionally provide an <code>image-width</code> and\n<code>image-height</code>."
14749
},
14750
"Image width (pixels)",
14751
"Image height (pixels)",
14752
"Port to listen on (defaults to random value between 3000 and\n8000)",
14753
"Hostname to bind to (defaults to 127.0.0.1)",
14754
"Use an exernal application to preview the project.",
14755
"Open a web browser to view the preview (defaults to true)",
14756
"Re-render input files when they change (defaults to true)",
14757
"Navigate the browser automatically when outputs are updated (defaults\nto true)",
14758
"Time (in seconds) after which to exit if there are no active\nclients",
14759
"Serve project preview using the specified command. Interpolate the\n<code>--port</code> into the command using <code>{port}</code>.",
14760
"Additional command line arguments for preview command.",
14761
"Environment variables to set for preview command.",
14762
"Regular expression for detecting when the server is ready.",
14763
"Sites published from project",
14764
"Unique identifier for site",
14765
"Published URL for site",
14766
{
14767
"short": "The title of the page",
14768
"long": "The title of the page. Note that by default Quarto will automatically\nuse the title metadata from the page. Specify this field if you’d like\nto override the title for this provider."
14769
},
14770
{
14771
"short": "A short description of the content.",
14772
"long": "A short description of the content. Note that by default Quarto will\nautomatically use the description metadata from the page. Specify this\nfield if you’d like to override the description for this provider."
14773
},
14774
{
14775
"short": "The path to a preview image for the content.",
14776
"long": "The path to a preview image for the content. By default, Quarto will\nuse the <code>image</code> value from the format metadata. If you\nprovide an image, you may also optionally provide an\n<code>image-width</code> and <code>image-height</code>."
14777
},
14778
{
14779
"short": "The alt text for the preview image.",
14780
"long": "The alt text for the preview image. By default, Quarto will use the\n<code>image-alt</code> value from the format metadata. If you provide an\nimage, you may also optionally provide an <code>image-width</code> and\n<code>image-height</code>."
14781
},
14782
"Image width (pixels)",
14783
"Image height (pixels)",
14784
{
14785
"short": "Card style",
14786
"long": "Card style (<code>summary</code> or\n<code>summary_large_image</code>).\nIf this is not provided, the best style will automatically selected\nbased upon other metadata. You can learn more about Twitter Card styles\n<a href=\"https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards\">here</a>."
14787
},
14788
"<code>@username</code> of the content creator (must be a quoted\nstring)",
14789
"<code>@username</code> of the website (must be a quoted string)",
14790
{
14791
"short": "The title of the page",
14792
"long": "The title of the page. Note that by default Quarto will automatically\nuse the title metadata from the page. Specify this field if you’d like\nto override the title for this provider."
14793
},
14794
{
14795
"short": "A short description of the content.",
14796
"long": "A short description of the content. Note that by default Quarto will\nautomatically use the description metadata from the page. Specify this\nfield if you’d like to override the description for this provider."
14797
},
14798
{
14799
"short": "The path to a preview image for the content.",
14800
"long": "The path to a preview image for the content. By default, Quarto will\nuse the <code>image</code> value from the format metadata. If you\nprovide an image, you may also optionally provide an\n<code>image-width</code> and <code>image-height</code>."
14801
},
14802
{
14803
"short": "The alt text for the preview image.",
14804
"long": "The alt text for the preview image. By default, Quarto will use the\n<code>image-alt</code> value from the format metadata. If you provide an\nimage, you may also optionally provide an <code>image-width</code> and\n<code>image-height</code>."
14805
},
14806
"Image width (pixels)",
14807
"Image height (pixels)",
14808
"Locale of open graph metadata",
14809
{
14810
"short": "Name that should be displayed for the overall site",
14811
"long": "Name that should be displayed for the overall site. If not explicitly\nprovided in the <code>open-graph</code> metadata, Quarto will use the\nwebsite or book <code>title</code> by default."
14812
},
14813
"Footer left content",
14814
"Footer right content",
14815
"Footer center content",
14816
"Footer border (<code>true</code>, <code>false</code>, or a border\ncolor)",
14817
"Footer background color",
14818
"Footer foreground color",
14819
"Website title",
14820
"Website description",
14821
"The path to the favicon for this website",
14822
"Base URL for published website",
14823
"Path to site (defaults to <code>/</code>). Not required if you\nspecify <code>site-url</code>.",
14824
"Base URL for website source code repository",
14825
"The value of the target attribute for repo links",
14826
"The value of the rel attribute for repo links",
14827
"Subdirectory of repository containing website",
14828
"Branch of website source code (defaults to <code>main</code>)",
14829
"URL to use for the ‘report an issue’ repository action.",
14830
{
14831
"short": "Links to source repository actions",
14832
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
14833
},
14834
{
14835
"short": "Links to source repository actions",
14836
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
14837
},
14838
"Displays a ‘reader-mode’ tool which allows users to hide the sidebar\nand table of contents when viewing a page.",
14839
"Generate llms.txt and .llms.md files for LLM-friendly content\nconsumption.",
14840
"Enable Google Analytics for this website",
14841
"The Google tracking Id or measurement Id of this website.",
14842
{
14843
"short": "Storage options for Google Analytics data",
14844
"long": "Storage option for Google Analytics data using on of these two\nvalues:\n<code>cookies</code>: Use cookies to store unique user and session\nidentification (default).\n<code>none</code>: Do not use cookies to store unique user and\nsession identification.\nFor more about choosing storage options see <a href=\"https://quarto.org/docs/websites/website-tools.html#storage\">Storage</a>."
14845
},
14846
{
14847
"short": "Anonymize the user ip address.",
14848
"long": "Anonymize the user ip address. For more about this feature, see <a href=\"https://support.google.com/analytics/answer/2763052?hl=en\">IP\nAnonymization (or IP masking) in Google Analytics</a>."
14849
},
14850
{
14851
"short": "The version number of Google Analytics to use.",
14852
"long": "The version number of Google Analytics to use."
14853
},
14854
{
14855
"short": "Enable Plausible Analytics for this website by providing a script\nsnippet or path to snippet file",
14856
"long": "Enable Plausible Analytics for this website by pasting the script\nsnippet from your Plausible dashboard, or by providing a path to a file\ncontaining the snippet.\nPlausible is a privacy-friendly, GDPR-compliant web analytics service\nthat does not use cookies and does not require cookie consent.\n<strong>Option 1: Inline snippet</strong>"
14857
},
14858
"Path to a file containing the Plausible Analytics script snippet",
14859
"Provides an announcement displayed at the top of the page.",
14860
"The content of the announcement",
14861
"Whether this announcement may be dismissed by the user.",
14862
{
14863
"short": "The icon to display in the announcement",
14864
"long": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>twitter</code>, <code>share</code>) for the announcement. See <a href=\"https://icons.getbootstrap.com/\" class=\"uri\">https://icons.getbootstrap.com/</a> for a list of available\nicons"
14865
},
14866
{
14867
"short": "The position of the announcement.",
14868
"long": "The position of the announcement. One of <code>above-navbar</code>\n(default) or <code>below-navbar</code>."
14869
},
14870
{
14871
"short": "The type of announcement. Affects the appearance of the\nannouncement.",
14872
"long": "The type of announcement. One of <code>primary</code>,\n<code>secondary</code>, <code>success</code>, <code>danger</code>,\n<code>warning</code>, <code>info</code>, <code>light</code> or\n<code>dark</code>. Affects the appearance of the announcement."
14873
},
14874
{
14875
"short": "Request cookie consent before enabling scripts that set cookies",
14876
"long": "Quarto includes the ability to request cookie consent before enabling\nscripts that set cookies, using <a href=\"https://www.cookieconsent.com/\">Cookie Consent</a>.\nThe user’s cookie preferences will automatically control Google\nAnalytics (if enabled) and can be used to control custom scripts you add\nas well. For more information see <a href=\"https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent\">Custom\nScripts and Cookie Consent</a>."
14877
},
14878
{
14879
"short": "The type of consent that should be requested",
14880
"long": "The type of consent that should be requested, using one of these two\nvalues:"
14881
},
14882
{
14883
"short": "The style of the consent banner that is displayed",
14884
"long": "The style of the consent banner that is displayed:"
14885
},
14886
"Whether to use a dark or light appearance for the consent banner\n(<code>light</code> or <code>dark</code>).",
14887
"The url to the website’s cookie or privacy policy.",
14888
{
14889
"short": "The language to be used when diplaying the cookie consent prompt\n(defaults to document language).",
14890
"long": "The language to be used when diplaying the cookie consent prompt\nspecified using an IETF language tag.\nIf not specified, the document language will be used."
14891
},
14892
{
14893
"short": "The text to display for the cookie preferences link in the website\nfooter.",
14894
"long": ""
14895
},
14896
"Provide full text search for website",
14897
"Location for search widget (<code>navbar</code> or\n<code>sidebar</code>)",
14898
"Type of search UI (<code>overlay</code> or <code>textbox</code>)",
14899
"Number of matches to display (defaults to 20)",
14900
"Matches after which to collapse additional results",
14901
"Provide button for copying search link",
14902
"When false, do not merge navbar crumbs into the crumbs in\n<code>search.json</code>.",
14903
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
14904
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
14905
"Whether to include search result parents when displaying items in\nsearch results (when possible).",
14906
"Use external Algolia search index",
14907
"The name of the index to use when performing a search",
14908
"The unique ID used by Algolia to identify your application",
14909
"The Search-Only API key to use to connect to Algolia",
14910
"Enable tracking of Algolia analytics events",
14911
"Enable the display of the Algolia logo in the search results\nfooter.",
14912
"Field that contains the URL of index entries",
14913
"Field that contains the title of index entries",
14914
"Field that contains the text of index entries",
14915
"Field that contains the section of index entries",
14916
"Additional parameters to pass when executing a search",
14917
"Top navigation options",
14918
"The navbar title. Uses the project title if none is specified.",
14919
"Specification of image that will be displayed to the left of the\ntitle.",
14920
"Alternate text for the logo image.",
14921
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
14922
"The navbar’s background color (named or hex color).",
14923
"The navbar’s foreground color (named or hex color).",
14924
"Include a search box in the navbar.",
14925
"Always show the navbar (keeping it pinned).",
14926
"Collapse the navbar into a menu when the display becomes narrow.",
14927
"The responsive breakpoint below which the navbar will collapse into a\nmenu (<code>sm</code>, <code>md</code>, <code>lg</code> (default),\n<code>xl</code>, <code>xxl</code>).",
14928
"List of items for the left side of the navbar.",
14929
"List of items for the right side of the navbar.",
14930
"The position of the collapsed navbar toggle when in responsive\nmode",
14931
"Collapse tools into the navbar menu when the display becomes\nnarrow.",
14932
"Side navigation options",
14933
"The identifier for this sidebar.",
14934
"The sidebar title. Uses the project title if none is specified.",
14935
"Specification of image that will be displayed in the sidebar.",
14936
"Alternate text for the logo image.",
14937
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
14938
"Include a search control in the sidebar.",
14939
"List of sidebar tools",
14940
"List of items for the sidebar",
14941
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
14942
"The sidebar’s background color (named or hex color).",
14943
"The sidebar’s foreground color (named or hex color).",
14944
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
14945
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
14946
"The depth at which the sidebar contents should be collapsed by\ndefault.",
14947
"When collapsed, pin the collapsed sidebar to the top of the page.",
14948
"Markdown to place above sidebar content (text or file path)",
14949
"Markdown to place below sidebar content (text or file path)",
14950
"The identifier for this sidebar.",
14951
"The sidebar title. Uses the project title if none is specified.",
14952
"Specification of image that will be displayed in the sidebar.",
14953
"Alternate text for the logo image.",
14954
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
14955
"Include a search control in the sidebar.",
14956
"List of sidebar tools",
14957
"List of items for the sidebar",
14958
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
14959
"The sidebar’s background color (named or hex color).",
14960
"The sidebar’s foreground color (named or hex color).",
14961
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
14962
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
14963
"The depth at which the sidebar contents should be collapsed by\ndefault.",
14964
"When collapsed, pin the collapsed sidebar to the top of the page.",
14965
"Markdown to place above sidebar content (text or file path)",
14966
"Markdown to place below sidebar content (text or file path)",
14967
"Markdown to insert at the beginning of each page’s body (below the\ntitle and author block).",
14968
"Markdown to insert below each page’s body.",
14969
"Markdown to place above margin content (text or file path)",
14970
"Markdown to place below margin content (text or file path)",
14971
"Provide next and previous article links in footer",
14972
"Provide a ‘back to top’ navigation button",
14973
"Whether to show navigation breadcrumbs for pages more than 1 level\ndeep",
14974
"Shared page footer",
14975
"Default site thumbnail image for <code>twitter</code>\n/<code>open-graph</code>",
14976
"Default site thumbnail image alt text for <code>twitter</code>\n/<code>open-graph</code>",
14977
"Publish open graph metadata",
14978
"Publish twitter card metadata",
14979
"A list of other links to appear below the TOC.",
14980
"A list of code links to appear with this document.",
14981
"A list of input documents that should be treated as drafts",
14982
{
14983
"short": "How to handle drafts that are encountered.",
14984
"long": "How to handle drafts that are encountered.\n<code>visible</code> - the draft will visible and fully available\n<code>unlinked</code> - the draft will be rendered, but will not appear\nin navigation, search, or listings. <code>gone</code> - the draft will\nhave no content and will not be linked to (default)."
14985
},
14986
"Book title",
14987
"Description metadata for HTML version of book",
14988
"The path to the favicon for this website",
14989
"Base URL for published website",
14990
"Path to site (defaults to <code>/</code>). Not required if you\nspecify <code>site-url</code>.",
14991
"Base URL for website source code repository",
14992
"The value of the target attribute for repo links",
14993
"The value of the rel attribute for repo links",
14994
"Subdirectory of repository containing website",
14995
"Branch of website source code (defaults to <code>main</code>)",
14996
"URL to use for the ‘report an issue’ repository action.",
14997
{
14998
"short": "Links to source repository actions",
14999
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
15000
},
15001
{
15002
"short": "Links to source repository actions",
15003
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
15004
},
15005
"Displays a ‘reader-mode’ tool which allows users to hide the sidebar\nand table of contents when viewing a page.",
15006
"Generate llms.txt and .llms.md files for LLM-friendly content\nconsumption.",
15007
"Enable Google Analytics for this website",
15008
"The Google tracking Id or measurement Id of this website.",
15009
{
15010
"short": "Storage options for Google Analytics data",
15011
"long": "Storage option for Google Analytics data using on of these two\nvalues:\n<code>cookies</code>: Use cookies to store unique user and session\nidentification (default).\n<code>none</code>: Do not use cookies to store unique user and\nsession identification.\nFor more about choosing storage options see <a href=\"https://quarto.org/docs/websites/website-tools.html#storage\">Storage</a>."
15012
},
15013
{
15014
"short": "Anonymize the user ip address.",
15015
"long": "Anonymize the user ip address. For more about this feature, see <a href=\"https://support.google.com/analytics/answer/2763052?hl=en\">IP\nAnonymization (or IP masking) in Google Analytics</a>."
15016
},
15017
{
15018
"short": "The version number of Google Analytics to use.",
15019
"long": "The version number of Google Analytics to use."
15020
},
15021
{
15022
"short": "Enable Plausible Analytics for this website by providing a script\nsnippet or path to snippet file",
15023
"long": "Enable Plausible Analytics for this website by pasting the script\nsnippet from your Plausible dashboard, or by providing a path to a file\ncontaining the snippet.\nPlausible is a privacy-friendly, GDPR-compliant web analytics service\nthat does not use cookies and does not require cookie consent.\n<strong>Option 1: Inline snippet</strong>"
15024
},
15025
"Path to a file containing the Plausible Analytics script snippet",
15026
"Provides an announcement displayed at the top of the page.",
15027
"The content of the announcement",
15028
"Whether this announcement may be dismissed by the user.",
15029
{
15030
"short": "The icon to display in the announcement",
15031
"long": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>twitter</code>, <code>share</code>) for the announcement. See <a href=\"https://icons.getbootstrap.com/\" class=\"uri\">https://icons.getbootstrap.com/</a> for a list of available\nicons"
15032
},
15033
{
15034
"short": "The position of the announcement.",
15035
"long": "The position of the announcement. One of <code>above-navbar</code>\n(default) or <code>below-navbar</code>."
15036
},
15037
{
15038
"short": "The type of announcement. Affects the appearance of the\nannouncement.",
15039
"long": "The type of announcement. One of <code>primary</code>,\n<code>secondary</code>, <code>success</code>, <code>danger</code>,\n<code>warning</code>, <code>info</code>, <code>light</code> or\n<code>dark</code>. Affects the appearance of the announcement."
15040
},
15041
{
15042
"short": "Request cookie consent before enabling scripts that set cookies",
15043
"long": "Quarto includes the ability to request cookie consent before enabling\nscripts that set cookies, using <a href=\"https://www.cookieconsent.com/\">Cookie Consent</a>.\nThe user’s cookie preferences will automatically control Google\nAnalytics (if enabled) and can be used to control custom scripts you add\nas well. For more information see <a href=\"https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent\">Custom\nScripts and Cookie Consent</a>."
15044
},
15045
{
15046
"short": "The type of consent that should be requested",
15047
"long": "The type of consent that should be requested, using one of these two\nvalues:"
15048
},
15049
{
15050
"short": "The style of the consent banner that is displayed",
15051
"long": "The style of the consent banner that is displayed:"
15052
},
15053
"Whether to use a dark or light appearance for the consent banner\n(<code>light</code> or <code>dark</code>).",
15054
"The url to the website’s cookie or privacy policy.",
15055
{
15056
"short": "The language to be used when diplaying the cookie consent prompt\n(defaults to document language).",
15057
"long": "The language to be used when diplaying the cookie consent prompt\nspecified using an IETF language tag.\nIf not specified, the document language will be used."
15058
},
15059
{
15060
"short": "The text to display for the cookie preferences link in the website\nfooter.",
15061
"long": ""
15062
},
15063
"Provide full text search for website",
15064
"Location for search widget (<code>navbar</code> or\n<code>sidebar</code>)",
15065
"Type of search UI (<code>overlay</code> or <code>textbox</code>)",
15066
"Number of matches to display (defaults to 20)",
15067
"Matches after which to collapse additional results",
15068
"Provide button for copying search link",
15069
"When false, do not merge navbar crumbs into the crumbs in\n<code>search.json</code>.",
15070
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
15071
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
15072
"Whether to include search result parents when displaying items in\nsearch results (when possible).",
15073
"Use external Algolia search index",
15074
"The name of the index to use when performing a search",
15075
"The unique ID used by Algolia to identify your application",
15076
"The Search-Only API key to use to connect to Algolia",
15077
"Enable tracking of Algolia analytics events",
15078
"Enable the display of the Algolia logo in the search results\nfooter.",
15079
"Field that contains the URL of index entries",
15080
"Field that contains the title of index entries",
15081
"Field that contains the text of index entries",
15082
"Field that contains the section of index entries",
15083
"Additional parameters to pass when executing a search",
15084
"Top navigation options",
15085
"The navbar title. Uses the project title if none is specified.",
15086
"Specification of image that will be displayed to the left of the\ntitle.",
15087
"Alternate text for the logo image.",
15088
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
15089
"The navbar’s background color (named or hex color).",
15090
"The navbar’s foreground color (named or hex color).",
15091
"Include a search box in the navbar.",
15092
"Always show the navbar (keeping it pinned).",
15093
"Collapse the navbar into a menu when the display becomes narrow.",
15094
"The responsive breakpoint below which the navbar will collapse into a\nmenu (<code>sm</code>, <code>md</code>, <code>lg</code> (default),\n<code>xl</code>, <code>xxl</code>).",
15095
"List of items for the left side of the navbar.",
15096
"List of items for the right side of the navbar.",
15097
"The position of the collapsed navbar toggle when in responsive\nmode",
15098
"Collapse tools into the navbar menu when the display becomes\nnarrow.",
15099
"Side navigation options",
15100
"The identifier for this sidebar.",
15101
"The sidebar title. Uses the project title if none is specified.",
15102
"Specification of image that will be displayed in the sidebar.",
15103
"Alternate text for the logo image.",
15104
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
15105
"Include a search control in the sidebar.",
15106
"List of sidebar tools",
15107
"List of items for the sidebar",
15108
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
15109
"The sidebar’s background color (named or hex color).",
15110
"The sidebar’s foreground color (named or hex color).",
15111
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
15112
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
15113
"The depth at which the sidebar contents should be collapsed by\ndefault.",
15114
"When collapsed, pin the collapsed sidebar to the top of the page.",
15115
"Markdown to place above sidebar content (text or file path)",
15116
"Markdown to place below sidebar content (text or file path)",
15117
"The identifier for this sidebar.",
15118
"The sidebar title. Uses the project title if none is specified.",
15119
"Specification of image that will be displayed in the sidebar.",
15120
"Alternate text for the logo image.",
15121
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
15122
"Include a search control in the sidebar.",
15123
"List of sidebar tools",
15124
"List of items for the sidebar",
15125
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
15126
"The sidebar’s background color (named or hex color).",
15127
"The sidebar’s foreground color (named or hex color).",
15128
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
15129
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
15130
"The depth at which the sidebar contents should be collapsed by\ndefault.",
15131
"When collapsed, pin the collapsed sidebar to the top of the page.",
15132
"Markdown to place above sidebar content (text or file path)",
15133
"Markdown to place below sidebar content (text or file path)",
15134
"Markdown to insert at the beginning of each page’s body (below the\ntitle and author block).",
15135
"Markdown to insert below each page’s body.",
15136
"Markdown to place above margin content (text or file path)",
15137
"Markdown to place below margin content (text or file path)",
15138
"Provide next and previous article links in footer",
15139
"Provide a ‘back to top’ navigation button",
15140
"Whether to show navigation breadcrumbs for pages more than 1 level\ndeep",
15141
"Shared page footer",
15142
"Default site thumbnail image for <code>twitter</code>\n/<code>open-graph</code>",
15143
"Default site thumbnail image alt text for <code>twitter</code>\n/<code>open-graph</code>",
15144
"Publish open graph metadata",
15145
"Publish twitter card metadata",
15146
"A list of other links to appear below the TOC.",
15147
"A list of code links to appear with this document.",
15148
"A list of input documents that should be treated as drafts",
15149
{
15150
"short": "How to handle drafts that are encountered.",
15151
"long": "How to handle drafts that are encountered.\n<code>visible</code> - the draft will visible and fully available\n<code>unlinked</code> - the draft will be rendered, but will not appear\nin navigation, search, or listings. <code>gone</code> - the draft will\nhave no content and will not be linked to (default)."
15152
},
15153
"Book subtitle",
15154
"Author or authors of the book",
15155
"Author or authors of the book",
15156
"Book publication date",
15157
"Format string for dates in the book",
15158
"Book abstract",
15159
"Book part and chapter files",
15160
"Book appendix files",
15161
"Book references file",
15162
"Base name for single-file output (e.g.&nbsp;PDF, ePub, docx)",
15163
"Cover image (used in HTML and ePub formats)",
15164
"Alternative text for cover image (used in HTML format)",
15165
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
15166
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
15167
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
15168
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
15169
"Custom tools for navbar or sidebar",
15170
"The Digital Object Identifier for this book.",
15171
"Part title or path to input file",
15172
"Path to chapter input file",
15173
"The text for the link.",
15174
"The href for the link.",
15175
"The bootstrap icon name for the link.",
15176
"The rel attribute value for the link.",
15177
"The target attribute value for the link.",
15178
{
15179
"short": "The role of this creator or contributor.",
15180
"long": "The role of this creator or contributor using <a href=\"https://loc.gov/marc/relators/relaterm.html\">MARC relators</a>.\nHuman readable translations to commonly used relators (e.g.&nbsp;‘author’,\n‘editor’) will attempt to be automatically translated."
15181
},
15182
"An alternate version of the creator or contributor text used for\nalphabatizing.",
15183
"The text describing the creator or contributor (for example, creator\nname).",
15184
{
15185
"short": "The role of this creator or contributor.",
15186
"long": "The role of this creator or contributor using <a href=\"https://loc.gov/marc/relators/relaterm.html\">MARC relators</a>.\nHuman readable translations to commonly used relators (e.g.&nbsp;‘author’,\n‘editor’) will attempt to be automatically translated."
15187
},
15188
"An alternate version of the creator or contributor text used for\nalphabatizing.",
15189
"The text describing the creator or contributor (for example, creator\nname).",
15190
{
15191
"short": "The target id for the about page.",
15192
"long": "The target id of this about page. When the about page is rendered, it\nwill place read the contents of a <code>div</code> with this id into the\nabout template that you have selected (and replace the contents with the\nrendered about content).\nIf no such <code>div</code> is defined on the page, a\n<code>div</code> with this id will be created and appended to the end of\nthe page."
15193
},
15194
{
15195
"short": "The template to use to layout this about page.",
15196
"long": "The template to use to layout this about page. Choose from:"
15197
},
15198
{
15199
"short": "The path to the main image on the about page.",
15200
"long": "The path to the main image on the about page. If not specified, the\n<code>image</code> provided for the document itself will be used."
15201
},
15202
"The alt text for the main image on the about page.",
15203
"The title for the main image on the about page.",
15204
{
15205
"short": "A valid CSS width for the about page image.",
15206
"long": "A valid CSS width for the about page image."
15207
},
15208
{
15209
"short": "The shape of the image on the about page.",
15210
"long": "The shape of the image on the about page."
15211
},
15212
{
15213
"short": "The id of this listing.",
15214
"long": "The id of this listing. When the listing is rendered, it will place\nthe contents into a <code>div</code> with this id. If no such\n<code>div</code> is defined on the page, a <code>div</code> with this id\nwill be created and appended to the end of the page.\nIf no <code>id</code> is provided for a listing, Quarto will\nsynthesize one when rendering the page."
15215
},
15216
{
15217
"short": "The type of listing to create.",
15218
"long": "The type of listing to create. Choose one of:"
15219
},
15220
"The files or path globs of Quarto documents or YAML files that should\nbe included in the listing.",
15221
{
15222
"short": "Sort items in the listing by these fields.",
15223
"long": "Sort items in the listing by these fields. The sort key is made up of\na field name followed by a direction <code>asc</code> or\n<code>desc</code>.\nFor example: <code>date asc</code>\nUse <code>sort:false</code> to use the unsorted original order of\nitems."
15224
},
15225
"The maximum number of items to include in this listing.",
15226
"The number of items to display on a page.",
15227
{
15228
"short": "Shows or hides the sorting control for the listing.",
15229
"long": "Shows or hides the sorting control for the listing. To control the\nfields that will be displayed in the sorting control, provide a list of\nfield names."
15230
},
15231
{
15232
"short": "Shows or hides the filtering control for the listing.",
15233
"long": "Shows or hides the filtering control for the listing. To control the\nfields that will be used to filter the listing, provide a list of field\nnames. By default all fields of the listing will be used when\nfiltering."
15234
},
15235
{
15236
"short": "Display item categories from this listing in the margin of the\npage.",
15237
"long": "Display item categories from this listing in the margin of the\npage."
15238
},
15239
"Enables an RSS feed for the listing.",
15240
"The number of items to include in your feed. Defaults to 20.",
15241
{
15242
"short": "Whether to include full or partial content in the feed.",
15243
"long": "Whether to include full or partial content in the feed."
15244
},
15245
{
15246
"short": "The title for this feed.",
15247
"long": "The title for this feed. Defaults to the site title provided the\nQuarto project."
15248
},
15249
{
15250
"short": "The path to an image for this feed.",
15251
"long": "The path to an image for this feed. If not specified, the image for\nthe page the listing appears on will be used, otherwise an image will be\nused if specified for the site in the Quarto project."
15252
},
15253
{
15254
"short": "The description of this feed.",
15255
"long": "The description of this feed. If not specified, the description for\nthe page the listing appears on will be used, otherwise the description\nof the site will be used if specified in the Quarto project."
15256
},
15257
{
15258
"short": "The language of the feed.",
15259
"long": "The language of the feed. Omitted if not specified. See <a href=\"https://www.rssboard.org/rss-language-codes\">https://www.rssboard.org/rss-language-codes</a>\nfor a list of valid language codes."
15260
},
15261
"A list of categories for which to create separate RSS feeds\ncontaining only posts with that category",
15262
"A list of categories for which to create separate RSS feeds\ncontaining only posts with that category",
15263
"The path to an XML stylesheet (XSL file) used to style the RSS\nfeed.",
15264
{
15265
"short": "The date format to use when displaying dates (e.g.&nbsp;d-M-yyy).",
15266
"long": "The date format to use when displaying dates (e.g.&nbsp;d-M-yyy). Learn\nmore about supported date formatting values <a href=\"https://quarto.org/docs/reference/dates.html\">here</a>."
15267
},
15268
{
15269
"short": "The maximum length (in characters) of the description displayed in\nthe listing.",
15270
"long": "The maximum length (in characters) of the description displayed in\nthe listing. Defaults to 175."
15271
},
15272
"The default image to use if an item in the listing doesn’t have an\nimage.",
15273
"If false, images in the listing will be loaded immediately. If true,\nimages will be loaded as they come into view.",
15274
"In <code>default</code> type listings, whether to place the image on\nthe right or left side of the post content (<code>left</code> or\n<code>right</code>).",
15275
{
15276
"short": "The height of the image being displayed.",
15277
"long": "The height of the image being displayed (a CSS height string).\nThe width is automatically determined and the image will fill the\nrectangle without scaling (cropped to fill)."
15278
},
15279
{
15280
"short": "In <code>grid</code> type listings, the number of columns in the grid\ndisplay.",
15281
"long": "In grid type listings, the number of columns in the grid display.\nDefaults to 3."
15282
},
15283
{
15284
"short": "In <code>grid</code> type listings, whether to display a border\naround the item card.",
15285
"long": "In grid type listings, whether to display a border around the item\ncard. Defaults to <code>true</code>."
15286
},
15287
{
15288
"short": "In <code>grid</code> type listings, the alignment of the content\nwithin the card.",
15289
"long": "In grid type listings, the alignment of the content within the card\n(<code>left</code> (default), <code>right</code>, or\n<code>center</code>)."
15290
},
15291
{
15292
"short": "In <code>table</code> type listings, display the table rows with\nalternating background colors.",
15293
"long": "In table type listings, display the table rows with alternating\nbackground colors. Defaults to <code>false</code>."
15294
},
15295
{
15296
"short": "In <code>table</code> type listings, highlight rows of the table when\nthe user hovers the mouse over them.",
15297
"long": "In table type listings, highlight rows of the table when the user\nhovers the mouse over them. Defaults to false."
15298
},
15299
{
15300
"short": "The path to a custom listing template.",
15301
"long": "The path to a custom listing template."
15302
},
15303
"Parameters that are passed to the custom template.",
15304
{
15305
"short": "The list of fields to include in this listing",
15306
"long": "The list of fields to include in this listing."
15307
},
15308
{
15309
"short": "A mapping of display names for listing fields.",
15310
"long": "A mapping that provides display names for specific fields. For\nexample, to display the title column as ‘Report’ in a table listing you\nwould write:"
15311
},
15312
{
15313
"short": "Provides the date type for the field of a listing item.",
15314
"long": "Provides the date type for the field of a listing item. Unknown\nfields are treated as strings unless a type is provided. Valid types are\n<code>date</code>, <code>number</code>."
15315
},
15316
{
15317
"short": "This list of fields to display as links in a table listing.",
15318
"long": "The list of fields to display as hyperlinks to the source document\nwhen the listing type is a table. By default, only the\n<code>title</code> or <code>filename</code> is displayed as a link."
15319
},
15320
{
15321
"short": "Fields that items in this listing must have populated.",
15322
"long": "Fields that items in this listing must have populated. If a listing\nis rendered and one more items in this listing is missing a required\nfield, an error will occur and the render will."
15323
},
15324
"Items with matching field values will be included in the listing.",
15325
"Items with matching field values will be excluded from the\nlisting.",
15326
"The year",
15327
"The month",
15328
"The day",
15329
"The family name.",
15330
"The given name.",
15331
"The family name.",
15332
"The given name.",
15333
"A url to the abstract for this item.",
15334
"Date the item has been accessed.",
15335
{
15336
"short": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review).",
15337
"long": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use\n<code>note</code> instead"
15338
},
15339
"Archive storing the item",
15340
"Collection the item is part of within an archive.",
15341
"Storage location within an archive (e.g.&nbsp;a box and folder\nnumber).",
15342
"Geographic location of the archive.",
15343
"Issuing or judicial authority (e.g.&nbsp;“USPTO” for a patent, “Fairfax\nCircuit Court” for a legal case).",
15344
{
15345
"short": "Date the item was initially available",
15346
"long": "Date the item was initially available (e.g.&nbsp;the online publication\ndate of a journal article before its formal publication date; the date a\ntreaty was made available for signing)."
15347
},
15348
"Call number (to locate the item in a library).",
15349
"The person leading the session containing a presentation (e.g.&nbsp;the\norganizer of the <code>container-title</code> of a\n<code>speech</code>).",
15350
"Chapter number (e.g.&nbsp;chapter number in a book; track number on an\nalbum).",
15351
{
15352
"short": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey).",
15353
"long": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey);\nUse this variable to facilitate conversion between word-processor and\nplain-text writing systems; For an identifer intended as formatted\noutput label for a citation (e.g.&nbsp;“Ferr78”), use\n<code>citation-label</code> instead"
15354
},
15355
{
15356
"short": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”).",
15357
"long": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the\nidentifier of the item in the input data file, use\n<code>citation-key</code> instead"
15358
},
15359
"Index (starting at 1) of the cited reference in the bibliography\n(generated by the CSL processor).",
15360
"Editor of the collection holding the item (e.g.&nbsp;the series editor for\na book).",
15361
"Number identifying the collection holding the item (e.g.&nbsp;the series\nnumber for a book)",
15362
"Title of the collection holding the item (e.g.&nbsp;the series title for a\nbook; the lecture series title for a presentation).",
15363
"Person compiling or selecting material for an item from the works of\nvarious persons or bodies (e.g.&nbsp;for an anthology).",
15364
"Composer (e.g.&nbsp;of a musical score).",
15365
"Author of the container holding the item (e.g.&nbsp;the book author for a\nbook chapter).",
15366
{
15367
"short": "Title of the container holding the item.",
15368
"long": "Title of the container holding the item (e.g.&nbsp;the book title for a\nbook chapter, the journal title for a journal article; the album title\nfor a recording; the session title for multi-part presentation at a\nconference)"
15369
},
15370
"Short/abbreviated form of container-title;",
15371
"A minor contributor to the item; typically cited using “with” before\nthe name when listed in a bibliography.",
15372
"Curator of an exhibit or collection (e.g.&nbsp;in a museum).",
15373
"Physical (e.g.&nbsp;size) or temporal (e.g.&nbsp;running time) dimensions of\nthe item.",
15374
"Director (e.g.&nbsp;of a film).",
15375
"Minor subdivision of a court with a <code>jurisdiction</code> for a\nlegal item",
15376
"(Container) edition holding the item (e.g.&nbsp;“3” when citing a chapter\nin the third edition of a book).",
15377
"The editor of the item.",
15378
"Managing editor (“Directeur de la Publication” in French).",
15379
{
15380
"short": "Combined editor and translator of a work.",
15381
"long": "Combined editor and translator of a work.\nThe citation processory must be automatically generate if editor and\ntranslator variables are identical; May also be provided directly in\nitem data."
15382
},
15383
"Date the event related to an item took place.",
15384
"Name of the event related to the item (e.g.&nbsp;the conference name when\nciting a conference paper; the meeting where presentation was made).",
15385
"Geographic location of the event related to the item\n(e.g.&nbsp;“Amsterdam, The Netherlands”).",
15386
"Executive producer of the item (e.g.&nbsp;of a television series).",
15387
{
15388
"short": "Number of a preceding note containing the first reference to the\nitem.",
15389
"long": "Number of a preceding note containing the first reference to the\nitem\nAssigned by the CSL processor; Empty in non-note-based styles or when\nthe item hasn’t been cited in any preceding notes in a document"
15390
},
15391
"A url to the full text for this item.",
15392
{
15393
"short": "Type, class, or subtype of the item",
15394
"long": "Type, class, or subtype of the item (e.g.&nbsp;“Doctoral dissertation” for\na PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g.&nbsp;“adventure”\nfor an adventure movie)"
15395
},
15396
"Guest (e.g.&nbsp;on a TV show or podcast).",
15397
"Host of the item (e.g.&nbsp;of a TV show or podcast).",
15398
"A value which uniquely identifies this item.",
15399
"Illustrator (e.g.&nbsp;of a children’s book or graphic novel).",
15400
"Interviewer (e.g.&nbsp;of an interview).",
15401
"International Standard Book Number (e.g.&nbsp;“978-3-8474-1017-1”).",
15402
"International Standard Serial Number.",
15403
{
15404
"short": "Issue number of the item or container holding the item",
15405
"long": "Issue number of the item or container holding the item (e.g.&nbsp;“5” when\nciting a journal article from journal volume 2, issue 5);\nUse <code>volume-title</code> for the title of the issue, if any."
15406
},
15407
"Date the item was issued/published.",
15408
"Geographic scope of relevance (e.g.&nbsp;“US” for a US patent; the court\nhearing a legal case).",
15409
"Keyword(s) or tag(s) attached to the item.",
15410
{
15411
"short": "The language of the item (used only for citation of the item).",
15412
"long": "The language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code\n(e.g.&nbsp;“en”, “zh”), optionally with a two-letter locale code\n(e.g.&nbsp;“de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents\nwhat language the item uses (which may be used in citing the item)."
15413
},
15414
{
15415
"short": "The license information applicable to an item.",
15416
"long": "The license information applicable to an item (e.g.&nbsp;the license an\narticle or software is released under; the copyright information for an\nitem; the classification status of a document)"
15417
},
15418
{
15419
"short": "A cite-specific pinpointer within the item.",
15420
"long": "A cite-specific pinpointer within the item (e.g.&nbsp;a page number within\na book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the\nlocator type (see the Locators term list)."
15421
},
15422
"Description of the item’s format or medium (e.g.&nbsp;“CD”, “DVD”,\n“Album”, etc.)",
15423
"Narrator (e.g.&nbsp;of an audio book).",
15424
"Descriptive text or notes about an item (e.g.&nbsp;in an annotated\nbibliography).",
15425
"Number identifying the item (e.g.&nbsp;a report number).",
15426
"Total number of pages of the cited item.",
15427
"Total number of volumes, used when citing multi-volume books and\nsuch.",
15428
"Organizer of an event (e.g.&nbsp;organizer of a workshop or\nconference).",
15429
{
15430
"short": "The original creator of a work.",
15431
"long": "The original creator of a work (e.g.&nbsp;the form of the author name\nlisted on the original version of a book; the historical author of a\nwork; the original songwriter or performer for a musical piece; the\noriginal developer or programmer for a piece of software; the original\nauthor of an adapted work such as a book adapted into a screenplay)"
15432
},
15433
"Issue date of the original version.",
15434
"Original publisher, for items that have been republished by a\ndifferent publisher.",
15435
"Geographic location of the original publisher (e.g.&nbsp;“London,\nUK”).",
15436
"Title of the original version (e.g.&nbsp;“Война и мир”, the untranslated\nRussian title of “War and Peace”).",
15437
"Range of pages the item (e.g.&nbsp;a journal article) covers in a\ncontainer (e.g.&nbsp;a journal issue).",
15438
"First page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15439
"Last page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15440
{
15441
"short": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).",
15442
"long": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).\nUse <code>part-title</code> for the title of the part, if any."
15443
},
15444
"Title of the specific part of an item being cited.",
15445
"A url to the pdf for this item.",
15446
"Performer of an item (e.g.&nbsp;an actor appearing in a film; a muscian\nperforming a piece of music).",
15447
"PubMed Central reference number.",
15448
"PubMed reference number.",
15449
"Printing number of the item or container holding the item.",
15450
"Producer (e.g.&nbsp;of a television or radio broadcast).",
15451
"A public url for this item.",
15452
"The publisher of the item.",
15453
"The geographic location of the publisher.",
15454
"Recipient (e.g.&nbsp;of a letter).",
15455
"Author of the item reviewed by the current item.",
15456
"Type of the item being reviewed by the current item (e.g.&nbsp;book,\nfilm).",
15457
"Title of the item reviewed by the current item.",
15458
"Scale of e.g.&nbsp;a map or model.",
15459
"Writer of a script or screenplay (e.g.&nbsp;of a film).",
15460
"Section of the item or container holding the item (e.g.&nbsp;“§2.0.1” for\na law; “politics” for a newspaper article).",
15461
"Creator of a series (e.g.&nbsp;of a television series).",
15462
"Source from whence the item originates (e.g.&nbsp;a library catalog or\ndatabase).",
15463
"Publication status of the item (e.g.&nbsp;“forthcoming”; “in press”;\n“advance online publication”; “retracted”)",
15464
"Date the item (e.g.&nbsp;a manuscript) was submitted for publication.",
15465
"Supplement number of the item or container holding the item (e.g.&nbsp;for\nsecondary legal items that are regularly updated between editions).",
15466
"Short/abbreviated form of<code>title</code>.",
15467
"Translator",
15468
"The <a href=\"https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types\">type</a>\nof the item.",
15469
"Uniform Resource Locator\n(e.g.&nbsp;“https://aem.asm.org/cgi/content/full/74/9/2766”)",
15470
"Version of the item (e.g.&nbsp;“2.0.9” for a software program).",
15471
{
15472
"short": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item.",
15473
"long": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item (e.g.&nbsp;“2” when citing a chapter from\nvolume 2 of a book).\nUse <code>volume-title</code> for the title of the volume, if\nany."
15474
},
15475
{
15476
"short": "Title of the volume of the item or container holding the item.",
15477
"long": "Title of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections,\nand the like."
15478
},
15479
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
15480
"A url to the abstract for this item.",
15481
"Date the item has been accessed.",
15482
{
15483
"short": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review).",
15484
"long": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use\n<code>note</code> instead"
15485
},
15486
"Archive storing the item",
15487
"Collection the item is part of within an archive.",
15488
"Storage location within an archive (e.g.&nbsp;a box and folder\nnumber).",
15489
"Geographic location of the archive.",
15490
"Issuing or judicial authority (e.g.&nbsp;“USPTO” for a patent, “Fairfax\nCircuit Court” for a legal case).",
15491
{
15492
"short": "Date the item was initially available",
15493
"long": "Date the item was initially available (e.g.&nbsp;the online publication\ndate of a journal article before its formal publication date; the date a\ntreaty was made available for signing)."
15494
},
15495
"Call number (to locate the item in a library).",
15496
"The person leading the session containing a presentation (e.g.&nbsp;the\norganizer of the <code>container-title</code> of a\n<code>speech</code>).",
15497
"Chapter number (e.g.&nbsp;chapter number in a book; track number on an\nalbum).",
15498
{
15499
"short": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey).",
15500
"long": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey);\nUse this variable to facilitate conversion between word-processor and\nplain-text writing systems; For an identifer intended as formatted\noutput label for a citation (e.g.&nbsp;“Ferr78”), use\n<code>citation-label</code> instead"
15501
},
15502
{
15503
"short": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”).",
15504
"long": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the\nidentifier of the item in the input data file, use\n<code>citation-key</code> instead"
15505
},
15506
"Index (starting at 1) of the cited reference in the bibliography\n(generated by the CSL processor).",
15507
"Editor of the collection holding the item (e.g.&nbsp;the series editor for\na book).",
15508
"Number identifying the collection holding the item (e.g.&nbsp;the series\nnumber for a book)",
15509
"Title of the collection holding the item (e.g.&nbsp;the series title for a\nbook; the lecture series title for a presentation).",
15510
"Person compiling or selecting material for an item from the works of\nvarious persons or bodies (e.g.&nbsp;for an anthology).",
15511
"Composer (e.g.&nbsp;of a musical score).",
15512
"Author of the container holding the item (e.g.&nbsp;the book author for a\nbook chapter).",
15513
{
15514
"short": "Title of the container holding the item.",
15515
"long": "Title of the container holding the item (e.g.&nbsp;the book title for a\nbook chapter, the journal title for a journal article; the album title\nfor a recording; the session title for multi-part presentation at a\nconference)"
15516
},
15517
"Short/abbreviated form of container-title;",
15518
"A minor contributor to the item; typically cited using “with” before\nthe name when listed in a bibliography.",
15519
"Curator of an exhibit or collection (e.g.&nbsp;in a museum).",
15520
"Physical (e.g.&nbsp;size) or temporal (e.g.&nbsp;running time) dimensions of\nthe item.",
15521
"Director (e.g.&nbsp;of a film).",
15522
"Minor subdivision of a court with a <code>jurisdiction</code> for a\nlegal item",
15523
"(Container) edition holding the item (e.g.&nbsp;“3” when citing a chapter\nin the third edition of a book).",
15524
"The editor of the item.",
15525
"Managing editor (“Directeur de la Publication” in French).",
15526
{
15527
"short": "Combined editor and translator of a work.",
15528
"long": "Combined editor and translator of a work.\nThe citation processory must be automatically generate if editor and\ntranslator variables are identical; May also be provided directly in\nitem data."
15529
},
15530
"Date the event related to an item took place.",
15531
"Name of the event related to the item (e.g.&nbsp;the conference name when\nciting a conference paper; the meeting where presentation was made).",
15532
"Geographic location of the event related to the item\n(e.g.&nbsp;“Amsterdam, The Netherlands”).",
15533
"Executive producer of the item (e.g.&nbsp;of a television series).",
15534
{
15535
"short": "Number of a preceding note containing the first reference to the\nitem.",
15536
"long": "Number of a preceding note containing the first reference to the\nitem\nAssigned by the CSL processor; Empty in non-note-based styles or when\nthe item hasn’t been cited in any preceding notes in a document"
15537
},
15538
"A url to the full text for this item.",
15539
{
15540
"short": "Type, class, or subtype of the item",
15541
"long": "Type, class, or subtype of the item (e.g.&nbsp;“Doctoral dissertation” for\na PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g.&nbsp;“adventure”\nfor an adventure movie)"
15542
},
15543
"Guest (e.g.&nbsp;on a TV show or podcast).",
15544
"Host of the item (e.g.&nbsp;of a TV show or podcast).",
15545
"Citation identifier for the item (e.g.&nbsp;“item1”). Will be\nautogenerated if not provided.",
15546
"Illustrator (e.g.&nbsp;of a children’s book or graphic novel).",
15547
"Interviewer (e.g.&nbsp;of an interview).",
15548
"International Standard Book Number (e.g.&nbsp;“978-3-8474-1017-1”).",
15549
"International Standard Serial Number.",
15550
{
15551
"short": "Issue number of the item or container holding the item",
15552
"long": "Issue number of the item or container holding the item (e.g.&nbsp;“5” when\nciting a journal article from journal volume 2, issue 5);\nUse <code>volume-title</code> for the title of the issue, if any."
15553
},
15554
"Date the item was issued/published.",
15555
"Geographic scope of relevance (e.g.&nbsp;“US” for a US patent; the court\nhearing a legal case).",
15556
"Keyword(s) or tag(s) attached to the item.",
15557
{
15558
"short": "The language of the item (used only for citation of the item).",
15559
"long": "The language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code\n(e.g.&nbsp;“en”, “zh”), optionally with a two-letter locale code\n(e.g.&nbsp;“de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents\nwhat language the item uses (which may be used in citing the item)."
15560
},
15561
{
15562
"short": "The license information applicable to an item.",
15563
"long": "The license information applicable to an item (e.g.&nbsp;the license an\narticle or software is released under; the copyright information for an\nitem; the classification status of a document)"
15564
},
15565
{
15566
"short": "A cite-specific pinpointer within the item.",
15567
"long": "A cite-specific pinpointer within the item (e.g.&nbsp;a page number within\na book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the\nlocator type (see the Locators term list)."
15568
},
15569
"Description of the item’s format or medium (e.g.&nbsp;“CD”, “DVD”,\n“Album”, etc.)",
15570
"Narrator (e.g.&nbsp;of an audio book).",
15571
"Descriptive text or notes about an item (e.g.&nbsp;in an annotated\nbibliography).",
15572
"Number identifying the item (e.g.&nbsp;a report number).",
15573
"Total number of pages of the cited item.",
15574
"Total number of volumes, used when citing multi-volume books and\nsuch.",
15575
"Organizer of an event (e.g.&nbsp;organizer of a workshop or\nconference).",
15576
{
15577
"short": "The original creator of a work.",
15578
"long": "The original creator of a work (e.g.&nbsp;the form of the author name\nlisted on the original version of a book; the historical author of a\nwork; the original songwriter or performer for a musical piece; the\noriginal developer or programmer for a piece of software; the original\nauthor of an adapted work such as a book adapted into a screenplay)"
15579
},
15580
"Issue date of the original version.",
15581
"Original publisher, for items that have been republished by a\ndifferent publisher.",
15582
"Geographic location of the original publisher (e.g.&nbsp;“London,\nUK”).",
15583
"Title of the original version (e.g.&nbsp;“Война и мир”, the untranslated\nRussian title of “War and Peace”).",
15584
"Range of pages the item (e.g.&nbsp;a journal article) covers in a\ncontainer (e.g.&nbsp;a journal issue).",
15585
"First page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15586
"Last page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15587
{
15588
"short": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).",
15589
"long": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).\nUse <code>part-title</code> for the title of the part, if any."
15590
},
15591
"Title of the specific part of an item being cited.",
15592
"A url to the pdf for this item.",
15593
"Performer of an item (e.g.&nbsp;an actor appearing in a film; a muscian\nperforming a piece of music).",
15594
"PubMed Central reference number.",
15595
"PubMed reference number.",
15596
"Printing number of the item or container holding the item.",
15597
"Producer (e.g.&nbsp;of a television or radio broadcast).",
15598
"A public url for this item.",
15599
"The publisher of the item.",
15600
"The geographic location of the publisher.",
15601
"Recipient (e.g.&nbsp;of a letter).",
15602
"Author of the item reviewed by the current item.",
15603
"Type of the item being reviewed by the current item (e.g.&nbsp;book,\nfilm).",
15604
"Title of the item reviewed by the current item.",
15605
"Scale of e.g.&nbsp;a map or model.",
15606
"Writer of a script or screenplay (e.g.&nbsp;of a film).",
15607
"Section of the item or container holding the item (e.g.&nbsp;“§2.0.1” for\na law; “politics” for a newspaper article).",
15608
"Creator of a series (e.g.&nbsp;of a television series).",
15609
"Source from whence the item originates (e.g.&nbsp;a library catalog or\ndatabase).",
15610
"Publication status of the item (e.g.&nbsp;“forthcoming”; “in press”;\n“advance online publication”; “retracted”)",
15611
"Date the item (e.g.&nbsp;a manuscript) was submitted for publication.",
15612
"Supplement number of the item or container holding the item (e.g.&nbsp;for\nsecondary legal items that are regularly updated between editions).",
15613
"Short/abbreviated form of<code>title</code>.",
15614
"Translator",
15615
"The <a href=\"https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types\">type</a>\nof the item.",
15616
"Uniform Resource Locator\n(e.g.&nbsp;“https://aem.asm.org/cgi/content/full/74/9/2766”)",
15617
"Version of the item (e.g.&nbsp;“2.0.9” for a software program).",
15618
{
15619
"short": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item.",
15620
"long": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item (e.g.&nbsp;“2” when citing a chapter from\nvolume 2 of a book).\nUse <code>volume-title</code> for the title of the volume, if\nany."
15621
},
15622
{
15623
"short": "Title of the volume of the item or container holding the item.",
15624
"long": "Title of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections,\nand the like."
15625
},
15626
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
15627
"Abstract of the item (e.g.&nbsp;the abstract of a journal article)",
15628
"The author(s) of the item.",
15629
"Digital Object Identifier (e.g.&nbsp;“10.1128/AEM.02591-07”)",
15630
{
15631
"short": "Resources related to the procedural history of a legal case or\nlegislation.",
15632
"long": "Resources related to the procedural history of a legal case or\nlegislation;\nCan also be used to refer to the procedural history of other items\n(e.g.&nbsp; “Conference canceled” for a presentation accepted as a conference\nthat was subsequently canceled; details of a retraction or correction\nnotice)"
15633
},
15634
"The primary title of the item.",
15635
"A url to the abstract for this item.",
15636
"Date the item has been accessed.",
15637
{
15638
"short": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review).",
15639
"long": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use\n<code>note</code> instead"
15640
},
15641
"Archive storing the item",
15642
"Collection the item is part of within an archive.",
15643
"Storage location within an archive (e.g.&nbsp;a box and folder\nnumber).",
15644
"Geographic location of the archive.",
15645
"Issuing or judicial authority (e.g.&nbsp;“USPTO” for a patent, “Fairfax\nCircuit Court” for a legal case).",
15646
{
15647
"short": "Date the item was initially available",
15648
"long": "Date the item was initially available (e.g.&nbsp;the online publication\ndate of a journal article before its formal publication date; the date a\ntreaty was made available for signing)."
15649
},
15650
"Call number (to locate the item in a library).",
15651
"The person leading the session containing a presentation (e.g.&nbsp;the\norganizer of the <code>container-title</code> of a\n<code>speech</code>).",
15652
"Chapter number (e.g.&nbsp;chapter number in a book; track number on an\nalbum).",
15653
{
15654
"short": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey).",
15655
"long": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey);\nUse this variable to facilitate conversion between word-processor and\nplain-text writing systems; For an identifer intended as formatted\noutput label for a citation (e.g.&nbsp;“Ferr78”), use\n<code>citation-label</code> instead"
15656
},
15657
{
15658
"short": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”).",
15659
"long": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the\nidentifier of the item in the input data file, use\n<code>citation-key</code> instead"
15660
},
15661
"Index (starting at 1) of the cited reference in the bibliography\n(generated by the CSL processor).",
15662
"Editor of the collection holding the item (e.g.&nbsp;the series editor for\na book).",
15663
"Number identifying the collection holding the item (e.g.&nbsp;the series\nnumber for a book)",
15664
"Title of the collection holding the item (e.g.&nbsp;the series title for a\nbook; the lecture series title for a presentation).",
15665
"Person compiling or selecting material for an item from the works of\nvarious persons or bodies (e.g.&nbsp;for an anthology).",
15666
"Composer (e.g.&nbsp;of a musical score).",
15667
"Author of the container holding the item (e.g.&nbsp;the book author for a\nbook chapter).",
15668
{
15669
"short": "Title of the container holding the item.",
15670
"long": "Title of the container holding the item (e.g.&nbsp;the book title for a\nbook chapter, the journal title for a journal article; the album title\nfor a recording; the session title for multi-part presentation at a\nconference)"
15671
},
15672
"Short/abbreviated form of container-title;",
15673
"A minor contributor to the item; typically cited using “with” before\nthe name when listed in a bibliography.",
15674
"Curator of an exhibit or collection (e.g.&nbsp;in a museum).",
15675
"Physical (e.g.&nbsp;size) or temporal (e.g.&nbsp;running time) dimensions of\nthe item.",
15676
"Director (e.g.&nbsp;of a film).",
15677
"Minor subdivision of a court with a <code>jurisdiction</code> for a\nlegal item",
15678
"(Container) edition holding the item (e.g.&nbsp;“3” when citing a chapter\nin the third edition of a book).",
15679
"The editor of the item.",
15680
"Managing editor (“Directeur de la Publication” in French).",
15681
{
15682
"short": "Combined editor and translator of a work.",
15683
"long": "Combined editor and translator of a work.\nThe citation processory must be automatically generate if editor and\ntranslator variables are identical; May also be provided directly in\nitem data."
15684
},
15685
"Date the event related to an item took place.",
15686
"Name of the event related to the item (e.g.&nbsp;the conference name when\nciting a conference paper; the meeting where presentation was made).",
15687
"Geographic location of the event related to the item\n(e.g.&nbsp;“Amsterdam, The Netherlands”).",
15688
"Executive producer of the item (e.g.&nbsp;of a television series).",
15689
{
15690
"short": "Number of a preceding note containing the first reference to the\nitem.",
15691
"long": "Number of a preceding note containing the first reference to the\nitem\nAssigned by the CSL processor; Empty in non-note-based styles or when\nthe item hasn’t been cited in any preceding notes in a document"
15692
},
15693
"A url to the full text for this item.",
15694
{
15695
"short": "Type, class, or subtype of the item",
15696
"long": "Type, class, or subtype of the item (e.g.&nbsp;“Doctoral dissertation” for\na PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g.&nbsp;“adventure”\nfor an adventure movie)"
15697
},
15698
"Guest (e.g.&nbsp;on a TV show or podcast).",
15699
"Host of the item (e.g.&nbsp;of a TV show or podcast).",
15700
"Citation identifier for the item (e.g.&nbsp;“item1”). Will be\nautogenerated if not provided.",
15701
"Illustrator (e.g.&nbsp;of a children’s book or graphic novel).",
15702
"Interviewer (e.g.&nbsp;of an interview).",
15703
"International Standard Book Number (e.g.&nbsp;“978-3-8474-1017-1”).",
15704
"International Standard Serial Number.",
15705
{
15706
"short": "Issue number of the item or container holding the item",
15707
"long": "Issue number of the item or container holding the item (e.g.&nbsp;“5” when\nciting a journal article from journal volume 2, issue 5);\nUse <code>volume-title</code> for the title of the issue, if any."
15708
},
15709
"Date the item was issued/published.",
15710
"Geographic scope of relevance (e.g.&nbsp;“US” for a US patent; the court\nhearing a legal case).",
15711
"Keyword(s) or tag(s) attached to the item.",
15712
{
15713
"short": "The language of the item (used only for citation of the item).",
15714
"long": "The language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code\n(e.g.&nbsp;“en”, “zh”), optionally with a two-letter locale code\n(e.g.&nbsp;“de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents\nwhat language the item uses (which may be used in citing the item)."
15715
},
15716
{
15717
"short": "The license information applicable to an item.",
15718
"long": "The license information applicable to an item (e.g.&nbsp;the license an\narticle or software is released under; the copyright information for an\nitem; the classification status of a document)"
15719
},
15720
{
15721
"short": "A cite-specific pinpointer within the item.",
15722
"long": "A cite-specific pinpointer within the item (e.g.&nbsp;a page number within\na book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the\nlocator type (see the Locators term list)."
15723
},
15724
"Description of the item’s format or medium (e.g.&nbsp;“CD”, “DVD”,\n“Album”, etc.)",
15725
"Narrator (e.g.&nbsp;of an audio book).",
15726
"Descriptive text or notes about an item (e.g.&nbsp;in an annotated\nbibliography).",
15727
"Number identifying the item (e.g.&nbsp;a report number).",
15728
"Total number of pages of the cited item.",
15729
"Total number of volumes, used when citing multi-volume books and\nsuch.",
15730
"Organizer of an event (e.g.&nbsp;organizer of a workshop or\nconference).",
15731
{
15732
"short": "The original creator of a work.",
15733
"long": "The original creator of a work (e.g.&nbsp;the form of the author name\nlisted on the original version of a book; the historical author of a\nwork; the original songwriter or performer for a musical piece; the\noriginal developer or programmer for a piece of software; the original\nauthor of an adapted work such as a book adapted into a screenplay)"
15734
},
15735
"Issue date of the original version.",
15736
"Original publisher, for items that have been republished by a\ndifferent publisher.",
15737
"Geographic location of the original publisher (e.g.&nbsp;“London,\nUK”).",
15738
"Title of the original version (e.g.&nbsp;“Война и мир”, the untranslated\nRussian title of “War and Peace”).",
15739
"Range of pages the item (e.g.&nbsp;a journal article) covers in a\ncontainer (e.g.&nbsp;a journal issue).",
15740
"First page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15741
"Last page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
15742
{
15743
"short": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).",
15744
"long": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).\nUse <code>part-title</code> for the title of the part, if any."
15745
},
15746
"Title of the specific part of an item being cited.",
15747
"A url to the pdf for this item.",
15748
"Performer of an item (e.g.&nbsp;an actor appearing in a film; a muscian\nperforming a piece of music).",
15749
"PubMed Central reference number.",
15750
"PubMed reference number.",
15751
"Printing number of the item or container holding the item.",
15752
"Producer (e.g.&nbsp;of a television or radio broadcast).",
15753
"A public url for this item.",
15754
"The publisher of the item.",
15755
"The geographic location of the publisher.",
15756
"Recipient (e.g.&nbsp;of a letter).",
15757
"Author of the item reviewed by the current item.",
15758
"Type of the item being reviewed by the current item (e.g.&nbsp;book,\nfilm).",
15759
"Title of the item reviewed by the current item.",
15760
"Scale of e.g.&nbsp;a map or model.",
15761
"Writer of a script or screenplay (e.g.&nbsp;of a film).",
15762
"Section of the item or container holding the item (e.g.&nbsp;“§2.0.1” for\na law; “politics” for a newspaper article).",
15763
"Creator of a series (e.g.&nbsp;of a television series).",
15764
"Source from whence the item originates (e.g.&nbsp;a library catalog or\ndatabase).",
15765
"Publication status of the item (e.g.&nbsp;“forthcoming”; “in press”;\n“advance online publication”; “retracted”)",
15766
"Date the item (e.g.&nbsp;a manuscript) was submitted for publication.",
15767
"Supplement number of the item or container holding the item (e.g.&nbsp;for\nsecondary legal items that are regularly updated between editions).",
15768
"Short/abbreviated form of<code>title</code>.",
15769
"Translator",
15770
"The <a href=\"https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types\">type</a>\nof the item.",
15771
"Uniform Resource Locator\n(e.g.&nbsp;“https://aem.asm.org/cgi/content/full/74/9/2766”)",
15772
"Version of the item (e.g.&nbsp;“2.0.9” for a software program).",
15773
{
15774
"short": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item.",
15775
"long": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item (e.g.&nbsp;“2” when citing a chapter from\nvolume 2 of a book).\nUse <code>volume-title</code> for the title of the volume, if\nany."
15776
},
15777
{
15778
"short": "Title of the volume of the item or container holding the item.",
15779
"long": "Title of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections,\nand the like."
15780
},
15781
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
15782
"Abstract of the item (e.g.&nbsp;the abstract of a journal article)",
15783
"The author(s) of the item.",
15784
"Digital Object Identifier (e.g.&nbsp;“10.1128/AEM.02591-07”)",
15785
{
15786
"short": "Resources related to the procedural history of a legal case or\nlegislation.",
15787
"long": "Resources related to the procedural history of a legal case or\nlegislation;\nCan also be used to refer to the procedural history of other items\n(e.g.&nbsp; “Conference canceled” for a presentation accepted as a conference\nthat was subsequently canceled; details of a retraction or correction\nnotice)"
15788
},
15789
"The primary title of the item.",
15790
"The unique identifier for this article.",
15791
"The type of identifier",
15792
"The value for the identifier",
15793
"The type of identifier",
15794
"The value for the identifier",
15795
"Bibliographic identifier for a document that does not have\ntraditional printed page numbers.",
15796
"Electronic International Standard Serial Number.",
15797
"Print International Standard Serial Number.",
15798
"Generic article accession identifier.",
15799
"The location of the publisher of this item.",
15800
"The name of a subject or topic describing the article.",
15801
"A list of subjects or topics describing the article.",
15802
"A list of subjects or topics describing the article.",
15803
{
15804
"short": "External identifier of a publication or journal.",
15805
"long": "External identifier, typically assigned to a journal by a publisher,\narchive, or library to provide a unique identifier for the journal or\npublication."
15806
},
15807
"The type of identifier (e.g.&nbsp;<code>nlm-ta</code> or\n<code>pmc</code>).",
15808
"The value for the identifier",
15809
"The type of identifier (e.g.&nbsp;<code>nlm-ta</code> or\n<code>pmc</code>).",
15810
"The value for the identifier",
15811
"The type used for the JATS <code>article</code> tag.",
15812
"Textual content to add to includes",
15813
"Name of file with content to add to includes",
15814
"Version number according to Semantic Versioning",
15815
"Specify a default profile and profile groups",
15816
"Default profile to apply if QUARTO_PROFILE is not defined.",
15817
"Define a profile group for which at least one profile is always\nactive.",
15818
"Control when tests should run",
15819
"Run tests on CI (true = run, false = skip)",
15820
"Skip test unconditionally (true = skip with default message, string =\nskip with custom message)",
15821
"Run tests ONLY on these platforms (whitelist)",
15822
"Don’t run tests on these platforms (blacklist)",
15823
"The path to the locally referenced notebook.",
15824
"The title of the notebook when viewed.",
15825
"The url to use when viewing this notebook.",
15826
"The url to use when downloading the notebook from the preview",
15827
"The bootstrap icon for this code link.",
15828
"The text for this code link.",
15829
"The href for this code link.",
15830
"The rel used in the <code>a</code> tag for this code link.",
15831
"The target used in the <code>a</code> tag for this code link.",
15832
"The bootstrap icon for this code link.",
15833
"The text for this code link.",
15834
"The href for this code link.",
15835
"The rel used in the <code>a</code> tag for this code link.",
15836
"The target used in the <code>a</code> tag for this code link.",
15837
"The input document that will serve as the root document for this\nmanuscript",
15838
"Code links to display for this manuscript.",
15839
"The deployed url for this manuscript",
15840
"Whether to generate a MECA bundle for this manuscript",
15841
"Additional file resources to be copied to output directory",
15842
"Additional file resources to be copied to output directory",
15843
"Files that specify the execution environment (e.g.&nbsp;renv.lock,\nrequirements.text, etc…)",
15844
"Files that specify the execution environment (e.g.&nbsp;renv.lock,\nrequirements.text, etc…)",
15845
"Metadata for a brand, including the brand name and important\nlinks.",
15846
"The brand name.",
15847
"The full, official or legal name of the company or brand.",
15848
"The short, informal, or common name of the company or brand.",
15849
"Important links for the brand, including social media links. If a\nsingle string, it is the brand’s home page or website. Additional fields\nare allowed for internal use.",
15850
"The brand’s home page or website.",
15851
"The brand’s Mastodon URL.",
15852
"The brand’s Bluesky URL.",
15853
"The brand’s GitHub URL.",
15854
"The brand’s LinkedIn URL.",
15855
"The brand’s Twitter URL.",
15856
"The brand’s Facebook URL.",
15857
"A link or path to the brand’s light-colored logo or icon.",
15858
"A link or path to the brand’s dark-colored logo or icon.",
15859
"Alternative text for the logo, used for accessibility.",
15860
"Provide definitions and defaults for brand’s logo in various formats\nand sizes.",
15861
"A dictionary of named logo resources.",
15862
"A link or path to the brand’s small-sized logo or icon.",
15863
"A link or path to the brand’s medium-sized logo.",
15864
"A link or path to the brand’s large- or full-sized logo.",
15865
"Provide definitions and defaults for brand’s logo in various formats\nand sizes.",
15866
"A dictionary of named logo resources.",
15867
"A link or path to the brand’s small-sized logo or icon, or a link or\npath to both the light and dark versions.",
15868
"A link or path to the brand’s medium-sized logo, or a link or path to\nboth the light and dark versions.",
15869
"A link or path to the brand’s large- or full-sized logo, or a link or\npath to both the light and dark versions.",
15870
"Names of customizeable logos",
15871
"Path or brand.yml logo resource name.",
15872
"Alternative text for the logo, used for accessibility.",
15873
"Path or brand.yml logo resource name.",
15874
"Alternative text for the logo, used for accessibility.",
15875
"Any of the ways a logo can be specified: string, object, or\nlight/dark object of string or object. Use <code>false</code> to\nexplicitly disable the logo.",
15876
"Specification of a light logo",
15877
"Specification of a dark logo",
15878
"Any of the ways a logo can be specified: string, object, or\nlight/dark object of string or object",
15879
"Specification of a light logo",
15880
"Specification of a dark logo",
15881
"Any of the ways a logo can be specified: string, object, or\nlight/dark object of string or object",
15882
"Options for a light logo",
15883
"Options for a dark logo",
15884
"The brand’s custom color palette and theme.",
15885
"The brand’s custom color palette. Any number of colors can be\ndefined, each color having a custom name.",
15886
"The foreground color, used for text.",
15887
"The background color, used for the page background.",
15888
"The primary accent color, i.e.&nbsp;the main theme color. Typically used\nfor hyperlinks, active states, primary action buttons, etc.",
15889
"The secondary accent color. Typically used for lighter text or\ndisabled states.",
15890
"The tertiary accent color. Typically an even lighter color, used for\nhover states, accents, and wells.",
15891
"The color used for positive or successful actions and\ninformation.",
15892
"The color used for neutral or informational actions and\ninformation.",
15893
"The color used for warning or cautionary actions and information.",
15894
"The color used for errors, dangerous actions, or negative\ninformation.",
15895
"A bright color, used as a high-contrast foreground color on dark\nelements or low-contrast background color on light elements.",
15896
"A dark color, used as a high-contrast foreground color on light\nelements or high-contrast background color on light elements.",
15897
"The color used for hyperlinks. If not defined, the\n<code>primary</code> color is used.",
15898
"A link or path to the brand’s light-colored logo or icon.",
15899
"A link or path to the brand’s dark-colored logo or icon.",
15900
"The brand’s custom color palette and theme.",
15901
"The brand’s custom color palette. Any number of colors can be\ndefined, each color having a custom name.",
15902
"The foreground color, used for text.",
15903
"The background color, used for the page background.",
15904
"The primary accent color, i.e.&nbsp;the main theme color. Typically used\nfor hyperlinks, active states, primary action buttons, etc.",
15905
"The secondary accent color. Typically used for lighter text or\ndisabled states.",
15906
"The tertiary accent color. Typically an even lighter color, used for\nhover states, accents, and wells.",
15907
"The color used for positive or successful actions and\ninformation.",
15908
"The color used for neutral or informational actions and\ninformation.",
15909
"The color used for warning or cautionary actions and information.",
15910
"The color used for errors, dangerous actions, or negative\ninformation.",
15911
"A bright color, used as a high-contrast foreground color on dark\nelements or low-contrast background color on light elements.",
15912
"A dark color, used as a high-contrast foreground color on light\nelements or high-contrast background color on light elements.",
15913
"The color used for hyperlinks. If not defined, the\n<code>primary</code> color is used.",
15914
"A color, which may be a named brand color.",
15915
"A link or path to the brand’s light-colored logo or icon.",
15916
"A link or path to the brand’s dark-colored logo or icon.",
15917
"A named brand color, taken either from <code>color.theme</code> or\n<code>color.palette</code> (in that order).",
15918
"Typography definitions for the brand.",
15919
"Font files and definitions for the brand.",
15920
"The base font settings for the brand. These are used as the default\nfor all text.",
15921
"Settings for headings, or a string specifying the font family\nonly.",
15922
"Settings for monospace text, or a string specifying the font family\nonly.",
15923
"Settings for inline code, or a string specifying the font family\nonly.",
15924
"Settings for code blocks, or a string specifying the font family\nonly.",
15925
"Settings for links.",
15926
"Typography definitions for the brand.",
15927
"Font files and definitions for the brand.",
15928
"The base font settings for the brand. These are used as the default\nfor all text.",
15929
"Settings for headings, or a string specifying the font family\nonly.",
15930
"Settings for monospace text, or a string specifying the font family\nonly.",
15931
"Settings for inline code, or a string specifying the font family\nonly.",
15932
"Settings for code blocks, or a string specifying the font family\nonly.",
15933
"Settings for links.",
15934
"Base typographic options.",
15935
"Typographic options for headings.",
15936
"Typographic options for headings.",
15937
"Typographic options for monospace elements.",
15938
"Typographic options for monospace elements.",
15939
"Typographic options for inline monospace elements.",
15940
"Typographic options for inline monospace elements.",
15941
"Line height",
15942
"Typographic options for block monospace elements.",
15943
"Typographic options for block monospace elements.",
15944
"Typographic options for inline monospace elements.",
15945
"Typographic options for inline monospace elements.",
15946
"Names of customizeable typography elements",
15947
"Font files and definitions for the brand.",
15948
"A font weight.",
15949
"A font style.",
15950
"The font family name, which must match the name of the font on the\nfoundry website.",
15951
"The font weights to include.",
15952
"The font styles to include.",
15953
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
15954
"A system font definition.",
15955
"The font family name, which must match the name of the font on the\nfoundry website.",
15956
"The font weights to include.",
15957
"The font styles to include.",
15958
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
15959
"A font definition from Google Fonts.",
15960
"The font family name, which must match the name of the font on the\nfoundry website.",
15961
"The font weights to include.",
15962
"The font styles to include.",
15963
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
15964
"A font definition from fonts.bunny.net.",
15965
"The font family name, which must match the name of the font on the\nfoundry website.",
15966
"The font weights to include.",
15967
"The font styles to include.",
15968
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
15969
"A method for providing font files directly, either locally or from an\nonline location.",
15970
"The font family name.",
15971
"The font files to include. These can be local or online. Local file\npaths should be relative to the <code>brand.yml</code> file. Online\npaths should be complete URLs.",
15972
"The path to the font file. This can be a local path or a URL.",
15973
"A locally-installed font family name. When used, the end-user is\nresponsible for ensuring that the font is installed on their system.",
15974
"A path to a brand.yml file, or an object with light and dark paths to\nbrand.yml",
15975
"Branding information to use for this document. If a string, the path\nto a brand file. If false, don’t use branding on this document. If an\nobject, an inline (unified) brand definition, or an object with light\nand dark brand paths or definitions.",
15976
"The path to a light brand file or an inline light brand\ndefinition.",
15977
"The path to a dark brand file or an inline dark brand definition.",
15978
"Distance from page edge to wideblock boundary.",
15979
"Width of the margin note column.",
15980
"Gap between margin column and body text.",
15981
{
15982
"short": "Unique label for code cell",
15983
"long": "Unique label for code cell. Used when other code needs to refer to\nthe cell (e.g.&nbsp;for cross references <code>fig-samples</code> or\n<code>tbl-summary</code>)"
15984
},
15985
"Classes to apply to cell container",
15986
"Array of rendering names, e.g.&nbsp;<code>[light, dark]</code>",
15987
"Array of tags for notebook cell",
15988
{
15989
"short": "Notebook cell identifier",
15990
"long": "Notebook cell identifier. Note that if there is no cell\n<code>id</code> then <code>label</code> will be used as the cell\n<code>id</code> if it is present. See <a href=\"https://jupyter.org/enhancement-proposals/62-cell-id/cell-id.html\" class=\"uri\">https://jupyter.org/enhancement-proposals/62-cell-id/cell-id.html</a>\nfor additional details on cell ids."
15991
},
15992
"nbconvert tag to export cell",
15993
{
15994
"short": "Whether to cache a code chunk.",
15995
"long": "Whether to cache a code chunk. When evaluating code chunks for the\nsecond time, the cached chunks are skipped (unless they have been\nmodified), but the objects created in these chunks are loaded from\npreviously saved databases (<code>.rdb</code> and <code>.rdx</code>\nfiles), and these files are saved when a chunk is evaluated for the\nfirst time, or when cached files are not found (e.g., you may have\nremoved them by hand). Note that the filename consists of the chunk\nlabel with an MD5 digest of the R code and chunk options of the code\nchunk, which means any changes in the chunk will produce a different MD5\ndigest, and hence invalidate the cache."
15996
},
15997
"A prefix to be used to generate the paths of cache files",
15998
{
15999
"short": "Variable names to be saved in the cache database.",
16000
"long": "Variable names to be saved in the cache database. By default, all\nvariables created in the current chunks are identified and saved, but\nyou may want to manually specify the variables to be saved, because the\nautomatic detection of variables may not be robust, or you may want to\nsave only a subset of variables."
16001
},
16002
{
16003
"short": "Variables names that are not created from the current chunk",
16004
"long": "Variables names that are not created from the current chunk.\nThis option is mainly for <code>autodep: true</code> to work more\nprecisely—a chunk <code>B</code> depends on chunk <code>A</code> when\nany of <code>B</code>’s global variables are <code>A</code>’s local\nvariables. In case the automatic detection of global variables in a\nchunk fails, you may manually specify the names of global variables via\nthis option. In addition, <code>cache-globals: false</code> means\ndetecting all variables in a code chunk, no matter if they are global or\nlocal variables."
16005
},
16006
{
16007
"short": "Whether to <code>lazyLoad()</code> or directly <code>load()</code>\nobjects",
16008
"long": "Whether to <code>lazyLoad()</code> or directly <code>load()</code>\nobjects. For very large objects, lazyloading may not work, so\n<code>cache-lazy: false</code> may be desirable (see <a href=\"https://github.com/yihui/knitr/issues/572\">#572</a>)."
16009
},
16010
"Force rebuild of cache for chunk",
16011
"Prevent comment changes from invalidating the cache for a chunk",
16012
"Explicitly specify cache dependencies for this chunk (one or more\nchunk labels)",
16013
"Detect cache dependencies automatically via usage of global\nvariables",
16014
{
16015
"short": "Title displayed in dashboard card header",
16016
"long": ""
16017
},
16018
{
16019
"short": "Padding around dashboard card content (default <code>8px</code>)",
16020
"long": ""
16021
},
16022
{
16023
"short": "Make dashboard card content expandable (default:\n<code>true</code>)",
16024
"long": ""
16025
},
16026
{
16027
"short": "Percentage or absolute pixel width for dashboard card (defaults to\nevenly spaced across row)",
16028
"long": ""
16029
},
16030
{
16031
"short": "Percentage or absolute pixel height for dashboard card (defaults to\nevenly spaced across column)",
16032
"long": ""
16033
},
16034
{
16035
"short": "Context to execute cell within.",
16036
"long": ""
16037
},
16038
{
16039
"short": "The type of dashboard element being produced by this code cell.",
16040
"long": ""
16041
},
16042
{
16043
"short": "For code cells that produce a valuebox, the color of the\nvaluebox.s",
16044
"long": ""
16045
},
16046
{
16047
"short": "Evaluate code cells (if <code>false</code> just echos the code into\noutput).",
16048
"long": "Evaluate code cells (if <code>false</code> just echos the code into\noutput)."
16049
},
16050
{
16051
"short": "Include cell source code in rendered output.",
16052
"long": "Include cell source code in rendered output."
16053
},
16054
{
16055
"short": "Collapse code into an HTML <code>&lt;details&gt;</code> tag so the\nuser can display it on-demand.",
16056
"long": "Collapse code into an HTML <code>&lt;details&gt;</code> tag so the\nuser can display it on-demand."
16057
},
16058
"Summary text to use for code blocks collapsed using\n<code>code-fold</code>",
16059
{
16060
"short": "Choose whether to <code>scroll</code> or <code>wrap</code> when code\nlines are too wide for their container.",
16061
"long": "Choose how to handle code overflow, when code lines are too wide for\ntheir container. One of:"
16062
},
16063
{
16064
"short": "Include line numbers in code block output (<code>true</code> or\n<code>false</code>)",
16065
"long": "Include line numbers in code block output (<code>true</code> or\n<code>false</code>).\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines)."
16066
},
16067
"Unique label for code listing (used in cross references)",
16068
"Caption for code listing",
16069
"Whether to reformat R code.",
16070
"List of options to pass to <code>tidy</code> handler",
16071
"Collapse all the source and output blocks from one code chunk into a\nsingle block",
16072
{
16073
"short": "Whether to add the prompt characters in R code.",
16074
"long": "Whether to add the prompt characters in R code. See\n<code>prompt</code> and <code>continue</code> on the help page\n<code>?base::options</code>. Note that adding prompts can make it\ndifficult for readers to copy R code from the output, so\n<code>prompt: false</code> may be a better choice. This option may not\nwork well when the <code>engine</code> is not <code>R</code> (<a href=\"https://github.com/yihui/knitr/issues/1274\">#1274</a>)."
16075
},
16076
"Whether to syntax highlight the source code",
16077
"Class name(s) for source code blocks",
16078
"Attribute(s) for source code blocks",
16079
"Default width for figures",
16080
"Default height for figures",
16081
"Figure caption",
16082
"Figure subcaptions",
16083
"Hyperlink target for the figure",
16084
"Figure horizontal alignment (<code>default</code>, <code>left</code>,\n<code>right</code>, or <code>center</code>)",
16085
"Alternative text to be used in the <code>alt</code> attribute of HTML\nimages.",
16086
"LaTeX environment for figure output",
16087
{
16088
"short": "LaTeX figure position arrangement to be used in\n<code>\\begin{figure}[]</code>.",
16089
"long": "LaTeX figure position arrangement to be used in\n<code>\\begin{figure}[]</code>.\nComputational figure output that is accompanied by the code that\nproduced it is given a default value of <code>fig-pos=\"H\"</code> (so\nthat the code and figure are not inordinately separated).\nIf <code>fig-pos</code> is <code>false</code>, then we don’t use any\nfigure position specifier, which is sometimes necessary with custom\nfigure environments (such as <code>sidewaysfigure</code>)."
16090
},
16091
{
16092
"short": "A short caption (only used in LaTeX output)",
16093
"long": "A short caption (only used in LaTeX output). A short caption is\ninserted in <code>\\caption[]</code>, and usually displayed in the “List\nof Figures” of a PDF document."
16094
},
16095
"Default output format for figures (<code>retina</code>,\n<code>png</code>, <code>jpeg</code>, <code>svg</code>, or\n<code>pdf</code>)",
16096
"Default DPI for figures",
16097
"The aspect ratio of the plot, i.e., the ratio of height/width. When\n<code>fig-asp</code> is specified, the height of a plot (the option\n<code>fig-height</code>) is calculated from\n<code>fig-width * fig-asp</code>.",
16098
{
16099
"short": "Width of plot in the output document",
16100
"long": "Width of the plot in the output document, which can be different from\nits physical <code>fig-width</code>, i.e., plots can be scaled in the\noutput document. When used without a unit, the unit is assumed to be\npixels. However, any of the following unit identifiers can be used: px,\ncm, mm, in, inch and %, for example, <code>3in</code>, <code>8cm</code>,\n<code>300px</code> or <code>50%</code>."
16101
},
16102
{
16103
"short": "Height of plot in the output document",
16104
"long": "Height of the plot in the output document, which can be different\nfrom its physical <code>fig-height</code>, i.e., plots can be scaled in\nthe output document. Depending on the output format, this option can\ntake special values. For example, for LaTeX output, it can be\n<code>3in</code>, or <code>8cm</code>; for HTML, it can be\n<code>300px</code>."
16105
},
16106
{
16107
"short": "How plots in chunks should be kept.",
16108
"long": "How plots in chunks should be kept. Possible values are as\nfollows:"
16109
},
16110
{
16111
"short": "How to show/arrange the plots",
16112
"long": "How to show/arrange the plots. Possible values are as follows:"
16113
},
16114
"Additional raw LaTeX or HTML options to be applied to figures",
16115
"Externalize tikz graphics (pre-compile to PDF)",
16116
"sanitize tikz graphics (escape special LaTeX characters).",
16117
"Time interval (number of seconds) between animation frames.",
16118
{
16119
"short": "Extra options for animations",
16120
"long": "Extra options for animations; see the documentation of the LaTeX <a href=\"http://ctan.org/pkg/animate\"><strong>animate</strong>\npackage.</a>"
16121
},
16122
{
16123
"short": "Hook function to create animations in HTML output",
16124
"long": "Hook function to create animations in HTML output.\nThe default hook (<code>ffmpeg</code>) uses FFmpeg to convert images\nto a WebM video.\nAnother hook function is <code>gifski</code> based on the <a href=\"https://cran.r-project.org/package=gifski\"><strong>gifski</strong></a>\npackage to create GIF animations."
16125
},
16126
"One or more paths of child documents to be knitted and input into the\nmain document.",
16127
"File containing code to execute for this chunk",
16128
"String containing code to execute for this chunk",
16129
"Include chunk when extracting code with\n<code>knitr::purl()</code>",
16130
{
16131
"short": "2d-array of widths where the first dimension specifies columns and\nthe second rows.",
16132
"long": "2d-array of widths where the first dimension specifies columns and\nthe second rows.\nFor example, to layout the first two output blocks side-by-side on\nthe top with the third block spanning the full width below, use\n<code>[[3,3], [1]]</code>.\nUse negative values to create margin. For example, to create space\nbetween the output blocks in the top row of the previous example, use\n<code>[[3,-1, 3], [1]]</code>."
16133
},
16134
"Layout output blocks into columns",
16135
"Layout output blocks into rows",
16136
"Horizontal alignment for layout content (<code>default</code>,\n<code>left</code>, <code>right</code>, or <code>center</code>)",
16137
"Vertical alignment for layout content (<code>default</code>,\n<code>top</code>, <code>center</code>, or <code>bottom</code>)",
16138
{
16139
"short": "Page column for output",
16140
"long": "<a href=\"https://quarto.org/docs/authoring/article-layout.html\">Page\ncolumn</a> for output"
16141
},
16142
{
16143
"short": "Page column for figure output",
16144
"long": "<a href=\"https://quarto.org/docs/authoring/article-layout.html\">Page\ncolumn</a> for figure output"
16145
},
16146
{
16147
"short": "Page column for table output",
16148
"long": "<a href=\"https://quarto.org/docs/authoring/article-layout.html\">Page\ncolumn</a> for table output"
16149
},
16150
"Where to place figure and table captions (<code>top</code>,\n<code>bottom</code>, or <code>margin</code>)",
16151
"Where to place figure captions (<code>top</code>,\n<code>bottom</code>, or <code>margin</code>)",
16152
"Where to place table captions (<code>top</code>, <code>bottom</code>,\nor <code>margin</code>)",
16153
"Table caption",
16154
"Table subcaptions",
16155
{
16156
"short": "Apply explicit table column widths",
16157
"long": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than <code>columns</code> characters wide (72 by\ndefault).\nSome formats (e.g.&nbsp;HTML) do an excellent job automatically sizing\ntable columns and so don’t benefit much from column width\nspecifications. Other formats (e.g.&nbsp;LaTeX) require table column sizes in\norder to correctly flow longer cell content (this is a major reason why\ntables &gt; 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:"
16158
},
16159
"If <code>none</code>, do not process raw HTML table in cell output\nand leave it as-is",
16160
{
16161
"short": "Include the results of executing the code in the output (specify\n<code>asis</code> to treat output as raw markdown with no enclosing\ncontainers).",
16162
"long": "Include the results of executing the code in the output. Possible\nvalues:"
16163
},
16164
"Include warnings in rendered output.",
16165
"Include errors in the output (note that this implies that errors\nexecuting code will not halt processing of the document).",
16166
"Catch all for preventing any output (code or results) from being\nincluded in output.",
16167
"Panel type for cell output (<code>tabset</code>, <code>input</code>,\n<code>sidebar</code>, <code>fill</code>, <code>center</code>)",
16168
{
16169
"short": "Location of output relative to the code that generated it\n(<code>default</code>, <code>fragment</code>, <code>slide</code>,\n<code>column</code>, or <code>column-location</code>)",
16170
"long": "Location of output relative to the code that generated it. The\npossible values are as follows:"
16171
},
16172
{
16173
"short": "Include messages in rendered output.",
16174
"long": "Include messages in rendered output. Possible values are\n<code>true</code>, <code>false</code>, or <code>NA</code>. If\n<code>true</code>, messages are included in the output. If\n<code>false</code>, messages are not included. If <code>NA</code>,\nmessages are not included in output but shown in the knitr log to\nconsole."
16175
},
16176
{
16177
"short": "How to display text results",
16178
"long": "How to display text results. Note that this option only applies to\nnormal text output (not warnings, messages, or errors). The possible\nvalues are as follows:"
16179
},
16180
{
16181
"short": "Prefix to be added before each line of text output.",
16182
"long": "Prefix to be added before each line of text output. By default, the\ntext output is commented out by <code>##</code>, so if readers want to\ncopy and run the source code from the output document, they can select\nand copy everything from the chunk, since the text output is masked in\ncomments (and will be ignored when running the copied text). Set\n<code>comment: ''</code> to remove the default <code>##</code>."
16183
},
16184
"Class name(s) for text/console output",
16185
"Attribute(s) for text/console output",
16186
"Class name(s) for warning output",
16187
"Attribute(s) for warning output",
16188
"Class name(s) for message output",
16189
"Attribute(s) for message output",
16190
"Class name(s) for error output",
16191
"Attribute(s) for error output",
16192
{
16193
"short": "Specifies that the page is an ‘about’ page and which template to use\nwhen laying out the page.",
16194
"long": "Specifies that the page is an ‘about’ page and which template to use\nwhen laying out the page.\nThe allowed values are either:"
16195
},
16196
"Document title",
16197
"Identifies the subtitle of the document.",
16198
"Document date",
16199
"Date format for the document",
16200
"Document date modified",
16201
"Author or authors of the document",
16202
{
16203
"short": "The list of organizations with which contributors are affiliated.",
16204
"long": "The list of organizations with which contributors are affiliated.\nEach institution is added as an [<code>&lt;aff&gt;</code>] element to\nthe author’s contrib-group. See the Pandoc <a href=\"https://pandoc.org/jats.html\">JATS documentation</a> for details\non <code>affiliation</code> fields."
16205
},
16206
{
16207
"short": "Licensing and copyright information.",
16208
"long": "Licensing and copyright information. This information is rendered via\nthe <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/permissions.html\"><code>&lt;permissions&gt;</code></a>\nelement. The variables <code>type</code>, <code>link</code>, and\n<code>text</code> should always be used together. See the Pandoc <a href=\"https://pandoc.org/jats.html\">JATS documentation</a> for details\non <code>copyright</code> fields."
16209
},
16210
{
16211
"short": "Information concerning the article that identifies or describes\nit.",
16212
"long": "Information concerning the article that identifies or describes it.\nThe key-value pairs within this map are typically used within the <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/article-meta.html\"><code>&lt;article-meta&gt;</code></a>\nelement. See the Pandoc <a href=\"https://pandoc.org/jats.html\">JATS\ndocumentation</a> for details on <code>article</code> fields."
16213
},
16214
{
16215
"short": "Information on the journal in which the article is published.",
16216
"long": "Information on the journal in which the article is published. See the\nPandoc <a href=\"https://pandoc.org/jats.html\">JATS documentation</a> for\ndetails on <code>journal</code> fields."
16217
},
16218
"Author affiliations for the presentation.",
16219
"Summary of document",
16220
"Title used to label document abstract",
16221
"Additional notes concerning the whole article. Added to the article’s\nfrontmatter via the <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/notes.html\"><code>&lt;notes&gt;</code></a>\nelement.",
16222
"List of keywords. Items are used as contents of the <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd.html\"><code>&lt;kwd&gt;</code></a>\nelement; the elements are grouped in a <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd-group.html\"><code>&lt;kwd-group&gt;</code></a>\nwith the <a href=\"https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/kwd-group-type.html\"><code>kwd-group-type</code></a>\nvalue <code>author</code>.",
16223
"Displays the document Digital Object Identifier in the header.",
16224
"The contents of an acknowledgments footnote after the document\ntitle.",
16225
"Order for document when included in a website automatic sidebar\nmenu.",
16226
{
16227
"short": "Citation information for the document itself.",
16228
"long": "Citation information for the document itself specified as <a href=\"https://docs.citationstyles.org/en/stable/specification.html\">CSL</a>\nYAML in the document front matter.\nFor more on supported options, see <a href=\"https://quarto.org/docs/reference/metadata/citation.html\">Citation\nMetadata</a>."
16229
},
16230
{
16231
"short": "Enable a code copy icon for code blocks.",
16232
"long": "Enable a code copy icon for code blocks."
16233
},
16234
{
16235
"short": "Enables hyper-linking of functions within code blocks to their online\ndocumentation.",
16236
"long": "Enables hyper-linking of functions within code blocks to their online\ndocumentation.\nCode linking is currently implemented only for the knitr engine (via\nthe <a href=\"https://downlit.r-lib.org/\">downlit</a> package). A\nlimitation of downlit currently prevents code linking if\n<code>code-line-numbers</code> is also <code>true</code>."
16237
},
16238
{
16239
"short": "The style to use when displaying code annotations",
16240
"long": "The style to use when displaying code annotations. Set this value to\nfalse to hide code annotations."
16241
},
16242
{
16243
"short": "Include a code tools menu (for hiding and showing code).",
16244
"long": "Include a code tools menu (for hiding and showing code). Use\n<code>true</code> or <code>false</code> to enable or disable the\nstandard code tools menu. Specify sub-properties <code>source</code>,\n<code>toggle</code>, and <code>caption</code> to customize the behavior\nand appearance of code tools."
16245
},
16246
{
16247
"short": "Show a thick left border on code blocks.",
16248
"long": "Specifies to apply a left border on code blocks. Provide a hex color\nto specify that the border is enabled as well as the color of the\nborder."
16249
},
16250
{
16251
"short": "Show a background color for code blocks.",
16252
"long": "Specifies to apply a background color on code blocks. Provide a hex\ncolor to specify that the background color is enabled as well as the\ncolor of the background."
16253
},
16254
{
16255
"short": "Specifies the coloring style to be used in highlighted source\ncode.",
16256
"long": "Specifies the coloring style to be used in highlighted source\ncode.\nValid values:"
16257
},
16258
{
16259
"short": "Deprecated: use <code>syntax-highlighting</code> instead.",
16260
"long": "Deprecated: use <code>syntax-highlighting</code> instead.\nSpecifies the coloring style to be used in highlighted source\ncode."
16261
},
16262
"KDE language syntax definition file (XML)",
16263
"KDE language syntax definition files (XML)",
16264
{
16265
"short": "Use the listings package for LaTeX code blocks.",
16266
"long": "Use the <code>listings</code> package for LaTeX code blocks. The\npackage does not support multi-byte encoding for source code. To handle\nUTF-8 you would need to use a custom template. This issue is fully\ndocumented here: <a href=\"https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue\">Encoding\nissue with the listings package</a>"
16267
},
16268
"Specify classes to use for all indented code blocks",
16269
"Sets the CSS <code>color</code> property.",
16270
{
16271
"short": "Sets the color of hyperlinks in the document.",
16272
"long": "For HTML output, sets the CSS <code>color</code> property on all\nlinks.\nFor LaTeX output, The color used for internal links using color\noptions allowed by <a href=\"https://ctan.org/pkg/xcolor\"><code>xcolor</code></a>, including\nthe <code>dvipsnames</code>, <code>svgnames</code>, and\n<code>x11names</code> lists.\nFor ConTeXt output, sets the color for both external links and links\nwithin the document.\nFor Typst output, sets the color of internal hyperlinks using Typst\ncolor syntax."
16273
},
16274
"Sets the CSS <code>background-color</code> property on code elements\nand adds extra padding.",
16275
"Sets the CSS <code>background-color</code> property on the html\nelement.",
16276
{
16277
"short": "The color used for external links.",
16278
"long": "For LaTeX output, the color used for external links using color\noptions allowed by <a href=\"https://ctan.org/pkg/xcolor\"><code>xcolor</code></a>, including\nthe <code>dvipsnames</code>, <code>svgnames</code>, and\n<code>x11names</code> lists.\nFor Typst output, sets the color of external file links using Typst\ncolor syntax."
16279
},
16280
{
16281
"short": "The color used for citation links.",
16282
"long": "For LaTeX output, the color used for citation links using color\noptions allowed by <a href=\"https://ctan.org/pkg/xcolor\"><code>xcolor</code></a>, including\nthe <code>dvipsnames</code>, <code>svgnames</code>, and\n<code>x11names</code> lists.\nFor Typst output, sets the color of citation links using Typst color\nsyntax."
16283
},
16284
{
16285
"short": "The color used for linked URLs using color options allowed by\n<code>xcolor</code>",
16286
"long": "The color used for linked URLs using color options allowed by <a href=\"https://ctan.org/pkg/xcolor\"><code>xcolor</code></a>, including\nthe <code>dvipsnames</code>, <code>svgnames</code>, and\n<code>x11names</code> lists."
16287
},
16288
{
16289
"short": "The color used for links in the Table of Contents using color options\nallowed by <code>xcolor</code>",
16290
"long": "The color used for links in the Table of Contents using color options\nallowed by <a href=\"https://ctan.org/pkg/xcolor\"><code>xcolor</code></a>, including\nthe <code>dvipsnames</code>, <code>svgnames</code>, and\n<code>x11names</code> lists."
16291
},
16292
"Add color to link text, automatically enabled if any of\n<code>linkcolor</code>, <code>filecolor</code>, <code>citecolor</code>,\n<code>urlcolor</code>, or <code>toccolor</code> are set.",
16293
{
16294
"short": "Color for links to other content within the document.",
16295
"long": "Color for links to other content within the document.\nSee <a href=\"https://wiki.contextgarden.net/Color\">ConTeXt Color</a>\nfor additional information."
16296
},
16297
"Configuration for document commenting.",
16298
{
16299
"short": "Configuration for cross-reference labels and prefixes.",
16300
"long": "Configuration for cross-reference labels and prefixes. See <a href=\"https://quarto.org/docs/reference/metadata/crossref.html\">Cross-Reference\nOptions</a> for more details."
16301
},
16302
"A custom cross reference type. See <a href=\"https://quarto.org/docs/reference/metadata/crossref.html#custom\">Custom</a>\nfor more details.",
16303
"The kind of cross reference (currently only “float” is\nsupported).",
16304
"The prefix used in rendered references when referencing this\ntype.",
16305
"The prefix used in rendered captions when referencing this type. If\nomitted, the field <code>reference-prefix</code> is used.",
16306
"If false, use no space between crossref prefixes and numbering.",
16307
"The key used to prefix reference labels of this type, such as “fig”,\n“tbl”, “lst”, etc.",
16308
"In LaTeX output, the name of the custom environment to be used.",
16309
"In LaTeX output, the extension of the auxiliary file used by LaTeX to\ncollect names to be used in the custom “list of” command. If omitted, a\nstring with prefix <code>lo</code> and suffix with the value of\n<code>ref-type</code> is used.",
16310
"The description of the crossreferenceable object to be used in the\ntitle of the “list of” command. If omitted, the field\n<code>reference-prefix</code> is used.",
16311
"The location of the caption relative to the crossreferenceable\ncontent.",
16312
"Use top level sections (H1) in this document as chapters.",
16313
"The delimiter used between the prefix and the caption.",
16314
"The title prefix used for figure captions.",
16315
"The title prefix used for table captions.",
16316
"The title prefix used for equation captions.",
16317
"The title prefix used for listing captions.",
16318
"The title prefix used for theorem captions.",
16319
"The title prefix used for lemma captions.",
16320
"The title prefix used for corollary captions.",
16321
"The title prefix used for proposition captions.",
16322
"The title prefix used for conjecture captions.",
16323
"The title prefix used for definition captions.",
16324
"The title prefix used for example captions.",
16325
"The title prefix used for exercise captions.",
16326
"The prefix used for an inline reference to a figure.",
16327
"The prefix used for an inline reference to a table.",
16328
"The prefix used for an inline reference to an equation.",
16329
"The prefix used for an inline reference to a section.",
16330
"The prefix used for an inline reference to a listing.",
16331
"The prefix used for an inline reference to a theorem.",
16332
"The prefix used for an inline reference to a lemma.",
16333
"The prefix used for an inline reference to a corollary.",
16334
"The prefix used for an inline reference to a proposition.",
16335
"The prefix used for an inline reference to a conjecture.",
16336
"The prefix used for an inline reference to a definition.",
16337
"The prefix used for an inline reference to an example.",
16338
"The prefix used for an inline reference to an exercise.",
16339
"The numbering scheme used for figures.",
16340
"The numbering scheme used for tables.",
16341
"The numbering scheme used for equations.",
16342
"The numbering scheme used for sections.",
16343
"The numbering scheme used for listings.",
16344
"The numbering scheme used for theorems.",
16345
"The numbering scheme used for lemmas.",
16346
"The numbering scheme used for corollaries.",
16347
"The numbering scheme used for propositions.",
16348
"The numbering scheme used for conjectures.",
16349
"The numbering scheme used for definitions.",
16350
"The numbering scheme used for examples.",
16351
"The numbering scheme used for exercises.",
16352
"The title used for the list of figures.",
16353
"The title used for the list of tables.",
16354
"The title used for the list of listings.",
16355
"The number scheme used for references.",
16356
"The number scheme used for sub references.",
16357
"Whether cross references should be hyper-linked.",
16358
"The title used for appendix.",
16359
"The delimiter beween appendix number and title.",
16360
"Enables a hover popup for cross references that shows the item being\nreferenced.",
16361
"Logo image(s) (placed on the left side of the navigation bar)",
16362
"Default orientation for dashboard content (default\n<code>rows</code>)",
16363
"Use scrolling rather than fill layout (default:\n<code>false</code>)",
16364
"Make card content expandable (default: <code>true</code>)",
16365
"Links to display on the dashboard navigation bar",
16366
"Visual editor configuration",
16367
"Default editing mode for document",
16368
"Markdown writing options for visual editor",
16369
"A column number (e.g.&nbsp;72), <code>sentence</code>, or\n<code>none</code>",
16370
"Write standard visual editor markdown from source mode.",
16371
"Reference writing options for visual editor",
16372
"Location to write references (<code>block</code>,\n<code>section</code>, or <code>document</code>)",
16373
"Write markdown links as references rather than inline.",
16374
"Unique prefix for references (<code>none</code> to prevent automatic\nprefixes)",
16375
"Automatically re-render for preview whenever document is saved (note\nthat this requires a preview for the saved document be already running).\nThis option currently works only within VS Code.",
16376
{
16377
"short": "Editor-specific options (used by RStudio and Positron).",
16378
"long": "Editor-specific options that control IDE behavior for this document.\nThese options are used by RStudio and Positron to configure per-document\neditor settings."
16379
},
16380
"Determines where chunk output is shown in the editor.",
16381
"Enable (<code>true</code>) or disable (<code>false</code>) Zotero for\na document. Alternatively, provide a list of one or more Zotero group\nlibraries to use with the document.",
16382
"The identifier for this publication.",
16383
"The identifier value.",
16384
"The identifier schema (e.g.&nbsp;<code>DOI</code>, <code>ISBN-A</code>,\netc.)",
16385
"Creators of this publication.",
16386
"Contributors to this publication.",
16387
"The subject of the publication.",
16388
"The subject text.",
16389
"An EPUB reserved authority value.",
16390
"The subject term (defined by the schema).",
16391
{
16392
"short": "Text describing the specialized type of this publication.",
16393
"long": "Text describing the specialized type of this publication.\nAn informative registry of specialized EPUB Publication types for use\nwith this element is maintained in the <a href=\"https://www.w3.org/publishing/epub32/epub-packages.html#bib-typesregistry\">TypesRegistry</a>,\nbut Authors may use any text string as a value."
16394
},
16395
"Text describing the format of this publication.",
16396
"Text describing the relation of this publication.",
16397
"Text describing the coverage of this publication.",
16398
"Text describing the rights of this publication.",
16399
"Identifies the name of a collection to which the EPUB Publication\nbelongs.",
16400
"Indicates the numeric position in which this publication belongs\nrelative to other works belonging to the same\n<code>belongs-to-collection</code> field.",
16401
"Sets the global direction in which content flows (<code>ltr</code> or\n<code>rtl</code>)",
16402
"iBooks specific metadata options.",
16403
"What is new in this version of the book.",
16404
"Whether this book provides embedded fonts in a flowing or fixed\nlayout book.",
16405
"The scroll direction for this book (<code>vertical</code>,\n<code>horizontal</code>, or <code>default</code>)",
16406
{
16407
"short": "Look in the specified XML file for metadata for the EPUB. The file\nshould contain a series of <a href=\"https://www.dublincore.org/specifications/dublin-core/dces/\">Dublin\nCore elements</a>.",
16408
"long": "Look in the specified XML file for metadata for the EPUB. The file\nshould contain a series of <a href=\"https://www.dublincore.org/specifications/dublin-core/dces/\">Dublin\nCore elements</a>. For example:"
16409
},
16410
"Specify the subdirectory in the OCF container that is to hold the\nEPUB-specific contents. The default is <code>EPUB</code>. To put the\nEPUB contents in the top level, use an empty string.",
16411
{
16412
"short": "Embed the specified fonts in the EPUB",
16413
"long": "Embed the specified fonts in the EPUB. Wildcards can also be used:\nfor example, <code>DejaVuSans-*.ttf</code>. To use the embedded fonts,\nyou will need to add declarations like the following to your CSS:"
16414
},
16415
{
16416
"short": "Specify the heading level at which to split the EPUB into separate\nchapter files.",
16417
"long": "Specify the heading level at which to split the EPUB into separate\nchapter files. The default is to split into chapters at level-1\nheadings. This option only affects the internal composition of the EPUB,\nnot the way chapters and sections are displayed to users. Some readers\nmay be slow if the chapter files are too large, so for large documents\nwith few level-1 headings, one might want to use a chapter level of 2 or\n3."
16418
},
16419
"Use the specified image as the EPUB cover. It is recommended that the\nimage be less than 1000px in width and height.",
16420
"If false, disables the generation of a title page.",
16421
"Engine used for executable code blocks.",
16422
"Configures the Jupyter engine.",
16423
"The name to display in the UI.",
16424
"The name of the language the kernel implements.",
16425
"The name of the kernel.",
16426
"Configures the Julia engine.",
16427
"Arguments to pass to the Julia worker process.",
16428
"Environment variables to pass to the Julia worker process.",
16429
"Set Knitr options.",
16430
"Knit options.",
16431
"Knitr chunk options.",
16432
{
16433
"short": "Cache results of computations.",
16434
"long": "Cache results of computations (using the <a href=\"https://yihui.org/knitr/demo/cache/\">knitr cache</a> for R\ndocuments, and <a href=\"https://jupyter-cache.readthedocs.io/en/latest/\">Jupyter Cache</a>\nfor Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source\ncode (or other cache attributes you’ve defined)."
16435
},
16436
{
16437
"short": "Re-use previous computational output when rendering",
16438
"long": "Control the re-use of previous computational output when\nrendering."
16439
},
16440
"Document server",
16441
"Type of server to run behind the document\n(e.g.&nbsp;<code>shiny</code>)",
16442
"OJS variables to export to server.",
16443
"Server reactive values to import into OJS.",
16444
{
16445
"short": "Run Jupyter kernels within a peristent daemon (to mitigate kernel\nstartup time).",
16446
"long": "Run Jupyter kernels within a peristent daemon (to mitigate kernel\nstartup time). By default a daemon with a timeout of 300 seconds will be\nused. Set <code>daemon</code> to another timeout value or to\n<code>false</code> to disable it altogether."
16447
},
16448
"Restart any running Jupyter daemon before rendering.",
16449
"Enable code cell execution.",
16450
"Execute code cell execution in Jupyter notebooks.",
16451
"Show code-execution related debug information.",
16452
{
16453
"short": "Default width for figures generated by Matplotlib or R graphics",
16454
"long": "Default width for figures generated by Matplotlib or R graphics.\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with document or\nproject metadata."
16455
},
16456
{
16457
"short": "Default height for figures generated by Matplotlib or R graphics",
16458
"long": "Default height for figures generated by Matplotlib or R graphics.\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with document or\nproject metadata."
16459
},
16460
"Default format for figures generated by Matplotlib or R graphics\n(<code>retina</code>, <code>png</code>, <code>jpeg</code>,\n<code>svg</code>, or <code>pdf</code>)",
16461
{
16462
"short": "Default DPI for figures generated by Matplotlib or R graphics",
16463
"long": "Default DPI for figures generated by Matplotlib or R graphics.\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with document or\nproject metadata."
16464
},
16465
{
16466
"short": "The aspect ratio of the plot, i.e., the ratio of height/width.",
16467
"long": "The aspect ratio of the plot, i.e., the ratio of height/width. When\n<code>fig-asp</code> is specified, the height of a plot (the option\n<code>fig-height</code>) is calculated from\n<code>fig-width * fig-asp</code>.\nThe <code>fig-asp</code> option is only available within the knitr\nengine."
16468
},
16469
"Whether to make images in this document responsive.",
16470
{
16471
"short": "Sets the main font for the document.",
16472
"long": "For HTML output, sets the CSS <code>font-family</code> on the HTML\nelement.\nFor LaTeX output, the main font family for use with\n<code>xelatex</code> or <code>lualatex</code>. Takes the name of any\nsystem font, using the <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>\npackage.\nFor ConTeXt output, the main font family. Use the name of any system\nfont. See <a href=\"https://wiki.contextgarden.net/Fonts\">ConTeXt\nFonts</a> for more information."
16473
},
16474
{
16475
"short": "Sets the font used for when displaying code.",
16476
"long": "For HTML output, sets the CSS font-family property on code\nelements.\nFor PowerPoint output, sets the font used for code.\nFor LaTeX output, the monospace font family for use with\n<code>xelatex</code> or <code>lualatex</code>: take the name of any\nsystem font, using the <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>\npackage.\nFor ConTeXt output, the monspace font family. Use the name of any\nsystem font. See <a href=\"https://wiki.contextgarden.net/Fonts\">ConTeXt\nFonts</a> for more information."
16477
},
16478
{
16479
"short": "Sets the font used for code in Typst output.",
16480
"long": "For Typst output, sets the font used for displaying code. Takes the\nname of any font available to Typst (system fonts or fonts in\ndirectories specified by <code>font-paths</code>)."
16481
},
16482
{
16483
"short": "Sets the main font size for the document.",
16484
"long": "For HTML output, sets the base CSS <code>font-size</code>\nproperty.\nFor LaTeX and ConTeXt output, sets the font size for the document\nbody text."
16485
},
16486
{
16487
"short": "Allows font encoding to be specified through <code>fontenc</code>\npackage.",
16488
"long": "Allows font encoding to be specified through <a href=\"https://www.ctan.org/pkg/fontenc\"><code>fontenc</code></a>\npackage.\nSee <a href=\"https://ctan.org/pkg/encguide\">LaTeX Font Encodings\nGuide</a> for addition information on font encoding."
16489
},
16490
{
16491
"short": "Font package to use when compiling a PDF with the\n<code>pdflatex</code> <code>pdf-engine</code>.",
16492
"long": "Font package to use when compiling a PDf with the\n<code>pdflatex</code> <code>pdf-engine</code>.\nSee <a href=\"https://tug.org/FontCatalogue/\">The LaTeX Font\nCatalogue</a> for a summary of font options available.\nFor groff (<code>ms</code>) files, the font family for example,\n<code>T</code> or <code>P</code>."
16493
},
16494
{
16495
"short": "Options for the package used as <code>fontfamily</code>.",
16496
"long": "Options for the package used as <code>fontfamily</code>.\nFor example, to use the Libertine font with proportional lowercase\n(old-style) figures through the <a href=\"https://ctan.org/pkg/libertinus\"><code>libertinus</code></a>\npackage:"
16497
},
16498
{
16499
"short": "The sans serif font family for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16500
"long": "The sans serif font family for use with <code>xelatex</code> or\n<code>lualatex</code>. Takes the name of any system font, using the <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>\npackage."
16501
},
16502
{
16503
"short": "The math font family for use with <code>xelatex</code>,\n<code>lualatex</code>, or Typst.",
16504
"long": "For LaTeX output, the math font family for use with\n<code>xelatex</code> or <code>lualatex</code>. Takes the name of any\nsystem font, using the <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>\npackage.\nFor Typst output, sets the font used for mathematical content."
16505
},
16506
{
16507
"short": "The CJK main font family for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16508
"long": "The CJK main font family for use with <code>xelatex</code> or\n<code>lualatex</code> using the <a href=\"https://ctan.org/pkg/xecjk\"><code>xecjk</code></a> package."
16509
},
16510
{
16511
"short": "The main font options for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16512
"long": "The main font options for use with <code>xelatex</code> or\n<code>lualatex</code> allowing any options available through <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>.\nFor example, to use the <a href=\"http://www.gust.org.pl/projects/e-foundry/tex-gyre\">TeX Gyre</a>\nversion of Palatino with lowercase figures:"
16513
},
16514
{
16515
"short": "The sans serif font options for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16516
"long": "The sans serif font options for use with <code>xelatex</code> or\n<code>lualatex</code> allowing any options available through <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>."
16517
},
16518
{
16519
"short": "The monospace font options for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16520
"long": "The monospace font options for use with <code>xelatex</code> or\n<code>lualatex</code> allowing any options available through <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>."
16521
},
16522
{
16523
"short": "The math font options for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16524
"long": "The math font options for use with <code>xelatex</code> or\n<code>lualatex</code> allowing any options available through <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>."
16525
},
16526
{
16527
"short": "Adds additional directories to search for fonts when compiling with\nTypst.",
16528
"long": "Locally, Typst uses installed system fonts. In addition, some custom\npath can be specified to add directories that should be scanned for\nfonts. Setting this configuration will take precedence over any path set\nin TYPST_FONT_PATHS environment variable."
16529
},
16530
{
16531
"short": "The CJK font options for use with <code>xelatex</code> or\n<code>lualatex</code>.",
16532
"long": "The CJK font options for use with <code>xelatex</code> or\n<code>lualatex</code> allowing any options available through <a href=\"https://ctan.org/pkg/fontspec\"><code>fontspec</code></a>."
16533
},
16534
{
16535
"short": "Options to pass to the microtype package.",
16536
"long": "Options to pass to the <a href=\"https://ctan.org/pkg/microtype\">microtype</a> package."
16537
},
16538
"The point size, for example, <code>10p</code>.",
16539
"The line height, for example, <code>12p</code>.",
16540
{
16541
"short": "Sets the line height or spacing for text in the document.",
16542
"long": "For HTML output sets the CSS <code>line-height</code> property on the\nhtml element, which is preferred to be unitless.\nFor LaTeX output, adjusts line spacing using the <a href=\"https://ctan.org/pkg/setspace\">setspace</a> package, e.g.&nbsp;1.25,\n1.5.\nFor Typst output, adjusts the spacing between lines of text."
16543
},
16544
"Adjusts line spacing using the <code>\\setupinterlinespace</code>\ncommand.",
16545
"The typeface style for links in the document.",
16546
{
16547
"short": "Set the spacing between paragraphs, for example <code>none</code>,\n`small.",
16548
"long": "Set the spacing between paragraphs, for example <code>none</code>,\n<code>small</code> using the <a href=\"https://wiki.contextgarden.net/Command/setupwhitespace\"><code>setupwhitespace</code></a>\ncommand."
16549
},
16550
"Enables a hover popup for footnotes that shows the footnote\ncontents.",
16551
"Causes links to be printed as footnotes.",
16552
{
16553
"short": "Location for footnotes and references",
16554
"long": "Specify location for footnotes. Also controls the location of\nreferences, if <code>reference-links</code> is set."
16555
},
16556
{
16557
"short": "Set the indentation of paragraphs with one or more options.",
16558
"long": "Set the indentation of paragraphs with one or more options.\nSee <a href=\"https://wiki.contextgarden.net/Indentation\">ConTeXt\nIndentation</a> for additional information."
16559
},
16560
"Adjusts text to the left, right, center, or both margins\n(<code>l</code>, <code>r</code>, <code>c</code>, or <code>b</code>).",
16561
{
16562
"short": "Whether to hyphenate text at line breaks even in words that do not\ncontain hyphens.",
16563
"long": "Whether to hyphenate text at line breaks even in words that do not\ncontain hyphens if it is necessary to do so to lay out words on a line\nwithout excessive spacing"
16564
},
16565
"If true, tables are formatted as RST list tables.",
16566
{
16567
"short": "Specify the heading level at which to split the EPUB into separate\nchapter files.",
16568
"long": "Specify the heading level at which to split the EPUB into separate\nchapter files. The default is to split into chapters at level-1\nheadings. This option only affects the internal composition of the EPUB,\nnot the way chapters and sections are displayed to users. Some readers\nmay be slow if the chapter files are too large, so for large documents\nwith few level-1 headings, one might want to use a chapter level of 2 or\n3."
16569
},
16570
"Information about the funding of the research reported in the article\n(for example, grants, contracts, sponsors) and any open access fees for\nthe article itself",
16571
"Displayable prose statement that describes the funding for the\nresearch on which a work was based.",
16572
"Open access provisions that apply to a work or the funding\ninformation that provided the open access provisions.",
16573
"Unique identifier assigned to an award, contract, or grant.",
16574
"The name of this award",
16575
"The description for this award.",
16576
"Agency or organization that funded the research on which a work was\nbased.",
16577
"The text describing the source of the funding.",
16578
{
16579
"short": "Abbreviation for country where source of grant is located.",
16580
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16581
},
16582
"The text describing the source of the funding.",
16583
{
16584
"short": "Abbreviation for country where source of grant is located.",
16585
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16586
},
16587
"Individual(s) or institution(s) to whom the award was given (for\nexample, the principal grant holder or the sponsored individual).",
16588
"The id of an author or affiliation in the document metadata.",
16589
"The name of an individual that was the recipient of the funding.",
16590
"The institution that was the recipient of the funding.",
16591
"The id of an author or affiliation in the document metadata.",
16592
"The name of an individual that was the recipient of the funding.",
16593
"The institution that was the recipient of the funding.",
16594
"Individual(s) responsible for the intellectual content of the work\nreported in the document.",
16595
"The id of an author or affiliation in the document metadata.",
16596
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16597
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16598
"The id of an author or affiliation in the document metadata.",
16599
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16600
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16601
"Unique identifier assigned to an award, contract, or grant.",
16602
"The name of this award",
16603
"The description for this award.",
16604
"Agency or organization that funded the research on which a work was\nbased.",
16605
"The text describing the source of the funding.",
16606
{
16607
"short": "Abbreviation for country where source of grant is located.",
16608
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16609
},
16610
"The text describing the source of the funding.",
16611
{
16612
"short": "Abbreviation for country where source of grant is located.",
16613
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16614
},
16615
"Individual(s) or institution(s) to whom the award was given (for\nexample, the principal grant holder or the sponsored individual).",
16616
"The id of an author or affiliation in the document metadata.",
16617
"The name of an individual that was the recipient of the funding.",
16618
"The institution that was the recipient of the funding.",
16619
"The id of an author or affiliation in the document metadata.",
16620
"The name of an individual that was the recipient of the funding.",
16621
"The institution that was the recipient of the funding.",
16622
"Individual(s) responsible for the intellectual content of the work\nreported in the document.",
16623
"The id of an author or affiliation in the document metadata.",
16624
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16625
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16626
"The id of an author or affiliation in the document metadata.",
16627
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16628
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16629
"Displayable prose statement that describes the funding for the\nresearch on which a work was based.",
16630
"Open access provisions that apply to a work or the funding\ninformation that provided the open access provisions.",
16631
"Unique identifier assigned to an award, contract, or grant.",
16632
"The name of this award",
16633
"The description for this award.",
16634
"Agency or organization that funded the research on which a work was\nbased.",
16635
"The text describing the source of the funding.",
16636
{
16637
"short": "Abbreviation for country where source of grant is located.",
16638
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16639
},
16640
"The text describing the source of the funding.",
16641
{
16642
"short": "Abbreviation for country where source of grant is located.",
16643
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16644
},
16645
"Individual(s) or institution(s) to whom the award was given (for\nexample, the principal grant holder or the sponsored individual).",
16646
"The id of an author or affiliation in the document metadata.",
16647
"The name of an individual that was the recipient of the funding.",
16648
"The institution that was the recipient of the funding.",
16649
"The id of an author or affiliation in the document metadata.",
16650
"The name of an individual that was the recipient of the funding.",
16651
"The institution that was the recipient of the funding.",
16652
"Individual(s) responsible for the intellectual content of the work\nreported in the document.",
16653
"The id of an author or affiliation in the document metadata.",
16654
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16655
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16656
"The id of an author or affiliation in the document metadata.",
16657
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16658
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16659
"Unique identifier assigned to an award, contract, or grant.",
16660
"The name of this award",
16661
"The description for this award.",
16662
"Agency or organization that funded the research on which a work was\nbased.",
16663
"The text describing the source of the funding.",
16664
{
16665
"short": "Abbreviation for country where source of grant is located.",
16666
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16667
},
16668
"The text describing the source of the funding.",
16669
{
16670
"short": "Abbreviation for country where source of grant is located.",
16671
"long": "Abbreviation for country where source of grant is located. Whenever\npossible, ISO 3166-1 2-letter alphabetic codes should be used."
16672
},
16673
"Individual(s) or institution(s) to whom the award was given (for\nexample, the principal grant holder or the sponsored individual).",
16674
"The id of an author or affiliation in the document metadata.",
16675
"The name of an individual that was the recipient of the funding.",
16676
"The institution that was the recipient of the funding.",
16677
"The id of an author or affiliation in the document metadata.",
16678
"The name of an individual that was the recipient of the funding.",
16679
"The institution that was the recipient of the funding.",
16680
"Individual(s) responsible for the intellectual content of the work\nreported in the document.",
16681
"The id of an author or affiliation in the document metadata.",
16682
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16683
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16684
"The id of an author or affiliation in the document metadata.",
16685
"The name of an individual that was responsible for the intellectual\ncontent of the work reported in the document.",
16686
"The institution that was responsible for the intellectual content of\nthe work reported in the document.",
16687
{
16688
"short": "Format to write to (e.g.&nbsp;html)",
16689
"long": "Format to write to. Extensions can be individually enabled or\ndisabled by appending +EXTENSION or -EXTENSION to the format name\n(e.g.&nbsp;gfm+footnotes)"
16690
},
16691
{
16692
"short": "Format to write to (e.g.&nbsp;html)",
16693
"long": "Format to write to. Extensions can be individually enabled or\ndisabled by appending +EXTENSION or -EXTENSION to the format name\n(e.g.&nbsp;gfm+footnotes)"
16694
},
16695
"Input file to read from",
16696
"Input files to read from",
16697
"Include options from the specified defaults files",
16698
"Pandoc metadata variables",
16699
"Pandoc metadata variables",
16700
"Headers to include with HTTP requests by Pandoc",
16701
"Display trace debug output.",
16702
"Exit with error status if there are any warnings.",
16703
"Print information about command-line arguments to <em>stdout</em>,\nthen exit.",
16704
"Ignore command-line arguments (for use in wrapper scripts).",
16705
"Parse each file individually before combining for multifile\ndocuments.",
16706
"Specify the user data directory to search for pandoc data files.",
16707
"Level of program output (<code>INFO</code>, <code>ERROR</code>, or\n<code>WARNING</code>)",
16708
"Write log messages in machine-readable JSON format to FILE.",
16709
{
16710
"short": "Specify what to do with insertions, deletions, and comments produced\nby the MS Word “Track Changes” feature.",
16711
"long": "Specify what to do with insertions, deletions, and comments produced\nby the MS Word “Track Changes” feature."
16712
},
16713
{
16714
"short": "Embed the input file source code in the generated HTML",
16715
"long": "Embed the input file source code in the generated HTML. A hidden div\nwith class <code>quarto-embedded-source-code</code> will be added to the\ndocument. This option is not normally used directly but rather in the\nimplementation of the <code>code-tools</code> option."
16716
},
16717
"Keep hidden source code and output (marked with class\n<code>.hidden</code>)",
16718
{
16719
"short": "Generate HTML output (if necessary) even when targeting markdown.",
16720
"long": "Generate HTML output (if necessary) even when targeting markdown.\nEnables the embedding of more sophisticated output (e.g.&nbsp;Jupyter\nwidgets) in markdown."
16721
},
16722
"Indicates that computational output should not be written within\ndivs. This is necessary for some formats (e.g.&nbsp;<code>pptx</code>) to\nproperly layout figures.",
16723
"Disable merging of string based and file based includes (some\nformats, specifically ePub, do not correctly handle this merging)",
16724
"Content to include at the end of the document header.",
16725
"Content to include at the beginning of the document body (e.g.&nbsp;after\nthe <code>&lt;body&gt;</code> tag in HTML, or the\n<code>\\begin{document}</code> command in LaTeX).",
16726
"Content to include at the end of the document body (before the\n<code>&lt;/body&gt;</code> tag in HTML, or the\n<code>\\end{document}</code> command in LaTeX).",
16727
"Include contents at the beginning of the document body (e.g.&nbsp;after\nthe <code>&lt;body&gt;</code> tag in HTML, or the\n<code>\\begin{document}</code> command in LaTeX).\nA string value or an object with key “file” indicates a filename\nwhose contents are to be included\nAn object with key “text” indicates textual content to be\nincluded",
16728
"Include content at the end of the document body immediately after the\nmarkdown content. While it will be included before the closing\n<code>&lt;/body&gt;</code> tag in HTML and the\n<code>\\end{document}</code> command in LaTeX, this option refers to the\nend of the markdown content.\nA string value or an object with key “file” indicates a filename\nwhose contents are to be included\nAn object with key “text” indicates textual content to be\nincluded",
16729
"Include contents at the end of the header. This can be used, for\nexample, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename\nwhose contents are to be included\nAn object with key “text” indicates textual content to be\nincluded",
16730
"Path (or glob) to files to publish with this document.",
16731
{
16732
"short": "Text to be in a running header.",
16733
"long": "Text to be in a running header.\nProvide a single option or up to four options for different\nplacements (odd page inner, odd page outer, even page innner, even page\nouter)."
16734
},
16735
{
16736
"short": "Text to be in a running footer.",
16737
"long": "Text to be in a running footer.\nProvide a single option or up to four options for different\nplacements (odd page inner, odd page outer, even page innner, even page\nouter).\nSee <a href=\"https://wiki.contextgarden.net/Headers_and_Footers\">ConTeXt\nHeaders and Footers</a> for more information."
16738
},
16739
"Whether to include all source documents as file attachments in the\nPDF file.",
16740
"The footer for man pages.",
16741
"The header for man pages.",
16742
{
16743
"short": "Include file with YAML metadata",
16744
"long": "Read metadata from the supplied YAML (or JSON) file. This option can\nbe used with every input format, but string scalars in the YAML file\nwill always be parsed as Markdown. Generally, the input will be handled\nthe same as in YAML metadata blocks. Metadata values specified inside\nthe document, or by using <code>-M</code>, overwrite values specified\nwith this option."
16745
},
16746
{
16747
"short": "Include files with YAML metadata",
16748
"long": "Read metadata from the supplied YAML (or JSON) files. This option can\nbe used with every input format, but string scalars in the YAML file\nwill always be parsed as Markdown. Generally, the input will be handled\nthe same as in YAML metadata blocks. Values in files specified later in\nthe list will be preferred over those specified earlier. Metadata values\nspecified inside the document, or by using <code>-M</code>, overwrite\nvalues specified with this option."
16749
},
16750
{
16751
"short": "Identifies the main language of the document (e.g.&nbsp;<code>en</code> or\n<code>en-GB</code>).",
16752
"long": "Identifies the main language of the document using IETF language tags\n(following the <a href=\"https://www.rfc-editor.org/info/bcp47\">BCP\n47</a> standard), such as <code>en</code> or <code>en-GB</code>. The <a href=\"https://r12a.github.io/app-subtags/\">Language subtag lookup</a>\ntool can look up or verify these tags.\nThis affects most formats, and controls hyphenation in PDF output\nwhen using LaTeX (through <a href=\"https://ctan.org/pkg/babel\"><code>babel</code></a> and <a href=\"https://ctan.org/pkg/polyglossia\"><code>polyglossia</code></a>) or\nConTeXt."
16753
},
16754
"YAML file containing custom language translations",
16755
{
16756
"short": "Enable babel language-specific shorthands in LaTeX output.",
16757
"long": "Enable babel language-specific shorthands in LaTeX output. When\n<code>true</code>, babel’s language shortcuts are enabled (e.g., French\n<code>&lt;&lt;</code>/<code>&gt;&gt;</code> for guillemets, German\n<code>\"</code> shortcuts, proper spacing around French punctuation).\nDefault is <code>false</code> because language shorthands can\ninterfere with code blocks and other content. Only enable if you need\nspecific typographic features for your language."
16758
},
16759
{
16760
"short": "The base script direction for the document (<code>rtl</code> or\n<code>ltr</code>).",
16761
"long": "The base script direction for the document (<code>rtl</code> or\n<code>ltr</code>).\nFor bidirectional documents, native pandoc <code>span</code>s and\n<code>div</code>s with the <code>dir</code> attribute can be used to\noverride the base direction in some output formats. This may not always\nbe necessary if the final renderer (e.g.&nbsp;the browser, when generating\nHTML) supports the [Unicode Bidirectional Algorithm].\nWhen using LaTeX for bidirectional documents, only the\n<code>xelatex</code> engine is fully supported (use\n<code>--pdf-engine=xelatex</code>)."
16762
},
16763
{
16764
"short": "Use Quarto’s built-in PDF rendering wrapper",
16765
"long": "Use Quarto’s built-in PDF rendering wrapper (includes support for\nautomatically installing missing LaTeX packages)"
16766
},
16767
"Enable/disable automatic LaTeX package installation",
16768
"Minimum number of compilation passes.",
16769
"Maximum number of compilation passes.",
16770
"Clean intermediates after compilation.",
16771
"Program to use for <code>makeindex</code>.",
16772
"Array of command line options for <code>makeindex</code>.",
16773
"Array of command line options for <code>tlmgr</code>.",
16774
"Output directory for intermediates and PDF.",
16775
"Set to <code>false</code> to prevent an installation of TinyTex from\nbeing used to compile PDF documents.",
16776
"Array of paths LaTeX should search for inputs.",
16777
"The document class.",
16778
{
16779
"short": "Options for the document class,",
16780
"long": "For LaTeX/PDF output, the options set for the document class.\nFor HTML output using KaTeX, you can render display math equations\nflush left using <code>classoption: fleqn</code>"
16781
},
16782
"Control the <code>\\pagestyle{}</code> for the document.",
16783
"The paper size for the document.",
16784
"The brand mode to use for rendering the document, <code>light</code>\nor <code>dark</code>.",
16785
{
16786
"short": "The options for margins and text layout for this document.",
16787
"long": "The options for margins and text layout for this document.\nSee <a href=\"https://wiki.contextgarden.net/Layout\">ConTeXt\nLayout</a> for additional information."
16788
},
16789
"The page layout to use for this document (<code>article</code>,\n<code>full</code>, or <code>custom</code>)",
16790
{
16791
"short": "Target page width for output (used to compute columns widths for\n<code>layout</code> divs)",
16792
"long": "Target body page width for output (used to compute columns widths for\n<code>layout</code> divs). Defaults to 6.5 inches, which corresponds to\ndefault letter page settings in docx and odt (8.5 inches with 1 inch for\neach margins)."
16793
},
16794
{
16795
"short": "Properties of the grid system used to layout Quarto HTML and Typst\npages.",
16796
"long": ""
16797
},
16798
"Defines whether to use the standard, slim, or full content grid or to\nautomatically select the most appropriate content grid.",
16799
"The base width of the sidebar (left) column in an HTML page.",
16800
"The base width of the margin (right) column. For Typst, this controls\nthe width of the margin note column.",
16801
"The base width of the body (center) column. For Typst, this is\ncomputed as the remainder after other columns.",
16802
"The width of the gutter that appears between columns. For Typst, this\nis the gap between the text column and margin notes.",
16803
{
16804
"short": "The layout of the appendix for this document (<code>none</code>,\n<code>plain</code>, or <code>default</code>)",
16805
"long": "The layout of the appendix for this document (<code>none</code>,\n<code>plain</code>, or <code>default</code>).\nTo completely disable any styling of the appendix, choose the\nappendix style <code>none</code>. For minimal styling, choose\n<code>plain.</code>"
16806
},
16807
{
16808
"short": "Controls the formats which are provided in the citation section of\nthe appendix (<code>false</code>, <code>display</code>, or\n<code>bibtex</code>).",
16809
"long": "Controls the formats which are provided in the citation section of\nthe appendix.\nUse <code>false</code> to disable the display of the ‘cite as’\nappendix. Pass one or more of <code>display</code> or\n<code>bibtex</code> to enable that format in ‘cite as’ appendix."
16810
},
16811
{
16812
"short": "The layout of the title block for this document (<code>none</code>,\n<code>plain</code>, or <code>default</code>).",
16813
"long": "The layout of the title block for this document (<code>none</code>,\n<code>plain</code>, or <code>default</code>).\nTo completely disable any styling of the title block, choose the\nstyle <code>none</code>. For minimal styling, choose\n<code>plain.</code>"
16814
},
16815
{
16816
"short": "Apply a banner style treatment to the title block.",
16817
"long": "Applies a banner style treatment for the title block. You may specify\none of the following values:"
16818
},
16819
{
16820
"short": "Sets the color of text elements in a banner style title block.",
16821
"long": "Sets the color of text elements in a banner style title block. Use\none of the following values:"
16822
},
16823
{
16824
"short": "Enables or disables the display of categories in the title block.",
16825
"long": ""
16826
},
16827
"Adds a css <code>max-width</code> to the body Element.",
16828
{
16829
"short": "Sets the left margin of the document.",
16830
"long": "For HTML output, sets the <code>margin-left</code> property on the\nBody element.\nFor LaTeX output, sets the left margin if <code>geometry</code> is\nnot used (otherwise <code>geometry</code> overrides this value)\nFor ConTeXt output, sets the left margin if <code>layout</code> is\nnot used, otherwise <code>layout</code> overrides these.\nFor <code>wkhtmltopdf</code> sets the left page margin."
16831
},
16832
{
16833
"short": "Sets the right margin of the document.",
16834
"long": "For HTML output, sets the <code>margin-right</code> property on the\nBody element.\nFor LaTeX output, sets the right margin if <code>geometry</code> is\nnot used (otherwise <code>geometry</code> overrides this value)\nFor ConTeXt output, sets the right margin if <code>layout</code> is\nnot used, otherwise <code>layout</code> overrides these.\nFor <code>wkhtmltopdf</code> sets the right page margin."
16835
},
16836
{
16837
"short": "Sets the top margin of the document.",
16838
"long": "For HTML output, sets the <code>margin-top</code> property on the\nBody element.\nFor LaTeX output, sets the top margin if <code>geometry</code> is not\nused (otherwise <code>geometry</code> overrides this value)\nFor ConTeXt output, sets the top margin if <code>layout</code> is not\nused, otherwise <code>layout</code> overrides these.\nFor <code>wkhtmltopdf</code> sets the top page margin."
16839
},
16840
{
16841
"short": "Sets the bottom margin of the document.",
16842
"long": "For HTML output, sets the <code>margin-bottom</code> property on the\nBody element.\nFor LaTeX output, sets the bottom margin if <code>geometry</code> is\nnot used (otherwise <code>geometry</code> overrides this value)\nFor ConTeXt output, sets the bottom margin if <code>layout</code> is\nnot used, otherwise <code>layout</code> overrides these.\nFor <code>wkhtmltopdf</code> sets the bottom page margin."
16843
},
16844
{
16845
"short": "Margin settings for Reveal.js or Typst output.",
16846
"long": "For <code>revealjs</code>, the factor of the display size that should\nremain empty around the content (e.g.&nbsp;0.1).\nFor <code>typst</code>, a dictionary specifying page margins. Use\n<code>x</code> and <code>y</code> for symmetric horizontal/vertical\nmargins, or <code>top</code>, <code>bottom</code>, <code>left</code>,\n<code>right</code> for individual sides. Values should include units\n(e.g.&nbsp;<code>1.5in</code>, <code>2cm</code>)."
16847
},
16848
"Horizontal margin (e.g.&nbsp;1.5in)",
16849
"Vertical margin (e.g.&nbsp;1.5in)",
16850
"Top margin (e.g.&nbsp;1.5in)",
16851
"Bottom margin (e.g.&nbsp;1.5in)",
16852
"Left margin (e.g.&nbsp;1.5in)",
16853
"Right margin (e.g.&nbsp;1.5in)",
16854
{
16855
"short": "Options for the geometry package.",
16856
"long": "Options for the <a href=\"https://ctan.org/pkg/geometry\">geometry</a>\npackage. For example:"
16857
},
16858
{
16859
"short": "Additional non-color options for the hyperref package.",
16860
"long": "Options for the <a href=\"https://ctan.org/pkg/hyperref\">hyperref</a>\npackage. For example:"
16861
},
16862
{
16863
"short": "Whether to use document class settings for indentation.",
16864
"long": "Whether to use document class settings for indentation. If the\ndocument class settings are not used, the default LaTeX template removes\nindentation and adds space between paragraphs\nFor groff (<code>ms</code>) documents, the paragraph indent, for\nexample, <code>2m</code>."
16865
},
16866
{
16867
"short": "Make <code>\\paragraph</code> and <code>\\subparagraph</code>\nfree-standing rather than run-in.",
16868
"long": "Make <code>\\paragraph</code> and <code>\\subparagraph</code> (fourth-\nand fifth-level headings, or fifth- and sixth-level with book classes)\nfree-standing rather than run-in; requires further formatting to\ndistinguish from <code>\\subsubsection</code> (third- or fourth-level\nheadings). Instead of using this option, <a href=\"https://ctan.org/pkg/koma-script\">KOMA-Script</a> can adjust\nheadings more extensively:"
16869
},
16870
"Directory containing reveal.js files.",
16871
"The base url for s5 presentations.",
16872
"The base url for Slidy presentations.",
16873
"The base url for Slideous presentations.",
16874
"Enable or disable lightbox treatment for images in this document. See\n<a href=\"https://quarto.org/docs/output-formats/html-lightbox-figures.html\">Lightbox\nFigures</a> for more details.",
16875
{
16876
"short": "Set this to <code>auto</code> if you’d like any image to be given\nlightbox treatment.",
16877
"long": "Set this to <code>auto</code> if you’d like any image to be given\nlightbox treatment. If you omit this, only images with the class\n<code>lightbox</code> will be given the lightbox treatment."
16878
},
16879
"The effect that should be used when opening and closing the lightbox.\nOne of <code>fade</code>, <code>zoom</code>, <code>none</code>. Defaults\nto <code>zoom</code>.",
16880
"The position of the title and description when displaying a lightbox.\nOne of <code>top</code>, <code>bottom</code>, <code>left</code>,\n<code>right</code>. Defaults to <code>bottom</code>.",
16881
"Whether galleries should ‘loop’ to first image in the gallery if the\nuser continues past the last image of the gallery. Boolean that defaults\nto <code>true</code>.",
16882
"A class name to apply to the lightbox to allow css targeting. This\nwill replace the lightbox class with your custom class name.",
16883
"Show a special icon next to links that leave the current site.",
16884
"Open external links in a new browser window or tab (rather than\nnavigating the current tab).",
16885
{
16886
"short": "A regular expression that can be used to determine whether a link is\nan internal link.",
16887
"long": "A regular expression that can be used to determine whether a link is\nan internal link. For example, the following will treat links that start\nwith <code>http://www.quarto.org/custom</code> or\n<code>https://www.quarto.org/custom</code> as internal links (and others\nwill be considered external):"
16888
},
16889
{
16890
"short": "Controls whether links to other rendered formats are displayed in\nHTML output.",
16891
"long": "Controls whether links to other rendered formats are displayed in\nHTML output.\nPass <code>false</code> to disable the display of format lengths or\npass a list of format names for which you’d like links to be shown."
16892
},
16893
"The title for the link.",
16894
"The href for the link.",
16895
"The icon for the link.",
16896
"The format that this link represents.",
16897
"The title for this link.",
16898
"The icon for this link.",
16899
"The title for the link.",
16900
"The href for the link.",
16901
"The icon for the link.",
16902
"The format that this link represents.",
16903
"The title for this link.",
16904
"The icon for this link.",
16905
{
16906
"short": "Controls the display of links to notebooks that provided embedded\ncontent or are created from documents.",
16907
"long": "Controls the display of links to notebooks that provided embedded\ncontent or are created from documents.\nSpecify <code>false</code> to disable linking to source Notebooks.\nSpecify <code>inline</code> to show links to source notebooks beneath\nthe content they provide. Specify <code>global</code> to show a set of\nglobal links to source notebooks."
16908
},
16909
"A list of links that should be displayed below the table of contents\nin an <code>Other Links</code> section.",
16910
"A list of links that should be displayed below the table of contents\nin an <code>Code Links</code> section.",
16911
{
16912
"short": "Controls whether referenced notebooks are embedded in JATS output as\nsubarticles.",
16913
"long": "Controls the display of links to notebooks that provided embedded\ncontent or are created from documents.\nDefaults to <code>true</code> - specify <code>false</code> to disable\nembedding Notebook as subarticles with the JATS output."
16914
},
16915
"Configures the HTML viewer for notebooks that provide embedded\ncontent.",
16916
"The style of document to render. Setting this to\n<code>notebook</code> will create additional notebook style\naffordances.",
16917
"Options for controlling the display and behavior of Notebook\npreviews.",
16918
"Whether to show a back button in the notebook preview.",
16919
{
16920
"short": "Include a canonical link tag in website pages",
16921
"long": "Include a canonical link tag in website pages. You may pass either\n<code>true</code> to automatically generate a canonical link, or pass a\ncanonical url that you’d like to have placed in the <code>href</code>\nattribute of the tag.\nCanonical links can only be generated for websites with a known\n<code>site-url</code>."
16922
},
16923
"Automatically generate the contents of a page from a list of Quarto\ndocuments or other custom data.",
16924
"Mermaid diagram options",
16925
"The mermaid built-in theme to use.",
16926
"List of keywords to be included in the document metadata.",
16927
"The document subject",
16928
"The document description. Some applications show this as\n<code>Comments</code> metadata.",
16929
"The document category.",
16930
"The copyright for this document, if any.",
16931
"The year for this copyright",
16932
"The holder of the copyright.",
16933
"The holder of the copyright.",
16934
"The text to display for the license.",
16935
"The text to display for the license.",
16936
{
16937
"short": "The License for this document, if any. (e.g.&nbsp;<code>CC BY</code>)",
16938
"long": "The license for this document, if any.\nCreative Commons licenses <code>CC BY</code>, <code>CC BY-SA</code>,\n<code>CC BY-ND</code>, <code>CC BY-NC</code>, <code>CC BY-NC-SA</code>,\nand <code>CC BY-NC-ND</code> will automatically generate a license link\nin the document appendix. Other license text will be placed in the\nappendix verbatim."
16939
},
16940
"The type of the license.",
16941
"A URL to the license.",
16942
"The text to display for the license.",
16943
"The type of the license.",
16944
"A URL to the license.",
16945
"The text to display for the license.",
16946
"Sets the title metadata for the document",
16947
"Sets the title metadata for the document",
16948
"Specify STRING as a prefix at the beginning of the title that appears\nin the HTML header (but not in the title as it appears at the beginning\nof the body)",
16949
"Sets the description metadata for the document",
16950
"Sets the author metadata for the document",
16951
"Sets the date metadata for the document",
16952
{
16953
"short": "Number section headings",
16954
"long": "Number section headings rendered output. By default, sections are not\nnumbered. Sections with class <code>.unnumbered</code> will never be\nnumbered, even if <code>number-sections</code> is specified."
16955
},
16956
{
16957
"short": "The depth to which sections should be numbered.",
16958
"long": "By default, all headings in your document create a numbered section.\nYou customize numbering depth using the <code>number-depth</code>\noption.\nFor example, to only number sections immediately below the chapter\nlevel, use this:"
16959
},
16960
"The numbering depth for sections. (Use <code>number-depth</code>\ninstead).",
16961
{
16962
"short": "Offset for section headings in output (offsets are 0 by default)",
16963
"long": "Offset for section headings in output (offsets are 0 by default) The\nfirst number is added to the section number for top-level headings, the\nsecond for second-level headings, and so on. So, for example, if you\nwant the first top-level heading in your document to be numbered “6”,\nspecify <code>number-offset: 5</code>. If your document starts with a\nlevel-2 heading which you want to be numbered “1.5”, specify\n<code>number-offset: [1,4]</code>. Implies\n<code>number-sections</code>"
16964
},
16965
"Schema to use for numbering sections, e.g.&nbsp;<code>1.A.1</code>",
16966
{
16967
"short": "Shift heading levels by a positive or negative integer. For example,\nwith <code>shift-heading-level-by: -1</code>, level 2 headings become\nlevel 1 headings.",
16968
"long": "Shift heading levels by a positive or negative integer. For example,\nwith <code>shift-heading-level-by: -1</code>, level 2 headings become\nlevel 1 headings, and level 3 headings become level 2 headings. Headings\ncannot have a level less than 1, so a heading that would be shifted\nbelow level 1 becomes a regular paragraph. Exception: with a shift of\n-N, a level-N heading at the beginning of the document replaces the\nmetadata title."
16969
},
16970
{
16971
"short": "Schema to use for numbering pages, e.g.&nbsp;<code>1</code> or\n<code>i</code>, or <code>false</code> to omit page numbering.",
16972
"long": "Schema to use for numbering pages, e.g.&nbsp;<code>1</code> or\n<code>i</code>, or <code>false</code> to omit page numbering.\nSee <a href=\"https://typst.app/docs/reference/model/numbering/\">Typst\nNumbering</a> for additional information."
16973
},
16974
{
16975
"short": "Sets the page numbering style and location for the document.",
16976
"long": "Sets the page numbering style and location for the document using the\n<code>\\setuppagenumbering</code> command.\nSee <a href=\"https://wiki.contextgarden.net/Command/setuppagenumbering\">ConTeXt\nPage Numbering</a> for additional information."
16977
},
16978
{
16979
"short": "Treat top-level headings as the given division type\n(<code>default</code>, <code>section</code>, <code>chapter</code>, or\n<code>part</code>). The hierarchy order is part, chapter, then section;\nall headings are shifted such that the top-level heading becomes the\nspecified type.",
16980
"long": "Treat top-level headings as the given division type\n(<code>default</code>, <code>section</code>, <code>chapter</code>, or\n<code>part</code>). The hierarchy order is part, chapter, then section;\nall headings are shifted such that the top-level heading becomes the\nspecified type.\nThe default behavior is to determine the best division type via\nheuristics: unless other conditions apply, <code>section</code> is\nchosen. When the <code>documentclass</code> variable is set to\n<code>report</code>, <code>book</code>, or <code>memoir</code> (unless\nthe <code>article</code> option is specified), <code>chapter</code> is\nimplied as the setting for this option. If <code>beamer</code> is the\noutput format, specifying either <code>chapter</code> or\n<code>part</code> will cause top-level headings to become\n<code>\\part{..}</code>, while second-level headings remain as their\ndefault type."
16981
},
16982
"If <code>true</code>, force the presence of the OJS runtime. If\n<code>false</code>, force the absence instead. If unset, the OJS runtime\nis included only if OJS cells are present in the document.",
16983
"Use the specified file as a style reference in producing a docx,\npptx, or odt file.",
16984
"Branding information to use for this document. If a string, the path\nto a brand file. If false, don’t use branding on this document. If an\nobject, an inline brand definition, or an object with light and dark\nbrand paths or definitions.",
16985
"Theme name, theme scss file, or a mix of both.",
16986
"The light theme name, theme scss file, or a mix of both.",
16987
"The light theme name, theme scss file, or a mix of both.",
16988
"The dark theme name, theme scss file, or a mix of both.",
16989
"The dark theme name, theme scss file, or a mix of both.",
16990
"Classes to apply to the body of the document.",
16991
"Disables the built in html features like theming, anchor sections,\ncode block behavior, and more.",
16992
"Enables inclusion of Pandoc default CSS for this document.",
16993
"One or more CSS style sheets.",
16994
"Enables hover over a section title to see an anchor link.",
16995
"Enables tabsets to present content.",
16996
"Enables smooth scrolling within the page.",
16997
{
16998
"short": "Enables setting dark mode based on the\n<code>prefers-color-scheme</code> media query.",
16999
"long": "If set, Quarto reads the <code>prefers-color-scheme</code> media\nquery to determine whether to show the user a dark or light page.\nOtherwise the author-preferred color scheme is shown."
17000
},
17001
{
17002
"short": "Method use to render math in HTML output",
17003
"long": "Method use to render math in HTML output (<code>plain</code>,\n<code>webtex</code>, <code>gladtex</code>, <code>mathml</code>,\n<code>mathjax</code>, <code>katex</code>).\nSee the Pandoc documentation on <a href=\"https://pandoc.org/MANUAL.html#math-rendering-in-html\">Math\nRendering in HTML</a> for additional details."
17004
},
17005
"Wrap sections in <code>&lt;section&gt;</code> tags and attach\nidentifiers to the enclosing <code>&lt;section&gt;</code> rather than\nthe heading itself.",
17006
{
17007
"short": "Specify a prefix to be added to all identifiers and internal\nlinks.",
17008
"long": "Specify a prefix to be added to all identifiers and internal links in\nHTML and DocBook output, and to footnote numbers in Markdown and Haddock\noutput. This is useful for preventing duplicate identifiers when\ngenerating fragments to be included in other pages."
17009
},
17010
{
17011
"short": "Method for obfuscating mailto: links in HTML documents.",
17012
"long": "Specify a method for obfuscating <code>mailto:</code> links in HTML\ndocuments."
17013
},
17014
"Use <code>&lt;q&gt;</code> tags for quotes in HTML.",
17015
{
17016
"short": "Use the specified engine when producing PDF output.",
17017
"long": "Use the specified engine when producing PDF output. If the engine is\nnot in your PATH, the full path of the engine may be specified here. If\nthis option is not specified, Quarto uses the following defaults\ndepending on the output format in use:"
17018
},
17019
{
17020
"short": "Use the given string as a command-line argument to the\n<code>pdf-engine</code>.",
17021
"long": "Use the given string as a command-line argument to the pdf-engine.\nFor example, to use a persistent directory foo for latexmk’s auxiliary\nfiles, use <code>pdf-engine-opt: -outdir=foo</code>. Note that no check\nfor duplicate options is done."
17022
},
17023
{
17024
"short": "Pass multiple command-line arguments to the\n<code>pdf-engine</code>.",
17025
"long": "Use the given strings passed as a array as command-line arguments to\nthe pdf-engine. This is an alternative to <code>pdf-engine-opt</code>\nfor passing multiple options."
17026
},
17027
"Whether to produce a Beamer article from this presentation.",
17028
"Add an extra Beamer option using <code>\\setbeameroption{}</code>.",
17029
"The aspect ratio for this presentation.",
17030
"The logo image.",
17031
"The image for the title slide.",
17032
"Controls navigation symbols for the presentation (<code>empty</code>,\n<code>frame</code>, <code>vertical</code>, or\n<code>horizontal</code>)",
17033
"Whether to enable title pages for new sections.",
17034
"The Beamer color theme for this presentation, passed to\n<code>\\usecolortheme</code>.",
17035
"The Beamer color theme options for this presentation, passed to\n<code>\\usecolortheme</code>.",
17036
"The Beamer font theme for this presentation, passed to\n<code>\\usefonttheme</code>.",
17037
"The Beamer font theme options for this presentation, passed to\n<code>\\usefonttheme</code>.",
17038
"The Beamer inner theme for this presentation, passed to\n<code>\\useinnertheme</code>.",
17039
"The Beamer inner theme options for this presentation, passed to\n<code>\\useinnertheme</code>.",
17040
"The Beamer outer theme for this presentation, passed to\n<code>\\useoutertheme</code>.",
17041
"The Beamer outer theme options for this presentation, passed to\n<code>\\useoutertheme</code>.",
17042
"Options passed to LaTeX Beamer themes inside\n<code>\\usetheme</code>.",
17043
"The section number in man pages.",
17044
"Enable and disable extensions for markdown output (e.g.&nbsp;“+emoji”)",
17045
"Specify whether to use <code>atx</code> (<code>#</code>-prefixed) or\n<code>setext</code> (underlined) headings for level 1 and 2 headings\n(<code>atx</code> or <code>setext</code>).",
17046
{
17047
"short": "Determines which ipynb cell output formats are rendered\n(<code>none</code>, <code>all</code>, or <code>best</code>).",
17048
"long": "Determines which ipynb cell output formats are rendered."
17049
},
17050
{
17051
"short": "semver version range for required quarto version",
17052
"long": "A semver version range describing the supported quarto versions for\nthis document or project.\nExamples:"
17053
},
17054
{
17055
"short": "The mode to use when previewing this document.",
17056
"long": "The mode to use when previewing this document. To disable any special\npreviewing features, pass <code>raw</code> as the preview-mode."
17057
},
17058
{
17059
"short": "Adds the necessary setup to the document preamble to generate PDF/A\nof the type specified.",
17060
"long": "Adds the necessary setup to the document preamble to generate PDF/A\nof the type specified.\nIf the value is set to <code>true</code>, <code>1b:2005</code> will\nbe used as default.\nTo successfully generate PDF/A the required ICC color profiles have\nto be available and the content and all included files (such as images)\nhave to be standard conforming. The ICC profiles and output intent may\nbe specified using the variables <code>pdfaiccprofile</code> and\n<code>pdfaintent</code>. See also <a href=\"https://wiki.contextgarden.net/PDF/A\">ConTeXt PDFA</a> for more\ndetails."
17061
},
17062
{
17063
"short": "When used in conjunction with <code>pdfa</code>, specifies the ICC\nprofile to use in the PDF, e.g.&nbsp;<code>default.cmyk</code>.",
17064
"long": "When used in conjunction with <code>pdfa</code>, specifies the ICC\nprofile to use in the PDF, e.g.&nbsp;<code>default.cmyk</code>.\nIf left unspecified, <code>sRGB.icc</code> is used as default. May be\nrepeated to include multiple profiles. Note that the profiles have to be\navailable on the system. They can be obtained from <a href=\"https://wiki.contextgarden.net/PDFX#ICC_profiles\">ConTeXt ICC\nProfiles</a>."
17065
},
17066
{
17067
"short": "When used in conjunction with <code>pdfa</code>, specifies the output\nintent for the colors.",
17068
"long": "When used in conjunction with <code>pdfa</code>, specifies the output\nintent for the colors, for example\n<code>ISO coated v2 300\\letterpercent\\space (ECI)</code>\nIf left unspecified, <code>sRGB IEC61966-2.1</code> is used as\ndefault."
17069
},
17070
{
17071
"short": "PDF conformance standard (e.g., ua-2, a-2b, 1.7)",
17072
"long": "Specifies PDF conformance standards and/or version for the\noutput.\nAccepts a single value or array of values:\n<strong>PDF versions</strong> (both Typst and LaTeX):\n<code>1.4</code>, <code>1.5</code>, <code>1.6</code>, <code>1.7</code>,\n<code>2.0</code>\n<strong>PDF/A standards</strong> (both engines): <code>a-1b</code>,\n<code>a-2a</code>, <code>a-2b</code>, <code>a-2u</code>,\n<code>a-3a</code>, <code>a-3b</code>, <code>a-3u</code>,\n<code>a-4</code>, <code>a-4f</code>\n<strong>PDF/A standards</strong> (Typst only): <code>a-1a</code>,\n<code>a-4e</code>\n<strong>PDF/UA standards</strong>: <code>ua-1</code> (Typst),\n<code>ua-2</code> (LaTeX)\n<strong>PDF/X standards</strong> (LaTeX only): <code>x-4</code>,\n<code>x-4p</code>, <code>x-5g</code>, <code>x-5n</code>,\n<code>x-5pg</code>, <code>x-6</code>, <code>x-6n</code>,\n<code>x-6p</code>\nExample: <code>pdf-standard: [a-2b, ua-2]</code> for accessible\narchival PDF."
17073
},
17074
"Document bibliography (BibTeX or CSL). May be a single file or a list\nof files",
17075
"Citation Style Language file to use for formatting references.",
17076
"Enables a hover popup for citation that shows the reference\ninformation.",
17077
"Where citation information should be displayed (<code>document</code>\nor <code>margin</code>)",
17078
"Method used to format citations (<code>citeproc</code>,\n<code>natbib</code>, or <code>biblatex</code>).",
17079
{
17080
"short": "Turn on built-in citation processing",
17081
"long": "Turn on built-in citation processing. To use this feature, you will\nneed to have a document containing citations and a source of\nbibliographic data: either an external bibliography file or a list of\n<code>references</code> in the document’s YAML metadata. You can\noptionally also include a <code>csl</code> citation style file."
17082
},
17083
"A list of options for BibLaTeX.",
17084
"One or more options to provide for <code>natbib</code> when\ngenerating a bibliography.",
17085
"The bibliography style to use\n(e.g.&nbsp;<code>\\bibliographystyle{dinat}</code>) when using\n<code>natbib</code> or <code>biblatex</code>.",
17086
"The bibliography style to use\n(e.g.&nbsp;<code>#set bibliography(style: \"apa\")</code>) when using typst\nbuilt-in citation system (e.g when not <code>citeproc: true</code>).",
17087
"The bibliography title to use when using <code>natbib</code> or\n<code>biblatex</code>.",
17088
"Controls whether to output bibliography configuration for\n<code>natbib</code> or <code>biblatex</code> when cite method is not\n<code>citeproc</code>.",
17089
{
17090
"short": "JSON file containing abbreviations of journals that should be used in\nformatted bibliographies.",
17091
"long": "JSON file containing abbreviations of journals that should be used in\nformatted bibliographies when <code>form=\"short\"</code> is specified.\nThe format of the file can be illustrated with an example:"
17092
},
17093
"If true, citations will be hyperlinked to the corresponding\nbibliography entries (for author-date and numerical styles only).\nDefaults to false.",
17094
{
17095
"short": "If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be\nrendered as hyperlinks.",
17096
"long": "If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be\nrendered as hyperlinks. (If an entry contains a DOI, PMCID, PMID, or\nURL, but none of these fields are rendered by the style, then the title,\nor in the absence of a title the whole entry, will be hyperlinked.)\nDefaults to true."
17097
},
17098
{
17099
"short": "Places footnote references or superscripted numerical citations after\nfollowing punctuation.",
17100
"long": "If true (the default for note styles), Quarto (via Pandoc) will put\nfootnote references or superscripted numerical citations after following\npunctuation. For example, if the source contains\n<code>blah blah [@jones99]</code>., the result will look like\n<code>blah blah.[^1]</code>, with the note moved after the period and\nthe space collapsed.\nIf false, the space will still be collapsed, but the footnote will\nnot be moved after the punctuation. The option may also be used in\nnumerical styles that use superscripts for citation numbers (but for\nthese styles the default is not to move the citation)."
17101
},
17102
{
17103
"short": "Format to read from",
17104
"long": "Format to read from. Extensions can be individually enabled or\ndisabled by appending +EXTENSION or -EXTENSION to the format name\n(e.g.&nbsp;markdown+emoji)."
17105
},
17106
{
17107
"short": "Format to read from",
17108
"long": "Format to read from. Extensions can be individually enabled or\ndisabled by appending +EXTENSION or -EXTENSION to the format name\n(e.g.&nbsp;markdown+emoji)."
17109
},
17110
"Output file to write to",
17111
"Extension to use for generated output file",
17112
"Use the specified file as a custom template for the generated\ndocument.",
17113
"Include the specified files as partials accessible to the template\nfor the generated content.",
17114
{
17115
"short": "Produce a standalone HTML file with no external dependencies",
17116
"long": "Produce a standalone HTML file with no external dependencies, using\n<code>data:</code> URIs to incorporate the contents of linked scripts,\nstylesheets, images, and videos. The resulting file should be\n“self-contained,” in the sense that it needs no external files and no\nnet access to be displayed properly by a browser. This option works only\nwith HTML output formats, including <code>html4</code>,\n<code>html5</code>, <code>html+lhs</code>, <code>html5+lhs</code>,\n<code>s5</code>, <code>slidy</code>, <code>slideous</code>,\n<code>dzslides</code>, and <code>revealjs</code>. Scripts, images, and\nstylesheets at absolute URLs will be downloaded; those at relative URLs\nwill be sought relative to the working directory (if the first source\nfile is local) or relative to the base URL (if the first source file is\nremote). Elements with the attribute <code>data-external=\"1\"</code> will\nbe left alone; the documents they link to will not be incorporated in\nthe document. Limitation: resources that are loaded dynamically through\nJavaScript cannot be incorporated; as a result, some advanced features\n(e.g.&nbsp;zoom or speaker notes) may not work in an offline “self-contained”\n<code>reveal.js</code> slide show."
17117
},
17118
{
17119
"short": "Produce a standalone HTML file with no external dependencies",
17120
"long": "Produce a standalone HTML file with no external dependencies. Note\nthat this option has been deprecated in favor of\n<code>embed-resources</code>."
17121
},
17122
{
17123
"short": "Embed math libraries (e.g.&nbsp;MathJax) within\n<code>self-contained</code> output.",
17124
"long": "Embed math libraries (e.g.&nbsp;MathJax) within\n<code>self-contained</code> output. Note that math libraries are not\nembedded by default because they are quite large and often time\nconsuming to download."
17125
},
17126
"Specify executables or Lua scripts to be used as a filter\ntransforming the pandoc AST after the input is parsed and before the\noutput is written.",
17127
"Specify Lua scripts that implement shortcode handlers",
17128
"Keep the markdown file generated by executing code",
17129
"Keep the notebook file generated from executing code.",
17130
"Filters to pre-process ipynb files before rendering to markdown",
17131
"Specify which nodes should be run interactively (displaying output\nfrom expressions)",
17132
"If true, use the “notebook_connected” plotly renderer, which\ndownloads its dependencies from a CDN and requires an internet\nconnection to view.",
17133
"Keep the intermediate typst file used during render.",
17134
"Keep the intermediate tex file used during render.",
17135
{
17136
"short": "Extract images and other media contained in or linked from the source\ndocument to the path DIR.",
17137
"long": "Extract images and other media contained in or linked from the source\ndocument to the path DIR, creating it if necessary, and adjust the\nimages references in the document so they point to the extracted files.\nMedia are downloaded, read from the file system, or extracted from a\nbinary container (e.g.&nbsp;docx), as needed. The original file paths are\nused if they are relative paths not containing … Otherwise filenames are\nconstructed from the SHA1 hash of the contents."
17138
},
17139
"List of paths to search for images and other resources.",
17140
{
17141
"short": "Specify a default extension to use when image paths/URLs have no\nextension.",
17142
"long": "Specify a default extension to use when image paths/URLs have no\nextension. This allows you to use the same source for formats that\nrequire different kinds of images. Currently this option only affects\nthe Markdown and LaTeX readers."
17143
},
17144
{
17145
"short": "Specifies a custom abbreviations file, with abbreviations one to a\nline.",
17146
"long": "Specifies a custom abbreviations file, with abbreviations one to a\nline. This list is used when reading Markdown input: strings found in\nthis list will be followed by a nonbreaking space, and the period will\nnot produce sentence-ending space in formats like LaTeX. The strings may\nnot contain spaces."
17147
},
17148
{
17149
"short": "Specify the default dpi (dots per inch) value for conversion from\npixels to inch/ centimeters and vice versa.",
17150
"long": "Specify the default dpi (dots per inch) value for conversion from\npixels to inch/ centimeters and vice versa. (Technically, the correct\nterm would be ppi: pixels per inch.) The default is <code>96</code>.\nWhen images contain information about dpi internally, the encoded value\nis used instead of the default specified by this option."
17151
},
17152
"If <code>none</code>, do not process tables in HTML input.",
17153
"If <code>none</code>, ignore any divs with\n<code>html-pre-tag-processing=parse</code> enabled.",
17154
{
17155
"short": "CSS property translation",
17156
"long": "If <code>translate</code>, translate CSS properties into output\nformat properties. If <code>none</code>, do not process css\nproperties."
17157
},
17158
"If <code>true</code>, attempt to use <code>rsvg-convert</code> to\nconvert SVG images to PDF.",
17159
"Logo image (placed in bottom right corner of slides)",
17160
{
17161
"short": "Footer to include on all slides",
17162
"long": "Footer to include on all slides. Can also be set per-slide by\nincluding a div with class <code>.footer</code> on the slide."
17163
},
17164
{
17165
"short": "Allow content that overflows slides vertically to scroll",
17166
"long": "<code>true</code> to allow content that overflows slides vertically\nto scroll. This can also be set per-slide by including the\n<code>.scrollable</code> class on the slide title."
17167
},
17168
{
17169
"short": "Use a smaller default font for slide content",
17170
"long": "<code>true</code> to use a smaller default font for slide content.\nThis can also be set per-slide by including the <code>.smaller</code>\nclass on the slide title."
17171
},
17172
{
17173
"short": "Location of output relative to the code that generated it\n(<code>default</code>, <code>fragment</code>, <code>slide</code>,\n<code>column</code>, or <code>column-location</code>)",
17174
"long": "Location of output relative to the code that generated it. The\npossible values are as follows:"
17175
},
17176
"Flags if the presentation is running in an embedded mode",
17177
"The display mode that will be used to show slides",
17178
"For slides with a single top-level image, automatically stretch it to\nfill the slide.",
17179
{
17180
"short": "The ‘normal’ width of the presentation",
17181
"long": "The “normal” width of the presentation, aspect ratio will be\npreserved when the presentation is scaled to fit different resolutions.\nCan be specified using percentage units."
17182
},
17183
{
17184
"short": "The ‘normal’ height of the presentation",
17185
"long": "The “normal” height of the presentation, aspect ratio will be\npreserved when the presentation is scaled to fit different resolutions.\nCan be specified using percentage units."
17186
},
17187
"Bounds for smallest possible scale to apply to content",
17188
"Bounds for largest possible scale to apply to content",
17189
"Vertical centering of slides",
17190
"Disables the default reveal.js slide layout (scaling and\ncentering)",
17191
"Sets the maximum height for source code blocks that appear in the\npresentation.",
17192
{
17193
"short": "Open links in an iframe preview overlay (<code>true</code>,\n<code>false</code>, or <code>auto</code>)",
17194
"long": "Open links in an iframe preview overlay."
17195
},
17196
"Autoplay embedded media (<code>null</code>, <code>true</code>, or\n<code>false</code>). Default is <code>null</code> (only when\n<code>autoplay</code> attribute is specified)",
17197
{
17198
"short": "Global override for preloading lazy-loaded iframes\n(<code>null</code>, <code>true</code>, or <code>false</code>).",
17199
"long": "Global override for preloading lazy-loaded iframes"
17200
},
17201
"Number of slides away from the current slide to pre-load resources\nfor",
17202
"Number of slides away from the current slide to pre-load resources\nfor (on mobile devices).",
17203
"Parallax background image",
17204
"Parallax background size (e.g.&nbsp;‘2100px 900px’)",
17205
"Number of pixels to move the parallax background horizontally per\nslide.",
17206
"Number of pixels to move the parallax background vertically per\nslide.",
17207
"Display a presentation progress bar",
17208
"Push each slide change to the browser history",
17209
{
17210
"short": "Navigation progression (<code>linear</code>, <code>vertical</code>,\nor <code>grid</code>)",
17211
"long": "Changes the behavior of navigation directions."
17212
},
17213
"Enable touch navigation on devices with touch input",
17214
"Enable keyboard shortcuts for navigation",
17215
"Enable slide navigation via mouse wheel",
17216
"Hide cursor if inactive",
17217
"Time before the cursor is hidden (in ms)",
17218
"Loop the presentation",
17219
"Randomize the order of slides each time the presentation loads",
17220
{
17221
"short": "Show arrow controls for navigating through slides (<code>true</code>,\n<code>false</code>, or <code>auto</code>).",
17222
"long": "Show arrow controls for navigating through slides."
17223
},
17224
"Location for navigation controls (<code>edges</code> or\n<code>bottom-right</code>)",
17225
"Help the user learn the controls by providing visual hints.",
17226
"Visibility rule for backwards navigation arrows (<code>faded</code>,\n<code>hidden</code>, or <code>visible</code>).",
17227
"Automatically progress all slides at the specified interval",
17228
"Stop auto-sliding after user input",
17229
"Navigation method to use when auto sliding (defaults to\nnavigateNext)",
17230
"Expected average seconds per slide (used by pacing timer in speaker\nview)",
17231
"Flags whether it should be possible to pause the presentation\n(blackout)",
17232
"Show a help overlay when the <code>?</code> key is pressed",
17233
"Add the current slide to the URL hash",
17234
"URL hash type (<code>number</code> or <code>title</code>)",
17235
"Use 1 based indexing for hash links to match slide number",
17236
"Monitor the hash and change slides accordingly",
17237
"Include the current fragment in the URL",
17238
"Play a subtle sound when changing slides",
17239
"Deactivate jump to slide feature.",
17240
{
17241
"short": "Slides that are too tall to fit within a single page will expand onto\nmultiple pages",
17242
"long": "Slides that are too tall to fit within a single page will expand onto\nmultiple pages. You can limit how many pages a slide may expand to using\nthis option."
17243
},
17244
"Prints each fragment on a separate slide",
17245
{
17246
"short": "Offset used to reduce the height of content within exported PDF\npages.",
17247
"long": "Offset used to reduce the height of content within exported PDF\npages. This exists to account for environment differences based on how\nyou print to PDF. CLI printing options, like phantomjs and wkpdf, can\nend on precisely the total height of the document whereas in-browser\nprinting has to end one pixel before."
17248
},
17249
"Enable the slide overview mode",
17250
"Configuration for revealjs menu.",
17251
"Side of the presentation where the menu will be shown\n(<code>left</code> or <code>right</code>)",
17252
"Width of the menu",
17253
"Add slide numbers to menu items",
17254
"For slides with no title, attempt to use the start of the text\ncontent as the title instead.",
17255
"Configuration for revealjs chalkboard.",
17256
"Visual theme for drawing surface (<code>chalkboard</code> or\n<code>whiteboard</code>)",
17257
"The drawing width of the boardmarker. Defaults to 3. Larger values\ndraw thicker lines.",
17258
"The drawing width of the chalk. Defaults to 7. Larger values draw\nthicker lines.",
17259
"Optional file name for pre-recorded drawings (download drawings using\nthe <code>D</code> key)",
17260
"Configuration option to prevent changes to existing drawings",
17261
"Add chalkboard buttons at the bottom of the slide",
17262
"Gives the duration (in ms) of the transition for a slide change, so\nthat the notes canvas is drawn after the transition is completed.",
17263
"Configuration for reveal presentation multiplexing.",
17264
"Multiplex token server (defaults to Reveal-hosted server)",
17265
"Unique presentation id provided by multiplex token server",
17266
"Secret provided by multiplex token server",
17267
"Control the scroll view feature of Revealjs",
17268
"Activate scroll view by default for the presentation. Otherwise, it\nis manually avalaible by adding <code>?view=scroll</code> to url.",
17269
"Show the scrollbar while scrolling, hide while idle (default\n<code>auto</code>). Set to ‘true’ to always show, <code>false</code> to\nalways hide.",
17270
"When scrolling, it will automatically snap to the closest slide. Only\nsnap when close to the top of a slide using <code>proximity</code>.\nDisable snapping altogether by setting to <code>false</code>.",
17271
"By default each slide will be sized to be as tall as the viewport. If\nyou prefer a more dense layout with multiple slides visible in parallel,\nset to <code>compact</code>.",
17272
"Control scroll view activation width. The scroll view is\nautomatically unable when the viewport reaches mobile widths. Set to\n<code>0</code> to disable automatic scroll view.",
17273
{
17274
"short": "Transition style for slides",
17275
"long": "Transition style for slides backgrounds. (<code>none</code>,\n<code>fade</code>, <code>slide</code>, <code>convex</code>,\n<code>concave</code>, or <code>zoom</code>)"
17276
},
17277
"Slide transition speed (<code>default</code>, <code>fast</code>, or\n<code>slow</code>)",
17278
{
17279
"short": "Transition style for full page slide backgrounds",
17280
"long": "Transition style for full page slide backgrounds. (<code>none</code>,\n<code>fade</code>, <code>slide</code>, <code>convex</code>,\n<code>concave</code>, or <code>zoom</code>)"
17281
},
17282
"Turns fragments on and off globally",
17283
"Globally enable/disable auto-animate (enabled by default)",
17284
{
17285
"short": "Default CSS easing function for auto-animation",
17286
"long": "Default CSS easing function for auto-animation. Can be overridden\nper-slide or per-element via attributes."
17287
},
17288
{
17289
"short": "Duration (in seconds) of auto-animate transition",
17290
"long": "Duration (in seconds) of auto-animate transition. Can be overridden\nper-slide or per-element via attributes."
17291
},
17292
{
17293
"short": "Auto-animate unmatched elements.",
17294
"long": "Auto-animate unmatched elements. Can be overridden per-slide or\nper-element via attributes."
17295
},
17296
{
17297
"short": "CSS properties that can be auto-animated (positional styles like top,\nleft, etc. are always animated).",
17298
"long": ""
17299
},
17300
"Make list items in slide shows display incrementally (one by one).\nThe default is for lists to be displayed all at once.",
17301
{
17302
"short": "Specifies that headings with the specified level create slides.\nHeadings above this level in the hierarchy are used to divide the slide\nshow into sections.",
17303
"long": "Specifies that headings with the specified level create slides.\nHeadings above this level in the hierarchy are used to divide the slide\nshow into sections; headings below this level create subheads within a\nslide. Valid values are 0-6. If a slide level of 0 is specified, slides\nwill not be split automatically on headings, and horizontal rules must\nbe used to indicate slide boundaries. If a slide level is not specified\nexplicitly, the slide level will be set automatically based on the\ncontents of the document"
17304
},
17305
{
17306
"short": "Display the page number of the current slide",
17307
"long": "Display the page number of the current slide"
17308
},
17309
"Contexts in which the slide number appears (<code>all</code>,\n<code>print</code>, or <code>speaker</code>)",
17310
{
17311
"short": "Additional attributes for the title slide of a reveal.js\npresentation.",
17312
"long": "Additional attributes for the title slide of a reveal.js presentation\nas a map of attribute names and values. For example"
17313
},
17314
"CSS color for title slide background",
17315
"URL or path to the background image.",
17316
"CSS background size (defaults to <code>cover</code>)",
17317
"CSS background position (defaults to <code>center</code>)",
17318
"CSS background repeat (defaults to <code>no-repeat</code>)",
17319
"Opacity of the background image on a 0-1 scale. 0 is transparent and\n1 is fully opaque.",
17320
"The title slide style. Use <code>pandoc</code> to select the Pandoc\ndefault title slide style.",
17321
"Vertical centering of title slide",
17322
"Make speaker notes visible to all viewers",
17323
"Change the presentation direction to be RTL",
17324
{
17325
"short": "Method used to print tables in Knitr engine documents\n(<code>default</code>, <code>kable</code>, <code>tibble</code>, or\n<code>paged</code>). Uses <code>default</code> if not specified.",
17326
"long": "Method used to print tables in Knitr engine documents:"
17327
},
17328
{
17329
"short": "Determine how text is wrapped in the output (<code>auto</code>,\n<code>none</code>, or <code>preserve</code>).",
17330
"long": "Determine how text is wrapped in the output (the source code, not the\nrendered version)."
17331
},
17332
{
17333
"short": "For text formats, specify length of lines in characters. For\n<code>typst</code>, number of columns for body text.",
17334
"long": "Specify length of lines in characters. This affects text wrapping in\ngenerated source code (see <code>wrap</code>). It also affects\ncalculation of column widths for plain text tables.\nFor <code>typst</code>, number of columns for body text."
17335
},
17336
{
17337
"short": "Specify the number of spaces per tab (default is 4).",
17338
"long": "Specify the number of spaces per tab (default is 4). Note that tabs\nwithin normal textual input are always converted to spaces. Tabs within\ncode are also converted, however this can be disabled with\n<code>preserve-tabs: false</code>."
17339
},
17340
{
17341
"short": "Preserve tabs within code instead of converting them to spaces.",
17342
"long": "Preserve tabs within code instead of converting them to spaces. (By\ndefault, pandoc converts tabs to spaces before parsing its input.) Note\nthat this will only affect tabs in literal code spans and code blocks.\nTabs in regular text are always treated as spaces."
17343
},
17344
{
17345
"short": "Manually specify line endings (<code>lf</code>, <code>crlf</code>, or\n<code>native</code>).",
17346
"long": "Manually specify line endings:"
17347
},
17348
{
17349
"short": "Strip out HTML comments in source, rather than passing them on to\noutput.",
17350
"long": "Strip out HTML comments in the Markdown source, rather than passing\nthem on to Markdown, Textile or HTML output as raw HTML. This does not\napply to HTML comments inside raw HTML blocks when the\n<code>markdown_in_html_blocks</code> extension is not set."
17351
},
17352
{
17353
"short": "Use only ASCII characters in output.",
17354
"long": "Use only ASCII characters in output. Currently supported for XML and\nHTML formats (which use entities instead of UTF-8 when this option is\nselected), CommonMark, gfm, and Markdown (which use entities), roff ms\n(which use hexadecimal escapes), and to a limited degree LaTeX (which\nuses standard commands for accented characters when possible). roff man\noutput uses ASCII by default."
17355
},
17356
{
17357
"short": "Include an automatically generated table of contents",
17358
"long": "Include an automatically generated table of contents (or, in the case\nof <code>latex</code>, <code>context</code>, <code>docx</code>,\n<code>odt</code>, <code>opendocument</code>, <code>rst</code>, or\n<code>ms</code>, an instruction to create one) in the output\ndocument.\nNote that if you are producing a PDF via <code>ms</code>, the table\nof contents will appear at the beginning of the document, before the\ntitle. If you would prefer it to be at the end of the document, use the\noption <code>pdf-engine-opt: --no-toc-relocation</code>."
17359
},
17360
{
17361
"short": "Include an automatically generated table of contents",
17362
"long": "Include an automatically generated table of contents (or, in the case\nof <code>latex</code>, <code>context</code>, <code>docx</code>,\n<code>odt</code>, <code>opendocument</code>, <code>rst</code>, or\n<code>ms</code>, an instruction to create one) in the output\ndocument.\nNote that if you are producing a PDF via <code>ms</code>, the table\nof contents will appear at the beginning of the document, before the\ntitle. If you would prefer it to be at the end of the document, use the\noption <code>pdf-engine-opt: --no-toc-relocation</code>."
17363
},
17364
"The amount of indentation to use for each level of the table of\ncontents. The default is “1.5em”.",
17365
"Specify the number of section levels to include in the table of\ncontents. The default is 3",
17366
{
17367
"short": "Location for table of contents (<code>body</code>, <code>left</code>,\n<code>right</code> (default), <code>left-body</code>,\n<code>right-body</code>).",
17368
"long": "Location for table of contents:"
17369
},
17370
"The title used for the table of contents.",
17371
"Specifies the depth of items in the table of contents that should be\ndisplayed as expanded in HTML output. Use <code>true</code> to expand\nall or <code>false</code> to collapse all.",
17372
"Print a list of figures in the document.",
17373
"Print a list of tables in the document.",
17374
"Setting this to false prevents this document from being included in\nsearches.",
17375
"Setting this to false prevents the <code>repo-actions</code> from\nappearing on this page. Other possible values are <code>none</code> or\none or more of <code>edit</code>, <code>source</code>, and\n<code>issue</code>, <em>e.g.</em>\n<code>[edit, source, issue]</code>.",
17376
{
17377
"short": "Links to source repository actions",
17378
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17379
},
17380
{
17381
"short": "Links to source repository actions",
17382
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17383
},
17384
"URLs that alias this document, when included in a website.",
17385
{
17386
"short": "The path to a preview image for this document.",
17387
"long": "The path to a preview image for this content. By default, Quarto will\nuse the image value from the site: metadata. If you provide an image,\nyou may also optionally provide an image-width and image-height to\nimprove the appearance of your Twitter Card.\nIf image is not provided, Quarto will automatically attempt to locate\na preview image."
17388
},
17389
"The height of the preview image for this document.",
17390
"The width of the preview image for this document.",
17391
"The alt text for preview image on this page.",
17392
{
17393
"short": "If true, the preview image will only load when it comes into\nview.",
17394
"long": "Enables lazy loading for the preview image. If true, the preview\nimage element will have <code>loading=\"lazy\"</code>, and will only load\nwhen it comes into view.\nIf false, the preview image will load immediately."
17395
},
17396
"Project configuration.",
17397
"Project type (<code>default</code>, <code>website</code>,\n<code>book</code>, or <code>manuscript</code>)",
17398
"Files to render (defaults to all files)",
17399
{
17400
"short": "Working directory for computations",
17401
"long": "Control the working directory for computations."
17402
},
17403
"Output directory",
17404
"HTML library (JS/CSS/etc.) directory",
17405
"Additional file resources to be copied to output directory",
17406
"Additional file resources to be copied to output directory",
17407
"Path to brand.yml or object with light and dark paths to\nbrand.yml",
17408
"Options for <code>quarto preview</code>",
17409
"Scripts to run as a pre-render step",
17410
"Scripts to run as a post-render step",
17411
"Array of paths used to detect the project type within a directory",
17412
"Website configuration.",
17413
"Book configuration.",
17414
"Book title",
17415
"Description metadata for HTML version of book",
17416
"The path to the favicon for this website",
17417
"Base URL for published website",
17418
"Path to site (defaults to <code>/</code>). Not required if you\nspecify <code>site-url</code>.",
17419
"Base URL for website source code repository",
17420
"The value of the target attribute for repo links",
17421
"The value of the rel attribute for repo links",
17422
"Subdirectory of repository containing website",
17423
"Branch of website source code (defaults to <code>main</code>)",
17424
"URL to use for the ‘report an issue’ repository action.",
17425
{
17426
"short": "Links to source repository actions",
17427
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17428
},
17429
{
17430
"short": "Links to source repository actions",
17431
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17432
},
17433
"Displays a ‘reader-mode’ tool which allows users to hide the sidebar\nand table of contents when viewing a page.",
17434
"Generate llms.txt and .llms.md files for LLM-friendly content\nconsumption.",
17435
"Enable Google Analytics for this website",
17436
"The Google tracking Id or measurement Id of this website.",
17437
{
17438
"short": "Storage options for Google Analytics data",
17439
"long": "Storage option for Google Analytics data using on of these two\nvalues:\n<code>cookies</code>: Use cookies to store unique user and session\nidentification (default).\n<code>none</code>: Do not use cookies to store unique user and\nsession identification.\nFor more about choosing storage options see <a href=\"https://quarto.org/docs/websites/website-tools.html#storage\">Storage</a>."
17440
},
17441
{
17442
"short": "Anonymize the user ip address.",
17443
"long": "Anonymize the user ip address. For more about this feature, see <a href=\"https://support.google.com/analytics/answer/2763052?hl=en\">IP\nAnonymization (or IP masking) in Google Analytics</a>."
17444
},
17445
{
17446
"short": "The version number of Google Analytics to use.",
17447
"long": "The version number of Google Analytics to use."
17448
},
17449
{
17450
"short": "Enable Plausible Analytics for this website by providing a script\nsnippet or path to snippet file",
17451
"long": "Enable Plausible Analytics for this website by pasting the script\nsnippet from your Plausible dashboard, or by providing a path to a file\ncontaining the snippet.\nPlausible is a privacy-friendly, GDPR-compliant web analytics service\nthat does not use cookies and does not require cookie consent.\n<strong>Option 1: Inline snippet</strong>"
17452
},
17453
"Path to a file containing the Plausible Analytics script snippet",
17454
"Provides an announcement displayed at the top of the page.",
17455
"The content of the announcement",
17456
"Whether this announcement may be dismissed by the user.",
17457
{
17458
"short": "The icon to display in the announcement",
17459
"long": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>twitter</code>, <code>share</code>) for the announcement. See <a href=\"https://icons.getbootstrap.com/\" class=\"uri\">https://icons.getbootstrap.com/</a> for a list of available\nicons"
17460
},
17461
{
17462
"short": "The position of the announcement.",
17463
"long": "The position of the announcement. One of <code>above-navbar</code>\n(default) or <code>below-navbar</code>."
17464
},
17465
{
17466
"short": "The type of announcement. Affects the appearance of the\nannouncement.",
17467
"long": "The type of announcement. One of <code>primary</code>,\n<code>secondary</code>, <code>success</code>, <code>danger</code>,\n<code>warning</code>, <code>info</code>, <code>light</code> or\n<code>dark</code>. Affects the appearance of the announcement."
17468
},
17469
{
17470
"short": "Request cookie consent before enabling scripts that set cookies",
17471
"long": "Quarto includes the ability to request cookie consent before enabling\nscripts that set cookies, using <a href=\"https://www.cookieconsent.com/\">Cookie Consent</a>.\nThe user’s cookie preferences will automatically control Google\nAnalytics (if enabled) and can be used to control custom scripts you add\nas well. For more information see <a href=\"https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent\">Custom\nScripts and Cookie Consent</a>."
17472
},
17473
{
17474
"short": "The type of consent that should be requested",
17475
"long": "The type of consent that should be requested, using one of these two\nvalues:"
17476
},
17477
{
17478
"short": "The style of the consent banner that is displayed",
17479
"long": "The style of the consent banner that is displayed:"
17480
},
17481
"Whether to use a dark or light appearance for the consent banner\n(<code>light</code> or <code>dark</code>).",
17482
"The url to the website’s cookie or privacy policy.",
17483
{
17484
"short": "The language to be used when diplaying the cookie consent prompt\n(defaults to document language).",
17485
"long": "The language to be used when diplaying the cookie consent prompt\nspecified using an IETF language tag.\nIf not specified, the document language will be used."
17486
},
17487
{
17488
"short": "The text to display for the cookie preferences link in the website\nfooter.",
17489
"long": ""
17490
},
17491
"Provide full text search for website",
17492
"Location for search widget (<code>navbar</code> or\n<code>sidebar</code>)",
17493
"Type of search UI (<code>overlay</code> or <code>textbox</code>)",
17494
"Number of matches to display (defaults to 20)",
17495
"Matches after which to collapse additional results",
17496
"Provide button for copying search link",
17497
"When false, do not merge navbar crumbs into the crumbs in\n<code>search.json</code>.",
17498
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
17499
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
17500
"Whether to include search result parents when displaying items in\nsearch results (when possible).",
17501
"Use external Algolia search index",
17502
"The name of the index to use when performing a search",
17503
"The unique ID used by Algolia to identify your application",
17504
"The Search-Only API key to use to connect to Algolia",
17505
"Enable tracking of Algolia analytics events",
17506
"Enable the display of the Algolia logo in the search results\nfooter.",
17507
"Field that contains the URL of index entries",
17508
"Field that contains the title of index entries",
17509
"Field that contains the text of index entries",
17510
"Field that contains the section of index entries",
17511
"Additional parameters to pass when executing a search",
17512
"Top navigation options",
17513
"The navbar title. Uses the project title if none is specified.",
17514
"Specification of image that will be displayed to the left of the\ntitle.",
17515
"Alternate text for the logo image.",
17516
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17517
"The navbar’s background color (named or hex color).",
17518
"The navbar’s foreground color (named or hex color).",
17519
"Include a search box in the navbar.",
17520
"Always show the navbar (keeping it pinned).",
17521
"Collapse the navbar into a menu when the display becomes narrow.",
17522
"The responsive breakpoint below which the navbar will collapse into a\nmenu (<code>sm</code>, <code>md</code>, <code>lg</code> (default),\n<code>xl</code>, <code>xxl</code>).",
17523
"List of items for the left side of the navbar.",
17524
"List of items for the right side of the navbar.",
17525
"The position of the collapsed navbar toggle when in responsive\nmode",
17526
"Collapse tools into the navbar menu when the display becomes\nnarrow.",
17527
"Side navigation options",
17528
"The identifier for this sidebar.",
17529
"The sidebar title. Uses the project title if none is specified.",
17530
"Specification of image that will be displayed in the sidebar.",
17531
"Alternate text for the logo image.",
17532
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17533
"Include a search control in the sidebar.",
17534
"List of sidebar tools",
17535
"List of items for the sidebar",
17536
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
17537
"The sidebar’s background color (named or hex color).",
17538
"The sidebar’s foreground color (named or hex color).",
17539
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
17540
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
17541
"The depth at which the sidebar contents should be collapsed by\ndefault.",
17542
"When collapsed, pin the collapsed sidebar to the top of the page.",
17543
"Markdown to place above sidebar content (text or file path)",
17544
"Markdown to place below sidebar content (text or file path)",
17545
"The identifier for this sidebar.",
17546
"The sidebar title. Uses the project title if none is specified.",
17547
"Specification of image that will be displayed in the sidebar.",
17548
"Alternate text for the logo image.",
17549
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17550
"Include a search control in the sidebar.",
17551
"List of sidebar tools",
17552
"List of items for the sidebar",
17553
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
17554
"The sidebar’s background color (named or hex color).",
17555
"The sidebar’s foreground color (named or hex color).",
17556
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
17557
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
17558
"The depth at which the sidebar contents should be collapsed by\ndefault.",
17559
"When collapsed, pin the collapsed sidebar to the top of the page.",
17560
"Markdown to place above sidebar content (text or file path)",
17561
"Markdown to place below sidebar content (text or file path)",
17562
"Markdown to insert at the beginning of each page’s body (below the\ntitle and author block).",
17563
"Markdown to insert below each page’s body.",
17564
"Markdown to place above margin content (text or file path)",
17565
"Markdown to place below margin content (text or file path)",
17566
"Provide next and previous article links in footer",
17567
"Provide a ‘back to top’ navigation button",
17568
"Whether to show navigation breadcrumbs for pages more than 1 level\ndeep",
17569
"Shared page footer",
17570
"Default site thumbnail image for <code>twitter</code>\n/<code>open-graph</code>",
17571
"Default site thumbnail image alt text for <code>twitter</code>\n/<code>open-graph</code>",
17572
"Publish open graph metadata",
17573
"Publish twitter card metadata",
17574
"A list of other links to appear below the TOC.",
17575
"A list of code links to appear with this document.",
17576
"A list of input documents that should be treated as drafts",
17577
{
17578
"short": "How to handle drafts that are encountered.",
17579
"long": "How to handle drafts that are encountered.\n<code>visible</code> - the draft will visible and fully available\n<code>unlinked</code> - the draft will be rendered, but will not appear\nin navigation, search, or listings. <code>gone</code> - the draft will\nhave no content and will not be linked to (default)."
17580
},
17581
"Book subtitle",
17582
"Author or authors of the book",
17583
"Author or authors of the book",
17584
"Book publication date",
17585
"Format string for dates in the book",
17586
"Book abstract",
17587
"Book part and chapter files",
17588
"Book appendix files",
17589
"Book references file",
17590
"Base name for single-file output (e.g.&nbsp;PDF, ePub, docx)",
17591
"Cover image (used in HTML and ePub formats)",
17592
"Alternative text for cover image (used in HTML format)",
17593
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
17594
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
17595
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
17596
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
17597
"Custom tools for navbar or sidebar",
17598
"The Digital Object Identifier for this book.",
17599
"A url to the abstract for this item.",
17600
"Date the item has been accessed.",
17601
{
17602
"short": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review).",
17603
"long": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use\n<code>note</code> instead"
17604
},
17605
"Archive storing the item",
17606
"Collection the item is part of within an archive.",
17607
"Storage location within an archive (e.g.&nbsp;a box and folder\nnumber).",
17608
"Geographic location of the archive.",
17609
"Issuing or judicial authority (e.g.&nbsp;“USPTO” for a patent, “Fairfax\nCircuit Court” for a legal case).",
17610
{
17611
"short": "Date the item was initially available",
17612
"long": "Date the item was initially available (e.g.&nbsp;the online publication\ndate of a journal article before its formal publication date; the date a\ntreaty was made available for signing)."
17613
},
17614
"Call number (to locate the item in a library).",
17615
"The person leading the session containing a presentation (e.g.&nbsp;the\norganizer of the <code>container-title</code> of a\n<code>speech</code>).",
17616
"Chapter number (e.g.&nbsp;chapter number in a book; track number on an\nalbum).",
17617
{
17618
"short": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey).",
17619
"long": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey);\nUse this variable to facilitate conversion between word-processor and\nplain-text writing systems; For an identifer intended as formatted\noutput label for a citation (e.g.&nbsp;“Ferr78”), use\n<code>citation-label</code> instead"
17620
},
17621
{
17622
"short": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”).",
17623
"long": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the\nidentifier of the item in the input data file, use\n<code>citation-key</code> instead"
17624
},
17625
"Index (starting at 1) of the cited reference in the bibliography\n(generated by the CSL processor).",
17626
"Editor of the collection holding the item (e.g.&nbsp;the series editor for\na book).",
17627
"Number identifying the collection holding the item (e.g.&nbsp;the series\nnumber for a book)",
17628
"Title of the collection holding the item (e.g.&nbsp;the series title for a\nbook; the lecture series title for a presentation).",
17629
"Person compiling or selecting material for an item from the works of\nvarious persons or bodies (e.g.&nbsp;for an anthology).",
17630
"Composer (e.g.&nbsp;of a musical score).",
17631
"Author of the container holding the item (e.g.&nbsp;the book author for a\nbook chapter).",
17632
{
17633
"short": "Title of the container holding the item.",
17634
"long": "Title of the container holding the item (e.g.&nbsp;the book title for a\nbook chapter, the journal title for a journal article; the album title\nfor a recording; the session title for multi-part presentation at a\nconference)"
17635
},
17636
"Short/abbreviated form of container-title;",
17637
"A minor contributor to the item; typically cited using “with” before\nthe name when listed in a bibliography.",
17638
"Curator of an exhibit or collection (e.g.&nbsp;in a museum).",
17639
"Physical (e.g.&nbsp;size) or temporal (e.g.&nbsp;running time) dimensions of\nthe item.",
17640
"Director (e.g.&nbsp;of a film).",
17641
"Minor subdivision of a court with a <code>jurisdiction</code> for a\nlegal item",
17642
"(Container) edition holding the item (e.g.&nbsp;“3” when citing a chapter\nin the third edition of a book).",
17643
"The editor of the item.",
17644
"Managing editor (“Directeur de la Publication” in French).",
17645
{
17646
"short": "Combined editor and translator of a work.",
17647
"long": "Combined editor and translator of a work.\nThe citation processory must be automatically generate if editor and\ntranslator variables are identical; May also be provided directly in\nitem data."
17648
},
17649
"Date the event related to an item took place.",
17650
"Name of the event related to the item (e.g.&nbsp;the conference name when\nciting a conference paper; the meeting where presentation was made).",
17651
"Geographic location of the event related to the item\n(e.g.&nbsp;“Amsterdam, The Netherlands”).",
17652
"Executive producer of the item (e.g.&nbsp;of a television series).",
17653
{
17654
"short": "Number of a preceding note containing the first reference to the\nitem.",
17655
"long": "Number of a preceding note containing the first reference to the\nitem\nAssigned by the CSL processor; Empty in non-note-based styles or when\nthe item hasn’t been cited in any preceding notes in a document"
17656
},
17657
"A url to the full text for this item.",
17658
{
17659
"short": "Type, class, or subtype of the item",
17660
"long": "Type, class, or subtype of the item (e.g.&nbsp;“Doctoral dissertation” for\na PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g.&nbsp;“adventure”\nfor an adventure movie)"
17661
},
17662
"Guest (e.g.&nbsp;on a TV show or podcast).",
17663
"Host of the item (e.g.&nbsp;of a TV show or podcast).",
17664
"A value which uniquely identifies this item.",
17665
"Illustrator (e.g.&nbsp;of a children’s book or graphic novel).",
17666
"Interviewer (e.g.&nbsp;of an interview).",
17667
"International Standard Book Number (e.g.&nbsp;“978-3-8474-1017-1”).",
17668
"International Standard Serial Number.",
17669
{
17670
"short": "Issue number of the item or container holding the item",
17671
"long": "Issue number of the item or container holding the item (e.g.&nbsp;“5” when\nciting a journal article from journal volume 2, issue 5);\nUse <code>volume-title</code> for the title of the issue, if any."
17672
},
17673
"Date the item was issued/published.",
17674
"Geographic scope of relevance (e.g.&nbsp;“US” for a US patent; the court\nhearing a legal case).",
17675
"Keyword(s) or tag(s) attached to the item.",
17676
{
17677
"short": "The language of the item (used only for citation of the item).",
17678
"long": "The language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code\n(e.g.&nbsp;“en”, “zh”), optionally with a two-letter locale code\n(e.g.&nbsp;“de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents\nwhat language the item uses (which may be used in citing the item)."
17679
},
17680
{
17681
"short": "The license information applicable to an item.",
17682
"long": "The license information applicable to an item (e.g.&nbsp;the license an\narticle or software is released under; the copyright information for an\nitem; the classification status of a document)"
17683
},
17684
{
17685
"short": "A cite-specific pinpointer within the item.",
17686
"long": "A cite-specific pinpointer within the item (e.g.&nbsp;a page number within\na book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the\nlocator type (see the Locators term list)."
17687
},
17688
"Description of the item’s format or medium (e.g.&nbsp;“CD”, “DVD”,\n“Album”, etc.)",
17689
"Narrator (e.g.&nbsp;of an audio book).",
17690
"Descriptive text or notes about an item (e.g.&nbsp;in an annotated\nbibliography).",
17691
"Number identifying the item (e.g.&nbsp;a report number).",
17692
"Total number of pages of the cited item.",
17693
"Total number of volumes, used when citing multi-volume books and\nsuch.",
17694
"Organizer of an event (e.g.&nbsp;organizer of a workshop or\nconference).",
17695
{
17696
"short": "The original creator of a work.",
17697
"long": "The original creator of a work (e.g.&nbsp;the form of the author name\nlisted on the original version of a book; the historical author of a\nwork; the original songwriter or performer for a musical piece; the\noriginal developer or programmer for a piece of software; the original\nauthor of an adapted work such as a book adapted into a screenplay)"
17698
},
17699
"Issue date of the original version.",
17700
"Original publisher, for items that have been republished by a\ndifferent publisher.",
17701
"Geographic location of the original publisher (e.g.&nbsp;“London,\nUK”).",
17702
"Title of the original version (e.g.&nbsp;“Война и мир”, the untranslated\nRussian title of “War and Peace”).",
17703
"Range of pages the item (e.g.&nbsp;a journal article) covers in a\ncontainer (e.g.&nbsp;a journal issue).",
17704
"First page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
17705
"Last page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
17706
{
17707
"short": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).",
17708
"long": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).\nUse <code>part-title</code> for the title of the part, if any."
17709
},
17710
"Title of the specific part of an item being cited.",
17711
"A url to the pdf for this item.",
17712
"Performer of an item (e.g.&nbsp;an actor appearing in a film; a muscian\nperforming a piece of music).",
17713
"PubMed Central reference number.",
17714
"PubMed reference number.",
17715
"Printing number of the item or container holding the item.",
17716
"Producer (e.g.&nbsp;of a television or radio broadcast).",
17717
"A public url for this item.",
17718
"The publisher of the item.",
17719
"The geographic location of the publisher.",
17720
"Recipient (e.g.&nbsp;of a letter).",
17721
"Author of the item reviewed by the current item.",
17722
"Type of the item being reviewed by the current item (e.g.&nbsp;book,\nfilm).",
17723
"Title of the item reviewed by the current item.",
17724
"Scale of e.g.&nbsp;a map or model.",
17725
"Writer of a script or screenplay (e.g.&nbsp;of a film).",
17726
"Section of the item or container holding the item (e.g.&nbsp;“§2.0.1” for\na law; “politics” for a newspaper article).",
17727
"Creator of a series (e.g.&nbsp;of a television series).",
17728
"Source from whence the item originates (e.g.&nbsp;a library catalog or\ndatabase).",
17729
"Publication status of the item (e.g.&nbsp;“forthcoming”; “in press”;\n“advance online publication”; “retracted”)",
17730
"Date the item (e.g.&nbsp;a manuscript) was submitted for publication.",
17731
"Supplement number of the item or container holding the item (e.g.&nbsp;for\nsecondary legal items that are regularly updated between editions).",
17732
"Short/abbreviated form of<code>title</code>.",
17733
"Translator",
17734
"The <a href=\"https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types\">type</a>\nof the item.",
17735
"Uniform Resource Locator\n(e.g.&nbsp;“https://aem.asm.org/cgi/content/full/74/9/2766”)",
17736
"Version of the item (e.g.&nbsp;“2.0.9” for a software program).",
17737
{
17738
"short": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item.",
17739
"long": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item (e.g.&nbsp;“2” when citing a chapter from\nvolume 2 of a book).\nUse <code>volume-title</code> for the title of the volume, if\nany."
17740
},
17741
{
17742
"short": "Title of the volume of the item or container holding the item.",
17743
"long": "Title of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections,\nand the like."
17744
},
17745
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
17746
"Manuscript configuration",
17747
"internal-schema-hack",
17748
"List execution engines you want to give priority when determining\nwhich engine should render a notebook. If two engines have support for a\nnotebook, the one listed earlier will be chosen. Quarto’s default order\nis ‘knitr’, ‘jupyter’, ‘markdown’, ‘julia’.",
17749
"When defined, run axe-core accessibility tests on the document.",
17750
"If set, output axe-core results on console. <code>json</code>:\nproduce structured output; <code>console</code>: print output to\njavascript console; <code>document</code>: produce a visual report of\nviolations in the document itself.",
17751
"The logo image.",
17752
{
17753
"short": "Advanced geometry settings for Typst margin layout.",
17754
"long": "Fine-grained control over marginalia package geometry. Most users\nshould use <code>margin</code> and <code>grid</code> options instead;\nthese values are computed automatically.\nUser-specified values override the computed defaults."
17755
},
17756
"Inner (left) margin geometry.",
17757
"Outer (right) margin geometry.",
17758
"Minimum vertical spacing between margin notes (default: 8pt).",
17759
{
17760
"short": "Visual style for theorem environments in Typst output.",
17761
"long": "Controls how theorems, lemmas, definitions, etc. are rendered:"
17762
},
17763
{
17764
"short": "Email format version",
17765
"long": "Specifies which email format version to use."
17766
},
17767
"Project configuration.",
17768
"Project type (<code>default</code>, <code>website</code>,\n<code>book</code>, or <code>manuscript</code>)",
17769
"Files to render (defaults to all files)",
17770
{
17771
"short": "Working directory for computations",
17772
"long": "Control the working directory for computations."
17773
},
17774
"Output directory",
17775
"HTML library (JS/CSS/etc.) directory",
17776
"Additional file resources to be copied to output directory",
17777
"Additional file resources to be copied to output directory",
17778
"Path to brand.yml or object with light and dark paths to\nbrand.yml",
17779
"Options for <code>quarto preview</code>",
17780
"Scripts to run as a pre-render step",
17781
"Scripts to run as a post-render step",
17782
"Array of paths used to detect the project type within a directory",
17783
"Website configuration.",
17784
"Book configuration.",
17785
"Book title",
17786
"Description metadata for HTML version of book",
17787
"The path to the favicon for this website",
17788
"Base URL for published website",
17789
"Path to site (defaults to <code>/</code>). Not required if you\nspecify <code>site-url</code>.",
17790
"Base URL for website source code repository",
17791
"The value of the target attribute for repo links",
17792
"The value of the rel attribute for repo links",
17793
"Subdirectory of repository containing website",
17794
"Branch of website source code (defaults to <code>main</code>)",
17795
"URL to use for the ‘report an issue’ repository action.",
17796
{
17797
"short": "Links to source repository actions",
17798
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17799
},
17800
{
17801
"short": "Links to source repository actions",
17802
"long": "Links to source repository actions (<code>none</code> or one or more\nof <code>edit</code>, <code>source</code>, <code>issue</code>)"
17803
},
17804
"Displays a ‘reader-mode’ tool which allows users to hide the sidebar\nand table of contents when viewing a page.",
17805
"Generate llms.txt and .llms.md files for LLM-friendly content\nconsumption.",
17806
"Enable Google Analytics for this website",
17807
"The Google tracking Id or measurement Id of this website.",
17808
{
17809
"short": "Storage options for Google Analytics data",
17810
"long": "Storage option for Google Analytics data using on of these two\nvalues:\n<code>cookies</code>: Use cookies to store unique user and session\nidentification (default).\n<code>none</code>: Do not use cookies to store unique user and\nsession identification.\nFor more about choosing storage options see <a href=\"https://quarto.org/docs/websites/website-tools.html#storage\">Storage</a>."
17811
},
17812
{
17813
"short": "Anonymize the user ip address.",
17814
"long": "Anonymize the user ip address. For more about this feature, see <a href=\"https://support.google.com/analytics/answer/2763052?hl=en\">IP\nAnonymization (or IP masking) in Google Analytics</a>."
17815
},
17816
{
17817
"short": "The version number of Google Analytics to use.",
17818
"long": "The version number of Google Analytics to use."
17819
},
17820
{
17821
"short": "Enable Plausible Analytics for this website by providing a script\nsnippet or path to snippet file",
17822
"long": "Enable Plausible Analytics for this website by pasting the script\nsnippet from your Plausible dashboard, or by providing a path to a file\ncontaining the snippet.\nPlausible is a privacy-friendly, GDPR-compliant web analytics service\nthat does not use cookies and does not require cookie consent.\n<strong>Option 1: Inline snippet</strong>"
17823
},
17824
"Path to a file containing the Plausible Analytics script snippet",
17825
"Provides an announcement displayed at the top of the page.",
17826
"The content of the announcement",
17827
"Whether this announcement may be dismissed by the user.",
17828
{
17829
"short": "The icon to display in the announcement",
17830
"long": "Name of bootstrap icon (e.g.&nbsp;<code>github</code>,\n<code>twitter</code>, <code>share</code>) for the announcement. See <a href=\"https://icons.getbootstrap.com/\" class=\"uri\">https://icons.getbootstrap.com/</a> for a list of available\nicons"
17831
},
17832
{
17833
"short": "The position of the announcement.",
17834
"long": "The position of the announcement. One of <code>above-navbar</code>\n(default) or <code>below-navbar</code>."
17835
},
17836
{
17837
"short": "The type of announcement. Affects the appearance of the\nannouncement.",
17838
"long": "The type of announcement. One of <code>primary</code>,\n<code>secondary</code>, <code>success</code>, <code>danger</code>,\n<code>warning</code>, <code>info</code>, <code>light</code> or\n<code>dark</code>. Affects the appearance of the announcement."
17839
},
17840
{
17841
"short": "Request cookie consent before enabling scripts that set cookies",
17842
"long": "Quarto includes the ability to request cookie consent before enabling\nscripts that set cookies, using <a href=\"https://www.cookieconsent.com/\">Cookie Consent</a>.\nThe user’s cookie preferences will automatically control Google\nAnalytics (if enabled) and can be used to control custom scripts you add\nas well. For more information see <a href=\"https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent\">Custom\nScripts and Cookie Consent</a>."
17843
},
17844
{
17845
"short": "The type of consent that should be requested",
17846
"long": "The type of consent that should be requested, using one of these two\nvalues:"
17847
},
17848
{
17849
"short": "The style of the consent banner that is displayed",
17850
"long": "The style of the consent banner that is displayed:"
17851
},
17852
"Whether to use a dark or light appearance for the consent banner\n(<code>light</code> or <code>dark</code>).",
17853
"The url to the website’s cookie or privacy policy.",
17854
{
17855
"short": "The language to be used when diplaying the cookie consent prompt\n(defaults to document language).",
17856
"long": "The language to be used when diplaying the cookie consent prompt\nspecified using an IETF language tag.\nIf not specified, the document language will be used."
17857
},
17858
{
17859
"short": "The text to display for the cookie preferences link in the website\nfooter.",
17860
"long": ""
17861
},
17862
"Provide full text search for website",
17863
"Location for search widget (<code>navbar</code> or\n<code>sidebar</code>)",
17864
"Type of search UI (<code>overlay</code> or <code>textbox</code>)",
17865
"Number of matches to display (defaults to 20)",
17866
"Matches after which to collapse additional results",
17867
"Provide button for copying search link",
17868
"When false, do not merge navbar crumbs into the crumbs in\n<code>search.json</code>.",
17869
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
17870
"One or more keys that will act as a shortcut to launch search (single\ncharacters)",
17871
"Whether to include search result parents when displaying items in\nsearch results (when possible).",
17872
"Use external Algolia search index",
17873
"The name of the index to use when performing a search",
17874
"The unique ID used by Algolia to identify your application",
17875
"The Search-Only API key to use to connect to Algolia",
17876
"Enable tracking of Algolia analytics events",
17877
"Enable the display of the Algolia logo in the search results\nfooter.",
17878
"Field that contains the URL of index entries",
17879
"Field that contains the title of index entries",
17880
"Field that contains the text of index entries",
17881
"Field that contains the section of index entries",
17882
"Additional parameters to pass when executing a search",
17883
"Top navigation options",
17884
"The navbar title. Uses the project title if none is specified.",
17885
"Specification of image that will be displayed to the left of the\ntitle.",
17886
"Alternate text for the logo image.",
17887
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17888
"The navbar’s background color (named or hex color).",
17889
"The navbar’s foreground color (named or hex color).",
17890
"Include a search box in the navbar.",
17891
"Always show the navbar (keeping it pinned).",
17892
"Collapse the navbar into a menu when the display becomes narrow.",
17893
"The responsive breakpoint below which the navbar will collapse into a\nmenu (<code>sm</code>, <code>md</code>, <code>lg</code> (default),\n<code>xl</code>, <code>xxl</code>).",
17894
"List of items for the left side of the navbar.",
17895
"List of items for the right side of the navbar.",
17896
"The position of the collapsed navbar toggle when in responsive\nmode",
17897
"Collapse tools into the navbar menu when the display becomes\nnarrow.",
17898
"Side navigation options",
17899
"The identifier for this sidebar.",
17900
"The sidebar title. Uses the project title if none is specified.",
17901
"Specification of image that will be displayed in the sidebar.",
17902
"Alternate text for the logo image.",
17903
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17904
"Include a search control in the sidebar.",
17905
"List of sidebar tools",
17906
"List of items for the sidebar",
17907
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
17908
"The sidebar’s background color (named or hex color).",
17909
"The sidebar’s foreground color (named or hex color).",
17910
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
17911
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
17912
"The depth at which the sidebar contents should be collapsed by\ndefault.",
17913
"When collapsed, pin the collapsed sidebar to the top of the page.",
17914
"Markdown to place above sidebar content (text or file path)",
17915
"Markdown to place below sidebar content (text or file path)",
17916
"The identifier for this sidebar.",
17917
"The sidebar title. Uses the project title if none is specified.",
17918
"Specification of image that will be displayed in the sidebar.",
17919
"Alternate text for the logo image.",
17920
"Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
17921
"Include a search control in the sidebar.",
17922
"List of sidebar tools",
17923
"List of items for the sidebar",
17924
"The style of sidebar (<code>docked</code> or\n<code>floating</code>).",
17925
"The sidebar’s background color (named or hex color).",
17926
"The sidebar’s foreground color (named or hex color).",
17927
"Whether to show a border on the sidebar (defaults to true for\n‘docked’ sidebars)",
17928
"Alignment of the items within the sidebar (<code>left</code>,\n<code>right</code>, or <code>center</code>)",
17929
"The depth at which the sidebar contents should be collapsed by\ndefault.",
17930
"When collapsed, pin the collapsed sidebar to the top of the page.",
17931
"Markdown to place above sidebar content (text or file path)",
17932
"Markdown to place below sidebar content (text or file path)",
17933
"Markdown to insert at the beginning of each page’s body (below the\ntitle and author block).",
17934
"Markdown to insert below each page’s body.",
17935
"Markdown to place above margin content (text or file path)",
17936
"Markdown to place below margin content (text or file path)",
17937
"Provide next and previous article links in footer",
17938
"Provide a ‘back to top’ navigation button",
17939
"Whether to show navigation breadcrumbs for pages more than 1 level\ndeep",
17940
"Shared page footer",
17941
"Default site thumbnail image for <code>twitter</code>\n/<code>open-graph</code>",
17942
"Default site thumbnail image alt text for <code>twitter</code>\n/<code>open-graph</code>",
17943
"Publish open graph metadata",
17944
"Publish twitter card metadata",
17945
"A list of other links to appear below the TOC.",
17946
"A list of code links to appear with this document.",
17947
"A list of input documents that should be treated as drafts",
17948
{
17949
"short": "How to handle drafts that are encountered.",
17950
"long": "How to handle drafts that are encountered.\n<code>visible</code> - the draft will visible and fully available\n<code>unlinked</code> - the draft will be rendered, but will not appear\nin navigation, search, or listings. <code>gone</code> - the draft will\nhave no content and will not be linked to (default)."
17951
},
17952
"Book subtitle",
17953
"Author or authors of the book",
17954
"Author or authors of the book",
17955
"Book publication date",
17956
"Format string for dates in the book",
17957
"Book abstract",
17958
"Book part and chapter files",
17959
"Book appendix files",
17960
"Book references file",
17961
"Base name for single-file output (e.g.&nbsp;PDF, ePub, docx)",
17962
"Cover image (used in HTML and ePub formats)",
17963
"Alternative text for cover image (used in HTML format)",
17964
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
17965
"Sharing buttons to include on navbar or sidebar (one or more of\n<code>twitter</code>, <code>facebook</code>, <code>linkedin</code>)",
17966
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
17967
"Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
17968
"Custom tools for navbar or sidebar",
17969
"The Digital Object Identifier for this book.",
17970
"A url to the abstract for this item.",
17971
"Date the item has been accessed.",
17972
{
17973
"short": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review).",
17974
"long": "Short markup, decoration, or annotation to the item (e.g., to\nindicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use\n<code>note</code> instead"
17975
},
17976
"Archive storing the item",
17977
"Collection the item is part of within an archive.",
17978
"Storage location within an archive (e.g.&nbsp;a box and folder\nnumber).",
17979
"Geographic location of the archive.",
17980
"Issuing or judicial authority (e.g.&nbsp;“USPTO” for a patent, “Fairfax\nCircuit Court” for a legal case).",
17981
{
17982
"short": "Date the item was initially available",
17983
"long": "Date the item was initially available (e.g.&nbsp;the online publication\ndate of a journal article before its formal publication date; the date a\ntreaty was made available for signing)."
17984
},
17985
"Call number (to locate the item in a library).",
17986
"The person leading the session containing a presentation (e.g.&nbsp;the\norganizer of the <code>container-title</code> of a\n<code>speech</code>).",
17987
"Chapter number (e.g.&nbsp;chapter number in a book; track number on an\nalbum).",
17988
{
17989
"short": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey).",
17990
"long": "Identifier of the item in the input data file (analogous to BiTeX\nentrykey);\nUse this variable to facilitate conversion between word-processor and\nplain-text writing systems; For an identifer intended as formatted\noutput label for a citation (e.g.&nbsp;“Ferr78”), use\n<code>citation-label</code> instead"
17991
},
17992
{
17993
"short": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”).",
17994
"long": "Label identifying the item in in-text citations of label styles\n(e.g.&nbsp;“Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the\nidentifier of the item in the input data file, use\n<code>citation-key</code> instead"
17995
},
17996
"Index (starting at 1) of the cited reference in the bibliography\n(generated by the CSL processor).",
17997
"Editor of the collection holding the item (e.g.&nbsp;the series editor for\na book).",
17998
"Number identifying the collection holding the item (e.g.&nbsp;the series\nnumber for a book)",
17999
"Title of the collection holding the item (e.g.&nbsp;the series title for a\nbook; the lecture series title for a presentation).",
18000
"Person compiling or selecting material for an item from the works of\nvarious persons or bodies (e.g.&nbsp;for an anthology).",
18001
"Composer (e.g.&nbsp;of a musical score).",
18002
"Author of the container holding the item (e.g.&nbsp;the book author for a\nbook chapter).",
18003
{
18004
"short": "Title of the container holding the item.",
18005
"long": "Title of the container holding the item (e.g.&nbsp;the book title for a\nbook chapter, the journal title for a journal article; the album title\nfor a recording; the session title for multi-part presentation at a\nconference)"
18006
},
18007
"Short/abbreviated form of container-title;",
18008
"A minor contributor to the item; typically cited using “with” before\nthe name when listed in a bibliography.",
18009
"Curator of an exhibit or collection (e.g.&nbsp;in a museum).",
18010
"Physical (e.g.&nbsp;size) or temporal (e.g.&nbsp;running time) dimensions of\nthe item.",
18011
"Director (e.g.&nbsp;of a film).",
18012
"Minor subdivision of a court with a <code>jurisdiction</code> for a\nlegal item",
18013
"(Container) edition holding the item (e.g.&nbsp;“3” when citing a chapter\nin the third edition of a book).",
18014
"The editor of the item.",
18015
"Managing editor (“Directeur de la Publication” in French).",
18016
{
18017
"short": "Combined editor and translator of a work.",
18018
"long": "Combined editor and translator of a work.\nThe citation processory must be automatically generate if editor and\ntranslator variables are identical; May also be provided directly in\nitem data."
18019
},
18020
"Date the event related to an item took place.",
18021
"Name of the event related to the item (e.g.&nbsp;the conference name when\nciting a conference paper; the meeting where presentation was made).",
18022
"Geographic location of the event related to the item\n(e.g.&nbsp;“Amsterdam, The Netherlands”).",
18023
"Executive producer of the item (e.g.&nbsp;of a television series).",
18024
{
18025
"short": "Number of a preceding note containing the first reference to the\nitem.",
18026
"long": "Number of a preceding note containing the first reference to the\nitem\nAssigned by the CSL processor; Empty in non-note-based styles or when\nthe item hasn’t been cited in any preceding notes in a document"
18027
},
18028
"A url to the full text for this item.",
18029
{
18030
"short": "Type, class, or subtype of the item",
18031
"long": "Type, class, or subtype of the item (e.g.&nbsp;“Doctoral dissertation” for\na PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g.&nbsp;“adventure”\nfor an adventure movie)"
18032
},
18033
"Guest (e.g.&nbsp;on a TV show or podcast).",
18034
"Host of the item (e.g.&nbsp;of a TV show or podcast).",
18035
"A value which uniquely identifies this item.",
18036
"Illustrator (e.g.&nbsp;of a children’s book or graphic novel).",
18037
"Interviewer (e.g.&nbsp;of an interview).",
18038
"International Standard Book Number (e.g.&nbsp;“978-3-8474-1017-1”).",
18039
"International Standard Serial Number.",
18040
{
18041
"short": "Issue number of the item or container holding the item",
18042
"long": "Issue number of the item or container holding the item (e.g.&nbsp;“5” when\nciting a journal article from journal volume 2, issue 5);\nUse <code>volume-title</code> for the title of the issue, if any."
18043
},
18044
"Date the item was issued/published.",
18045
"Geographic scope of relevance (e.g.&nbsp;“US” for a US patent; the court\nhearing a legal case).",
18046
"Keyword(s) or tag(s) attached to the item.",
18047
{
18048
"short": "The language of the item (used only for citation of the item).",
18049
"long": "The language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code\n(e.g.&nbsp;“en”, “zh”), optionally with a two-letter locale code\n(e.g.&nbsp;“de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents\nwhat language the item uses (which may be used in citing the item)."
18050
},
18051
{
18052
"short": "The license information applicable to an item.",
18053
"long": "The license information applicable to an item (e.g.&nbsp;the license an\narticle or software is released under; the copyright information for an\nitem; the classification status of a document)"
18054
},
18055
{
18056
"short": "A cite-specific pinpointer within the item.",
18057
"long": "A cite-specific pinpointer within the item (e.g.&nbsp;a page number within\na book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the\nlocator type (see the Locators term list)."
18058
},
18059
"Description of the item’s format or medium (e.g.&nbsp;“CD”, “DVD”,\n“Album”, etc.)",
18060
"Narrator (e.g.&nbsp;of an audio book).",
18061
"Descriptive text or notes about an item (e.g.&nbsp;in an annotated\nbibliography).",
18062
"Number identifying the item (e.g.&nbsp;a report number).",
18063
"Total number of pages of the cited item.",
18064
"Total number of volumes, used when citing multi-volume books and\nsuch.",
18065
"Organizer of an event (e.g.&nbsp;organizer of a workshop or\nconference).",
18066
{
18067
"short": "The original creator of a work.",
18068
"long": "The original creator of a work (e.g.&nbsp;the form of the author name\nlisted on the original version of a book; the historical author of a\nwork; the original songwriter or performer for a musical piece; the\noriginal developer or programmer for a piece of software; the original\nauthor of an adapted work such as a book adapted into a screenplay)"
18069
},
18070
"Issue date of the original version.",
18071
"Original publisher, for items that have been republished by a\ndifferent publisher.",
18072
"Geographic location of the original publisher (e.g.&nbsp;“London,\nUK”).",
18073
"Title of the original version (e.g.&nbsp;“Война и мир”, the untranslated\nRussian title of “War and Peace”).",
18074
"Range of pages the item (e.g.&nbsp;a journal article) covers in a\ncontainer (e.g.&nbsp;a journal issue).",
18075
"First page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
18076
"Last page of the range of pages the item (e.g.&nbsp;a journal article)\ncovers in a container (e.g.&nbsp;a journal issue).",
18077
{
18078
"short": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).",
18079
"long": "Number of the specific part of the item being cited (e.g.&nbsp;part 2 of a\njournal article).\nUse <code>part-title</code> for the title of the part, if any."
18080
},
18081
"Title of the specific part of an item being cited.",
18082
"A url to the pdf for this item.",
18083
"Performer of an item (e.g.&nbsp;an actor appearing in a film; a muscian\nperforming a piece of music).",
18084
"PubMed Central reference number.",
18085
"PubMed reference number.",
18086
"Printing number of the item or container holding the item.",
18087
"Producer (e.g.&nbsp;of a television or radio broadcast).",
18088
"A public url for this item.",
18089
"The publisher of the item.",
18090
"The geographic location of the publisher.",
18091
"Recipient (e.g.&nbsp;of a letter).",
18092
"Author of the item reviewed by the current item.",
18093
"Type of the item being reviewed by the current item (e.g.&nbsp;book,\nfilm).",
18094
"Title of the item reviewed by the current item.",
18095
"Scale of e.g.&nbsp;a map or model.",
18096
"Writer of a script or screenplay (e.g.&nbsp;of a film).",
18097
"Section of the item or container holding the item (e.g.&nbsp;“§2.0.1” for\na law; “politics” for a newspaper article).",
18098
"Creator of a series (e.g.&nbsp;of a television series).",
18099
"Source from whence the item originates (e.g.&nbsp;a library catalog or\ndatabase).",
18100
"Publication status of the item (e.g.&nbsp;“forthcoming”; “in press”;\n“advance online publication”; “retracted”)",
18101
"Date the item (e.g.&nbsp;a manuscript) was submitted for publication.",
18102
"Supplement number of the item or container holding the item (e.g.&nbsp;for\nsecondary legal items that are regularly updated between editions).",
18103
"Short/abbreviated form of<code>title</code>.",
18104
"Translator",
18105
"The <a href=\"https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types\">type</a>\nof the item.",
18106
"Uniform Resource Locator\n(e.g.&nbsp;“https://aem.asm.org/cgi/content/full/74/9/2766”)",
18107
"Version of the item (e.g.&nbsp;“2.0.9” for a software program).",
18108
{
18109
"short": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item.",
18110
"long": "Volume number of the item (e.g.&nbsp;“2” when citing volume 2 of a book)\nor the container holding the item (e.g.&nbsp;“2” when citing a chapter from\nvolume 2 of a book).\nUse <code>volume-title</code> for the title of the volume, if\nany."
18111
},
18112
{
18113
"short": "Title of the volume of the item or container holding the item.",
18114
"long": "Title of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections,\nand the like."
18115
},
18116
"Disambiguating year suffix in author-date styles (e.g.&nbsp;“a” in “Doe,\n1999a”).",
18117
"Manuscript configuration",
18118
"internal-schema-hack",
18119
"List execution engines you want to give priority when determining\nwhich engine should render a notebook. If two engines have support for a\nnotebook, the one listed earlier will be chosen. Quarto’s default order\nis ‘knitr’, ‘jupyter’, ‘markdown’, ‘julia’."
18120
],
18121
"schema/external-schemas.yml": [
18122
{
18123
"_internalId": 7,
18124
"type": "object",
18125
"description": "be an object",
18126
"properties": {
18127
"path": {
18128
"type": "string",
18129
"description": "be a string"
18130
},
18131
"name": {
18132
"type": "string",
18133
"description": "be a string"
18134
},
18135
"register": {
18136
"type": "boolean",
18137
"description": "be `true` or `false`",
18138
"completions": [
18139
"true",
18140
"false"
18141
],
18142
"exhaustiveCompletions": true
18143
},
18144
"script": {
18145
"_internalId": 4,
18146
"type": "anyOf",
18147
"anyOf": [
18148
{
18149
"_internalId": 2,
18150
"type": "anyOf",
18151
"anyOf": [
18152
{
18153
"type": "string",
18154
"description": "be a string"
18155
},
18156
{
18157
"_internalId": 1,
18158
"type": "object",
18159
"description": "be an object",
18160
"properties": {
18161
"path": {
18162
"type": "string",
18163
"description": "be a string"
18164
},
18165
"async": {
18166
"type": "boolean",
18167
"description": "be `true` or `false`",
18168
"completions": [
18169
"true",
18170
"false"
18171
],
18172
"exhaustiveCompletions": true
18173
}
18174
},
18175
"patternProperties": {},
18176
"required": [
18177
"path"
18178
]
18179
}
18180
],
18181
"description": "be at least one of: a string, an object"
18182
},
18183
{
18184
"_internalId": 3,
18185
"type": "array",
18186
"description": "be an array of values, where each element must be at least one of: a string, an object",
18187
"items": {
18188
"_internalId": 2,
18189
"type": "anyOf",
18190
"anyOf": [
18191
{
18192
"type": "string",
18193
"description": "be a string"
18194
},
18195
{
18196
"_internalId": 1,
18197
"type": "object",
18198
"description": "be an object",
18199
"properties": {
18200
"path": {
18201
"type": "string",
18202
"description": "be a string"
18203
},
18204
"async": {
18205
"type": "boolean",
18206
"description": "be `true` or `false`",
18207
"completions": [
18208
"true",
18209
"false"
18210
],
18211
"exhaustiveCompletions": true
18212
}
18213
},
18214
"patternProperties": {},
18215
"required": [
18216
"path"
18217
]
18218
}
18219
],
18220
"description": "be at least one of: a string, an object"
18221
}
18222
}
18223
],
18224
"description": "be at least one of: at least one of: a string, an object, an array of values, where each element must be at least one of: a string, an object"
18225
},
18226
"stylesheet": {
18227
"_internalId": 6,
18228
"type": "anyOf",
18229
"anyOf": [
18230
{
18231
"type": "string",
18232
"description": "be a string"
18233
},
18234
{
18235
"_internalId": 5,
18236
"type": "array",
18237
"description": "be an array of values, where each element must be a string",
18238
"items": {
18239
"type": "string",
18240
"description": "be a string"
18241
}
18242
}
18243
],
18244
"description": "be at least one of: a string, an array of values, where each element must be a string"
18245
},
18246
"self-contained": {
18247
"type": "boolean",
18248
"description": "be `true` or `false`",
18249
"completions": [
18250
"true",
18251
"false"
18252
],
18253
"exhaustiveCompletions": true
18254
}
18255
},
18256
"patternProperties": {},
18257
"required": [
18258
"name"
18259
],
18260
"propertyNames": {
18261
"errorMessage": "property ${value} does not match case convention path,name,register,script,stylesheet,self-contained",
18262
"type": "string",
18263
"pattern": "(?!(^self_contained$|^selfContained$))",
18264
"tags": {
18265
"case-convention": [
18266
"dash-case"
18267
],
18268
"error-importance": -5,
18269
"case-detection": true
18270
}
18271
},
18272
"tags": {
18273
"case-convention": [
18274
"dash-case"
18275
],
18276
"error-importance": -5,
18277
"case-detection": true
18278
},
18279
"$id": "plugin-reveal"
18280
}
18281
],
18282
"handlers/languages.yml": [
18283
"mermaid",
18284
"dot"
18285
],
18286
"handlers/lang-comment-chars.yml": {
18287
"r": "#",
18288
"python": "#",
18289
"julia": "#",
18290
"scala": "//",
18291
"matlab": "%",
18292
"csharp": "//",
18293
"fsharp": "//",
18294
"c": [
18295
"/*",
18296
"*/"
18297
],
18298
"css": [
18299
"/*",
18300
"*/"
18301
],
18302
"sas": [
18303
"*",
18304
";"
18305
],
18306
"powershell": "#",
18307
"bash": "#",
18308
"sql": "--",
18309
"mysql": "--",
18310
"psql": "--",
18311
"lua": "--",
18312
"cpp": "//",
18313
"cc": "//",
18314
"stan": "#",
18315
"octave": "#",
18316
"fortran": "!",
18317
"fortran95": "!",
18318
"awk": "#",
18319
"gawk": "#",
18320
"stata": "*",
18321
"java": "//",
18322
"groovy": "//",
18323
"sed": "#",
18324
"perl": "#",
18325
"prql": "#",
18326
"ruby": "#",
18327
"tikz": "%",
18328
"js": "//",
18329
"d3": "//",
18330
"node": "//",
18331
"sass": "//",
18332
"scss": "//",
18333
"coffee": "#",
18334
"go": "//",
18335
"asy": "//",
18336
"haskell": "--",
18337
"dot": "//",
18338
"ojs": "//",
18339
"apl": "⍝",
18340
"ocaml": [
18341
"(*",
18342
"*)"
18343
],
18344
"q": "/",
18345
"rust": "//",
18346
"mermaid": "%%"
18347
},
18348
"handlers/mermaid/schema.yml": {
18349
"_internalId": 222775,
18350
"type": "object",
18351
"description": "be an object",
18352
"properties": {
18353
"mermaid-format": {
18354
"_internalId": 222767,
18355
"type": "enum",
18356
"enum": [
18357
"png",
18358
"svg",
18359
"js"
18360
],
18361
"description": "be one of: `png`, `svg`, `js`",
18362
"completions": [
18363
"png",
18364
"svg",
18365
"js"
18366
],
18367
"exhaustiveCompletions": true
18368
},
18369
"theme": {
18370
"_internalId": 222774,
18371
"type": "anyOf",
18372
"anyOf": [
18373
{
18374
"type": "null",
18375
"description": "be the null value",
18376
"completions": [
18377
"null"
18378
],
18379
"exhaustiveCompletions": true
18380
},
18381
{
18382
"type": "string",
18383
"description": "be a string"
18384
}
18385
],
18386
"description": "be at least one of: the null value, a string"
18387
}
18388
},
18389
"patternProperties": {},
18390
"propertyNames": {
18391
"errorMessage": "property ${value} does not match case convention mermaid-format,theme",
18392
"type": "string",
18393
"pattern": "(?!(^mermaid_format$|^mermaidFormat$))",
18394
"tags": {
18395
"case-convention": [
18396
"dash-case"
18397
],
18398
"error-importance": -5,
18399
"case-detection": true
18400
}
18401
},
18402
"tags": {
18403
"case-convention": [
18404
"dash-case"
18405
],
18406
"error-importance": -5,
18407
"case-detection": true
18408
},
18409
"$id": "handlers/mermaid"
18410
},
18411
"schema/document-a11y.yml": [
18412
{
18413
"name": "axe",
18414
"tags": {
18415
"formats": [
18416
"$html-files"
18417
]
18418
},
18419
"schema": {
18420
"anyOf": [
18421
"boolean",
18422
{
18423
"object": {
18424
"properties": {
18425
"output": {
18426
"enum": [
18427
"json",
18428
"console",
18429
"document"
18430
],
18431
"description": "If set, output axe-core results on console. `json`: produce structured output; `console`: print output to javascript console; `document`: produce a visual report of violations in the document itself."
18432
}
18433
}
18434
}
18435
}
18436
]
18437
},
18438
"description": "When defined, run axe-core accessibility tests on the document."
18439
}
18440
],
18441
"schema/document-typst.yml": [
18442
{
18443
"name": "logo",
18444
"schema": {
18445
"ref": "logo-light-dark-specifier-path-optional"
18446
},
18447
"tags": {
18448
"formats": [
18449
"typst"
18450
]
18451
},
18452
"description": "The logo image."
18453
},
18454
{
18455
"name": "margin-geometry",
18456
"schema": {
18457
"object": {
18458
"closed": true,
18459
"properties": {
18460
"inner": {
18461
"ref": "marginalia-side-geometry",
18462
"description": "Inner (left) margin geometry."
18463
},
18464
"outer": {
18465
"ref": "marginalia-side-geometry",
18466
"description": "Outer (right) margin geometry."
18467
},
18468
"clearance": {
18469
"string": {
18470
"description": "Minimum vertical spacing between margin notes (default: 8pt)."
18471
}
18472
}
18473
}
18474
}
18475
},
18476
"tags": {
18477
"formats": [
18478
"typst"
18479
]
18480
},
18481
"description": {
18482
"short": "Advanced geometry settings for Typst margin layout.",
18483
"long": "Fine-grained control over marginalia package geometry. Most users should\nuse `margin` and `grid` options instead; these values are computed automatically.\n\nUser-specified values override the computed defaults.\n"
18484
}
18485
},
18486
{
18487
"name": "theorem-appearance",
18488
"schema": {
18489
"enum": [
18490
"simple",
18491
"fancy",
18492
"clouds",
18493
"rainbow"
18494
]
18495
},
18496
"default": "simple",
18497
"tags": {
18498
"formats": [
18499
"typst"
18500
]
18501
},
18502
"description": {
18503
"short": "Visual style for theorem environments in Typst output.",
18504
"long": "Controls how theorems, lemmas, definitions, etc. are rendered:\n\n- `simple`: Plain text with bold title and italic body (default)\n- `fancy`: Colored boxes using brand colors\n- `clouds`: Rounded colored background boxes\n- `rainbow`: Colored left border with colored title\n"
18505
}
18506
}
18507
],
18508
"schema/document-email.yml": [
18509
{
18510
"name": "email-version",
18511
"tags": {
18512
"formats": [
18513
"email"
18514
]
18515
},
18516
"schema": {
18517
"enum": [
18518
1,
18519
2
18520
]
18521
},
18522
"description": {
18523
"short": "Email format version",
18524
"long": "Specifies which email format version to use.\n\n- `1`: Legacy email format with document-level metadata (compatible with older Connect versions)\n- `2`: New email format with multiple individual emails and v2 markers (requires Posit Connect 2026.03 or later)\n"
18525
}
18526
}
18527
]
18528
}
18529