1
- name: reference-doc
2
  tags:
3
    formats: [$office-all, odt]
4
  schema: path
5
  description: |
6
    Use the specified file as a style reference in producing a docx, 
7
    pptx, or odt file.
8

9
- name: brand
10
  schema:
11
    ref: brand-path-bool-light-dark
12
  description: |
13
    Branding information to use for this document. If a string, the path to a brand file.
14
    If false, don't use branding on this document. If an object, an inline brand
15
    definition, or an object with light and dark brand paths or definitions.
16

17
- name: theme
18
  tags:
19
    formats: [$html-doc, revealjs, beamer, dashboard]
20
  schema:
21
    anyOf:
22
      - string
23
      - arrayOf: string
24
      - object:
25
          closed: true
26
          properties:
27
            light:
28
              maybeArrayOf:
29
                string:
30
                  description: The light theme name, theme scss file, or a mix of both.
31
            dark:
32
              maybeArrayOf:
33
                string:
34
                  description: The dark theme name, theme scss file, or a mix of both.
35
  description: Theme name, theme scss file, or a mix of both.
36

37
- name: body-classes
38
  tags:
39
    formats: [$html-doc]
40
  schema: string
41
  description: |
42
    Classes to apply to the body of the document.
43

44
- name: minimal
45
  schema: boolean
46
  default: false
47
  tags:
48
    formats: [$html-doc]
49
  description: Disables the built in html features like theming, anchor sections, code block behavior, and more.
50

51
- name: document-css
52
  schema: boolean
53
  hidden: true
54
  default: true
55
  tags:
56
    formats: [$html-files]
57
  description: Enables inclusion of Pandoc default CSS for this document.
58

59
- name: css
60
  tags:
61
    formats: [$html-all]
62
  schema:
63
    maybeArrayOf: path
64
  description: "One or more CSS style sheets."
65

66
- name: anchor-sections
67
  schema: boolean
68
  default: true
69
  tags:
70
    formats: [$html-doc]
71
  description: Enables hover over a section title to see an anchor link.
72

73
- name: tabsets
74
  schema: boolean
75
  default: true
76
  tags:
77
    formats: [$html-doc]
78
  description: Enables tabsets to present content.
79

80
- name: smooth-scroll
81
  schema: boolean
82
  default: false
83
  tags:
84
    formats: [$html-doc]
85
  description: Enables smooth scrolling within the page.
86

87
- name: respect-user-color-scheme
88
  schema: boolean
89
  default: false
90
  tags:
91
    formats: [$html-doc]
92
  description:
93
    short: "Enables setting dark mode based on the `prefers-color-scheme` media query."
94
    long: |
95
      If set, Quarto reads the `prefers-color-scheme` media query to determine whether to show
96
      the user a dark or light page. Otherwise the author-preferred color scheme is shown.
97

98
- name: html-math-method
99
  tags:
100
    formats: [$html-doc, $epub-all, gfm]
101
  schema:
102
    anyOf:
103
      - ref: math-methods
104
      - object:
105
          properties:
106
            method:
107
              ref: math-methods
108
            url: string
109
          required: [method]
110
  description:
111
    short: "Method use to render math in HTML output"
112
    long: |
113
      Method use to render math in HTML output (`plain`, `webtex`, `gladtex`, `mathml`, `mathjax`, `katex`).
114

