1
- name: documentclass
2
  schema:
3
    string:
4
      completions:
5
        - scrartcl
6
        - scrbook
7
        - scrreprt
8
        - scrlttr2
9
        - article
10
        - book
11
        - report
12
        - memoir
13
  tags:
14
    formats: [$pdf-all]
15
  default: scrartcl
16
  description: The document class.
17

18
- name: classoption
19
  schema:
20
    maybeArrayOf: string
21
  tags:
22
    formats: [$html-files, $pdf-all]
23
  description:
24
    short: Options for the document class,
25
    long: |
26
      For LaTeX/PDF output, the options set for the document
27
      class.
28

29
      For HTML output using KaTeX, you can render display
30
      math equations flush left using `classoption: fleqn`
31

32
- name: pagestyle
33
  schema:
34
    string:
35
      completions:
36
        - plain
37
        - empty
38
        - headings
39
  tags:
40
    formats: [$pdf-all]
41
  default: plain
42
  description: Control the `\pagestyle{}` for the document.
43

44
- name: papersize
45
  schema: string
46
  tags:
47
    formats: [$pdf-all, typst]
48
  description: |
49
    The paper size for the document.
50

51
- name: brand-mode
52
  schema:
53
    enum: [light, dark]
54
  default: light
55
  tags:
56
    formats: [typst, revealjs]
57
  description: |
58
    The brand mode to use for rendering the document, `light` or `dark`.
59

60
- name: layout
61
  schema:
62
    maybeArrayOf: string
63
  tags:
64
    formats: [context]
65
  description:
66
    short: The options for margins and text layout for this document.
67
    long: |
68
      The options for margins and text layout for this document.
69

