2.\" Automatically generated by Pandoc 2.11
4.TH "Pandoc User\[cq]s Guide" "" "July 23, 2020" "pandoc 2.11" ""
7pandoc - general markup converter
10\f[C]pandoc\f[R] [\f[I]options\f[R]] [\f[I]input-file\f[R]]\&...
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, LaTeX
19For the full lists of input and output formats, see the \f[C]--from\f[R]
20and \f[C]--to\f[R] options below.
21Pandoc can also produce PDF output: see creating a PDF, below.
23Pandoc\[cq]s enhanced version of Markdown includes syntax for tables,
24definition lists, metadata blocks, footnotes, citations, math, and much
26See below under Pandoc\[cq]s Markdown.
28Pandoc has a modular design: it consists of a set of readers, which
29parse text in a given format and produce a native representation of the
30document (an \f[I]abstract syntax tree\f[R] or AST), and a set of
31writers, which convert this native representation into a target format.
32Thus, adding an input or output format requires only adding a reader or
34Users can also run custom pandoc filters to modify the intermediate AST.
36Because pandoc\[cq]s intermediate representation of a document is less
37expressive than many of the formats it converts between, one should not
38expect perfect conversions between every format and every other.
39Pandoc attempts to preserve the structural elements of a document, but
40not formatting details such as margin size.
41And some document elements, such as complex tables, may not fit into
42pandoc\[cq]s simple document model.
43While conversions from pandoc\[cq]s Markdown to all formats aspire to be
44perfect, conversions from formats more expressive than pandoc\[cq]s
45Markdown can be expected to be lossy.
48If no \f[I]input-files\f[R] are specified, input is read from
50Output goes to \f[I]stdout\f[R] by default.
51For output to a file, use the \f[C]-o\f[R] option:
55pandoc -o output.html input.txt
59By default, pandoc produces a document fragment.
60To produce a standalone document (e.g.\ a valid HTML file including
61\f[C]<head>\f[R] and \f[C]<body>\f[R]), use the \f[C]-s\f[R] or
62\f[C]--standalone\f[R] flag:
66pandoc -s -o output.html input.txt
70For more information on how standalone documents are produced, see
73If multiple input files are given, \f[C]pandoc\f[R] will concatenate
74them all (with blank lines between them) before parsing.
75(Use \f[C]--file-scope\f[R] to parse files individually.)
78The format of the input and output can be specified explicitly using
80The input format can be specified using the \f[C]-f/--from\f[R] option,
81the output format using the \f[C]-t/--to\f[R] option.
82Thus, to convert \f[C]hello.txt\f[R] from Markdown to LaTeX, you could
87pandoc -f markdown -t latex hello.txt
91To convert \f[C]hello.html\f[R] from HTML to Markdown:
95pandoc -f html -t markdown hello.html
99Supported input and output formats are listed below under Options (see
100\f[C]-f\f[R] for input formats and \f[C]-t\f[R] for output formats).
101You can also use \f[C]pandoc --list-input-formats\f[R] and
102\f[C]pandoc --list-output-formats\f[R] to print lists of supported
105If the input or output format is not specified explicitly,
106\f[C]pandoc\f[R] will attempt to guess it from the extensions of the
112pandoc -o hello.tex hello.txt
116will convert \f[C]hello.txt\f[R] from Markdown to LaTeX.
117If no output file is specified (so that output goes to
118\f[I]stdout\f[R]), or if the output file\[cq]s extension is unknown, the
119output format will default to HTML.
120If no input file is specified (so that input comes from
121\f[I]stdin\f[R]), or if the input files\[cq] extensions are unknown, the
122input format will be assumed to be Markdown.
123.SS Character encoding
125Pandoc uses the UTF-8 character encoding for both input and output.
126If your local character encoding is not UTF-8, you should pipe input and
127output through \f[C]iconv\f[R]:
131iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
135Note that in some output formats (such as HTML, LaTeX, ConTeXt, RTF,
136OPML, DocBook, and Texinfo), information about the character encoding is
137included in the document header, which will only be included if you use
138the \f[C]-s/--standalone\f[R] option.
141To produce a PDF, specify an output file with a \f[C].pdf\f[R]
146pandoc test.txt -o test.pdf
150By default, pandoc will use LaTeX to create the PDF, which requires that
151a LaTeX engine be installed (see \f[C]--pdf-engine\f[R] below).
152Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
154To do this, specify an output file with a \f[C].pdf\f[R] extension, as
155before, but add the \f[C]--pdf-engine\f[R] option or
156\f[C]-t context\f[R], \f[C]-t html\f[R], or \f[C]-t ms\f[R] to the
158The tool used to generate the PDF from the intermediate format may be
159specified using \f[C]--pdf-engine\f[R].
161You can control the PDF style using variables, depending on the
162intermediate format used: see variables for LaTeX, variables for
163ConTeXt, variables for \f[C]wkhtmltopdf\f[R], variables for ms.
164When HTML is used as an intermediate format, the output can be styled
165using \f[C]--css\f[R].
167To debug the PDF creation, it can be useful to look at the intermediate
168representation: instead of \f[C]-o test.pdf\f[R], use for example
169\f[C]-s -o test.tex\f[R] to output the generated LaTeX.
170You can then test it with \f[C]pdflatex test.tex\f[R].
172When using LaTeX, the following packages need to be available (they are
173included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
174\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
175\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the
176\f[C]--listings\f[R] option is used), \f[C]fancyvrb\f[R],
177\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] (if the
178document contains images), \f[C]hyperref\f[R], \f[C]xcolor\f[R],
179\f[C]ulem\f[R], \f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable
180set), \f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and
181\f[C]babel\f[R] (with \f[C]lang\f[R]).
182The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
183requires \f[C]fontspec\f[R].
184\f[C]lualatex\f[R] uses \f[C]selnolig\f[R].
185\f[C]xelatex\f[R] uses \f[C]polyglossia\f[R] (with \f[C]lang\f[R]),
186\f[C]xecjk\f[R], and \f[C]bidi\f[R] (with the \f[C]dir\f[R] variable
188If the \f[C]mathspec\f[R] variable is set, \f[C]xelatex\f[R] will use
189\f[C]mathspec\f[R] instead of \f[C]unicode-math\f[R].
190The \f[C]upquote\f[R] and \f[C]microtype\f[R] packages are used if
191available, and \f[C]csquotes\f[R] will be used for typography if the
192\f[C]csquotes\f[R] variable or metadata field is set to a true value.
193The \f[C]natbib\f[R], \f[C]biblatex\f[R], \f[C]bibtex\f[R], and
194\f[C]biber\f[R] packages can optionally be used for citation rendering.
195The following packages will be used to improve output quality if
196present, but pandoc does not require them to be present:
197\f[C]upquote\f[R] (for straight quotes in verbatim environments),
198\f[C]microtype\f[R] (for better spacing adjustments), \f[C]parskip\f[R]
199(for better inter-paragraph spaces), \f[C]xurl\f[R] (for better line
200breaks in URLs), \f[C]bookmark\f[R] (for better PDF bookmarks), and
201\f[C]footnotehyper\f[R] or \f[C]footnote\f[R] (to allow footnotes in
203.SS Reading from the Web
205Instead of an input file, an absolute URI may be given.
206In this case pandoc will fetch the content using HTTP:
210pandoc -f html -t markdown https://www.fsf.org
214It is possible to supply a custom User-Agent string or other header when
215requesting a document from a URL:
219pandoc -f html -t markdown --request-header User-Agent:\[dq]Mozilla/5.0\[dq] \[rs]
226\f[B]\f[CB]-f\f[B]\f[R] \f[I]FORMAT\f[R], \f[B]\f[CB]-r\f[B]\f[R] \f[I]FORMAT\f[R], \f[B]\f[CB]--from=\f[B]\f[R]\f[I]FORMAT\f[R], \f[B]\f[CB]--read=\f[B]\f[R]\f[I]FORMAT\f[R]
228\f[I]FORMAT\f[R] can be:
231\f[C]bibtex\f[R] (BibTeX bibliography)
233\f[C]biblatex\f[R] (BibLaTeX bibliography)
235\f[C]commonmark\f[R] (CommonMark Markdown)
237\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
239\f[C]creole\f[R] (Creole 1.0)
241\f[C]csljson\f[R] (CSL JSON bibliography)
243\f[C]csv\f[R] (CSV table)
245\f[C]docbook\f[R] (DocBook)
247\f[C]docx\f[R] (Word docx)
249\f[C]dokuwiki\f[R] (DokuWiki markup)
253\f[C]fb2\f[R] (FictionBook2 e-book)
255\f[C]gfm\f[R] (GitHub-Flavored Markdown), or the deprecated and less
256accurate \f[C]markdown_github\f[R]; use \f[C]markdown_github\f[R] only
257if you need extensions not supported in \f[C]gfm\f[R].
259\f[C]haddock\f[R] (Haddock markup)
263\f[C]ipynb\f[R] (Jupyter notebook)
265\f[C]jats\f[R] (JATS XML)
267\f[C]jira\f[R] (Jira/Confluence wiki markup)
269\f[C]json\f[R] (JSON version of native AST)
271\f[C]latex\f[R] (LaTeX)
273\f[C]markdown\f[R] (Pandoc\[cq]s Markdown)
275\f[C]markdown_mmd\f[R] (MultiMarkdown)
277\f[C]markdown_phpextra\f[R] (PHP Markdown Extra)
279\f[C]markdown_strict\f[R] (original unextended Markdown)
281\f[C]mediawiki\f[R] (MediaWiki markup)
283\f[C]man\f[R] (roff man)
287\f[C]native\f[R] (native Haskell)
293\f[C]org\f[R] (Emacs Org mode)
295\f[C]rst\f[R] (reStructuredText)
297\f[C]t2t\f[R] (txt2tags)
299\f[C]textile\f[R] (Textile)
301\f[C]tikiwiki\f[R] (TikiWiki markup)
303\f[C]twiki\f[R] (TWiki markup)
305\f[C]vimwiki\f[R] (Vimwiki)
307Extensions can be individually enabled or disabled by appending
308\f[C]+EXTENSION\f[R] or \f[C]-EXTENSION\f[R] to the format name.
309See Extensions below, for a list of extensions and their names.
310See \f[C]--list-input-formats\f[R] and \f[C]--list-extensions\f[R],
314\f[B]\f[CB]-t\f[B]\f[R] \f[I]FORMAT\f[R], \f[B]\f[CB]-w\f[B]\f[R] \f[I]FORMAT\f[R], \f[B]\f[CB]--to=\f[B]\f[R]\f[I]FORMAT\f[R], \f[B]\f[CB]--write=\f[B]\f[R]\f[I]FORMAT\f[R]
315Specify output format.
316\f[I]FORMAT\f[R] can be:
319\f[C]asciidoc\f[R] (AsciiDoc) or \f[C]asciidoctor\f[R] (AsciiDoctor)
321\f[C]beamer\f[R] (LaTeX beamer slide show)
323\f[C]commonmark\f[R] (CommonMark Markdown)
325\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
327\f[C]context\f[R] (ConTeXt)
329\f[C]csljson\f[R] (CSL JSON bibliography)
331\f[C]docbook\f[R] or \f[C]docbook4\f[R] (DocBook 4)
333\f[C]docbook5\f[R] (DocBook 5)
335\f[C]docx\f[R] (Word docx)
337\f[C]dokuwiki\f[R] (DokuWiki markup)
339\f[C]epub\f[R] or \f[C]epub3\f[R] (EPUB v3 book)
341\f[C]epub2\f[R] (EPUB v2)
343\f[C]fb2\f[R] (FictionBook2 e-book)
345\f[C]gfm\f[R] (GitHub-Flavored Markdown), or the deprecated and less
346accurate \f[C]markdown_github\f[R]; use \f[C]markdown_github\f[R] only
347if you need extensions not supported in \f[C]gfm\f[R].
349\f[C]haddock\f[R] (Haddock markup)
351\f[C]html\f[R] or \f[C]html5\f[R] (HTML, i.e.\ HTML5/XHTML polyglot
354\f[C]html4\f[R] (XHTML 1.0 Transitional)
356\f[C]icml\f[R] (InDesign ICML)
358\f[C]ipynb\f[R] (Jupyter notebook)
360\f[C]jats_archiving\f[R] (JATS XML, Archiving and Interchange Tag Set)
362\f[C]jats_articleauthoring\f[R] (JATS XML, Article Authoring Tag Set)
364\f[C]jats_publishing\f[R] (JATS XML, Journal Publishing Tag Set)
366\f[C]jats\f[R] (alias for \f[C]jats_archiving\f[R])
368\f[C]jira\f[R] (Jira/Confluence wiki markup)
370\f[C]json\f[R] (JSON version of native AST)
372\f[C]latex\f[R] (LaTeX)
374\f[C]man\f[R] (roff man)
376\f[C]markdown\f[R] (Pandoc\[cq]s Markdown)
378\f[C]markdown_mmd\f[R] (MultiMarkdown)
380\f[C]markdown_phpextra\f[R] (PHP Markdown Extra)
382\f[C]markdown_strict\f[R] (original unextended Markdown)
384\f[C]mediawiki\f[R] (MediaWiki markup)
386\f[C]ms\f[R] (roff ms)
388\f[C]muse\f[R] (Muse),
390\f[C]native\f[R] (native Haskell),
392\f[C]odt\f[R] (OpenOffice text document)
396\f[C]opendocument\f[R] (OpenDocument)
398\f[C]org\f[R] (Emacs Org mode)
402\f[C]plain\f[R] (plain text),
404\f[C]pptx\f[R] (PowerPoint slide show)
406\f[C]rst\f[R] (reStructuredText)
408\f[C]rtf\f[R] (Rich Text Format)
410\f[C]texinfo\f[R] (GNU Texinfo)
412\f[C]textile\f[R] (Textile)
414\f[C]slideous\f[R] (Slideous HTML and JavaScript slide show)
416\f[C]slidy\f[R] (Slidy HTML and JavaScript slide show)
418\f[C]dzslides\f[R] (DZSlides HTML5 + JavaScript slide show),
420\f[C]revealjs\f[R] (reveal.js HTML5 + JavaScript slide show)
422\f[C]s5\f[R] (S5 HTML and JavaScript slide show)
424\f[C]tei\f[R] (TEI Simple)
426\f[C]xwiki\f[R] (XWiki markup)
428\f[C]zimwiki\f[R] (ZimWiki markup)
430the path of a custom Lua writer, see Custom writers below
432Note that \f[C]odt\f[R], \f[C]docx\f[R], \f[C]epub\f[R], and
433\f[C]pdf\f[R] output will not be directed to \f[I]stdout\f[R] unless
434forced with \f[C]-o -\f[R].
436Extensions can be individually enabled or disabled by appending
437\f[C]+EXTENSION\f[R] or \f[C]-EXTENSION\f[R] to the format name.
438See Extensions below, for a list of extensions and their names.
439See \f[C]--list-output-formats\f[R] and \f[C]--list-extensions\f[R],
443\f[B]\f[CB]-o\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--output=\f[B]\f[R]\f[I]FILE\f[R]
444Write output to \f[I]FILE\f[R] instead of \f[I]stdout\f[R].
445If \f[I]FILE\f[R] is \f[C]-\f[R], output will go to \f[I]stdout\f[R],
446even if a non-textual format (\f[C]docx\f[R], \f[C]odt\f[R],
447\f[C]epub2\f[R], \f[C]epub3\f[R]) is specified.
449\f[B]\f[CB]--data-dir=\f[B]\f[R]\f[I]DIRECTORY\f[R]
450Specify the user data directory to search for pandoc data files.
451If this option is not specified, the default user data directory will be
453On *nix and macOS systems this will be the \f[C]pandoc\f[R] subdirectory
454of the XDG data directory (by default, \f[C]$HOME/.local/share\f[R],
455overridable by setting the \f[C]XDG_DATA_HOME\f[R] environment
457If that directory does not exist, \f[C]$HOME/.pandoc\f[R] will be used
458(for backwards compatibility).
459In Windows the default user data directory is
460\f[C]C:\[rs]Users\[rs]USERNAME\[rs]AppData\[rs]Roaming\[rs]pandoc\f[R].
461You can find the default user data directory on your system by looking
462at the output of \f[C]pandoc --version\f[R].
463A \f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R],
464\f[C]templates\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], or
465\f[C]s5\f[R] directory placed in this directory will override
466pandoc\[cq]s normal defaults.
468\f[B]\f[CB]-d\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--defaults=\f[B]\f[R]\f[I]FILE\f[R]
469Specify a set of default option settings.
470\f[I]FILE\f[R] is a YAML file whose fields correspond to command-line
472All options for document conversion, including input and output files,
473can be set using a defaults file.
474The file will be searched for first in the working directory, and then
475in the \f[C]defaults\f[R] subdirectory of the user data directory (see
476\f[C]--data-dir\f[R]).
477The \f[C].yaml\f[R] extension may be omitted.
478See the section Default files for more information on the file format.
479Settings from the defaults file may be overridden or extended by
480subsequent options on the command line.
482\f[B]\f[CB]--bash-completion\f[B]\f[R]
483Generate a bash completion script.
484To enable bash completion with pandoc, add this to your
490eval \[dq]$(pandoc --bash-completion)\[dq]
495\f[B]\f[CB]--verbose\f[B]\f[R]
496Give verbose debugging output.
498\f[B]\f[CB]--quiet\f[B]\f[R]
499Suppress warning messages.
501\f[B]\f[CB]--fail-if-warnings\f[B]\f[R]
502Exit with error status if there are any warnings.
504\f[B]\f[CB]--log=\f[B]\f[R]\f[I]FILE\f[R]
505Write log messages in machine-readable JSON format to \f[I]FILE\f[R].
506All messages above DEBUG level will be written, regardless of verbosity
507settings (\f[C]--verbose\f[R], \f[C]--quiet\f[R]).
509\f[B]\f[CB]--list-input-formats\f[B]\f[R]
510List supported input formats, one per line.
512\f[B]\f[CB]--list-output-formats\f[B]\f[R]
513List supported output formats, one per line.
515\f[B]\f[CB]--list-extensions\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]FORMAT\f[R]]
516List supported extensions for \f[I]FORMAT\f[R], one per line, preceded
517by a \f[C]+\f[R] or \f[C]-\f[R] indicating whether it is enabled by
518default in \f[I]FORMAT\f[R].
519If \f[I]FORMAT\f[R] is not specified, defaults for pandoc\[cq]s Markdown
522\f[B]\f[CB]--list-highlight-languages\f[B]\f[R]
523List supported languages for syntax highlighting, one per line.
525\f[B]\f[CB]--list-highlight-styles\f[B]\f[R]
526List supported styles for syntax highlighting, one per line.
527See \f[C]--highlight-style\f[R].
529\f[B]\f[CB]-v\f[B]\f[R], \f[B]\f[CB]--version\f[B]\f[R]
532\f[B]\f[CB]-h\f[B]\f[R], \f[B]\f[CB]--help\f[B]\f[R]
536\f[B]\f[CB]--shift-heading-level-by=\f[B]\f[R]\f[I]NUMBER\f[R]
537Shift heading levels by a positive or negative integer.
538For example, with \f[C]--shift-heading-level-by=-1\f[R], level 2
539headings become level 1 headings, and level 3 headings become level 2
541Headings cannot have a level less than 1, so a heading that would be
542shifted below level 1 becomes a regular paragraph.
543Exception: with a shift of -N, a level-N heading at the beginning of the
544document replaces the metadata title.
545\f[C]--shift-heading-level-by=-1\f[R] is a good choice when converting
546HTML or Markdown documents that use an initial level-1 heading for the
547document title and level-2+ headings for sections.
548\f[C]--shift-heading-level-by=1\f[R] may be a good choice for converting
549Markdown documents that use level-1 headings for sections to HTML, since
550pandoc uses a level-1 heading to render the document title.
552\f[B]\f[CB]--base-header-level=\f[B]\f[R]\f[I]NUMBER\f[R]
553\f[I]Deprecated. Use \f[CI]--shift-heading-level-by\f[I]=X instead,
554where X = NUMBER - 1.\f[R] Specify the base level for headings (defaults
557\f[B]\f[CB]--strip-empty-paragraphs\f[B]\f[R]
558\f[I]Deprecated. Use the \f[CI]+empty_paragraphs\f[I] extension
559instead.\f[R] Ignore paragraphs with no content.
560This option is useful for converting word processing documents where
561users have used empty paragraphs to create inter-paragraph space.
563\f[B]\f[CB]--indented-code-classes=\f[B]\f[R]\f[I]CLASSES\f[R]
564Specify classes to use for indented code blocks\[en]for example,
565\f[C]perl,numberLines\f[R] or \f[C]haskell\f[R].
566Multiple classes may be separated by spaces or commas.
568\f[B]\f[CB]--default-image-extension=\f[B]\f[R]\f[I]EXTENSION\f[R]
569Specify a default extension to use when image paths/URLs have no
571This allows you to use the same source for formats that require
572different kinds of images.
573Currently this option only affects the Markdown and LaTeX readers.
575\f[B]\f[CB]--file-scope\f[B]\f[R]
576Parse each file individually before combining for multifile documents.
577This will allow footnotes in different files with the same identifiers
579If this option is set, footnotes and links will not work across files.
580Reading binary files (docx, odt, epub) implies \f[C]--file-scope\f[R].
582\f[B]\f[CB]-F\f[B]\f[R] \f[I]PROGRAM\f[R], \f[B]\f[CB]--filter=\f[B]\f[R]\f[I]PROGRAM\f[R]
583Specify an executable to be used as a filter transforming the pandoc AST
584after the input is parsed and before the output is written.
585The executable should read JSON from stdin and write JSON to stdout.
586The JSON must be formatted like pandoc\[cq]s own JSON input and output.
587The name of the output format will be passed to the filter as the first
594pandoc --filter ./caps.py -t latex
602pandoc -t json | ./caps.py latex | pandoc -f json -t latex
606The latter form may be useful for debugging filters.
608Filters may be written in any language.
609\f[C]Text.Pandoc.JSON\f[R] exports \f[C]toJSONFilter\f[R] to facilitate
610writing filters in Haskell.
611Those who would prefer to write filters in python can use the module
612\f[C]pandocfilters\f[R], installable from PyPI.
613There are also pandoc filter libraries in PHP, perl, and
616In order of preference, pandoc will look for filters in
618a specified full or relative path (executable or non-executable)
620\f[C]$DATADIR/filters\f[R] (executable or non-executable) where
621\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
624\f[C]$PATH\f[R] (executable only)
626Filters and Lua-filters are applied in the order specified on the
630\f[B]\f[CB]-L\f[B]\f[R] \f[I]SCRIPT\f[R], \f[B]\f[CB]--lua-filter=\f[B]\f[R]\f[I]SCRIPT\f[R]
631Transform the document in a similar fashion as JSON filters (see
632\f[C]--filter\f[R]), but use pandoc\[cq]s build-in Lua filtering system.
633The given Lua script is expected to return a list of Lua filters which
634will be applied in order.
635Each Lua filter must contain element-transforming functions indexed by
636the name of the AST element on which the filter function should be
640The \f[C]pandoc\f[R] Lua module provides helper functions for element
642It is always loaded into the script\[cq]s Lua environment.
644The following is an example Lua script for macro-expansion:
648function expand_hello_world(inline)
649 if inline.c == \[aq]{{helloworld}}\[aq] then
650 return pandoc.Emph{ pandoc.Str \[dq]Hello, World\[dq] }
656return {{Str = expand_hello_world}}
660In order of preference, pandoc will look for Lua filters in
662a specified full or relative path (executable or non-executable)
664\f[C]$DATADIR/filters\f[R] (executable or non-executable) where
665\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
669\f[B]\f[CB]-M\f[B]\f[R] \f[I]KEY\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]VAL\f[R]], \f[B]\f[CB]--metadata=\f[B]\f[R]\f[I]KEY\f[R][\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]]
670Set the metadata field \f[I]KEY\f[R] to the value \f[I]VAL\f[R].
671A value specified on the command line overrides a value specified in the
672document using YAML metadata blocks.
673Values will be parsed as YAML boolean or string values.
674If no value is specified, the value will be treated as Boolean true.
675Like \f[C]--variable\f[R], \f[C]--metadata\f[R] causes template
677But unlike \f[C]--variable\f[R], \f[C]--metadata\f[R] affects the
678metadata of the underlying document (which is accessible from filters
679and may be printed in some output formats) and metadata values will be
680escaped when inserted into the template.
682\f[B]\f[CB]--metadata-file=\f[B]\f[R]\f[I]FILE\f[R]
683Read metadata from the supplied YAML (or JSON) file.
684This option can be used with every input format, but string scalars in
685the YAML file will always be parsed as Markdown.
686Generally, the input will be handled the same as in YAML metadata
688This option can be used repeatedly to include multiple metadata files;
689values in files specified later on the command line will be preferred
690over those specified in earlier files.
691Metadata values specified inside the document, or by using \f[C]-M\f[R],
692overwrite values specified with this option.
694\f[B]\f[CB]-p\f[B]\f[R], \f[B]\f[CB]--preserve-tabs\f[B]\f[R]
695Preserve tabs instead of converting them to spaces.
696(By default, pandoc converts tabs to spaces before parsing its input.)
697Note that this will only affect tabs in literal code spans and code
699Tabs in regular text are always treated as spaces.
701\f[B]\f[CB]--tab-stop=\f[B]\f[R]\f[I]NUMBER\f[R]
702Specify the number of spaces per tab (default is 4).
704\f[B]\f[CB]--track-changes=accept\f[B]\f[R]|\f[B]\f[CB]reject\f[B]\f[R]|\f[B]\f[CB]all\f[B]\f[R]
705Specifies what to do with insertions, deletions, and comments produced
706by the MS Word \[lq]Track Changes\[rq] feature.
707\f[C]accept\f[R] (the default), inserts all insertions, and ignores all
709\f[C]reject\f[R] inserts all deletions and ignores insertions.
710Both \f[C]accept\f[R] and \f[C]reject\f[R] ignore comments.
711\f[C]all\f[R] puts in insertions, deletions, and comments, wrapped in
712spans with \f[C]insertion\f[R], \f[C]deletion\f[R],
713\f[C]comment-start\f[R], and \f[C]comment-end\f[R] classes,
715The author and time of change is included.
716\f[C]all\f[R] is useful for scripting: only accepting changes from a
717certain reviewer, say, or before a certain date.
718If a paragraph is inserted or deleted, \f[C]track-changes=all\f[R]
719produces a span with the class
720\f[C]paragraph-insertion\f[R]/\f[C]paragraph-deletion\f[R] before the
721affected paragraph break.
722This option only affects the docx reader.
724\f[B]\f[CB]--extract-media=\f[B]\f[R]\f[I]DIR\f[R]
725Extract images and other media contained in or linked from the source
726document to the path \f[I]DIR\f[R], creating it if necessary, and adjust
727the images references in the document so they point to the extracted
729If the source format is a binary container (docx, epub, or odt), the
730media is extracted from the container and the original filenames are
732Otherwise the media is read from the file system or downloaded, and new
733filenames are constructed based on SHA1 hashes of the contents.
735\f[B]\f[CB]--abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
736Specifies a custom abbreviations file, with abbreviations one to a line.
737If this option is not specified, pandoc will read the data file
738\f[C]abbreviations\f[R] from the user data directory or fall back on a
740To see the system default, use
741\f[C]pandoc --print-default-data-file=abbreviations\f[R].
742The only use pandoc makes of this list is in the Markdown reader.
743Strings ending in a period that are found in this list will be followed
744by a nonbreaking space, so that the period will not produce
745sentence-ending space in formats like LaTeX.
746.SS General writer options
748\f[B]\f[CB]-s\f[B]\f[R], \f[B]\f[CB]--standalone\f[B]\f[R]
749Produce output with an appropriate header and footer (e.g.\ a standalone
750HTML, LaTeX, TEI, or RTF file, not a fragment).
751This option is set automatically for \f[C]pdf\f[R], \f[C]epub\f[R],
752\f[C]epub3\f[R], \f[C]fb2\f[R], \f[C]docx\f[R], and \f[C]odt\f[R]
754For \f[C]native\f[R] output, this option causes metadata to be included;
755otherwise, metadata is suppressed.
757\f[B]\f[CB]--template=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
758Use the specified file as a custom template for the generated document.
759Implies \f[C]--standalone\f[R].
760See Templates, below, for a description of template syntax.
761If no extension is specified, an extension corresponding to the writer
762will be added, so that \f[C]--template=special\f[R] looks for
763\f[C]special.html\f[R] for HTML output.
764If the template is not found, pandoc will search for it in the
765\f[C]templates\f[R] subdirectory of the user data directory (see
766\f[C]--data-dir\f[R]).
767If this option is not used, a default template appropriate for the
768output format will be used (see \f[C]-D/--print-default-template\f[R]).
770\f[B]\f[CB]-V\f[B]\f[R] \f[I]KEY\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]VAL\f[R]], \f[B]\f[CB]--variable=\f[B]\f[R]\f[I]KEY\f[R][\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]]
771Set the template variable \f[I]KEY\f[R] to the value \f[I]VAL\f[R] when
772rendering the document in standalone mode.
773If no \f[I]VAL\f[R] is specified, the key will be given the value
776\f[B]\f[CB]-D\f[B]\f[R] \f[I]FORMAT\f[R], \f[B]\f[CB]--print-default-template=\f[B]\f[R]\f[I]FORMAT\f[R]
777Print the system default template for an output \f[I]FORMAT\f[R].
778(See \f[C]-t\f[R] for a list of possible \f[I]FORMAT\f[R]s.) Templates
779in the user data directory are ignored.
780This option may be used with \f[C]-o\f[R]/\f[C]--output\f[R] to redirect
781output to a file, but \f[C]-o\f[R]/\f[C]--output\f[R] must come before
782\f[C]--print-default-template\f[R] on the command line.
785Note that some of the default templates use partials, for example
786\f[C]styles.html\f[R].
787To print the partials, use \f[C]--print-default-data-file\f[R]: for
788example, \f[C]--print-default-data-file=templates/styles.html\f[R].
791\f[B]\f[CB]--print-default-data-file=\f[B]\f[R]\f[I]FILE\f[R]
792Print a system default data file.
793Files in the user data directory are ignored.
794This option may be used with \f[C]-o\f[R]/\f[C]--output\f[R] to redirect
795output to a file, but \f[C]-o\f[R]/\f[C]--output\f[R] must come before
796\f[C]--print-default-data-file\f[R] on the command line.
798\f[B]\f[CB]--eol=crlf\f[B]\f[R]|\f[B]\f[CB]lf\f[B]\f[R]|\f[B]\f[CB]native\f[B]\f[R]
799Manually specify line endings: \f[C]crlf\f[R] (Windows), \f[C]lf\f[R]
800(macOS/Linux/UNIX), or \f[C]native\f[R] (line endings appropriate to the
801OS on which pandoc is being run).
802The default is \f[C]native\f[R].
804\f[B]\f[CB]--dpi\f[B]\f[R]=\f[I]NUMBER\f[R]
805Specify the default dpi (dots per inch) value for conversion from pixels
806to inch/centimeters and vice versa.
807(Technically, the correct term would be ppi: pixels per inch.) The
809When images contain information about dpi internally, the encoded value
810is used instead of the default specified by this option.
812\f[B]\f[CB]--wrap=auto\f[B]\f[R]|\f[B]\f[CB]none\f[B]\f[R]|\f[B]\f[CB]preserve\f[B]\f[R]
813Determine how text is wrapped in the output (the source code, not the
815With \f[C]auto\f[R] (the default), pandoc will attempt to wrap lines to
816the column width specified by \f[C]--columns\f[R] (default 72).
817With \f[C]none\f[R], pandoc will not wrap lines at all.
818With \f[C]preserve\f[R], pandoc will attempt to preserve the wrapping
819from the source document (that is, where there are nonsemantic newlines
820in the source, there will be nonsemantic newlines in the output as
822Automatic wrapping does not currently work in HTML output.
823In \f[C]ipynb\f[R] output, this option affects wrapping of the contents
826\f[B]\f[CB]--columns=\f[B]\f[R]\f[I]NUMBER\f[R]
827Specify length of lines in characters.
828This affects text wrapping in the generated source code (see
830It also affects calculation of column widths for plain text tables (see
833\f[B]\f[CB]--toc\f[B]\f[R], \f[B]\f[CB]--table-of-contents\f[B]\f[R]
834Include an automatically generated table of contents (or, in the case of
835\f[C]latex\f[R], \f[C]context\f[R], \f[C]docx\f[R], \f[C]odt\f[R],
836\f[C]opendocument\f[R], \f[C]rst\f[R], or \f[C]ms\f[R], an instruction
837to create one) in the output document.
838This option has no effect unless \f[C]-s/--standalone\f[R] is used, and
839it has no effect on \f[C]man\f[R], \f[C]docbook4\f[R],
840\f[C]docbook5\f[R], or \f[C]jats\f[R] output.
843Note that if you are producing a PDF via \f[C]ms\f[R], the table of
844contents will appear at the beginning of the document, before the title.
845If you would prefer it to be at the end of the document, use the option
846\f[C]--pdf-engine-opt=--no-toc-relocation\f[R].
849\f[B]\f[CB]--toc-depth=\f[B]\f[R]\f[I]NUMBER\f[R]
850Specify the number of section levels to include in the table of
852The default is 3 (which means that level-1, 2, and 3 headings will be
853listed in the contents).
855\f[B]\f[CB]--strip-comments\f[B]\f[R]
856Strip out HTML comments in the Markdown or Textile source, rather than
857passing them on to Markdown, Textile or HTML output as raw HTML.
858This does not apply to HTML comments inside raw HTML blocks when the
859\f[C]markdown_in_html_blocks\f[R] extension is not set.
861\f[B]\f[CB]--no-highlight\f[B]\f[R]
862Disables syntax highlighting for code blocks and inlines, even when a
863language attribute is given.
865\f[B]\f[CB]--highlight-style=\f[B]\f[R]\f[I]STYLE\f[R]|\f[I]FILE\f[R]
866Specifies the coloring style to be used in highlighted source code.
867Options are \f[C]pygments\f[R] (the default), \f[C]kate\f[R],
868\f[C]monochrome\f[R], \f[C]breezeDark\f[R], \f[C]espresso\f[R],
869\f[C]zenburn\f[R], \f[C]haddock\f[R], and \f[C]tango\f[R].
870For more information on syntax highlighting in pandoc, see Syntax
872See also \f[C]--list-highlight-styles\f[R].
875Instead of a \f[I]STYLE\f[R] name, a JSON file with extension
876\f[C].theme\f[R] may be supplied.
877This will be parsed as a KDE syntax highlighting theme and (if valid)
878used as the highlighting style.
880To generate the JSON version of an existing style, use
881\f[C]--print-highlight-style\f[R].
884\f[B]\f[CB]--print-highlight-style=\f[B]\f[R]\f[I]STYLE\f[R]|\f[I]FILE\f[R]
885Prints a JSON version of a highlighting style, which can be modified,
886saved with a \f[C].theme\f[R] extension, and used with
887\f[C]--highlight-style\f[R].
888This option may be used with \f[C]-o\f[R]/\f[C]--output\f[R] to redirect
889output to a file, but \f[C]-o\f[R]/\f[C]--output\f[R] must come before
890\f[C]--print-highlight-style\f[R] on the command line.
892\f[B]\f[CB]--syntax-definition=\f[B]\f[R]\f[I]FILE\f[R]
893Instructs pandoc to load a KDE XML syntax definition file, which will be
894used for syntax highlighting of appropriately marked code blocks.
895This can be used to add support for new languages or to use altered
896syntax definitions for existing languages.
897This option may be repeated to add multiple syntax definitions.
899\f[B]\f[CB]-H\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--include-in-header=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
900Include contents of \f[I]FILE\f[R], verbatim, at the end of the header.
901This can be used, for example, to include special CSS or JavaScript in
903This option can be used repeatedly to include multiple files in the
905They will be included in the order specified.
906Implies \f[C]--standalone\f[R].
908\f[B]\f[CB]-B\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--include-before-body=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
909Include contents of \f[I]FILE\f[R], verbatim, at the beginning of the
910document body (e.g.\ after the \f[C]<body>\f[R] tag in HTML, or the
911\f[C]\[rs]begin{document}\f[R] command in LaTeX).
912This can be used to include navigation bars or banners in HTML
914This option can be used repeatedly to include multiple files.
915They will be included in the order specified.
916Implies \f[C]--standalone\f[R].
918\f[B]\f[CB]-A\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--include-after-body=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
919Include contents of \f[I]FILE\f[R], verbatim, at the end of the document
920body (before the \f[C]</body>\f[R] tag in HTML, or the
921\f[C]\[rs]end{document}\f[R] command in LaTeX).
922This option can be used repeatedly to include multiple files.
923They will be included in the order specified.
924Implies \f[C]--standalone\f[R].
926\f[B]\f[CB]--resource-path=\f[B]\f[R]\f[I]SEARCHPATH\f[R]
927List of paths to search for images and other resources.
928The paths should be separated by \f[C]:\f[R] on Linux, UNIX, and macOS
929systems, and by \f[C];\f[R] on Windows.
930If \f[C]--resource-path\f[R] is not specified, the default resource path
931is the working directory.
932Note that, if \f[C]--resource-path\f[R] is specified, the working
933directory must be explicitly listed or it will not be searched.
934For example: \f[C]--resource-path=.:test\f[R] will search the working
935directory and the \f[C]test\f[R] subdirectory, in that order.
938\f[C]--resource-path\f[R] only has an effect if (a) the output format
939embeds images (for example, \f[C]docx\f[R], \f[C]pdf\f[R], or
940\f[C]html\f[R] with \f[C]--self-contained\f[R]) or (b) it is used
941together with \f[C]--extract-media\f[R].
944\f[B]\f[CB]--request-header=\f[B]\f[R]\f[I]NAME\f[R]\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]
945Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when
946making HTTP requests (for example, when a URL is given on the command
947line, or when resources used in a document must be downloaded).
948If you\[cq]re behind a proxy, you also need to set the environment
949variable \f[C]http_proxy\f[R] to \f[C]http://...\f[R].
951\f[B]\f[CB]--no-check-certificate\f[B]\f[R]
952Disable the certificate verification to allow access to unsecure HTTP
953resources (for example when the certificate is no longer valid or self
955.SS Options affecting specific writers
957\f[B]\f[CB]--self-contained\f[B]\f[R]
958Produce a standalone HTML file with no external dependencies, using
959\f[C]data:\f[R] URIs to incorporate the contents of linked scripts,
960stylesheets, images, and videos.
961Implies \f[C]--standalone\f[R].
962The resulting file should be \[lq]self-contained,\[rq] in the sense that
963it needs no external files and no net access to be displayed properly by
965This option works only with HTML output formats, including
966\f[C]html4\f[R], \f[C]html5\f[R], \f[C]html+lhs\f[R],
967\f[C]html5+lhs\f[R], \f[C]s5\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R],
968\f[C]dzslides\f[R], and \f[C]revealjs\f[R].
969Scripts, images, and stylesheets at absolute URLs will be downloaded;
970those at relative URLs will be sought relative to the working directory
971(if the first source file is local) or relative to the base URL (if the
972first source file is remote).
973Elements with the attribute \f[C]data-external=\[dq]1\[dq]\f[R] will be
974left alone; the documents they link to will not be incorporated in the
976Limitation: resources that are loaded dynamically through JavaScript
977cannot be incorporated; as a result, \f[C]--self-contained\f[R] does not
978work with \f[C]--mathjax\f[R], and some advanced features (e.g.\ zoom or
979speaker notes) may not work in an offline \[lq]self-contained\[rq]
980\f[C]reveal.js\f[R] slide show.
982\f[B]\f[CB]--html-q-tags\f[B]\f[R]
983Use \f[C]<q>\f[R] tags for quotes in HTML.
985\f[B]\f[CB]--ascii\f[B]\f[R]
986Use only ASCII characters in output.
987Currently supported for XML and HTML formats (which use entities instead
988of UTF-8 when this option is selected), CommonMark, gfm, and Markdown
989(which use entities), roff ms (which use hexadecimal escapes), and to a
990limited degree LaTeX (which uses standard commands for accented
991characters when possible).
992roff man output uses ASCII by default.
994\f[B]\f[CB]--reference-links\f[B]\f[R]
995Use reference-style links, rather than inline links, in writing Markdown
997By default inline links are used.
998The placement of link references is affected by the
999\f[C]--reference-location\f[R] option.
1001\f[B]\f[CB]--reference-location = block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
1002Specify whether footnotes (and references, if \f[C]reference-links\f[R]
1003is set) are placed at the end of the current (top-level) block, the
1004current section, or the document.
1005The default is \f[C]document\f[R].
1006Currently only affects the markdown writer.
1008\f[B]\f[CB]--atx-headers\f[B]\f[R]
1009Use ATX-style headings in Markdown output.
1010The default is to use setext-style headings for levels 1 to 2, and then
1012(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This
1013option also affects markdown cells in \f[C]ipynb\f[R] output.
1015\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R]
1016Treat top-level headings as the given division type in LaTeX, ConTeXt,
1017DocBook, and TEI output.
1018The hierarchy order is part, chapter, then section; all headings are
1019shifted such that the top-level heading becomes the specified type.
1020The default behavior is to determine the best division type via
1021heuristics: unless other conditions apply, \f[C]section\f[R] is chosen.
1022When the \f[C]documentclass\f[R] variable is set to \f[C]report\f[R],
1023\f[C]book\f[R], or \f[C]memoir\f[R] (unless the \f[C]article\f[R] option
1024is specified), \f[C]chapter\f[R] is implied as the setting for this
1026If \f[C]beamer\f[R] is the output format, specifying either
1027\f[C]chapter\f[R] or \f[C]part\f[R] will cause top-level headings to
1028become \f[C]\[rs]part{..}\f[R], while second-level headings remain as
1031\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
1032Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
1033By default, sections are not numbered.
1034Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
1035\f[C]--number-sections\f[R] is specified.
1037\f[B]\f[CB]--number-offset=\f[B]\f[R]\f[I]NUMBER\f[R][\f[B]\f[CB],\f[B]\f[R]\f[I]NUMBER\f[R]\f[B]\f[CB],\f[B]\f[R]\f[I]\&...\f[R]]
1038Offset for section headings in HTML output (ignored in other output
1040The first number is added to the section number for top-level headings,
1041the second for second-level headings, and so on.
1042So, for example, if you want the first top-level heading in your
1043document to be numbered \[lq]6\[rq], specify
1044\f[C]--number-offset=5\f[R].
1045If your document starts with a level-2 heading which you want to be
1046numbered \[lq]1.5\[rq], specify \f[C]--number-offset=1,4\f[R].
1047Offsets are 0 by default.
1048Implies \f[C]--number-sections\f[R].
1050\f[B]\f[CB]--listings\f[B]\f[R]
1051Use the \f[C]listings\f[R] package for LaTeX code blocks.
1052The package does not support multi-byte encoding for source code.
1053To handle UTF-8 you would need to use a custom template.
1054This issue is fully documented here: Encoding issue with the listings
1057\f[B]\f[CB]-i\f[B]\f[R], \f[B]\f[CB]--incremental\f[B]\f[R]
1058Make list items in slide shows display incrementally (one by one).
1059The default is for lists to be displayed all at once.
1061\f[B]\f[CB]--slide-level=\f[B]\f[R]\f[I]NUMBER\f[R]
1062Specifies that headings with the specified level create slides (for
1063\f[C]beamer\f[R], \f[C]s5\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R],
1065Headings above this level in the hierarchy are used to divide the slide
1066show into sections; headings below this level create subheads within a
1068Note that content that is not contained under slide-level headings will
1069not appear in the slide show.
1070The default is to set the slide level based on the contents of the
1071document; see Structuring the slide show.
1073\f[B]\f[CB]--section-divs\f[B]\f[R]
1074Wrap sections in \f[C]<section>\f[R] tags (or \f[C]<div>\f[R] tags for
1075\f[C]html4\f[R]), and attach identifiers to the enclosing
1076\f[C]<section>\f[R] (or \f[C]<div>\f[R]) rather than the heading itself.
1077See Heading identifiers, below.
1079\f[B]\f[CB]--email-obfuscation=none\f[B]\f[R]|\f[B]\f[CB]javascript\f[B]\f[R]|\f[B]\f[CB]references\f[B]\f[R]
1080Specify a method for obfuscating \f[C]mailto:\f[R] links in HTML
1082\f[C]none\f[R] leaves \f[C]mailto:\f[R] links as they are.
1083\f[C]javascript\f[R] obfuscates them using JavaScript.
1084\f[C]references\f[R] obfuscates them by printing their letters as
1085decimal or hexadecimal character references.
1086The default is \f[C]none\f[R].
1088\f[B]\f[CB]--id-prefix=\f[B]\f[R]\f[I]STRING\f[R]
1089Specify a prefix to be added to all identifiers and internal links in
1090HTML and DocBook output, and to footnote numbers in Markdown and Haddock
1092This is useful for preventing duplicate identifiers when generating
1093fragments to be included in other pages.
1095\f[B]\f[CB]-T\f[B]\f[R] \f[I]STRING\f[R], \f[B]\f[CB]--title-prefix=\f[B]\f[R]\f[I]STRING\f[R]
1096Specify \f[I]STRING\f[R] as a prefix at the beginning of the title that
1097appears in the HTML header (but not in the title as it appears at the
1098beginning of the HTML body).
1099Implies \f[C]--standalone\f[R].
1101\f[B]\f[CB]-c\f[B]\f[R] \f[I]URL\f[R], \f[B]\f[CB]--css=\f[B]\f[R]\f[I]URL\f[R]
1102Link to a CSS style sheet.
1103This option can be used repeatedly to include multiple files.
1104They will be included in the order specified.
1107A stylesheet is required for generating EPUB.
1108If none is provided using this option (or the \f[C]css\f[R] or
1109\f[C]stylesheet\f[R] metadata fields), pandoc will look for a file
1110\f[C]epub.css\f[R] in the user data directory (see
1111\f[C]--data-dir\f[R]).
1112If it is not found there, sensible defaults will be used.
1115\f[B]\f[CB]--reference-doc=\f[B]\f[R]\f[I]FILE\f[R]
1116Use the specified file as a style reference in producing a docx or ODT
1121For best results, the reference docx should be a modified version of a
1122docx file produced using pandoc.
1123The contents of the reference docx are ignored, but its stylesheets and
1124document properties (including margins, page size, header, and footer)
1125are used in the new docx.
1126If no reference docx is specified on the command line, pandoc will look
1127for a file \f[C]reference.docx\f[R] in the user data directory (see
1128\f[C]--data-dir\f[R]).
1129If this is not found either, sensible defaults will be used.
1132To produce a custom \f[C]reference.docx\f[R], first get a copy of the
1133default \f[C]reference.docx\f[R]:
1134\f[C]pandoc -o custom-reference.docx --print-default-data-file reference.docx\f[R].
1135Then open \f[C]custom-reference.docx\f[R] in Word, modify the styles as
1136you wish, and save the file.
1137For best results, do not make changes to this file other than modifying
1138the styles used by pandoc:
1202Default Paragraph Font
1220For best results, the reference ODT should be a modified version of an
1221ODT produced using pandoc.
1222The contents of the reference ODT are ignored, but its stylesheets are
1224If no reference ODT is specified on the command line, pandoc will look
1225for a file \f[C]reference.odt\f[R] in the user data directory (see
1226\f[C]--data-dir\f[R]).
1227If this is not found either, sensible defaults will be used.
1230To produce a custom \f[C]reference.odt\f[R], first get a copy of the
1231default \f[C]reference.odt\f[R]:
1232\f[C]pandoc -o custom-reference.odt --print-default-data-file reference.odt\f[R].
1233Then open \f[C]custom-reference.odt\f[R] in LibreOffice, modify the
1234styles as you wish, and save the file.
1238Templates included with Microsoft PowerPoint 2013 (either with
1239\f[C].pptx\f[R] or \f[C].potx\f[R] extension) are known to work, as are
1240most templates derived from these.
1243The specific requirement is that the template should begin with the
1244following first four layouts:
1254All templates included with a recent version of MS PowerPoint will fit
1256(You can click on \f[C]Layout\f[R] under the \f[C]Home\f[R] menu to
1259You can also modify the default \f[C]reference.pptx\f[R]: first run
1260\f[C]pandoc -o custom-reference.pptx --print-default-data-file reference.pptx\f[R],
1261and then modify \f[C]custom-reference.pptx\f[R] in MS PowerPoint (pandoc
1262will use the first four layout slides, as mentioned above).
1266\f[B]\f[CB]--epub-cover-image=\f[B]\f[R]\f[I]FILE\f[R]
1267Use the specified image as the EPUB cover.
1268It is recommended that the image be less than 1000px in width and
1270Note that in a Markdown source document you can also specify
1271\f[C]cover-image\f[R] in a YAML metadata block (see EPUB Metadata,
1274\f[B]\f[CB]--epub-metadata=\f[B]\f[R]\f[I]FILE\f[R]
1275Look in the specified XML file for metadata for the EPUB.
1276The file should contain a series of Dublin Core elements.
1282 <dc:rights>Creative Commons</dc:rights>
1283 <dc:language>es-AR</dc:language>
1287By default, pandoc will include the following metadata elements:
1288\f[C]<dc:title>\f[R] (from the document title), \f[C]<dc:creator>\f[R]
1289(from the document authors), \f[C]<dc:date>\f[R] (from the document
1290date, which should be in ISO 8601 format), \f[C]<dc:language>\f[R] (from
1291the \f[C]lang\f[R] variable, or, if is not set, the locale), and
1292\f[C]<dc:identifier id=\[dq]BookId\[dq]>\f[R] (a randomly generated
1294Any of these may be overridden by elements in the metadata file.
1296Note: if the source document is Markdown, a YAML metadata block in the
1297document can be used instead.
1298See below under EPUB Metadata.
1301\f[B]\f[CB]--epub-embed-font=\f[B]\f[R]\f[I]FILE\f[R]
1302Embed the specified font in the EPUB.
1303This option can be repeated to embed multiple fonts.
1304Wildcards can also be used: for example, \f[C]DejaVuSans-*.ttf\f[R].
1305However, if you use wildcards on the command line, be sure to escape
1306them or put the whole filename in single quotes, to prevent them from
1307being interpreted by the shell.
1308To use the embedded fonts, you will need to add declarations like the
1309following to your CSS (see \f[C]--css\f[R]):
1315font-family: DejaVuSans;
1318src:url(\[dq]DejaVuSans-Regular.ttf\[dq]);
1321font-family: DejaVuSans;
1324src:url(\[dq]DejaVuSans-Bold.ttf\[dq]);
1327font-family: DejaVuSans;
1330src:url(\[dq]DejaVuSans-Oblique.ttf\[dq]);
1333font-family: DejaVuSans;
1336src:url(\[dq]DejaVuSans-BoldOblique.ttf\[dq]);
1338body { font-family: \[dq]DejaVuSans\[dq]; }
1343\f[B]\f[CB]--epub-chapter-level=\f[B]\f[R]\f[I]NUMBER\f[R]
1344Specify the heading level at which to split the EPUB into separate
1345\[lq]chapter\[rq] files.
1346The default is to split into chapters at level-1 headings.
1347This option only affects the internal composition of the EPUB, not the
1348way chapters and sections are displayed to users.
1349Some readers may be slow if the chapter files are too large, so for
1350large documents with few level-1 headings, one might want to use a
1351chapter level of 2 or 3.
1353\f[B]\f[CB]--epub-subdirectory=\f[B]\f[R]\f[I]DIRNAME\f[R]
1354Specify the subdirectory in the OCF container that is to hold the
1355EPUB-specific contents.
1356The default is \f[C]EPUB\f[R].
1357To put the EPUB contents in the top level, use an empty string.
1359\f[B]\f[CB]--ipynb-output=all|none|best\f[B]\f[R]
1360Determines how ipynb output cells are treated.
1361\f[C]all\f[R] means that all of the data formats included in the
1362original are preserved.
1363\f[C]none\f[R] means that the contents of data cells are omitted.
1364\f[C]best\f[R] causes pandoc to try to pick the richest data block in
1365each output cell that is compatible with the output format.
1366The default is \f[C]best\f[R].
1368\f[B]\f[CB]--pdf-engine=\f[B]\f[R]\f[I]PROGRAM\f[R]
1369Use the specified engine when producing PDF output.
1370Valid values are \f[C]pdflatex\f[R], \f[C]lualatex\f[R],
1371\f[C]xelatex\f[R], \f[C]latexmk\f[R], \f[C]tectonic\f[R],
1372\f[C]wkhtmltopdf\f[R], \f[C]weasyprint\f[R], \f[C]prince\f[R],
1373\f[C]context\f[R], and \f[C]pdfroff\f[R].
1374If the engine is not in your PATH, the full path of the engine may be
1376If this option is not specified, pandoc uses the following defaults
1377depending on the output format specified using \f[C]-t/--to\f[R]:
1380\f[C]-t latex\f[R] or none: \f[C]pdflatex\f[R] (other options:
1381\f[C]xelatex\f[R], \f[C]lualatex\f[R], \f[C]tectonic\f[R],
1384\f[C]-t context\f[R]: \f[C]context\f[R]
1386\f[C]-t html\f[R]: \f[C]wkhtmltopdf\f[R] (other options:
1387\f[C]prince\f[R], \f[C]weasyprint\f[R]; see print-css.rocks for a good
1388introduction to PDF generation from HTML/CSS.)
1390\f[C]-t ms\f[R]: \f[C]pdfroff\f[R]
1393\f[B]\f[CB]--pdf-engine-opt=\f[B]\f[R]\f[I]STRING\f[R]
1394Use the given string as a command-line argument to the
1395\f[C]pdf-engine\f[R].
1396For example, to use a persistent directory \f[C]foo\f[R] for
1397\f[C]latexmk\f[R]\[cq]s auxiliary files, use
1398\f[C]--pdf-engine-opt=-outdir=foo\f[R].
1399Note that no check for duplicate options is done.
1400.SS Citation rendering
1402\f[B]\f[CB]-C\f[B]\f[R], \f[B]\f[CB]--citeproc\f[B]\f[R]
1403Process the citations in the file, replacing them with rendered
1404citations and adding a bibliography.
1405Citation processing will not take place unless bibliographic data is
1406supplied, either through an external file specified using the
1407\f[C]--bibliography\f[R] option or the \f[C]bibliography\f[R] field in
1408metadata, or via a \f[C]references\f[R] section in metadata containing a
1409list of citations in CSL YAML format with Markdown formatting.
1410The style is controlled by a CSL stylesheet specified using the
1411\f[C]--csl\f[R] option or the \f[C]csl\f[R] field in metadata.
1412(If no stylesheet is specified, the \f[C]chicago-author-date\f[R] style
1413will be used by default.) The citation processing transformation may be
1414applied before or after filters or Lua filters (see \f[C]--filter\f[R],
1415\f[C]--lua-filter\f[R]): these transformations are applied in the order
1416they appear on the command line.
1417For more information, see the section on Citations.
1419\f[B]\f[CB]--bibliography=\f[B]\f[R]\f[I]FILE\f[R]
1420Set the \f[C]bibliography\f[R] field in the document\[cq]s metadata to
1421\f[I]FILE\f[R], overriding any value set in the metadata.
1422If you supply this argument multiple times, each \f[I]FILE\f[R] will be
1423added to bibliography.
1425\f[B]\f[CB]--csl=\f[B]\f[R]\f[I]FILE\f[R]
1426Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
1427\f[I]FILE\f[R], overriding any value set in the metadata.
1428(This is equivalent to \f[C]--metadata csl=FILE\f[R].) If \f[I]FILE\f[R]
1429is a URL, it will be fetched via HTTP.
1430If \f[I]FILE\f[R] is not found relative to the working directory, it
1431will be sought in the resource path and finally in the \f[C]csl\f[R]
1432subdirectory of the pandoc user data directory.
1434\f[B]\f[CB]--citation-abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
1435Set the \f[C]citation-abbreviations\f[R] field in the document\[cq]s
1436metadata to \f[I]FILE\f[R], overriding any value set in the metadata.
1437(This is equivalent to
1438\f[C]--metadata citation-abbreviations=FILE\f[R].) If \f[I]FILE\f[R] is
1439a URL, it will be fetched via HTTP.
1440If \f[I]FILE\f[R] is not found relative to the working directory, it
1441will be sought in the resource path and finally in the \f[C]csl\f[R]
1442subdirectory of the pandoc user data directory.
1444\f[B]\f[CB]--natbib\f[B]\f[R]
1445Use \f[C]natbib\f[R] for citations in LaTeX output.
1446This option is not for use with the \f[C]--citeproc\f[R] option or with
1448It is intended for use in producing a LaTeX file that can be processed
1449with \f[C]bibtex\f[R].
1451\f[B]\f[CB]--biblatex\f[B]\f[R]
1452Use \f[C]biblatex\f[R] for citations in LaTeX output.
1453This option is not for use with the \f[C]--citeproc\f[R] option or with
1455It is intended for use in producing a LaTeX file that can be processed
1456with \f[C]bibtex\f[R] or \f[C]biber\f[R].
1457.SS Math rendering in HTML
1459The default is to render TeX math as far as possible using Unicode
1461Formulas are put inside a \f[C]span\f[R] with
1462\f[C]class=\[dq]math\[dq]\f[R], so that they may be styled differently
1463from the surrounding text if needed.
1464However, this gives acceptable results only for basic math, usually you
1465will want to use \f[C]--mathjax\f[R] or another of the following
1468\f[B]\f[CB]--mathjax\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]URL\f[R]]
1469Use MathJax to display embedded TeX math in HTML output.
1470TeX math will be put between \f[C]\[rs](...\[rs])\f[R] (for inline math)
1471or \f[C]\[rs][...\[rs]]\f[R] (for display math) and wrapped in
1472\f[C]<span>\f[R] tags with class \f[C]math\f[R].
1473Then the MathJax JavaScript will render it.
1474The \f[I]URL\f[R] should point to the \f[C]MathJax.js\f[R] load script.
1475If a \f[I]URL\f[R] is not provided, a link to the Cloudflare CDN will be
1478\f[B]\f[CB]--mathml\f[B]\f[R]
1479Convert TeX math to MathML (in \f[C]epub3\f[R], \f[C]docbook4\f[R],
1480\f[C]docbook5\f[R], \f[C]jats\f[R], \f[C]html4\f[R] and
1482This is the default in \f[C]odt\f[R] output.
1483Note that currently only Firefox and Safari (and select e-book readers)
1484natively support MathML.
1486\f[B]\f[CB]--webtex\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]URL\f[R]]
1487Convert TeX formulas to \f[C]<img>\f[R] tags that link to an external
1488script that converts formulas to images.
1489The formula will be URL-encoded and concatenated with the URL provided.
1490For SVG images you can for example use
1491\f[C]--webtex https://latex.codecogs.com/svg.latex?\f[R].
1492If no URL is specified, the CodeCogs URL generating PNGs will be used
1493(\f[C]https://latex.codecogs.com/png.latex?\f[R]).
1494Note: the \f[C]--webtex\f[R] option will affect Markdown output as well
1495as HTML, which is useful if you\[cq]re targeting a version of Markdown
1496without native math support.
1498\f[B]\f[CB]--katex\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]URL\f[R]]
1499Use KaTeX to display embedded TeX math in HTML output.
1500The \f[I]URL\f[R] is the base URL for the KaTeX library.
1501That directory should contain a \f[C]katex.min.js\f[R] and a
1502\f[C]katex.min.css\f[R] file.
1503If a \f[I]URL\f[R] is not provided, a link to the KaTeX CDN will be
1506\f[B]\f[CB]--gladtex\f[B]\f[R]
1507Enclose TeX math in \f[C]<eq>\f[R] tags in HTML output.
1508The resulting HTML can then be processed by GladTeX to produce images of
1509the typeset formulas and an HTML file with links to these images.
1510So, the procedure is:
1515pandoc -s --gladtex input.md -o myfile.htex
1516gladtex -d myfile-images myfile.htex
1517# produces myfile.html and images in myfile-images
1521.SS Options for wrapper scripts
1523\f[B]\f[CB]--dump-args\f[B]\f[R]
1524Print information about command-line arguments to \f[I]stdout\f[R], then
1526This option is intended primarily for use in wrapper scripts.
1527The first line of output contains the name of the output file specified
1528with the \f[C]-o\f[R] option, or \f[C]-\f[R] (for \f[I]stdout\f[R]) if
1529no output file was specified.
1530The remaining lines contain the command-line arguments, one per line, in
1531the order they appear.
1532These do not include regular pandoc options and their arguments, but do
1533include any options appearing after a \f[C]--\f[R] separator at the end
1536\f[B]\f[CB]--ignore-args\f[B]\f[R]
1537Ignore command-line arguments (for use in wrapper scripts).
1538Regular pandoc options are not ignored.
1544pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1552pandoc -o foo.html -s
1558If pandoc completes successfully, it will return exit code 0.
1559Nonzero exit codes have the following meanings:
1573PandocFailOnWarningError
1593PandocUnknownReaderError
1598PandocUnknownWriterError
1603PandocUnsupportedExtensionError
1613PandocEpubSubdirectoryError
1623PandocPDFProgramNotFoundError
1633PandocShouldNeverHappenError
1673PandocUTF8DecodingError
1678PandocIpynbDecodingError
1683PandocCouldNotFindDataFileError
1688PandocResourceNotFound
1693The \f[C]--defaults\f[R] option may be used to specify a package of
1695Here is a sample defaults file demonstrating all of the fields that may
1701# reader: may be used instead of from:
1703# writer: may be used instead of to:
1705# leave blank for output to stdout:
1707# leave blank for input from stdin, use [] for no input:
1711# or you may use input-file: with a single value
1715self-contained: false
1717# note that structured variables may be specified:
1724# metadata values specified here are parsed as literal
1725# string text, not markdown:
1732# or you may use metadata-file: with a single value
1734# Note that these take files, not their contents:
1735include-before-body: []
1736include-after-body: []
1737include-in-header: []
1738resource-path: [\[dq].\[dq]]
1740# turn on built-in citation processing. Note that if you need
1741# control over when the citeproc processing is done relative
1742# to other filters, you should instead use \[ga]citeproc\[ga] in the
1743# list of \[ga]filters\[ga] (see below).
1750# Filters will be assumed to be Lua filters if they have
1751# the .lua extension, and json filters otherwise. But
1752# the filter type can also be specified explicitly, as shown.
1753# Filters are run in the order specified.
1754# To include the built-in citeproc filter, use either \[ga]citeproc\[ga]
1755# or \[ga]{type: citeproc}\[ga].
1765# ERROR, WARNING, or INFO
1769# citeproc, natbib, or biblatex
1770cite-method: citeproc
1771# part, chapter, section, or default:
1772top-level-division: chapter
1777- \[dq]-shell-escape\[dq]
1778# you may also use pdf-engine-opt: with a single option
1779# pdf-engine-opt: \[dq]-shell-escape\[dq]
1781# auto, preserve, or none
1786extract-media: mediadir
1788table-of-contents: true
1790number-sections: false
1791# a list of offsets at each heading level
1792number-offset: [0,0,0,0,0,0]
1793# toc: may also be used instead of table-of-contents:
1794shift-heading-level-by: 1
1796identifier-prefix: foo
1797title-prefix: \[dq]\[dq]
1798strip-empty-paragraphs: true
1799# lf, crlf, or native
1801strip-comments: false
1802indented-code-classes: []
1804default-image-extension: \[dq].jpg\[dq]
1806# either a style name of a style definition file:
1807highlight-style: pygments
1810# or you may use syntax-definition: with a single value
1813reference-doc: myref.docx
1815# method is plain, webtex, gladtex, mathml, mathjax, katex
1816# you may specify a url with webtex, mathjax, katex
1819 url: \[dq]https://cdn.jsdelivr.net/npm/mathjax\[at]3/es5/tex-mml-chtml.js\[dq]
1820# none, references, or javascript
1821email-obfuscation: javascript
1829epub-subdirectory: EPUB
1830epub-metadata: meta.xml
1833epub-chapter-level: 1
1834epub-cover-image: cover.jpg
1836reference-links: true
1837# block, section, or document
1838reference-location: block
1841# accept, reject, or all
1842track-changes: accept
1851# A list of two-element lists
1853- [\[dq]User-Agent\[dq], \[dq]Mozilla/5.0\[dq]]
1855fail-if-warnings: false
1862Fields that are omitted will just have their regular default values.
1863So a defaults file can be as simple as one line:
1871Default files can be placed in the \f[C]defaults\f[R] subdirectory of
1872the user data directory and used from any directory.
1873For example, one could create a file specifying defaults for writing
1874letters, save it as \f[C]letter.yaml\f[R] in the \f[C]defaults\f[R]
1875subdirectory of the user data directory, and then invoke these defaults
1876from any directory using \f[C]pandoc --defaults letter\f[R] or
1877\f[C]pandoc -dletter\f[R].
1879When multiple defaults are used, their contents will be combined.
1881Note that, where command-line arguments may be repeated
1882(\f[C]--metadata-file\f[R], \f[C]--css\f[R],
1883\f[C]--include-in-header\f[R], \f[C]--include-before-body\f[R],
1884\f[C]--include-after-body\f[R], \f[C]--variable\f[R],
1885\f[C]--metadata\f[R], \f[C]--syntax-definition\f[R]), the values
1886specified on the command line will combine with values specified in the
1887defaults file, rather than replacing them.
1890When the \f[C]-s/--standalone\f[R] option is used, pandoc uses a
1891template to add header and footer material that is needed for a
1892self-standing document.
1893To see the default template that is used, just type
1901where \f[I]FORMAT\f[R] is the name of the output format.
1902A custom template can be specified using the \f[C]--template\f[R]
1904You can also override the system default templates for a given output
1905format \f[I]FORMAT\f[R] by putting a file
1906\f[C]templates/default.*FORMAT*\f[R] in the user data directory (see
1907\f[C]--data-dir\f[R], above).
1908\f[I]Exceptions:\f[R]
1910For \f[C]odt\f[R] output, customize the \f[C]default.opendocument\f[R]
1913For \f[C]pdf\f[R] output, customize the \f[C]default.latex\f[R] template
1914(or the \f[C]default.context\f[R] template, if you use
1915\f[C]-t context\f[R], or the \f[C]default.ms\f[R] template, if you use
1916\f[C]-t ms\f[R], or the \f[C]default.html\f[R] template, if you use
1919\f[C]docx\f[R] and \f[C]pptx\f[R] have no template (however, you can use
1920\f[C]--reference-doc\f[R] to customize the output).
1922Templates contain \f[I]variables\f[R], which allow for the inclusion of
1923arbitrary information at any point in the file.
1924They may be set at the command line using the \f[C]-V/--variable\f[R]
1926If a variable is not set, pandoc will look for the key in the
1927document\[cq]s metadata, which can be set using either YAML metadata
1928blocks or with the \f[C]-M/--metadata\f[R] option.
1929In addition, some variables are given default values by pandoc.
1930See Variables below for a list of variables used in pandoc\[cq]s default
1933If you use custom templates, you may need to revise them as pandoc
1935We recommend tracking the changes in the default templates, and
1936modifying your custom templates accordingly.
1937An easy way to do this is to fork the pandoc-templates repository and
1938merge in changes after each pandoc release.
1942Anything between the sequence \f[C]$--\f[R] and the end of the line will
1943be treated as a comment and omitted from the output.
1946To mark variables and control structures in the template, either
1947\f[C]$\f[R]\&...\f[C]$\f[R] or \f[C]${\f[R]\&...\f[C]}\f[R] may be used
1949The styles may also be mixed in the same template, but the opening and
1950closing delimiter must match in each case.
1951The opening delimiter may be followed by one or more spaces or tabs,
1952which will be ignored.
1953The closing delimiter may be followed by one or more spaces or tabs,
1954which will be ignored.
1956To include a literal \f[C]$\f[R] in the document, use \f[C]$$\f[R].
1957.SS Interpolated variables
1959A slot for an interpolated variable is a variable name surrounded by
1961Variable names must begin with a letter and can contain letters,
1962numbers, \f[C]_\f[R], \f[C]-\f[R], and \f[C].\f[R].
1963The keywords \f[C]it\f[R], \f[C]if\f[R], \f[C]else\f[R],
1964\f[C]endif\f[R], \f[C]for\f[R], \f[C]sep\f[R], and \f[C]endfor\f[R] may
1965not be used as variable names.
1981Variable names with periods are used to get at structured variable
1983So, for example, \f[C]employee.salary\f[R] will return the value of the
1984\f[C]salary\f[R] field of the object that is the value of the
1985\f[C]employee\f[R] field.
1987If the value of the variable is simple value, it will be rendered
1989(Note that no escaping is done; the assumption is that the calling
1990program will escape the strings appropriately for the output format.)
1992If the value is a list, the values will be concatenated.
1994If the value is a map, the string \f[C]true\f[R] will be rendered.
1996Every other value will be rendered as the empty string.
1999A conditional begins with \f[C]if(variable)\f[R] (enclosed in matched
2000delimiters) and ends with \f[C]endif\f[R] (enclosed in matched
2002It may optionally contain an \f[C]else\f[R] (enclosed in matched
2004The \f[C]if\f[R] section is used if \f[C]variable\f[R] has a non-empty
2005value, otherwise the \f[C]else\f[R] section is used (if present).
2022${if(foo)}bar${endif}
2036The keyword \f[C]elseif\f[R] may be used to simplify complex nested
2052A for loop begins with \f[C]for(variable)\f[R] (enclosed in matched
2053delimiters) and ends with \f[C]endfor\f[R] (enclosed in matched
2056If \f[C]variable\f[R] is an array, the material inside the loop will be
2057evaluated repeatedly, with \f[C]variable\f[R] being set to each value of
2058the array in turn, and concatenated.
2060If \f[C]variable\f[R] is a map, the material inside will be set to the
2063If the value of the associated variable is not an array or a map, a
2064single iteration will be performed on its value.
2070$for(foo)$$foo$$sep$, $endfor$
2073 - $foo.last$, $foo.first$
2077 - ${ foo.bar.last }, ${ foo.bar.first }
2081$it.name$: $it.office$
2086You may optionally specify a separator between consecutive values using
2087\f[C]sep\f[R] (enclosed in matched delimiters).
2088The material between \f[C]sep\f[R] and the \f[C]endfor\f[R] is the
2093${ for(foo) }${ foo }${ sep }, ${ endfor }
2097Instead of using \f[C]variable\f[R] inside the loop, the special
2098anaphoric keyword \f[C]it\f[R] may be used.
2103 - ${ it.last }, ${ it.first }
2109Partials (subtemplates stored in different files) may be included by
2110using the name of the partial, followed by \f[C]()\f[R], for example:
2118Partials will be sought in the directory containing the main template.
2119The file name will be assumed to have the same extension as the main
2120template if it lacks an extension.
2121When calling the partial, the full name including file extension can
2130(If a partial is not found in the directory of the template, it will
2131also be sought in the \f[C]templates\f[R] subdirectory of the user data
2134Partials may optionally be applied to variables using a colon:
2140${ articles:bibentry() }
2144If \f[C]articles\f[R] is an array, this will iterate over its values,
2145applying the partial \f[C]bibentry()\f[R] to each one.
2146So the second example above is equivalent to
2156Note that the anaphoric keyword \f[C]it\f[R] must be used when iterating
2158In the above examples, the \f[C]bibentry\f[R] partial should contain
2159\f[C]it.title\f[R] (and so on) instead of \f[C]articles.title\f[R].
2161Final newlines are omitted from included partials.
2163Partials may include other partials.
2165A separator between values of an array may be specified in square
2166brackets, immediately after the variable name or partial:
2172${articles:bibentry()[; ]$
2176The separator in this case is literal and (unlike with \f[C]sep\f[R] in
2177an explicit \f[C]for\f[R] loop) cannot contain interpolated variables or
2178other template directives.
2181To ensure that content is \[lq]nested,\[rq] that is, subsequent lines
2182indented, use the \f[C]\[ha]\f[R] directive:
2186$item.number$ $\[ha]$$item.description$ ($item.price$)
2190In this example, if \f[C]item.description\f[R] has multiple lines, they
2191will all be indented to line up with the first line:
219500123 A fine bottle of 18-year old
2196 Oban whiskey. ($148)
2200To nest multiple lines to the same level, align them with the
2201\f[C]\[ha]\f[R] directive in the template.
2206$item.number$ $\[ha]$$item.description$ ($item.price$)
2207 (Available til $item.sellby$.)
221500123 A fine bottle of 18-year old
2216 Oban whiskey. ($148)
2217 (Available til March 30, 2020.)
2221If a variable occurs by itself on a line, preceded by whitespace and not
2222followed by further text or directives on the same line, and the
2223variable\[cq]s value contains multiple lines, it will be nested
2227Normally, spaces in the template itself (as opposed to values of the
2228interpolated variables) are not breakable, but they can be made
2229breakable in part of the template by using the \f[C]\[ti]\f[R] keyword
2230(ended with another \f[C]\[ti]\f[R]).
2234$\[ti]$This long line may break if the document is rendered
2235with a short line length.$\[ti]$
2240A pipe transforms the value of a variable or partial.
2241Pipes are specified using a slash (\f[C]/\f[R]) between the variable
2242name (or partial) and the pipe name.
2251$for(metadata/pairs)$
2252- $it.key$: $it.value$
2255$employee:name()/uppercase$
2259Pipes may be chained:
2263$for(employees/pairs)$
2264$it.key/alpha/uppercase$. $it.name$
2269Some pipes take parameters:
2273|----------------------|------------|
2275$it.name.first/uppercase/left 20 \[dq]| \[dq]$$it.name.salary/right 10 \[dq] | \[dq] \[dq] |\[dq]$
2277|----------------------|------------|
2281Currently the following pipes are predefined:
2283\f[C]pairs\f[R]: Converts a map or array to an array of maps, each with
2284\f[C]key\f[R] and \f[C]value\f[R] fields.
2285If the original value was an array, the \f[C]key\f[R] will be the array
2286index, starting with 1.
2288\f[C]uppercase\f[R]: Converts text to uppercase.
2290\f[C]lowercase\f[R]: Converts text to lowercase.
2292\f[C]length\f[R]: Returns the length of the value: number of characters
2293for a textual value, number of elements for a map or array.
2295\f[C]reverse\f[R]: Reverses a textual value or array, and has no effect
2298\f[C]first\f[R]: Returns the first value of an array, if applied to a
2299non-empty array; otherwise returns the original value.
2301\f[C]last\f[R]: Returns the last value of an array, if applied to a
2302non-empty array; otherwise returns the original value.
2304\f[C]rest\f[R]: Returns all but the first value of an array, if applied
2305to a non-empty array; otherwise returns the original value.
2307\f[C]allbutlast\f[R]: Returns all but the last value of an array, if
2308applied to a non-empty array; otherwise returns the original value.
2310\f[C]chomp\f[R]: Removes trailing newlines (and breakable space).
2312\f[C]nowrap\f[R]: Disables line wrapping on breakable spaces.
2314\f[C]alpha\f[R]: Converts textual values that can be read as an integer
2315into lowercase alphabetic characters \f[C]a..z\f[R] (mod 26).
2316This can be used to get lettered enumeration from array indices.
2317To get uppercase letters, chain with \f[C]uppercase\f[R].
2319\f[C]roman\f[R]: Converts textual values that can be read as an integer
2320into lowercase roman numerials.
2321This can be used to get lettered enumeration from array indices.
2322To get uppercase roman, chain with \f[C]uppercase\f[R].
2324\f[C]left n \[dq]leftborder\[dq] \[dq]rightborder\[dq]\f[R]: Renders a
2325textual value in a block of width \f[C]n\f[R], aligned to the left, with
2326an optional left and right border.
2327Has no effect on other values.
2328This can be used to align material in tables.
2329Widths are positive integers indicating the number of characters.
2330Borders are strings inside double quotes; literal \f[C]\[dq]\f[R] and
2331\f[C]\[rs]\f[R] characters must be backslash-escaped.
2333\f[C]right n \[dq]leftborder\[dq] \[dq]rightborder\[dq]\f[R]: Renders a
2334textual value in a block of width \f[C]n\f[R], aligned to the right, and
2335has no effect on other values.
2337\f[C]center n \[dq]leftborder\[dq] \[dq]rightborder\[dq]\f[R]: Renders a
2338textual value in a block of width \f[C]n\f[R], aligned to the center,
2339and has no effect on other values.
2341.SS Metadata variables
2343\f[B]\f[CB]title\f[B]\f[R], \f[B]\f[CB]author\f[B]\f[R], \f[B]\f[CB]date\f[B]\f[R]
2344allow identification of basic aspects of the document.
2345Included in PDF metadata through LaTeX and ConTeXt.
2346These can be set through a pandoc title block, which allows for multiple
2347authors, or through a YAML metadata block:
2360Note that if you just want to set PDF or HTML metadata, without
2361including a title block in the document itself, you can set the
2362\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
2364(By default these are set automatically, based on \f[C]title\f[R],
2365\f[C]author\f[R], and \f[C]date\f[R].)
2368\f[B]\f[CB]subtitle\f[B]\f[R]
2369document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2372\f[B]\f[CB]abstract\f[B]\f[R]
2373document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2376\f[B]\f[CB]keywords\f[B]\f[R]
2377list of keywords to be included in HTML, PDF, ODT, pptx, docx and
2378AsciiDoc metadata; repeat as for \f[C]author\f[R], above
2380\f[B]\f[CB]subject\f[B]\f[R]
2381document subject, included in ODT, PDF, docx and pptx metadata
2383\f[B]\f[CB]description\f[B]\f[R]
2384document description, included in ODT, docx and pptx metadata.
2385Some applications show this as \f[C]Comments\f[R] metadata.
2387\f[B]\f[CB]category\f[B]\f[R]
2388document category, included in docx and pptx metadata
2390Additionally, any root-level string metadata, not included in ODT, docx
2391or pptx metadata is added as a \f[I]custom property\f[R].
2392The following YAML metadata block for instance:
2397title: \[aq]This is the title\[aq]
2398subtitle: \[dq]This is the subtitle\[dq]
2406 It consists of two paragraphs
2411will include \f[C]title\f[R], \f[C]author\f[R] and \f[C]description\f[R]
2412as standard document properties and \f[C]subtitle\f[R] as a custom
2413property when converting to docx, ODT or pptx.
2414.SS Language variables
2416\f[B]\f[CB]lang\f[B]\f[R]
2417identifies the main language of the document using IETF language tags
2418(following the BCP 47 standard), such as \f[C]en\f[R] or
2420The Language subtag lookup tool can look up or verify these tags.
2421This affects most formats, and controls hyphenation in PDF output when
2422using LaTeX (through \f[C]babel\f[R] and \f[C]polyglossia\f[R]) or
2426Use native pandoc Divs and Spans with the \f[C]lang\f[R] attribute to
2435Text in the main document language (British English).
2438> Cette citation est \['e]crite en fran\[,c]ais canadien.
2441More text in English. [\[aq]Zitat auf Deutsch.\[aq]]{lang=de}
2446\f[B]\f[CB]dir\f[B]\f[R]
2447the base script direction, either \f[C]rtl\f[R] (right-to-left) or
2448\f[C]ltr\f[R] (left-to-right).
2451For bidirectional documents, native pandoc \f[C]span\f[R]s and
2452\f[C]div\f[R]s with the \f[C]dir\f[R] attribute (value \f[C]rtl\f[R] or
2453\f[C]ltr\f[R]) can be used to override the base direction in some output
2455This may not always be necessary if the final renderer (e.g.\ the
2456browser, when generating HTML) supports the Unicode Bidirectional
2459When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[R]
2460engine is fully supported (use \f[C]--pdf-engine=xelatex\f[R]).
2462.SS Variables for HTML
2464\f[B]\f[CB]document-css\f[B]\f[R]
2465Enables inclusion of most of the CSS in the \f[C]styles.html\f[R]
2466partial (have a look with
2467\f[C]pandoc --print-default-data-file=templates/styles.html\f[R]).
2468Unless you use \f[C]--css\f[R], this variable is set to \f[C]true\f[R]
2470You can disable it with e.g.\ \f[C]pandoc -M document-css=false\f[R].
2472\f[B]\f[CB]mainfont\f[B]\f[R]
2473sets the CSS \f[C]font-family\f[R] property on the \f[C]html\f[R]
2476\f[B]\f[CB]fontsize\f[B]\f[R]
2477sets the base CSS \f[C]font-size\f[R], which you\[cq]d usually set to
2478e.g.\ \f[C]20px\f[R], but it also accepts \f[C]pt\f[R] (12pt = 16px in
2481\f[B]\f[CB]fontcolor\f[B]\f[R]
2482sets the CSS \f[C]color\f[R] property on the \f[C]html\f[R] element.
2484\f[B]\f[CB]linkcolor\f[B]\f[R]
2485sets the CSS \f[C]color\f[R] property on all links.
2487\f[B]\f[CB]monofont\f[B]\f[R]
2488sets the CSS \f[C]font-family\f[R] property on \f[C]code\f[R] elements.
2490\f[B]\f[CB]linestretch\f[B]\f[R]
2491sets the CSS \f[C]line-height\f[R] property on the \f[C]html\f[R]
2492element, which is preferred to be unitless.
2494\f[B]\f[CB]backgroundcolor\f[B]\f[R]
2495sets the CSS \f[C]background-color\f[R] property on the \f[C]html\f[R]
2498\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2499sets the corresponding CSS \f[C]padding\f[R] properties on the
2500\f[C]body\f[R] element.
2501.SS Variables for HTML math
2503\f[B]\f[CB]classoption\f[B]\f[R]
2504when using KaTeX, you can render display math equations flush left using
2505YAML metadata or with \f[C]-M classoption=fleqn\f[R].
2506.SS Variables for HTML slides
2508These affect HTML output when [producing slide shows with pandoc].
2510All reveal.js configuration options are available as variables.
2511To turn off boolean flags that default to true in reveal.js, use
2514\f[B]\f[CB]revealjs-url\f[B]\f[R]
2515base URL for reveal.js documents (defaults to
2516\f[C]https://unpkg.com/reveal.js\[at]\[ha]4/\f[R])
2518\f[B]\f[CB]s5-url\f[B]\f[R]
2519base URL for S5 documents (defaults to \f[C]s5/default\f[R])
2521\f[B]\f[CB]slidy-url\f[B]\f[R]
2522base URL for Slidy documents (defaults to
2523\f[C]https://www.w3.org/Talks/Tools/Slidy2\f[R])
2525\f[B]\f[CB]slideous-url\f[B]\f[R]
2526base URL for Slideous documents (defaults to \f[C]slideous\f[R])
2528\f[B]\f[CB]title-slide-attributes\f[B]\f[R]
2529additional attributes for the title slide of reveal.js slide shows.
2530See background in reveal.js and beamer for an example.
2531.SS Variables for Beamer slides
2533These variables change the appearance of PDF slides using
2536\f[B]\f[CB]aspectratio\f[B]\f[R]
2537slide aspect ratio (\f[C]43\f[R] for 4:3 [default], \f[C]169\f[R] for
253816:9, \f[C]1610\f[R] for 16:10, \f[C]149\f[R] for 14:9, \f[C]141\f[R]
2539for 1.41:1, \f[C]54\f[R] for 5:4, \f[C]32\f[R] for 3:2)
2541\f[B]\f[CB]beamerarticle\f[B]\f[R]
2542produce an article from Beamer slides
2544\f[B]\f[CB]beameroption\f[B]\f[R]
2545add extra beamer option with \f[C]\[rs]setbeameroption{}\f[R]
2547\f[B]\f[CB]institute\f[B]\f[R]
2548author affiliations: can be a list when there are multiple authors
2550\f[B]\f[CB]logo\f[B]\f[R]
2551logo image for slides
2553\f[B]\f[CB]navigation\f[B]\f[R]
2554controls navigation symbols (default is \f[C]empty\f[R] for no
2555navigation symbols; other valid values are \f[C]frame\f[R],
2556\f[C]vertical\f[R], and \f[C]horizontal\f[R])
2558\f[B]\f[CB]section-titles\f[B]\f[R]
2559enables \[lq]title pages\[rq] for new sections (default is true)
2561\f[B]\f[CB]theme\f[B]\f[R], \f[B]\f[CB]colortheme\f[B]\f[R], \f[B]\f[CB]fonttheme\f[B]\f[R], \f[B]\f[CB]innertheme\f[B]\f[R], \f[B]\f[CB]outertheme\f[B]\f[R]
2564\f[B]\f[CB]themeoptions\f[B]\f[R]
2565options for LaTeX beamer themes (a list).
2567\f[B]\f[CB]titlegraphic\f[B]\f[R]
2568image for title slide
2569.SS Variables for PowerPoint
2571These variables control the visual aspects of a slide show that are not
2572easily controlled via templates.
2574\f[B]\f[CB]monofont\f[B]\f[R]
2575font to use for code.
2576.SS Variables for LaTeX
2578Pandoc uses these variables when creating a PDF with a LaTeX engine.
2581\f[B]\f[CB]block-headings\f[B]\f[R]
2582make \f[C]\[rs]paragraph\f[R] and \f[C]\[rs]subparagraph\f[R] (fourth-
2583and fifth-level headings, or fifth- and sixth-level with book classes)
2584free-standing rather than run-in; requires further formatting to
2585distinguish from \f[C]\[rs]subsubsection\f[R] (third- or fourth-level
2587Instead of using this option, KOMA-Script can adjust headings more
2594documentclass: scrartcl
2596 \[rs]RedeclareSectionCommand[
2597 beforeskip=-10pt plus -2pt minus -1pt,
2598 afterskip=1sp plus -1sp minus 1sp,
2599 font=\[rs]normalfont\[rs]itshape]{paragraph}
2600 \[rs]RedeclareSectionCommand[
2601 beforeskip=-10pt plus -2pt minus -1pt,
2602 afterskip=1sp plus -1sp minus 1sp,
2603 font=\[rs]normalfont\[rs]scshape,
2604 indent=0pt]{subparagraph}
2610\f[B]\f[CB]classoption\f[B]\f[R]
2611option for document class, e.g.\ \f[C]oneside\f[R]; repeat for multiple
2626\f[B]\f[CB]documentclass\f[B]\f[R]
2627document class: usually one of the standard classes, \f[C]article\f[R],
2628\f[C]book\f[R], and \f[C]report\f[R]; the KOMA-Script equivalents,
2629\f[C]scrartcl\f[R], \f[C]scrbook\f[R], and \f[C]scrreprt\f[R], which
2630default to smaller margins; or \f[C]memoir\f[R]
2632\f[B]\f[CB]geometry\f[B]\f[R]
2633option for \f[C]geometry\f[R] package, e.g.\ \f[C]margin=1in\f[R];
2634repeat for multiple options:
2649\f[B]\f[CB]hyperrefoptions\f[B]\f[R]
2650option for \f[C]hyperref\f[R] package, e.g.\ \f[C]linktoc=all\f[R];
2651repeat for multiple options:
2660- pdfpagemode=FullScreen
2666\f[B]\f[CB]indent\f[B]\f[R]
2667uses document class settings for indentation (the default LaTeX template
2668otherwise removes indentation and adds space between paragraphs)
2670\f[B]\f[CB]linestretch\f[B]\f[R]
2671adjusts line spacing using the \f[C]setspace\f[R] package,
2672e.g.\ \f[C]1.25\f[R], \f[C]1.5\f[R]
2674\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2675sets margins if \f[C]geometry\f[R] is not used (otherwise
2676\f[C]geometry\f[R] overrides these)
2678\f[B]\f[CB]pagestyle\f[B]\f[R]
2679control \f[C]\[rs]pagestyle{}\f[R]: the default article class supports
2680\f[C]plain\f[R] (default), \f[C]empty\f[R] (no running heads or page
2681numbers), and \f[C]headings\f[R] (section titles in running heads)
2683\f[B]\f[CB]papersize\f[B]\f[R]
2684paper size, e.g.\ \f[C]letter\f[R], \f[C]a4\f[R]
2686\f[B]\f[CB]secnumdepth\f[B]\f[R]
2687numbering depth for sections (with \f[C]--number-sections\f[R] option or
2688\f[C]numbersections\f[R] variable)
2691\f[B]\f[CB]fontenc\f[B]\f[R]
2692allows font encoding to be specified through \f[C]fontenc\f[R] package
2693(with \f[C]pdflatex\f[R]); default is \f[C]T1\f[R] (see LaTeX font
2696\f[B]\f[CB]fontfamily\f[B]\f[R]
2697font package for use with \f[C]pdflatex\f[R]: TeX Live includes many
2698options, documented in the LaTeX Font Catalogue.
2699The default is Latin Modern.
2701\f[B]\f[CB]fontfamilyoptions\f[B]\f[R]
2702options for package used as \f[C]fontfamily\f[R]; repeat for multiple
2704For example, to use the Libertine font with proportional lowercase
2705(old-style) figures through the \f[C]libertinus\f[R] package:
2711fontfamily: libertinus
2720\f[B]\f[CB]fontsize\f[B]\f[R]
2721font size for body text.
2722The standard classes allow 10pt, 11pt, and 12pt.
2723To use another size, set \f[C]documentclass\f[R] to one of the
2724KOMA-Script classes, such as \f[C]scrartcl\f[R] or \f[C]scrbook\f[R].
2726\f[B]\f[CB]mainfont\f[B]\f[R], \f[B]\f[CB]sansfont\f[B]\f[R], \f[B]\f[CB]monofont\f[B]\f[R], \f[B]\f[CB]mathfont\f[B]\f[R], \f[B]\f[CB]CJKmainfont\f[B]\f[R]
2727font families for use with \f[C]xelatex\f[R] or \f[C]lualatex\f[R]: take
2728the name of any system font, using the \f[C]fontspec\f[R] package.
2729\f[C]CJKmainfont\f[R] uses the \f[C]xecjk\f[R] package.
2731\f[B]\f[CB]mainfontoptions\f[B]\f[R], \f[B]\f[CB]sansfontoptions\f[B]\f[R], \f[B]\f[CB]monofontoptions\f[B]\f[R], \f[B]\f[CB]mathfontoptions\f[B]\f[R], \f[B]\f[CB]CJKoptions\f[B]\f[R]
2732options to use with \f[C]mainfont\f[R], \f[C]sansfont\f[R],
2733\f[C]monofont\f[R], \f[C]mathfont\f[R], \f[C]CJKmainfont\f[R] in
2734\f[C]xelatex\f[R] and \f[C]lualatex\f[R].
2735Allow for any choices available through \f[C]fontspec\f[R]; repeat for
2737For example, to use the TeX Gyre version of Palatino with lowercase
2744mainfont: TeX Gyre Pagella
2747- Numbers=Proportional
2753\f[B]\f[CB]microtypeoptions\f[B]\f[R]
2754options to pass to the microtype package
2757\f[B]\f[CB]colorlinks\f[B]\f[R]
2758add color to link text; automatically enabled if any of
2759\f[C]linkcolor\f[R], \f[C]filecolor\f[R], \f[C]citecolor\f[R],
2760\f[C]urlcolor\f[R], or \f[C]toccolor\f[R] are set
2762\f[B]\f[CB]linkcolor\f[B]\f[R], \f[B]\f[CB]filecolor\f[B]\f[R], \f[B]\f[CB]citecolor\f[B]\f[R], \f[B]\f[CB]urlcolor\f[B]\f[R], \f[B]\f[CB]toccolor\f[B]\f[R]
2763color for internal links, external links, citation links, linked URLs,
2764and links in table of contents, respectively: uses options allowed by
2765\f[C]xcolor\f[R], including the \f[C]dvipsnames\f[R],
2766\f[C]svgnames\f[R], and \f[C]x11names\f[R] lists
2768\f[B]\f[CB]links-as-notes\f[B]\f[R]
2769causes links to be printed as footnotes
2772\f[B]\f[CB]lof\f[B]\f[R], \f[B]\f[CB]lot\f[B]\f[R]
2773include list of figures, list of tables
2775\f[B]\f[CB]thanks\f[B]\f[R]
2776contents of acknowledgments footnote after document title
2778\f[B]\f[CB]toc\f[B]\f[R]
2779include table of contents (can also be set using
2780\f[C]--toc/--table-of-contents\f[R])
2782\f[B]\f[CB]toc-depth\f[B]\f[R]
2783level of section to include in table of contents
2784.SS BibLaTeX Bibliographies
2786These variables function when using BibLaTeX for citation rendering.
2788\f[B]\f[CB]biblatexoptions\f[B]\f[R]
2789list of options for biblatex
2791\f[B]\f[CB]biblio-style\f[B]\f[R]
2792bibliography style, when used with \f[C]--natbib\f[R] and
2793\f[C]--biblatex\f[R].
2795\f[B]\f[CB]biblio-title\f[B]\f[R]
2796bibliography title, when used with \f[C]--natbib\f[R] and
2797\f[C]--biblatex\f[R].
2799\f[B]\f[CB]bibliography\f[B]\f[R]
2800bibliography to use for resolving references
2802\f[B]\f[CB]natbiboptions\f[B]\f[R]
2803list of options for natbib
2804.SS Variables for ConTeXt
2806Pandoc uses these variables when creating a PDF with ConTeXt.
2808\f[B]\f[CB]fontsize\f[B]\f[R]
2809font size for body text (e.g.\ \f[C]10pt\f[R], \f[C]12pt\f[R])
2811\f[B]\f[CB]headertext\f[B]\f[R], \f[B]\f[CB]footertext\f[B]\f[R]
2812text to be placed in running header or footer (see ConTeXt Headers and
2813Footers); repeat up to four times for different placement
2815\f[B]\f[CB]indenting\f[B]\f[R]
2816controls indentation of paragraphs, e.g.\ \f[C]yes,small,next\f[R] (see
2817ConTeXt Indentation); repeat for multiple options
2819\f[B]\f[CB]interlinespace\f[B]\f[R]
2820adjusts line spacing, e.g.\ \f[C]4ex\f[R] (using
2821\f[C]setupinterlinespace\f[R]); repeat for multiple options
2823\f[B]\f[CB]layout\f[B]\f[R]
2824options for page margins and text arrangement (see ConTeXt Layout);
2825repeat for multiple options
2827\f[B]\f[CB]linkcolor\f[B]\f[R], \f[B]\f[CB]contrastcolor\f[B]\f[R]
2828color for links outside and inside a page, e.g.\ \f[C]red\f[R],
2829\f[C]blue\f[R] (see ConTeXt Color)
2831\f[B]\f[CB]linkstyle\f[B]\f[R]
2832typeface style for links, e.g.\ \f[C]normal\f[R], \f[C]bold\f[R],
2833\f[C]slanted\f[R], \f[C]boldslanted\f[R], \f[C]type\f[R], \f[C]cap\f[R],
2836\f[B]\f[CB]lof\f[B]\f[R], \f[B]\f[CB]lot\f[B]\f[R]
2837include list of figures, list of tables
2839\f[B]\f[CB]mainfont\f[B]\f[R], \f[B]\f[CB]sansfont\f[B]\f[R], \f[B]\f[CB]monofont\f[B]\f[R], \f[B]\f[CB]mathfont\f[B]\f[R]
2840font families: take the name of any system font (see ConTeXt Font
2843\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2844sets margins, if \f[C]layout\f[R] is not used (otherwise
2845\f[C]layout\f[R] overrides these)
2847\f[B]\f[CB]pagenumbering\f[B]\f[R]
2848page number style and location (using \f[C]setuppagenumbering\f[R]);
2849repeat for multiple options
2851\f[B]\f[CB]papersize\f[B]\f[R]
2852paper size, e.g.\ \f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R]
2853(see ConTeXt Paper Setup); repeat for multiple options
2855\f[B]\f[CB]pdfa\f[B]\f[R]
2856adds to the preamble the setup necessary to generate PDF/A of the type
2857specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R].
2858If no type is specified (i.e.\ the value is set to True, by
2859e.g.\ \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML
2860metadata block), \f[C]1b:2005\f[R] will be used as default, for reasons
2861of backwards compatibility.
2862Using \f[C]--variable=pdfa\f[R] without specified value is not
2864To successfully generate PDF/A the required ICC color profiles have to
2865be available and the content and all included files (such as images)
2866have to be standard conforming.
2867The ICC profiles and output intent may be specified using the variables
2868\f[C]pdfaiccprofile\f[R] and \f[C]pdfaintent\f[R].
2869See also ConTeXt PDFA for more details.
2871\f[B]\f[CB]pdfaiccprofile\f[B]\f[R]
2872when used in conjunction with \f[C]pdfa\f[R], specifies the ICC profile
2873to use in the PDF, e.g.\ \f[C]default.cmyk\f[R].
2874If left unspecified, \f[C]sRGB.icc\f[R] is used as default.
2875May be repeated to include multiple profiles.
2876Note that the profiles have to be available on the system.
2877They can be obtained from ConTeXt ICC Profiles.
2879\f[B]\f[CB]pdfaintent\f[B]\f[R]
2880when used in conjunction with \f[C]pdfa\f[R], specifies the output
2881intent for the colors,
2882e.g.\ \f[C]ISO coated v2 300\[rs]letterpercent\[rs]space (ECI)\f[R] If
2883left unspecified, \f[C]sRGB IEC61966-2.1\f[R] is used as default.
2885\f[B]\f[CB]toc\f[B]\f[R]
2886include table of contents (can also be set using
2887\f[C]--toc/--table-of-contents\f[R])
2889\f[B]\f[CB]whitespace\f[B]\f[R]
2890spacing between paragraphs, e.g.\ \f[C]none\f[R], \f[C]small\f[R] (using
2891\f[C]setupwhitespace\f[R])
2893\f[B]\f[CB]includesource\f[B]\f[R]
2894include all source documents as file attachments in the PDF file
2895.SS Variables for \f[C]wkhtmltopdf\f[R]
2897Pandoc uses these variables when creating a PDF with
2898\f[C]wkhtmltopdf\f[R].
2899The \f[C]--css\f[R] option also affects the output.
2901\f[B]\f[CB]footer-html\f[B]\f[R], \f[B]\f[CB]header-html\f[B]\f[R]
2902add information to the header and footer
2904\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2907\f[B]\f[CB]papersize\f[B]\f[R]
2908sets the PDF paper size
2909.SS Variables for man pages
2911\f[B]\f[CB]adjusting\f[B]\f[R]
2912adjusts text to left (\f[C]l\f[R]), right (\f[C]r\f[R]), center
2913(\f[C]c\f[R]), or both (\f[C]b\f[R]) margins
2915\f[B]\f[CB]footer\f[B]\f[R]
2918\f[B]\f[CB]header\f[B]\f[R]
2921\f[B]\f[CB]hyphenate\f[B]\f[R]
2922if \f[C]true\f[R] (the default), hyphenation will be used
2924\f[B]\f[CB]section\f[B]\f[R]
2925section number in man pages
2928\f[B]\f[CB]fontfamily\f[B]\f[R]
2929font family (e.g.\ \f[C]T\f[R] or \f[C]P\f[R])
2931\f[B]\f[CB]indent\f[B]\f[R]
2932paragraph indent (e.g.\ \f[C]2m\f[R])
2934\f[B]\f[CB]lineheight\f[B]\f[R]
2935line height (e.g.\ \f[C]12p\f[R])
2937\f[B]\f[CB]pointsize\f[B]\f[R]
2938point size (e.g.\ \f[C]10p\f[R])
2939.SS Variables set automatically
2941Pandoc sets these variables automatically in response to options or
2942document contents; users can also modify them.
2943These vary depending on the output format, and include the following:
2945\f[B]\f[CB]body\f[B]\f[R]
2948\f[B]\f[CB]date-meta\f[B]\f[R]
2949the \f[C]date\f[R] variable converted to ISO 8601 YYYY-MM-DD, included
2950in all HTML based formats (dzslides, epub, html, html4, html5, revealjs,
2951s5, slideous, slidy).
2952The recognized formats for \f[C]date\f[R] are: \f[C]mm/dd/yyyy\f[R],
2953\f[C]mm/dd/yy\f[R], \f[C]yyyy-mm-dd\f[R] (ISO 8601),
2954\f[C]dd MM yyyy\f[R] (e.g.\ either \f[C]02 Apr 2018\f[R] or
2955\f[C]02 April 2018\f[R]), \f[C]MM dd, yyyy\f[R]
2956(e.g.\ \f[C]Apr. 02, 2018\f[R] or
2957\f[C]April 02, 2018),\f[R]yyyy[mm[dd]]]\f[C](e.g.\f[R]20180402,
2958\f[C]201804\f[R] or \f[C]2018\f[R]).
2960\f[B]\f[CB]header-includes\f[B]\f[R]
2961contents specified by \f[C]-H/--include-in-header\f[R] (may have
2964\f[B]\f[CB]include-before\f[B]\f[R]
2965contents specified by \f[C]-B/--include-before-body\f[R] (may have
2968\f[B]\f[CB]include-after\f[B]\f[R]
2969contents specified by \f[C]-A/--include-after-body\f[R] (may have
2972\f[B]\f[CB]meta-json\f[B]\f[R]
2973JSON representation of all of the document\[cq]s metadata.
2974Field values are transformed to the selected output format.
2976\f[B]\f[CB]numbersections\f[B]\f[R]
2977non-null value if \f[C]-N/--number-sections\f[R] was specified
2979\f[B]\f[CB]sourcefile\f[B]\f[R], \f[B]\f[CB]outputfile\f[B]\f[R]
2980source and destination filenames, as given on the command line.
2981\f[C]sourcefile\f[R] can also be a list if input comes from multiple
2982files, or empty if input is from stdin.
2983You can use the following snippet in your template to distinguish them:
2998Similarly, \f[C]outputfile\f[R] can be \f[C]-\f[R] if output goes to the
3001If you need absolute paths, use e.g.\ \f[C]$curdir$/$sourcefile$\f[R].
3004\f[B]\f[CB]curdir\f[B]\f[R]
3005working directory from which pandoc is run.
3007\f[B]\f[CB]toc\f[B]\f[R]
3008non-null value if \f[C]--toc/--table-of-contents\f[R] was specified
3010\f[B]\f[CB]toc-title\f[B]\f[R]
3011title of table of contents (works only with EPUB, HTML, opendocument,
3012odt, docx, pptx, beamer, LaTeX)
3015The behavior of some of the readers and writers can be adjusted by
3016enabling or disabling various extensions.
3018An extension can be enabled by adding \f[C]+EXTENSION\f[R] to the format
3019name and disabled by adding \f[C]-EXTENSION\f[R].
3020For example, \f[C]--from markdown_strict+footnotes\f[R] is strict
3021Markdown with footnotes enabled, while
3022\f[C]--from markdown-footnotes-pipe_tables\f[R] is pandoc\[cq]s Markdown
3023without footnotes or pipe tables.
3025The markdown reader and writer make by far the most use of extensions.
3026Extensions only used by them are therefore covered in the section
3027Pandoc\[cq]s Markdown below (See Markdown variants for
3028\f[C]commonmark\f[R] and \f[C]gfm\f[R].) In the following, extensions
3029that also work for other formats are covered.
3031Note that markdown extensions added to the \f[C]ipynb\f[R] format affect
3032Markdown cells in Jupyter notebooks (as do command-line options like
3033\f[C]--atx-headers\f[R]).
3035.SS Extension: \f[C]smart\f[R]
3037Interpret straight quotes as curly quotes, \f[C]---\f[R] as em-dashes,
3038\f[C]--\f[R] as en-dashes, and \f[C]...\f[R] as ellipses.
3039Nonbreaking spaces are inserted after certain abbreviations, such as
3042This extension can be enabled/disabled for the following formats:
3045\f[C]markdown\f[R], \f[C]commonmark\f[R], \f[C]latex\f[R],
3046\f[C]mediawiki\f[R], \f[C]org\f[R], \f[C]rst\f[R], \f[C]twiki\f[R]
3049\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]context\f[R], \f[C]rst\f[R]
3051enabled by default in
3052\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]context\f[R] (both input and
3055Note: If you are \f[I]writing\f[R] Markdown, then the \f[C]smart\f[R]
3056extension has the reverse effect: what would have been curly quotes
3059In LaTeX, \f[C]smart\f[R] means to use the standard TeX ligatures for
3060quotation marks (\f[C]\[ga]\[ga]\f[R] and \f[C]\[aq]\[aq]\f[R] for
3061double quotes, \f[C]\[ga]\f[R] and \f[C]\[aq]\f[R] for single quotes)
3062and dashes (\f[C]--\f[R] for en-dash and \f[C]---\f[R] for em-dash).
3063If \f[C]smart\f[R] is disabled, then in reading LaTeX pandoc will parse
3064these characters literally.
3065In writing LaTeX, enabling \f[C]smart\f[R] tells pandoc to use the
3066ligatures when possible; if \f[C]smart\f[R] is disabled pandoc will use
3067unicode quotation mark and dash characters.
3068.SS Headings and sections
3069.SS Extension: \f[C]auto_identifiers\f[R]
3071A heading without an explicitly specified identifier will be
3072automatically assigned a unique identifier based on the heading text.
3074This extension can be enabled/disabled for the following formats:
3077\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]rst\f[R], \f[C]mediawiki\f[R],
3081\f[C]markdown\f[R], \f[C]muse\f[R]
3083enabled by default in
3084\f[C]markdown\f[R], \f[C]muse\f[R]
3086The default algorithm used to derive the identifier from the heading
3089Remove all formatting, links, etc.
3091Remove all footnotes.
3093Remove all non-alphanumeric characters, except underscores, hyphens, and
3096Replace all spaces and newlines with hyphens.
3098Convert all alphabetic characters to lowercase.
3100Remove everything up to the first letter (identifiers may not begin with
3101a number or punctuation mark).
3103If nothing is left after this, use the identifier \f[C]section\f[R].
3117\f[C]Heading identifiers in HTML\f[R]
3119\f[C]heading-identifiers-in-html\f[R]
3122\f[C]Ma\[^i]tre d\[aq]h\[^o]tel\f[R]
3124\f[C]ma\[^i]tre-dh\[^o]tel\f[R]
3127\f[C]*Dogs*?--in *my* house?\f[R]
3129\f[C]dogs--in-my-house\f[R]
3132\f[C][HTML], [S5], or [RTF]?\f[R]
3134\f[C]html-s5-or-rtf\f[R]
3137\f[C]3. Applications\f[R]
3139\f[C]applications\f[R]
3148These rules should, in most cases, allow one to determine the identifier
3149from the heading text.
3150The exception is when several headings have the same text; in this case,
3151the first will get an identifier as described above; the second will get
3152the same identifier with \f[C]-1\f[R] appended; the third with
3153\f[C]-2\f[R]; and so on.
3155(However, a different algorithm is used if
3156\f[C]gfm_auto_identifiers\f[R] is enabled; see below.)
3158These identifiers are used to provide link targets in the table of
3159contents generated by the \f[C]--toc|--table-of-contents\f[R] option.
3160They also make it easy to provide links from one section of a document
3162A link to this section, for example, might look like this:
3167[heading identifiers](#heading-identifiers-in-html-latex-and-context).
3171Note, however, that this method of providing links to sections works
3172only in HTML, LaTeX, and ConTeXt formats.
3174If the \f[C]--section-divs\f[R] option is specified, then each section
3175will be wrapped in a \f[C]section\f[R] (or a \f[C]div\f[R], if
3176\f[C]html4\f[R] was specified), and the identifier will be attached to
3177the enclosing \f[C]<section>\f[R] (or \f[C]<div>\f[R]) tag rather than
3179This allows entire sections to be manipulated using JavaScript or
3180treated differently in CSS.
3181.SS Extension: \f[C]ascii_identifiers\f[R]
3183Causes the identifiers produced by \f[C]auto_identifiers\f[R] to be pure
3185Accents are stripped off of accented Latin letters, and non-Latin
3187.SS Extension: \f[C]gfm_auto_identifiers\f[R]
3189Changes the algorithm used by \f[C]auto_identifiers\f[R] to conform to
3191Spaces are converted to dashes (\f[C]-\f[R]), uppercase characters to
3192lowercase characters, and punctuation characters other than \f[C]-\f[R]
3193and \f[C]_\f[R] are removed.
3194Emojis are replaced by their names.
3197The extensions \f[C]tex_math_dollars\f[R],
3198\f[C]tex_math_single_backslash\f[R], and
3199\f[C]tex_math_double_backslash\f[R] are described in the section about
3200Pandoc\[cq]s Markdown.
3202However, they can also be used with HTML input.
3203This is handy for reading web pages formatted using MathJax, for
3207The following extensions are described in more detail in their
3208respective sections of Pandoc\[cq]s Markdown:
3210\f[C]raw_html\f[R] allows HTML elements which are not representable in
3211pandoc\[cq]s AST to be parsed as raw HTML.
3212By default, this is disabled for HTML input.
3214\f[C]raw_tex\f[R] allows raw LaTeX, TeX, and ConTeXt to be included in a
3216This extension can be enabled/disabled for the following formats (in
3217addition to \f[C]markdown\f[R]):
3221\f[C]latex\f[R], \f[C]org\f[R], \f[C]textile\f[R], \f[C]html\f[R]
3222(environments, \f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only),
3226\f[C]textile\f[R], \f[C]commonmark\f[R]
3228Note: as applied to \f[C]ipynb\f[R], \f[C]raw_html\f[R] and
3229\f[C]raw_tex\f[R] affect not only raw TeX in markdown cells, but data
3230with mime type \f[C]text/html\f[R] in output cells.
3231Since the \f[C]ipynb\f[R] reader attempts to preserve the richest
3232possible outputs when several options are given, you will get best
3233results if you disable \f[C]raw_html\f[R] and \f[C]raw_tex\f[R] when
3234converting to formats like \f[C]docx\f[R] which don\[cq]t allow raw
3235\f[C]html\f[R] or \f[C]tex\f[R].
3238\f[C]native_divs\f[R] causes HTML \f[C]div\f[R] elements to be parsed as
3239native pandoc Div blocks.
3240If you want them to be parsed as raw HTML, use
3241\f[C]-f html-native_divs+raw_html\f[R].
3243\f[C]native_spans\f[R] causes HTML \f[C]span\f[R] elements to be parsed
3244as native pandoc Span inlines.
3245If you want them to be parsed as raw HTML, use
3246\f[C]-f html-native_spans+raw_html\f[R].
3247If you want to drop all \f[C]div\f[R]s and \f[C]span\f[R]s when
3248converting HTML to Markdown, you can use
3249\f[C]pandoc -f html-native_divs-native_spans -t markdown\f[R].
3250.SS Literate Haskell support
3251.SS Extension: \f[C]literate_haskell\f[R]
3253Treat the document as literate Haskell source.
3255This extension can be enabled/disabled for the following formats:
3258\f[C]markdown\f[R], \f[C]rst\f[R], \f[C]latex\f[R]
3261\f[C]markdown\f[R], \f[C]rst\f[R], \f[C]latex\f[R], \f[C]html\f[R]
3263If you append \f[C]+lhs\f[R] (or \f[C]+literate_haskell\f[R]) to one of
3264the formats above, pandoc will treat the document as literate Haskell
3268In Markdown input, \[lq]bird track\[rq] sections will be parsed as
3269Haskell code rather than block quotations.
3270Text between \f[C]\[rs]begin{code}\f[R] and \f[C]\[rs]end{code}\f[R]
3271will also be treated as Haskell code.
3272For ATX-style headings the character `=' will be used instead of `#'.
3274In Markdown output, code blocks with classes \f[C]haskell\f[R] and
3275\f[C]literate\f[R] will be rendered using bird tracks, and block
3276quotations will be indented one space, so they will not be treated as
3278In addition, headings will be rendered setext-style (with underlines)
3279rather than ATX-style (with `#' characters).
3280(This is because ghc treats `#' characters in column 1 as introducing
3283In restructured text input, \[lq]bird track\[rq] sections will be parsed
3286In restructured text output, code blocks with class \f[C]haskell\f[R]
3287will be rendered using bird tracks.
3289In LaTeX input, text in \f[C]code\f[R] environments will be parsed as
3292In LaTeX output, code blocks with class \f[C]haskell\f[R] will be
3293rendered inside \f[C]code\f[R] environments.
3295In HTML output, code blocks with class \f[C]haskell\f[R] will be
3296rendered with class \f[C]literatehaskell\f[R] and bird tracks.
3302pandoc -f markdown+lhs -t html
3306reads literate Haskell source formatted with Markdown conventions and
3307writes ordinary HTML (without bird tracks).
3311pandoc -f markdown+lhs -t html+lhs
3315writes HTML with the Haskell code in bird tracks, so it can be copied
3316and pasted as literate Haskell source.
3318Note that GHC expects the bird tracks in the first column, so indented
3319literate code blocks (e.g.\ inside an itemized environment) will not be
3320picked up by the Haskell compiler.
3322.SS Extension: \f[C]empty_paragraphs\f[R]
3324Allows empty paragraphs.
3325By default empty paragraphs are omitted.
3327This extension can be enabled/disabled for the following formats:
3330\f[C]docx\f[R], \f[C]html\f[R]
3333\f[C]docx\f[R], \f[C]odt\f[R], \f[C]opendocument\f[R], \f[C]html\f[R]
3334.SS Extension: \f[C]native_numbering\f[R]
3336Enables native numbering of figures and tables.
3337Enumeration starts at 1.
3339This extension can be enabled/disabled for the following formats:
3342\f[C]odt\f[R], \f[C]opendocument\f[R]
3343.SS Extension: \f[C]styles\f[R]
3345When converting from docx, read all docx styles as divs (for paragraph
3346styles) and spans (for character styles) regardless of whether pandoc
3347understands the meaning of these styles.
3348This can be used with docx custom styles.
3353.SS Extension: \f[C]amuse\f[R]
3355In the \f[C]muse\f[R] input format, this enables Text::Amuse extensions
3356to Emacs Muse markup.
3357.SS Extension: \f[C]raw_markdown\f[R]
3359In the \f[C]ipynb\f[R] input format, this causes Markdown cells to be
3360included as raw Markdown blocks (allowing lossless round-tripping)
3361rather than being parsed.
3362Use this only when you are targetting \f[C]ipynb\f[R] or a
3363markdown-based output format.
3364.SS Extension: \f[C]citations\f[R]
3366Some aspects of Pandoc\[cq]s Markdown citation syntax are also accepted
3367in \f[C]org\f[R] input.
3368.SS Extension: \f[C]ntb\f[R]
3370In the \f[C]context\f[R] output format this enables the use of Natural
3371Tables (TABLE) instead of the default Extreme Tables (xtables).
3372Natural tables allow more fine-grained global customization but come at
3373a performance penalty compared to extreme tables.
3374.SH PANDOC\[cq]S MARKDOWN
3376Pandoc understands an extended and slightly revised version of John
3377Gruber\[cq]s Markdown syntax.
3378This document explains the syntax, noting differences from standard
3380Except where noted, these differences can be suppressed by using the
3381\f[C]markdown_strict\f[R] format instead of \f[C]markdown\f[R].
3382Extensions can be enabled or disabled to specify the behavior more
3384They are described in the following.
3385See also Extensions above, for extensions that work also on other
3389Markdown is designed to be easy to write, and, even more importantly,
3393A Markdown-formatted document should be publishable as-is, as plain
3394text, without looking like it\[cq]s been marked up with tags or
3395formatting instructions.
3399This principle has guided pandoc\[cq]s decisions in finding syntax for
3400tables, footnotes, and other extensions.
3402There is, however, one respect in which pandoc\[cq]s aims are different
3403from the original aims of Markdown.
3404Whereas Markdown was originally designed with HTML generation in mind,
3405pandoc is designed for multiple output formats.
3406Thus, while pandoc allows the embedding of raw HTML, it discourages it,
3407and provides other, non-HTMLish ways of representing important document
3408elements like definition lists, tables, mathematics, and footnotes.
3411A paragraph is one or more lines of text followed by one or more blank
3413Newlines are treated as spaces, so you can reflow your paragraphs as you
3415If you need a hard line break, put two or more spaces at the end of a
3417.SS Extension: \f[C]escaped_line_breaks\f[R]
3419A backslash followed by a newline is also a hard line break.
3420Note: in multiline and grid table cells, this is the only way to create
3421a hard line break, since trailing spaces in the cells are ignored.
3424There are two kinds of headings: Setext and ATX.
3425.SS Setext-style headings
3427A setext-style heading is a line of text \[lq]underlined\[rq] with a row
3428of \f[C]=\f[R] signs (for a level-one heading) or \f[C]-\f[R] signs (for
3429a level-two heading):
3441The heading text can contain inline formatting, such as emphasis (see
3442Inline formatting, below).
3443.SS ATX-style headings
3445An ATX-style heading consists of one to six \f[C]#\f[R] signs and a line
3446of text, optionally followed by any number of \f[C]#\f[R] signs.
3447The number of \f[C]#\f[R] signs at the beginning of the line is the
3452## A level-two heading
3454### A level-three heading ###
3458As with setext-style headings, the heading text can contain formatting:
3462# A level-one heading with a [link](/url) and *emphasis*
3465.SS Extension: \f[C]blank_before_header\f[R]
3467Standard Markdown syntax does not require a blank line before a heading.
3468Pandoc does require this (except, of course, at the beginning of the
3470The reason for the requirement is that it is all too easy for a
3471\f[C]#\f[R] to end up at the beginning of a line by accident (perhaps
3472through line wrapping).
3473Consider, for example:
3477I like several of their flavors of ice cream:
3478#22, for example, and #5.
3481.SS Extension: \f[C]space_in_atx_header\f[R]
3483Many Markdown implementations do not require a space between the opening
3484\f[C]#\f[R]s of an ATX heading and the heading text, so that
3485\f[C]#5 bolt\f[R] and \f[C]#hashtag\f[R] count as headings.
3486With this extension, pandoc does require the space.
3487.SS Heading identifiers
3489See also the \f[C]auto_identifiers\f[R] extension above.
3490.SS Extension: \f[C]header_attributes\f[R]
3492Headings can be assigned attributes using this syntax at the end of the
3493line containing the heading text:
3497{#identifier .class .class key=value key=value}
3501Thus, for example, the following headings will all be assigned the
3502identifier \f[C]foo\f[R]:
3508## My heading ## {#foo}
3510My other heading {#foo}
3515(This syntax is compatible with PHP Markdown Extra.)
3517Note that although this syntax allows assignment of classes and
3518key/value attributes, writers generally don\[cq]t use all of this
3520Identifiers, classes, and key/value attributes are used in HTML and
3521HTML-based formats such as EPUB and slidy.
3522Identifiers are used for labels and link anchors in the LaTeX, ConTeXt,
3523Textile, Jira markup, and AsciiDoc writers.
3525Headings with the class \f[C]unnumbered\f[R] will not be numbered, even
3526if \f[C]--number-sections\f[R] is specified.
3527A single hyphen (\f[C]-\f[R]) in an attribute context is equivalent to
3528\f[C].unnumbered\f[R], and preferable in non-English documents.
3541# My heading {.unnumbered}
3545If the \f[C]unlisted\f[R] class is present in addition to
3546\f[C]unnumbered\f[R], the heading will not be included in a table of
3548(Currently this feature is only implemented for certain formats: those
3549based on LaTeX and HTML, PowerPoint, and RTF.)
3550.SS Extension: \f[C]implicit_header_references\f[R]
3552Pandoc behaves as if reference links have been defined for each heading.
3553So, to link to a heading
3557# Heading identifiers in HTML
3565[Heading identifiers in HTML]
3573[Heading identifiers in HTML][]
3581[the section on heading identifiers][heading identifiers in
3586instead of giving the identifier explicitly:
3590[Heading identifiers in HTML](#heading-identifiers-in-html)
3594If there are multiple headings with identical text, the corresponding
3595reference will link to the first one only, and you will need to use
3596explicit links to link to the others, as described above.
3598Like regular reference links, these references are case-insensitive.
3600Explicit link reference definitions always take priority over implicit
3602So, in the following example, the link will point to \f[C]bar\f[R], not
3616Markdown uses email conventions for quoting blocks of text.
3617A block quotation is one or more paragraphs or other block elements
3618(such as lists or headings), with each line preceded by a \f[C]>\f[R]
3619character and an optional space.
3620(The \f[C]>\f[R] need not start at the left margin, but it should not be
3621indented more than three spaces.)
3625> This is a block quote. This
3626> paragraph has two lines.
3628> 1. This is a list inside a block quote.
3633A \[lq]lazy\[rq] form, which requires the \f[C]>\f[R] character only on
3634the first line of each block, is also allowed:
3638> This is a block quote. This
3639paragraph has two lines.
3641> 1. This is a list inside a block quote.
3646Among the block elements that can be contained in a block quote are
3648That is, block quotes can be nested:
3652> This is a block quote.
3654> > A block quote within a block quote.
3658If the \f[C]>\f[R] character is followed by an optional space, that
3659space will be considered part of the block quote marker and not part of
3660the indentation of the contents.
3661Thus, to put an indented code block in a block quote, you need five
3662spaces after the \f[C]>\f[R]:
3669.SS Extension: \f[C]blank_before_blockquote\f[R]
3671Standard Markdown syntax does not require a blank line before a block
3673Pandoc does require this (except, of course, at the beginning of the
3675The reason for the requirement is that it is all too easy for a
3676\f[C]>\f[R] to end up at the beginning of a line by accident (perhaps
3677through line wrapping).
3678So, unless the \f[C]markdown_strict\f[R] format is used, the following
3679does not produce a nested block quote in pandoc:
3683> This is a block quote.
3687.SS Verbatim (code) blocks
3688.SS Indented code blocks
3690A block of text indented four spaces (or one tab) is treated as verbatim
3691text: that is, special characters do not trigger special formatting, and
3692all spaces and line breaks are preserved.
3698 moveShip(5 * gravity, DOWN);
3703The initial (four space or one tab) indentation is not considered part
3704of the verbatim text, and is removed in the output.
3706Note: blank lines in the verbatim text need not begin with four spaces.
3707.SS Fenced code blocks
3708.SS Extension: \f[C]fenced_code_blocks\f[R]
3710In addition to standard indented code blocks, pandoc supports
3711\f[I]fenced\f[R] code blocks.
3712These begin with a row of three or more tildes (\f[C]\[ti]\f[R]) and end
3713with a row of tildes that must be at least as long as the starting row.
3714Everything between these lines is treated as code.
3715No indentation is necessary:
3719\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3721 moveShip(5 * gravity, DOWN);
3723\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3727Like regular code blocks, fenced code blocks must be separated from
3728surrounding text by blank lines.
3730If the code itself contains a row of tildes or backticks, just use a
3731longer row of tildes or backticks at the start and end:
3735\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3736\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3737code including tildes
3738\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3739\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3742.SS Extension: \f[C]backtick_code_blocks\f[R]
3744Same as \f[C]fenced_code_blocks\f[R], but uses backticks
3745(\f[C]\[ga]\f[R]) instead of tildes (\f[C]\[ti]\f[R]).
3746.SS Extension: \f[C]fenced_code_attributes\f[R]
3748Optionally, you may attach attributes to fenced or backtick code block
3753\[ti]\[ti]\[ti]\[ti] {#mycode .haskell .numberLines startFrom=\[dq]100\[dq]}
3755qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3756 qsort (filter (>= x) xs)
3757\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]
3761Here \f[C]mycode\f[R] is an identifier, \f[C]haskell\f[R] and
3762\f[C]numberLines\f[R] are classes, and \f[C]startFrom\f[R] is an
3763attribute with value \f[C]100\f[R].
3764Some output formats can use this information to do syntax highlighting.
3765Currently, the only output formats that uses this information are HTML,
3766LaTeX, Docx, Ms, and PowerPoint.
3767If highlighting is supported for your output format and language, then
3768the code block above will appear highlighted, with numbered lines.
3769(To see which languages are supported, type
3770\f[C]pandoc --list-highlight-languages\f[R].) Otherwise, the code block
3771above will appear as follows:
3775<pre id=\[dq]mycode\[dq] class=\[dq]haskell numberLines\[dq] startFrom=\[dq]100\[dq]>
3783The \f[C]numberLines\f[R] (or \f[C]number-lines\f[R]) class will cause
3784the lines of the code block to be numbered, starting with \f[C]1\f[R] or
3785the value of the \f[C]startFrom\f[R] attribute.
3786The \f[C]lineAnchors\f[R] (or \f[C]line-anchors\f[R]) class will cause
3787the lines to be clickable anchors in HTML output.
3789A shortcut form can also be used for specifying the language of the code
3794\[ga]\[ga]\[ga]haskell
3800This is equivalent to:
3804\[ga]\[ga]\[ga] {.haskell}
3810If the \f[C]fenced_code_attributes\f[R] extension is disabled, but input
3811contains class attribute(s) for the code block, the first class
3812attribute will be printed after the opening fence as a bare word.
3814To prevent all highlighting, use the \f[C]--no-highlight\f[R] flag.
3815To set the highlighting style, use \f[C]--highlight-style\f[R].
3816For more information on highlighting, see Syntax highlighting, below.
3818.SS Extension: \f[C]line_blocks\f[R]
3820A line block is a sequence of lines beginning with a vertical bar
3821(\f[C]|\f[R]) followed by a space.
3822The division into lines will be preserved in the output, as will any
3823leading spaces; otherwise, the lines will be formatted as Markdown.
3824This is useful for verse and addresses:
3828| The limerick packs laughs anatomical
3829| In space that is quite economical.
3830| But the good ones I\[aq]ve seen
3831| So seldom are clean
3832| And the clean ones so seldom are comical
3839The lines can be hard-wrapped if needed, but the continuation line must
3844| The Right Honorable Most Venerable and Righteous Samuel L.
3851This syntax is borrowed from reStructuredText.
3855A bullet list is a list of bulleted list items.
3856A bulleted list item begins with a bullet (\f[C]*\f[R], \f[C]+\f[R], or
3858Here is a simple example:
3868This will produce a \[lq]compact\[rq] list.
3869If you want a \[lq]loose\[rq] list, in which each item is formatted as a
3870paragraph, put spaces between the items:
3882The bullets need not be flush with the left margin; they may be indented
3883one, two, or three spaces.
3884The bullet must be followed by whitespace.
3886List items look best if subsequent lines are flush with the first line
3897But Markdown also allows a \[lq]lazy\[rq] format:
3906.SS Block content in list items
3908A list item may contain multiple paragraphs and other block-level
3910However, subsequent paragraphs must be preceded by a blank line and
3911indented to line up with the first non-space content after the list
3920 * Second paragraph. With a code block, which must be indented
3927Exception: if the list marker is followed by an indented code block,
3928which must begin 5 spaces after the list marker, then subsequent
3929paragraphs must begin two columns after the last character of the list
3936 continuation paragraph
3940List items may include other lists.
3941In this case the preceding blank line is optional.
3942The nested list must be indented to line up with the first non-space
3943character after the list marker of the containing list item.
3959As noted above, Markdown allows you to write list items
3960\[lq]lazily,\[rq] instead of indenting continuation lines.
3961However, if there are multiple paragraphs or other blocks in a list
3962item, the first line of each must be indented.
3969+ Another one; this looks
3972 Second paragraph of second
3978Ordered lists work just like bulleted lists, except that the items begin
3979with enumerators rather than bullets.
3981In standard Markdown, enumerators are decimal numbers followed by a
3983The numbers themselves are ignored, so there is no difference between
4003.SS Extension: \f[C]fancy_lists\f[R]
4005Unlike standard Markdown, pandoc allows ordered list items to be marked
4006with uppercase and lowercase letters and roman numerals, in addition to
4008List markers may be enclosed in parentheses or followed by a single
4009right-parentheses or period.
4010They must be separated from the text that follows by at least one space,
4011and, if the list marker is a capital letter with a period, by at least
4014The \f[C]fancy_lists\f[R] extension also allows `\f[C]#\f[R]' to be used
4015as an ordered list marker in place of a numeral:
4023.SS Extension: \f[C]startnum\f[R]
4025Pandoc also pays attention to the type of list marker used, and to the
4026starting number, and both of these are preserved where possible in the
4028Thus, the following yields a list with numbers followed by a single
4029parenthesis, starting with 9, and a sublist with lowercase roman
4043Pandoc will start a new list each time a different type of list marker
4045So, the following will create three lists:
4056If default list markers are desired, use \f[C]#.\f[R]:
4065.SS Extension: \f[C]task_lists\f[R]
4067Pandoc supports task lists, using the syntax of GitHub-Flavored
4072- [ ] an unchecked task list item
4077.SS Extension: \f[C]definition_lists\f[R]
4079Pandoc supports definition lists, using the syntax of PHP Markdown Extra
4080with some extensions.
4088Term 2 with *inline markup*
4092 { some code, part of Definition 2 }
4094 Third paragraph of definition 2.
4098Each term must fit on one line, which may optionally be followed by a
4099blank line, and must be followed by one or more definitions.
4100A definition begins with a colon or tilde, which may be indented one or
4103A term may have multiple definitions, and each definition may consist of
4104one or more block elements (paragraph, code block, list, etc.), each
4105indented four spaces or one tab stop.
4106The body of the definition (including the first line, aside from the
4107colon or tilde) should be indented four spaces.
4108However, as with other Markdown lists, you can \[lq]lazily\[rq] omit
4109indentation except at the beginning of a paragraph or other block
4117with lazy continuation.
4119 Second paragraph of the definition.
4123If you leave space before the definition (as in the example above), the
4124text of the definition will be treated as a paragraph.
4125In some output formats, this will mean greater spacing between
4126term/definition pairs.
4127For a more compact definition list, omit the space before the
4141Note that space between items in a definition list is required.
4142(A variant that loosens this requirement, but disallows \[lq]lazy\[rq]
4143hard wrapping, can be activated with \f[C]compact_definition_lists\f[R]:
4144see Non-pandoc extensions, below.)
4145.SS Numbered example lists
4146.SS Extension: \f[C]example_lists\f[R]
4148The special list marker \f[C]\[at]\f[R] can be used for sequentially
4150The first list item with a \f[C]\[at]\f[R] marker will be numbered `1',
4151the next `2', and so on, throughout the document.
4152The numbered examples need not occur in a single list; each new list
4153using \f[C]\[at]\f[R] will take up where the last stopped.
4158(\[at]) My first example will be numbered (1).
4159(\[at]) My second example will be numbered (2).
4161Explanation of examples.
4163(\[at]) My third example will be numbered (3).
4167Numbered examples can be labeled and referred to elsewhere in the
4172(\[at]good) This is a good example.
4174As (\[at]good) illustrates, ...
4178The label can be any string of alphanumeric characters, underscores, or
4181Note: continuation paragraphs in example lists must always be indented
4182four spaces, regardless of the length of the list marker.
4183That is, example lists always behave as if the \f[C]four_space_rule\f[R]
4185This is because example labels tend to be long, and indenting content to
4186the first non-space character after the label would be awkward.
4189What if you want to put an indented code block after a list?
4200Trouble! Here pandoc (like other Markdown implementations) will treat
4201\f[C]{ my code block }\f[R] as the second paragraph of item two, and not
4204To \[lq]cut off\[rq] the list after item two, you can insert some
4205non-indented content, like an HTML comment, which won\[cq]t produce
4206visible output in any format:
4219You can use the same trick if you want two consecutive lists instead of
4237A line containing a row of three or more \f[C]*\f[R], \f[C]-\f[R], or
4238\f[C]_\f[R] characters (optionally separated by spaces) produces a
4250Four kinds of tables may be used.
4251The first three kinds presuppose the use of a fixed-width font, such as
4253The fourth kind can be used with proportionally spaced fonts, as it does
4254not require lining up columns.
4255.SS Extension: \f[C]table_captions\f[R]
4257A caption may optionally be provided with all 4 kinds of tables (as
4258illustrated in the examples below).
4259A caption is a paragraph beginning with the string \f[C]Table:\f[R] (or
4260just \f[C]:\f[R]), which will be stripped off.
4261It may appear either before or after the table.
4262.SS Extension: \f[C]simple_tables\f[R]
4264Simple tables look like this:
4268 Right Left Center Default
4269------- ------ ---------- -------
4274Table: Demonstration of simple table syntax.
4278The header and table rows must each fit on one line.
4279Column alignments are determined by the position of the header text
4280relative to the dashed line below it:
4282If the dashed line is flush with the header text on the right side but
4283extends beyond it on the left, the column is right-aligned.
4285If the dashed line is flush with the header text on the left side but
4286extends beyond it on the right, the column is left-aligned.
4288If the dashed line extends beyond the header text on both sides, the
4291If the dashed line is flush with the header text on both sides, the
4292default alignment is used (in most cases, this will be left).
4294The table must end with a blank line, or a line of dashes followed by a
4297The column header row may be omitted, provided a dashed line is used to
4303------- ------ ---------- -------
4307------- ------ ---------- -------
4311When the header row is omitted, column alignments are determined on the
4312basis of the first line of the table body.
4313So, in the tables above, the columns would be right, left, center, and
4314right aligned, respectively.
4315.SS Extension: \f[C]multiline_tables\f[R]
4317Multiline tables allow header and table rows to span multiple lines of
4318text (but cells that span multiple columns or rows of the table are not
4324-------------------------------------------------------------
4325 Centered Default Right Left
4326 Header Aligned Aligned Aligned
4327----------- ------- --------------- -------------------------
4328 First row 12.0 Example of a row that
4329 spans multiple lines.
4331 Second row 5.0 Here\[aq]s another one. Note
4332 the blank line between
4334-------------------------------------------------------------
4336Table: Here\[aq]s the caption. It, too, may span
4341These work like simple tables, but with the following differences:
4343They must begin with a row of dashes, before the header text (unless the
4344header row is omitted).
4346They must end with a row of dashes, then a blank line.
4348The rows must be separated by blank lines.
4350In multiline tables, the table parser pays attention to the widths of
4351the columns, and the writers try to reproduce these relative widths in
4353So, if you find that one of the columns is too narrow in the output, try
4354widening it in the Markdown source.
4356The header may be omitted in multiline tables as well as simple tables:
4360----------- ------- --------------- -------------------------
4361 First row 12.0 Example of a row that
4362 spans multiple lines.
4364 Second row 5.0 Here\[aq]s another one. Note
4365 the blank line between
4367----------- ------- --------------- -------------------------
4369: Here\[aq]s a multiline table without a header.
4373It is possible for a multiline table to have just one row, but the row
4374should be followed by a blank line (and then the row of dashes that ends
4375the table), or the table may be interpreted as a simple table.
4376.SS Extension: \f[C]grid_tables\f[R]
4378Grid tables look like this:
4384+---------------+---------------+--------------------+
4385| Fruit | Price | Advantages |
4386+===============+===============+====================+
4387| Bananas | $1.34 | - built-in wrapper |
4388| | | - bright color |
4389+---------------+---------------+--------------------+
4390| Oranges | $2.10 | - cures scurvy |
4392+---------------+---------------+--------------------+
4396The row of \f[C]=\f[R]s separates the header from the table body, and
4397can be omitted for a headerless table.
4398The cells of grid tables may contain arbitrary block elements (multiple
4399paragraphs, code blocks, lists, etc.).
4400Cells that span multiple columns or rows are not supported.
4401Grid tables can be created easily using Emacs\[cq] table-mode
4402(\f[C]M-x table-insert\f[R]).
4404Alignments can be specified as with pipe tables, by putting colons at
4405the boundaries of the separator line after the header:
4409+---------------+---------------+--------------------+
4410| Right | Left | Centered |
4411+==============:+:==============+:==================:+
4412| Bananas | $1.34 | built-in wrapper |
4413+---------------+---------------+--------------------+
4417For headerless tables, the colons go on the top line instead:
4421+--------------:+:--------------+:------------------:+
4422| Right | Left | Centered |
4423+---------------+---------------+--------------------+
4426.SS Grid Table Limitations
4428Pandoc does not support grid tables with row spans or column spans.
4429This means that neither variable numbers of columns across rows nor
4430variable numbers of rows across columns are supported by Pandoc.
4431All grid tables must have the same number of columns in each row, and
4432the same number of rows in each column.
4433For example, the Docutils sample grid tables will not render as expected
4435.SS Extension: \f[C]pipe_tables\f[R]
4437Pipe tables look like this:
4441| Right | Left | Default | Center |
4442|------:|:-----|---------|:------:|
4443| 12 | 12 | 12 | 12 |
4444| 123 | 123 | 123 | 123 |
4447 : Demonstration of pipe table syntax.
4451The syntax is identical to PHP Markdown Extra tables.
4452The beginning and ending pipe characters are optional, but pipes are
4453required between all columns.
4454The colons indicate column alignment as shown.
4455The header cannot be omitted.
4456To simulate a headerless table, include a header with blank cells.
4458Since the pipes indicate column boundaries, columns need not be
4459vertically aligned, as they are in the above example.
4460So, this is a perfectly legal (though ugly) pipe table:
4472The cells of pipe tables cannot contain block elements like paragraphs
4473and lists, and cannot span multiple lines.
4474If a pipe table contains a row whose Markdown content is wider than the
4475column width (see \f[C]--columns\f[R]), then the table will take up the
4476full text width and the cell contents will wrap, with the relative cell
4477widths determined by the number of dashes in the line separating the
4478table header from the table body.
4479(For example \f[C]---|-\f[R] would make the first column 3/4 and the
4480second column 1/4 of the full text width.) On the other hand, if no
4481lines are wider than column width, then cell contents will not be
4482wrapped, and the cells will be sized to their contents.
4484Note: pandoc also recognizes pipe tables of the following form, as can
4485be produced by Emacs\[cq] orgtbl-mode:
4496The difference is that \f[C]+\f[R] is used instead of \f[C]|\f[R].
4497Other orgtbl features are not supported.
4498In particular, to get non-default column alignment, you\[cq]ll need to
4501.SS Extension: \f[C]pandoc_title_block\f[R]
4503If the file begins with a title block
4508% author(s) (separated by semicolons)
4513it will be parsed as bibliographic information, not regular text.
4514(It will be used, for example, in the title of standalone LaTeX or HTML
4515output.) The block may contain just a title, a title and an author, or
4517If you want to include an author but no title, or a title and a date but
4518no author, you need a blank line:
4535The title may occupy multiple lines, but continuation lines must begin
4536with leading space, thus:
4545If a document has multiple authors, the authors may be put on separate
4546lines with leading space, or separated by semicolons, or both.
4547So, all of the following are equivalent:
4558% Author One; Author Two
4569The date must fit on one line.
4571All three metadata fields may contain standard inline formatting
4572(italics, links, footnotes, etc.).
4574Title blocks will always be parsed, but they will affect the output only
4575when the \f[C]--standalone\f[R] (\f[C]-s\f[R]) option is chosen.
4576In HTML output, titles will appear twice: once in the document head
4577\[en] this is the title that will appear at the top of the window in a
4578browser \[en] and once at the beginning of the document body.
4579The title in the document head can have an optional prefix attached
4580(\f[C]--title-prefix\f[R] or \f[C]-T\f[R] option).
4581The title in the body appears as an H1 element with class
4582\[lq]title\[rq], so it can be suppressed or reformatted with CSS.
4583If a title prefix is specified with \f[C]-T\f[R] and no title block
4584appears in the document, the title prefix will be used by itself as the
4587The man page writer extracts a title, man page section number, and other
4588header and footer information from the title line.
4589The title is assumed to be the first word on the title line, which may
4590optionally end with a (single-digit) section number in parentheses.
4591(There should be no space between the title and the parentheses.)
4592Anything after this is assumed to be additional footer and header text.
4593A single pipe character (\f[C]|\f[R]) should be used to separate the
4594footer text from the header text.
4603will yield a man page with the title \f[C]PANDOC\f[R] and section 1.
4607% PANDOC(1) Pandoc User Manuals
4611will also have \[lq]Pandoc User Manuals\[rq] in the footer.
4615% PANDOC(1) Pandoc User Manuals | Version 4.0
4619will also have \[lq]Version 4.0\[rq] in the header.
4620.SS Extension: \f[C]yaml_metadata_block\f[R]
4622A YAML metadata block is a valid YAML object, delimited by a line of
4623three hyphens (\f[C]---\f[R]) at the top and a line of three hyphens
4624(\f[C]---\f[R]) or three dots (\f[C]...\f[R]) at the bottom.
4625A YAML metadata block may occur anywhere in the document, but if it is
4626not at the beginning, it must be preceded by a blank line.
4627(Note that, because of the way pandoc concatenates input files when
4628several are provided, you may also keep the metadata in a separate YAML
4629file and pass it to pandoc as an argument, along with your Markdown
4634pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4638Just be sure that the YAML file begins with \f[C]---\f[R] and ends with
4639\f[C]---\f[R] or \f[C]...\f[R].) Alternatively, you can use the
4640\f[C]--metadata-file\f[R] option.
4641Using that approach however, you cannot reference content (like
4642footnotes) from the main markdown input document.
4644Metadata will be taken from the fields of the YAML object and added to
4645any existing document metadata.
4646Metadata can contain lists and objects (nested arbitrarily), but all
4647string scalars will be interpreted as Markdown.
4648Fields with names ending in an underscore will be ignored by pandoc.
4649(They may be given a role by external processors.) Field names must not
4650be interpretable as YAML numbers or boolean values (so, for example,
4651\f[C]yes\f[R], \f[C]True\f[R], and \f[C]15\f[R] cannot be used as field
4654A document may contain multiple metadata blocks.
4655If two metadata blocks attempt to set the same field, the value from the
4656second block will be taken.
4658When pandoc is used with \f[C]-t markdown\f[R] to create a Markdown
4659document, a YAML metadata block will be produced only if the
4660\f[C]-s/--standalone\f[R] option is used.
4661All of the metadata will appear in a single block at the beginning of
4664Note that YAML escaping rules must be followed.
4665Thus, for example, if a title contains a colon, it must be quoted.
4666The pipe character (\f[C]|\f[R]) can be used to begin an indented block
4667that will be interpreted literally, without need for escaping.
4668This form is necessary when the field contains blank lines or
4669block-level formatting:
4674title: \[aq]This is the title: it contains a colon\[aq]
4678keywords: [nothing, nothingness]
4680 This is the abstract.
4682 It consists of two paragraphs.
4687Template variables will be set automatically from the metadata.
4688Thus, for example, in writing HTML, the variable \f[C]abstract\f[R] will
4689be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[R]
4694<p>This is the abstract.</p>
4695<p>It consists of two paragraphs.</p>
4699Variables can contain arbitrary YAML structures, but the template must
4700match this structure.
4701The \f[C]author\f[R] variable in the default templates expects a simple
4702list or string, but can be changed to support more complicated
4704The following combination, for example, would add an affiliation to the
4705author if one is given:
4710title: The document title
4713 affiliation: University of Somewhere
4715 affiliation: University of Nowhere
4720To use the structured authors in the example above, you would need a
4727$author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4735Raw content to include in the document\[cq]s header may be specified
4736using \f[C]header-includes\f[R]; however, it is important to mark up
4737this content as raw code for a particular output format, using the
4738\f[C]raw_attribute\f[R] extension), or it will be interpreted as
4746 \[ga]\[ga]\[ga]{=latex}
4747 \[rs]let\[rs]oldsection\[rs]section
4748 \[rs]renewcommand{\[rs]section}[1]{\[rs]clearpage\[rs]oldsection{#1}}
4752.SS Backslash escapes
4753.SS Extension: \f[C]all_symbols_escapable\f[R]
4755Except inside a code block or inline code, any punctuation or space
4756character preceded by a backslash will be treated literally, even if it
4757would normally indicate formatting.
4758Thus, for example, if one writes
4778<strong>hello</strong>
4782This rule is easier to remember than standard Markdown\[cq]s rule, which
4783allows only the following characters to be backslash-escaped:
4787\[rs]\[ga]*_{}[]()>#+-.!
4791(However, if the \f[C]markdown_strict\f[R] format is used, the standard
4792Markdown rule will be used.)
4794A backslash-escaped space is parsed as a nonbreaking space.
4795In TeX output, it will appear as \f[C]\[ti]\f[R].
4796In HTML and XML output, it will appear as a literal unicode nonbreaking
4797space character (note that it will thus actually look
4798\[lq]invisible\[rq] in the generated HTML source; you can still use the
4799\f[C]--ascii\f[R] command-line option to make it appear as an explicit
4802A backslash-escaped newline (i.e.\ a backslash occurring at the end of a
4803line) is parsed as a hard line break.
4804It will appear in TeX output as \f[C]\[rs]\[rs]\f[R] and in HTML as
4806This is a nice alternative to Markdown\[cq]s \[lq]invisible\[rq] way of
4807indicating hard line breaks using two trailing spaces on a line.
4809Backslash escapes do not work in verbatim contexts.
4810.SS Inline formatting
4813To \f[I]emphasize\f[R] some text, surround it with \f[C]*\f[R]s or
4814\f[C]_\f[R], like this:
4818This text is _emphasized with underscores_, and this
4819is *emphasized with asterisks*.
4823Double \f[C]*\f[R] or \f[C]_\f[R] produces \f[B]strong emphasis\f[R]:
4827This is **strong emphasis** and __with underscores__.
4831A \f[C]*\f[R] or \f[C]_\f[R] character surrounded by spaces, or
4832backslash-escaped, will not trigger emphasis:
4836This is * not emphasized *, and \[rs]*neither is this\[rs]*.
4839.SS Extension: \f[C]intraword_underscores\f[R]
4841Because \f[C]_\f[R] is sometimes used inside words and identifiers,
4842pandoc does not interpret a \f[C]_\f[R] surrounded by alphanumeric
4843characters as an emphasis marker.
4844If you want to emphasize just part of a word, use \f[C]*\f[R]:
4848feas*ible*, not feas*able*.
4852.SS Extension: \f[C]strikeout\f[R]
4854To strikeout a section of text with a horizontal line, begin and end it
4855with \f[C]\[ti]\[ti]\f[R].
4860This \[ti]\[ti]is deleted text.\[ti]\[ti]
4863.SS Superscripts and subscripts
4864.SS Extension: \f[C]superscript\f[R], \f[C]subscript\f[R]
4866Superscripts may be written by surrounding the superscripted text by
4867\f[C]\[ha]\f[R] characters; subscripts may be written by surrounding the
4868subscripted text by \f[C]\[ti]\f[R] characters.
4873H\[ti]2\[ti]O is a liquid. 2\[ha]10\[ha] is 1024.
4877The text between \f[C]\[ha]...\[ha]\f[R] or \f[C]\[ti]...\[ti]\f[R] may
4878not contain spaces or newlines.
4879If the superscripted or subscripted text contains spaces, these spaces
4880must be escaped with backslashes.
4881(This is to prevent accidental superscripting and subscripting through
4882the ordinary use of \f[C]\[ti]\f[R] and \f[C]\[ha]\f[R], and also bad
4883interactions with footnotes.) Thus, if you want the letter P with `a
4884cat' in subscripts, use \f[C]P\[ti]a\[rs] cat\[ti]\f[R], not
4885\f[C]P\[ti]a cat\[ti]\f[R].
4888To make a short span of text verbatim, put it inside backticks:
4892What is the difference between \[ga]>>=\[ga] and \[ga]>>\[ga]?
4896If the verbatim text includes a backtick, use double backticks:
4900Here is a literal backtick \[ga]\[ga] \[ga] \[ga]\[ga].
4904(The spaces after the opening backticks and before the closing backticks
4907The general rule is that a verbatim span starts with a string of
4908consecutive backticks (optionally followed by a space) and ends with a
4909string of the same number of backticks (optionally preceded by a space).
4911Note that backslash-escapes (and other Markdown constructs) do not work
4912in verbatim contexts:
4916This is a backslash followed by an asterisk: \[ga]\[rs]*\[ga].
4919.SS Extension: \f[C]inline_code_attributes\f[R]
4921Attributes can be attached to verbatim text, just as with fenced code
4926\[ga]<$>\[ga]{.haskell}
4931To write small caps, use the \f[C]smallcaps\f[R] class:
4935[Small caps]{.smallcaps}
4939Or, without the \f[C]bracketed_spans\f[R] extension:
4943<span class=\[dq]smallcaps\[dq]>Small caps</span>
4947For compatibility with other Markdown flavors, CSS is also supported:
4951<span style=\[dq]font-variant:small-caps;\[dq]>Small caps</span>
4955This will work in all output formats that support small caps.
4957.SS Extension: \f[C]tex_math_dollars\f[R]
4959Anything between two \f[C]$\f[R] characters will be treated as TeX math.
4960The opening \f[C]$\f[R] must have a non-space character immediately to
4961its right, while the closing \f[C]$\f[R] must have a non-space character
4962immediately to its left, and must not be followed immediately by a
4964Thus, \f[C]$20,000 and $30,000\f[R] won\[cq]t parse as math.
4965If for some reason you need to enclose text in literal \f[C]$\f[R]
4966characters, backslash-escape them and they won\[cq]t be treated as math
4969For display math, use \f[C]$$\f[R] delimiters.
4970(In this case, the delimiters may be separated from the formula by
4973TeX math will be printed in all output formats.
4974How it is rendered depends on the output format:
4977It will appear verbatim surrounded by \f[C]\[rs](...\[rs])\f[R] (for
4978inline math) or \f[C]\[rs][...\[rs]]\f[R] (for display math).
4980Markdown, Emacs Org mode, ConTeXt, ZimWiki
4981It will appear verbatim surrounded by \f[C]$...$\f[R] (for inline math)
4982or \f[C]$$...$$\f[R] (for display math).
4985It will appear verbatim surrounded by
4986\f[C]{{formula}}..{{/formula}}\f[R].
4989It will be rendered using an interpreted text role \f[C]:math:\f[R].
4992For AsciiDoc output format (\f[C]-t asciidoc\f[R]) it will appear
4993verbatim surrounded by \f[C]latexmath:[$...$]\f[R] (for inline math) or
4994\f[C][latexmath]++++\[rs][...\[rs]]+++\f[R] (for display math).
4995For AsciiDoctor output format (\f[C]-t asciidoctor\f[R]) the LaTex
4996delimiters (\f[C]$..$\f[R] and \f[C]\[rs][..\[rs]]\f[R]) are omitted.
4999It will be rendered inside a \f[C]\[at]math\f[R] command.
5001roff man, Jira markup
5002It will be rendered verbatim without \f[C]$\f[R]\[cq]s.
5005It will be rendered inside \f[C]<math>\f[R] tags.
5008It will be rendered inside \f[C]<span class=\[dq]math\[dq]>\f[R] tags.
5011It will be rendered, if possible, using Unicode characters, and will
5012otherwise appear verbatim.
5015It will be rendered, if possible, using MathML.
5018If the \f[C]--mathml\f[R] flag is used, it will be rendered using MathML
5019in an \f[C]inlineequation\f[R] or \f[C]informalequation\f[R] tag.
5020Otherwise it will be rendered, if possible, using Unicode characters.
5023It will be rendered using OMML math markup.
5026If the \f[C]--webtex\f[R] option is used, formulas are rendered as
5027images using CodeCogs or other compatible web service, downloaded and
5028embedded in the e-book.
5029Otherwise, they will appear verbatim.
5031HTML, Slidy, DZSlides, S5, EPUB
5032The way math is rendered in HTML will depend on the command-line options
5034Therefore see Math rendering in HTML above.
5036.SS Extension: \f[C]raw_html\f[R]
5038Markdown allows you to insert raw HTML (or DocBook) anywhere in a
5039document (except verbatim contexts, where \f[C]<\f[R], \f[C]>\f[R], and
5040\f[C]&\f[R] are interpreted literally).
5041(Technically this is not an extension, since standard Markdown allows
5042it, but it has been made an extension so that it can be disabled if
5045The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
5046DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
5047output, and suppressed in other formats.
5049For a more explicit way of including raw HTML in a Markdown document,
5050see the \f[C]raw_attribute\f[R] extension.
5052In the CommonMark format, if \f[C]raw_html\f[R] is enabled,
5053superscripts, subscripts, strikeouts and small capitals will be
5055Otherwise, plain-text fallbacks will be used.
5056Note that even if \f[C]raw_html\f[R] is disabled, tables will be
5057rendered with HTML syntax if they cannot use pipe syntax.
5058.SS Extension: \f[C]markdown_in_html_blocks\f[R]
5060Standard Markdown allows you to include HTML \[lq]blocks\[rq]: blocks of
5061HTML between balanced tags that are separated from the surrounding text
5062with blank lines, and start and end at the left margin.
5063Within these blocks, everything is interpreted as HTML, not Markdown; so
5064(for example), \f[C]*\f[R] does not signify emphasis.
5066Pandoc behaves this way when the \f[C]markdown_strict\f[R] format is
5067used; but by default, pandoc interprets material between HTML block tags
5069Thus, for example, pandoc will turn
5076<td>[a link](https://google.com)</td>
5088<td><em>one</em></td>
5089<td><a href=\[dq]https://google.com\[dq]>a link</a></td>
5095whereas \f[C]Markdown.pl\f[R] will preserve it as is.
5097There is one exception to this rule: text between \f[C]<script>\f[R] and
5098\f[C]<style>\f[R] tags is not interpreted as Markdown.
5100This departure from standard Markdown should make it easier to mix
5101Markdown with HTML block elements.
5102For example, one can surround a block of Markdown text with
5103\f[C]<div>\f[R] tags without preventing it from being interpreted as
5105.SS Extension: \f[C]native_divs\f[R]
5107Use native pandoc \f[C]Div\f[R] blocks for content inside
5108\f[C]<div>\f[R] tags.
5109For the most part this should give the same output as
5110\f[C]markdown_in_html_blocks\f[R], but it makes it easier to write
5111pandoc filters to manipulate groups of blocks.
5112.SS Extension: \f[C]native_spans\f[R]
5114Use native pandoc \f[C]Span\f[R] blocks for content inside
5115\f[C]<span>\f[R] tags.
5116For the most part this should give the same output as
5117\f[C]raw_html\f[R], but it makes it easier to write pandoc filters to
5118manipulate groups of inlines.
5119.SS Extension: \f[C]raw_tex\f[R]
5121In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
5122included in a document.
5123Inline TeX commands will be preserved and passed unchanged to the LaTeX
5125Thus, for example, you can use LaTeX to include BibTeX citations:
5129This result was proved in \[rs]cite{jones.1967}.
5133Note that in LaTeX environments, like
5137\[rs]begin{tabular}{|l|l|}\[rs]hline
5138Age & Frequency \[rs]\[rs] \[rs]hline
513918--25 & 15 \[rs]\[rs]
514026--35 & 33 \[rs]\[rs]
514136--45 & 22 \[rs]\[rs] \[rs]hline
5146the material between the begin and end tags will be interpreted as raw
5147LaTeX, not as Markdown.
5149For a more explicit and flexible way of including raw TeX in a Markdown
5150document, see the \f[C]raw_attribute\f[R] extension.
5152Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
5153Emacs Org mode, and ConTeXt.
5154.SS Generic raw attribute
5155.SS Extension: \f[C]raw_attribute\f[R]
5157Inline spans and fenced code blocks with a special kind of attribute
5158will be parsed as raw content with the designated format.
5159For example, the following produces a raw roff \f[C]ms\f[R] block:
5170And the following produces a raw \f[C]html\f[R] inline element:
5174This is \[ga]<a>html</a>\[ga]{=html}
5178This can be useful to insert raw xml into \f[C]docx\f[R] documents, e.g.
5183\[ga]\[ga]\[ga]{=openxml}
5186 <w:br w:type=\[dq]page\[dq]/>
5193The format name should match the target format name (see
5194\f[C]-t/--to\f[R], above, for a list, or use
5195\f[C]pandoc --list-output-formats\f[R]).
5196Use \f[C]openxml\f[R] for \f[C]docx\f[R] output, \f[C]opendocument\f[R]
5197for \f[C]odt\f[R] output, \f[C]html5\f[R] for \f[C]epub3\f[R] output,
5198\f[C]html4\f[R] for \f[C]epub2\f[R] output, and \f[C]latex\f[R],
5199\f[C]beamer\f[R], \f[C]ms\f[R], or \f[C]html5\f[R] for \f[C]pdf\f[R]
5200output (depending on what you use for \f[C]--pdf-engine\f[R]).
5202This extension presupposes that the relevant kind of inline code or
5203fenced code block is enabled.
5204Thus, for example, to use a raw attribute with a backtick code block,
5205\f[C]backtick_code_blocks\f[R] must be enabled.
5207The raw attribute cannot be combined with regular attributes.
5209.SS Extension: \f[C]latex_macros\f[R]
5211When this extension is enabled, pandoc will parse LaTeX macro
5212definitions and apply the resulting macros to all LaTeX math and raw
5214So, for example, the following will work in all output formats, not just
5219\[rs]newcommand{\[rs]tuple}[1]{\[rs]langle #1 \[rs]rangle}
5221$\[rs]tuple{a, b, c}$
5225Note that LaTeX macros will not be applied if they occur inside a raw
5226span or block marked with the \f[C]raw_attribute\f[R] extension.
5228When \f[C]latex_macros\f[R] is disabled, the raw LaTeX and math will not
5230This is usually a better approach when you are targeting LaTeX or PDF.
5232Macro definitions in LaTeX will be passed through as raw LaTeX only if
5233\f[C]latex_macros\f[R] is not enabled.
5234Macro definitions in Markdown source (or other formats allowing
5235\f[C]raw_tex\f[R]) will be passed through regardless of whether
5236\f[C]latex_macros\f[R] is enabled.
5239Markdown allows links to be specified in several ways.
5242If you enclose a URL or email address in pointy brackets, it will become
5248<sam\[at]green.eggs.ham>
5253An inline link consists of the link text in square brackets, followed by
5254the URL in parentheses.
5255(Optionally, the URL can be followed by a link title, in quotes.)
5259This is an [inline link](/url), and here\[aq]s [one with
5260a title](https://fsf.org \[dq]click here for a good time!\[dq]).
5264There can be no space between the bracketed part and the parenthesized
5266The link text can contain formatting (such as emphasis), but the title
5269Email addresses in inline links are not autodetected, so they have to be
5270prefixed with \f[C]mailto\f[R]:
5274[Write me!](mailto:sam\[at]green.eggs.ham)
5279An \f[I]explicit\f[R] reference link has two parts, the link itself and
5280the link definition, which may occur elsewhere in the document (either
5281before or after the link).
5283The link consists of link text in square brackets, followed by a label
5285(There cannot be space between the two unless the
5286\f[C]spaced_reference_links\f[R] extension is enabled.) The link
5287definition consists of the bracketed label, followed by a colon and a
5288space, followed by the URL, and optionally (after a space) a link title
5289either in quotes or in parentheses.
5290The label must not be parseable as a citation (assuming the
5291\f[C]citations\f[R] extension is enabled): citations take precedence
5294Here are some examples:
5298[my label 1]: /foo/bar.html \[dq]My title, optional\[dq]
5300[my label 3]: https://fsf.org (The free software foundation)
5301[my label 4]: /bar#special \[aq]A title in single quotes\[aq]
5305The URL may optionally be surrounded by angle brackets:
5309[my label 5]: <http://foo.bar.baz>
5313The title may go on the next line:
5317[my label 3]: https://fsf.org
5318 \[dq]The free software foundation\[dq]
5322Note that link labels are not case sensitive.
5327Here is [my link][FOO]
5333In an \f[I]implicit\f[R] reference link, the second pair of brackets is
5340[my website]: http://foo.bar.baz
5344Note: In \f[C]Markdown.pl\f[R] and most other Markdown implementations,
5345reference link definitions cannot occur in nested constructions such as
5346list items or block quotes.
5347Pandoc lifts this arbitrary seeming restriction.
5348So the following is fine in pandoc, though not in most other
5358.SS Extension: \f[C]shortcut_reference_links\f[R]
5360In a \f[I]shortcut\f[R] reference link, the second pair of brackets may
5367[my website]: http://foo.bar.baz
5372To link to another section of the same document, use the automatically
5373generated identifier (see Heading identifiers).
5378See the [Introduction](#introduction).
5386See the [Introduction].
5388[Introduction]: #introduction
5392Internal links are currently supported for HTML formats (including HTML
5393slide shows and EPUB), LaTeX, and ConTeXt.
5396A link immediately preceded by a \f[C]!\f[R] will be treated as an
5398The link text will be used as the image\[cq]s alt text:
5402
5406[movie reel]: movie.gif
5409.SS Extension: \f[C]implicit_figures\f[R]
5411An image with nonempty alt text, occurring by itself in a paragraph,
5412will be rendered as a figure with a caption.
5413The image\[cq]s alt text will be used as the caption.
5417
5421How this is rendered depends on the output format.
5422Some output formats (e.g.\ RTF) do not yet support figures.
5423In those formats, you\[cq]ll just get an image in a paragraph by itself,
5426If you just want a regular inline image, just make sure it is not the
5427only thing in the paragraph.
5428One way to do this is to insert a nonbreaking space after the image:
5432![This image won\[aq]t be a figure](/url/of/image.png)\[rs]
5436Note that in reveal.js slide shows, an image in a paragraph by itself
5437that has the \f[C]stretch\f[R] class will fill the screen, and the
5438caption and figure tags will be omitted.
5439.SS Extension: \f[C]link_attributes\f[R]
5441Attributes can be set on links and images:
5445An inline {#id .class width=30 height=20px}
5446and a reference ![image][ref] with attributes.
5448[ref]: foo.jpg \[dq]optional title\[dq] {#id .class key=val key2=\[dq]val 2\[dq]}
5452(This syntax is compatible with PHP Markdown Extra when only
5453\f[C]#id\f[R] and \f[C].class\f[R] are used.)
5455For HTML and EPUB, all known HTML5 attributes except \f[C]width\f[R] and
5456\f[C]height\f[R] (but including \f[C]srcset\f[R] and \f[C]sizes\f[R])
5457are passed through as is.
5458Unknown attributes are passed through as custom attributes, with
5459\f[C]data-\f[R] prepended.
5460The other writers ignore attributes that are not specifically supported
5461by their output format.
5463The \f[C]width\f[R] and \f[C]height\f[R] attributes on images are
5465When used without a unit, the unit is assumed to be pixels.
5466However, any of the following unit identifiers can be used:
5467\f[C]px\f[R], \f[C]cm\f[R], \f[C]mm\f[R], \f[C]in\f[R], \f[C]inch\f[R]
5469There must not be any spaces between the number and the unit.
5474{ width=50% }
5478Dimensions may be converted to a form that is compatible with the output
5479format (for example, dimensions given in pixels will be converted to
5480inches when converting HTML to LaTeX).
5481Conversion between pixels and physical measurements is affected by the
5482\f[C]--dpi\f[R] option (by default, 96 dpi is assumed, unless the image
5483itself contains dpi information).
5485The \f[C]%\f[R] unit is generally relative to some available space.
5486For example the above example will render to the following.
5490\f[C]<img href=\[dq]file.jpg\[dq] style=\[dq]width: 50%;\[dq] />\f[R]
5493\f[C]\[rs]includegraphics[width=0.5\[rs]textwidth,height=\[rs]textheight]{file.jpg}\f[R]
5494(If you\[cq]re using a custom template, you need to configure
5495\f[C]graphicx\f[R] as in the default template.)
5498\f[C]\[rs]externalfigure[file.jpg][width=0.5\[rs]textwidth]\f[R]
5501Some output formats have a notion of a class (ConTeXt) or a unique
5502identifier (LaTeX \f[C]\[rs]caption\f[R]), or both (HTML).
5504When no \f[C]width\f[R] or \f[C]height\f[R] attributes are specified,
5505the fallback is to look at the image resolution and the dpi metadata
5506embedded in the image file.
5509Using the \f[C]native_divs\f[R] and \f[C]native_spans\f[R] extensions
5510(see above), HTML syntax can be used as part of markdown to create
5511native \f[C]Div\f[R] and \f[C]Span\f[R] elements in the pandoc AST (as
5512opposed to raw HTML).
5513However, there is also nicer syntax available:
5514.SS Extension: \f[C]fenced_divs\f[R]
5516Allow special fenced syntax for native \f[C]Div\f[R] blocks.
5517A Div starts with a fence containing at least three consecutive colons
5518plus some attributes.
5519The attributes may optionally be followed by another string of
5521The attribute syntax is exactly as in fenced code blocks (see Extension:
5522\f[C]fenced_code_attributes\f[R]).
5523As with fenced code blocks, one can use either attributes in curly
5524braces or a single unbraced word, which will be treated as a class name.
5525The Div ends with another line containing a string of at least three
5527The fenced Div should be separated by blank lines from preceding and
5534::::: {#special .sidebar}
5542Fenced divs can be nested.
5543Opening fences are distinguished because they \f[I]must\f[R] have
5552This is a warning within a warning.
5558Fences without attributes are always closing fences.
5559Unlike with fenced code blocks, the number of colons in the closing
5560fence need not match the number in the opening fence.
5561However, it can be helpful for visual clarity to use fences of different
5562lengths to distinguish nested divs from their parents.
5563.SS Extension: \f[C]bracketed_spans\f[R]
5565A bracketed sequence of inlines, as one would use to begin a link, will
5566be treated as a \f[C]Span\f[R] with attributes if it is followed
5567immediately by attributes:
5571[This is *some text*]{.class key=\[dq]val\[dq]}
5575.SS Extension: \f[C]footnotes\f[R]
5577Pandoc\[cq]s Markdown allows footnotes, using the following syntax:
5581Here is a footnote reference,[\[ha]1] and another.[\[ha]longnote]
5583[\[ha]1]: Here is the footnote.
5585[\[ha]longnote]: Here\[aq]s one with multiple blocks.
5587 Subsequent paragraphs are indented to show that they
5588belong to the previous footnote.
5592 The whole paragraph can be indented, or just the first
5593 line. In this way, multi-paragraph footnotes work like
5594 multi-paragraph list items.
5596This paragraph won\[aq]t be part of the note, because it
5601The identifiers in footnote references may not contain spaces, tabs, or
5603These identifiers are used only to correlate the footnote reference with
5604the note itself; in the output, footnotes will be numbered sequentially.
5606The footnotes themselves need not be placed at the end of the document.
5607They may appear anywhere except inside other block elements (lists,
5608block quotes, tables, etc.).
5609Each footnote should be separated from surrounding content (including
5610other footnotes) by blank lines.
5611.SS Extension: \f[C]inline_notes\f[R]
5613Inline footnotes are also allowed (though, unlike regular notes, they
5614cannot contain multiple paragraphs).
5615The syntax is as follows:
5619Here is an inline note.\[ha][Inlines notes are easier to write, since
5620you don\[aq]t have to pick an identifier and move down to type the
5625Inline and regular footnotes may be mixed freely.
5627.SS Extension: \f[C]citations\f[R]
5629Markdown citations go inside square brackets and are separated by
5631Each citation must have a key, composed of `\[at]' + the citation
5632identifier from the database, and may optionally have a prefix, a
5633locator, and a suffix.
5634The citation key must begin with a letter, digit, or \f[C]_\f[R], and
5635may contain alphanumerics, \f[C]_\f[R], and internal punctuation
5636characters (\f[C]:.#$%&-+?<>\[ti]/\f[R]).
5637Here are some examples:
5641Blah blah [see \[at]doe99, pp. 33-35; also \[at]smith04, chap. 1].
5643Blah blah [\[at]doe99, pp. 33-35, 38-39 and *passim*].
5645Blah blah [\[at]smith04; \[at]doe99].
5649\f[C]pandoc\f[R] detects locator terms in the CSL locale files.
5650Either abbreviated or unabbreviated forms are accepted.
5651In the \f[C]en-US\f[R] locale, locator terms can be written in either
5652singular or plural forms, as \f[C]book\f[R],
5653\f[C]bk.\f[R]/\f[C]bks.\f[R]; \f[C]chapter\f[R],
5654\f[C]chap.\f[R]/\f[C]chaps.\f[R]; \f[C]column\f[R],
5655\f[C]col.\f[R]/\f[C]cols.\f[R]; \f[C]figure\f[R],
5656\f[C]fig.\f[R]/\f[C]figs.\f[R]; \f[C]folio\f[R],
5657\f[C]fol.\f[R]/\f[C]fols.\f[R]; \f[C]number\f[R],
5658\f[C]no.\f[R]/\f[C]nos.\f[R]; \f[C]line\f[R],
5659\f[C]l.\f[R]/\f[C]ll.\f[R]; \f[C]note\f[R], \f[C]n.\f[R]/\f[C]nn.\f[R];
5660\f[C]opus\f[R], \f[C]op.\f[R]/\f[C]opp.\f[R]; \f[C]page\f[R],
5661\f[C]p.\f[R]/\f[C]pp.\f[R]; \f[C]paragraph\f[R],
5662\f[C]para.\f[R]/\f[C]paras.\f[R]; \f[C]part\f[R],
5663\f[C]pt.\f[R]/\f[C]pts.\f[R]; \f[C]section\f[R],
5664\f[C]sec.\f[R]/\f[C]secs.\f[R]; \f[C]sub verbo\f[R],
5665\f[C]s.v.\f[R]/\f[C]s.vv.\f[R]; \f[C]verse\f[R],
5666\f[C]v.\f[R]/\f[C]vv.\f[R]; \f[C]volume\f[R],
5667\f[C]vol.\f[R]/\f[C]vols.\f[R]; \f[C]\[ps]\f[R]/\f[C]\[ps]\[ps]\f[R];
5668\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R].
5669If no locator term is used, \[lq]page\[rq] is assumed.
5671\f[C]pandoc\f[R] will use heuristics to distinguish the locator from the
5673In complex cases, the locator can be enclosed in curly braces:
5677[\[at]smith{ii, A, D-Z}, with a suffix]
5678[\[at]smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5682A minus sign (\f[C]-\f[R]) before the \f[C]\[at]\f[R] will suppress
5683mention of the author in the citation.
5684This can be useful when the author is already mentioned in the text:
5688Smith says blah [-\[at]smith04].
5692You can also write an in-text citation, as follows:
5696\[at]smith04 says blah.
5698\[at]smith04 [p. 33] says blah.
5701.SS Non-pandoc extensions
5703The following Markdown syntax extensions are not enabled by default in
5704pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format
5705name, where \f[C]EXTENSION\f[R] is the name of the extension.
5706Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with
5708.SS Extension: \f[C]attributes\f[R]
5710Allows attributes to be attached to any inline or block-level element.
5711The syntax for the attributes is the same as that used in
5712\f[C]header_attributes\f[R].
5714Attributes that occur immediately after an inline element affect that
5716If they follow a space, then they belong to the space.
5717(Hence, this option subsumes \f[C]inline_code_attributes\f[R] and
5718\f[C]link_attributes\f[R].)
5720Attributes that occur immediately before a block element, on a line by
5721themselves, affect that element.
5723Consecutive attribute specifiers may be used, either for blocks or for
5725Their attributes will be combined.
5727Attributes that occur at the end of the text of a Setext or ATX heading
5728(separated by whitespace from the text) affect the heading element.
5729(Hence, this option subsumes \f[C]header_attributes\f[R].)
5731Attributes that occur after the opening fence in a fenced code block
5732affect the code block element.
5733(Hence, this option subsumes \f[C]fenced_code_attributes\f[R].)
5735Attributes that occur at the end of a reference link definition affect
5736links that refer to that definition.
5738Note that pandoc\[cq]s AST does not currently allow attributes to be
5739attached to arbitrary elements.
5740Hence a Span or Div container will be added if needed.
5741.SS Extension: \f[C]old_dashes\f[R]
5743Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5744\f[C]-\f[R] before a numeral is an en-dash, and \f[C]--\f[R] is an
5746This option only has an effect if \f[C]smart\f[R] is enabled.
5747It is selected automatically for \f[C]textile\f[R] input.
5748.SS Extension: \f[C]angle_brackets_escapable\f[R]
5750Allow \f[C]<\f[R] and \f[C]>\f[R] to be backslash-escaped, as they can
5751be in GitHub flavored Markdown but not original Markdown.
5752This is implied by pandoc\[cq]s default \f[C]all_symbols_escapable\f[R].
5753.SS Extension: \f[C]lists_without_preceding_blankline\f[R]
5755Allow a list to occur right after a paragraph, with no intervening blank
5757.SS Extension: \f[C]four_space_rule\f[R]
5759Selects the pandoc <= 2.0 behavior for parsing lists, so that four
5760spaces indent are needed for list item continuation paragraphs.
5761.SS Extension: \f[C]spaced_reference_links\f[R]
5763Allow whitespace between the two components of a reference link, for
5771.SS Extension: \f[C]hard_line_breaks\f[R]
5773Causes all newlines within a paragraph to be interpreted as hard line
5774breaks instead of spaces.
5775.SS Extension: \f[C]ignore_line_breaks\f[R]
5777Causes newlines within a paragraph to be ignored, rather than being
5778treated as spaces or as hard line breaks.
5779This option is intended for use with East Asian languages where spaces
5780are not used between words, but text is divided into lines for
5782.SS Extension: \f[C]east_asian_line_breaks\f[R]
5784Causes newlines within a paragraph to be ignored, rather than being
5785treated as spaces or as hard line breaks, when they occur between two
5786East Asian wide characters.
5787This is a better choice than \f[C]ignore_line_breaks\f[R] for texts that
5788include a mix of East Asian wide characters and other characters.
5789.SS Extension: \f[C]emoji\f[R]
5791Parses textual emojis like \f[C]:smile:\f[R] as Unicode emoticons.
5792.SS Extension: \f[C]tex_math_single_backslash\f[R]
5794Causes anything between \f[C]\[rs](\f[R] and \f[C]\[rs])\f[R] to be
5795interpreted as inline TeX math, and anything between \f[C]\[rs][\f[R]
5796and \f[C]\[rs]]\f[R] to be interpreted as display TeX math.
5797Note: a drawback of this extension is that it precludes escaping
5798\f[C](\f[R] and \f[C][\f[R].
5799.SS Extension: \f[C]tex_math_double_backslash\f[R]
5801Causes anything between \f[C]\[rs]\[rs](\f[R] and \f[C]\[rs]\[rs])\f[R]
5802to be interpreted as inline TeX math, and anything between
5803\f[C]\[rs]\[rs][\f[R] and \f[C]\[rs]\[rs]]\f[R] to be interpreted as
5805.SS Extension: \f[C]markdown_attribute\f[R]
5807By default, pandoc interprets material inside block-level tags as
5809This extension changes the behavior so that Markdown is only parsed
5810inside block-level tags if the tags have the attribute
5811\f[C]markdown=1\f[R].
5812.SS Extension: \f[C]mmd_title_block\f[R]
5814Enables a MultiMarkdown style title block at the top of the document,
5821Date: September 1, 2008
5822Comment: This is a sample mmd title block, with
5823 a field spanning multiple lines.
5827See the MultiMarkdown documentation for details.
5828If \f[C]pandoc_title_block\f[R] or \f[C]yaml_metadata_block\f[R] is
5829enabled, it will take precedence over \f[C]mmd_title_block\f[R].
5830.SS Extension: \f[C]abbreviations\f[R]
5832Parses PHP Markdown Extra abbreviation keys, like
5836*[HTML]: Hypertext Markup Language
5840Note that the pandoc document model does not support abbreviations, so
5841if this extension is enabled, abbreviation keys are simply skipped (as
5842opposed to being parsed as paragraphs).
5843.SS Extension: \f[C]autolink_bare_uris\f[R]
5845Makes all absolute URIs into links, even when not surrounded by pointy
5846braces \f[C]<...>\f[R].
5847.SS Extension: \f[C]mmd_link_attributes\f[R]
5849Parses multimarkdown style key-value attributes on link and image
5851This extension should not be confused with the \f[C]link_attributes\f[R]
5856This is a reference ![image][ref] with multimarkdown attributes.
5858[ref]: https://path.to/image \[dq]Image title\[dq] width=20px height=30px
5859 id=myId class=\[dq]myClass1 myClass2\[dq]
5862.SS Extension: \f[C]mmd_header_identifiers\f[R]
5864Parses multimarkdown style heading identifiers (in square brackets,
5865after the heading but before any trailing \f[C]#\f[R]s in an ATX
5867.SS Extension: \f[C]compact_definition_lists\f[R]
5869Activates the definition list syntax of pandoc 1.12.x and earlier.
5870This syntax differs from the one described above under Definition lists
5873No blank line is required between consecutive items of the definition
5876To get a \[lq]tight\[rq] or \[lq]compact\[rq] list, omit space between
5877consecutive items; the space between a term and its definition does not
5880Lazy wrapping of paragraphs is not allowed: the entire definition must
5881be indented four spaces.
5882.SS Extension: \f[C]gutenberg\f[R]
5884Use Project Gutenberg conventions for \f[C]plain\f[R] output: all-caps
5885for strong emphasis, surround by underscores for regular emphasis, add
5886extra blank space around headings.
5887.SS Markdown variants
5889In addition to pandoc\[cq]s extended Markdown, the following Markdown
5890variants are supported:
5892\f[C]markdown_phpextra\f[R] (PHP Markdown Extra)
5894\f[C]markdown_github\f[R] (deprecated GitHub-Flavored Markdown)
5896\f[C]markdown_mmd\f[R] (MultiMarkdown)
5898\f[C]markdown_strict\f[R] (Markdown.pl)
5900\f[C]commonmark\f[R] (CommonMark)
5902\f[C]gfm\f[R] (Github-Flavored Markdown)
5904\f[C]commonmark_x\f[R] (CommonMark with many pandoc extensions)
5906To see which extensions are supported for a given format, and which are
5907enabled by default, you can use the command
5911pandoc --list-extensions=FORMAT
5915where \f[C]FORMAT\f[R] is replaced with the name of the format.
5917Note that the list of extensions for \f[C]commonmark\f[R],
5918\f[C]gfm\f[R], and \f[C]commonmark_x\f[R] are defined relative to
5920So, for example, \f[C]backtick_code_blocks\f[R] does not appear as an
5921extension, since it is enabled by default and cannot be disabled.
5924When the \f[C]--citeproc\f[R] option is used, pandoc can automatically
5925generate citations and a bibliography in a number of styles.
5930pandoc --citeproc myinput.txt
5934To use this feature, you will need to have
5936a document containing citations (see Extension: \f[C]citations\f[R]);
5938a source of bibliographic data: either an external bibliography file or
5939a list of \f[C]references\f[R] in the document\[cq]s YAML metadata
5941optionally, a CSL citation style.
5942.SS Specifying bibliographic data
5944You can specify an external bibliography using the
5945\f[C]bibliography\f[R] metadata field in a YAML metadata section or the
5946\f[C]--bibliography\f[R] command line argument.
5947If you want to use multiple bibliography files, you can supply multiple
5948\f[C]--bibliography\f[R] arguments or set \f[C]bibliography\f[R]
5949metadata field to YAML array.
5950A bibliography may have any of these formats:
5983Note that \f[C].bib\f[R] can be used with both BibTeX and BibLaTeX
5984files; use the extension \f[C].bibtex\f[R] to force interpretation as
5987In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup inside
5988fields such as \f[C]title\f[R]; in CSL YAML databases, pandoc Markdown;
5989and in CSL JSON databases, an HTML-like markup:
5991\f[B]\f[CB]<i>...</i>\f[B]\f[R]
5994\f[B]\f[CB]<b>...</b>\f[B]\f[R]
5997\f[B]\f[CB]<span style=\[dq]font-variant:small-caps;\[dq]>...</span>\f[B]\f[R] or \f[B]\f[CB]<sc>...</sc>\f[B]\f[R]
6000\f[B]\f[CB]<sub>...</sub>\f[B]\f[R]
6003\f[B]\f[CB]<sup>...</sup>\f[B]\f[R]
6006\f[B]\f[CB]<span class=\[dq]nocase\[dq]>...</span>\f[B]\f[R]
6007prevent a phrase from being capitalized as title case
6009As an alternative to specifying a bibliography file using
6010\f[C]--bibliography\f[R] or the YAML metadata field
6011\f[C]bibliography\f[R], you can include the citation data directly in
6012the \f[C]references\f[R] field of the document\[cq]s YAML metadata.
6013The field should contain an array of YAML-encoded references, for
6020- type: article-journal
6032 title: \[aq]Molecular structure of nucleic acids: a structure for
6033 deoxyribose nucleic acid\[aq]
6034 title-short: Molecular structure of nucleic acids
6035 container-title: Nature
6039 DOI: 10.1038/171737a0
6040 URL: https://www.nature.com/articles/171737a0
6046Note that \f[C]pandoc\f[R] can be used to produce such a YAML metadata
6047section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
6051pandoc chem.bib -s -t markdown
6052pandoc chem.json -s -t markdown
6056\f[C]pandoc\f[R] can also be used to produce CSL JSON bibliography from
6057BibTeX, BibLaTeX, or markdown YAML:
6061pandoc chem.bib -s -t csljson
6062pandoc chem.yaml -s -t csljson
6066Running pandoc on a bibliography file with the \f[C]--citeproc\f[R]
6067option will create a formatted bibliography in the format of your
6072pandoc chem.bib -s --citeproc -o chem.html
6073pandoc chem.bib -s --citeproc -o chem.pdf
6076.SS Capitalization in titles
6078If you are using a bibtex or biblatex bibliography, then observe the
6081English titles should be in title case.
6082Non-English titles should be in sentence case, and the \f[C]langid\f[R]
6083field in biblatex should be set to the relevant language.
6084(The following values are treated as English: \f[C]american\f[R],
6085\f[C]british\f[R], \f[C]canadian\f[R], \f[C]english\f[R],
6086\f[C]australian\f[R], \f[C]newzealand\f[R], \f[C]USenglish\f[R], or
6087\f[C]UKenglish\f[R].)
6089As is standard with bibtex/biblatex, proper names should be protected
6090with curly braces so that they won\[cq]t be lowercased in styles that
6091call for sentence case.
6097title = {My Dinner with {Andre}}
6102In addition, words that should remain lowercase (or camelCase) should be
6108title = {Spin Wave Dispersion on the {nm} Scale}
6112Though this is not necessary in bibtex/biblatex, it is necessary with
6113citeproc, which stores titles internally in sentence case, and converts
6114to title case in styles that require it.
6115Here we protect \[lq]nm\[rq] so that it doesn\[cq]t get converted to
6116\[lq]Nm\[rq] at this stage.
6119If you are using a CSL bibliography (either JSON or YAML), then observe
6122All titles should be in sentence case.
6124Use the \f[C]language\f[R] field for non-English titles to prevent their
6125conversion to title case in styles that call for this.
6126(Conversion happens only if \f[C]language\f[R] begins with \f[C]en\f[R]
6129Protect words that should not be converted to title case using this
6135Spin wave dispersion on the <span class=\[dq]nocase\[dq]>nm</span> scale
6139.SS Conference Papers, Published vs.\ Unpublished
6141For a formally published conference paper, use the biblatex entry type
6142\f[C]inproceedings\f[R] (which will be mapped to CSL
6143\f[C]paper-conference\f[R]).
6145For an unpublished manuscript, use the biblatex entry type
6146\f[C]unpublished\f[R] without an \f[C]eventtitle\f[R] field (this entry
6147type will be mapped to CSL \f[C]manuscript\f[R]).
6149For a talk, an unpublished conference paper, or a poster presentation,
6150use the biblatex entry type \f[C]unpublished\f[R] with an
6151\f[C]eventtitle\f[R] field (this entry type will be mapped to CSL
6153Use the biblatex \f[C]type\f[R] field to indicate the type,
6154e.g.\ \[lq]Paper\[rq], or \[lq]Poster\[rq].
6155\f[C]venue\f[R] and \f[C]eventdate\f[R] may be useful too, though
6156\f[C]eventdate\f[R] will not be rendered by most CSL styles.
6157Note that \f[C]venue\f[R] is for the event\[cq]s venue, unlike
6158\f[C]location\f[R] which describes the publisher\[cq]s location; do not
6159use the latter for an unpublished conference paper.
6160.SS Specifying a citation style
6162Citations and references can be formatted using any style supported by
6163the Citation Style Language, listed in the Zotero Style Repository.
6164These files are specified using the \f[C]--csl\f[R] option or the
6165\f[C]csl\f[R] (or \f[C]citation-style\f[R]) metadata field.
6166By default, pandoc will use the Chicago Manual of Style author-date
6168(You can override this default by copying a CSL style of your choice to
6169\f[C]default.csl\f[R] in your user data directory.) The CSL project
6170provides further information on finding and editing styles.
6172The \f[C]--citation-abbreviations\f[R] option (or the
6173\f[C]citation-abbreviations\f[R] metadata field) may be used to specify
6174a JSON file containing abbreviations of journals that should be used in
6175formatted bibliographies when \f[C]form=\[dq]short\[dq]\f[R] is
6177The format of the file can be illustrated with an example:
6181{ \[dq]default\[dq]: {
6182 \[dq]container-title\[dq]: {
6183 \[dq]Lloyd\[aq]s Law Reports\[dq]: \[dq]Lloyd\[aq]s Rep\[dq],
6184 \[dq]Estates Gazette\[dq]: \[dq]EG\[dq],
6185 \[dq]Scots Law Times\[dq]: \[dq]SLT\[dq]
6191.SS Raw content in a style
6193To include raw content in a prefix, suffix, delimiter, or term, surround
6194it with these tags indicating the format:
6198{{jats}}<ref>{{/jats}}
6202Without the tags, the string will be interpreted as a string and escaped
6203in the output, rather than being passed through raw.
6205This feature allows stylesheets to be customized to give different
6206output for different output formats.
6207However, stylesheets customized in this way will not be useable by other
6209.SS Placement of the bibliography
6211If the style calls for a list of works cited, it will be placed in a div
6212with id \f[C]refs\f[R], if one exists:
6221Otherwise, it will be placed at the end of the document.
6222Generation of the bibliography can be suppressed by setting
6223\f[C]suppress-bibliography: true\f[R] in the YAML metadata.
6225If you wish the bibliography to have a section heading, you can set
6226\f[C]reference-section-title\f[R] in the metadata, or put the heading at
6227the beginning of the div with id \f[C]refs\f[R] (if you are using it) or
6228at the end of your document:
6238The bibliography will be inserted after this heading.
6239Note that the \f[C]unnumbered\f[R] class will be added to this heading,
6240so that the section will not be numbered.
6241.SS Including uncited items in the bibliography
6243If you want to include items in the bibliography without actually citing
6244them in the body text, you can define a dummy \f[C]nocite\f[R] metadata
6245field and put the citations there:
6251 \[at]item1, \[at]item2
6258In this example, the document will contain a citation for
6259\f[C]item3\f[R] only, but the bibliography will contain entries for
6260\f[C]item1\f[R], \f[C]item2\f[R], and \f[C]item3\f[R].
6262It is possible to create a bibliography with all the citations, whether
6263or not they appear in the document, by using a wildcard:
6274For LaTeX output, you can also use \f[C]natbib\f[R] or
6275\f[C]biblatex\f[R] to render the bibliography.
6276In order to do so, specify bibliography files as outlined above, and add
6277\f[C]--natbib\f[R] or \f[C]--biblatex\f[R] argument to \f[C]pandoc\f[R]
6279Bear in mind that bibliography files have to be in either BibTeX (for
6280\f[C]--natbib\f[R]) or BibLaTeX (for \f[C]--biblatex\f[R]) format.
6281.SS Other relevant metadata fields
6283A few other metadata fields affect bibliography formatting:
6285\f[B]\f[CB]link-citation\f[B]\f[R]
6286If true, citations will be hyperlinked to the corresponding bibliography
6287entries (for author-date and numerical styles only).
6289\f[B]\f[CB]lang\f[B]\f[R]
6290The \f[C]lang\f[R] field will affect how the style is localized, for
6291example in the translation of labels and the use of quotation marks.
6292(For backwards compatibility, \f[C]locale\f[R] may be used instead of
6293\f[C]lang\f[R], but this use is deprecated.)
6295\f[B]\f[CB]notes-after-punctuation\f[B]\f[R]
6296If true (the default), pandoc will put footnote citations after
6297following punctuation.
6298For example, if the source contains \f[C]blah blah [\[at]jones99].\f[R],
6299the result will look like \f[C]blah blah.[\[ha]1]\f[R], with the note
6300moved after the period and the space collapsed.
6301If false, the space will still be collapsed, but the footnote will not
6302be moved after the punctuation.
6305You can use pandoc to produce an HTML + JavaScript slide presentation
6306that can be viewed via a web browser.
6307There are five ways to do this, using S5, DZSlides, Slidy, Slideous, or
6309You can also produce a PDF slide show using LaTeX \f[C]beamer\f[R], or
6310slides shows in Microsoft PowerPoint format.
6312Here\[cq]s the Markdown source for a simple slide show,
6313\f[C]habits.txt\f[R]:
6342
6351To produce an HTML/JavaScript slide show, simply type
6355pandoc -t FORMAT -s habits.txt -o habits.html
6359where \f[C]FORMAT\f[R] is either \f[C]s5\f[R], \f[C]slidy\f[R],
6360\f[C]slideous\f[R], \f[C]dzslides\f[R], or \f[C]revealjs\f[R].
6362For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with
6363the \f[C]-s/--standalone\f[R] option embeds a link to JavaScript and CSS
6364files, which are assumed to be available at the relative path
6365\f[C]s5/default\f[R] (for S5), \f[C]slideous\f[R] (for Slideous),
6366\f[C]reveal.js\f[R] (for reveal.js), or at the Slidy website at
6367\f[C]w3.org\f[R] (for Slidy).
6368(These paths can be changed by setting the \f[C]slidy-url\f[R],
6369\f[C]slideous-url\f[R], \f[C]revealjs-url\f[R], or \f[C]s5-url\f[R]
6370variables; see Variables for HTML slides, above.) For DZSlides, the
6371(relatively short) JavaScript and CSS are included in the file by
6374With all HTML slide formats, the \f[C]--self-contained\f[R] option can
6375be used to produce a single file that contains all of the data necessary
6376to display the slide show, including linked scripts, stylesheets,
6379To produce a PDF slide show using beamer, type
6383pandoc -t beamer habits.txt -o habits.pdf
6387Note that a reveal.js slide show can also be converted to a PDF by
6388printing it to a file from the browser.
6390To produce a Powerpoint slide show, type
6394pandoc habits.txt -o habits.pptx
6397.SS Structuring the slide show
6399By default, the \f[I]slide level\f[R] is the highest heading level in
6400the hierarchy that is followed immediately by content, and not another
6401heading, somewhere in the document.
6402In the example above, level-1 headings are always followed by level-2
6403headings, which are followed by content, so the slide level is 2.
6404This default can be overridden using the \f[C]--slide-level\f[R] option.
6406The document is carved up into slides according to the following rules:
6408A horizontal rule always starts a new slide.
6410A heading at the slide level always starts a new slide.
6412Headings \f[I]below\f[R] the slide level in the hierarchy create
6413headings \f[I]within\f[R] a slide.
6415Headings \f[I]above\f[R] the slide level in the hierarchy create
6416\[lq]title slides,\[rq] which just contain the section title and help to
6417break the slide show into sections.
6418Non-slide content under these headings will be included on the title
6419slide (for HTML slide shows) or in a subsequent slide with the same
6422A title page is constructed automatically from the document\[cq]s title
6424(In the case of beamer, this can be disabled by commenting out some
6425lines in the default template.)
6427These rules are designed to support many different styles of slide show.
6428If you don\[cq]t care about structuring your slides into sections and
6429subsections, you can just use level-1 headings for all each slide.
6430(In that case, level-1 will be the slide level.) But you can also
6431structure the slide show into sections, as in the example above.
6433Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
6434layout will be produced, with level-1 headings building horizontally and
6435level-2 headings building vertically.
6436It is not recommended that you use deeper nesting of section levels with
6438.SS Incremental lists
6440By default, these writers produce lists that display \[lq]all at
6441once.\[rq] If you want your lists to display incrementally (one item at
6442a time), use the \f[C]-i\f[R] option.
6443If you want a particular list to depart from the default, put it in a
6444\f[C]div\f[R] block with class \f[C]incremental\f[R] or
6445\f[C]nonincremental\f[R].
6446So, for example, using the \f[C]fenced div\f[R] syntax, the following
6447would be incremental regardless of the document default:
6473While using \f[C]incremental\f[R] and \f[C]nonincremental\f[R] divs are
6474the recommended method of setting incremental lists on a per-case basis,
6475an older method is also supported: putting lists inside a blockquote
6476will depart from the document default (that is, it will display
6477incrementally without the \f[C]-i\f[R] option and all at once with the
6478\f[C]-i\f[R] option):
6487Both methods allow incremental and nonincremental lists to be mixed in a
6490Note: Neither the \f[C]-i/--incremental\f[R] option nor any of the
6491methods described here currently works for PowerPoint output.
6494You can add \[lq]pauses\[rq] within a slide by including a paragraph
6495containing three dots, separated by spaces:
6501content before the pause
6505content after the pause
6509Note: this feature is not yet implemented for PowerPoint output.
6510.SS Styling the slides
6512You can change the style of HTML slides by putting customized CSS files
6513in \f[C]$DATADIR/s5/default\f[R] (for S5), \f[C]$DATADIR/slidy\f[R] (for
6514Slidy), or \f[C]$DATADIR/slideous\f[R] (for Slideous), where
6515\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
6517The originals may be found in pandoc\[cq]s system data directory
6518(generally \f[C]$CABALDIR/pandoc-VERSION/s5/default\f[R]).
6519Pandoc will look there for any files it does not find in the user data
6522For dzslides, the CSS is included in the HTML file itself, and may be
6525All reveal.js configuration options can be set through variables.
6526For example, themes can be used by setting the \f[C]theme\f[R] variable:
6534Or you can specify a custom stylesheet using the \f[C]--css\f[R] option.
6536To style beamer slides, you can specify a \f[C]theme\f[R],
6537\f[C]colortheme\f[R], \f[C]fonttheme\f[R], \f[C]innertheme\f[R], and
6538\f[C]outertheme\f[R], using the \f[C]-V\f[R] option:
6542pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
6546Note that heading attributes will turn into slide attributes (on a
6547\f[C]<div>\f[R] or \f[C]<section>\f[R]) in HTML slide formats, allowing
6548you to style individual slides.
6549In beamer, the only heading attribute that affects slides is the
6550\f[C]allowframebreaks\f[R] class, which sets the
6551\f[C]allowframebreaks\f[R] option, causing multiple slides to be created
6552if the content overfills the frame.
6553This is recommended especially for bibliographies:
6557# References {.allowframebreaks}
6562Speaker notes are supported in reveal.js and PowerPoint (pptx) output.
6563You can add notes to your Markdown document thus:
6571- It can contain Markdown
6578To show the notes window in reveal.js, press \f[C]s\f[R] while viewing
6580Speaker notes in PowerPoint will be available, as usual, in handouts and
6583Notes are not yet supported for other slide formats, but the notes will
6584not appear on the slides themselves.
6587To put material in side by side columns, you can use a native div
6588container with class \f[C]columns\f[R], containing two or more div
6589containers with class \f[C]column\f[R] and a \f[C]width\f[R] attribute:
6593:::::::::::::: {.columns}
6594::: {.column width=\[dq]40%\[dq]}
6597::: {.column width=\[dq]60%\[dq]}
6603.SS Additional columns attributes in beamer
6605The div containers with classes \f[C]columns\f[R] and \f[C]column\f[R]
6606can optionally have an \f[C]align\f[R] attribute.
6607The class \f[C]columns\f[R] can optionally have a \f[C]totalwidth\f[R]
6608attribute or an \f[C]onlytextwidth\f[R] class.
6612:::::::::::::: {.columns align=center totalwidth=8em}
6613::: {.column width=\[dq]40%\[dq]}
6616::: {.column width=\[dq]60%\[dq] align=bottom}
6623The \f[C]align\f[R] attributes on \f[C]columns\f[R] and \f[C]column\f[R]
6624can be used with the values \f[C]top\f[R], \f[C]top-baseline\f[R],
6625\f[C]center\f[R] and \f[C]bottom\f[R] to vertically align the columns.
6626It defaults to \f[C]top\f[R] in \f[C]columns\f[R].
6628The \f[C]totalwidth\f[R] attribute limits the width of the columns to
6633:::::::::::::: {.columns align=top .onlytextwidth}
6634::: {.column width=\[dq]40%\[dq] align=center}
6637::: {.column width=\[dq]60%\[dq]}
6644The class \f[C]onlytextwidth\f[R] sets the \f[C]totalwidth\f[R] to
6645\f[C]\[rs]textwidth\f[R].
6647See Section 12.7 of the Beamer User\[cq]s Guide for more details.
6648.SS Frame attributes in beamer
6650Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[R] option to
6651a frame in beamer (for example, when using the \f[C]minted\f[R]
6653This can be forced by adding the \f[C]fragile\f[R] class to the heading
6654introducing the slide:
6658# Fragile slide {.fragile}
6662All of the other frame attributes described in Section 8.1 of the Beamer
6663User\[cq]s Guide may also be used: \f[C]allowdisplaybreaks\f[R],
6664\f[C]allowframebreaks\f[R], \f[C]b\f[R], \f[C]c\f[R], \f[C]t\f[R],
6665\f[C]environment\f[R], \f[C]label\f[R], \f[C]plain\f[R],
6666\f[C]shrink\f[R], \f[C]standout\f[R], \f[C]noframenumbering\f[R].
6667.SS Background in reveal.js and beamer
6669Background images can be added to self-contained reveal.js slideshows
6670and to beamer slideshows.
6672For the same image on every slide, use the configuration option
6673\f[C]background-image\f[R] either in the YAML metadata block or as a
6674command-line variable.
6675(There are no other options in beamer and the rest of this section
6676concerns reveal.js slideshows.)
6678For reveal.js, you can instead use the reveal.js-native option
6679\f[C]parallaxBackgroundImage\f[R].
6680You can also set \f[C]parallaxBackgroundHorizontal\f[R] and
6681\f[C]parallaxBackgroundVertical\f[R] the same way and must also set
6682\f[C]parallaxBackgroundSize\f[R] to have your values take effect.
6684To set an image for a particular reveal.js slide, add
6685\f[C]{data-background-image=\[dq]/path/to/image\[dq]}\f[R] to the first
6686slide-level heading on the slide (which may even be empty).
6688In reveal.js\[cq]s overview mode, the parallaxBackgroundImage will show
6689up only on the first slide.
6691Other reveal.js background settings also work on individual slides,
6692including \f[C]data-background-size\f[R],
6693\f[C]data-background-repeat\f[R], \f[C]data-background-color\f[R],
6694\f[C]data-transition\f[R], and \f[C]data-transition-speed\f[R].
6696To add a background image to the automatically generated title slide,
6697use the \f[C]title-slide-attributes\f[R] variable in the YAML metadata
6699It must contain a map of attribute names and values.
6701See the reveal.js documentation for more details.
6703For example in reveal.js:
6709parallaxBackgroundImage: /path/to/my/background_image.png
6710title-slide-attributes:
6711 data-background-image: /path/to/title_image.png
6712 data-background-size: contain
6717Slide 1 has background_image.png as its background.
6719## {data-background-image=\[dq]/path/to/special_image.jpg\[dq]}
6721Slide 2 has a special image for its background, even though the heading has no content.
6727EPUB metadata may be specified using the \f[C]--epub-metadata\f[R]
6728option, but if the source document is Markdown, it is better to use a
6739 text: An investigation of metadata
6747 text: doi:10.234234.234/33
6749rights: \[co] 2007 John Smith, CC BY-NC
6756The following fields are recognized:
6758\f[B]\f[CB]identifier\f[B]\f[R]
6759Either a string value or an object with fields \f[C]text\f[R] and
6761Valid values for \f[C]scheme\f[R] are \f[C]ISBN-10\f[R],
6762\f[C]GTIN-13\f[R], \f[C]UPC\f[R], \f[C]ISMN-10\f[R], \f[C]DOI\f[R],
6763\f[C]LCCN\f[R], \f[C]GTIN-14\f[R], \f[C]ISBN-13\f[R],
6764\f[C]Legal deposit number\f[R], \f[C]URN\f[R], \f[C]OCLC\f[R],
6765\f[C]ISMN-13\f[R], \f[C]ISBN-A\f[R], \f[C]JP\f[R], \f[C]OLCC\f[R].
6767\f[B]\f[CB]title\f[B]\f[R]
6768Either a string value, or an object with fields \f[C]file-as\f[R] and
6769\f[C]type\f[R], or a list of such objects.
6770Valid values for \f[C]type\f[R] are \f[C]main\f[R], \f[C]subtitle\f[R],
6771\f[C]short\f[R], \f[C]collection\f[R], \f[C]edition\f[R],
6774\f[B]\f[CB]creator\f[B]\f[R]
6775Either a string value, or an object with fields \f[C]role\f[R],
6776\f[C]file-as\f[R], and \f[C]text\f[R], or a list of such objects.
6777Valid values for \f[C]role\f[R] are MARC relators, but pandoc will
6778attempt to translate the human-readable versions (like \[lq]author\[rq]
6779and \[lq]editor\[rq]) to the appropriate marc relators.
6781\f[B]\f[CB]contributor\f[B]\f[R]
6782Same format as \f[C]creator\f[R].
6784\f[B]\f[CB]date\f[B]\f[R]
6785A string value in \f[C]YYYY-MM-DD\f[R] format.
6786(Only the year is necessary.) Pandoc will attempt to convert other
6789\f[B]\f[CB]lang\f[B]\f[R] (or legacy: \f[B]\f[CB]language\f[B]\f[R])
6790A string value in BCP 47 format.
6791Pandoc will default to the local language if nothing is specified.
6793\f[B]\f[CB]subject\f[B]\f[R]
6794A string value or a list of such values.
6796\f[B]\f[CB]description\f[B]\f[R]
6799\f[B]\f[CB]type\f[B]\f[R]
6802\f[B]\f[CB]format\f[B]\f[R]
6805\f[B]\f[CB]relation\f[B]\f[R]
6808\f[B]\f[CB]coverage\f[B]\f[R]
6811\f[B]\f[CB]rights\f[B]\f[R]
6814\f[B]\f[CB]cover-image\f[B]\f[R]
6815A string value (path to cover image).
6817\f[B]\f[CB]css\f[B]\f[R] (or legacy: \f[B]\f[CB]stylesheet\f[B]\f[R])
6818A string value (path to CSS stylesheet).
6820\f[B]\f[CB]page-progression-direction\f[B]\f[R]
6821Either \f[C]ltr\f[R] or \f[C]rtl\f[R].
6822Specifies the \f[C]page-progression-direction\f[R] attribute for the
6823\f[C]spine\f[R] element.
6825\f[B]\f[CB]ibooks\f[B]\f[R]
6826iBooks-specific metadata, with the following fields:
6829\f[C]version\f[R]: (string)
6831\f[C]specified-fonts\f[R]: \f[C]true\f[R]|\f[C]false\f[R] (default
6834\f[C]ipad-orientation-lock\f[R]:
6835\f[C]portrait-only\f[R]|\f[C]landscape-only\f[R]
6837\f[C]iphone-orientation-lock\f[R]:
6838\f[C]portrait-only\f[R]|\f[C]landscape-only\f[R]
6840\f[C]binding\f[R]: \f[C]true\f[R]|\f[C]false\f[R] (default
6843\f[C]scroll-axis\f[R]:
6844\f[C]vertical\f[R]|\f[C]horizontal\f[R]|\f[C]default\f[R]
6846.SS The \f[C]epub:type\f[R] attribute
6848For \f[C]epub3\f[R] output, you can mark up the heading that corresponds
6849to an EPUB chapter using the \f[C]epub:type\f[R] attribute.
6850For example, to set the attribute to the value \f[C]prologue\f[R], use
6855# My chapter {epub:type=prologue}
6859Which will result in:
6863<body epub:type=\[dq]frontmatter\[dq]>
6864 <section epub:type=\[dq]prologue\[dq]>
6869Pandoc will output \f[C]<body epub:type=\[dq]bodymatter\[dq]>\f[R],
6870unless you use one of the following values, in which case either
6871\f[C]frontmatter\f[R] or \f[C]backmatter\f[R] will be output.
6877\f[C]epub:type\f[R] of first section
6879\f[C]epub:type\f[R] of body
6990By default, pandoc will download media referenced from any
6991\f[C]<img>\f[R], \f[C]<audio>\f[R], \f[C]<video>\f[R] or
6992\f[C]<source>\f[R] element present in the generated EPUB, and include it
6993in the EPUB container, yielding a completely self-contained EPUB.
6994If you want to link to external media resources instead, use raw HTML in
6995your source and add \f[C]data-external=\[dq]1\[dq]\f[R] to the tag with
6996the \f[C]src\f[R] attribute.
7001<audio controls=\[dq]1\[dq]>
7002 <source src=\[dq]https://example.com/music/toccata.mp3\[dq]
7003 data-external=\[dq]1\[dq] type=\[dq]audio/mpeg\[dq]>
7008.SH JUPYTER NOTEBOOKS
7010When creating a Jupyter notebook, pandoc will try to infer the notebook
7012Code blocks with the class \f[C]code\f[R] will be taken as code cells,
7013and intervening content will be taken as Markdown cells.
7014Attachments will automatically be created for images in Markdown cells.
7015Metadata will be taken from the \f[C]jupyter\f[R] metadata field.
7026 display_name: Python 2
7033 file_extension: \[dq].py\[dq]
7034 mimetype: \[dq]text/x-python\[dq]
7035 name: \[dq]python\[dq]
7036 nbconvert_exporter: \[dq]python\[dq]
7037 pygments_lexer: \[dq]ipython2\[dq]
7038 version: \[dq]2.7.15\[dq]
7043**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
7044bibendum felis dictum sodales.
7047print(\[dq]hello\[dq])
7053from IPython.display import HTML
7056console.log(\[dq]hello\[dq]);
7064This image  will be
7065included as a cell attachment.
7069If you want to add cell attributes, group cells differently, or add
7070output to code cells, then you need to include divs to indicate the
7072You can use either fenced divs or native divs for this.
7077:::::: {.cell .markdown}
7080**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
7081bibendum felis dictum sodales.
7084:::::: {.cell .code execution_count=1}
7085\[ga]\[ga]\[ga] {.python}
7086print(\[dq]hello\[dq])
7089::: {.output .stream .stdout}
7096:::::: {.cell .code execution_count=2}
7097\[ga]\[ga]\[ga] {.python}
7098from IPython.display import HTML
7101console.log(\[dq]hello\[dq]);
7107::: {.output .execute_result execution_count=2}
7108\[ga]\[ga]\[ga]{=html}
7110console.log(\[dq]hello\[dq]);
7120If you include raw HTML or TeX in an output cell, use the [raw
7121attribute][Extension: \f[C]fenced_attribute\f[R]], as shown in the last
7122cell of the example above.
7123Although pandoc can process \[lq]bare\[rq] raw HTML and TeX, the result
7124is often interspersed raw elements and normal textual elements, and in
7125an output cell pandoc expects a single, connected raw block.
7126To avoid using raw HTML or TeX except when marked explicitly using raw
7127attributes, we recommend specifying the extensions
7128\f[C]-raw_html-raw_tex+raw_attribute\f[R] when translating between
7129Markdown and ipynb notebooks.
7131Note that options and extensions that affect reading and writing of
7132Markdown will also affect Markdown cells in ipynb notebooks.
7133For example, \f[C]--wrap=preserve\f[R] will preserve soft line breaks in
7134Markdown cells; \f[C]--atx-headers\f[R] will cause ATX-style headings to
7135be used; and \f[C]--preserve-tabs\f[R] will prevent tabs from being
7137.SH SYNTAX HIGHLIGHTING
7139Pandoc will automatically highlight syntax in fenced code blocks that
7140are marked with a language name.
7141The Haskell library skylighting is used for highlighting.
7142Currently highlighting is supported only for HTML, EPUB, Docx, Ms, and
7144To see a list of language names that pandoc will recognize, type
7145\f[C]pandoc --list-highlight-languages\f[R].
7147The color scheme can be selected using the \f[C]--highlight-style\f[R]
7149The default color scheme is \f[C]pygments\f[R], which imitates the
7150default color scheme used by the Python library pygments (though
7151pygments is not actually used to do the highlighting).
7152To see a list of highlight styles, type
7153\f[C]pandoc --list-highlight-styles\f[R].
7155If you are not satisfied with the predefined styles, you can use
7156\f[C]--print-highlight-style\f[R] to generate a JSON \f[C].theme\f[R]
7157file which can be modified and used as the argument to
7158\f[C]--highlight-style\f[R].
7159To get a JSON version of the \f[C]pygments\f[R] style, for example:
7163pandoc --print-highlight-style pygments > my.theme
7167Then edit \f[C]my.theme\f[R] and use it like this:
7171pandoc --highlight-style my.theme
7175If you are not satisfied with the built-in highlighting, or you want
7176highlight a language that isn\[cq]t supported, you can use the
7177\f[C]--syntax-definition\f[R] option to load a KDE-style XML syntax
7179Before writing your own, have a look at KDE\[cq]s repository of syntax
7182To disable highlighting, use the \f[C]--no-highlight\f[R] option.
7185Custom styles can be used in the docx and ICML formats.
7188By default, pandoc\[cq]s docx and ICML output applies a predefined set
7189of styles for blocks such as paragraphs and block quotes, and uses
7190largely default formatting (italics, bold) for inlines.
7191This will work for most purposes, especially alongside a
7192\f[C]reference.docx\f[R] file.
7193However, if you need to apply your own styles to blocks, or match a
7194preexisting set of styles, pandoc allows you to define custom styles for
7195blocks and text using \f[C]div\f[R]s and \f[C]span\f[R]s, respectively.
7197If you define a \f[C]div\f[R] or \f[C]span\f[R] with the attribute
7198\f[C]custom-style\f[R], pandoc will apply your specified style to the
7199contained elements (with the exception of elements whose function
7200depends on a style, like headings, code blocks, block quotes, or links).
7201So, for example, using the \f[C]bracketed_spans\f[R] syntax,
7205[Get out]{custom-style=\[dq]Emphatically\[dq]}, he said.
7209would produce a docx file with \[lq]Get out\[rq] styled with character
7210style \f[C]Emphatically\f[R].
7211Similarly, using the \f[C]fenced_divs\f[R] syntax,
7215Dickinson starts the poem simply:
7217::: {custom-style=\[dq]Poetry\[dq]}
7218| A Bird came down the Walk---
7219| He did not know I saw---
7224would style the two contained lines with the \f[C]Poetry\f[R] paragraph
7227For docx output, styles will be defined in the output file as inheriting
7228from normal text, if the styles are not yet in your reference.docx.
7229If they are already defined, pandoc will not alter the definition.
7231This feature allows for greatest customization in conjunction with
7233If you want all paragraphs after block quotes to be indented, you can
7234write a filter to apply the styles necessary.
7235If you want all italics to be transformed to the \f[C]Emphasis\f[R]
7236character style (perhaps to change their color), you can write a filter
7237which will transform all italicized inlines to inlines within an
7238\f[C]Emphasis\f[R] custom-style \f[C]span\f[R].
7240For docx output, you don\[cq]t need to enable any extensions for custom
7244The docx reader, by default, only reads those styles that it can convert
7245into pandoc elements, either by direct conversion or interpreting the
7246derivation of the input document\[cq]s styles.
7248By enabling the \f[C]styles\f[R] extension in the docx reader
7249(\f[C]-f docx+styles\f[R]), you can produce output that maintains the
7250styles of the input document, using the \f[C]custom-style\f[R] class.
7251Paragraph styles are interpreted as divs, while character styles are
7252interpreted as spans.
7254For example, using the \f[C]custom-style-reference.docx\f[R] file in the
7255test directory, we have the following different outputs:
7257Without the \f[C]+styles\f[R] extension:
7261$ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
7264This is text with an *emphasized* text style. And this is text with a
7265**strengthened** text style.
7267> Here is a styled paragraph that inherits from Block Text.
7271And with the extension:
7275$ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
7277::: {custom-style=\[dq]First Paragraph\[dq]}
7281::: {custom-style=\[dq]Body Text\[dq]}
7282This is text with an [emphasized]{custom-style=\[dq]Emphatic\[dq]} text style.
7283And this is text with a [strengthened]{custom-style=\[dq]Strengthened\[dq]}
7287::: {custom-style=\[dq]My Block Style\[dq]}
7288> Here is a styled paragraph that inherits from Block Text.
7293With these custom styles, you can use your input document as a
7294reference-doc while creating docx output (see below), and maintain the
7295same styles in your input and output files.
7298Pandoc can be extended with custom writers written in Lua.
7299(Pandoc includes a Lua interpreter, so Lua need not be installed
7302To use a custom writer, simply specify the path to the Lua script in
7303place of the output format.
7308pandoc -t data/sample.lua
7312Creating a custom writer requires writing a Lua function for each
7313possible element in a pandoc document.
7314To get a documented example which you can modify according to your
7319pandoc --print-default-data-file sample.lua
7323Note that custom writers have no default template.
7324If you want to use \f[C]--standalone\f[R] with a custom writer, you will
7325need to specify a template manually using \f[C]--template\f[R] or add a
7326new default template with the name
7327\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
7328subdirectory of your user data directory (see Templates).
7329.SH A NOTE ON SECURITY
7331If you use pandoc to convert user-contributed content in a web
7332application, here are some things to keep in mind:
7334Although pandoc itself will not create or modify any files other than
7335those you explicitly ask it create (with the exception of temporary
7336files used in producing PDFs), a filter or custom writer could in
7337principle do anything on your file system.
7338Please audit filters and custom writers very carefully before using
7341If your application uses pandoc as a Haskell library (rather than
7342shelling out to the executable), it is possible to use it in a mode that
7343fully isolates pandoc from your file system, by running the pandoc
7344operations in the \f[C]PandocPure\f[R] monad.
7345See the document Using the pandoc API for more details.
7347Pandoc\[cq]s parsers can exhibit pathological performance on some corner
7349It is wise to put any pandoc operations under a timeout, to avoid DOS
7350attacks that exploit these issues.
7351If you are using the pandoc executable, you can add the command line
7352options \f[C]+RTS -M512M -RTS\f[R] (for example) to limit the heap size
7355The HTML generated by pandoc is not guaranteed to be safe.
7356If \f[C]raw_html\f[R] is enabled for the Markdown input, users can
7357inject arbitrary HTML.
7358Even if \f[C]raw_html\f[R] is disabled, users can include dangerous
7359content in attributes for headings, spans, and code blocks.
7360To be safe, you should run all the generated HTML through an HTML
7364Copyright 2006\[en]2020 John MacFarlane (jgm\[at]berkeley.edu).
7365Released under the GPL, version 2 or greater.
7366This software carries no warranty of any kind.
7367(See COPYRIGHT for full copyright and warranty notices.) For a full list
7368of contributors, see the file AUTHORS.md in the pandoc source code.
7370The Pandoc source code and all documentation may be downloaded
7371from <http://pandoc.org>.
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