2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: https://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`iftex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `lualatex` uses
147[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149`mathspec` variable is set, `xelatex` will use [`mathspec`]
150instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151packages are used if available, and [`csquotes`] will be used
152for [typography] if the `csquotes` variable or metadata field is
153set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`iftex`]: https://ctan.org/pkg/iftex
184[`listings`]: https://ctan.org/pkg/listings
185[`lm`]: https://ctan.org/pkg/lm
186[`longtable`]: https://ctan.org/pkg/longtable
187[`mathspec`]: https://ctan.org/pkg/mathspec
188[`microtype`]: https://ctan.org/pkg/microtype
189[`natbib`]: https://ctan.org/pkg/natbib
190[`parskip`]: https://ctan.org/pkg/parskip
191[`polyglossia`]: https://ctan.org/pkg/polyglossia
192[`prince`]: https://www.princexml.com/
193[`setspace`]: https://ctan.org/pkg/setspace
194[`ulem`]: https://ctan.org/pkg/ulem
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
196[`upquote`]: https://ctan.org/pkg/upquote
197[`weasyprint`]: https://weasyprint.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
199[`xcolor`]: https://ctan.org/pkg/xcolor
200[`xecjk`]: https://ctan.org/pkg/xecjk
201[`xurl`]: https://ctan.org/pkg/xurl
202[`selnolig`]: https://ctan.org/pkg/selnolig
206## Reading from the Web
208Instead of an input file, an absolute URI may be given. In this case
209pandoc will fetch the content using HTTP:
211 pandoc -f html -t markdown https://www.fsf.org
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
221## General options {.options}
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
225: Specify input format. *FORMAT* can be:
228 - `bibtex` ([BibTeX] bibliography)
229 - `biblatex` ([BibLaTeX] bibliography)
230 - `commonmark` ([CommonMark] Markdown)
231 - `commonmark_x` ([CommonMark] Markdown with extensions)
232 - `creole` ([Creole 1.0])
233 - `csljson` ([CSL JSON] bibliography)
234 - `csv` ([CSV] table)
235 - `docbook` ([DocBook])
236 - `docx` ([Word docx])
237 - `dokuwiki` ([DokuWiki markup])
239 - `fb2` ([FictionBook2] e-book)
240 - `gfm` ([GitHub-Flavored Markdown]),
241 or the deprecated and less accurate `markdown_github`;
242 use [`markdown_github`](#markdown-variants) only
243 if you need extensions not supported in [`gfm`](#markdown-variants).
244 - `haddock` ([Haddock markup])
246 - `ipynb` ([Jupyter notebook])
247 - `jats` ([JATS] XML)
248 - `jira` ([Jira]/Confluence wiki markup)
249 - `json` (JSON version of native AST)
251 - `markdown` ([Pandoc's Markdown])
252 - `markdown_mmd` ([MultiMarkdown])
253 - `markdown_phpextra` ([PHP Markdown Extra])
254 - `markdown_strict` (original unextended [Markdown])
255 - `mediawiki` ([MediaWiki markup])
258 - `native` (native Haskell)
261 - `org` ([Emacs Org mode])
262 - `rst` ([reStructuredText])
264 - `textile` ([Textile])
265 - `tikiwiki` ([TikiWiki markup])
266 - `twiki` ([TWiki markup])
267 - `vimwiki` ([Vimwiki])
270 Extensions can be individually enabled or disabled by
271 appending `+EXTENSION` or `-EXTENSION` to the format name.
272 See [Extensions] below, for a list of extensions and
273 their names. See `--list-input-formats` and `--list-extensions`,
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
278: Specify output format. *FORMAT* can be:
280 ::: {#output-formats}
281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283 - `bibtex` ([BibTeX] bibliography)
284 - `biblatex` ([BibLaTeX] bibliography)
285 - `commonmark` ([CommonMark] Markdown)
286 - `commonmark_x` ([CommonMark] Markdown with extensions)
287 - `context` ([ConTeXt])
288 - `csljson` ([CSL JSON] bibliography)
289 - `docbook` or `docbook4` ([DocBook] 4)
290 - `docbook5` (DocBook 5)
291 - `docx` ([Word docx])
292 - `dokuwiki` ([DokuWiki markup])
293 - `epub` or `epub3` ([EPUB] v3 book)
295 - `fb2` ([FictionBook2] e-book)
296 - `gfm` ([GitHub-Flavored Markdown]),
297 or the deprecated and less accurate `markdown_github`;
298 use [`markdown_github`](#markdown-variants) only
299 if you need extensions not supported in [`gfm`](#markdown-variants).
300 - `haddock` ([Haddock markup])
301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302 - `html4` ([XHTML] 1.0 Transitional)
303 - `icml` ([InDesign ICML])
304 - `ipynb` ([Jupyter notebook])
305 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308 - `jats` (alias for `jats_archiving`)
309 - `jira` ([Jira]/Confluence wiki markup)
310 - `json` (JSON version of native AST)
313 - `markdown` ([Pandoc's Markdown])
314 - `markdown_mmd` ([MultiMarkdown])
315 - `markdown_phpextra` ([PHP Markdown Extra])
316 - `markdown_strict` (original unextended [Markdown])
317 - `mediawiki` ([MediaWiki markup])
320 - `native` (native Haskell),
321 - `odt` ([OpenOffice text document][ODT])
323 - `opendocument` ([OpenDocument])
324 - `org` ([Emacs Org mode])
326 - `plain` (plain text),
327 - `pptx` ([PowerPoint] slide show)
328 - `rst` ([reStructuredText])
329 - `rtf` ([Rich Text Format])
330 - `texinfo` ([GNU Texinfo])
331 - `textile` ([Textile])
332 - `slideous` ([Slideous] HTML and JavaScript slide show)
333 - `slidy` ([Slidy] HTML and JavaScript slide show)
334 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336 - `s5` ([S5] HTML and JavaScript slide show)
337 - `tei` ([TEI Simple])
338 - `xwiki` ([XWiki markup])
339 - `zimwiki` ([ZimWiki markup])
340 - the path of a custom Lua writer, see [Custom writers] below
343 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344 to *stdout* unless forced with `-o -`.
346 Extensions can be individually enabled or
347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348 name. See [Extensions] below, for a list of extensions and their
349 names. See `--list-output-formats` and `--list-extensions`, below.
351`-o` *FILE*, `--output=`*FILE*
353: Write output to *FILE* instead of *stdout*. If *FILE* is
354 `-`, output will go to *stdout*, even if a non-textual format
355 (`docx`, `odt`, `epub2`, `epub3`) is specified.
357`--data-dir=`*DIRECTORY*
359: Specify the user data directory to search for pandoc data files.
360 If this option is not specified, the default user data directory
361 will be used. On \*nix and macOS systems this will be the `pandoc`
362 subdirectory of the XDG data directory (by default,
363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364 environment variable). If that directory does not exist and
365 `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366 On Windows the default user data directory is
367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
368 You can find the default user data directory on your system by
369 looking at the output of `pandoc --version`.
370 Data files placed in this directory (for example, `reference.odt`,
371 `reference.docx`, `epub.css`, `templates`) will override
372 pandoc's normal defaults.
374`-d` *FILE*, `--defaults=`*FILE*
376: Specify a set of default option settings. *FILE* is a YAML
377 file whose fields correspond to command-line option
378 settings. All options for document conversion, including input
379 and output files, can be set using a defaults file. The file will
380 be searched for first in the working directory, and then in
381 the `defaults` subdirectory of the user data directory
382 (see `--data-dir`). The `.yaml` extension may be omitted.
383 See the section [Default files] for more information on the
384 file format. Settings from the defaults file may be
385 overridden or extended by subsequent options on the command
390: Generate a bash completion script. To enable bash completion
391 with pandoc, add this to your `.bashrc`:
393 eval "$(pandoc --bash-completion)"
397: Give verbose debugging output.
401: Suppress warning messages.
405: Exit with error status if there are any warnings.
409: Write log messages in machine-readable JSON format to
410 *FILE*. All messages above DEBUG level will be written,
411 regardless of verbosity settings (`--verbose`, `--quiet`).
413`--list-input-formats`
415: List supported input formats, one per line.
417`--list-output-formats`
419: List supported output formats, one per line.
421`--list-extensions`[`=`*FORMAT*]
423: List supported extensions for *FORMAT*, one per line, preceded
424 by a `+` or `-` indicating whether it is enabled by default
425 in *FORMAT*. If *FORMAT* is not specified, defaults for
426 pandoc's Markdown are given.
428`--list-highlight-languages`
430: List supported languages for syntax highlighting, one per
433`--list-highlight-styles`
435: List supported styles for syntax highlighting, one per line.
436 See `--highlight-style`.
446[Markdown]: https://daringfireball.net/projects/markdown/
447[CommonMark]: https://commonmark.org
448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452[S5]: https://meyerweb.com/eric/tools/s5/
453[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454[Slideous]: https://goessner.net/articles/slideous/
455[HTML]: https://www.w3.org/html/
456[HTML5]: https://html.spec.whatwg.org/
457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458[XHTML]: https://www.w3.org/TR/xhtml1/
459[LaTeX]: https://www.latex-project.org/
460[`beamer`]: https://ctan.org/pkg/beamer
461[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462[ConTeXt]: https://www.contextgarden.net/
463[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464[DocBook]: https://docbook.org
465[JATS]: https://jats.nlm.nih.gov
466[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467[txt2tags]: https://txt2tags.org
468[EPUB]: http://idpf.org/epub
469[OPML]: http://dev.opml.org/spec2.html
470[OpenDocument]: http://opendocument.xml.org
471[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472[Textile]: https://www.promptworks.com/textile
473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481[CSV]: https://tools.ietf.org/html/rfc4180
482[roff man]: https://man.cx/groff_man(7)
483[roff ms]: https://man.cx/groff_ms(7)
484[Haskell]: https://www.haskell.org
485[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486[Emacs Org mode]: https://orgmode.org
487[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488[AsciiDoctor]: https://asciidoctor.org/
489[DZSlides]: https://paulrouget.com/dzslides/
490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491[PDF]: https://www.adobe.com/pdf/
492[reveal.js]: https://revealjs.com/
493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496[TEI Simple]: https://github.com/TEIC/TEI-Simple
497[Muse]: https://amusewiki.org/library/manual
498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499[Vimwiki]: https://vimwiki.github.io
500[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501[BibTeX]: https://ctan.org/pkg/bibtex
502[BibLaTeX]: https://ctan.org/pkg/biblatex
504## Reader options {.options}
506`--shift-heading-level-by=`*NUMBER*
508: Shift heading levels by a positive or negative integer.
509 For example, with `--shift-heading-level-by=-1`, level 2
510 headings become level 1 headings, and level 3 headings
511 become level 2 headings. Headings cannot have a level
512 less than 1, so a heading that would be shifted below level 1
513 becomes a regular paragraph. Exception: with a shift of -N,
514 a level-N heading at the beginning of the document
515 replaces the metadata title. `--shift-heading-level-by=-1`
516 is a good choice when converting HTML or Markdown documents that
517 use an initial level-1 heading for the document title and
518 level-2+ headings for sections. `--shift-heading-level-by=1`
519 may be a good choice for converting Markdown documents that
520 use level-1 headings for sections to HTML, since pandoc uses
521 a level-1 heading to render the document title.
523`--base-header-level=`*NUMBER*
525: *Deprecated. Use `--shift-heading-level-by`=X instead,
526 where X = NUMBER - 1.* Specify the base level for headings
529`--strip-empty-paragraphs`
531: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532 Ignore paragraphs with no content. This option is useful
533 for converting word processing documents where users have
534 used empty paragraphs to create inter-paragraph space.
536`--indented-code-classes=`*CLASSES*
538: Specify classes to use for indented code blocks--for example,
539 `perl,numberLines` or `haskell`. Multiple classes may be separated
542`--default-image-extension=`*EXTENSION*
544: Specify a default extension to use when image paths/URLs have no
545 extension. This allows you to use the same source for formats that
546 require different kinds of images. Currently this option only affects
547 the Markdown and LaTeX readers.
551: Parse each file individually before combining for multifile
552 documents. This will allow footnotes in different files with the
553 same identifiers to work as expected. If this option is set,
554 footnotes and links will not work across files. Reading binary
555 files (docx, odt, epub) implies `--file-scope`.
557`-F` *PROGRAM*, `--filter=`*PROGRAM*
559: Specify an executable to be used as a filter transforming the
560 pandoc AST after the input is parsed and before the output is
561 written. The executable should read JSON from stdin and write
562 JSON to stdout. The JSON must be formatted like pandoc's own
563 JSON input and output. The name of the output format will be
564 passed to the filter as the first argument. Hence,
566 pandoc --filter ./caps.py -t latex
570 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
572 The latter form may be useful for debugging filters.
574 Filters may be written in any language. `Text.Pandoc.JSON`
575 exports `toJSONFilter` to facilitate writing filters in Haskell.
576 Those who would prefer to write filters in python can use the
577 module [`pandocfilters`], installable from PyPI. There are also
578 pandoc filter libraries in [PHP], [perl], and
579 [JavaScript/node.js].
581 In order of preference, pandoc will look for filters in
583 1. a specified full or relative path (executable or
586 2. `$DATADIR/filters` (executable or non-executable)
587 where `$DATADIR` is the user data directory (see
588 `--data-dir`, above).
590 3. `$PATH` (executable only)
592 Filters, Lua-filters, and citeproc processing are applied in
593 the order specified on the command line.
595`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
597: Transform the document in a similar fashion as JSON filters (see
598 `--filter`), but use pandoc's built-in Lua filtering system. The given
599 Lua script is expected to return a list of Lua filters which will be
600 applied in order. Each Lua filter must contain element-transforming
601 functions indexed by the name of the AST element on which the filter
602 function should be applied.
604 The `pandoc` Lua module provides helper functions for element
605 creation. It is always loaded into the script's Lua environment.
607 See the [Lua filters documentation] for further details.
609 In order of preference, pandoc will look for Lua filters in
611 1. a specified full or relative path
613 2. `$DATADIR/filters` where `$DATADIR` is the user data
614 directory (see `--data-dir`, above).
616 Filters, Lua filters, and citeproc processing are applied in
617 the order specified on the command line.
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
621: Set the metadata field *KEY* to the value *VAL*. A value specified
622 on the command line overrides a value specified in the document
623 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
624 Values will be parsed as YAML boolean or string values. If no value is
625 specified, the value will be treated as Boolean true. Like
626 `--variable`, `--metadata` causes template variables to be set.
627 But unlike `--variable`, `--metadata` affects the metadata of the
628 underlying document (which is accessible from filters and may be
629 printed in some output formats) and metadata values will be escaped
630 when inserted into the template.
632`--metadata-file=`*FILE*
634: Read metadata from the supplied YAML (or JSON) file. This
635 option can be used with every input format, but string scalars
636 in the YAML file will always be parsed as Markdown. Generally,
637 the input will be handled the same as in [YAML metadata
638 blocks][Extension: `yaml_metadata_block`]. This option can be
639 used repeatedly to include multiple metadata files; values in
640 files specified later on the command line will be preferred
641 over those specified in earlier files. Metadata values
642 specified inside the document, or by using `-M`, overwrite
643 values specified with this option.
645`-p`, `--preserve-tabs`
647: Preserve tabs instead of converting them to spaces. (By default, pandoc
648 converts tabs to spaces before parsing its input.) Note that this will
649 only affect tabs in literal code spans and code blocks. Tabs in regular
650 text are always treated as spaces.
654: Specify the number of spaces per tab (default is 4).
656`--track-changes=accept`|`reject`|`all`
658: Specifies what to do with insertions, deletions, and comments
659 produced by the MS Word "Track Changes" feature. `accept` (the
660 default) processes all the insertions and deletions.
661 `reject` ignores them. Both `accept` and `reject` ignore comments.
662 `all` includes all insertions, deletions, and comments, wrapped
663 in spans with `insertion`, `deletion`, `comment-start`, and
664 `comment-end` classes, respectively. The author and time of
665 change is included. `all` is useful for scripting: only
666 accepting changes from a certain reviewer, say, or before a
667 certain date. If a paragraph is inserted or deleted,
668 `track-changes=all` produces a span with the class
669 `paragraph-insertion`/`paragraph-deletion` before the
670 affected paragraph break. This option only affects the docx
673`--extract-media=`*DIR*
675: Extract images and other media contained in or linked from
676 the source document to the path *DIR*, creating it if
677 necessary, and adjust the images references in the document
678 so they point to the extracted files. If the source format is
679 a binary container (docx, epub, or odt), the media is
680 extracted from the container and the original
681 filenames are used. Otherwise the media is read from the
682 file system or downloaded, and new filenames are constructed
683 based on SHA1 hashes of the contents.
685`--abbreviations=`*FILE*
687: Specifies a custom abbreviations file, with abbreviations
688 one to a line. If this option is not specified, pandoc will
689 read the data file `abbreviations` from the user data
690 directory or fall back on a system default. To see the
692 `pandoc --print-default-data-file=abbreviations`. The only
693 use pandoc makes of this list is in the Markdown reader.
694 Strings found in this list will be followed by a nonbreaking
695 space, and the period will not produce sentence-ending space
696 in formats like LaTeX. The strings may not contain spaces.
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
699[PHP]: https://github.com/vinai/pandocfilters-php
700[perl]: https://metacpan.org/pod/Pandoc::Filter
701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702[Lua filters documentation]: https://pandoc.org/lua-filters.html
704## General writer options {.options}
708: Produce output with an appropriate header and footer (e.g. a
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711 output. For `native` output, this option causes metadata to
712 be included; otherwise, metadata is suppressed.
714`--template=`*FILE*|*URL*
716: Use the specified file as a custom template for the generated document.
717 Implies `--standalone`. See [Templates], below, for a description
718 of template syntax. If no extension is specified, an extension
719 corresponding to the writer will be added, so that `--template=special`
720 looks for `special.html` for HTML output. If the template is not
721 found, pandoc will search for it in the `templates` subdirectory of
722 the user data directory (see `--data-dir`). If this option is not used,
723 a default template appropriate for the output format will be used (see
724 `-D/--print-default-template`).
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
728: Set the template variable *KEY* to the value *VAL* when rendering the
729 document in standalone mode. If no *VAL* is specified, the
730 key will be given the value `true`.
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
734: Print the system default template for an output *FORMAT*. (See `-t`
735 for a list of possible *FORMAT*s.) Templates in the user data
736 directory are ignored. This option may be used with
737 `-o`/`--output` to redirect output to a file, but
738 `-o`/`--output` must come before `--print-default-template`
741 Note that some of the default templates use partials, for
742 example `styles.html`. To print the partials, use
743 `--print-default-data-file`: for example,
744 `--print-default-data-file=templates/styles.html`.
746`--print-default-data-file=`*FILE*
748: Print a system default data file. Files in the user data directory
749 are ignored. This option may be used with `-o`/`--output` to
750 redirect output to a file, but `-o`/`--output` must come before
751 `--print-default-data-file` on the command line.
753`--eol=crlf`|`lf`|`native`
755: Manually specify line endings: `crlf` (Windows), `lf`
756 (macOS/Linux/UNIX), or `native` (line endings appropriate
757 to the OS on which pandoc is being run). The default is
762: Specify the default dpi (dots per inch) value for conversion
763 from pixels to inch/centimeters and vice versa. (Technically,
764 the correct term would be ppi: pixels per inch.) The default
765 is 96dpi. When images contain information about dpi
766 internally, the encoded value is used instead of the default
767 specified by this option.
769`--wrap=auto`|`none`|`preserve`
771: Determine how text is wrapped in the output (the source
772 code, not the rendered version). With `auto` (the default),
773 pandoc will attempt to wrap lines to the column width specified by
774 `--columns` (default 72). With `none`, pandoc will not wrap
775 lines at all. With `preserve`, pandoc will attempt to
776 preserve the wrapping from the source document (that is,
777 where there are nonsemantic newlines in the source, there
778 will be nonsemantic newlines in the output as well).
779 Automatic wrapping does not currently work in HTML output.
780 In `ipynb` output, this option affects wrapping of the
781 contents of markdown cells.
785: Specify length of lines in characters. This affects text wrapping
786 in the generated source code (see `--wrap`). It also affects
787 calculation of column widths for plain text tables (see [Tables] below).
789`--toc`, `--table-of-contents`
791: Include an automatically generated table of contents (or, in
792 the case of `latex`, `context`, `docx`, `odt`,
793 `opendocument`, `rst`, or `ms`, an instruction to create
794 one) in the output document. This option has no effect
795 unless `-s/--standalone` is used, and it has no effect
796 on `man`, `docbook4`, `docbook5`, or `jats` output.
798 Note that if you are producing a PDF via `ms`, the table
799 of contents will appear at the beginning of the
800 document, before the title. If you would prefer it to
801 be at the end of the document, use the option
802 `--pdf-engine-opt=--no-toc-relocation`.
804`--toc-depth=`*NUMBER*
806: Specify the number of section levels to include in the table
807 of contents. The default is 3 (which means that level-1, 2, and 3
808 headings will be listed in the contents).
812: Strip out HTML comments in the Markdown or Textile source,
813 rather than passing them on to Markdown, Textile or HTML
814 output as raw HTML. This does not apply to HTML comments
815 inside raw HTML blocks when the `markdown_in_html_blocks`
816 extension is not set.
820: Disables syntax highlighting for code blocks and inlines, even when
821 a language attribute is given.
823`--highlight-style=`*STYLE*|*FILE*
825: Specifies the coloring style to be used in highlighted source code.
826 Options are `pygments` (the default), `kate`, `monochrome`,
827 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
828 For more information on syntax highlighting in pandoc, see
829 [Syntax highlighting], below. See also
830 `--list-highlight-styles`.
832 Instead of a *STYLE* name, a JSON file with extension
833 `.theme` may be supplied. This will be parsed as a KDE
834 syntax highlighting theme and (if valid) used as the
837 To generate the JSON version of an existing style,
838 use `--print-highlight-style`.
840`--print-highlight-style=`*STYLE*|*FILE*
842: Prints a JSON version of a highlighting style, which can
843 be modified, saved with a `.theme` extension, and used
844 with `--highlight-style`. This option may be used with
845 `-o`/`--output` to redirect output to a file, but
846 `-o`/`--output` must come before `--print-highlight-style`
849`--syntax-definition=`*FILE*
851: Instructs pandoc to load a KDE XML syntax definition file,
852 which will be used for syntax highlighting of appropriately
853 marked code blocks. This can be used to add support for
854 new languages or to use altered syntax definitions for
855 existing languages. This option may be repeated to add
856 multiple syntax definitions.
858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
860: Include contents of *FILE*, verbatim, at the end of the header.
861 This can be used, for example, to include special
862 CSS or JavaScript in HTML documents. This option can be used
863 repeatedly to include multiple files in the header. They will be
864 included in the order specified. Implies `--standalone`.
866`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
868: Include contents of *FILE*, verbatim, at the beginning of the
869 document body (e.g. after the `<body>` tag in HTML, or the
870 `\begin{document}` command in LaTeX). This can be used to include
871 navigation bars or banners in HTML documents. This option can be
872 used repeatedly to include multiple files. They will be included in
873 the order specified. Implies `--standalone`.
875`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
877: Include contents of *FILE*, verbatim, at the end of the document
878 body (before the `</body>` tag in HTML, or the
879 `\end{document}` command in LaTeX). This option can be used
880 repeatedly to include multiple files. They will be included in the
881 order specified. Implies `--standalone`.
883`--resource-path=`*SEARCHPATH*
885: List of paths to search for images and other resources.
886 The paths should be separated by `:` on Linux, UNIX, and
887 macOS systems, and by `;` on Windows. If `--resource-path`
888 is not specified, the default resource path is the working
889 directory. Note that, if `--resource-path` is specified,
890 the working directory must be explicitly listed or it
891 will not be searched. For example:
892 `--resource-path=.:test` will search the working directory
893 and the `test` subdirectory, in that order.
894 This option can be used repeatedly. Search path components
895 that come later on the command line will be searched before
896 those that come earlier, so
897 `--resource-path foo:bar --resource-path baz:bim` is
898 equivalent to `--resource-path baz:bim:foo:bar`.
900`--request-header=`*NAME*`:`*VAL*
902: Set the request header *NAME* to the value *VAL* when making
903 HTTP requests (for example, when a URL is given on the
904 command line, or when resources used in a document must be
905 downloaded). If you're behind a proxy, you also need to set
906 the environment variable `http_proxy` to `http://...`.
908`--no-check-certificate`
910: Disable the certificate verification to allow access to
911 unsecure HTTP resources (for example when the certificate
912 is no longer valid or self signed).
914## Options affecting specific writers {.options}
918: Produce a standalone HTML file with no external dependencies, using
919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
920 images, and videos. Implies `--standalone`. The resulting file should be
921 "self-contained," in the sense that it needs no external files and no net
922 access to be displayed properly by a browser. This option works only with
923 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925 and stylesheets at absolute URLs will be downloaded; those at relative
926 URLs will be sought relative to the working directory (if the first source
927 file is local) or relative to the base URL (if the first source
928 file is remote). Elements with the attribute
929 `data-external="1"` will be left alone; the documents they
930 link to will not be incorporated in the document.
931 Limitation: resources that are loaded dynamically through
932 JavaScript cannot be incorporated; as a result,
933 `--self-contained` does not work with `--mathjax`, and some
934 advanced features (e.g. zoom or speaker notes) may not work
935 in an offline "self-contained" `reveal.js` slide show.
939: Use `<q>` tags for quotes in HTML. (This option only has an
940 effect if the `smart` extension is enabled for the input
945: Use only ASCII characters in output. Currently supported for XML
946 and HTML formats (which use entities instead of UTF-8 when this
947 option is selected), CommonMark, gfm, and Markdown (which use
948 entities), roff ms (which use hexadecimal escapes), and to a
949 limited degree LaTeX (which uses standard commands for accented
950 characters when possible). roff man output uses ASCII by default.
954: Use reference-style links, rather than inline links, in writing Markdown
955 or reStructuredText. By default inline links are used. The
956 placement of link references is affected by the
957 `--reference-location` option.
959`--reference-location=block`|`section`|`document`
961: Specify whether footnotes (and references, if `reference-links` is
962 set) are placed at the end of the current (top-level) block, the
963 current section, or the document. The default is
964 `document`. Currently only affects the markdown writer.
966`--markdown-headings=setext`|`atx`
968: Specify whether to use ATX-style (`#`-prefixed) or
969 Setext-style (underlined) headings for level 1 and 2
970 headings in Markdown output. (The default is `atx`.)
971 ATX-style headings are always used for levels 3+.
972 This option also affects Markdown cells in `ipynb` output.
976: *Deprecated synonym for `--markdown-headings=atx`.*
978`--top-level-division=default`|`section`|`chapter`|`part`
980: Treat top-level headings as the given division type in
981 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982 order is part, chapter, then section; all headings are
983 shifted such that the top-level heading becomes the
984 specified type. The default behavior is to determine the
985 best division type via heuristics: unless other conditions
986 apply, `section` is chosen. When the `documentclass`
987 variable is set to `report`, `book`, or `memoir` (unless the
988 `article` option is specified), `chapter` is implied as the
989 setting for this option. If `beamer` is the output format,
990 specifying either `chapter` or `part` will cause top-level
991 headings to become `\part{..}`, while second-level headings
992 remain as their default type.
994`-N`, `--number-sections`
996: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997 output. By default, sections are not numbered. Sections with class
998 `unnumbered` will never be numbered, even if `--number-sections`
1001`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
1003: Offset for section headings in HTML output (ignored in other
1004 output formats). The first number is added to the section number for
1005 top-level headings, the second for second-level headings, and so on.
1006 So, for example, if you want the first top-level heading in your
1007 document to be numbered "6", specify `--number-offset=5`.
1008 If your document starts with a level-2 heading which you want to
1009 be numbered "1.5", specify `--number-offset=1,4`.
1010 Offsets are 0 by default. Implies `--number-sections`.
1014: Use the [`listings`] package for LaTeX code blocks. The package
1015 does not support multi-byte encoding for source code. To handle UTF-8
1016 you would need to use a custom template. This issue is fully
1017 documented here: [Encoding issue with the listings package].
1019`-i`, `--incremental`
1021: Make list items in slide shows display incrementally (one by one).
1022 The default is for lists to be displayed all at once.
1024`--slide-level=`*NUMBER*
1026: Specifies that headings with the specified level create
1027 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1028 above this level in the hierarchy are used to divide the
1029 slide show into sections; headings below this level create
1030 subheads within a slide. Note that content that is
1031 not contained under slide-level headings will not appear in
1032 the slide show. The default is to set the slide level based
1033 on the contents of the document; see [Structuring the slide
1038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039 and attach identifiers to the enclosing `<section>` (or `<div>`)
1040 rather than the heading itself. See
1041 [Heading identifiers], below.
1043`--email-obfuscation=none`|`javascript`|`references`
1045: Specify a method for obfuscating `mailto:` links in HTML documents.
1046 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1047 them using JavaScript. `references` obfuscates them by printing their
1048 letters as decimal or hexadecimal character references. The default
1051`--id-prefix=`*STRING*
1053: Specify a prefix to be added to all identifiers and internal links
1054 in HTML and DocBook output, and to footnote numbers in Markdown
1055 and Haddock output. This is useful for preventing duplicate
1056 identifiers when generating fragments to be included in other pages.
1058`-T` *STRING*, `--title-prefix=`*STRING*
1060: Specify *STRING* as a prefix at the beginning of the title
1061 that appears in the HTML header (but not in the title as it
1062 appears at the beginning of the HTML body). Implies `--standalone`.
1064`-c` *URL*, `--css=`*URL*
1066: Link to a CSS style sheet. This option can be used repeatedly to
1067 include multiple files. They will be included in the order specified.
1069 A stylesheet is required for generating EPUB. If none is
1070 provided using this option (or the `css` or `stylesheet`
1071 metadata fields), pandoc will look for a file `epub.css` in the
1072 user data directory (see `--data-dir`). If it is not
1073 found there, sensible defaults will be used.
1075`--reference-doc=`*FILE*
1077: Use the specified file as a style reference in producing a
1082 : For best results, the reference docx should be a modified
1083 version of a docx file produced using pandoc. The contents
1084 of the reference docx are ignored, but its stylesheets and
1085 document properties (including margins, page size, header,
1086 and footer) are used in the new docx. If no reference docx
1087 is specified on the command line, pandoc will look for a
1088 file `reference.docx` in the user data directory (see
1089 `--data-dir`). If this is not found either, sensible
1090 defaults will be used.
1092 To produce a custom `reference.docx`, first get a copy of
1093 the default `reference.docx`: `pandoc
1094 -o custom-reference.docx --print-default-data-file reference.docx`.
1095 Then open `custom-reference.docx` in Word, modify the
1096 styles as you wish, and save the file. For best
1097 results, do not make changes to this file other than
1098 modifying the styles used by pandoc:
1134 - Default Paragraph Font
1137 - Footnote Reference
1147 : For best results, the reference ODT should be a modified
1148 version of an ODT produced using pandoc. The contents of
1149 the reference ODT are ignored, but its stylesheets are used
1150 in the new ODT. If no reference ODT is specified on the
1151 command line, pandoc will look for a file `reference.odt` in
1152 the user data directory (see `--data-dir`). If this is not
1153 found either, sensible defaults will be used.
1155 To produce a custom `reference.odt`, first get a copy of
1156 the default `reference.odt`: `pandoc
1157 -o custom-reference.odt --print-default-data-file reference.odt`.
1158 Then open `custom-reference.odt` in LibreOffice, modify
1159 the styles as you wish, and save the file.
1163 : Templates included with Microsoft PowerPoint 2013 (either with
1164 `.pptx` or `.potx` extension) are known to work, as are most
1165 templates derived from these.
1167 The specific requirement is that the template should begin with
1168 the following first four layouts:
1171 2. Title and Content
1175 All templates included with a recent version of MS PowerPoint
1176 will fit these criteria. (You can click on `Layout` under the
1177 `Home` menu to check.)
1179 You can also modify the default `reference.pptx`: first run
1180 `pandoc -o custom-reference.pptx --print-default-data-file
1181 reference.pptx`, and then modify `custom-reference.pptx`
1182 in MS PowerPoint (pandoc will use the first four layout
1183 slides, as mentioned above).
1185`--epub-cover-image=`*FILE*
1187: Use the specified image as the EPUB cover. It is recommended
1188 that the image be less than 1000px in width and height. Note that
1189 in a Markdown source document you can also specify `cover-image`
1190 in a YAML metadata block (see [EPUB Metadata], below).
1192`--epub-metadata=`*FILE*
1194: Look in the specified XML file for metadata for the EPUB.
1195 The file should contain a series of [Dublin Core elements].
1198 <dc:rights>Creative Commons</dc:rights>
1199 <dc:language>es-AR</dc:language>
1201 By default, pandoc will include the following metadata elements:
1202 `<dc:title>` (from the document title), `<dc:creator>` (from the
1203 document authors), `<dc:date>` (from the document date, which should
1204 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1205 variable, or, if is not set, the locale), and `<dc:identifier
1206 id="BookId">` (a randomly generated UUID). Any of these may be
1207 overridden by elements in the metadata file.
1209 Note: if the source document is Markdown, a YAML metadata block
1210 in the document can be used instead. See below under
1213`--epub-embed-font=`*FILE*
1215: Embed the specified font in the EPUB. This option can be repeated
1216 to embed multiple fonts. Wildcards can also be used: for example,
1217 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1218 line, be sure to escape them or put the whole filename in single quotes,
1219 to prevent them from being interpreted by the shell. To use the
1220 embedded fonts, you will need to add declarations like the following
1221 to your CSS (see `--css`):
1224 font-family: DejaVuSans;
1226 font-weight: normal;
1227 src:url("DejaVuSans-Regular.ttf");
1230 font-family: DejaVuSans;
1233 src:url("DejaVuSans-Bold.ttf");
1236 font-family: DejaVuSans;
1238 font-weight: normal;
1239 src:url("DejaVuSans-Oblique.ttf");
1242 font-family: DejaVuSans;
1245 src:url("DejaVuSans-BoldOblique.ttf");
1247 body { font-family: "DejaVuSans"; }
1249`--epub-chapter-level=`*NUMBER*
1251: Specify the heading level at which to split the EPUB into separate
1252 "chapter" files. The default is to split into chapters at level-1
1253 headings. This option only affects the internal composition of the
1254 EPUB, not the way chapters and sections are displayed to users. Some
1255 readers may be slow if the chapter files are too large, so for large
1256 documents with few level-1 headings, one might want to use a chapter
1259`--epub-subdirectory=`*DIRNAME*
1261: Specify the subdirectory in the OCF container that is to hold
1262 the EPUB-specific contents. The default is `EPUB`. To put
1263 the EPUB contents in the top level, use an empty string.
1265`--ipynb-output=all|none|best`
1267: Determines how ipynb output cells are treated. `all` means
1268 that all of the data formats included in the original are
1269 preserved. `none` means that the contents of data cells
1270 are omitted. `best` causes pandoc to try to pick the
1271 richest data block in each output cell that is compatible
1272 with the output format. The default is `best`.
1274`--pdf-engine=`*PROGRAM*
1276: Use the specified engine when producing PDF output.
1277 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279 and `pdfroff`. If the engine is not in your PATH, the full
1280 path of the engine may be specified here. If this option
1281 is not specified, pandoc uses the following defaults
1282 depending on the output format specified using `-t/--to`:
1284 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285 `tectonic`, `latexmk`)
1286 - `-t context`: `context`
1287 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288 see [print-css.rocks](https://print-css.rocks) for a good
1289 introduction to PDF generation from HTML/CSS.)
1290 - `-t ms`: `pdfroff`
1292`--pdf-engine-opt=`*STRING*
1294: Use the given string as a command-line argument to the `pdf-engine`.
1295 For example, to use a persistent directory `foo` for `latexmk`'s
1296 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297 Note that no check for duplicate options is done.
1299[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301[Encoding issue with the listings package]:
1302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1304## Citation rendering {.options}
1308: Process the citations in the file, replacing them with
1309 rendered citations and adding a bibliography.
1310 Citation processing will not take place unless bibliographic
1311 data is supplied, either through an external file specified
1312 using the `--bibliography` option or the `bibliography`
1313 field in metadata, or via a `references` section in metadata
1314 containing a list of citations in CSL YAML format with
1315 Markdown formatting. The style is controlled by a [CSL]
1316 stylesheet specified using the `--csl` option or the `csl`
1317 field in metadata. (If no stylesheet is specified,
1318 the `chicago-author-date` style will be used by default.)
1319 The citation processing transformation may be applied before
1320 or after filters or Lua filters (see `--filter`,
1321 `--lua-filter`): these transformations are applied in the
1322 order they appear on the command line. For more
1323 information, see the section on [Citations].
1325`--bibliography=`*FILE*
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1328 overriding any value set in the metadata. If you supply
1329 this argument multiple times, each *FILE* will be added to
1330 bibliography. If *FILE* is a URL, it will be fetched
1331 via HTTP. If *FILE* is not found relative to the
1332 working directory, it will be sought in the resource path
1333 (see `--resource-path`).
1337: Set the `csl` field in the document's metadata to *FILE*,
1338 overriding any value set in the metadata. (This is equivalent to
1339 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340 fetched via HTTP. If *FILE* is not found relative to the
1341 working directory, it will be sought in the resource path
1342 (see `--resource-path`) and finally in the `csl`
1343 subdirectory of the pandoc user data directory.
1345`--citation-abbreviations=`*FILE*
1347: Set the `citation-abbreviations` field in the document's metadata to
1348 *FILE*, overriding any value set in the metadata. (This is equivalent to
1349 `--metadata citation-abbreviations=FILE`.)
1350 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351 found relative to the working directory, it will be sought
1352 in the resource path (see `--resource-path`) and finally in
1353 the `csl` subdirectory of the pandoc user data directory.
1357: Use [`natbib`] for citations in LaTeX output. This option
1358 is not for use with the `--citeproc` option or with PDF
1359 output. It is intended for use in producing a LaTeX file
1360 that can be processed with [`bibtex`].
1364: Use [`biblatex`] for citations in LaTeX output. This option
1365 is not for use with the `--citeproc` option or with PDF
1366 output. It is intended for use in producing a LaTeX file
1367 that can be processed with [`bibtex`] or [`biber`].
1369## Math rendering in HTML {.options}
1371The default is to render TeX math as far as possible using
1372Unicode characters. Formulas are put inside a `span` with
1373`class="math"`, so that they may be styled differently from the
1374surrounding text if needed. However, this gives acceptable
1375results only for basic math, usually you will want to use
1376`--mathjax` or another of the following options.
1378`--mathjax`[`=`*URL*]
1380: Use [MathJax] to display embedded TeX math in HTML output.
1381 TeX math will be put between `\(...\)` (for inline math)
1382 or `\[...\]` (for display math) and wrapped in `<span>` tags
1383 with class `math`. Then the MathJax JavaScript will render it.
1384 The *URL* should point to the `MathJax.js` load script.
1385 If a *URL* is not provided, a link to the Cloudflare CDN will
1390: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391 `docbook5`, `jats`, `html4` and `html5`). This is the
1392 default in `odt` output. Note that currently only Firefox
1393 and Safari (and select e-book readers) natively support
1398: Convert TeX formulas to `<img>` tags that link to an external script
1399 that converts formulas to images. The formula will be URL-encoded
1400 and concatenated with the URL provided. For SVG images you can for
1401 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1402 If no URL is specified, the CodeCogs URL generating PNGs
1403 will be used (`https://latex.codecogs.com/png.latex?`).
1404 Note: the `--webtex` option will affect Markdown output
1405 as well as HTML, which is useful if you're targeting a
1406 version of Markdown without native math support.
1410: Use [KaTeX] to display embedded TeX math in HTML output.
1411 The *URL* is the base URL for the KaTeX library. That directory
1412 should contain a `katex.min.js` and a `katex.min.css` file.
1413 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418 can then be processed by [GladTeX] to produce images of the typeset
1419 formulas and an HTML file with links to these images.
1420 So, the procedure is:
1422 pandoc -s --gladtex input.md -o myfile.htex
1423 gladtex -d myfile-images myfile.htex
1424 # produces myfile.html and images in myfile-images
1426[MathML]: https://www.w3.org/Math/
1427[MathJax]: https://www.mathjax.org
1428[KaTeX]: https://github.com/Khan/KaTeX
1429[GladTeX]: https://humenda.github.io/GladTeX/
1431## Options for wrapper scripts {.options}
1435: Print information about command-line arguments to *stdout*, then exit.
1436 This option is intended primarily for use in wrapper scripts.
1437 The first line of output contains the name of the output file specified
1438 with the `-o` option, or `-` (for *stdout*) if no output file was
1439 specified. The remaining lines contain the command-line arguments,
1440 one per line, in the order they appear. These do not include regular
1441 pandoc options and their arguments, but do include any options appearing
1442 after a `--` separator at the end of the line.
1446: Ignore command-line arguments (for use in wrapper scripts).
1447 Regular pandoc options are not ignored. Thus, for example,
1449 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1453 pandoc -o foo.html -s
1457If pandoc completes successfully, it will return exit code 0.
1458Nonzero exit codes have the following meanings:
1461----- ------------------------------------
1462 3 PandocFailOnWarningError
1464 5 PandocTemplateError
1466 21 PandocUnknownReaderError
1467 22 PandocUnknownWriterError
1468 23 PandocUnsupportedExtensionError
1469 24 PandocCiteprocError
1470 31 PandocEpubSubdirectoryError
1473 47 PandocPDFProgramNotFoundError
1475 62 PandocShouldNeverHappenError
1478 65 PandocParsecError
1479 66 PandocMakePDFError
1480 67 PandocSyntaxMapError
1481 83 PandocFilterError
1483 92 PandocUTF8DecodingError
1484 93 PandocIpynbDecodingError
1485 94 PandocUnsupportedCharsetError
1486 97 PandocCouldNotFindDataFileError
1487 99 PandocResourceNotFound
1488----- ------------------------------------
1492The `--defaults` option may be used to specify a package
1493of options. Here is a sample defaults file demonstrating all of
1494the fields that may be used:
1498# reader: may be used instead of from:
1500# writer: may be used instead of to:
1502# leave blank for output to stdout:
1504# leave blank for input from stdin, use [] for no input:
1508# or you may use input-file: with a single value
1510# Include options from the specified defaults files.
1511# The files will be searched for first in the working directory
1512# and then in the defaults subdirectory of the user data directory.
1513# The files are included in the same order in which they appear in
1514# the list. Options specified in this defaults file always have
1515# priority over the included ones.
1522self-contained: false
1524# note that structured variables may be specified:
1531# metadata values specified here are parsed as literal
1532# string text, not markdown:
1539# or you may use metadata-file: with a single value
1541# Note that these take files, not their contents:
1542include-before-body: []
1543include-after-body: []
1544include-in-header: []
1547# turn on built-in citation processing. Note that if you need
1548# control over when the citeproc processing is done relative
1549# to other filters, you should instead use `citeproc` in the
1550# list of `filters` (see below).
1556citation-abbreviations: abbrevs.json
1558# Filters will be assumed to be Lua filters if they have
1559# the .lua extension, and json filters otherwise. But
1560# the filter type can also be specified explicitly, as shown.
1561# Filters are run in the order specified.
1562# To include the built-in citeproc filter, use either `citeproc`
1563# or `{type: citeproc}`.
1573# ERROR, WARNING, or INFO
1577# citeproc, natbib, or biblatex. This only affects LaTeX
1578# output. If you want to use citeproc to format citations,
1579# you should also set 'citeproc: true' (see above).
1580cite-method: citeproc
1582# part, chapter, section, or default:
1583top-level-division: chapter
1589# you may also use pdf-engine-opt: with a single option
1590# pdf-engine-opt: "-shell-escape"
1592# auto, preserve, or none
1597extract-media: mediadir
1599table-of-contents: true
1601number-sections: false
1602# a list of offsets at each heading level
1603number-offset: [0,0,0,0,0,0]
1604# toc: may also be used instead of table-of-contents:
1605shift-heading-level-by: 1
1607identifier-prefix: foo
1609strip-empty-paragraphs: true
1610# lf, crlf, or native
1612strip-comments: false
1613indented-code-classes: []
1615default-image-extension: ".jpg"
1617# either a style name of a style definition file:
1618highlight-style: pygments
1621# or you may use syntax-definition: with a single value
1624reference-doc: myref.docx
1626# method is plain, webtex, gladtex, mathml, mathjax, katex
1627# you may specify a url with webtex, mathjax, katex
1630 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1631# none, references, or javascript
1632email-obfuscation: javascript
1640epub-subdirectory: EPUB
1641epub-metadata: meta.xml
1644epub-chapter-level: 1
1645epub-cover-image: cover.jpg
1647reference-links: true
1648# block, section, or document
1649reference-location: block
1650markdown-headings: setext
1652# accept, reject, or all
1653track-changes: accept
1662# A list of two-element lists
1664- ["User-Agent", "Mozilla/5.0"]
1666fail-if-warnings: false
1672Fields that are omitted will just have their regular
1673default values. So a defaults file can be as simple as
1680In fields that expect a file path (or list of file paths), the
1681following syntax may be used to interpolate environment variables:
1684csl: ${HOME}/mycsldir/special.csl
1687`${USERDATA}` may also be used; this will always resolve to the
1688user data directory that is current when the defaults file is
1689parsed, regardless of the setting of the environment
1692`${.}` will resolve to the directory containing the default
1693file itself. This allows you to refer to resources contained
1697epub-cover-image: ${.}/cover.jpg
1698epub-metadata: ${.}/meta.xml
1700- . # the working directory from which pandoc is run
1701- ${.}/images # the images subdirectory of the directory
1702 # containing this defaults file
1705This environment variable interpolation syntax *only* works in
1706fields that expect file paths.
1708Default files can be placed in the `defaults` subdirectory of
1709the user data directory and used from any directory. For
1710example, one could create a file specifying defaults for writing
1711letters, save it as `letter.yaml` in the `defaults` subdirectory
1712of the user data directory, and then invoke these defaults
1713from any directory using `pandoc --defaults letter`
1714or `pandoc -dletter`.
1716When multiple defaults are used, their contents will be combined.
1718Note that, where command-line arguments may be repeated
1719(`--metadata-file`, `--css`, `--include-in-header`,
1720`--include-before-body`, `--include-after-body`, `--variable`,
1721`--metadata`, `--syntax-definition`), the values specified on
1722the command line will combine with values specified in the
1723defaults file, rather than replacing them.
1727When the `-s/--standalone` option is used, pandoc uses a template to
1728add header and footer material that is needed for a self-standing
1729document. To see the default template that is used, just type
1733where *FORMAT* is the name of the output format. A custom template
1734can be specified using the `--template` option. You can also override
1735the system default templates for a given output format *FORMAT*
1736by putting a file `templates/default.*FORMAT*` in the user data
1737directory (see `--data-dir`, above). *Exceptions:*
1739- For `odt` output, customize the `default.opendocument`
1741- For `pdf` output, customize the `default.latex` template
1742 (or the `default.context` template, if you use `-t context`,
1743 or the `default.ms` template, if you use `-t ms`, or the
1744 `default.html` template, if you use `-t html`).
1745- `docx` and `pptx` have no template (however, you can use
1746 `--reference-doc` to customize the output).
1748Templates contain *variables*, which allow for the inclusion of
1749arbitrary information at any point in the file. They may be set at the
1750command line using the `-V/--variable` option. If a variable is not set,
1751pandoc will look for the key in the document's metadata, which can be set
1752using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1753or with the `-M/--metadata` option. In addition, some variables
1754are given default values by pandoc. See [Variables] below for
1755a list of variables used in pandoc's default templates.
1757If you use custom templates, you may need to revise them as pandoc
1758changes. We recommend tracking the changes in the default templates,
1759and modifying your custom templates accordingly. An easy way to do this
1760is to fork the [pandoc-templates] repository and merge in
1761changes after each pandoc release.
1763 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1769Anything between the sequence `$--` and the end of the
1770line will be treated as a comment and omitted from the output.
1774To mark variables and control structures in the template,
1775either `$`...`$` or `${`...`}` may be used as delimiters.
1776The styles may also be mixed in the same template, but the
1777opening and closing delimiter must match in each case. The
1778opening delimiter may be followed by one or more spaces
1779or tabs, which will be ignored. The closing delimiter may
1780be followed by one or more spaces or tabs, which will be
1783To include a literal `$` in the document, use `$$`.
1785### Interpolated variables
1787A slot for an interpolated variable is a variable name surrounded
1788by matched delimiters. Variable names must begin with a letter
1789and can contain letters, numbers, `_`, `-`, and `.`. The
1790keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1791not be used as variable names. Examples:
1804Variable names with periods are used to get at structured
1805variable values. So, for example, `employee.salary` will return the
1806value of the `salary` field of the object that is the value of
1807the `employee` field.
1809- If the value of the variable is simple value, it will be
1810 rendered verbatim. (Note that no escaping is done;
1811 the assumption is that the calling program will escape
1812 the strings appropriately for the output format.)
1813- If the value is a list, the values will be concatenated.
1814- If the value is a map, the string `true` will be rendered.
1815- Every other value will be rendered as the empty string.
1819A conditional begins with `if(variable)` (enclosed in
1820matched delimiters) and ends with `endif` (enclosed in matched
1821delimiters). It may optionally contain an `else` (enclosed in
1822matched delimiters). The `if` section is used if
1823`variable` has a non-empty value, otherwise the `else`
1824section is used (if present). Examples:
1839${if(foo)}bar${endif}
1852The keyword `elseif` may be used to simplify complex nested
1867A for loop begins with `for(variable)` (enclosed in
1868matched delimiters) and ends with `endfor` (enclosed in matched
1871- If `variable` is an array, the material inside the loop will
1872 be evaluated repeatedly, with `variable` being set to each
1873 value of the array in turn, and concatenated.
1874- If `variable` is a map, the material inside will be set to
1876- If the value of the associated variable is not an array or
1877 a map, a single iteration will be performed on its value.
1882$for(foo)$$foo$$sep$, $endfor$
1885 - $foo.last$, $foo.first$
1889 - ${ foo.bar.last }, ${ foo.bar.first }
1893$it.name$: $it.office$
1897You may optionally specify a separator between consecutive
1898values using `sep` (enclosed in matched delimiters). The
1899material between `sep` and the `endfor` is the separator.
1902${ for(foo) }${ foo }${ sep }, ${ endfor }
1905Instead of using `variable` inside the loop, the special
1906anaphoric keyword `it` may be used.
1910 - ${ it.last }, ${ it.first }
1916Partials (subtemplates stored in different files) may be
1917included by using the name of the partial, followed
1918by `()`, for example:
1924Partials will be sought in the directory containing
1925the main template. The file name will be assumed to
1926have the same extension as the main template if it
1927lacks an extension. When calling the partial, the
1928full name including file extension can also be used:
1934(If a partial is not found in the directory of the
1935template and the template path is given as a relative
1936path, it will also be sought in the `templates`
1937subdirectory of the user data directory.)
1939Partials may optionally be applied to variables using
1945${ articles:bibentry() }
1948If `articles` is an array, this will iterate over its
1949values, applying the partial `bibentry()` to each one. So the
1950second example above is equivalent to
1958Note that the anaphoric keyword `it` must be used when
1959iterating over partials. In the above examples,
1960the `bibentry` partial should contain `it.title`
1961(and so on) instead of `articles.title`.
1963Final newlines are omitted from included partials.
1965Partials may include other partials.
1967A separator between values of an array may be specified
1968in square brackets, immediately after the variable name
1974${articles:bibentry()[; ]$
1977The separator in this case is literal and (unlike with `sep`
1978in an explicit `for` loop) cannot contain interpolated
1979variables or other template directives.
1983To ensure that content is "nested," that is, subsequent lines
1984indented, use the `^` directive:
1987$item.number$ $^$$item.description$ ($item.price$)
1990In this example, if `item.description` has multiple lines,
1991they will all be indented to line up with the first line:
199400123 A fine bottle of 18-year old
1995 Oban whiskey. ($148)
1998To nest multiple lines to the same level, align them
1999with the `^` directive in the template. For example:
2002$item.number$ $^$$item.description$ ($item.price$)
2003 (Available til $item.sellby$.)
200900123 A fine bottle of 18-year old
2010 Oban whiskey. ($148)
2011 (Available til March 30, 2020.)
2014If a variable occurs by itself on a line, preceded by whitespace
2015and not followed by further text or directives on the same line,
2016and the variable's value contains multiple lines, it will be
2017nested automatically.
2021Normally, spaces in the template itself (as opposed to values of
2022the interpolated variables) are not breakable, but they can be
2023made breakable in part of the template by using the `~` keyword
2024(ended with another `~`).
2027$~$This long line may break if the document is rendered
2028with a short line length.$~$
2033A pipe transforms the value of a variable or partial. Pipes are
2034specified using a slash (`/`) between the variable name (or partial)
2035and the pipe name. Example:
2042$for(metadata/pairs)$
2043- $it.key$: $it.value$
2046$employee:name()/uppercase$
2049Pipes may be chained:
2052$for(employees/pairs)$
2053$it.key/alpha/uppercase$. $it.name$
2057Some pipes take parameters:
2060|----------------------|------------|
2062$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2064|----------------------|------------|
2067Currently the following pipes are predefined:
2069- `pairs`: Converts a map or array to an array of maps,
2070 each with `key` and `value` fields. If the original
2071 value was an array, the `key` will be the array index,
2074- `uppercase`: Converts text to uppercase.
2076- `lowercase`: Converts text to lowercase.
2078- `length`: Returns the length of the value: number
2079 of characters for a textual value, number of elements
2082- `reverse`: Reverses a textual value or array,
2083 and has no effect on other values.
2085- `first`: Returns the first value of an array, if
2086 applied to a non-empty array; otherwise returns
2089- `last`: Returns the last value of an array, if
2090 applied to a non-empty array; otherwise returns
2093- `rest`: Returns all but the first value of an array, if
2094 applied to a non-empty array; otherwise returns
2097- `allbutlast`: Returns all but the last value of an array, if
2098 applied to a non-empty array; otherwise returns
2101- `chomp`: Removes trailing newlines (and breakable space).
2103- `nowrap`: Disables line wrapping on breakable spaces.
2105- `alpha`: Converts textual values that can be
2106 read as an integer into lowercase alphabetic
2107 characters `a..z` (mod 26). This can be used to get lettered
2108 enumeration from array indices. To get uppercase
2109 letters, chain with `uppercase`.
2111- `roman`: Converts textual values that can be
2112 read as an integer into lowercase roman numerials.
2113 This can be used to get lettered enumeration from array indices.
2114 To get uppercase roman, chain with `uppercase`.
2116- `left n "leftborder" "rightborder"`: Renders a textual value
2117 in a block of width `n`, aligned to the left, with an optional
2118 left and right border. Has no effect on other values. This
2119 can be used to align material in tables. Widths are positive
2120 integers indicating the number of characters. Borders
2121 are strings inside double quotes; literal `"` and `\` characters
2122 must be backslash-escaped.
2124- `right n "leftborder" "rightborder"`: Renders a textual value
2125 in a block of width `n`, aligned to the right, and has no
2126 effect on other values.
2128- `center n "leftborder" "rightborder"`: Renders a textual
2129 value in a block of width `n`, aligned to the center, and has
2130 no effect on other values.
2135### Metadata variables
2137`title`, `author`, `date`
2138: allow identification of basic aspects of the document. Included
2139 in PDF metadata through LaTeX and ConTeXt. These can be set
2140 through a [pandoc title block][Extension: `pandoc_title_block`],
2141 which allows for multiple authors, or through a
2142 [YAML metadata block][Extension: `yaml_metadata_block`]:
2150 Note that if you just want to set PDF or HTML metadata, without
2151 including a title block in the document itself, you can
2152 set the `title-meta`, `author-meta`, and `date-meta`
2153 variables. (By default these are set automatically, based
2154 on `title`, `author`, and `date`.) The page title in HTML
2155 is set by `pagetitle`, which is equal to `title` by default.
2158: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2162: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2166: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2167 and AsciiDoc metadata; repeat as for `author`, above
2170: document subject, included in ODT, PDF, docx and pptx metadata
2173: document description, included in ODT, docx and pptx metadata. Some
2174 applications show this as `Comments` metadata.
2177: document category, included in docx and pptx metadata
2180any root-level string metadata, not included in ODT, docx
2181or pptx metadata is added as a *custom property*.
2182The following [YAML] metadata block for instance:
2185 title: 'This is the title'
2186 subtitle: "This is the subtitle"
2194 It consists of two paragraphs
2197will include `title`, `author` and `description` as standard document
2198properties and `subtitle` as a custom property when converting to docx,
2201### Language variables
2204: identifies the main language of the document using IETF language
2205 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2206 The [Language subtag lookup] tool can look up or verify these tags.
2207 This affects most formats, and controls hyphenation in PDF output
2208 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2210 Use native pandoc [Divs and Spans] with the `lang` attribute to
2211 switch the language:
2217 Text in the main document language (British English).
2220 > Cette citation est écrite en français canadien.
2223 More text in English. ['Zitat auf Deutsch.']{lang=de}
2226: the base script direction, either `rtl` (right-to-left)
2227 or `ltr` (left-to-right).
2229 For bidirectional documents, native pandoc `span`s and
2230 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2231 be used to override the base direction in some output
2232 formats. This may not always be necessary if the final
2233 renderer (e.g. the browser, when generating HTML) supports
2234 the [Unicode Bidirectional Algorithm].
2236 When using LaTeX for bidirectional documents, only the
2237 `xelatex` engine is fully supported (use
2238 `--pdf-engine=xelatex`).
2240[BCP 47]: https://tools.ietf.org/html/bcp47
2241[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2242[Language subtag lookup]: https://r12a.github.io/app-subtags/
2244### Variables for HTML
2247: Enables inclusion of most of the [CSS] in the `styles.html`
2248 [partial](#partials) (have a look with
2249 `pandoc --print-default-data-file=templates/styles.html`).
2250 Unless you use [`--css`](#option--css), this variable
2251 is set to `true` by default. You can disable it with
2252 e.g. `pandoc -M document-css=false`.
2255: sets the CSS `font-family` property on the `html` element.
2258: sets the base CSS `font-size`, which you'd usually set
2259 to e.g. `20px`, but it also accepts `pt`
2260 (12pt = 16px in most browsers).
2263: sets the CSS `color` property on the `html` element.
2266: sets the CSS `color` property on all links.
2269: sets the CSS `font-family` property on `code` elements.
2271`monobackgroundcolor`
2272: sets the CSS `background-color` property on `code` elements
2273 and adds extra padding.
2276: sets the CSS `line-height` property on the `html` element,
2277 which is preferred to be unitless.
2280: sets the CSS `background-color` property on the `html` element.
2282`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2283: sets the corresponding CSS `padding` properties on the `body` element.
2285To override or extend some [CSS] for just one document, include for example:
2294 background-color: #f0f0f0;
2297 padding: 0.5em 2em 0.5em 0.5em;
2300 border-bottom: none;
2305[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2307### Variables for HTML math
2310: when using [KaTeX](#option--katex), you can render display
2311math equations flush left using [YAML metadata](#layout) or with
2312`-M classoption=fleqn`.
2314### Variables for HTML slides
2316These affect HTML output when [producing slide shows with pandoc].
2318All [reveal.js configuration options] are available as variables.
2319To turn off boolean flags that default to true in reveal.js, use `0`.
2322: base URL for reveal.js documents (defaults to
2323 `https://unpkg.com/reveal.js@^4/`)
2326: base URL for S5 documents (defaults to `s5/default`)
2329: base URL for Slidy documents (defaults to
2330 `https://www.w3.org/Talks/Tools/Slidy2`)
2333: base URL for Slideous documents (defaults to `slideous`)
2335`title-slide-attributes`
2336: additional attributes for the title slide of reveal.js slide shows.
2337 See [background in reveal.js and beamer] for an example.
2339[reveal.js configuration options]: https://revealjs.com/config/
2341### Variables for Beamer slides
2343These variables change the appearance of PDF slides using [`beamer`].
2346: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2347 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2351: produce an article from Beamer slides
2354: add extra beamer option with `\setbeameroption{}`
2357: author affiliations: can be a list when there are multiple authors
2360: logo image for slides
2363: controls navigation symbols (default is `empty` for no navigation
2364 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367: enables "title pages" for new sections (default is true)
2369`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2373: options for LaTeX beamer themes (a list).
2376: image for title slide
2378### Variables for PowerPoint
2380These variables control the visual aspects of a slide show that
2381are not easily controlled via templates.
2384: font to use for code.
2386### Variables for LaTeX
2388Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2393: make `\paragraph` and `\subparagraph` (fourth- and
2394 fifth-level headings, or fifth- and sixth-level with book
2395 classes) free-standing rather than run-in; requires further
2396 formatting to distinguish from `\subsubsection` (third- or
2397 fourth-level headings). Instead of using this option,
2398 [KOMA-Script] can adjust headings more extensively:
2401 documentclass: scrartcl
2403 \RedeclareSectionCommand[
2404 beforeskip=-10pt plus -2pt minus -1pt,
2405 afterskip=1sp plus -1sp minus 1sp,
2406 font=\normalfont\itshape]{paragraph}
2407 \RedeclareSectionCommand[
2408 beforeskip=-10pt plus -2pt minus -1pt,
2409 afterskip=1sp plus -1sp minus 1sp,
2410 font=\normalfont\scshape,
2411 indent=0pt]{subparagraph}
2415: option for document class, e.g. `oneside`; repeat for multiple options:
2424: document class: usually one of the standard classes,
2425 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2426 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2427 default to smaller margins; or [`memoir`]
2430: option for [`geometry`] package, e.g. `margin=1in`;
2431 repeat for multiple options:
2441: option for [`hyperref`] package, e.g. `linktoc=all`;
2442 repeat for multiple options:
2448 - pdfpagemode=FullScreen
2452: if true, pandoc will use document class settings for
2453 indentation (the default LaTeX template otherwise removes
2454 indentation and adds space between paragraphs)
2457: adjusts line spacing using the [`setspace`]
2458 package, e.g. `1.25`, `1.5`
2460`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2461: sets margins if `geometry` is not used (otherwise `geometry`
2465: control `\pagestyle{}`: the default article class
2466 supports `plain` (default), `empty` (no running heads or page numbers),
2467 and `headings` (section titles in running heads)
2470: paper size, e.g. `letter`, `a4`
2473: numbering depth for sections (with `--number-sections` option
2474 or `numbersections` variable)
2479: allows font encoding to be specified through `fontenc` package (with
2480 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483: font package for use with `pdflatex`:
2484 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2485 The default is [Latin Modern][`lm`].
2488: options for package used as `fontfamily`; repeat for multiple options.
2489 For example, to use the Libertine font with proportional lowercase
2490 (old-style) figures through the [`libertinus`] package:
2493 fontfamily: libertinus
2500: font size for body text. The standard classes allow 10pt, 11pt, and
2501 12pt. To use another size, set `documentclass` to one of
2502 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2504`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2505: font families for use with `xelatex` or
2506 `lualatex`: take the name of any system font, using the
2507 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2509`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2510: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2511 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2512 choices available through [`fontspec`]; repeat for multiple
2513 options. For example, to use the [TeX Gyre] version of
2514 Palatino with lowercase figures:
2517 mainfont: TeX Gyre Pagella
2520 - Numbers=Proportional
2524: options to pass to the microtype package
2529: add color to link text; automatically enabled if any of
2530 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2532`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2533: color for internal links, external links, citation links, linked
2534 URLs, and links in table of contents, respectively: uses options
2535 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2539: causes links to be printed as footnotes
2544: include list of figures, list of tables
2547: contents of acknowledgments footnote after document title
2550: include table of contents (can also be set using
2551 `--toc/--table-of-contents`)
2554: level of section to include in table of contents
2556#### BibLaTeX Bibliographies
2558These variables function when using BibLaTeX for [citation rendering].
2561: list of options for biblatex
2564: bibliography style, when used with `--natbib` and `--biblatex`.
2567: bibliography title, when used with `--natbib` and `--biblatex`.
2570: bibliography to use for resolving references
2573: list of options for natbib
2575[KOMA-Script]: https://ctan.org/pkg/koma-script
2576[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2577[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2578[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2579[`article`]: https://ctan.org/pkg/article
2580[`book`]: https://ctan.org/pkg/book
2581[`libertinus`]: https://ctan.org/pkg/libertinus
2582[`memoir`]: https://ctan.org/pkg/memoir
2583[`report`]: https://ctan.org/pkg/report
2585### Variables for ConTeXt
2587Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590: font size for body text (e.g. `10pt`, `12pt`)
2592`headertext`, `footertext`
2593: text to be placed in running header or footer (see [ConTeXt Headers and
2594 Footers]); repeat up to four times for different placement
2597: controls indentation of paragraphs, e.g. `yes,small,next` (see
2598 [ConTeXt Indentation]); repeat for multiple options
2601: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2602 repeat for multiple options
2605: options for page margins and text arrangement (see [ConTeXt Layout]);
2606 repeat for multiple options
2608`linkcolor`, `contrastcolor`
2609: color for links outside and inside a page, e.g. `red`, `blue` (see
2613: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2614 `type`, `cap`, `small`
2617: include list of figures, list of tables
2619`mainfont`, `sansfont`, `monofont`, `mathfont`
2620: font families: take the name of any system font (see
2621 [ConTeXt Font Switching])
2623`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2624: sets margins, if `layout` is not used (otherwise `layout`
2628: page number style and location (using [`setuppagenumbering`]);
2629 repeat for multiple options
2632: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2633 repeat for multiple options
2636: adds to the preamble the setup necessary to generate PDF/A
2637 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2638 specified (i.e. the value is set to True, by e.g.
2639 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2640 `1b:2005` will be used as default, for reasons of backwards
2641 compatibility. Using `--variable=pdfa` without specified value
2642 is not supported. To successfully generate PDF/A the required
2643 ICC color profiles have to be available and the content and all
2644 included files (such as images) have to be standard conforming.
2645 The ICC profiles and output intent may be specified using the
2646 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2647 PDFA] for more details.
2650: when used in conjunction with `pdfa`, specifies the ICC profile to use
2651 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2652 used as default. May be repeated to include multiple profiles. Note that
2653 the profiles have to be available on the system. They can be obtained
2654 from [ConTeXt ICC Profiles].
2657: when used in conjunction with `pdfa`, specifies the output intent for
2658 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2659 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2662: include table of contents (can also be set using
2663 `--toc/--table-of-contents`)
2666: spacing between paragraphs, e.g. `none`, `small` (using
2667 [`setupwhitespace`])
2670: include all source documents as file attachments in the PDF file
2672[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2673[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2674[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2675[ConTeXt Color]: https://wiki.contextgarden.net/Color
2676[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2677[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2678[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2679[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2680[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2681[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2682[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2684### Variables for `wkhtmltopdf`
2686Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2687The `--css` option also affects the output.
2689`footer-html`, `header-html`
2690: add information to the header and footer
2692`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2693: set the page margins
2696: sets the PDF paper size
2698### Variables for man pages
2701: adjusts text to left (`l`), right (`r`), center (`c`),
2702 or both (`b`) margins
2705: footer in man pages
2708: header in man pages
2711: if `true` (the default), hyphenation will be used
2714: section number in man pages
2719: font family (e.g. `T` or `P`)
2722: paragraph indent (e.g. `2m`)
2725: line height (e.g. `12p`)
2728: point size (e.g. `10p`)
2730### Variables set automatically
2732Pandoc sets these variables automatically in response to [options] or
2733document contents; users can also modify them. These vary depending
2734on the output format, and include the following:
2740: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2741 included in all HTML based formats (dzslides, epub,
2742 html, html4, html5, revealjs, s5, slideous, slidy).
2743 The recognized formats for `date` are: `mm/dd/yyyy`,
2744 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2745 (e.g. either `02 Apr 2018` or `02 April 2018`),
2746 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2747 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2750: contents specified by `-H/--include-in-header` (may have multiple
2754: contents specified by `-B/--include-before-body` (may have
2758: contents specified by `-A/--include-after-body` (may have
2762: JSON representation of all of the document's metadata. Field
2763 values are transformed to the selected output format.
2766: non-null value if `-N/--number-sections` was specified
2768`sourcefile`, `outputfile`
2769: source and destination filenames, as given on the command line.
2770 `sourcefile` can also be a list if input comes from multiple files,
2771 or empty if input is from stdin. You can use the following snippet in
2772 your template to distinguish them:
2782 Similarly, `outputfile` can be `-` if output goes to the terminal.
2784 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787: working directory from which pandoc is run.
2790: non-null value if `--toc/--table-of-contents` was specified
2793: title of table of contents (works only with EPUB,
2794 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2796[pandoc-templates]: https://github.com/jgm/pandoc-templates
2800The behavior of some of the readers and writers can be adjusted by
2801enabling or disabling various extensions.
2803An extension can be enabled by adding `+EXTENSION`
2804to the format name and disabled by adding `-EXTENSION`. For example,
2805`--from markdown_strict+footnotes` is strict Markdown with footnotes
2806enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2807Markdown without footnotes or pipe tables.
2809The markdown reader and writer make by far the most use of extensions.
2810Extensions only used by them are therefore covered in the
2811section [Pandoc's Markdown] below (See [Markdown variants] for
2812`commonmark` and `gfm`.) In the following, extensions that also work
2813for other formats are covered.
2815Note that markdown extensions added to the `ipynb` format
2816affect Markdown cells in Jupyter notebooks (as do command-line
2817options like `--atx-headers`).
2821#### Extension: `smart` ####
2823Interpret straight quotes as curly quotes, `---` as em-dashes,
2824`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2825inserted after certain abbreviations, such as "Mr."
2827This extension can be enabled/disabled for the following formats:
2830: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2833: `markdown`, `latex`, `context`, `rst`
2835enabled by default in
2836: `markdown`, `latex`, `context` (both input and output)
2838Note: If you are *writing* Markdown, then the `smart` extension
2839has the reverse effect: what would have been curly quotes comes
2842In LaTeX, `smart` means to use the standard TeX ligatures
2843for quotation marks (` `` ` and ` '' ` for double quotes,
2844`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2845en-dash and `---` for em-dash). If `smart` is disabled,
2846then in reading LaTeX pandoc will parse these characters
2847literally. In writing LaTeX, enabling `smart` tells pandoc
2848to use the ligatures when possible; if `smart` is disabled
2849pandoc will use unicode quotation mark and dash characters.
2851## Headings and sections
2853#### Extension: `auto_identifiers` ####
2855A heading without an explicitly specified identifier will be
2856automatically assigned a unique identifier based on the heading text.
2858This extension can be enabled/disabled for the following formats:
2861: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2866enabled by default in
2869The default algorithm used to derive the identifier from the
2872 - Remove all formatting, links, etc.
2873 - Remove all footnotes.
2874 - Remove all non-alphanumeric characters,
2875 except underscores, hyphens, and periods.
2876 - Replace all spaces and newlines with hyphens.
2877 - Convert all alphabetic characters to lowercase.
2878 - Remove everything up to the first letter (identifiers may
2879 not begin with a number or punctuation mark).
2880 - If nothing is left after this, use the identifier `section`.
2885 ------------------------------- ----------------------------
2886 `Heading identifiers in HTML` `heading-identifiers-in-html`
2887 `Maître d'hôtel` `maître-dhôtel`
2888 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2889 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2890 `3. Applications` `applications`
2893These rules should, in most cases, allow one to determine the identifier
2894from the heading text. The exception is when several headings have the
2895same text; in this case, the first will get an identifier as described
2896above; the second will get the same identifier with `-1` appended; the
2897third with `-2`; and so on.
2899(However, a different algorithm is used if
2900`gfm_auto_identifiers` is enabled; see below.)
2902These identifiers are used to provide link targets in the table of
2903contents generated by the `--toc|--table-of-contents` option. They
2904also make it easy to provide links from one section of a document to
2905another. A link to this section, for example, might look like this:
2908 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2910Note, however, that this method of providing links to sections works
2911only in HTML, LaTeX, and ConTeXt formats.
2913If the `--section-divs` option is specified, then each section will
2914be wrapped in a `section` (or a `div`, if `html4` was specified),
2915and the identifier will be attached to the enclosing `<section>`
2916(or `<div>`) tag rather than the heading itself. This allows entire
2917sections to be manipulated using JavaScript or treated differently in
2920#### Extension: `ascii_identifiers` ####
2922Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2923Accents are stripped off of accented Latin letters, and non-Latin
2926#### Extension: `gfm_auto_identifiers` ####
2928Changes the algorithm used by `auto_identifiers` to conform to
2929GitHub's method. Spaces are converted to dashes (`-`),
2930uppercase characters to lowercase characters, and punctuation
2931characters other than `-` and `_` are removed.
2932Emojis are replaced by their names.
2936The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2937[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2938[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2939are described in the section about Pandoc's Markdown.
2941However, they can also be used with HTML input. This is handy for
2942reading web pages formatted using MathJax, for example.
2946The following extensions are described in more detail in
2947their respective sections of [Pandoc's Markdown]:
2949- [`raw_html`](#extension-raw_html) allows HTML elements which
2950 are not representable in pandoc's AST to be parsed as raw HTML.
2951 By default, this is disabled for HTML input.
2953- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2954 to be included in a document. This extension can be enabled/disabled
2955 for the following formats (in addition to `markdown`):
2958 : `latex`, `textile`, `html` (environments, `\ref`, and
2959 `\eqref` only), `ipynb`
2962 : `textile`, `commonmark`
2964 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2965 only raw TeX in markdown cells, but data with mime type
2966 `text/html` in output cells. Since the `ipynb` reader attempts
2967 to preserve the richest possible outputs when several options
2968 are given, you will get best results if you disable `raw_html`
2969 and `raw_tex` when converting to formats like `docx` which don't
2970 allow raw `html` or `tex`.
2972- [`native_divs`](#extension-native_divs) causes HTML `div`
2973 elements to be parsed as native pandoc Div blocks.
2974 If you want them to be parsed as raw HTML, use
2975 `-f html-native_divs+raw_html`.
2977- [`native_spans`](#extension-native_spans) causes HTML `span`
2978 elements to be parsed as native pandoc Span inlines.
2979 If you want them to be parsed as raw HTML, use
2980 `-f html-native_spans+raw_html`. If you want to drop all
2981 `div`s and `span`s when converting HTML to Markdown, you
2982 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2984## Literate Haskell support
2986#### Extension: `literate_haskell` ####
2988Treat the document as literate Haskell source.
2990This extension can be enabled/disabled for the following formats:
2993: `markdown`, `rst`, `latex`
2996: `markdown`, `rst`, `latex`, `html`
2998If you append `+lhs` (or `+literate_haskell`) to one of the formats
2999above, pandoc will treat the document as literate Haskell source.
3002 - In Markdown input, "bird track" sections will be parsed as Haskell
3003 code rather than block quotations. Text between `\begin{code}`
3004 and `\end{code}` will also be treated as Haskell code. For
3005 ATX-style headings the character '=' will be used instead of '#'.
3007 - In Markdown output, code blocks with classes `haskell` and `literate`
3008 will be rendered using bird tracks, and block quotations will be
3009 indented one space, so they will not be treated as Haskell code.
3010 In addition, headings will be rendered setext-style (with underlines)
3011 rather than ATX-style (with '#' characters). (This is because ghc
3012 treats '#' characters in column 1 as introducing line numbers.)
3014 - In restructured text input, "bird track" sections will be parsed
3017 - In restructured text output, code blocks with class `haskell` will
3018 be rendered using bird tracks.
3020 - In LaTeX input, text in `code` environments will be parsed as
3023 - In LaTeX output, code blocks with class `haskell` will be rendered
3024 inside `code` environments.
3026 - In HTML output, code blocks with class `haskell` will be rendered
3027 with class `literatehaskell` and bird tracks.
3031 pandoc -f markdown+lhs -t html
3033reads literate Haskell source formatted with Markdown conventions and writes
3034ordinary HTML (without bird tracks).
3036 pandoc -f markdown+lhs -t html+lhs
3038writes HTML with the Haskell code in bird tracks, so it can be copied
3039and pasted as literate Haskell source.
3041Note that GHC expects the bird tracks in the first column, so indented
3042literate code blocks (e.g. inside an itemized environment) will not be
3043picked up by the Haskell compiler.
3047#### Extension: `empty_paragraphs` ####
3049Allows empty paragraphs. By default empty paragraphs are
3052This extension can be enabled/disabled for the following formats:
3058: `docx`, `odt`, `opendocument`, `html`
3060#### Extension: `native_numbering` ####
3062Enables native numbering of figures and tables. Enumeration
3065This extension can be enabled/disabled for the following formats:
3068: `odt`, `opendocument`
3070#### Extension: `xrefs_name` ####
3072Links to headings, figures and tables inside the document are
3073substituted with cross-references that will use the name or caption
3074of the referenced item. The original link text is replaced once
3075the generated document is refreshed. This extension can be combined
3076with `xrefs_number` in which case numbers will appear before the
3079Text in cross-references is only made consistent with the referenced
3080item once the document has been refreshed.
3082This extension can be enabled/disabled for the following formats:
3085: `odt`, `opendocument`
3087#### Extension: `xrefs_number` ####
3089Links to headings, figures and tables inside the document are
3090substituted with cross-references that will use the number
3091of the referenced item. The original link text is discarded.
3092This extension can be combined with `xrefs_name` in which case
3093the name or caption numbers will appear after the number.
3095For the `xrefs_number` to be useful heading numbers must be enabled
3096in the generated document, also table and figure captions must be enabled
3097using for example the `native_numbering` extension.
3099Numbers in cross-references are only visible in the final document once
3100it has been refreshed.
3102This extension can be enabled/disabled for the following formats:
3105: `odt`, `opendocument`
3107#### Extension: `styles` #### {#ext-styles}
3109When converting from docx, read all docx styles as divs (for
3110paragraph styles) and spans (for character styles) regardless
3111of whether pandoc understands the meaning of these styles.
3112This can be used with [docx custom styles](#custom-styles).
3118#### Extension: `amuse` ####
3120In the `muse` input format, this enables Text::Amuse
3121extensions to Emacs Muse markup.
3123#### Extension: `raw_markdown` ####
3125In the `ipynb` input format, this causes Markdown cells
3126to be included as raw Markdown blocks (allowing lossless
3127round-tripping) rather than being parsed. Use this only
3128when you are targeting `ipynb` or a markdown-based
3131#### Extension: `citations` {#org-citations}
3133Some aspects of [Pandoc's Markdown citation syntax](#citations)
3134are also accepted in `org` input.
3136#### Extension: `element_citations` ####
3138In the `jats` output formats, this causes reference items to
3139be replaced with `<element-citation>` elements. These
3140elements are not influenced by CSL styles, but all information
3141on the item is included in tags.
3143#### Extension: `ntb` ####
3145In the `context` output format this enables the use of [Natural Tables
3146(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3147[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3148Natural tables allow more fine-grained global customization but come
3149at a performance penalty compared to extreme tables.
3154Pandoc understands an extended and slightly revised version of
3155John Gruber's [Markdown] syntax. This document explains the syntax,
3156noting differences from standard Markdown. Except where noted, these
3157differences can be suppressed by using the `markdown_strict` format instead
3158of `markdown`. Extensions can be enabled or disabled to specify the
3159behavior more granularly. They are described in the following. See also
3160[Extensions] above, for extensions that work also on other formats.
3164Markdown is designed to be easy to write, and, even more importantly,
3167> A Markdown-formatted document should be publishable as-is, as plain
3168> text, without looking like it's been marked up with tags or formatting
3170> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3172This principle has guided pandoc's decisions in finding syntax for
3173tables, footnotes, and other extensions.
3175There is, however, one respect in which pandoc's aims are different
3176from the original aims of Markdown. Whereas Markdown was originally
3177designed with HTML generation in mind, pandoc is designed for multiple
3178output formats. Thus, while pandoc allows the embedding of raw HTML,
3179it discourages it, and provides other, non-HTMLish ways of representing
3180important document elements like definition lists, tables, mathematics, and
3185A paragraph is one or more lines of text followed by one or more blank lines.
3186Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3187If you need a hard line break, put two or more spaces at the end of a line.
3189#### Extension: `escaped_line_breaks` ####
3191A backslash followed by a newline is also a hard line break.
3192Note: in multiline and grid table cells, this is the only way
3193to create a hard line break, since trailing spaces in the cells
3198There are two kinds of headings: Setext and ATX.
3200### Setext-style headings ###
3202A setext-style heading is a line of text "underlined" with a row of `=` signs
3203(for a level-one heading) or `-` signs (for a level-two heading):
3211The heading text can contain inline formatting, such as emphasis (see
3212[Inline formatting], below).
3215### ATX-style headings ###
3217An ATX-style heading consists of one to six `#` signs and a line of
3218text, optionally followed by any number of `#` signs. The number of
3219`#` signs at the beginning of the line is the heading level:
3221 ## A level-two heading
3223 ### A level-three heading ###
3225As with setext-style headings, the heading text can contain formatting:
3227 # A level-one heading with a [link](/url) and *emphasis*
3229#### Extension: `blank_before_header` ####
3231Standard Markdown syntax does not require a blank line before a heading.
3232Pandoc does require this (except, of course, at the beginning of the
3233document). The reason for the requirement is that it is all too easy for a
3234`#` to end up at the beginning of a line by accident (perhaps through line
3235wrapping). Consider, for example:
3237 I like several of their flavors of ice cream:
3238 #22, for example, and #5.
3240#### Extension: `space_in_atx_header` ####
3242Many Markdown implementations do not require a space between the
3243opening `#`s of an ATX heading and the heading text, so that
3244`#5 bolt` and `#hashtag` count as headings. With this extension,
3245pandoc does require the space.
3247### Heading identifiers ###
3249See also the [`auto_identifiers`
3250extension](#extension-auto_identifiers) above.
3252#### Extension: `header_attributes` ####
3254Headings can be assigned attributes using this syntax at the end
3255of the line containing the heading text:
3257 {#identifier .class .class key=value key=value}
3259Thus, for example, the following headings will all be assigned the identifier
3264 ## My heading ## {#foo}
3266 My other heading {#foo}
3269(This syntax is compatible with [PHP Markdown Extra].)
3271Note that although this syntax allows assignment of classes and key/value
3272attributes, writers generally don't use all of this information. Identifiers,
3273classes, and key/value attributes are used in HTML and HTML-based formats such
3274as EPUB and slidy. Identifiers are used for labels and link anchors in the
3275LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3277Headings with the class `unnumbered` will not be numbered, even if
3278`--number-sections` is specified. A single hyphen (`-`) in an attribute
3279context is equivalent to `.unnumbered`, and preferable in non-English
3286 # My heading {.unnumbered}
3288If the `unlisted` class is present in addition to `unnumbered`,
3289the heading will not be included in a table of contents.
3290(Currently this feature is only implemented for certain
3291formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3293#### Extension: `implicit_header_references` ####
3295Pandoc behaves as if reference links have been defined for each heading.
3296So, to link to a heading
3298 # Heading identifiers in HTML
3302 [Heading identifiers in HTML]
3306 [Heading identifiers in HTML][]
3310 [the section on heading identifiers][heading identifiers in
3313instead of giving the identifier explicitly:
3315 [Heading identifiers in HTML](#heading-identifiers-in-html)
3317If there are multiple headings with identical text, the corresponding
3318reference will link to the first one only, and you will need to use explicit
3319links to link to the others, as described above.
3321Like regular reference links, these references are case-insensitive.
3323Explicit link reference definitions always take priority over
3324implicit heading references. So, in the following example, the
3325link will point to `bar`, not to `#foo`:
3335Markdown uses email conventions for quoting blocks of text.
3336A block quotation is one or more paragraphs or other block elements
3337(such as lists or headings), with each line preceded by a `>` character
3338and an optional space. (The `>` need not start at the left margin, but
3339it should not be indented more than three spaces.)
3341 > This is a block quote. This
3342 > paragraph has two lines.
3344 > 1. This is a list inside a block quote.
3347A "lazy" form, which requires the `>` character only on the first
3348line of each block, is also allowed:
3350 > This is a block quote. This
3351 paragraph has two lines.
3353 > 1. This is a list inside a block quote.
3356Among the block elements that can be contained in a block quote are
3357other block quotes. That is, block quotes can be nested:
3359 > This is a block quote.
3361 > > A block quote within a block quote.
3363If the `>` character is followed by an optional space, that space
3364will be considered part of the block quote marker and not part of
3365the indentation of the contents. Thus, to put an indented code
3366block in a block quote, you need five spaces after the `>`:
3370#### Extension: `blank_before_blockquote` ####
3372Standard Markdown syntax does not require a blank line before a
3373block quote. Pandoc does require this (except, of course, at
3374the beginning of the document). The reason for the requirement
3375is that it is all too easy for a `>` to end up at the beginning
3376of a line by accident (perhaps through line wrapping). So,
3377unless the `markdown_strict` format is used, the following does
3378not produce a nested block quote in pandoc:
3380 > This is a block quote.
3384## Verbatim (code) blocks
3386### Indented code blocks ###
3388A block of text indented four spaces (or one tab) is treated as verbatim
3389text: that is, special characters do not trigger special formatting,
3390and all spaces and line breaks are preserved. For example,
3393 moveShip(5 * gravity, DOWN);
3396The initial (four space or one tab) indentation is not considered part
3397of the verbatim text, and is removed in the output.
3399Note: blank lines in the verbatim text need not begin with four spaces.
3402### Fenced code blocks ###
3404#### Extension: `fenced_code_blocks` ####
3406In addition to standard indented code blocks, pandoc supports
3407*fenced* code blocks. These begin with a row of three or more
3408tildes (`~`) and end with a row of tildes that must be at least as long as
3409the starting row. Everything between these lines is treated as code. No
3410indentation is necessary:
3414 moveShip(5 * gravity, DOWN);
3418Like regular code blocks, fenced code blocks must be separated
3419from surrounding text by blank lines.
3421If the code itself contains a row of tildes or backticks, just use a longer
3422row of tildes or backticks at the start and end:
3426 code including tildes
3430#### Extension: `backtick_code_blocks` ####
3432Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3435#### Extension: `fenced_code_attributes` ####
3437Optionally, you may attach attributes to fenced or backtick code block using
3440 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3442 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3443 qsort (filter (>= x) xs)
3444 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3446Here `mycode` is an identifier, `haskell` and `numberLines` are
3447classes, and `startFrom` is an attribute with value `100`. Some
3448output formats can use this information to do syntax
3449highlighting. Currently, the only output formats that uses this
3450information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3451highlighting is supported for your output format and language,
3452then the code block above will appear highlighted, with numbered
3453lines. (To see which languages are supported, type `pandoc
3454--list-highlight-languages`.) Otherwise, the code block above
3455will appear as follows:
3457 <pre id="mycode" class="haskell numberLines" startFrom="100">
3463The `numberLines` (or `number-lines`) class will cause the lines
3464of the code block to be numbered, starting with `1` or the value
3465of the `startFrom` attribute. The `lineAnchors` (or
3466`line-anchors`) class will cause the lines to be clickable
3467anchors in HTML output.
3469A shortcut form can also be used for specifying the language of
3476This is equivalent to:
3482If the `fenced_code_attributes` extension is disabled, but
3483input contains class attribute(s) for the code block, the first
3484class attribute will be printed after the opening fence as a bare
3487To prevent all highlighting, use the `--no-highlight` flag.
3488To set the highlighting style, use `--highlight-style`.
3489For more information on highlighting, see [Syntax highlighting],
3494#### Extension: `line_blocks` ####
3496A line block is a sequence of lines beginning with a vertical bar (`|`)
3497followed by a space. The division into lines will be preserved in
3498the output, as will any leading spaces; otherwise, the lines will
3499be formatted as Markdown. This is useful for verse and addresses:
3501 | The limerick packs laughs anatomical
3502 | In space that is quite economical.
3503 | But the good ones I've seen
3504 | So seldom are clean
3505 | And the clean ones so seldom are comical
3508 | Berkeley, CA 94718
3510The lines can be hard-wrapped if needed, but the continuation
3511line must begin with a space.
3513 | The Right Honorable Most Venerable and Righteous Samuel L.
3516 | Berkeley, CA 94718
3518Inline formatting (such as emphasis) is allowed in the content,
3519but not block-level formatting (such as block quotes or lists).
3521This syntax is borrowed from [reStructuredText].
3527A bullet list is a list of bulleted list items. A bulleted list
3528item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3535This will produce a "compact" list. If you want a "loose" list, in which
3536each item is formatted as a paragraph, put spaces between the items:
3544The bullets need not be flush with the left margin; they may be
3545indented one, two, or three spaces. The bullet must be followed
3548List items look best if subsequent lines are flush with the first
3549line (after the bullet):
3555But Markdown also allows a "lazy" format:
3561### Block content in list items ###
3563A list item may contain multiple paragraphs and other block-level
3564content. However, subsequent paragraphs must be preceded by a blank line
3565and indented to line up with the first non-space content after
3572 * Second paragraph. With a code block, which must be indented
3577Exception: if the list marker is followed by an indented code
3578block, which must begin 5 spaces after the list marker, then
3579subsequent paragraphs must begin two columns after the last
3580character of the list marker:
3584 continuation paragraph
3586List items may include other lists. In this case the preceding blank
3587line is optional. The nested list must be indented to line up with
3588the first non-space character after the list marker of the
3589containing list item.
3601As noted above, Markdown allows you to write list items "lazily," instead of
3602indenting continuation lines. However, if there are multiple paragraphs or
3603other blocks in a list item, the first line of each must be indented.
3605 + A lazy, lazy, list
3608 + Another one; this looks
3611 Second paragraph of second
3614### Ordered lists ###
3616Ordered lists work just like bulleted lists, except that the items
3617begin with enumerators rather than bullets.
3619In standard Markdown, enumerators are decimal numbers followed
3620by a period and a space. The numbers themselves are ignored, so
3621there is no difference between this list:
3633#### Extension: `fancy_lists` ####
3635Unlike standard Markdown, pandoc allows ordered list items to be marked
3636with uppercase and lowercase letters and roman numerals, in addition to
3637Arabic numerals. List markers may be enclosed in parentheses or followed by a
3638single right-parentheses or period. They must be separated from the
3639text that follows by at least one space, and, if the list marker is a
3640capital letter with a period, by at least two spaces.[^2]
3642[^2]: The point of this rule is to ensure that normal paragraphs
3643 starting with people's initials, like
3645 B. Russell was an English philosopher.
3647 do not get treated as list items.
3649 This rule will not prevent
3653 from being interpreted as a list item. In this case, a backslash
3658The `fancy_lists` extension also allows '`#`' to be used as an
3659ordered list marker in place of a numeral:
3664#### Extension: `startnum` ####
3666Pandoc also pays attention to the type of list marker used, and to the
3667starting number, and both of these are preserved where possible in the
3668output format. Thus, the following yields a list with numbers followed
3669by a single parenthesis, starting with 9, and a sublist with lowercase
3679Pandoc will start a new list each time a different type of list
3680marker is used. So, the following will create three lists:
3687If default list markers are desired, use `#.`:
3693#### Extension: `task_lists` ####
3695Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3697 - [ ] an unchecked task list item
3700### Definition lists ###
3702#### Extension: `definition_lists` ####
3704Pandoc supports definition lists, using the syntax of
3705[PHP Markdown Extra] with some extensions.[^3]
3711 Term 2 with *inline markup*
3715 { some code, part of Definition 2 }
3717 Third paragraph of definition 2.
3719Each term must fit on one line, which may optionally be followed by
3720a blank line, and must be followed by one or more definitions.
3721A definition begins with a colon or tilde, which may be indented one
3724A term may have multiple definitions, and each definition may
3725consist of one or more block elements (paragraph, code block,
3726list, etc.), each indented four spaces or one tab stop. The
3727body of the definition (including the first line, aside from the
3728colon or tilde) should be indented four spaces. However, as with
3729other Markdown lists, you can "lazily" omit indentation except
3730at the beginning of a paragraph or other block element:
3735 with lazy continuation.
3737 Second paragraph of the definition.
3739If you leave space before the definition (as in the example above),
3740the text of the definition will be treated as a paragraph. In some
3741output formats, this will mean greater spacing between term/definition
3742pairs. For a more compact definition list, omit the space before the
3752Note that space between items in a definition list is required.
3753(A variant that loosens this requirement, but disallows "lazy"
3754hard wrapping, can be activated with `compact_definition_lists`: see
3755[Non-pandoc extensions], below.)
3757[^3]: I have been influenced by the suggestions of [David
3758 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3760### Numbered example lists ###
3762#### Extension: `example_lists` ####
3764The special list marker `@` can be used for sequentially numbered
3765examples. The first list item with a `@` marker will be numbered '1',
3766the next '2', and so on, throughout the document. The numbered examples
3767need not occur in a single list; each new list using `@` will take up
3768where the last stopped. So, for example:
3770 (@) My first example will be numbered (1).
3771 (@) My second example will be numbered (2).
3773 Explanation of examples.
3775 (@) My third example will be numbered (3).
3777Numbered examples can be labeled and referred to elsewhere in the
3780 (@good) This is a good example.
3782 As (@good) illustrates, ...
3784The label can be any string of alphanumeric characters, underscores,
3787Note: continuation paragraphs in example lists must always
3788be indented four spaces, regardless of the length of the
3789list marker. That is, example lists always behave as if the
3790`four_space_rule` extension is set. This is because example
3791labels tend to be long, and indenting content to the
3792first non-space character after the label would be awkward.
3795### Ending a list ###
3797What if you want to put an indented code block after a list?
3804Trouble! Here pandoc (like other Markdown implementations) will treat
3805`{ my code block }` as the second paragraph of item two, and not as
3808To "cut off" the list after item two, you can insert some non-indented
3809content, like an HTML comment, which won't produce visible output in
3815 <!-- end of list -->
3819You can use the same trick if you want two consecutive lists instead
3834A line containing a row of three or more `*`, `-`, or `_` characters
3835(optionally separated by spaces) produces a horizontal rule:
3844Four kinds of tables may be used. The first three kinds presuppose the use of
3845a fixed-width font, such as Courier. The fourth kind can be used with
3846proportionally spaced fonts, as it does not require lining up columns.
3848#### Extension: `table_captions` ####
3850A caption may optionally be provided with all 4 kinds of tables (as
3851illustrated in the examples below). A caption is a paragraph beginning
3852with the string `Table:` (or just `:`), which will be stripped off.
3853It may appear either before or after the table.
3855#### Extension: `simple_tables` ####
3857Simple tables look like this:
3859 Right Left Center Default
3860 ------- ------ ---------- -------
3865 Table: Demonstration of simple table syntax.
3867The header and table rows must each fit on one line. Column
3868alignments are determined by the position of the header text relative
3869to the dashed line below it:[^4]
3871 - If the dashed line is flush with the header text on the right side
3872 but extends beyond it on the left, the column is right-aligned.
3873 - If the dashed line is flush with the header text on the left side
3874 but extends beyond it on the right, the column is left-aligned.
3875 - If the dashed line extends beyond the header text on both sides,
3876 the column is centered.
3877 - If the dashed line is flush with the header text on both sides,
3878 the default alignment is used (in most cases, this will be left).
3880[^4]: This scheme is due to Michel Fortin, who proposed it on the
3881 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3883The table must end with a blank line, or a line of dashes followed by
3886The column header row may be omitted, provided a dashed line is used
3887to end the table. For example:
3889 ------- ------ ---------- -------
3893 ------- ------ ---------- -------
3895When the header row is omitted, column alignments are determined on the basis
3896of the first line of the table body. So, in the tables above, the columns
3897would be right, left, center, and right aligned, respectively.
3899#### Extension: `multiline_tables` ####
3901Multiline tables allow header and table rows to span multiple lines
3902of text (but cells that span multiple columns or rows of the table are
3903not supported). Here is an example:
3905 -------------------------------------------------------------
3906 Centered Default Right Left
3907 Header Aligned Aligned Aligned
3908 ----------- ------- --------------- -------------------------
3909 First row 12.0 Example of a row that
3910 spans multiple lines.
3912 Second row 5.0 Here's another one. Note
3913 the blank line between
3915 -------------------------------------------------------------
3917 Table: Here's the caption. It, too, may span
3920These work like simple tables, but with the following differences:
3922 - They must begin with a row of dashes, before the header text
3923 (unless the header row is omitted).
3924 - They must end with a row of dashes, then a blank line.
3925 - The rows must be separated by blank lines.
3927In multiline tables, the table parser pays attention to the widths of
3928the columns, and the writers try to reproduce these relative widths in
3929the output. So, if you find that one of the columns is too narrow in the
3930output, try widening it in the Markdown source.
3932The header may be omitted in multiline tables as well as simple tables:
3934 ----------- ------- --------------- -------------------------
3935 First row 12.0 Example of a row that
3936 spans multiple lines.
3938 Second row 5.0 Here's another one. Note
3939 the blank line between
3941 ----------- ------- --------------- -------------------------
3943 : Here's a multiline table without a header.
3945It is possible for a multiline table to have just one row, but the row
3946should be followed by a blank line (and then the row of dashes that ends
3947the table), or the table may be interpreted as a simple table.
3949#### Extension: `grid_tables` ####
3951Grid tables look like this:
3953 : Sample grid table.
3955 +---------------+---------------+--------------------+
3956 | Fruit | Price | Advantages |
3957 +===============+===============+====================+
3958 | Bananas | $1.34 | - built-in wrapper |
3959 | | | - bright color |
3960 +---------------+---------------+--------------------+
3961 | Oranges | $2.10 | - cures scurvy |
3963 +---------------+---------------+--------------------+
3965The row of `=`s separates the header from the table body, and can be
3966omitted for a headerless table. The cells of grid tables may contain
3967arbitrary block elements (multiple paragraphs, code blocks, lists,
3968etc.). Cells that span multiple columns or rows are not
3969supported. Grid tables can be created easily using Emacs' table-mode
3970(`M-x table-insert`).
3972Alignments can be specified as with pipe tables, by putting
3973colons at the boundaries of the separator line after the
3976 +---------------+---------------+--------------------+
3977 | Right | Left | Centered |
3978 +==============:+:==============+:==================:+
3979 | Bananas | $1.34 | built-in wrapper |
3980 +---------------+---------------+--------------------+
3982For headerless tables, the colons go on the top line instead:
3984 +--------------:+:--------------+:------------------:+
3985 | Right | Left | Centered |
3986 +---------------+---------------+--------------------+
3988##### Grid Table Limitations #####
3990Pandoc does not support grid tables with row spans or column spans.
3991This means that neither variable numbers of columns across rows nor
3992variable numbers of rows across columns are supported by Pandoc.
3993All grid tables must have the same number of columns in each row,
3994and the same number of rows in each column. For example, the
3995Docutils [sample grid tables] will not render as expected with
3998[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
4001#### Extension: `pipe_tables` ####
4003Pipe tables look like this:
4005 | Right | Left | Default | Center |
4006 |------:|:-----|---------|:------:|
4007 | 12 | 12 | 12 | 12 |
4008 | 123 | 123 | 123 | 123 |
4011 : Demonstration of pipe table syntax.
4013The syntax is identical to [PHP Markdown Extra tables]. The beginning and
4014ending pipe characters are optional, but pipes are required between all
4015columns. The colons indicate column alignment as shown. The header
4016cannot be omitted. To simulate a headerless table, include a header
4019Since the pipes indicate column boundaries, columns need not be vertically
4020aligned, as they are in the above example. So, this is a perfectly
4021legal (though ugly) pipe table:
4029The cells of pipe tables cannot contain block elements like paragraphs
4030and lists, and cannot span multiple lines. If a pipe table contains a
4031row whose Markdown content is wider than the column width (see
4032`--columns`), then the table will take up the full text width and
4033the cell contents will wrap, with the relative cell widths determined
4034by the number of dashes in the line separating the table header from
4035the table body. (For example `---|-` would make the first column 3/4
4036and the second column 1/4 of the full text width.)
4037On the other hand, if no lines are wider than column width, then
4038cell contents will not be wrapped, and the cells will be sized
4041Note: pandoc also recognizes pipe tables of the following
4042form, as can be produced by Emacs' orgtbl-mode:
4049The difference is that `+` is used instead of `|`. Other orgtbl features
4050are not supported. In particular, to get non-default column alignment,
4051you'll need to add colons as above.
4053[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4057#### Extension: `pandoc_title_block` ####
4059If the file begins with a title block
4062 % author(s) (separated by semicolons)
4065it will be parsed as bibliographic information, not regular text. (It
4066will be used, for example, in the title of standalone LaTeX or HTML
4067output.) The block may contain just a title, a title and an author,
4068or all three elements. If you want to include an author but no
4069title, or a title and a date but no author, you need a blank line:
4082The title may occupy multiple lines, but continuation lines must
4083begin with leading space, thus:
4090If a document has multiple authors, the authors may be put on
4091separate lines with leading space, or separated by semicolons, or
4092both. So, all of the following are equivalent:
4100% Author One; Author Two
4108The date must fit on one line.
4110All three metadata fields may contain standard inline formatting
4111(italics, links, footnotes, etc.).
4113Title blocks will always be parsed, but they will affect the output only
4114when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4115will appear twice: once in the document head -- this is the title that
4116will appear at the top of the window in a browser -- and once at the
4117beginning of the document body. The title in the document head can have
4118an optional prefix attached (`--title-prefix` or `-T` option). The title
4119in the body appears as an H1 element with class "title", so it can be
4120suppressed or reformatted with CSS. If a title prefix is specified with
4121`-T` and no title block appears in the document, the title prefix will
4122be used by itself as the HTML title.
4124The man page writer extracts a title, man page section number, and
4125other header and footer information from the title line. The title
4126is assumed to be the first word on the title line, which may optionally
4127end with a (single-digit) section number in parentheses. (There should
4128be no space between the title and the parentheses.) Anything after
4129this is assumed to be additional footer and header text. A single pipe
4130character (`|`) should be used to separate the footer text from the header
4135will yield a man page with the title `PANDOC` and section 1.
4137 % PANDOC(1) Pandoc User Manuals
4139will also have "Pandoc User Manuals" in the footer.
4141 % PANDOC(1) Pandoc User Manuals | Version 4.0
4143will also have "Version 4.0" in the header.
4145#### Extension: `yaml_metadata_block` ####
4147A [YAML] metadata block is a valid YAML object, delimited by a line of three
4148hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4149(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4150document, but if it is not at the beginning, it must be preceded by a blank
4151line. (Note that, because of the way pandoc concatenates input files when
4152several are provided, you may also keep the metadata in a separate YAML file
4153and pass it to pandoc as an argument, along with your Markdown files:
4155 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4157Just be sure that the YAML file begins with `---` and ends with `---` or
4158`...`.) Alternatively, you can use the `--metadata-file` option. Using
4159that approach however, you cannot reference content (like footnotes)
4160from the main markdown input document.
4162Metadata will be taken from the fields of the YAML object and added to any
4163existing document metadata. Metadata can contain lists and objects (nested
4164arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4165with names ending in an underscore will be ignored by pandoc. (They may be
4166given a role by external processors.) Field names must not be
4167interpretable as YAML numbers or boolean values (so, for
4168example, `yes`, `True`, and `15` cannot be used as field names).
4170A document may contain multiple metadata blocks. If two
4171metadata blocks attempt to set the same field, the value from
4172the second block will be taken.
4174When pandoc is used with `-t markdown` to create a Markdown document,
4175a YAML metadata block will be produced only if the `-s/--standalone`
4176option is used. All of the metadata will appear in a single block
4177at the beginning of the document.
4179Note that [YAML] escaping rules must be followed. Thus, for example,
4180if a title contains a colon, it must be quoted. The pipe character
4181(`|`) can be used to begin an indented block that will be interpreted
4182literally, without need for escaping. This form is necessary
4183when the field contains blank lines or block-level formatting:
4186 title: 'This is the title: it contains a colon'
4190 keywords: [nothing, nothingness]
4192 This is the abstract.
4194 It consists of two paragraphs.
4197Template variables will be set automatically from the metadata. Thus, for
4198example, in writing HTML, the variable `abstract` will be set to the HTML
4199equivalent of the Markdown in the `abstract` field:
4201 <p>This is the abstract.</p>
4202 <p>It consists of two paragraphs.</p>
4204Variables can contain arbitrary YAML structures, but the template must match
4205this structure. The `author` variable in the default templates expects a
4206simple list or string, but can be changed to support more complicated
4207structures. The following combination, for example, would add an affiliation
4208to the author if one is given:
4211 title: The document title
4214 affiliation: University of Somewhere
4216 affiliation: University of Nowhere
4219To use the structured authors in the example above, you would need a custom
4224 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4230Raw content to include in the document's header may be specified
4231using `header-includes`; however, it is important to mark up
4232this content as raw code for a particular output format, using
4233the [`raw_attribute` extension](#extension-raw_attribute)), or it
4234will be interpreted as markdown. For example:
4239 \let\oldsection\section
4240 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4243Note: the `yaml_metadata_block` extension works with
4244`commonmark` as well as `markdown` (and it is enabled by default
4245in `gfm` and `commonmark_x`). However, in these formats the
4246following restrictions apply:
4248- The YAML metadata block must occur at the beginning of the
4249 document (and there can be only one). If multiple files are
4250 given as arguments to pandoc, only the first can be a YAML
4253- The leaf nodes of the YAML structure are parsed in isolation from
4254 each other and from the rest of the document. So, for
4255 example, you can't use a reference link in these contexts
4256 if the link definition is somewhere else in the document.
4261#### Extension: `all_symbols_escapable` ####
4263Except inside a code block or inline code, any punctuation or space
4264character preceded by a backslash will be treated literally, even if it
4265would normally indicate formatting. Thus, for example, if one writes
4275 <strong>hello</strong>
4277This rule is easier to remember than standard Markdown's rule,
4278which allows only the following characters to be backslash-escaped:
4282(However, if the `markdown_strict` format is used, the standard Markdown rule
4285A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4286it will appear as `~`. In HTML and XML output, it will appear as a
4287literal unicode nonbreaking space character (note that it will thus
4288actually look "invisible" in the generated HTML source; you can still
4289use the `--ascii` command-line option to make it appear as an explicit
4292A backslash-escaped newline (i.e. a backslash occurring at the end of
4293a line) is parsed as a hard line break. It will appear in TeX output as
4294`\\` and in HTML as `<br />`. This is a nice alternative to
4295Markdown's "invisible" way of indicating hard line breaks using
4296two trailing spaces on a line.
4298Backslash escapes do not work in verbatim contexts.
4304To *emphasize* some text, surround it with `*`s or `_`, like this:
4306 This text is _emphasized with underscores_, and this
4307 is *emphasized with asterisks*.
4309Double `*` or `_` produces **strong emphasis**:
4311 This is **strong emphasis** and __with underscores__.
4313A `*` or `_` character surrounded by spaces, or backslash-escaped,
4314will not trigger emphasis:
4316 This is * not emphasized *, and \*neither is this\*.
4318#### Extension: `intraword_underscores` ####
4320Because `_` is sometimes used inside words and identifiers,
4321pandoc does not interpret a `_` surrounded by alphanumeric
4322characters as an emphasis marker. If you want to emphasize
4323just part of a word, use `*`:
4325 feas*ible*, not feas*able*.
4330#### Extension: `strikeout` ####
4332To strikeout a section of text with a horizontal line, begin and end it
4333with `~~`. Thus, for example,
4335 This ~~is deleted text.~~
4338### Superscripts and subscripts ###
4340#### Extension: `superscript`, `subscript` ####
4342Superscripts may be written by surrounding the superscripted text by `^`
4343characters; subscripts may be written by surrounding the subscripted
4344text by `~` characters. Thus, for example,
4346 H~2~O is a liquid. 2^10^ is 1024.
4348The text between `^...^` or `~...~` may not contain spaces or
4349newlines. If the superscripted or subscripted text contains
4350spaces, these spaces must be escaped with backslashes. (This is
4351to prevent accidental superscripting and subscripting through
4352the ordinary use of `~` and `^`, and also bad interactions with
4353footnotes.) Thus, if you want the letter P with 'a cat' in
4354subscripts, use `P~a\ cat~`, not `P~a cat~`.
4358To make a short span of text verbatim, put it inside backticks:
4360 What is the difference between `>>=` and `>>`?
4362If the verbatim text includes a backtick, use double backticks:
4364 Here is a literal backtick `` ` ``.
4366(The spaces after the opening backticks and before the closing
4367backticks will be ignored.)
4369The general rule is that a verbatim span starts with a string
4370of consecutive backticks (optionally followed by a space)
4371and ends with a string of the same number of backticks (optionally
4372preceded by a space).
4374Note that backslash-escapes (and other Markdown constructs) do not
4375work in verbatim contexts:
4377 This is a backslash followed by an asterisk: `\*`.
4379#### Extension: `inline_code_attributes` ####
4381Attributes can be attached to verbatim text, just as with
4382[fenced code blocks]:
4388To write small caps, use the `smallcaps` class:
4390 [Small caps]{.smallcaps}
4392Or, without the `bracketed_spans` extension:
4394 <span class="smallcaps">Small caps</span>
4396For compatibility with other Markdown flavors, CSS is also supported:
4398 <span style="font-variant:small-caps;">Small caps</span>
4400This will work in all output formats that support small caps.
4405#### Extension: `tex_math_dollars` ####
4407Anything between two `$` characters will be treated as TeX math. The
4408opening `$` must have a non-space character immediately to its right,
4409while the closing `$` must have a non-space character immediately to its
4410left, and must not be followed immediately by a digit. Thus,
4411`$20,000 and $30,000` won't parse as math. If for some reason
4412you need to enclose text in literal `$` characters, backslash-escape
4413them and they won't be treated as math delimiters.
4415For display math, use `$$` delimiters. (In this case, the delimiters
4416may be separated from the formula by whitespace. However, there can be
4417no blank lines betwen the opening and closing `$$` delimiters.)
4419TeX math will be printed in all output formats. How it is rendered
4420depends on the output format:
4423 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4424 math) or `\[...\]` (for display math).
4426Markdown, Emacs Org mode, ConTeXt, ZimWiki
4427 ~ It will appear verbatim surrounded by `$...$` (for inline
4428 math) or `$$...$$` (for display math).
4431 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4434 ~ It will be rendered using an [interpreted text role `:math:`].
4437 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4438 surrounded by `latexmath:[$...$]` (for inline math) or
4439 `[latexmath]++++\[...\]+++` (for display math).
4440 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4441 (`$..$` and `\[..\]`) are omitted.
4444 ~ It will be rendered inside a `@math` command.
4446roff man, Jira markup
4447 ~ It will be rendered verbatim without `$`'s.
4450 ~ It will be rendered inside `<math>` tags.
4453 ~ It will be rendered inside `<span class="math">` tags.
4456 ~ It will be rendered, if possible, using Unicode characters,
4457 and will otherwise appear verbatim.
4460 ~ It will be rendered, if possible, using MathML.
4463 ~ If the `--mathml` flag is used, it will be rendered using MathML
4464 in an `inlineequation` or `informalequation` tag. Otherwise it
4465 will be rendered, if possible, using Unicode characters.
4468 ~ It will be rendered using OMML math markup.
4471 ~ If the `--webtex` option is used, formulas are rendered as images
4472 using CodeCogs or other compatible web service, downloaded
4473 and embedded in the e-book. Otherwise, they will appear verbatim.
4475HTML, Slidy, DZSlides, S5, EPUB
4476 ~ The way math is rendered in HTML will depend on the
4477 command-line options selected. Therefore see [Math rendering in HTML]
4480[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4484#### Extension: `raw_html` ####
4486Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4487(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4488literally). (Technically this is not an extension, since standard
4489Markdown allows it, but it has been made an extension so that it can
4490be disabled if desired.)
4492The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4493DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4494output, and suppressed in other formats.
4496For a more explicit way of including raw HTML in a Markdown
4497document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4499In the CommonMark format, if `raw_html` is enabled, superscripts,
4500subscripts, strikeouts and small capitals will be represented as HTML.
4501Otherwise, plain-text fallbacks will be used. Note that even if
4502`raw_html` is disabled, tables will be rendered with HTML syntax if
4503they cannot use pipe syntax.
4505#### Extension: `markdown_in_html_blocks` ####
4507Standard Markdown allows you to include HTML "blocks": blocks
4508of HTML between balanced tags that are separated from the surrounding text
4509with blank lines, and start and end at the left margin. Within
4510these blocks, everything is interpreted as HTML, not Markdown;
4511so (for example), `*` does not signify emphasis.
4513Pandoc behaves this way when the `markdown_strict` format is used; but
4514by default, pandoc interprets material between HTML block tags as Markdown.
4515Thus, for example, pandoc will turn
4520 <td>[a link](https://google.com)</td>
4528 <td><em>one</em></td>
4529 <td><a href="https://google.com">a link</a></td>
4533whereas `Markdown.pl` will preserve it as is.
4535There is one exception to this rule: text between `<script>`,
4536`<style>`, and `<textarea>` tags is not interpreted as Markdown.
4538This departure from standard Markdown should make it easier to mix
4539Markdown with HTML block elements. For example, one can surround
4540a block of Markdown text with `<div>` tags without preventing it
4541from being interpreted as Markdown.
4543#### Extension: `native_divs` ####
4545Use native pandoc `Div` blocks for content inside `<div>` tags.
4546For the most part this should give the same output as
4547`markdown_in_html_blocks`, but it makes it easier to write pandoc
4548filters to manipulate groups of blocks.
4550#### Extension: `native_spans` ####
4552Use native pandoc `Span` blocks for content inside `<span>` tags.
4553For the most part this should give the same output as `raw_html`,
4554but it makes it easier to write pandoc filters to manipulate groups
4557#### Extension: `raw_tex` ####
4559In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4560included in a document. Inline TeX commands will be preserved and passed
4561unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4562LaTeX to include BibTeX citations:
4564 This result was proved in \cite{jones.1967}.
4566Note that in LaTeX environments, like
4568 \begin{tabular}{|l|l|}\hline
4569 Age & Frequency \\ \hline
4572 36--45 & 22 \\ \hline
4575the material between the begin and end tags will be interpreted as raw
4576LaTeX, not as Markdown.
4578For a more explicit and flexible way of including raw TeX in a
4579Markdown document, see the [`raw_attribute`
4580extension][Extension: `raw_attribute`].
4582Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4583Emacs Org mode, and ConTeXt.
4585### Generic raw attribute ###
4587#### Extension: `raw_attribute` ####
4589Inline spans and fenced code blocks with a special
4590kind of attribute will be parsed as raw content with the
4591designated format. For example, the following produces a raw
4598And the following produces a raw `html` inline element:
4600 This is `<a>html</a>`{=html}
4602This can be useful to insert raw xml into `docx` documents, e.g.
4608 <w:br w:type="page"/>
4613The format name should match the target format name (see
4614`-t/--to`, above, for a list, or use `pandoc
4615--list-output-formats`). Use `openxml` for `docx` output,
4616`opendocument` for `odt` output, `html5` for `epub3` output,
4617`html4` for `epub2` output, and `latex`, `beamer`,
4618`ms`, or `html5` for `pdf` output (depending on what you
4619use for `--pdf-engine`).
4621This extension presupposes that the relevant kind of
4622inline code or fenced code block is enabled. Thus, for
4623example, to use a raw attribute with a backtick code block,
4624`backtick_code_blocks` must be enabled.
4626The raw attribute cannot be combined with regular attributes.
4630#### Extension: `latex_macros` ####
4632When this extension is enabled, pandoc will parse LaTeX
4633macro definitions and apply the resulting macros to all LaTeX
4634math and raw LaTeX. So, for example, the following will work in
4635all output formats, not just LaTeX:
4637 \newcommand{\tuple}[1]{\langle #1 \rangle}
4641Note that LaTeX macros will not be applied if they occur
4642inside a raw span or block marked with the
4643[`raw_attribute` extension](#extension-raw_attribute).
4645When `latex_macros` is disabled, the raw LaTeX and math will
4646not have macros applied. This is usually a better approach when
4647you are targeting LaTeX or PDF.
4649Macro definitions in LaTeX will be passed through as raw LaTeX
4650only if `latex_macros` is not enabled. Macro definitions in
4651Markdown source (or other formats allowing `raw_tex`) will
4652be passed through regardless of whether `latex_macros` is
4657Markdown allows links to be specified in several ways.
4659### Automatic links ###
4661If you enclose a URL or email address in pointy brackets, it
4664 <https://google.com>
4665 <sam@green.eggs.ham>
4669An inline link consists of the link text in square brackets,
4670followed by the URL in parentheses. (Optionally, the URL can
4671be followed by a link title, in quotes.)
4673 This is an [inline link](/url), and here's [one with
4674 a title](https://fsf.org "click here for a good time!").
4676There can be no space between the bracketed part and the parenthesized part.
4677The link text can contain formatting (such as emphasis), but the title cannot.
4679Email addresses in inline links are not autodetected, so they have to be
4680prefixed with `mailto`:
4682 [Write me!](mailto:sam@green.eggs.ham)
4684### Reference links ###
4686An *explicit* reference link has two parts, the link itself and the link
4687definition, which may occur elsewhere in the document (either
4688before or after the link).
4690The link consists of link text in square brackets, followed by a label in
4691square brackets. (There cannot be space between the two unless the
4692`spaced_reference_links` extension is enabled.) The link definition
4693consists of the bracketed label, followed by a colon and a space, followed by
4694the URL, and optionally (after a space) a link title either in quotes or in
4695parentheses. The label must not be parseable as a citation (assuming
4696the `citations` extension is enabled): citations take precedence over
4699Here are some examples:
4701 [my label 1]: /foo/bar.html "My title, optional"
4703 [my label 3]: https://fsf.org (The free software foundation)
4704 [my label 4]: /bar#special 'A title in single quotes'
4706The URL may optionally be surrounded by angle brackets:
4708 [my label 5]: <http://foo.bar.baz>
4710The title may go on the next line:
4712 [my label 3]: https://fsf.org
4713 "The free software foundation"
4715Note that link labels are not case sensitive. So, this will work:
4717 Here is [my link][FOO]
4721In an *implicit* reference link, the second pair of brackets is
4726 [my website]: http://foo.bar.baz
4728Note: In `Markdown.pl` and most other Markdown implementations,
4729reference link definitions cannot occur in nested constructions
4730such as list items or block quotes. Pandoc lifts this arbitrary
4731seeming restriction. So the following is fine in pandoc, though
4732not in most other implementations:
4738#### Extension: `shortcut_reference_links` ####
4740In a *shortcut* reference link, the second pair of brackets may
4745 [my website]: http://foo.bar.baz
4747### Internal links ###
4749To link to another section of the same document, use the automatically
4750generated identifier (see [Heading identifiers]). For example:
4752 See the [Introduction](#introduction).
4756 See the [Introduction].
4758 [Introduction]: #introduction
4760Internal links are currently supported for HTML formats (including
4761HTML slide shows and EPUB), LaTeX, and ConTeXt.
4765A link immediately preceded by a `!` will be treated as an image.
4766The link text will be used as the image's alt text:
4768 
4772 [movie reel]: movie.gif
4774#### Extension: `implicit_figures` ####
4776An image with nonempty alt text, occurring by itself in a
4777paragraph, will be rendered as a figure with a caption. The
4778image's alt text will be used as the caption.
4780 
4782How this is rendered depends on the output format. Some output
4783formats (e.g. RTF) do not yet support figures. In those
4784formats, you'll just get an image in a paragraph by itself, with
4787If you just want a regular inline image, just make sure it is not
4788the only thing in the paragraph. One way to do this is to insert a
4789nonbreaking space after the image:
4791 \
4793Note that in reveal.js slide shows, an image in a paragraph
4794by itself that has the `stretch` class will fill the screen,
4795and the caption and figure tags will be omitted.
4797#### Extension: `link_attributes` ####
4799Attributes can be set on links and images:
4801 An inline {#id .class width=30 height=20px}
4802 and a reference ![image][ref] with attributes.
4804 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4806(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4807and `.class` are used.)
4809For HTML and EPUB, all known HTML5 attributes except `width` and
4810`height` (but including `srcset` and `sizes`) are passed through
4811as is. Unknown attributes are passed through as custom
4812attributes, with `data-` prepended. The other writers ignore
4813attributes that are not specifically supported by their output format.
4815The `width` and `height` attributes on images are treated specially. When
4816used without a unit, the unit is assumed to be pixels. However, any of
4817the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4818and `%`. There must not be any spaces between the number and the unit.
4822{ width=50% }
4825- Dimensions may be converted to a form that is compatible with
4826 the output format (for example, dimensions given in pixels will
4827 be converted to inches when converting HTML to LaTeX). Conversion
4828 between pixels and physical measurements is affected by the
4829 `--dpi` option (by default, 96 dpi is assumed, unless the image
4830 itself contains dpi information).
4831- The `%` unit is generally relative to some available space.
4832 For example the above example will render to the following.
4833 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4834 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4835 (If you're using a custom template, you need to configure `graphicx`
4836 as in the default template.)
4837 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4838- Some output formats have a notion of a class
4839 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4840 or a unique identifier (LaTeX `\caption`), or both (HTML).
4841- When no `width` or `height` attributes are specified, the fallback
4842 is to look at the image resolution and the dpi metadata embedded in
4847Using the `native_divs` and `native_spans` extensions
4848(see [above][Extension: `native_divs`]), HTML syntax can
4849be used as part of markdown to create native `Div` and `Span`
4850elements in the pandoc AST (as opposed to raw HTML).
4851However, there is also nicer syntax available:
4853#### Extension: `fenced_divs` ####
4855Allow special fenced syntax for native `Div` blocks. A Div
4856starts with a fence containing at least three consecutive
4857colons plus some attributes. The attributes may optionally
4858be followed by another string of consecutive colons.
4859The attribute syntax is exactly as in fenced code blocks (see
4860[Extension: `fenced_code_attributes`]). As with fenced
4861code blocks, one can use either attributes in curly braces
4862or a single unbraced word, which will be treated as a class
4863name. The Div ends with another line containing a string of at
4864least three consecutive colons. The fenced Div should be
4865separated by blank lines from preceding and following blocks.
4869 ::::: {#special .sidebar}
4870 Here is a paragraph.
4875Fenced divs can be nested. Opening fences are distinguished
4876because they *must* have attributes:
4882 This is a warning within a warning.
4886Fences without attributes are always closing fences. Unlike
4887with fenced code blocks, the number of colons in the closing
4888fence need not match the number in the opening fence. However,
4889it can be helpful for visual clarity to use fences of different
4890lengths to distinguish nested divs from their parents.
4893#### Extension: `bracketed_spans` ####
4895A bracketed sequence of inlines, as one would use to begin
4896a link, will be treated as a `Span` with attributes if it is
4897followed immediately by attributes:
4899 [This is *some text*]{.class key="val"}
4903#### Extension: `footnotes` ####
4905Pandoc's Markdown allows footnotes, using the following syntax:
4907 Here is a footnote reference,[^1] and another.[^longnote]
4909 [^1]: Here is the footnote.
4911 [^longnote]: Here's one with multiple blocks.
4913 Subsequent paragraphs are indented to show that they
4914 belong to the previous footnote.
4918 The whole paragraph can be indented, or just the first
4919 line. In this way, multi-paragraph footnotes work like
4920 multi-paragraph list items.
4922 This paragraph won't be part of the note, because it
4925The identifiers in footnote references may not contain spaces, tabs,
4926or newlines. These identifiers are used only to correlate the
4927footnote reference with the note itself; in the output, footnotes
4928will be numbered sequentially.
4930The footnotes themselves need not be placed at the end of the
4931document. They may appear anywhere except inside other block elements
4932(lists, block quotes, tables, etc.). Each footnote should be
4933separated from surrounding content (including other footnotes)
4936#### Extension: `inline_notes` ####
4938Inline footnotes are also allowed (though, unlike regular notes,
4939they cannot contain multiple paragraphs). The syntax is as follows:
4941 Here is an inline note.^[Inlines notes are easier to write, since
4942 you don't have to pick an identifier and move down to type the
4945Inline and regular footnotes may be mixed freely.
4949#### Extension: `citations` ####
4951Markdown citations go inside square brackets and are separated
4952by semicolons. Each citation must have a key, composed of '@' +
4953the citation identifier from the database, and may optionally
4954have a prefix, a locator, and a suffix. The citation key must
4955begin with a letter, digit, or `_`, and may contain
4956alphanumerics, `_`, and internal punctuation characters
4957(`:.#$%&-+?<>~/`). Here are some examples:
4959 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4961 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4963 Blah blah [@smith04; @doe99].
4965`pandoc` detects locator terms in the [CSL locale files].
4966Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4967locale, locator terms can be written in either singular or plural forms,
4968as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4969`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4970`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4971`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4972`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4973`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4974locator term is used, "page" is assumed.
4976`pandoc` will use heuristics to distinguish the locator
4977from the suffix. In complex cases, the locator can be enclosed
4980 [@smith{ii, A, D-Z}, with a suffix]
4981 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4983A minus sign (`-`) before the `@` will suppress mention of
4984the author in the citation. This can be useful when the
4985author is already mentioned in the text:
4987 Smith says blah [-@smith04].
4989You can also write an in-text citation, as follows:
4993 @smith04 [p. 33] says blah.
4996[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4997[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4998[Chicago Manual of Style]: https://chicagomanualofstyle.org
4999[Citation Style Language]: https://citationstyles.org
5000[Zotero Style Repository]: https://www.zotero.org/styles
5001[finding and editing styles]: https://citationstyles.org/authors/
5002[CSL locale files]: https://github.com/citation-style-language/locales
5004## Non-pandoc extensions
5006The following Markdown syntax extensions are not enabled by default
5007in pandoc, but may be enabled by adding `+EXTENSION` to the format
5008name, where `EXTENSION` is the name of the extension. Thus, for
5009example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5011#### Extension: `attributes` ####
5013Allows attributes to be attached to any inline or block-level
5014element. The syntax for the attributes is the same as that
5015used in [`header_attributes`][Extension: `header_attributes`].
5017- Attributes that occur immediately after an inline
5018 element affect that element. If they follow a space, then they
5019 belong to the space. (Hence, this option subsumes
5020 `inline_code_attributes` and `link_attributes`.)
5021- Attributes that occur immediately before a block
5022 element, on a line by themselves, affect that
5024- Consecutive attribute specifiers may be used,
5025 either for blocks or for inlines. Their attributes
5027- Attributes that occur at the end of the text of
5028 a Setext or ATX heading (separated by whitespace
5029 from the text) affect the heading element. (Hence, this
5030 option subsumes `header_attributes`.)
5031- Attributes that occur after the opening fence
5032 in a fenced code block affect the code block element. (Hence,
5033 this option subsumes `fenced_code_attributes`.)
5034- Attributes that occur at the end of a reference
5035 link definition affect links that refer to that
5038Note that pandoc's AST does not currently allow attributes
5039to be attached to arbitrary elements. Hence a Span or Div
5040container will be added if needed.
5042#### Extension: `old_dashes` ####
5044Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5045`-` before a numeral is an en-dash, and `--` is an em-dash.
5046This option only has an effect if `smart` is enabled. It is
5047selected automatically for `textile` input.
5049#### Extension: `angle_brackets_escapable` ####
5051Allow `<` and `>` to be backslash-escaped, as they can be in
5052GitHub flavored Markdown but not original Markdown. This is
5053implied by pandoc's default `all_symbols_escapable`.
5055#### Extension: `lists_without_preceding_blankline` ####
5057Allow a list to occur right after a paragraph, with no intervening
5060#### Extension: `four_space_rule` ####
5062Selects the pandoc <= 2.0 behavior for parsing lists, so that
5063four spaces indent are needed for list item continuation
5066#### Extension: `spaced_reference_links` ####
5068Allow whitespace between the two components of a reference link,
5073#### Extension: `hard_line_breaks` ####
5075Causes all newlines within a paragraph to be interpreted as hard line
5076breaks instead of spaces.
5078#### Extension: `ignore_line_breaks` ####
5080Causes newlines within a paragraph to be ignored, rather than being
5081treated as spaces or as hard line breaks. This option is intended for
5082use with East Asian languages where spaces are not used between words,
5083but text is divided into lines for readability.
5085#### Extension: `east_asian_line_breaks` ####
5087Causes newlines within a paragraph to be ignored, rather than
5088being treated as spaces or as hard line breaks, when they occur
5089between two East Asian wide characters. This is a better choice
5090than `ignore_line_breaks` for texts that include a mix of East
5091Asian wide characters and other characters.
5093#### Extension: `emoji` ####
5095Parses textual emojis like `:smile:` as Unicode emoticons.
5097#### Extension: `tex_math_single_backslash` ####
5099Causes anything between `\(` and `\)` to be interpreted as inline
5100TeX math, and anything between `\[` and `\]` to be interpreted
5101as display TeX math. Note: a drawback of this extension is that
5102it precludes escaping `(` and `[`.
5104#### Extension: `tex_math_double_backslash` ####
5106Causes anything between `\\(` and `\\)` to be interpreted as inline
5107TeX math, and anything between `\\[` and `\\]` to be interpreted
5110#### Extension: `markdown_attribute` ####
5112By default, pandoc interprets material inside block-level tags as Markdown.
5113This extension changes the behavior so that Markdown is only parsed
5114inside block-level tags if the tags have the attribute `markdown=1`.
5116#### Extension: `mmd_title_block` ####
5118Enables a [MultiMarkdown] style title block at the top of
5119the document, for example:
5123 Date: September 1, 2008
5124 Comment: This is a sample mmd title block, with
5125 a field spanning multiple lines.
5127See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5128`yaml_metadata_block` is enabled, it will take precedence over
5131#### Extension: `abbreviations` ####
5133Parses PHP Markdown Extra abbreviation keys, like
5135 *[HTML]: Hypertext Markup Language
5137Note that the pandoc document model does not support
5138abbreviations, so if this extension is enabled, abbreviation keys are
5139simply skipped (as opposed to being parsed as paragraphs).
5141#### Extension: `autolink_bare_uris` ####
5143Makes all absolute URIs into links, even when not surrounded by
5144pointy braces `<...>`.
5146#### Extension: `mmd_link_attributes` ####
5148Parses multimarkdown style key-value attributes on link
5149and image references. This extension should not be confused with the
5150[`link_attributes`](#extension-link_attributes) extension.
5152 This is a reference ![image][ref] with multimarkdown attributes.
5154 [ref]: https://path.to/image "Image title" width=20px height=30px
5155 id=myId class="myClass1 myClass2"
5157#### Extension: `mmd_header_identifiers` ####
5159Parses multimarkdown style heading identifiers (in square brackets,
5160after the heading but before any trailing `#`s in an ATX heading).
5162#### Extension: `compact_definition_lists` ####
5164Activates the definition list syntax of pandoc 1.12.x and earlier.
5165This syntax differs from the one described above under [Definition lists]
5168 - No blank line is required between consecutive items of the
5170 - To get a "tight" or "compact" list, omit space between consecutive
5171 items; the space between a term and its definition does not affect
5173 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5174 be indented four spaces.[^6]
5176[^6]: To see why laziness is incompatible with relaxing the requirement
5177 of a blank line between items, consider the following example:
5184 Is this a single list item with two definitions of "bar," the first of
5185 which is lazily wrapped, or two list items? To remove the ambiguity
5186 we must either disallow lazy wrapping or require a blank line between
5189#### Extension: `gutenberg` ####
5191Use [Project Gutenberg] conventions for `plain` output:
5192all-caps for strong emphasis, surround by underscores
5193for regular emphasis, add extra blank space around headings.
5195 [Project Gutenberg]: https://www.gutenberg.org
5197#### Extension: `sourcepos` ####
5199Include source position attributes when parsing `commonmark`.
5200For elements that accept attributes, a `data-pos` attribute
5201is added; other elements are placed in a surrounding
5202Div or Span elemnet with a `data-pos` attribute.
5206In addition to pandoc's extended Markdown, the following Markdown
5207variants are supported:
5209- `markdown_phpextra` (PHP Markdown Extra)
5210- `markdown_github` (deprecated GitHub-Flavored Markdown)
5211- `markdown_mmd` (MultiMarkdown)
5212- `markdown_strict` (Markdown.pl)
5213- `commonmark` (CommonMark)
5214- `gfm` (Github-Flavored Markdown)
5215- `commonmark_x` (CommonMark with many pandoc extensions)
5217To see which extensions are supported for a given format,
5218and which are enabled by default, you can use the command
5220 pandoc --list-extensions=FORMAT
5222where `FORMAT` is replaced with the name of the format.
5224Note that the list of extensions for `commonmark`,
5225`gfm`, and `commonmark_x` are defined relative to default
5226commonmark. So, for example, `backtick_code_blocks`
5227does not appear as an extension, since it is enabled by
5228default and cannot be disabled.
5232When the `--citeproc` option is used, pandoc can automatically generate
5233citations and a bibliography in a number of styles. Basic usage is
5235 pandoc --citeproc myinput.txt
5237To use this feature, you will need to have
5239- a document containing citations (see [Extension: `citations`]);
5240- a source of bibliographic data: either an external bibliography
5241 file or a list of `references` in the document's YAML metadata
5242- optionally, a [CSL] citation style.
5244## Specifying bibliographic data
5246You can specify an external bibliography using the
5247`bibliography` metadata field in a YAML metadata section or the
5248`--bibliography` command line argument. If you want to use
5249multiple bibliography files, you can supply multiple
5250`--bibliography` arguments or set `bibliography` metadata field
5251to YAML array. A bibliography may have any of these formats:
5253 Format File extension
5254 ------------ --------------
5260Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5261use the extension `.bibtex` to force interpretation as BibTeX.
5263In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5264inside fields such as `title`; in CSL YAML databases, pandoc
5265Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5274`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5283`<span class="nocase">...</span>`
5284: prevent a phrase from being capitalized as title case
5286As an alternative to specifying a bibliography file using
5287`--bibliography` or the YAML metadata field `bibliography`, you
5288can include the citation data directly in the `references` field
5289of the document's YAML metadata. The field should contain an
5290array of YAML-encoded references, for example:
5294 - type: article-journal
5306 title: 'Molecular structure of nucleic acids: a structure for
5307 deoxyribose nucleic acid'
5308 title-short: Molecular structure of nucleic acids
5309 container-title: Nature
5313 DOI: 10.1038/171737a0
5314 URL: https://www.nature.com/articles/171737a0
5318If both an external bibliography and inline (YAML metadata)
5319references are provided, both will be used. In case of
5320conflicting `id`s, the inline references will take precedence.
5322Note that `pandoc` can be used to produce such a YAML metadata
5323section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5325 pandoc chem.bib -s -f biblatex -t markdown
5326 pandoc chem.json -s -f csljson -t markdown
5328Indeed, `pandoc` can convert between any of these
5331 pandoc chem.bib -s -f biblatex -t csljson
5332 pandoc chem.yaml -s -f markdown -t biblatex
5334Running pandoc on a bibliography file with the `--citeproc`
5335option will create a formatted bibliography in the format
5338 pandoc chem.bib -s --citeproc -o chem.html
5339 pandoc chem.bib -s --citeproc -o chem.pdf
5341### Capitalization in titles
5343If you are using a bibtex or biblatex bibliography, then observe
5346 - English titles should be in title case. Non-English titles should
5347 be in sentence case, and the `langid` field in biblatex should be
5348 set to the relevant language. (The following values are treated
5349 as English: `american`, `british`, `canadian`, `english`,
5350 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5352 - As is standard with bibtex/biblatex, proper names should be
5353 protected with curly braces so that they won't be lowercased
5354 in styles that call for sentence case. For example:
5356 title = {My Dinner with {Andre}}
5358 - In addition, words that should remain lowercase (or camelCase)
5359 should be protected:
5361 title = {Spin Wave Dispersion on the {nm} Scale}
5363 Though this is not necessary in bibtex/biblatex, it is necessary
5364 with citeproc, which stores titles internally in sentence case,
5365 and converts to title case in styles that require it. Here we
5366 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5368If you are using a CSL bibliography (either JSON or YAML), then observe
5371 - All titles should be in sentence case.
5373 - Use the `language` field for non-English titles to prevent their
5374 conversion to title case in styles that call for this. (Conversion
5375 happens only if `language` begins with `en` or is left empty.)
5377 - Protect words that should not be converted to title case using
5380 Spin wave dispersion on the <span class="nocase">nm</span> scale
5382### Conference Papers, Published vs. Unpublished
5384For a formally published conference paper, use the biblatex entry type
5385`inproceedings` (which will be mapped to CSL `paper-conference`).
5387For an unpublished manuscript, use the biblatex entry type
5388`unpublished` without an `eventtitle` field (this entry type
5389will be mapped to CSL `manuscript`).
5391For a talk, an unpublished conference paper, or a poster
5392presentation, use the biblatex entry type `unpublished` with an
5393`eventtitle` field (this entry type will be mapped to CSL
5394`speech`). Use the biblatex `type` field to indicate the type,
5395e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5396too, though `eventdate` will not be rendered by most CSL styles.
5397Note that `venue` is for the event's venue, unlike `location`
5398which describes the publisher's location; do not use the latter
5399for an unpublished conference paper.
5402## Specifying a citation style
5404Citations and references can be formatted using any style supported by the
5405[Citation Style Language], listed in the [Zotero Style Repository].
5406These files are specified using the `--csl` option or the `csl`
5407(or `citation-style`) metadata field. By default, pandoc will
5408use the [Chicago Manual of Style] author-date format. (You can
5409override this default by copying a CSL style of your choice
5410to `default.csl` in your user data directory.)
5411The CSL project provides further information on [finding and
5414The `--citation-abbreviations` option (or the
5415`citation-abbreviations` metadata field) may be used to specify
5416a JSON file containing abbreviations of journals that should be
5417used in formatted bibliographies when `form="short"` is
5418specified. The format of the file can be illustrated with an
5423 "container-title": {
5424 "Lloyd's Law Reports": "Lloyd's Rep",
5425 "Estates Gazette": "EG",
5426 "Scots Law Times": "SLT"
5432## Citations in note styles
5434Pandoc's citation processing is designed to allow you to
5435move between author-date, numerical, and note styles without
5436modifying the markdown source. When you're using a note
5437style, avoid inserting footnotes manually. Instead, insert
5438citations just as you would in an author-date style---for
5441 Blah blah [@foo, p. 33].
5443The footnote will be created automatically. Pandoc will take
5444care of removing the space and moving the note before or
5445after the period, depending on the setting of
5446`notes-after-punctuation`, as described below in [Other relevant
5449In some cases you may need to put a citation inside a regular
5450footnote. Normal citations in footnotes (such as `[@foo, p.
545133]`) will be rendered in parentheses. In-text citations (such
5452as `@foo [p. 33]`) will be rendered without parentheses. (A
5453comma will be added if appropriate.) Thus:
5455 [^1]: Some studies [@foo; @bar, p. 33] show that
5456 frubulicious zoosnaps are quantical. For a survey
5457 of the literature, see @baz [chap. 1].
5459## Raw content in a style
5461To include raw content in a prefix, suffix, delimiter, or term,
5462surround it with these tags indicating the format:
5464 {{jats}}<ref>{{/jats}}
5466Without the tags, the string will be interpreted as a string
5467and escaped in the output, rather than being passed through raw.
5469This feature allows stylesheets to be customized to give
5470different output for different output formats. However,
5471stylesheets customized in this way will not be usable
5472by other CSL implementations.
5476## Placement of the bibliography
5478If the style calls for a list of works cited, it will be placed
5479in a div with id `refs`, if one exists:
5484Otherwise, it will be placed at the end of the document.
5485Generation of the bibliography can be suppressed by setting
5486`suppress-bibliography: true` in the YAML metadata.
5488If you wish the bibliography to have a section heading, you can
5489set `reference-section-title` in the metadata, or put the heading
5490at the beginning of the div with id `refs` (if you are using it)
5491or at the end of your document:
5497The bibliography will be inserted after this heading. Note that
5498the `unnumbered` class will be added to this heading, so that the
5499section will not be numbered.
5501## Including uncited items in the bibliography
5503If you want to include items in the bibliography without actually
5504citing them in the body text, you can define a dummy `nocite` metadata
5505field and put the citations there:
5514In this example, the document will contain a citation for `item3`
5515only, but the bibliography will contain entries for `item1`, `item2`, and
5518It is possible to create a bibliography with all the citations,
5519whether or not they appear in the document, by using a wildcard:
5526For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5527render the bibliography. In order to do so, specify bibliography
5528files as outlined above, and add `--natbib` or `--biblatex`
5529argument to `pandoc` invocation. Bear in mind that bibliography
5530files have to be in either BibTeX (for `--natbib`)
5531or BibLaTeX (for `--biblatex`) format.
5533## Other relevant metadata fields
5535A few other metadata fields affect bibliography formatting:
5538: If true, citations will be
5539 hyperlinked to the corresponding bibliography entries
5540 (for author-date and numerical styles only).
5543: The `lang` field will affect how the style is localized,
5544 for example in the translation of labels and the use
5545 of quotation marks. (For backwards compatibility,
5546 `locale` may be used instead of `lang`, but this use
5549`notes-after-punctuation`
5550: If true (the default), pandoc will put footnote citations
5551 after following punctuation. For example, if the source
5552 contains `blah blah [@jones99].`, the result will look like
5553 `blah blah.[^1]`, with the note moved after the period and
5554 the space collapsed. If false, the space will still be
5555 collapsed, but the footnote will not be moved after the
5567You can use pandoc to produce an HTML + JavaScript slide presentation
5568that can be viewed via a web browser. There are five ways to do this,
5569using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5570You can also produce a PDF slide show using LaTeX [`beamer`], or
5571slides shows in Microsoft [PowerPoint] format.
5573Here's the Markdown source for a simple slide show, `habits.txt`:
5600 
5607To produce an HTML/JavaScript slide show, simply type
5609 pandoc -t FORMAT -s habits.txt -o habits.html
5611where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5613For Slidy, Slideous, reveal.js, and S5, the file produced by
5614pandoc with the `-s/--standalone` option embeds a link to
5615JavaScript and CSS files, which are assumed to be available at
5616the relative path `s5/default` (for S5), `slideous` (for
5617Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5618at `w3.org` (for Slidy). (These paths can be changed by setting
5619the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5620variables; see [Variables for HTML slides], above.) For
5621DZSlides, the (relatively short) JavaScript and CSS are included
5622in the file by default.
5624With all HTML slide formats, the `--self-contained` option can
5625be used to produce a single file that contains all of the data
5626necessary to display the slide show, including linked scripts,
5627stylesheets, images, and videos.
5629To produce a PDF slide show using beamer, type
5631 pandoc -t beamer habits.txt -o habits.pdf
5633Note that a reveal.js slide show can also be converted to a PDF
5634by printing it to a file from the browser.
5636To produce a Powerpoint slide show, type
5638 pandoc habits.txt -o habits.pptx
5640## Structuring the slide show
5642By default, the *slide level* is the highest heading level in
5643the hierarchy that is followed immediately by content, and not another
5644heading, somewhere in the document. In the example above, level-1 headings
5645are always followed by level-2 headings, which are followed by content,
5646so the slide level is 2. This default can be overridden using
5647the `--slide-level` option.
5649The document is carved up into slides according to the following
5652 * A horizontal rule always starts a new slide.
5654 * A heading at the slide level always starts a new slide.
5656 * Headings *below* the slide level in the hierarchy create
5657 headings *within* a slide.
5659 * Headings *above* the slide level in the hierarchy create
5660 "title slides," which just contain the section title
5661 and help to break the slide show into sections.
5662 Non-slide content under these headings will be included
5663 on the title slide (for HTML slide shows) or in a
5664 subsequent slide with the same title (for beamer).
5666 * A title page is constructed automatically from the document's title
5667 block, if present. (In the case of beamer, this can be disabled
5668 by commenting out some lines in the default template.)
5670These rules are designed to support many different styles of slide show. If
5671you don't care about structuring your slides into sections and subsections,
5672you can just use level-1 headings for all each slide. (In that case, level-1
5673will be the slide level.) But you can also structure the slide show into
5674sections, as in the example above.
5676Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5677layout will be produced, with level-1 headings building horizontally
5678and level-2 headings building vertically. It is not recommended that
5679you use deeper nesting of section levels with reveal.js.
5683By default, these writers produce lists that display "all at once."
5684If you want your lists to display incrementally (one item at a time),
5685use the `-i` option. If you want a particular list to depart from the
5686default, put it in a `div` block with class `incremental` or
5687`nonincremental`. So, for example, using the `fenced div` syntax, the
5688following would be incremental regardless of the document default:
5706While using `incremental` and `nonincremental` divs are the
5707recommended method of setting incremental lists on a per-case basis,
5708an older method is also supported: putting lists inside a blockquote
5709will depart from the document default (that is, it will display
5710incrementally without the `-i` option and all at once with the `-i`
5716Both methods allow incremental and nonincremental lists to be mixed
5717in a single document.
5719Note: Neither the `-i/--incremental` option nor any of the
5720methods described here currently works for PowerPoint output.
5724You can add "pauses" within a slide by including a paragraph containing
5725three dots, separated by spaces:
5727 # Slide with a pause
5729 content before the pause
5733 content after the pause
5735Note: this feature is not yet implemented for PowerPoint output.
5737## Styling the slides
5739You can change the style of HTML slides by putting customized CSS files
5740in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5741or `$DATADIR/slideous` (for Slideous),
5742where `$DATADIR` is the user data directory (see `--data-dir`, above).
5743The originals may be found in pandoc's system data directory (generally
5744`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5745files it does not find in the user data directory.
5747For dzslides, the CSS is included in the HTML file itself, and may
5750All [reveal.js configuration options] can be set through variables.
5751For example, themes can be used by setting the `theme` variable:
5755Or you can specify a custom stylesheet using the `--css` option.
5757To style beamer slides, you can specify a `theme`, `colortheme`,
5758`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5760 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5762Note that heading attributes will turn into slide attributes
5763(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5764to style individual slides. In beamer, the only heading attribute
5765that affects slides is the `allowframebreaks` class, which sets the
5766`allowframebreaks` option, causing multiple slides to be created
5767if the content overfills the frame. This is recommended especially for
5770 # References {.allowframebreaks}
5774Speaker notes are supported in reveal.js and PowerPoint (pptx)
5775output. You can add notes to your Markdown document thus:
5781 - It can contain Markdown
5786To show the notes window in reveal.js, press `s` while viewing the
5787presentation. Speaker notes in PowerPoint will be available, as usual,
5788in handouts and presenter view.
5790Notes are not yet supported for other slide formats, but the notes
5791will not appear on the slides themselves.
5795To put material in side by side columns, you can use a native
5796div container with class `columns`, containing two or more div
5797containers with class `column` and a `width` attribute:
5799 :::::::::::::: {.columns}
5800 ::: {.column width="40%"}
5803 ::: {.column width="60%"}
5808### Additional columns attributes in beamer
5810The div containers with classes `columns` and `column` can optionally have
5811an `align` attribute.
5812The class `columns` can optionally have a `totalwidth` attribute or an
5813`onlytextwidth` class.
5815 :::::::::::::: {.columns align=center totalwidth=8em}
5816 ::: {.column width="40%"}
5819 ::: {.column width="60%" align=bottom}
5824The `align` attributes on `columns` and `column` can be used with the
5825values `top`, `top-baseline`, `center` and `bottom` to vertically align
5826the columns. It defaults to `top` in `columns`.
5828The `totalwidth` attribute limits the width of the columns to the given value.
5830 :::::::::::::: {.columns align=top .onlytextwidth}
5831 ::: {.column width="40%" align=center}
5834 ::: {.column width="60%"}
5839The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5841See Section 12.7 of the [Beamer User's Guide] for more details.
5843## Frame attributes in beamer
5845Sometimes it is necessary to add the LaTeX `[fragile]` option to
5846a frame in beamer (for example, when using the `minted` environment).
5847This can be forced by adding the `fragile` class to the heading
5848introducing the slide:
5850 # Fragile slide {.fragile}
5852All of the other frame attributes described in Section 8.1 of
5853the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5854`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5855`shrink`, `standout`, `noframenumbering`.
5857## Background in reveal.js and beamer
5859Background images can be added to self-contained reveal.js slideshows and
5860to beamer slideshows.
5862For the same image on every slide, use the configuration
5863option `background-image` either in the YAML metadata block
5864or as a command-line variable. (There are no other options in
5865beamer and the rest of this section concerns reveal.js slideshows.)
5867For reveal.js, you can instead use the reveal.js-native option
5868`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5869and `parallaxBackgroundVertical` the same way and must also set
5870`parallaxBackgroundSize` to have your values take effect.
5872To set an image for a particular reveal.js slide, add
5873`{data-background-image="/path/to/image"}`
5874to the first slide-level heading on the slide (which may even be empty).
5876In reveal.js's overview mode, the parallaxBackgroundImage will show up
5877only on the first slide.
5879Other reveal.js background settings also work on individual slides, including
5880`data-background-size`, `data-background-repeat`, `data-background-color`,
5881`data-transition`, and `data-transition-speed`.
5883To add a background image to the automatically generated title slide, use the
5884`title-slide-attributes` variable in the YAML metadata block. It must contain
5885a map of attribute names and values.
5887See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5890For example in reveal.js:
5895parallaxBackgroundImage: /path/to/my/background_image.png
5896title-slide-attributes:
5897 data-background-image: /path/to/title_image.png
5898 data-background-size: contain
5903Slide 1 has background_image.png as its background.
5905## {data-background-image="/path/to/special_image.jpg"}
5907Slide 2 has a special image for its background, even though the heading has no content.
5914EPUB metadata may be specified using the `--epub-metadata` option, but
5915if the source document is Markdown, it is better to use a [YAML metadata
5916block][Extension: `yaml_metadata_block`]. Here is an example:
5923 text: An investigation of metadata
5931 text: doi:10.234234.234/33
5933 rights: © 2007 John Smith, CC BY-NC
5938The following fields are recognized:
5941 ~ Either a string value or an object with fields `text` and
5942 `scheme`. Valid values for `scheme` are `ISBN-10`,
5943 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5944 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5945 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5948 ~ Either a string value, or an object with fields `file-as` and
5949 `type`, or a list of such objects. Valid values for `type` are
5950 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5953 ~ Either a string value, or an object with fields `role`, `file-as`,
5954 and `text`, or a list of such objects. Valid values for `role` are
5955 [MARC relators], but
5956 pandoc will attempt to translate the human-readable versions
5957 (like "author" and "editor") to the appropriate marc relators.
5960 ~ Same format as `creator`.
5963 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5964 Pandoc will attempt to convert other common date formats.
5966`lang` (or legacy: `language`)
5967 ~ A string value in [BCP 47] format. Pandoc will default to the local
5968 language if nothing is specified.
5971 ~ A string value or a list of such values.
5991`belongs-to-collection`
5992 ~ A string value. identifies the name of a collection to which
5993 the EPUB Publication belongs.
5996 ~ The `group-position` field indicates the numeric position in which
5997 the EPUB Publication belongs relative to other works belonging to
5998 the same `belongs-to-collection` field.
6001 ~ A string value (path to cover image).
6003`css` (or legacy: `stylesheet`)
6004 ~ A string value (path to CSS stylesheet).
6006`page-progression-direction`
6007 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
6008 attribute for the [`spine` element].
6011 ~ iBooks-specific metadata, with the following fields:
6013 - `version`: (string)
6014 - `specified-fonts`: `true`|`false` (default `false`)
6015 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
6016 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
6017 - `binding`: `true`|`false` (default `true`)
6018 - `scroll-axis`: `vertical`|`horizontal`|`default`
6020[MARC relators]: https://loc.gov/marc/relators/relaterm.html
6021[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
6023## The `epub:type` attribute
6025For `epub3` output, you can mark up the heading that corresponds to an EPUB
6026chapter using the [`epub:type` attribute][epub-type]. For example, to set
6027the attribute to the value `prologue`, use this markdown:
6029 # My chapter {epub:type=prologue}
6031Which will result in:
6033 <body epub:type="frontmatter">
6034 <section epub:type="prologue">
6037Pandoc will output `<body epub:type="bodymatter">`, unless
6038you use one of the following values, in which case either
6039`frontmatter` or `backmatter` will be output.
6041`epub:type` of first section `epub:type` of body
6042---------------------------- ------------------
6045acknowledgments frontmatter
6046copyright-page frontmatter
6047dedication frontmatter
6051contributors frontmatter
6052other-credits frontmatter
6054revision-history frontmatter
6055titlepage frontmatter
6056halftitlepage frontmatter
6057seriespage frontmatter
6062bibliography backmatter
6065[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6069By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6070`<video>` or `<source>` element present in the generated EPUB,
6071and include it in the EPUB container, yielding a completely
6072self-contained EPUB. If you want to link to external media resources
6073instead, use raw HTML in your source and add `data-external="1"` to the tag
6074with the `src` attribute. For example:
6076 <audio controls="1">
6077 <source src="https://example.com/music/toccata.mp3"
6078 data-external="1" type="audio/mpeg">
6084When creating a [Jupyter notebook], pandoc will try to infer the
6085notebook structure. Code blocks with the class `code` will be
6086taken as code cells, and intervening content will be taken as
6087Markdown cells. Attachments will automatically be created for
6088images in Markdown cells. Metadata will be taken from the
6089`jupyter` metadata field. For example:
6098 display_name: Python 2
6105 file_extension: ".py"
6106 mimetype: "text/x-python"
6108 nbconvert_exporter: "python"
6109 pygments_lexer: "ipython2"
6115**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6116bibendum felis dictum sodales.
6125from IPython.display import HTML
6128console.log("hello");
6136This image  will be
6137included as a cell attachment.
6140If you want to add cell attributes, group cells differently, or
6141add output to code cells, then you need to include divs to
6142indicate the structure. You can use either [fenced
6143divs][Extension: `fenced_divs`] or [native divs][Extension:
6144`native_divs`] for this. Here is an example:
6147:::::: {.cell .markdown}
6150**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6151bibendum felis dictum sodales.
6154:::::: {.cell .code execution_count=1}
6159::: {.output .stream .stdout}
6166:::::: {.cell .code execution_count=2}
6168from IPython.display import HTML
6171console.log("hello");
6177::: {.output .execute_result execution_count=2}
6180console.log("hello");
6189If you include raw HTML or TeX in an output cell, use the
6190[raw attribute][Extension: `fenced_attribute`], as shown
6191in the last cell of the example above. Although pandoc can
6192process "bare" raw HTML and TeX, the result is often
6193interspersed raw elements and normal textual elements, and
6194in an output cell pandoc expects a single, connected raw
6195block. To avoid using raw HTML or TeX except when
6196marked explicitly using raw attributes, we recommend
6197specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6198translating between Markdown and ipynb notebooks.
6200Note that options and extensions that affect reading and
6201writing of Markdown will also affect Markdown cells in ipynb
6202notebooks. For example, `--wrap=preserve` will preserve
6203soft line breaks in Markdown cells; `--atx-headers` will
6204cause ATX-style headings to be used; and `--preserve-tabs` will
6205prevent tabs from being turned to spaces.
6207# Syntax highlighting
6209Pandoc will automatically highlight syntax in [fenced code blocks] that
6210are marked with a language name. The Haskell library [skylighting] is
6211used for highlighting. Currently highlighting is supported only for
6212HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6213that pandoc will recognize, type `pandoc --list-highlight-languages`.
6215The color scheme can be selected using the `--highlight-style` option.
6216The default color scheme is `pygments`, which imitates the default color
6217scheme used by the Python library pygments (though pygments is not actually
6218used to do the highlighting). To see a list of highlight styles,
6219type `pandoc --list-highlight-styles`.
6221If you are not satisfied with the predefined styles, you can
6222use `--print-highlight-style` to generate a JSON `.theme` file which
6223can be modified and used as the argument to `--highlight-style`. To
6224get a JSON version of the `pygments` style, for example:
6226 pandoc --print-highlight-style pygments > my.theme
6228Then edit `my.theme` and use it like this:
6230 pandoc --highlight-style my.theme
6232If you are not satisfied with the built-in highlighting, or you
6233want highlight a language that isn't supported, you can use the
6234`--syntax-definition` option to load a [KDE-style XML syntax definition
6235file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6236Before writing your own, have a look at KDE's [repository of syntax
6237definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6239To disable highlighting, use the `--no-highlight` option.
6241[skylighting]: https://github.com/jgm/skylighting
6245Custom styles can be used in the docx and ICML formats.
6249By default, pandoc's docx and ICML output applies a predefined set of styles
6250for blocks such as paragraphs and block quotes, and uses largely default
6251formatting (italics, bold) for inlines. This will work for most
6252purposes, especially alongside a `reference.docx` file. However, if you
6253need to apply your own styles to blocks, or match a preexisting set of
6254styles, pandoc allows you to define custom styles for blocks and text
6255using `div`s and `span`s, respectively.
6257If you define a `div` or `span` with the attribute `custom-style`,
6258pandoc will apply your specified style to the contained elements (with
6259the exception of elements whose function depends on a style, like
6260headings, code blocks, block quotes, or links). So, for example, using
6261the `bracketed_spans` syntax,
6263 [Get out]{custom-style="Emphatically"}, he said.
6265would produce a docx file with "Get out" styled with character
6266style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6268 Dickinson starts the poem simply:
6270 ::: {custom-style="Poetry"}
6271 | A Bird came down the Walk---
6272 | He did not know I saw---
6275would style the two contained lines with the `Poetry` paragraph style.
6277For docx output, styles will be defined in the output file as inheriting
6278from normal text, if the styles are not yet in your reference.docx.
6279If they are already defined, pandoc will not alter the definition.
6281This feature allows for greatest customization in conjunction with
6282[pandoc filters]. If you want all paragraphs after block quotes to be
6283indented, you can write a filter to apply the styles necessary. If you
6284want all italics to be transformed to the `Emphasis` character style
6285(perhaps to change their color), you can write a filter which will
6286transform all italicized inlines to inlines within an `Emphasis`
6289For docx output, you don't need to enable any extensions for
6290custom styles to work.
6292[pandoc filters]: https://pandoc.org/filters.html
6296The docx reader, by default, only reads those styles that it can
6297convert into pandoc elements, either by direct conversion or
6298interpreting the derivation of the input document's styles.
6300By enabling the [`styles` extension](#ext-styles) in the docx reader
6301(`-f docx+styles`), you can produce output that maintains the styles
6302of the input document, using the `custom-style` class. Paragraph
6303styles are interpreted as divs, while character styles are interpreted
6306For example, using the `custom-style-reference.docx` file in the test
6307directory, we have the following different outputs:
6309Without the `+styles` extension:
6311 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6314 This is text with an *emphasized* text style. And this is text with a
6315 **strengthened** text style.
6317 > Here is a styled paragraph that inherits from Block Text.
6319And with the extension:
6321 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6323 ::: {custom-style="First Paragraph"}
6327 ::: {custom-style="Body Text"}
6328 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6329 And this is text with a [strengthened]{custom-style="Strengthened"}
6333 ::: {custom-style="My Block Style"}
6334 > Here is a styled paragraph that inherits from Block Text.
6337With these custom styles, you can use your input document as a
6338reference-doc while creating docx output (see below), and maintain the
6339same styles in your input and output files.
6343Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6344includes a Lua interpreter, so Lua need not be installed separately.)
6346To use a custom writer, simply specify the path to the Lua script
6347in place of the output format. For example:
6349 pandoc -t data/sample.lua
6351Creating a custom writer requires writing a Lua function for each
6352possible element in a pandoc document. To get a documented example
6353which you can modify according to your needs, do
6355 pandoc --print-default-data-file sample.lua
6357Note that custom writers have no default template. If you want
6358to use `--standalone` with a custom writer, you will need to
6359specify a template manually using `--template` or add a new
6360default template with the name
6361`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6362subdirectory of your user data directory (see [Templates]).
6364[Lua]: https://www.lua.org
6366# Reproducible builds
6368Some of the document formats pandoc targets (such as EPUB,
6369docx, and ODT) include build timestamps in the generated document.
6370That means that the files generated on successive builds will
6371differ, even if the source does not. To avoid this, set the
6372`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6373be taken from it instead of the current time.
6374`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6375(specifying the number of second since midnight UTC January 1, 1970).
6377Some document formats also include a unique identifier. For
6378EPUB, this can be set explicitly by setting the `identifier`
6379metadata field (see [EPUB Metadata], above).
6383If you use pandoc to convert user-contributed content in a web
6384application, here are some things to keep in mind:
63861. Although pandoc itself will not create or modify any files other
6387 than those you explicitly ask it create (with the exception
6388 of temporary files used in producing PDFs), a filter or custom
6389 writer could in principle do anything on your file system. Please
6390 audit filters and custom writers very carefully before using them.
63922. If your application uses pandoc as a Haskell library (rather than
6393 shelling out to the executable), it is possible to use it in a mode
6394 that fully isolates pandoc from your file system, by running the
6395 pandoc operations in the `PandocPure` monad. See the document
6396 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
63993. Pandoc's parsers can exhibit pathological performance on some
6400 corner cases. It is wise to put any pandoc operations under
6401 a timeout, to avoid DOS attacks that exploit these issues.
6402 If you are using the pandoc executable, you can add the
6403 command line options `+RTS -M512M -RTS` (for example) to limit
6404 the heap size to 512MB.
64064. The HTML generated by pandoc is not guaranteed to be safe.
6407 If `raw_html` is enabled for the Markdown input, users can
6408 inject arbitrary HTML. Even if `raw_html` is disabled,
6409 users can include dangerous content in attributes for
6410 headings, spans, and code blocks. To be safe, you should
6411 run all the generated HTML through an HTML sanitizer.
6415Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
6416under the [GPL], version 2 or greater. This software carries no
6417warranty of any kind. (See COPYRIGHT for full copyright and
6418warranty notices.) For a full list of contributors, see the file
6419AUTHORS.md in the pandoc source code.
6421[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6422[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list