70
      See [ConTeXt Layout](https://wiki.contextgarden.net/Layout) for additional information.
71

72
- name: page-layout
73
  schema:
74
    enum: [article, full, custom]
75
  default: article
76
  tags:
77
    formats: [$html-doc]
78
  description: The page layout to use for this document (`article`, `full`, or `custom`)
79

80
- name: page-width
81
  tags:
82
    formats: [docx, $odt-all]
83
  schema: number
84
  description:
85
    short: |
86
      Target page width for output (used to compute columns widths for `layout` divs)
87
    long: |
88
      Target body page width for output (used to compute columns widths for `layout` divs).
89
      Defaults to 6.5 inches, which corresponds to default letter page settings in 
90
      docx and odt (8.5 inches with 1 inch for each margins).
91

92
- name: grid
93
  tags:
94
    formats: [$html-doc, typst]
95
  schema:
96
    object:
97
      closed: true
98
      properties:
99
        content-mode:
100
          enum: ["auto", "standard", "full", "slim"]
101
          description: "Defines whether to use the standard, slim, or full content grid or to automatically select the most appropriate content grid."
102
        sidebar-width:
103
          string:
104
            description: "The base width of the sidebar (left) column in an HTML page."
105
        margin-width:
106
          string:
107
            description: "The base width of the margin (right) column. For Typst, this controls the width of the margin note column."
108
        body-width:
109
          string:
110
            description: "The base width of the body (center) column. For Typst, this is computed as the remainder after other columns."
111
        gutter-width:
112
          string:
113
            description: "The width of the gutter that appears between columns. For Typst, this is the gap between the text column and margin notes."
114
  description:
115
    short: "Properties of the grid system used to layout Quarto HTML and Typst pages."
116

117
- name: appendix-style
118
  schema:
119
    anyOf:
120
      - enum: ["default", "plain", "none"]
121
  default: "default"
122
  tags:
123
    formats: [$html-doc]
124
  description:
125
    short: The layout of the appendix for this document (`none`, `plain`, or `default`)
126
    long: |
127
      The layout of the appendix for this document (`none`, `plain`, or `default`).
128

129
      To completely disable any styling of the appendix, choose the appendix style `none`. For minimal styling, choose `plain.`
130

131
- name: appendix-cite-as
132
  schema:
133
    anyOf:
134
      - boolean
135
      - maybeArrayOf:
136
          enum: ["display", "bibtex"]
137
  tags:
138
    formats: [$html-doc]
139
  description:
140
    short: Controls the formats which are provided in the citation section of the appendix (`false`, `display`, or `bibtex`).
141
    long: |
142
      Controls the formats which are provided in the citation section of the appendix.
143

144
      Use `false` to disable the display of the 'cite as' appendix. Pass one or more of `display` or `bibtex` to enable that
145
      format in 'cite as' appendix.
146

147
- name: title-block-style
148
  schema:
149
    anyOf:
150
      - enum: ["default", "plain", "manuscript", "none"]
151
  default: "default"
152
  tags:
153
    formats: [$html-doc]
154
  description:
155
    short: The layout of the title block for this document (`none`, `plain`, or `default`).
156
    long: |
157
      The layout of the title block for this document (`none`, `plain`, or `default`).
158

159
      To completely disable any styling of the title block, choose the style `none`. For minimal styling, choose `plain.`
160

161
- name: title-block-banner
162
  schema:
163
    anyOf:
164
      - string
165
      - boolean
166
  tags:
167
    formats: [$html-doc]
168
  description:
169
    short: Apply a banner style treatment to the title block.
170
    long: |
171
      Applies a banner style treatment for the title block. You may specify one of the following values:
172

173
      `true`
174
      : Will enable the banner style display and automatically select a background color based upon the theme.
175

176
      `<css color value>`
177
      : If you provide a CSS color value, the banner will be enabled and the background color set to the provided CSS color.
178

179
      `<path>`
180
      : If you provide the path to a file, the banner will be enabled and the background image will be set to the file path.
181

182
      See `title-block-banner-color` if you'd like to control the color of the title block banner text.
183

184
- name: title-block-banner-color
185
  schema: string
186
  tags:
187
    formats: [$html-doc]
188
  description:
189
    short: Sets the color of text elements in a banner style title block.
190
    long: |
191
      Sets the color of text elements in a banner style title block. Use one of the following values:
192

193
      `body` | `body-bg`
194
      : Will set the text color to the body text color or body background color, respectively.
195

196
      `<css color value>`
197
      : If you provide a CSS color value, the text color will be set to the provided CSS color.
198

199
- name: title-block-categories
200
  schema: boolean
201
  default: true
202
  tags:
203
    formats: [$html-doc]
204
  description:
205
    short: Enables or disables the display of categories in the title block.
206

207
- name: max-width
208
  schema: string
209
  tags:
210
    formats: [$html-files]
211
  description: Adds a css `max-width` to the body Element.
212

213
- name: margin-left
214
  schema: string
215
  tags:
216
    formats: [$html-files, context, $pdf-all]
217
  description:
218
    short: Sets the left margin of the document.
219
    long: |
220
      For HTML output, sets the `margin-left` property on the Body element.
221

222
      For LaTeX output, sets the left margin if `geometry` is not 
223
      used (otherwise `geometry` overrides this value)
224

225
      For ConTeXt output, sets the left margin if `layout` is not used, 
226
      otherwise `layout` overrides these.
227

228
      For `wkhtmltopdf` sets the left page margin.
229

230
- name: margin-right
231
  schema: string
232
  tags:
233
    formats: [$html-files, context, $pdf-all]
234
  description:
235
    short: Sets the right margin of the document.
236
    long: |
237
      For HTML output, sets the `margin-right` property on the Body element.
238

239
      For LaTeX output, sets the right margin if `geometry` is not 
240
      used (otherwise `geometry` overrides this value)
241

242
      For ConTeXt output, sets the right margin if `layout` is not used, 
243
      otherwise `layout` overrides these.
244

245
      For `wkhtmltopdf` sets the right page margin.
246

247
- name: margin-top
248
  schema: string
249
  tags:
250
    formats: [$html-files, context, $pdf-all]
251
  description:
252
    short: Sets the top margin of the document.
253
    long: |
254
      For HTML output, sets the `margin-top` property on the Body element.
255

256
      For LaTeX output, sets the top margin if `geometry` is not 
257
      used (otherwise `geometry` overrides this value)
258

259
      For ConTeXt output, sets the top margin if `layout` is not used, 
260
      otherwise `layout` overrides these.
261

262
      For `wkhtmltopdf` sets the top page margin.
263

264
- name: margin-bottom
265
  schema: string
266
  tags:
267
    formats: [$html-files, context, $pdf-all]
268
  description:
269
    short: Sets the bottom margin of the document.
270
    long: |
271
      For HTML output, sets the `margin-bottom` property on the Body element.
272

273
      For LaTeX output, sets the bottom margin if `geometry` is not 
274
      used (otherwise `geometry` overrides this value)
275

276
      For ConTeXt output, sets the bottom margin if `layout` is not used, 
277
      otherwise `layout` overrides these.
278

279
      For `wkhtmltopdf` sets the bottom page margin.
280

281
- name: margin
282
  tags:
283
    formats: [revealjs, typst]
284
  schema:
285
    anyOf:
286
      - number
287
      - object:
288
          closed: true
289
          properties:
290
            x:
291
              string:
292
                description: "Horizontal margin (e.g. 1.5in)"
293
            y:
294
              string:
295
                description: "Vertical margin (e.g. 1.5in)"
296
            top:
297
              string:
298
                description: "Top margin (e.g. 1.5in)"
299
            bottom:
300
              string:
301
                description: "Bottom margin (e.g. 1.5in)"
302
            left:
303
              string:
304
                description: "Left margin (e.g. 1.5in)"
305
            right:
306
              string:
307
                description: "Right margin (e.g. 1.5in)"
308
  default: 0.1
309
  description:
310
    short: "Margin settings for Reveal.js or Typst output."
311
    long: |
312
      For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).
