1
- name: from
2
  alias: reader
3
  schema: string
4
  default: markdown
5
  description:
6
    short: "Format to read from"
7
    long: |
8
      Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).
9

10
- name: output-file
11
  schema:
12
    ref: pandoc-format-output-file
13
  default: "Input filename with output extension (e.g. .pdf, .html, etc.)"
14
  description: "Output file to write to"
15

16
- name: output-ext
17
  schema: string
18
  description: |
19
    Extension to use for generated output file
20

21
- name: template
22
  disabled: [$office-all, ipynb]
23
  schema: path
24
  description: |
25
    Use the specified file as a custom template for the generated document.
26

27
- name: template-partials
28
  disabled: [$office-all, ipynb]
29
  schema:
30
    maybeArrayOf: path
31
  description: |
32
    Include the specified files as partials accessible to the template for the generated content.
33

34
- name: embed-resources
35
  tags:
36
    formats: [$html-files]
37
  schema: boolean
38
  default: false
39
  description:
40
    short: "Produce a standalone HTML file with no external dependencies"
41
    long: |
42
      Produce a standalone HTML file with no external dependencies, using
43
      `data:` URIs to incorporate the contents of linked scripts, stylesheets,
44
      images, and videos. The resulting file should be "self-contained," in the
45
      sense that it needs no external files and no net access to be displayed
46
      properly by a browser. This option works only with HTML output formats,
47
      including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`, `slidy`,
48
      `slideous`, `dzslides`, and `revealjs`. Scripts, images, and stylesheets at
49
      absolute URLs will be downloaded; those at relative URLs will be sought
50
      relative to the working directory (if the first source
51
      file is local) or relative to the base URL (if the first source
52
      file is remote).  Elements with the attribute
53
      `data-external="1"` will be left alone; the documents they
54
      link to will not be incorporated in the document.
55
      Limitation: resources that are loaded dynamically through
56
      JavaScript cannot be incorporated; as a result, some
57
      advanced features (e.g.  zoom or speaker notes) may not work
58
      in an offline "self-contained" `reveal.js` slide show.
59

60
- name: self-contained
61
  tags:
62
    formats: [$html-files]
63
  schema: boolean
64
  default: false
65
  hidden: true
66
  description:
67
    short: "Produce a standalone HTML file with no external dependencies"
68
    long: |
69
      Produce a standalone HTML file with no external dependencies. Note that
70
      this option has been deprecated in favor of `embed-resources`.
71

72
- name: self-contained-math
73
  tags:
74
    formats: [$html-files]
75
  schema: boolean
76
  default: false
77
  description:
78
    short: "Embed math libraries (e.g. MathJax) within `self-contained` output."
79
    long: |
80
      Embed math libraries (e.g. MathJax) within `self-contained` output.
81
      Note that math libraries are not embedded by default because they are 
82
       quite large and often time consuming to download.
83

84
- name: filters
85
  schema:
86
    ref: pandoc-format-filters
87
  description: |
88
    Specify executables or Lua scripts to be used as a filter transforming
89
    the pandoc AST after the input is parsed and before the output is written.
90

91
- name: shortcodes
92
  schema:
93
    ref: pandoc-shortcodes
94
  description: |
95
    Specify Lua scripts that implement shortcode handlers
96

97
- name: keep-md
98
  schema: boolean
99
  default: false
100
  tags:
101
    contexts: [document-execute]
102
  description: "Keep the markdown file generated by executing code"
103

104
- name: keep-ipynb
105
  schema: boolean
106
  default: false
107
  tags:
108
    contexts: [document-execute]
109
  description: "Keep the notebook file generated from executing code."
110

111
- name: ipynb-filters
112
  schema:
113
    arrayOf: "string"
114
  tags:
115
    contexts: [document-execute]
116
  description: "Filters to pre-process ipynb files before rendering to markdown"
117

118
- name: ipynb-shell-interactivity
119
  schema:
120
    enum: [null, all, last, last_expr, none, last_expr_or_assign]
121
  tags:
122
    contexts: [document-execute]
123
    engine: jupyter
124
  description: |
125
    Specify which nodes should be run interactively (displaying output from expressions)
126

127
- name: plotly-connected
128
  schema: boolean
129
  default: false
130
  tags:
131
    contexts: [document-execute]
132
    engine: jupyter
133
  description: |
134
    If true, use the "notebook_connected" plotly renderer, which downloads
135
    its dependencies from a CDN and requires an internet connection to view.
136

137
- name: keep-typ
138
  tags:
139
    formats: [typst]
140
  schema: boolean
141
  default: false
142
  description: "Keep the intermediate typst file used during render."
143

144
- name: keep-tex
145
  tags:
146
    formats: [pdf, beamer]
147
  schema: boolean
148
  default: false
149
  description: "Keep the intermediate tex file used during render."
150

151
- name: extract-media
152
  schema: path
153
  description:
154
    short: |
155
      Extract images and other media contained in or linked from the source document to the
156
      path DIR.
157
    long: |
158
      Extract images and other media contained in or linked from the source document to the
159
      path DIR, creating it if necessary, and adjust the images references in the document
160
      so they point to the extracted files. Media are downloaded, read from the file
161
      system, or extracted from a binary container (e.g. docx), as needed. The original
162
      file paths are used if they are relative paths not containing ... Otherwise filenames
163
      are constructed from the SHA1 hash of the contents.
164

165
- name: resource-path
166
  schema:
167
    arrayOf: path
168
  default: ["."]
169
  description: |
170
    List of paths to search for images and other resources.
171

172
- name: default-image-extension
173
  schema: string
174
  description:
175
    short: |
176
      Specify a default extension to use when image paths/URLs have no extension.
177
    long: |
178
      Specify a default extension to use when image paths/URLs have no
179
      extension.  This allows you to use the same source for formats that
180
      require different kinds of images.  Currently this option only affects
181
      the Markdown and LaTeX readers.
182

183
- name: abbreviations
184
  schema: string
185
  description:
186
    short: |
187
      Specifies a custom abbreviations file, with abbreviations one to a line.
188
    long: |
189
      Specifies a custom abbreviations file, with abbreviations one to a line.
190
      This list is used when reading Markdown input: strings found in this list
191
      will be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX.  The strings may not contain
192
      spaces.
193

194
- name: dpi
195
  schema: number
196
  default: 96
197
  description:
198
    short: |
199
      Specify the default dpi (dots per inch) value for conversion from pixels to inch/
200
      centimeters and vice versa.
201
    long: |
202
      Specify the default dpi (dots per inch) value for conversion from pixels to inch/
203
      centimeters and vice versa. (Technically, the correct term would be ppi: pixels per
204
      inch.) The default is `96`. When images contain information about dpi internally, the
205
      encoded value is used instead of the default specified by this option.
206

207
- name: html-table-processing
208
  schema:
209
    enum: [none]
210
  description: If `none`, do not process tables in HTML input.
211

212
- name: html-pre-tag-processing
213
  tags:
214
    formats: [typst]
215
  schema:
216
    enum: [none, parse]
217
  description: If `none`, ignore any divs with `html-pre-tag-processing=parse` enabled.
218

219
- name: css-property-processing
220
  tags:
221
    formats: [typst]
222
  schema:
223
    enum: [none, translate]
224
  default: translate
225
  description:
226
    short: CSS property translation
227
    long: If `translate`, translate CSS properties into output format properties. If `none`, do not process css properties.
228

229
- name: use-rsvg-convert
230
  schema: boolean
231
  default: true
232
  tags:
233
    formats: [$pdf-all]
234
  description: If `true`, attempt to use `rsvg-convert` to convert SVG images to PDF.
235

236