1
- name: mainfont
2
  schema: string
3
  tags:
4
    formats: [$html-doc, context, $pdf-all, typst]
5
  description:
6
    short: Sets the main font for the document.
7
    long: |
8
      For HTML output, sets the CSS `font-family` on the HTML element.
9

10
      For LaTeX output, the main font family for use with `xelatex` or 
11
      `lualatex`. Takes the name of any system font, using the
12
      [`fontspec`](https://ctan.org/pkg/fontspec) package. 
13

14
      For ConTeXt output, the main font family. Use the name of any 
15
      system font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more
16
      information.
17

18
- name: monofont
19
  schema: string
20
  tags:
21
    formats: [$html-doc, context, $pdf-all]
22
  description:
23
    short: Sets the font used for when displaying code.
24
    long: |
25
      For HTML output, sets the CSS font-family property on code elements.
26

27
      For PowerPoint output, sets the font used for code.
28

29
      For LaTeX output, the monospace font family for use with `xelatex` or 
30
      `lualatex`: take the name of any system font, using the
31
      [`fontspec`](https://ctan.org/pkg/fontspec) package.  
32

33
      For ConTeXt output, the monspace font family. Use the name of any 
34
      system font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more
35
      information.
36

37
- name: codefont
38
  schema: string
39
  tags:
40
    formats: [typst]
41
  description:
42
    short: Sets the font used for code in Typst output.
43
    long: |
44
      For Typst output, sets the font used for displaying code. Takes
45
      the name of any font available to Typst (system fonts or fonts in
46
      directories specified by `font-paths`).
47

48
- name: fontsize
49
  schema: string
50
  tags:
51
    formats: [$html-doc, context, $pdf-all, typst]
52
  description:
53
    short: Sets the main font size for the document.
54
    long: |
55
      For HTML output, sets the base CSS `font-size` property.
56

57
      For LaTeX and ConTeXt output, sets the font size for the document body text.
58

59
- name: fontenc
60
  schema: string
61
  tags:
62
    formats: [$pdf-all]
63
  default: T1
64
  description:
65
    short: Allows font encoding to be specified through `fontenc` package.
66
    long: |
67
      Allows font encoding to be specified through [`fontenc`](https://www.ctan.org/pkg/fontenc) package.
68

69
      See [LaTeX Font Encodings Guide](https://ctan.org/pkg/encguide) for addition information on font encoding.
70

71
- name: fontfamily
72
  schema: string
73
  tags:
74
    formats: [$pdf-all, ms]
75
  default: "Latin Modern"
76
  description:
77
    short: Font package to use when compiling a PDF with the `pdflatex` `pdf-engine`.
78
    long: |
79
      Font package to use when compiling a PDf with the `pdflatex` `pdf-engine`. 
80

81
      See [The LaTeX Font Catalogue](https://tug.org/FontCatalogue/) for a 
82
      summary of font options available.
83

84
      For groff (`ms`) files, the font family for example, `T` or `P`.
85

86
- name: fontfamilyoptions
87
  schema:
88
    maybeArrayOf: string
89
  tags:
90
    formats: [$pdf-all]
91
  description:
92
    short: Options for the package used as `fontfamily`.
93
    long: |
94
      Options for the package used as `fontfamily`.
95

96
      For example, to use the Libertine font with proportional lowercase
97
      (old-style) figures through the [`libertinus`](https://ctan.org/pkg/libertinus) package:
98

99
      ```yaml
100
      fontfamily: libertinus
101
      fontfamilyoptions:
102
        - osf
103
        - p
104
      ```
105

106
- name: sansfont
107
  schema: string
108
  tags:
109
    formats: [$pdf-all]
110
  description:
111
    short: The sans serif font family for use with `xelatex` or `lualatex`.
112
    long: |
113
      The sans serif font family for use with `xelatex` or 
114
      `lualatex`. Takes the name of any system font, using the
115
      [`fontspec`](https://ctan.org/pkg/fontspec) package.
116

117
- name: mathfont
118
  schema: string
119
  tags:
120
    formats: [$pdf-all, typst]
121
  description:
122
    short: The math font family for use with `xelatex`, `lualatex`, or Typst.
123
    long: |
124
      For LaTeX output, the math font family for use with `xelatex` or
125
      `lualatex`. Takes the name of any system font, using the
126
      [`fontspec`](https://ctan.org/pkg/fontspec) package.
127

128
      For Typst output, sets the font used for mathematical content.
129

130
- name: CJKmainfont
131
  schema: string
132
  tags:
133
    formats: [$pdf-all]
134
  description:
135
    short: The CJK main font family for use with `xelatex` or `lualatex`.
136
    long: |
137
      The CJK main font family for use with `xelatex` or 
138
      `lualatex` using the [`xecjk`](https://ctan.org/pkg/xecjk) package.
139

140
# dependencies upon other key values (e.g. pdf-engine: xelatex)
141
- name: mainfontoptions
142
  schema:
143
    maybeArrayOf: string
144
  tags:
145
    formats: [$pdf-all]
146
  description:
147
    short: The main font options for use with `xelatex` or `lualatex`.
148
    long: |
149
      The main font options for use with `xelatex` or `lualatex` allowing
150
      any options available through [`fontspec`](https://ctan.org/pkg/fontspec).
151

152
      For example, to use the [TeX Gyre](http://www.gust.org.pl/projects/e-foundry/tex-gyre) 
153
      version of Palatino with lowercase figures:
154

155
      ```yaml
156
      mainfont: TeX Gyre Pagella
157
      mainfontoptions:
158
        - Numbers=Lowercase
159
        - Numbers=Proportional    
160
      ```
161

162
- name: sansfontoptions
163
  schema:
164
    maybeArrayOf: string
165
  tags:
166
    formats: [$pdf-all]
167
  description:
168
    short: The sans serif font options for use with `xelatex` or `lualatex`.
169
    long: |
170
      The sans serif font options for use with `xelatex` or `lualatex` allowing
171
      any options available through [`fontspec`](https://ctan.org/pkg/fontspec).
172

173
- name: monofontoptions
174
  schema:
175
    maybeArrayOf: string
176
  tags:
177
    formats: [$pdf-all]
178
  description:
179
    short: The monospace font options for use with `xelatex` or `lualatex`.
180
    long: |
181
      The monospace font options for use with `xelatex` or `lualatex` allowing
182
      any options available through [`fontspec`](https://ctan.org/pkg/fontspec).
183

184
- name: mathfontoptions
185
  schema:
186
    maybeArrayOf: string
187
  tags:
188
    formats: [$pdf-all]
189
  description:
190
    short: The math font options for use with `xelatex` or `lualatex`.
191
    long: |
192
      The math font options for use with `xelatex` or `lualatex` allowing
193
      any options available through [`fontspec`](https://ctan.org/pkg/fontspec).
194

195
- name: font-paths
196
  schema:
197
    maybeArrayOf: string
198
  tags:
199
    formats: [typst]
200
  description:
201
    short: "Adds additional directories to search for fonts when compiling with Typst."
202
    long: |
203
      Locally, Typst uses installed system fonts. In addition, some custom path 
204
      can be specified to add directories that should be scanned for fonts.
205
      Setting this configuration will take precedence over any path set in TYPST_FONT_PATHS environment variable.
206

207
- name: CJKoptions
208
  schema:
209
    maybeArrayOf: string
210
  tags:
211
    formats: [$pdf-all]
212
  description:
213
    short: The CJK font options for use with `xelatex` or `lualatex`.
214
    long: |
215
      The CJK font options for use with `xelatex` or `lualatex` allowing
216
      any options available through [`fontspec`](https://ctan.org/pkg/fontspec).
217

218
- name: microtypeoptions
219
  schema:
220
    maybeArrayOf: string
221
  tags:
222
    formats: [$pdf-all]
223
  description:
224
    short: Options to pass to the microtype package.
225
    long: Options to pass to the [microtype](https://ctan.org/pkg/microtype) package.
226

227
- name: pointsize
228
  schema: string
229
  tags:
230
    formats: [ms]
231
  description: The point size, for example, `10p`.
232

233
- name: lineheight
234
  schema: string
235
  tags:
236
    formats: [ms]
237
  description: The line height, for example, `12p`.
238

239
- name: linestretch
240
  schema:
241
    anyOf:
242
      - string
243
      - number
244
  tags:
245
    formats: [$html-doc, context, $pdf-all, typst]
246
  description:
247
    short: Sets the line height or spacing for text in the document.
248
    long: |
249
      For HTML output sets the CSS `line-height` property on the html
250
      element, which is preferred to be unitless.
251

252
      For LaTeX output, adjusts line spacing using the
253
      [setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.
254

255
      For Typst output, adjusts the spacing between lines of text.
256

257
- name: interlinespace
258
  schema:
259
    maybeArrayOf: string
260
  tags:
261
    formats: [context]
262
  description: Adjusts line spacing using the `\setupinterlinespace` command.
263

264
- name: linkstyle
265
  schema:
266
    string:
267
      completions:
268
        - normal
269
        - bold
270
        - slanted
271
        - boldslanted
272
        - type
273
        - cap
274
        - small
275
  tags:
276
    formats: [context]
277
  description: The typeface style for links in the document.
278

279
- name: whitespace
280
  schema: string
281
  tags:
282
    formats: [context]
283
  description:
284
    short: Set the spacing between paragraphs, for example `none`, `small.
285
    long: |
286
      Set the spacing between paragraphs, for example `none`, `small` 
287
      using the [`setupwhitespace`](https://wiki.contextgarden.net/Command/setupwhitespace) 
288
      command.
289

290