313

314
      For `typst`, a dictionary specifying page margins. Use `x` and `y` for symmetric
315
      horizontal/vertical margins, or `top`, `bottom`, `left`, `right` for
316
      individual sides. Values should include units (e.g. `1.5in`, `2cm`).
317

318
- name: geometry
319
  schema:
320
    maybeArrayOf: string
321
  tags:
322
    formats: [$pdf-all]
323
  description:
324
    short: Options for the geometry package.
325
    long: |
326
      Options for the [geometry](https://ctan.org/pkg/geometry) package. For example:
327

328
      ```yaml
329
      geometry:
330
        - top=30mm
331
        - left=20mm
332
        - heightrounded
333
      ```
334

335
- name: hyperrefoptions
336
  schema:
337
    maybeArrayOf: string
338
  tags:
339
    formats: [$pdf-all]
340
  description:
341
    short: Additional non-color options for the hyperref package.
342
    long: |
343
      Options for the [hyperref](https://ctan.org/pkg/hyperref) package. For example:
344

345
      ```yaml
346
      hyperrefoptions:
347
        - linktoc=all
348
        - pdfwindowui
349
        - pdfpagemode=FullScreen      
350
      ```
351

352
      To customize link colors, please see the [Quarto PDF reference](https://quarto.org/docs/reference/formats/pdf.html#colors).
353

354
- name: indent
355
  schema:
356
    anyOf:
357
      - boolean
358
      - string
359
  tags:
360
    formats: [$pdf-all, ms]
361
  default: false
362
  description:
363
    short: Whether to use document class settings for indentation.
364
    long: |
365
      Whether to use document class settings for indentation. If the document 
366
      class settings are not used, the default LaTeX template removes indentation 
367
      and adds space between paragraphs
368

369
      For groff (`ms`) documents, the paragraph indent, for example, `2m`.
370

371
- name: block-headings
372
  schema: boolean
373
  tags:
374
    formats: [$pdf-all]
375
  description:
376
    short: Make `\paragraph` and `\subparagraph` free-standing rather than run-in.
377
    long: |
378
      Make `\paragraph` and `\subparagraph` (fourth- and
379
      fifth-level headings, or fifth- and sixth-level with book
380
      classes) free-standing rather than run-in; requires further
381
      formatting to distinguish from `\subsubsection` (third- or
382
      fourth-level headings). Instead of using this option,
383
      [KOMA-Script](https://ctan.org/pkg/koma-script) can adjust headings 
384
      more extensively:
385

386
      ```yaml
387
      header-includes: |
388
        \RedeclareSectionCommand[
389
          beforeskip=-10pt plus -2pt minus -1pt,
390
          afterskip=1sp plus -1sp minus 1sp,
391
          font=\normalfont\itshape]{paragraph}
392
        \RedeclareSectionCommand[
393
          beforeskip=-10pt plus -2pt minus -1pt,
394
          afterskip=1sp plus -1sp minus 1sp,
395
          font=\normalfont\scshape,
396
          indent=0pt]{subparagraph}
397
      ```
398

399