115
      See the Pandoc documentation on [Math Rendering in HTML](https://pandoc.org/MANUAL.html#math-rendering-in-html)
116
      for additional details.
117

118
- name: section-divs
119
  tags:
120
    formats: [$html-doc]
121
  schema: boolean
122
  default: true
123
  description: |
124
    Wrap sections in `<section>` tags and attach identifiers to the enclosing `<section>`
125
    rather than the heading itself.
126

127
- name: identifier-prefix
128
  tags:
129
    formats: [$html-files, $docbook-all, $markdown-all, haddock]
130
  schema: string
131
  description:
132
    short: "Specify a prefix to be added to all identifiers and internal links."
133
    long: |
134
      Specify a prefix to be added to all identifiers and internal links in HTML and
135
      DocBook output, and to footnote numbers in Markdown and Haddock output. 
136
      This is useful for preventing duplicate identifiers when generating fragments
137
      to be included in other pages.
138

139
- name: email-obfuscation
140
  tags:
141
    formats: [$html-files]
142
  schema:
143
    enum: [none, references, javascript]
144
  default: none
145
  description:
146
    short: "Method for obfuscating mailto: links in HTML documents."
147
    long: |
148
      Specify a method for obfuscating `mailto:` links in HTML documents.
149

150
      - `javascript`: Obfuscate links using JavaScript.
151
      - `references`: Obfuscate links by printing their letters as decimal or hexadecimal character references.
152
      - `none` (default): Do not obfuscate links.
153

154
- name: html-q-tags
155
  tags:
156
    formats: [$html-all]
157
  schema: boolean
158
  default: false
159
  description: "Use `<q>` tags for quotes in HTML."
160

161
- name: pdf-engine
162
  tags:
163
    formats: [$pdf-all, ms, context]
164
  schema:
165
    enum:
166
      [
167
        pdflatex,
168
        lualatex,
169
        xelatex,
170
        latexmk,
171
        tectonic,
172
        wkhtmltopdf,
173
        weasyprint,
174
        pagedjs-cli,
175
        prince,
176
        context,
177
        pdfroff,
178
        typst,
179
      ]
180
  description:
181
    short: "Use the specified engine when producing PDF output."
182
    long: |
183
      Use the specified engine when producing PDF output. If the engine is not
184
      in your PATH, the full path of the engine may be specified here. If this
185
      option is not specified, Quarto uses the following defaults
186
      depending on the output format in use:
187

188
      - `latex`: `lualatex` (other options: `pdflatex`, `xelatex`,
189
        `tectonic`, `latexmk`)
190
      - `context`: `context`
191
      - `html`:  `wkhtmltopdf` (other options: `prince`, `weasyprint`, `pagedjs-cli`;
192
        see [print-css.rocks](https://print-css.rocks) for a good
193
        introduction to PDF generation from HTML/CSS.)
194
      - `ms`:  `pdfroff`
195
      - `typst`: `typst`
196

197
- name: pdf-engine-opt
198
  tags:
199
    formats: [$pdf-all, ms, context]
200
  schema: string
201
  description:
202
    short: "Use the given string as a command-line argument to the `pdf-engine`."
203
    long: |
204
      Use the given string as a command-line argument to the pdf-engine.
205
      For example, to use a persistent directory foo for latexmk’s auxiliary
206
      files, use `pdf-engine-opt: -outdir=foo`. Note that no check for 
207
      duplicate options is done.
208

209
- name: pdf-engine-opts
210
  tags:
211
    formats: [$pdf-all, ms, context]
212
  schema:
213
    arrayOf: string
214
  description:
215
    short: "Pass multiple command-line arguments to the `pdf-engine`."
216
    long: |
217
      Use the given strings passed as a array as command-line arguments to the pdf-engine.
218
      This is an alternative to `pdf-engine-opt` for passing multiple options.
219

220
- name: beamerarticle
221
  schema: boolean
222
  tags:
223
    formats: [pdf]
224
  description: Whether to produce a Beamer article from this presentation.
225

226
- name: beameroption
227
  schema:
228
    maybeArrayOf: string
229
  tags:
230
    formats: [beamer]
231
  description: Add an extra Beamer option using `\setbeameroption{}`.
232

233
- name: aspectratio
234
  schema:
235
    enum:
236
      - 43
237
      - 169
238
      - 1610
239
      - 149
240
      - 141
241
      - 54
242
      - 32
243
  tags:
244
    formats: [beamer]
245
  description: The aspect ratio for this presentation.
246

247
- name: logo
248
  schema: path
249
  tags:
250
    formats: [beamer]
251
  description: The logo image.
252

253
- name: titlegraphic
254
  schema: path
255
  tags:
256
    formats: [beamer]
257
  description: The image for the title slide.
258

259
- name: navigation
260
  schema:
261
    enum: [empty, frame, vertical, horizontal]
262
  tags:
263
    formats: [beamer]
264
  description: Controls navigation symbols for the presentation (`empty`, `frame`, `vertical`, or `horizontal`)
265

266
- name: section-titles
267
  schema: boolean
268
  tags:
269
    formats: [beamer]
270
  default: true
271
  description: Whether to enable title pages for new sections.
272

273
- name: colortheme
274
  schema: string
275
  tags:
276
    formats: [beamer]
277
  description: The Beamer color theme for this presentation, passed to `\usecolortheme`.
278

279
- name: colorthemeoptions
280
  schema:
281
    maybeArrayOf: string
282
  tags:
283
    formats: [beamer]
284
  description: The Beamer color theme options for this presentation, passed to `\usecolortheme`.
285

286
- name: fonttheme
287
  schema: string
288
  tags:
289
    formats: [beamer]
290
  description: The Beamer font theme for this presentation, passed to `\usefonttheme`.
291

292
- name: fontthemeoptions
293
  schema:
294
    maybeArrayOf: string
295
  tags:
296
    formats: [beamer]
297
  description: The Beamer font theme options for this presentation, passed to `\usefonttheme`.
298

299
- name: innertheme
300
  schema: string
301
  tags:
302
    formats: [beamer]
303
  description: The Beamer inner theme for this presentation, passed to `\useinnertheme`.
304

305
- name: innerthemeoptions
306
  schema:
307
    maybeArrayOf: string
308
  tags:
309
    formats: [beamer]
310
  description: The Beamer inner theme options for this presentation, passed to `\useinnertheme`.
311

312
- name: outertheme
313
  schema: string
314
  tags:
315
    formats: [beamer]
316
  description: The Beamer outer theme for this presentation, passed to `\useoutertheme`.
317

318
- name: outerthemeoptions
319
  schema:
320
    maybeArrayOf: string
321
  tags:
322
    formats: [beamer]
323
  description: The Beamer outer theme options for this presentation, passed to `\useoutertheme`.
324

325
- name: themeoptions
326
  schema:
327
    maybeArrayOf: string
328
  tags:
329
    formats: [beamer]
330
  description: Options passed to LaTeX Beamer themes inside `\usetheme`.
331

332
- name: section
333
  schema: number
334
  tags:
335
    formats: [man]
336
  description: The section number in man pages.
337

338
- name: variant
339
  tags:
340
    formats: [$markdown-all]
341
  schema: string
342
  description: |
343
    Enable and disable extensions for markdown output (e.g. "+emoji")
344

345
- name: markdown-headings
346
  tags:
347
    formats: [$markdown-all, ipynb]
348
  schema:
349
    enum: [setext, atx]
350
  default: atx
351
  description: |
352
    Specify whether to use `atx` (`#`-prefixed) or
353
    `setext` (underlined) headings for level 1 and 2
354
    headings (`atx` or `setext`).
355

356
- name: ipynb-output
357
  tags:
358
    formats: [ipynb]
359
  schema:
360
    enum: [none, all, best]
361
  default: best
362
  description:
363
    short: "Determines which ipynb cell output formats are rendered (`none`, `all`, or `best`)."
364
    long: |
365
      Determines which ipynb cell output formats are rendered.
366

367
      - `all`: Preserve all of the data formats included in the original.
368
      - `none`: Omit the contents of data cells.
369
      - `best` (default): Instruct pandoc to try to pick the
370
        richest data block in each output cell that is compatible
371
        with the output format.
372

373
- name: quarto-required
374
  schema: string
375
  description:
376
    short: "semver version range for required quarto version"
377
    long: |
378
      A semver version range describing the supported quarto versions for this document
379
      or project.
380

381
      Examples:
382

383
      - `>= 1.1.0`: Require at least quarto version 1.1
384
      - `1.*`: Require any quarto versions whose major version number is 1
385

386
- name: preview-mode
387
  schema: string
388
  tags:
389
    formats: [$jats-all, gfm]
390
  description:
391
    short: "The mode to use when previewing this document."
392
    long: |
393
      The mode to use when previewing this document. To disable any special
394
      previewing features, pass `raw` as the preview-mode.
395

396