2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: https://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`ifxetex`], [`ifluatex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `lualatex` uses
147[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149`mathspec` variable is set, `xelatex` will use [`mathspec`]
150instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151packages are used if available, and [`csquotes`] will be used
152for [typography] if the `csquotes` variable or metadata field is
153set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`ifluatex`]: https://ctan.org/pkg/ifluatex
184[`ifxetex`]: https://ctan.org/pkg/ifxetex
185[`listings`]: https://ctan.org/pkg/listings
186[`lm`]: https://ctan.org/pkg/lm
187[`longtable`]: https://ctan.org/pkg/longtable
188[`mathspec`]: https://ctan.org/pkg/mathspec
189[`microtype`]: https://ctan.org/pkg/microtype
190[`natbib`]: https://ctan.org/pkg/natbib
191[`parskip`]: https://ctan.org/pkg/parskip
192[`polyglossia`]: https://ctan.org/pkg/polyglossia
193[`prince`]: https://www.princexml.com/
194[`setspace`]: https://ctan.org/pkg/setspace
195[`ulem`]: https://ctan.org/pkg/ulem
196[`unicode-math`]: https://ctan.org/pkg/unicode-math
197[`upquote`]: https://ctan.org/pkg/upquote
198[`weasyprint`]: https://weasyprint.org
199[`wkhtmltopdf`]: https://wkhtmltopdf.org
200[`xcolor`]: https://ctan.org/pkg/xcolor
201[`xecjk`]: https://ctan.org/pkg/xecjk
202[`xurl`]: https://ctan.org/pkg/xurl
203[`selnolig`]: https://ctan.org/pkg/selnolig
207## Reading from the Web
209Instead of an input file, an absolute URI may be given. In this case
210pandoc will fetch the content using HTTP:
212 pandoc -f html -t markdown https://www.fsf.org
214It is possible to supply a custom User-Agent string or other
215header when requesting a document from a URL:
217 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
222## General options {.options}
224`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
226: Specify input format. *FORMAT* can be:
229 - `bibtex` ([BibTeX] bibliography)
230 - `biblatex` ([BibLaTeX] bibliography)
231 - `commonmark` ([CommonMark] Markdown)
232 - `commonmark_x` ([CommonMark] Markdown with extensions)
233 - `creole` ([Creole 1.0])
234 - `csljson` ([CSL JSON] bibliography)
235 - `csv` ([CSV] table)
236 - `docbook` ([DocBook])
237 - `docx` ([Word docx])
238 - `dokuwiki` ([DokuWiki markup])
240 - `fb2` ([FictionBook2] e-book)
241 - `gfm` ([GitHub-Flavored Markdown]),
242 or the deprecated and less accurate `markdown_github`;
243 use [`markdown_github`](#markdown-variants) only
244 if you need extensions not supported in [`gfm`](#markdown-variants).
245 - `haddock` ([Haddock markup])
247 - `ipynb` ([Jupyter notebook])
248 - `jats` ([JATS] XML)
249 - `jira` ([Jira]/Confluence wiki markup)
250 - `json` (JSON version of native AST)
252 - `markdown` ([Pandoc's Markdown])
253 - `markdown_mmd` ([MultiMarkdown])
254 - `markdown_phpextra` ([PHP Markdown Extra])
255 - `markdown_strict` (original unextended [Markdown])
256 - `mediawiki` ([MediaWiki markup])
259 - `native` (native Haskell)
262 - `org` ([Emacs Org mode])
263 - `rst` ([reStructuredText])
265 - `textile` ([Textile])
266 - `tikiwiki` ([TikiWiki markup])
267 - `twiki` ([TWiki markup])
268 - `vimwiki` ([Vimwiki])
271 Extensions can be individually enabled or disabled by
272 appending `+EXTENSION` or `-EXTENSION` to the format name.
273 See [Extensions] below, for a list of extensions and
274 their names. See `--list-input-formats` and `--list-extensions`,
277`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
279: Specify output format. *FORMAT* can be:
281 ::: {#output-formats}
282 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283 - `beamer` ([LaTeX beamer][`beamer`] slide show)
284 - `commonmark` ([CommonMark] Markdown)
285 - `commonmark_x` ([CommonMark] Markdown with extensions)
286 - `context` ([ConTeXt])
287 - `csljson` ([CSL JSON] bibliography)
288 - `docbook` or `docbook4` ([DocBook] 4)
289 - `docbook5` (DocBook 5)
290 - `docx` ([Word docx])
291 - `dokuwiki` ([DokuWiki markup])
292 - `epub` or `epub3` ([EPUB] v3 book)
294 - `fb2` ([FictionBook2] e-book)
295 - `gfm` ([GitHub-Flavored Markdown]),
296 or the deprecated and less accurate `markdown_github`;
297 use [`markdown_github`](#markdown-variants) only
298 if you need extensions not supported in [`gfm`](#markdown-variants).
299 - `haddock` ([Haddock markup])
300 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
301 - `html4` ([XHTML] 1.0 Transitional)
302 - `icml` ([InDesign ICML])
303 - `ipynb` ([Jupyter notebook])
304 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
305 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
306 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
307 - `jats` (alias for `jats_archiving`)
308 - `jira` ([Jira]/Confluence wiki markup)
309 - `json` (JSON version of native AST)
312 - `markdown` ([Pandoc's Markdown])
313 - `markdown_mmd` ([MultiMarkdown])
314 - `markdown_phpextra` ([PHP Markdown Extra])
315 - `markdown_strict` (original unextended [Markdown])
316 - `mediawiki` ([MediaWiki markup])
319 - `native` (native Haskell),
320 - `odt` ([OpenOffice text document][ODT])
322 - `opendocument` ([OpenDocument])
323 - `org` ([Emacs Org mode])
325 - `plain` (plain text),
326 - `pptx` ([PowerPoint] slide show)
327 - `rst` ([reStructuredText])
328 - `rtf` ([Rich Text Format])
329 - `texinfo` ([GNU Texinfo])
330 - `textile` ([Textile])
331 - `slideous` ([Slideous] HTML and JavaScript slide show)
332 - `slidy` ([Slidy] HTML and JavaScript slide show)
333 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
334 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
335 - `s5` ([S5] HTML and JavaScript slide show)
336 - `tei` ([TEI Simple])
337 - `xwiki` ([XWiki markup])
338 - `zimwiki` ([ZimWiki markup])
339 - the path of a custom Lua writer, see [Custom writers] below
342 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
343 to *stdout* unless forced with `-o -`.
345 Extensions can be individually enabled or
346 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
347 name. See [Extensions] below, for a list of extensions and their
348 names. See `--list-output-formats` and `--list-extensions`, below.
350`-o` *FILE*, `--output=`*FILE*
352: Write output to *FILE* instead of *stdout*. If *FILE* is
353 `-`, output will go to *stdout*, even if a non-textual format
354 (`docx`, `odt`, `epub2`, `epub3`) is specified.
356`--data-dir=`*DIRECTORY*
358: Specify the user data directory to search for pandoc data files.
359 If this option is not specified, the default user data directory
360 will be used. On \*nix and macOS systems this will be the `pandoc`
361 subdirectory of the XDG data directory (by default,
362 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
363 environment variable). If that directory does not exist,
364 `$HOME/.pandoc` will be used (for backwards compatibility).
365 In Windows the default user data directory is
366 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
367 You can find the default user data directory on your system by
368 looking at the output of `pandoc --version`.
369 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
370 `slidy`, `slideous`, or `s5` directory
371 placed in this directory will override pandoc's normal defaults.
373`-d` *FILE*, `--defaults=`*FILE*
375: Specify a set of default option settings. *FILE* is a YAML
376 file whose fields correspond to command-line option
377 settings. All options for document conversion, including input
378 and output files, can be set using a defaults file. The file will
379 be searched for first in the working directory, and then in
380 the `defaults` subdirectory of the user data directory
381 (see `--data-dir`). The `.yaml` extension may be omitted.
382 See the section [Default files] for more information on the
383 file format. Settings from the defaults file may be
384 overridden or extended by subsequent options on the command
389: Generate a bash completion script. To enable bash completion
390 with pandoc, add this to your `.bashrc`:
392 eval "$(pandoc --bash-completion)"
396: Give verbose debugging output.
400: Suppress warning messages.
404: Exit with error status if there are any warnings.
408: Write log messages in machine-readable JSON format to
409 *FILE*. All messages above DEBUG level will be written,
410 regardless of verbosity settings (`--verbose`, `--quiet`).
412`--list-input-formats`
414: List supported input formats, one per line.
416`--list-output-formats`
418: List supported output formats, one per line.
420`--list-extensions`[`=`*FORMAT*]
422: List supported extensions for *FORMAT*, one per line, preceded
423 by a `+` or `-` indicating whether it is enabled by default
424 in *FORMAT*. If *FORMAT* is not specified, defaults for
425 pandoc's Markdown are given.
427`--list-highlight-languages`
429: List supported languages for syntax highlighting, one per
432`--list-highlight-styles`
434: List supported styles for syntax highlighting, one per line.
435 See `--highlight-style`.
445[Markdown]: https://daringfireball.net/projects/markdown/
446[CommonMark]: https://commonmark.org
447[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
448[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
449[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
450[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
451[S5]: https://meyerweb.com/eric/tools/s5/
452[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
453[Slideous]: https://goessner.net/articles/slideous/
454[HTML]: https://www.w3.org/html/
455[HTML5]: https://html.spec.whatwg.org/
456[polyglot markup]: https://www.w3.org/TR/html-polyglot/
457[XHTML]: https://www.w3.org/TR/xhtml1/
458[LaTeX]: https://www.latex-project.org/
459[`beamer`]: https://ctan.org/pkg/beamer
460[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
461[ConTeXt]: https://www.contextgarden.net/
462[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
463[DocBook]: https://docbook.org
464[JATS]: https://jats.nlm.nih.gov
465[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
466[txt2tags]: https://txt2tags.org
467[EPUB]: http://idpf.org/epub
468[OPML]: http://dev.opml.org/spec2.html
469[OpenDocument]: http://opendocument.xml.org
470[ODT]: https://en.wikipedia.org/wiki/OpenDocument
471[Textile]: https://www.promptworks.com/textile
472[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
473[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
474[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
475[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
476[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
477[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
478[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
479[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
480[CSV]: https://tools.ietf.org/html/rfc4180
481[roff man]: https://man.cx/groff_man(7)
482[roff ms]: https://man.cx/groff_ms(7)
483[Haskell]: https://www.haskell.org
484[GNU Texinfo]: https://www.gnu.org/software/texinfo/
485[Emacs Org mode]: https://orgmode.org
486[AsciiDoc]: https://www.methods.co.nz/asciidoc/
487[AsciiDoctor]: https://asciidoctor.org/
488[DZSlides]: http://paulrouget.com/dzslides/
489[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
490[PDF]: https://www.adobe.com/pdf/
491[reveal.js]: https://revealjs.com/
492[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
493[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
494[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
495[TEI Simple]: https://github.com/TEIC/TEI-Simple
496[Muse]: https://amusewiki.org/library/manual
497[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
498[Vimwiki]: https://vimwiki.github.io
499[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
500[BibTeX]: https://ctan.org/pkg/bibtex
501[BibLaTeX]: https://ctan.org/pkg/biblatex
503## Reader options {.options}
505`--shift-heading-level-by=`*NUMBER*
507: Shift heading levels by a positive or negative integer.
508 For example, with `--shift-heading-level-by=-1`, level 2
509 headings become level 1 headings, and level 3 headings
510 become level 2 headings. Headings cannot have a level
511 less than 1, so a heading that would be shifted below level 1
512 becomes a regular paragraph. Exception: with a shift of -N,
513 a level-N heading at the beginning of the document
514 replaces the metadata title. `--shift-heading-level-by=-1`
515 is a good choice when converting HTML or Markdown documents that
516 use an initial level-1 heading for the document title and
517 level-2+ headings for sections. `--shift-heading-level-by=1`
518 may be a good choice for converting Markdown documents that
519 use level-1 headings for sections to HTML, since pandoc uses
520 a level-1 heading to render the document title.
522`--base-header-level=`*NUMBER*
524: *Deprecated. Use `--shift-heading-level-by`=X instead,
525 where X = NUMBER - 1.* Specify the base level for headings
528`--strip-empty-paragraphs`
530: *Deprecated. Use the `+empty_paragraphs` extension instead.*
531 Ignore paragraphs with no content. This option is useful
532 for converting word processing documents where users have
533 used empty paragraphs to create inter-paragraph space.
535`--indented-code-classes=`*CLASSES*
537: Specify classes to use for indented code blocks--for example,
538 `perl,numberLines` or `haskell`. Multiple classes may be separated
541`--default-image-extension=`*EXTENSION*
543: Specify a default extension to use when image paths/URLs have no
544 extension. This allows you to use the same source for formats that
545 require different kinds of images. Currently this option only affects
546 the Markdown and LaTeX readers.
550: Parse each file individually before combining for multifile
551 documents. This will allow footnotes in different files with the
552 same identifiers to work as expected. If this option is set,
553 footnotes and links will not work across files. Reading binary
554 files (docx, odt, epub) implies `--file-scope`.
556`-F` *PROGRAM*, `--filter=`*PROGRAM*
558: Specify an executable to be used as a filter transforming the
559 pandoc AST after the input is parsed and before the output is
560 written. The executable should read JSON from stdin and write
561 JSON to stdout. The JSON must be formatted like pandoc's own
562 JSON input and output. The name of the output format will be
563 passed to the filter as the first argument. Hence,
565 pandoc --filter ./caps.py -t latex
569 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
571 The latter form may be useful for debugging filters.
573 Filters may be written in any language. `Text.Pandoc.JSON`
574 exports `toJSONFilter` to facilitate writing filters in Haskell.
575 Those who would prefer to write filters in python can use the
576 module [`pandocfilters`], installable from PyPI. There are also
577 pandoc filter libraries in [PHP], [perl], and
578 [JavaScript/node.js].
580 In order of preference, pandoc will look for filters in
582 1. a specified full or relative path (executable or
585 2. `$DATADIR/filters` (executable or non-executable)
586 where `$DATADIR` is the user data directory (see
587 `--data-dir`, above).
589 3. `$PATH` (executable only)
591 Filters and Lua-filters are applied in the order specified
594`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
596: Transform the document in a similar fashion as JSON filters (see
597 `--filter`), but use pandoc's built-in Lua filtering system. The given
598 Lua script is expected to return a list of Lua filters which will be
599 applied in order. Each Lua filter must contain element-transforming
600 functions indexed by the name of the AST element on which the filter
601 function should be applied.
603 The `pandoc` Lua module provides helper functions for element
604 creation. It is always loaded into the script's Lua environment.
606 The following is an example Lua script for macro-expansion:
608 function expand_hello_world(inline)
609 if inline.c == '{{helloworld}}' then
610 return pandoc.Emph{ pandoc.Str "Hello, World" }
616 return {{Str = expand_hello_world}}
618 In order of preference, pandoc will look for Lua filters in
620 1. a specified full or relative path (executable or
623 2. `$DATADIR/filters` (executable or non-executable)
624 where `$DATADIR` is the user data directory (see
625 `--data-dir`, above).
627`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
629: Set the metadata field *KEY* to the value *VAL*. A value specified
630 on the command line overrides a value specified in the document
631 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
632 Values will be parsed as YAML boolean or string values. If no value is
633 specified, the value will be treated as Boolean true. Like
634 `--variable`, `--metadata` causes template variables to be set.
635 But unlike `--variable`, `--metadata` affects the metadata of the
636 underlying document (which is accessible from filters and may be
637 printed in some output formats) and metadata values will be escaped
638 when inserted into the template.
640`--metadata-file=`*FILE*
642: Read metadata from the supplied YAML (or JSON) file. This
643 option can be used with every input format, but string scalars
644 in the YAML file will always be parsed as Markdown. Generally,
645 the input will be handled the same as in [YAML metadata
646 blocks][Extension: `yaml_metadata_block`]. This option can be
647 used repeatedly to include multiple metadata files; values in
648 files specified later on the command line will be preferred
649 over those specified in earlier files. Metadata values
650 specified inside the document, or by using `-M`, overwrite
651 values specified with this option.
653`-p`, `--preserve-tabs`
655: Preserve tabs instead of converting them to spaces. (By default, pandoc
656 converts tabs to spaces before parsing its input.) Note that this will
657 only affect tabs in literal code spans and code blocks. Tabs in regular
658 text are always treated as spaces.
662: Specify the number of spaces per tab (default is 4).
664`--track-changes=accept`|`reject`|`all`
666: Specifies what to do with insertions, deletions, and comments
667 produced by the MS Word "Track Changes" feature. `accept` (the
668 default) processes all the insertions and deletions.
669 `reject` ignores them. Both `accept` and `reject` ignore comments.
670 `all` includes all insertions, deletions, and comments, wrapped
671 in spans with `insertion`, `deletion`, `comment-start`, and
672 `comment-end` classes, respectively. The author and time of
673 change is included. `all` is useful for scripting: only
674 accepting changes from a certain reviewer, say, or before a
675 certain date. If a paragraph is inserted or deleted,
676 `track-changes=all` produces a span with the class
677 `paragraph-insertion`/`paragraph-deletion` before the
678 affected paragraph break. This option only affects the docx
681`--extract-media=`*DIR*
683: Extract images and other media contained in or linked from
684 the source document to the path *DIR*, creating it if
685 necessary, and adjust the images references in the document
686 so they point to the extracted files. If the source format is
687 a binary container (docx, epub, or odt), the media is
688 extracted from the container and the original
689 filenames are used. Otherwise the media is read from the
690 file system or downloaded, and new filenames are constructed
691 based on SHA1 hashes of the contents.
693`--abbreviations=`*FILE*
695: Specifies a custom abbreviations file, with abbreviations
696 one to a line. If this option is not specified, pandoc will
697 read the data file `abbreviations` from the user data
698 directory or fall back on a system default. To see the
700 `pandoc --print-default-data-file=abbreviations`. The only
701 use pandoc makes of this list is in the Markdown reader.
702 Strings ending in a period that are found in this list will
703 be followed by a nonbreaking space, so that the period will
704 not produce sentence-ending space in formats like LaTeX.
706[`pandocfilters`]: https://github.com/jgm/pandocfilters
707[PHP]: https://github.com/vinai/pandocfilters-php
708[perl]: https://metacpan.org/pod/Pandoc::Filter
709[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
711## General writer options {.options}
715: Produce output with an appropriate header and footer (e.g. a
716 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
717 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
718 output. For `native` output, this option causes metadata to
719 be included; otherwise, metadata is suppressed.
721`--template=`*FILE*|*URL*
723: Use the specified file as a custom template for the generated document.
724 Implies `--standalone`. See [Templates], below, for a description
725 of template syntax. If no extension is specified, an extension
726 corresponding to the writer will be added, so that `--template=special`
727 looks for `special.html` for HTML output. If the template is not
728 found, pandoc will search for it in the `templates` subdirectory of
729 the user data directory (see `--data-dir`). If this option is not used,
730 a default template appropriate for the output format will be used (see
731 `-D/--print-default-template`).
733`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
735: Set the template variable *KEY* to the value *VAL* when rendering the
736 document in standalone mode. If no *VAL* is specified, the
737 key will be given the value `true`.
739`-D` *FORMAT*, `--print-default-template=`*FORMAT*
741: Print the system default template for an output *FORMAT*. (See `-t`
742 for a list of possible *FORMAT*s.) Templates in the user data
743 directory are ignored. This option may be used with
744 `-o`/`--output` to redirect output to a file, but
745 `-o`/`--output` must come before `--print-default-template`
748 Note that some of the default templates use partials, for
749 example `styles.html`. To print the partials, use
750 `--print-default-data-file`: for example,
751 `--print-default-data-file=templates/styles.html`.
753`--print-default-data-file=`*FILE*
755: Print a system default data file. Files in the user data directory
756 are ignored. This option may be used with `-o`/`--output` to
757 redirect output to a file, but `-o`/`--output` must come before
758 `--print-default-data-file` on the command line.
760`--eol=crlf`|`lf`|`native`
762: Manually specify line endings: `crlf` (Windows), `lf`
763 (macOS/Linux/UNIX), or `native` (line endings appropriate
764 to the OS on which pandoc is being run). The default is
769: Specify the default dpi (dots per inch) value for conversion
770 from pixels to inch/centimeters and vice versa. (Technically,
771 the correct term would be ppi: pixels per inch.) The default
772 is 96dpi. When images contain information about dpi
773 internally, the encoded value is used instead of the default
774 specified by this option.
776`--wrap=auto`|`none`|`preserve`
778: Determine how text is wrapped in the output (the source
779 code, not the rendered version). With `auto` (the default),
780 pandoc will attempt to wrap lines to the column width specified by
781 `--columns` (default 72). With `none`, pandoc will not wrap
782 lines at all. With `preserve`, pandoc will attempt to
783 preserve the wrapping from the source document (that is,
784 where there are nonsemantic newlines in the source, there
785 will be nonsemantic newlines in the output as well).
786 Automatic wrapping does not currently work in HTML output.
787 In `ipynb` output, this option affects wrapping of the
788 contents of markdown cells.
792: Specify length of lines in characters. This affects text wrapping
793 in the generated source code (see `--wrap`). It also affects
794 calculation of column widths for plain text tables (see [Tables] below).
796`--toc`, `--table-of-contents`
798: Include an automatically generated table of contents (or, in
799 the case of `latex`, `context`, `docx`, `odt`,
800 `opendocument`, `rst`, or `ms`, an instruction to create
801 one) in the output document. This option has no effect
802 unless `-s/--standalone` is used, and it has no effect
803 on `man`, `docbook4`, `docbook5`, or `jats` output.
805 Note that if you are producing a PDF via `ms`, the table
806 of contents will appear at the beginning of the
807 document, before the title. If you would prefer it to
808 be at the end of the document, use the option
809 `--pdf-engine-opt=--no-toc-relocation`.
811`--toc-depth=`*NUMBER*
813: Specify the number of section levels to include in the table
814 of contents. The default is 3 (which means that level-1, 2, and 3
815 headings will be listed in the contents).
819: Strip out HTML comments in the Markdown or Textile source,
820 rather than passing them on to Markdown, Textile or HTML
821 output as raw HTML. This does not apply to HTML comments
822 inside raw HTML blocks when the `markdown_in_html_blocks`
823 extension is not set.
827: Disables syntax highlighting for code blocks and inlines, even when
828 a language attribute is given.
830`--highlight-style=`*STYLE*|*FILE*
832: Specifies the coloring style to be used in highlighted source code.
833 Options are `pygments` (the default), `kate`, `monochrome`,
834 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
835 For more information on syntax highlighting in pandoc, see
836 [Syntax highlighting], below. See also
837 `--list-highlight-styles`.
839 Instead of a *STYLE* name, a JSON file with extension
840 `.theme` may be supplied. This will be parsed as a KDE
841 syntax highlighting theme and (if valid) used as the
844 To generate the JSON version of an existing style,
845 use `--print-highlight-style`.
847`--print-highlight-style=`*STYLE*|*FILE*
849: Prints a JSON version of a highlighting style, which can
850 be modified, saved with a `.theme` extension, and used
851 with `--highlight-style`. This option may be used with
852 `-o`/`--output` to redirect output to a file, but
853 `-o`/`--output` must come before `--print-highlight-style`
856`--syntax-definition=`*FILE*
858: Instructs pandoc to load a KDE XML syntax definition file,
859 which will be used for syntax highlighting of appropriately
860 marked code blocks. This can be used to add support for
861 new languages or to use altered syntax definitions for
862 existing languages. This option may be repeated to add
863 multiple syntax definitions.
865`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
867: Include contents of *FILE*, verbatim, at the end of the header.
868 This can be used, for example, to include special
869 CSS or JavaScript in HTML documents. This option can be used
870 repeatedly to include multiple files in the header. They will be
871 included in the order specified. Implies `--standalone`.
873`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
875: Include contents of *FILE*, verbatim, at the beginning of the
876 document body (e.g. after the `<body>` tag in HTML, or the
877 `\begin{document}` command in LaTeX). This can be used to include
878 navigation bars or banners in HTML documents. This option can be
879 used repeatedly to include multiple files. They will be included in
880 the order specified. Implies `--standalone`.
882`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
884: Include contents of *FILE*, verbatim, at the end of the document
885 body (before the `</body>` tag in HTML, or the
886 `\end{document}` command in LaTeX). This option can be used
887 repeatedly to include multiple files. They will be included in the
888 order specified. Implies `--standalone`.
890`--resource-path=`*SEARCHPATH*
892: List of paths to search for images and other resources.
893 The paths should be separated by `:` on Linux, UNIX, and
894 macOS systems, and by `;` on Windows. If `--resource-path`
895 is not specified, the default resource path is the working
896 directory. Note that, if `--resource-path` is specified,
897 the working directory must be explicitly listed or it
898 will not be searched. For example:
899 `--resource-path=.:test` will search the working directory
900 and the `test` subdirectory, in that order.
902`--request-header=`*NAME*`:`*VAL*
904: Set the request header *NAME* to the value *VAL* when making
905 HTTP requests (for example, when a URL is given on the
906 command line, or when resources used in a document must be
907 downloaded). If you're behind a proxy, you also need to set
908 the environment variable `http_proxy` to `http://...`.
910`--no-check-certificate`
912: Disable the certificate verification to allow access to
913 unsecure HTTP resources (for example when the certificate
914 is no longer valid or self signed).
916## Options affecting specific writers {.options}
920: Produce a standalone HTML file with no external dependencies, using
921 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
922 images, and videos. Implies `--standalone`. The resulting file should be
923 "self-contained," in the sense that it needs no external files and no net
924 access to be displayed properly by a browser. This option works only with
925 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
926 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
927 and stylesheets at absolute URLs will be downloaded; those at relative
928 URLs will be sought relative to the working directory (if the first source
929 file is local) or relative to the base URL (if the first source
930 file is remote). Elements with the attribute
931 `data-external="1"` will be left alone; the documents they
932 link to will not be incorporated in the document.
933 Limitation: resources that are loaded dynamically through
934 JavaScript cannot be incorporated; as a result,
935 `--self-contained` does not work with `--mathjax`, and some
936 advanced features (e.g. zoom or speaker notes) may not work
937 in an offline "self-contained" `reveal.js` slide show.
941: Use `<q>` tags for quotes in HTML. (This option only has an
942 effect if the `smart` extension is enabled for the input
947: Use only ASCII characters in output. Currently supported for XML
948 and HTML formats (which use entities instead of UTF-8 when this
949 option is selected), CommonMark, gfm, and Markdown (which use
950 entities), roff ms (which use hexadecimal escapes), and to a
951 limited degree LaTeX (which uses standard commands for accented
952 characters when possible). roff man output uses ASCII by default.
956: Use reference-style links, rather than inline links, in writing Markdown
957 or reStructuredText. By default inline links are used. The
958 placement of link references is affected by the
959 `--reference-location` option.
961`--reference-location=block`|`section`|`document`
963: Specify whether footnotes (and references, if `reference-links` is
964 set) are placed at the end of the current (top-level) block, the
965 current section, or the document. The default is
966 `document`. Currently only affects the markdown writer.
968`--markdown-headings=setext`|`atx`
970: Specify whether to use ATX-style (`#`-prefixed) or
971 Setext-style (underlined) headings for level 1 and 2
972 headings in Markdown output. (The default is `atx`.)
973 ATX-style headings are always used for levels 3+.
974 This option also affects Markdown cells in `ipynb` output.
978: *Deprecated synonym for `--markdown-headings=atx`.*
980`--top-level-division=default`|`section`|`chapter`|`part`
982: Treat top-level headings as the given division type in
983 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
984 order is part, chapter, then section; all headings are
985 shifted such that the top-level heading becomes the
986 specified type. The default behavior is to determine the
987 best division type via heuristics: unless other conditions
988 apply, `section` is chosen. When the `documentclass`
989 variable is set to `report`, `book`, or `memoir` (unless the
990 `article` option is specified), `chapter` is implied as the
991 setting for this option. If `beamer` is the output format,
992 specifying either `chapter` or `part` will cause top-level
993 headings to become `\part{..}`, while second-level headings
994 remain as their default type.
996`-N`, `--number-sections`
998: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
999 output. By default, sections are not numbered. Sections with class
1000 `unnumbered` will never be numbered, even if `--number-sections`
1003`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
1005: Offset for section headings in HTML output (ignored in other
1006 output formats). The first number is added to the section number for
1007 top-level headings, the second for second-level headings, and so on.
1008 So, for example, if you want the first top-level heading in your
1009 document to be numbered "6", specify `--number-offset=5`.
1010 If your document starts with a level-2 heading which you want to
1011 be numbered "1.5", specify `--number-offset=1,4`.
1012 Offsets are 0 by default. Implies `--number-sections`.
1016: Use the [`listings`] package for LaTeX code blocks. The package
1017 does not support multi-byte encoding for source code. To handle UTF-8
1018 you would need to use a custom template. This issue is fully
1019 documented here: [Encoding issue with the listings package].
1021`-i`, `--incremental`
1023: Make list items in slide shows display incrementally (one by one).
1024 The default is for lists to be displayed all at once.
1026`--slide-level=`*NUMBER*
1028: Specifies that headings with the specified level create
1029 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1030 above this level in the hierarchy are used to divide the
1031 slide show into sections; headings below this level create
1032 subheads within a slide. Note that content that is
1033 not contained under slide-level headings will not appear in
1034 the slide show. The default is to set the slide level based
1035 on the contents of the document; see [Structuring the slide
1040: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1041 and attach identifiers to the enclosing `<section>` (or `<div>`)
1042 rather than the heading itself. See
1043 [Heading identifiers], below.
1045`--email-obfuscation=none`|`javascript`|`references`
1047: Specify a method for obfuscating `mailto:` links in HTML documents.
1048 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1049 them using JavaScript. `references` obfuscates them by printing their
1050 letters as decimal or hexadecimal character references. The default
1053`--id-prefix=`*STRING*
1055: Specify a prefix to be added to all identifiers and internal links
1056 in HTML and DocBook output, and to footnote numbers in Markdown
1057 and Haddock output. This is useful for preventing duplicate
1058 identifiers when generating fragments to be included in other pages.
1060`-T` *STRING*, `--title-prefix=`*STRING*
1062: Specify *STRING* as a prefix at the beginning of the title
1063 that appears in the HTML header (but not in the title as it
1064 appears at the beginning of the HTML body). Implies `--standalone`.
1066`-c` *URL*, `--css=`*URL*
1068: Link to a CSS style sheet. This option can be used repeatedly to
1069 include multiple files. They will be included in the order specified.
1071 A stylesheet is required for generating EPUB. If none is
1072 provided using this option (or the `css` or `stylesheet`
1073 metadata fields), pandoc will look for a file `epub.css` in the
1074 user data directory (see `--data-dir`). If it is not
1075 found there, sensible defaults will be used.
1077`--reference-doc=`*FILE*
1079: Use the specified file as a style reference in producing a
1084 : For best results, the reference docx should be a modified
1085 version of a docx file produced using pandoc. The contents
1086 of the reference docx are ignored, but its stylesheets and
1087 document properties (including margins, page size, header,
1088 and footer) are used in the new docx. If no reference docx
1089 is specified on the command line, pandoc will look for a
1090 file `reference.docx` in the user data directory (see
1091 `--data-dir`). If this is not found either, sensible
1092 defaults will be used.
1094 To produce a custom `reference.docx`, first get a copy of
1095 the default `reference.docx`: `pandoc
1096 -o custom-reference.docx --print-default-data-file reference.docx`.
1097 Then open `custom-reference.docx` in Word, modify the
1098 styles as you wish, and save the file. For best
1099 results, do not make changes to this file other than
1100 modifying the styles used by pandoc:
1136 - Default Paragraph Font
1139 - Footnote Reference
1149 : For best results, the reference ODT should be a modified
1150 version of an ODT produced using pandoc. The contents of
1151 the reference ODT are ignored, but its stylesheets are used
1152 in the new ODT. If no reference ODT is specified on the
1153 command line, pandoc will look for a file `reference.odt` in
1154 the user data directory (see `--data-dir`). If this is not
1155 found either, sensible defaults will be used.
1157 To produce a custom `reference.odt`, first get a copy of
1158 the default `reference.odt`: `pandoc
1159 -o custom-reference.odt --print-default-data-file reference.odt`.
1160 Then open `custom-reference.odt` in LibreOffice, modify
1161 the styles as you wish, and save the file.
1165 : Templates included with Microsoft PowerPoint 2013 (either with
1166 `.pptx` or `.potx` extension) are known to work, as are most
1167 templates derived from these.
1169 The specific requirement is that the template should begin with
1170 the following first four layouts:
1173 2. Title and Content
1177 All templates included with a recent version of MS PowerPoint
1178 will fit these criteria. (You can click on `Layout` under the
1179 `Home` menu to check.)
1181 You can also modify the default `reference.pptx`: first run
1182 `pandoc -o custom-reference.pptx --print-default-data-file
1183 reference.pptx`, and then modify `custom-reference.pptx`
1184 in MS PowerPoint (pandoc will use the first four layout
1185 slides, as mentioned above).
1187`--epub-cover-image=`*FILE*
1189: Use the specified image as the EPUB cover. It is recommended
1190 that the image be less than 1000px in width and height. Note that
1191 in a Markdown source document you can also specify `cover-image`
1192 in a YAML metadata block (see [EPUB Metadata], below).
1194`--epub-metadata=`*FILE*
1196: Look in the specified XML file for metadata for the EPUB.
1197 The file should contain a series of [Dublin Core elements].
1200 <dc:rights>Creative Commons</dc:rights>
1201 <dc:language>es-AR</dc:language>
1203 By default, pandoc will include the following metadata elements:
1204 `<dc:title>` (from the document title), `<dc:creator>` (from the
1205 document authors), `<dc:date>` (from the document date, which should
1206 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1207 variable, or, if is not set, the locale), and `<dc:identifier
1208 id="BookId">` (a randomly generated UUID). Any of these may be
1209 overridden by elements in the metadata file.
1211 Note: if the source document is Markdown, a YAML metadata block
1212 in the document can be used instead. See below under
1215`--epub-embed-font=`*FILE*
1217: Embed the specified font in the EPUB. This option can be repeated
1218 to embed multiple fonts. Wildcards can also be used: for example,
1219 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1220 line, be sure to escape them or put the whole filename in single quotes,
1221 to prevent them from being interpreted by the shell. To use the
1222 embedded fonts, you will need to add declarations like the following
1223 to your CSS (see `--css`):
1226 font-family: DejaVuSans;
1228 font-weight: normal;
1229 src:url("DejaVuSans-Regular.ttf");
1232 font-family: DejaVuSans;
1235 src:url("DejaVuSans-Bold.ttf");
1238 font-family: DejaVuSans;
1240 font-weight: normal;
1241 src:url("DejaVuSans-Oblique.ttf");
1244 font-family: DejaVuSans;
1247 src:url("DejaVuSans-BoldOblique.ttf");
1249 body { font-family: "DejaVuSans"; }
1251`--epub-chapter-level=`*NUMBER*
1253: Specify the heading level at which to split the EPUB into separate
1254 "chapter" files. The default is to split into chapters at level-1
1255 headings. This option only affects the internal composition of the
1256 EPUB, not the way chapters and sections are displayed to users. Some
1257 readers may be slow if the chapter files are too large, so for large
1258 documents with few level-1 headings, one might want to use a chapter
1261`--epub-subdirectory=`*DIRNAME*
1263: Specify the subdirectory in the OCF container that is to hold
1264 the EPUB-specific contents. The default is `EPUB`. To put
1265 the EPUB contents in the top level, use an empty string.
1267`--ipynb-output=all|none|best`
1269: Determines how ipynb output cells are treated. `all` means
1270 that all of the data formats included in the original are
1271 preserved. `none` means that the contents of data cells
1272 are omitted. `best` causes pandoc to try to pick the
1273 richest data block in each output cell that is compatible
1274 with the output format. The default is `best`.
1276`--pdf-engine=`*PROGRAM*
1278: Use the specified engine when producing PDF output.
1279 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1280 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1281 and `pdfroff`. If the engine is not in your PATH, the full
1282 path of the engine may be specified here. If this option
1283 is not specified, pandoc uses the following defaults
1284 depending on the output format specified using `-t/--to`:
1286 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1287 `tectonic`, `latexmk`)
1288 - `-t context`: `context`
1289 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1290 see [print-css.rocks](https://print-css.rocks) for a good
1291 introduction to PDF generation from HTML/CSS.)
1292 - `-t ms`: `pdfroff`
1294`--pdf-engine-opt=`*STRING*
1296: Use the given string as a command-line argument to the `pdf-engine`.
1297 For example, to use a persistent directory `foo` for `latexmk`'s
1298 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1299 Note that no check for duplicate options is done.
1301[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1302[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1303[Encoding issue with the listings package]:
1304 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1306## Citation rendering {.options}
1310: Process the citations in the file, replacing them with
1311 rendered citations and adding a bibliography.
1312 Citation processing will not take place unless bibliographic
1313 data is supplied, either through an external file specified
1314 using the `--bibliography` option or the `bibliography`
1315 field in metadata, or via a `references` section in metadata
1316 containing a list of citations in CSL YAML format with
1317 Markdown formatting. The style is controlled by a [CSL]
1318 stylesheet specified using the `--csl` option or the `csl`
1319 field in metadata. (If no stylesheet is specified,
1320 the `chicago-author-date` style will be used by default.)
1321 The citation processing transformation may be applied before
1322 or after filters or Lua filters (see `--filter`,
1323 `--lua-filter`): these transformations are applied in the
1324 order they appear on the command line. For more
1325 information, see the section on [Citations].
1327`--bibliography=`*FILE*
1329: Set the `bibliography` field in the document's metadata to *FILE*,
1330 overriding any value set in the metadata. If you supply
1331 this argument multiple times, each *FILE* will be added to
1332 bibliography. If *FILE* is a URL, it will be fetched
1333 via HTTP. If *FILE* is not found relative to the
1334 working directory, it will be sought in the resource path
1335 (see `--resource-path`).
1339: Set the `csl` field in the document's metadata to *FILE*,
1340 overriding any value set in the metadata. (This is equivalent to
1341 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1342 fetched via HTTP. If *FILE* is not found relative to the
1343 working directory, it will be sought in the resource path
1344 (see `--resource-path`) and finally in the `csl`
1345 subdirectory of the pandoc user data directory.
1347`--citation-abbreviations=`*FILE*
1349: Set the `citation-abbreviations` field in the document's metadata to
1350 *FILE*, overriding any value set in the metadata. (This is equivalent to
1351 `--metadata citation-abbreviations=FILE`.)
1352 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1353 found relative to the working directory, it will be sought
1354 in the resource path (see `--resource-path`) and finally in
1355 the `csl` subdirectory of the pandoc user data directory.
1359: Use [`natbib`] for citations in LaTeX output. This option
1360 is not for use with the `--citeproc` option or with PDF
1361 output. It is intended for use in producing a LaTeX file
1362 that can be processed with [`bibtex`].
1366: Use [`biblatex`] for citations in LaTeX output. This option
1367 is not for use with the `--citeproc` option or with PDF
1368 output. It is intended for use in producing a LaTeX file
1369 that can be processed with [`bibtex`] or [`biber`].
1371## Math rendering in HTML {.options}
1373The default is to render TeX math as far as possible using
1374Unicode characters. Formulas are put inside a `span` with
1375`class="math"`, so that they may be styled differently from the
1376surrounding text if needed. However, this gives acceptable
1377results only for basic math, usually you will want to use
1378`--mathjax` or another of the following options.
1380`--mathjax`[`=`*URL*]
1382: Use [MathJax] to display embedded TeX math in HTML output.
1383 TeX math will be put between `\(...\)` (for inline math)
1384 or `\[...\]` (for display math) and wrapped in `<span>` tags
1385 with class `math`. Then the MathJax JavaScript will render it.
1386 The *URL* should point to the `MathJax.js` load script.
1387 If a *URL* is not provided, a link to the Cloudflare CDN will
1392: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1393 `docbook5`, `jats`, `html4` and `html5`). This is the
1394 default in `odt` output. Note that currently only Firefox
1395 and Safari (and select e-book readers) natively support
1400: Convert TeX formulas to `<img>` tags that link to an external script
1401 that converts formulas to images. The formula will be URL-encoded
1402 and concatenated with the URL provided. For SVG images you can for
1403 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1404 If no URL is specified, the CodeCogs URL generating PNGs
1405 will be used (`https://latex.codecogs.com/png.latex?`).
1406 Note: the `--webtex` option will affect Markdown output
1407 as well as HTML, which is useful if you're targeting a
1408 version of Markdown without native math support.
1412: Use [KaTeX] to display embedded TeX math in HTML output.
1413 The *URL* is the base URL for the KaTeX library. That directory
1414 should contain a `katex.min.js` and a `katex.min.css` file.
1415 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1419: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1420 can then be processed by [GladTeX] to produce images of the typeset
1421 formulas and an HTML file with links to these images.
1422 So, the procedure is:
1424 pandoc -s --gladtex input.md -o myfile.htex
1425 gladtex -d myfile-images myfile.htex
1426 # produces myfile.html and images in myfile-images
1428[MathML]: https://www.w3.org/Math/
1429[MathJax]: https://www.mathjax.org
1430[KaTeX]: https://github.com/Khan/KaTeX
1431[GladTeX]: https://humenda.github.io/GladTeX/
1433## Options for wrapper scripts {.options}
1437: Print information about command-line arguments to *stdout*, then exit.
1438 This option is intended primarily for use in wrapper scripts.
1439 The first line of output contains the name of the output file specified
1440 with the `-o` option, or `-` (for *stdout*) if no output file was
1441 specified. The remaining lines contain the command-line arguments,
1442 one per line, in the order they appear. These do not include regular
1443 pandoc options and their arguments, but do include any options appearing
1444 after a `--` separator at the end of the line.
1448: Ignore command-line arguments (for use in wrapper scripts).
1449 Regular pandoc options are not ignored. Thus, for example,
1451 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1455 pandoc -o foo.html -s
1459If pandoc completes successfully, it will return exit code 0.
1460Nonzero exit codes have the following meanings:
1463----- ------------------------------------
1464 3 PandocFailOnWarningError
1466 5 PandocTemplateError
1468 21 PandocUnknownReaderError
1469 22 PandocUnknownWriterError
1470 23 PandocUnsupportedExtensionError
1471 24 PandocCiteprocError
1472 31 PandocEpubSubdirectoryError
1474 47 PandocPDFProgramNotFoundError
1476 62 PandocShouldNeverHappenError
1479 65 PandocParsecError
1480 66 PandocMakePDFError
1481 67 PandocSyntaxMapError
1482 83 PandocFilterError
1484 92 PandocUTF8DecodingError
1485 93 PandocIpynbDecodingError
1486 97 PandocCouldNotFindDataFileError
1487 99 PandocResourceNotFound
1488----- ------------------------------------
1492The `--defaults` option may be used to specify a package
1493of options. Here is a sample defaults file demonstrating all of
1494the fields that may be used:
1498# reader: may be used instead of from:
1500# writer: may be used instead of to:
1502# leave blank for output to stdout:
1504# leave blank for input from stdin, use [] for no input:
1508# or you may use input-file: with a single value
1512self-contained: false
1514# note that structured variables may be specified:
1521# metadata values specified here are parsed as literal
1522# string text, not markdown:
1529# or you may use metadata-file: with a single value
1531# Note that these take files, not their contents:
1532include-before-body: []
1533include-after-body: []
1534include-in-header: []
1537# turn on built-in citation processing. Note that if you need
1538# control over when the citeproc processing is done relative
1539# to other filters, you should instead use `citeproc` in the
1540# list of `filters` (see below).
1546citation-abbreviations: abbrevs.json
1548# Filters will be assumed to be Lua filters if they have
1549# the .lua extension, and json filters otherwise. But
1550# the filter type can also be specified explicitly, as shown.
1551# Filters are run in the order specified.
1552# To include the built-in citeproc filter, use either `citeproc`
1553# or `{type: citeproc}`.
1563# ERROR, WARNING, or INFO
1567# citeproc, natbib, or biblatex
1568cite-method: citeproc
1569# part, chapter, section, or default:
1570top-level-division: chapter
1576# you may also use pdf-engine-opt: with a single option
1577# pdf-engine-opt: "-shell-escape"
1579# auto, preserve, or none
1584extract-media: mediadir
1586table-of-contents: true
1588number-sections: false
1589# a list of offsets at each heading level
1590number-offset: [0,0,0,0,0,0]
1591# toc: may also be used instead of table-of-contents:
1592shift-heading-level-by: 1
1594identifier-prefix: foo
1596strip-empty-paragraphs: true
1597# lf, crlf, or native
1599strip-comments: false
1600indented-code-classes: []
1602default-image-extension: ".jpg"
1604# either a style name of a style definition file:
1605highlight-style: pygments
1608# or you may use syntax-definition: with a single value
1611reference-doc: myref.docx
1613# method is plain, webtex, gladtex, mathml, mathjax, katex
1614# you may specify a url with webtex, mathjax, katex
1617 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1618# none, references, or javascript
1619email-obfuscation: javascript
1627epub-subdirectory: EPUB
1628epub-metadata: meta.xml
1631epub-chapter-level: 1
1632epub-cover-image: cover.jpg
1634reference-links: true
1635# block, section, or document
1636reference-location: block
1637markdown-headings: setext
1639# accept, reject, or all
1640track-changes: accept
1649# A list of two-element lists
1651- ["User-Agent", "Mozilla/5.0"]
1653fail-if-warnings: false
1659Fields that are omitted will just have their regular
1660default values. So a defaults file can be as simple as
1667Default files can be placed in the `defaults` subdirectory of
1668the user data directory and used from any directory. For
1669example, one could create a file specifying defaults for writing
1670letters, save it as `letter.yaml` in the `defaults` subdirectory
1671of the user data directory, and then invoke these defaults
1672from any directory using `pandoc --defaults letter`
1673or `pandoc -dletter`.
1675When multiple defaults are used, their contents will be combined.
1677Note that, where command-line arguments may be repeated
1678(`--metadata-file`, `--css`, `--include-in-header`,
1679`--include-before-body`, `--include-after-body`, `--variable`,
1680`--metadata`, `--syntax-definition`), the values specified on
1681the command line will combine with values specified in the
1682defaults file, rather than replacing them.
1686When the `-s/--standalone` option is used, pandoc uses a template to
1687add header and footer material that is needed for a self-standing
1688document. To see the default template that is used, just type
1692where *FORMAT* is the name of the output format. A custom template
1693can be specified using the `--template` option. You can also override
1694the system default templates for a given output format *FORMAT*
1695by putting a file `templates/default.*FORMAT*` in the user data
1696directory (see `--data-dir`, above). *Exceptions:*
1698- For `odt` output, customize the `default.opendocument`
1700- For `pdf` output, customize the `default.latex` template
1701 (or the `default.context` template, if you use `-t context`,
1702 or the `default.ms` template, if you use `-t ms`, or the
1703 `default.html` template, if you use `-t html`).
1704- `docx` and `pptx` have no template (however, you can use
1705 `--reference-doc` to customize the output).
1707Templates contain *variables*, which allow for the inclusion of
1708arbitrary information at any point in the file. They may be set at the
1709command line using the `-V/--variable` option. If a variable is not set,
1710pandoc will look for the key in the document's metadata, which can be set
1711using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1712or with the `-M/--metadata` option. In addition, some variables
1713are given default values by pandoc. See [Variables] below for
1714a list of variables used in pandoc's default templates.
1716If you use custom templates, you may need to revise them as pandoc
1717changes. We recommend tracking the changes in the default templates,
1718and modifying your custom templates accordingly. An easy way to do this
1719is to fork the [pandoc-templates] repository and merge in
1720changes after each pandoc release.
1722 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1728Anything between the sequence `$--` and the end of the
1729line will be treated as a comment and omitted from the output.
1733To mark variables and control structures in the template,
1734either `$`...`$` or `${`...`}` may be used as delimiters.
1735The styles may also be mixed in the same template, but the
1736opening and closing delimiter must match in each case. The
1737opening delimiter may be followed by one or more spaces
1738or tabs, which will be ignored. The closing delimiter may
1739be followed by one or more spaces or tabs, which will be
1742To include a literal `$` in the document, use `$$`.
1744### Interpolated variables
1746A slot for an interpolated variable is a variable name surrounded
1747by matched delimiters. Variable names must begin with a letter
1748and can contain letters, numbers, `_`, `-`, and `.`. The
1749keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1750not be used as variable names. Examples:
1763Variable names with periods are used to get at structured
1764variable values. So, for example, `employee.salary` will return the
1765value of the `salary` field of the object that is the value of
1766the `employee` field.
1768- If the value of the variable is simple value, it will be
1769 rendered verbatim. (Note that no escaping is done;
1770 the assumption is that the calling program will escape
1771 the strings appropriately for the output format.)
1772- If the value is a list, the values will be concatenated.
1773- If the value is a map, the string `true` will be rendered.
1774- Every other value will be rendered as the empty string.
1778A conditional begins with `if(variable)` (enclosed in
1779matched delimiters) and ends with `endif` (enclosed in matched
1780delimiters). It may optionally contain an `else` (enclosed in
1781matched delimiters). The `if` section is used if
1782`variable` has a non-empty value, otherwise the `else`
1783section is used (if present). Examples:
1798${if(foo)}bar${endif}
1811The keyword `elseif` may be used to simplify complex nested
1826A for loop begins with `for(variable)` (enclosed in
1827matched delimiters) and ends with `endfor` (enclosed in matched
1830- If `variable` is an array, the material inside the loop will
1831 be evaluated repeatedly, with `variable` being set to each
1832 value of the array in turn, and concatenated.
1833- If `variable` is a map, the material inside will be set to
1835- If the value of the associated variable is not an array or
1836 a map, a single iteration will be performed on its value.
1841$for(foo)$$foo$$sep$, $endfor$
1844 - $foo.last$, $foo.first$
1848 - ${ foo.bar.last }, ${ foo.bar.first }
1852$it.name$: $it.office$
1856You may optionally specify a separator between consecutive
1857values using `sep` (enclosed in matched delimiters). The
1858material between `sep` and the `endfor` is the separator.
1861${ for(foo) }${ foo }${ sep }, ${ endfor }
1864Instead of using `variable` inside the loop, the special
1865anaphoric keyword `it` may be used.
1869 - ${ it.last }, ${ it.first }
1875Partials (subtemplates stored in different files) may be
1876included by using the name of the partial, followed
1877by `()`, for example:
1883Partials will be sought in the directory containing
1884the main template. The file name will be assumed to
1885have the same extension as the main template if it
1886lacks an extension. When calling the partial, the
1887full name including file extension can also be used:
1893(If a partial is not found in the directory of the
1894template, it will also be sought in the `templates`
1895subdirectory of the user data directory.)
1897Partials may optionally be applied to variables using
1903${ articles:bibentry() }
1906If `articles` is an array, this will iterate over its
1907values, applying the partial `bibentry()` to each one. So the
1908second example above is equivalent to
1916Note that the anaphoric keyword `it` must be used when
1917iterating over partials. In the above examples,
1918the `bibentry` partial should contain `it.title`
1919(and so on) instead of `articles.title`.
1921Final newlines are omitted from included partials.
1923Partials may include other partials.
1925A separator between values of an array may be specified
1926in square brackets, immediately after the variable name
1932${articles:bibentry()[; ]$
1935The separator in this case is literal and (unlike with `sep`
1936in an explicit `for` loop) cannot contain interpolated
1937variables or other template directives.
1941To ensure that content is "nested," that is, subsequent lines
1942indented, use the `^` directive:
1945$item.number$ $^$$item.description$ ($item.price$)
1948In this example, if `item.description` has multiple lines,
1949they will all be indented to line up with the first line:
195200123 A fine bottle of 18-year old
1953 Oban whiskey. ($148)
1956To nest multiple lines to the same level, align them
1957with the `^` directive in the template. For example:
1960$item.number$ $^$$item.description$ ($item.price$)
1961 (Available til $item.sellby$.)
196700123 A fine bottle of 18-year old
1968 Oban whiskey. ($148)
1969 (Available til March 30, 2020.)
1972If a variable occurs by itself on a line, preceded by whitespace
1973and not followed by further text or directives on the same line,
1974and the variable's value contains multiple lines, it will be
1975nested automatically.
1979Normally, spaces in the template itself (as opposed to values of
1980the interpolated variables) are not breakable, but they can be
1981made breakable in part of the template by using the `~` keyword
1982(ended with another `~`).
1985$~$This long line may break if the document is rendered
1986with a short line length.$~$
1991A pipe transforms the value of a variable or partial. Pipes are
1992specified using a slash (`/`) between the variable name (or partial)
1993and the pipe name. Example:
2000$for(metadata/pairs)$
2001- $it.key$: $it.value$
2004$employee:name()/uppercase$
2007Pipes may be chained:
2010$for(employees/pairs)$
2011$it.key/alpha/uppercase$. $it.name$
2015Some pipes take parameters:
2018|----------------------|------------|
2020$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2022|----------------------|------------|
2025Currently the following pipes are predefined:
2027- `pairs`: Converts a map or array to an array of maps,
2028 each with `key` and `value` fields. If the original
2029 value was an array, the `key` will be the array index,
2032- `uppercase`: Converts text to uppercase.
2034- `lowercase`: Converts text to lowercase.
2036- `length`: Returns the length of the value: number
2037 of characters for a textual value, number of elements
2040- `reverse`: Reverses a textual value or array,
2041 and has no effect on other values.
2043- `first`: Returns the first value of an array, if
2044 applied to a non-empty array; otherwise returns
2047- `last`: Returns the last value of an array, if
2048 applied to a non-empty array; otherwise returns
2051- `rest`: Returns all but the first value of an array, if
2052 applied to a non-empty array; otherwise returns
2055- `allbutlast`: Returns all but the last value of an array, if
2056 applied to a non-empty array; otherwise returns
2059- `chomp`: Removes trailing newlines (and breakable space).
2061- `nowrap`: Disables line wrapping on breakable spaces.
2063- `alpha`: Converts textual values that can be
2064 read as an integer into lowercase alphabetic
2065 characters `a..z` (mod 26). This can be used to get lettered
2066 enumeration from array indices. To get uppercase
2067 letters, chain with `uppercase`.
2069- `roman`: Converts textual values that can be
2070 read as an integer into lowercase roman numerials.
2071 This can be used to get lettered enumeration from array indices.
2072 To get uppercase roman, chain with `uppercase`.
2074- `left n "leftborder" "rightborder"`: Renders a textual value
2075 in a block of width `n`, aligned to the left, with an optional
2076 left and right border. Has no effect on other values. This
2077 can be used to align material in tables. Widths are positive
2078 integers indicating the number of characters. Borders
2079 are strings inside double quotes; literal `"` and `\` characters
2080 must be backslash-escaped.
2082- `right n "leftborder" "rightborder"`: Renders a textual value
2083 in a block of width `n`, aligned to the right, and has no
2084 effect on other values.
2086- `center n "leftborder" "rightborder"`: Renders a textual
2087 value in a block of width `n`, aligned to the center, and has
2088 no effect on other values.
2093### Metadata variables
2095`title`, `author`, `date`
2096: allow identification of basic aspects of the document. Included
2097 in PDF metadata through LaTeX and ConTeXt. These can be set
2098 through a [pandoc title block][Extension: `pandoc_title_block`],
2099 which allows for multiple authors, or through a
2100 [YAML metadata block][Extension: `yaml_metadata_block`]:
2108 Note that if you just want to set PDF or HTML metadata, without
2109 including a title block in the document itself, you can
2110 set the `title-meta`, `author-meta`, and `date-meta`
2111 variables. (By default these are set automatically, based
2112 on `title`, `author`, and `date`.) The page title in HTML
2113 is set by `pagetitle`, which is equal to `title` by default.
2116: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2120: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2124: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2125 and AsciiDoc metadata; repeat as for `author`, above
2128: document subject, included in ODT, PDF, docx and pptx metadata
2131: document description, included in ODT, docx and pptx metadata. Some
2132 applications show this as `Comments` metadata.
2135: document category, included in docx and pptx metadata
2138any root-level string metadata, not included in ODT, docx
2139or pptx metadata is added as a *custom property*.
2140The following [YAML] metadata block for instance:
2143 title: 'This is the title'
2144 subtitle: "This is the subtitle"
2152 It consists of two paragraphs
2155will include `title`, `author` and `description` as standard document
2156properties and `subtitle` as a custom property when converting to docx,
2159### Language variables
2162: identifies the main language of the document using IETF language
2163 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2164 The [Language subtag lookup] tool can look up or verify these tags.
2165 This affects most formats, and controls hyphenation in PDF output
2166 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2168 Use native pandoc [Divs and Spans] with the `lang` attribute to
2169 switch the language:
2175 Text in the main document language (British English).
2178 > Cette citation est écrite en français canadien.
2181 More text in English. ['Zitat auf Deutsch.']{lang=de}
2184: the base script direction, either `rtl` (right-to-left)
2185 or `ltr` (left-to-right).
2187 For bidirectional documents, native pandoc `span`s and
2188 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2189 be used to override the base direction in some output
2190 formats. This may not always be necessary if the final
2191 renderer (e.g. the browser, when generating HTML) supports
2192 the [Unicode Bidirectional Algorithm].
2194 When using LaTeX for bidirectional documents, only the
2195 `xelatex` engine is fully supported (use
2196 `--pdf-engine=xelatex`).
2198[BCP 47]: https://tools.ietf.org/html/bcp47
2199[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2200[Language subtag lookup]: https://r12a.github.io/app-subtags/
2202### Variables for HTML
2205: Enables inclusion of most of the [CSS] in the `styles.html`
2206 [partial](#partials) (have a look with
2207 `pandoc --print-default-data-file=templates/styles.html`).
2208 Unless you use [`--css`](#option--css), this variable
2209 is set to `true` by default. You can disable it with
2210 e.g. `pandoc -M document-css=false`.
2213: sets the CSS `font-family` property on the `html` element.
2216: sets the base CSS `font-size`, which you'd usually set
2217 to e.g. `20px`, but it also accepts `pt`
2218 (12pt = 16px in most browsers).
2221: sets the CSS `color` property on the `html` element.
2224: sets the CSS `color` property on all links.
2227: sets the CSS `font-family` property on `code` elements.
2229`monobackgroundcolor`
2230: sets the CSS `background-color` property on `code` elements
2231 and adds extra padding.
2234: sets the CSS `line-height` property on the `html` element,
2235 which is preferred to be unitless.
2238: sets the CSS `background-color` property on the `html` element.
2240`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2241: sets the corresponding CSS `padding` properties on the `body` element.
2243To override or extend some [CSS] for just one document, include for example:
2252 background-color: #f0f0f0;
2255 padding: 0.5em 2em 0.5em 0.5em;
2258 border-bottom: none;
2263[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2265### Variables for HTML math
2268: when using [KaTeX](#option--katex), you can render display
2269math equations flush left using [YAML metadata](#layout) or with
2270`-M classoption=fleqn`.
2272### Variables for HTML slides
2274These affect HTML output when [producing slide shows with pandoc].
2276All [reveal.js configuration options] are available as variables.
2277To turn off boolean flags that default to true in reveal.js, use `0`.
2280: base URL for reveal.js documents (defaults to
2281 `https://unpkg.com/reveal.js@^4/`)
2284: base URL for S5 documents (defaults to `s5/default`)
2287: base URL for Slidy documents (defaults to
2288 `https://www.w3.org/Talks/Tools/Slidy2`)
2291: base URL for Slideous documents (defaults to `slideous`)
2293`title-slide-attributes`
2294: additional attributes for the title slide of reveal.js slide shows.
2295 See [background in reveal.js and beamer] for an example.
2297[reveal.js configuration options]: https://revealjs.com/config/
2299### Variables for Beamer slides
2301These variables change the appearance of PDF slides using [`beamer`].
2304: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2305 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2309: produce an article from Beamer slides
2312: add extra beamer option with `\setbeameroption{}`
2315: author affiliations: can be a list when there are multiple authors
2318: logo image for slides
2321: controls navigation symbols (default is `empty` for no navigation
2322 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2325: enables "title pages" for new sections (default is true)
2327`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2331: options for LaTeX beamer themes (a list).
2334: image for title slide
2336### Variables for PowerPoint
2338These variables control the visual aspects of a slide show that
2339are not easily controlled via templates.
2342: font to use for code.
2344### Variables for LaTeX
2346Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2351: make `\paragraph` and `\subparagraph` (fourth- and
2352 fifth-level headings, or fifth- and sixth-level with book
2353 classes) free-standing rather than run-in; requires further
2354 formatting to distinguish from `\subsubsection` (third- or
2355 fourth-level headings). Instead of using this option,
2356 [KOMA-Script] can adjust headings more extensively:
2359 documentclass: scrartcl
2361 \RedeclareSectionCommand[
2362 beforeskip=-10pt plus -2pt minus -1pt,
2363 afterskip=1sp plus -1sp minus 1sp,
2364 font=\normalfont\itshape]{paragraph}
2365 \RedeclareSectionCommand[
2366 beforeskip=-10pt plus -2pt minus -1pt,
2367 afterskip=1sp plus -1sp minus 1sp,
2368 font=\normalfont\scshape,
2369 indent=0pt]{subparagraph}
2373: option for document class, e.g. `oneside`; repeat for multiple options:
2382: document class: usually one of the standard classes,
2383 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2384 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2385 default to smaller margins; or [`memoir`]
2388: option for [`geometry`] package, e.g. `margin=1in`;
2389 repeat for multiple options:
2399: option for [`hyperref`] package, e.g. `linktoc=all`;
2400 repeat for multiple options:
2406 - pdfpagemode=FullScreen
2410: if true, pandoc will use document class settings for
2411 indentation (the default LaTeX template otherwise removes
2412 indentation and adds space between paragraphs)
2415: adjusts line spacing using the [`setspace`]
2416 package, e.g. `1.25`, `1.5`
2418`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2419: sets margins if `geometry` is not used (otherwise `geometry`
2423: control `\pagestyle{}`: the default article class
2424 supports `plain` (default), `empty` (no running heads or page numbers),
2425 and `headings` (section titles in running heads)
2428: paper size, e.g. `letter`, `a4`
2431: numbering depth for sections (with `--number-sections` option
2432 or `numbersections` variable)
2437: allows font encoding to be specified through `fontenc` package (with
2438 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2441: font package for use with `pdflatex`:
2442 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2443 The default is [Latin Modern][`lm`].
2446: options for package used as `fontfamily`; repeat for multiple options.
2447 For example, to use the Libertine font with proportional lowercase
2448 (old-style) figures through the [`libertinus`] package:
2451 fontfamily: libertinus
2458: font size for body text. The standard classes allow 10pt, 11pt, and
2459 12pt. To use another size, set `documentclass` to one of
2460 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2462`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2463: font families for use with `xelatex` or
2464 `lualatex`: take the name of any system font, using the
2465 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2467`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2468: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2469 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2470 choices available through [`fontspec`]; repeat for multiple
2471 options. For example, to use the [TeX Gyre] version of
2472 Palatino with lowercase figures:
2475 mainfont: TeX Gyre Pagella
2478 - Numbers=Proportional
2482: options to pass to the microtype package
2487: add color to link text; automatically enabled if any of
2488 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2490`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2491: color for internal links, external links, citation links, linked
2492 URLs, and links in table of contents, respectively: uses options
2493 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2497: causes links to be printed as footnotes
2502: include list of figures, list of tables
2505: contents of acknowledgments footnote after document title
2508: include table of contents (can also be set using
2509 `--toc/--table-of-contents`)
2512: level of section to include in table of contents
2514#### BibLaTeX Bibliographies
2516These variables function when using BibLaTeX for [citation rendering].
2519: list of options for biblatex
2522: bibliography style, when used with `--natbib` and `--biblatex`.
2525: bibliography title, when used with `--natbib` and `--biblatex`.
2528: bibliography to use for resolving references
2531: list of options for natbib
2533[KOMA-Script]: https://ctan.org/pkg/koma-script
2534[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2535[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2536[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2537[`article`]: https://ctan.org/pkg/article
2538[`book`]: https://ctan.org/pkg/book
2539[`libertinus`]: https://ctan.org/pkg/libertinus
2540[`memoir`]: https://ctan.org/pkg/memoir
2541[`report`]: https://ctan.org/pkg/report
2543### Variables for ConTeXt
2545Pandoc uses these variables when [creating a PDF] with ConTeXt.
2548: font size for body text (e.g. `10pt`, `12pt`)
2550`headertext`, `footertext`
2551: text to be placed in running header or footer (see [ConTeXt Headers and
2552 Footers]); repeat up to four times for different placement
2555: controls indentation of paragraphs, e.g. `yes,small,next` (see
2556 [ConTeXt Indentation]); repeat for multiple options
2559: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2560 repeat for multiple options
2563: options for page margins and text arrangement (see [ConTeXt Layout]);
2564 repeat for multiple options
2566`linkcolor`, `contrastcolor`
2567: color for links outside and inside a page, e.g. `red`, `blue` (see
2571: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2572 `type`, `cap`, `small`
2575: include list of figures, list of tables
2577`mainfont`, `sansfont`, `monofont`, `mathfont`
2578: font families: take the name of any system font (see
2579 [ConTeXt Font Switching])
2581`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2582: sets margins, if `layout` is not used (otherwise `layout`
2586: page number style and location (using [`setuppagenumbering`]);
2587 repeat for multiple options
2590: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2591 repeat for multiple options
2594: adds to the preamble the setup necessary to generate PDF/A
2595 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2596 specified (i.e. the value is set to True, by e.g.
2597 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2598 `1b:2005` will be used as default, for reasons of backwards
2599 compatibility. Using `--variable=pdfa` without specified value
2600 is not supported. To successfully generate PDF/A the required
2601 ICC color profiles have to be available and the content and all
2602 included files (such as images) have to be standard conforming.
2603 The ICC profiles and output intent may be specified using the
2604 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2605 PDFA] for more details.
2608: when used in conjunction with `pdfa`, specifies the ICC profile to use
2609 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2610 used as default. May be repeated to include multiple profiles. Note that
2611 the profiles have to be available on the system. They can be obtained
2612 from [ConTeXt ICC Profiles].
2615: when used in conjunction with `pdfa`, specifies the output intent for
2616 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2617 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2620: include table of contents (can also be set using
2621 `--toc/--table-of-contents`)
2624: spacing between paragraphs, e.g. `none`, `small` (using
2625 [`setupwhitespace`])
2628: include all source documents as file attachments in the PDF file
2630[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2631[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2632[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2633[ConTeXt Color]: https://wiki.contextgarden.net/Color
2634[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2635[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2636[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2637[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2638[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2639[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2640[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2642### Variables for `wkhtmltopdf`
2644Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2645The `--css` option also affects the output.
2647`footer-html`, `header-html`
2648: add information to the header and footer
2650`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2651: set the page margins
2654: sets the PDF paper size
2656### Variables for man pages
2659: adjusts text to left (`l`), right (`r`), center (`c`),
2660 or both (`b`) margins
2663: footer in man pages
2666: header in man pages
2669: if `true` (the default), hyphenation will be used
2672: section number in man pages
2677: font family (e.g. `T` or `P`)
2680: paragraph indent (e.g. `2m`)
2683: line height (e.g. `12p`)
2686: point size (e.g. `10p`)
2688### Variables set automatically
2690Pandoc sets these variables automatically in response to [options] or
2691document contents; users can also modify them. These vary depending
2692on the output format, and include the following:
2698: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2699 included in all HTML based formats (dzslides, epub,
2700 html, html4, html5, revealjs, s5, slideous, slidy).
2701 The recognized formats for `date` are: `mm/dd/yyyy`,
2702 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2703 (e.g. either `02 Apr 2018` or `02 April 2018`),
2704 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2705 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2708: contents specified by `-H/--include-in-header` (may have multiple
2712: contents specified by `-B/--include-before-body` (may have
2716: contents specified by `-A/--include-after-body` (may have
2720: JSON representation of all of the document's metadata. Field
2721 values are transformed to the selected output format.
2724: non-null value if `-N/--number-sections` was specified
2726`sourcefile`, `outputfile`
2727: source and destination filenames, as given on the command line.
2728 `sourcefile` can also be a list if input comes from multiple files,
2729 or empty if input is from stdin. You can use the following snippet in
2730 your template to distinguish them:
2740 Similarly, `outputfile` can be `-` if output goes to the terminal.
2742 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2745: working directory from which pandoc is run.
2748: non-null value if `--toc/--table-of-contents` was specified
2751: title of table of contents (works only with EPUB,
2752 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2754[pandoc-templates]: https://github.com/jgm/pandoc-templates
2758The behavior of some of the readers and writers can be adjusted by
2759enabling or disabling various extensions.
2761An extension can be enabled by adding `+EXTENSION`
2762to the format name and disabled by adding `-EXTENSION`. For example,
2763`--from markdown_strict+footnotes` is strict Markdown with footnotes
2764enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2765Markdown without footnotes or pipe tables.
2767The markdown reader and writer make by far the most use of extensions.
2768Extensions only used by them are therefore covered in the
2769section [Pandoc's Markdown] below (See [Markdown variants] for
2770`commonmark` and `gfm`.) In the following, extensions that also work
2771for other formats are covered.
2773Note that markdown extensions added to the `ipynb` format
2774affect Markdown cells in Jupyter notebooks (as do command-line
2775options like `--atx-headers`).
2779#### Extension: `smart` ####
2781Interpret straight quotes as curly quotes, `---` as em-dashes,
2782`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2783inserted after certain abbreviations, such as "Mr."
2785This extension can be enabled/disabled for the following formats:
2788: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2791: `markdown`, `latex`, `context`, `rst`
2793enabled by default in
2794: `markdown`, `latex`, `context` (both input and output)
2796Note: If you are *writing* Markdown, then the `smart` extension
2797has the reverse effect: what would have been curly quotes comes
2800In LaTeX, `smart` means to use the standard TeX ligatures
2801for quotation marks (` `` ` and ` '' ` for double quotes,
2802`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2803en-dash and `---` for em-dash). If `smart` is disabled,
2804then in reading LaTeX pandoc will parse these characters
2805literally. In writing LaTeX, enabling `smart` tells pandoc
2806to use the ligatures when possible; if `smart` is disabled
2807pandoc will use unicode quotation mark and dash characters.
2809## Headings and sections
2811#### Extension: `auto_identifiers` ####
2813A heading without an explicitly specified identifier will be
2814automatically assigned a unique identifier based on the heading text.
2816This extension can be enabled/disabled for the following formats:
2819: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2824enabled by default in
2827The default algorithm used to derive the identifier from the
2830 - Remove all formatting, links, etc.
2831 - Remove all footnotes.
2832 - Remove all non-alphanumeric characters,
2833 except underscores, hyphens, and periods.
2834 - Replace all spaces and newlines with hyphens.
2835 - Convert all alphabetic characters to lowercase.
2836 - Remove everything up to the first letter (identifiers may
2837 not begin with a number or punctuation mark).
2838 - If nothing is left after this, use the identifier `section`.
2843 ------------------------------- ----------------------------
2844 `Heading identifiers in HTML` `heading-identifiers-in-html`
2845 `Maître d'hôtel` `maître-dhôtel`
2846 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2847 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2848 `3. Applications` `applications`
2851These rules should, in most cases, allow one to determine the identifier
2852from the heading text. The exception is when several headings have the
2853same text; in this case, the first will get an identifier as described
2854above; the second will get the same identifier with `-1` appended; the
2855third with `-2`; and so on.
2857(However, a different algorithm is used if
2858`gfm_auto_identifiers` is enabled; see below.)
2860These identifiers are used to provide link targets in the table of
2861contents generated by the `--toc|--table-of-contents` option. They
2862also make it easy to provide links from one section of a document to
2863another. A link to this section, for example, might look like this:
2866 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2868Note, however, that this method of providing links to sections works
2869only in HTML, LaTeX, and ConTeXt formats.
2871If the `--section-divs` option is specified, then each section will
2872be wrapped in a `section` (or a `div`, if `html4` was specified),
2873and the identifier will be attached to the enclosing `<section>`
2874(or `<div>`) tag rather than the heading itself. This allows entire
2875sections to be manipulated using JavaScript or treated differently in
2878#### Extension: `ascii_identifiers` ####
2880Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2881Accents are stripped off of accented Latin letters, and non-Latin
2884#### Extension: `gfm_auto_identifiers` ####
2886Changes the algorithm used by `auto_identifiers` to conform to
2887GitHub's method. Spaces are converted to dashes (`-`),
2888uppercase characters to lowercase characters, and punctuation
2889characters other than `-` and `_` are removed.
2890Emojis are replaced by their names.
2894The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2895[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2896[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2897are described in the section about Pandoc's Markdown.
2899However, they can also be used with HTML input. This is handy for
2900reading web pages formatted using MathJax, for example.
2904The following extensions are described in more detail in
2905their respective sections of [Pandoc's Markdown]:
2907- [`raw_html`](#extension-raw_html) allows HTML elements which
2908 are not representable in pandoc's AST to be parsed as raw HTML.
2909 By default, this is disabled for HTML input.
2911- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2912 to be included in a document. This extension can be enabled/disabled
2913 for the following formats (in addition to `markdown`):
2916 : `latex`, `textile`, `html` (environments, `\ref`, and
2917 `\eqref` only), `ipynb`
2920 : `textile`, `commonmark`
2922 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2923 only raw TeX in markdown cells, but data with mime type
2924 `text/html` in output cells. Since the `ipynb` reader attempts
2925 to preserve the richest possible outputs when several options
2926 are given, you will get best results if you disable `raw_html`
2927 and `raw_tex` when converting to formats like `docx` which don't
2928 allow raw `html` or `tex`.
2930- [`native_divs`](#extension-native_divs) causes HTML `div`
2931 elements to be parsed as native pandoc Div blocks.
2932 If you want them to be parsed as raw HTML, use
2933 `-f html-native_divs+raw_html`.
2935- [`native_spans`](#extension-native_spans) causes HTML `span`
2936 elements to be parsed as native pandoc Span inlines.
2937 If you want them to be parsed as raw HTML, use
2938 `-f html-native_spans+raw_html`. If you want to drop all
2939 `div`s and `span`s when converting HTML to Markdown, you
2940 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2942## Literate Haskell support
2944#### Extension: `literate_haskell` ####
2946Treat the document as literate Haskell source.
2948This extension can be enabled/disabled for the following formats:
2951: `markdown`, `rst`, `latex`
2954: `markdown`, `rst`, `latex`, `html`
2956If you append `+lhs` (or `+literate_haskell`) to one of the formats
2957above, pandoc will treat the document as literate Haskell source.
2960 - In Markdown input, "bird track" sections will be parsed as Haskell
2961 code rather than block quotations. Text between `\begin{code}`
2962 and `\end{code}` will also be treated as Haskell code. For
2963 ATX-style headings the character '=' will be used instead of '#'.
2965 - In Markdown output, code blocks with classes `haskell` and `literate`
2966 will be rendered using bird tracks, and block quotations will be
2967 indented one space, so they will not be treated as Haskell code.
2968 In addition, headings will be rendered setext-style (with underlines)
2969 rather than ATX-style (with '#' characters). (This is because ghc
2970 treats '#' characters in column 1 as introducing line numbers.)
2972 - In restructured text input, "bird track" sections will be parsed
2975 - In restructured text output, code blocks with class `haskell` will
2976 be rendered using bird tracks.
2978 - In LaTeX input, text in `code` environments will be parsed as
2981 - In LaTeX output, code blocks with class `haskell` will be rendered
2982 inside `code` environments.
2984 - In HTML output, code blocks with class `haskell` will be rendered
2985 with class `literatehaskell` and bird tracks.
2989 pandoc -f markdown+lhs -t html
2991reads literate Haskell source formatted with Markdown conventions and writes
2992ordinary HTML (without bird tracks).
2994 pandoc -f markdown+lhs -t html+lhs
2996writes HTML with the Haskell code in bird tracks, so it can be copied
2997and pasted as literate Haskell source.
2999Note that GHC expects the bird tracks in the first column, so indented
3000literate code blocks (e.g. inside an itemized environment) will not be
3001picked up by the Haskell compiler.
3005#### Extension: `empty_paragraphs` ####
3007Allows empty paragraphs. By default empty paragraphs are
3010This extension can be enabled/disabled for the following formats:
3016: `docx`, `odt`, `opendocument`, `html`
3018#### Extension: `native_numbering` ####
3020Enables native numbering of figures and tables. Enumeration
3023This extension can be enabled/disabled for the following formats:
3026: `odt`, `opendocument`
3028#### Extension: `xrefs_name` ####
3030Links to headings, figures and tables inside the document are
3031substituted with cross-references that will use the name or caption
3032of the referenced item. The original link text is replaced once
3033the generated document is refreshed. This extension can be combined
3034with `xrefs_number` in which case numbers will appear before the
3037Text in cross-references is only made consistent with the referenced
3038item once the document has been refreshed.
3040This extension can be enabled/disabled for the following formats:
3043: `odt`, `opendocument`
3045#### Extension: `xrefs_number` ####
3047Links to headings, figures and tables inside the document are
3048substituted with cross-references that will use the number
3049of the referenced item. The original link text is discarded.
3050This extension can be combined with `xrefs_name` in which case
3051the name or caption numbers will appear after the number.
3053For the `xrefs_number` to be useful heading numbers must be enabled
3054in the generated document, also table and figure captions must be enabled
3055using for example the `native_numbering` extension.
3057Numbers in cross-references are only visible in the final document once
3058it has been refreshed.
3060This extension can be enabled/disabled for the following formats:
3063: `odt`, `opendocument`
3065#### Extension: `styles` #### {#ext-styles}
3067When converting from docx, read all docx styles as divs (for
3068paragraph styles) and spans (for character styles) regardless
3069of whether pandoc understands the meaning of these styles.
3070This can be used with [docx custom styles](#custom-styles).
3076#### Extension: `amuse` ####
3078In the `muse` input format, this enables Text::Amuse
3079extensions to Emacs Muse markup.
3081#### Extension: `raw_markdown` ####
3083In the `ipynb` input format, this causes Markdown cells
3084to be included as raw Markdown blocks (allowing lossless
3085round-tripping) rather than being parsed. Use this only
3086when you are targeting `ipynb` or a markdown-based
3089#### Extension: `citations` {#org-citations}
3091Some aspects of [Pandoc's Markdown citation syntax](#citations)
3092are also accepted in `org` input.
3094#### Extension: `ntb` ####
3096In the `context` output format this enables the use of [Natural Tables
3097(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3098[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3099Natural tables allow more fine-grained global customization but come
3100at a performance penalty compared to extreme tables.
3105Pandoc understands an extended and slightly revised version of
3106John Gruber's [Markdown] syntax. This document explains the syntax,
3107noting differences from standard Markdown. Except where noted, these
3108differences can be suppressed by using the `markdown_strict` format instead
3109of `markdown`. Extensions can be enabled or disabled to specify the
3110behavior more granularly. They are described in the following. See also
3111[Extensions] above, for extensions that work also on other formats.
3115Markdown is designed to be easy to write, and, even more importantly,
3118> A Markdown-formatted document should be publishable as-is, as plain
3119> text, without looking like it's been marked up with tags or formatting
3121> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3123This principle has guided pandoc's decisions in finding syntax for
3124tables, footnotes, and other extensions.
3126There is, however, one respect in which pandoc's aims are different
3127from the original aims of Markdown. Whereas Markdown was originally
3128designed with HTML generation in mind, pandoc is designed for multiple
3129output formats. Thus, while pandoc allows the embedding of raw HTML,
3130it discourages it, and provides other, non-HTMLish ways of representing
3131important document elements like definition lists, tables, mathematics, and
3136A paragraph is one or more lines of text followed by one or more blank lines.
3137Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3138If you need a hard line break, put two or more spaces at the end of a line.
3140#### Extension: `escaped_line_breaks` ####
3142A backslash followed by a newline is also a hard line break.
3143Note: in multiline and grid table cells, this is the only way
3144to create a hard line break, since trailing spaces in the cells
3149There are two kinds of headings: Setext and ATX.
3151### Setext-style headings ###
3153A setext-style heading is a line of text "underlined" with a row of `=` signs
3154(for a level-one heading) or `-` signs (for a level-two heading):
3162The heading text can contain inline formatting, such as emphasis (see
3163[Inline formatting], below).
3166### ATX-style headings ###
3168An ATX-style heading consists of one to six `#` signs and a line of
3169text, optionally followed by any number of `#` signs. The number of
3170`#` signs at the beginning of the line is the heading level:
3172 ## A level-two heading
3174 ### A level-three heading ###
3176As with setext-style headings, the heading text can contain formatting:
3178 # A level-one heading with a [link](/url) and *emphasis*
3180#### Extension: `blank_before_header` ####
3182Standard Markdown syntax does not require a blank line before a heading.
3183Pandoc does require this (except, of course, at the beginning of the
3184document). The reason for the requirement is that it is all too easy for a
3185`#` to end up at the beginning of a line by accident (perhaps through line
3186wrapping). Consider, for example:
3188 I like several of their flavors of ice cream:
3189 #22, for example, and #5.
3191#### Extension: `space_in_atx_header` ####
3193Many Markdown implementations do not require a space between the
3194opening `#`s of an ATX heading and the heading text, so that
3195`#5 bolt` and `#hashtag` count as headings. With this extension,
3196pandoc does require the space.
3198### Heading identifiers ###
3200See also the [`auto_identifiers`
3201extension](#extension-auto_identifiers) above.
3203#### Extension: `header_attributes` ####
3205Headings can be assigned attributes using this syntax at the end
3206of the line containing the heading text:
3208 {#identifier .class .class key=value key=value}
3210Thus, for example, the following headings will all be assigned the identifier
3215 ## My heading ## {#foo}
3217 My other heading {#foo}
3220(This syntax is compatible with [PHP Markdown Extra].)
3222Note that although this syntax allows assignment of classes and key/value
3223attributes, writers generally don't use all of this information. Identifiers,
3224classes, and key/value attributes are used in HTML and HTML-based formats such
3225as EPUB and slidy. Identifiers are used for labels and link anchors in the
3226LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3228Headings with the class `unnumbered` will not be numbered, even if
3229`--number-sections` is specified. A single hyphen (`-`) in an attribute
3230context is equivalent to `.unnumbered`, and preferable in non-English
3237 # My heading {.unnumbered}
3239If the `unlisted` class is present in addition to `unnumbered`,
3240the heading will not be included in a table of contents.
3241(Currently this feature is only implemented for certain
3242formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3244#### Extension: `implicit_header_references` ####
3246Pandoc behaves as if reference links have been defined for each heading.
3247So, to link to a heading
3249 # Heading identifiers in HTML
3253 [Heading identifiers in HTML]
3257 [Heading identifiers in HTML][]
3261 [the section on heading identifiers][heading identifiers in
3264instead of giving the identifier explicitly:
3266 [Heading identifiers in HTML](#heading-identifiers-in-html)
3268If there are multiple headings with identical text, the corresponding
3269reference will link to the first one only, and you will need to use explicit
3270links to link to the others, as described above.
3272Like regular reference links, these references are case-insensitive.
3274Explicit link reference definitions always take priority over
3275implicit heading references. So, in the following example, the
3276link will point to `bar`, not to `#foo`:
3286Markdown uses email conventions for quoting blocks of text.
3287A block quotation is one or more paragraphs or other block elements
3288(such as lists or headings), with each line preceded by a `>` character
3289and an optional space. (The `>` need not start at the left margin, but
3290it should not be indented more than three spaces.)
3292 > This is a block quote. This
3293 > paragraph has two lines.
3295 > 1. This is a list inside a block quote.
3298A "lazy" form, which requires the `>` character only on the first
3299line of each block, is also allowed:
3301 > This is a block quote. This
3302 paragraph has two lines.
3304 > 1. This is a list inside a block quote.
3307Among the block elements that can be contained in a block quote are
3308other block quotes. That is, block quotes can be nested:
3310 > This is a block quote.
3312 > > A block quote within a block quote.
3314If the `>` character is followed by an optional space, that space
3315will be considered part of the block quote marker and not part of
3316the indentation of the contents. Thus, to put an indented code
3317block in a block quote, you need five spaces after the `>`:
3321#### Extension: `blank_before_blockquote` ####
3323Standard Markdown syntax does not require a blank line before a
3324block quote. Pandoc does require this (except, of course, at
3325the beginning of the document). The reason for the requirement
3326is that it is all too easy for a `>` to end up at the beginning
3327of a line by accident (perhaps through line wrapping). So,
3328unless the `markdown_strict` format is used, the following does
3329not produce a nested block quote in pandoc:
3331 > This is a block quote.
3335## Verbatim (code) blocks
3337### Indented code blocks ###
3339A block of text indented four spaces (or one tab) is treated as verbatim
3340text: that is, special characters do not trigger special formatting,
3341and all spaces and line breaks are preserved. For example,
3344 moveShip(5 * gravity, DOWN);
3347The initial (four space or one tab) indentation is not considered part
3348of the verbatim text, and is removed in the output.
3350Note: blank lines in the verbatim text need not begin with four spaces.
3353### Fenced code blocks ###
3355#### Extension: `fenced_code_blocks` ####
3357In addition to standard indented code blocks, pandoc supports
3358*fenced* code blocks. These begin with a row of three or more
3359tildes (`~`) and end with a row of tildes that must be at least as long as
3360the starting row. Everything between these lines is treated as code. No
3361indentation is necessary:
3365 moveShip(5 * gravity, DOWN);
3369Like regular code blocks, fenced code blocks must be separated
3370from surrounding text by blank lines.
3372If the code itself contains a row of tildes or backticks, just use a longer
3373row of tildes or backticks at the start and end:
3377 code including tildes
3381#### Extension: `backtick_code_blocks` ####
3383Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3386#### Extension: `fenced_code_attributes` ####
3388Optionally, you may attach attributes to fenced or backtick code block using
3391 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3393 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3394 qsort (filter (>= x) xs)
3395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3397Here `mycode` is an identifier, `haskell` and `numberLines` are
3398classes, and `startFrom` is an attribute with value `100`. Some
3399output formats can use this information to do syntax
3400highlighting. Currently, the only output formats that uses this
3401information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3402highlighting is supported for your output format and language,
3403then the code block above will appear highlighted, with numbered
3404lines. (To see which languages are supported, type `pandoc
3405--list-highlight-languages`.) Otherwise, the code block above
3406will appear as follows:
3408 <pre id="mycode" class="haskell numberLines" startFrom="100">
3414The `numberLines` (or `number-lines`) class will cause the lines
3415of the code block to be numbered, starting with `1` or the value
3416of the `startFrom` attribute. The `lineAnchors` (or
3417`line-anchors`) class will cause the lines to be clickable
3418anchors in HTML output.
3420A shortcut form can also be used for specifying the language of
3427This is equivalent to:
3433If the `fenced_code_attributes` extension is disabled, but
3434input contains class attribute(s) for the code block, the first
3435class attribute will be printed after the opening fence as a bare
3438To prevent all highlighting, use the `--no-highlight` flag.
3439To set the highlighting style, use `--highlight-style`.
3440For more information on highlighting, see [Syntax highlighting],
3445#### Extension: `line_blocks` ####
3447A line block is a sequence of lines beginning with a vertical bar (`|`)
3448followed by a space. The division into lines will be preserved in
3449the output, as will any leading spaces; otherwise, the lines will
3450be formatted as Markdown. This is useful for verse and addresses:
3452 | The limerick packs laughs anatomical
3453 | In space that is quite economical.
3454 | But the good ones I've seen
3455 | So seldom are clean
3456 | And the clean ones so seldom are comical
3459 | Berkeley, CA 94718
3461The lines can be hard-wrapped if needed, but the continuation
3462line must begin with a space.
3464 | The Right Honorable Most Venerable and Righteous Samuel L.
3467 | Berkeley, CA 94718
3469This syntax is borrowed from [reStructuredText].
3475A bullet list is a list of bulleted list items. A bulleted list
3476item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3483This will produce a "compact" list. If you want a "loose" list, in which
3484each item is formatted as a paragraph, put spaces between the items:
3492The bullets need not be flush with the left margin; they may be
3493indented one, two, or three spaces. The bullet must be followed
3496List items look best if subsequent lines are flush with the first
3497line (after the bullet):
3503But Markdown also allows a "lazy" format:
3509### Block content in list items ###
3511A list item may contain multiple paragraphs and other block-level
3512content. However, subsequent paragraphs must be preceded by a blank line
3513and indented to line up with the first non-space content after
3520 * Second paragraph. With a code block, which must be indented
3525Exception: if the list marker is followed by an indented code
3526block, which must begin 5 spaces after the list marker, then
3527subsequent paragraphs must begin two columns after the last
3528character of the list marker:
3532 continuation paragraph
3534List items may include other lists. In this case the preceding blank
3535line is optional. The nested list must be indented to line up with
3536the first non-space character after the list marker of the
3537containing list item.
3549As noted above, Markdown allows you to write list items "lazily," instead of
3550indenting continuation lines. However, if there are multiple paragraphs or
3551other blocks in a list item, the first line of each must be indented.
3553 + A lazy, lazy, list
3556 + Another one; this looks
3559 Second paragraph of second
3562### Ordered lists ###
3564Ordered lists work just like bulleted lists, except that the items
3565begin with enumerators rather than bullets.
3567In standard Markdown, enumerators are decimal numbers followed
3568by a period and a space. The numbers themselves are ignored, so
3569there is no difference between this list:
3581#### Extension: `fancy_lists` ####
3583Unlike standard Markdown, pandoc allows ordered list items to be marked
3584with uppercase and lowercase letters and roman numerals, in addition to
3585Arabic numerals. List markers may be enclosed in parentheses or followed by a
3586single right-parentheses or period. They must be separated from the
3587text that follows by at least one space, and, if the list marker is a
3588capital letter with a period, by at least two spaces.[^2]
3590[^2]: The point of this rule is to ensure that normal paragraphs
3591 starting with people's initials, like
3593 B. Russell was an English philosopher.
3595 do not get treated as list items.
3597 This rule will not prevent
3601 from being interpreted as a list item. In this case, a backslash
3606The `fancy_lists` extension also allows '`#`' to be used as an
3607ordered list marker in place of a numeral:
3612#### Extension: `startnum` ####
3614Pandoc also pays attention to the type of list marker used, and to the
3615starting number, and both of these are preserved where possible in the
3616output format. Thus, the following yields a list with numbers followed
3617by a single parenthesis, starting with 9, and a sublist with lowercase
3627Pandoc will start a new list each time a different type of list
3628marker is used. So, the following will create three lists:
3635If default list markers are desired, use `#.`:
3641#### Extension: `task_lists` ####
3643Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3645 - [ ] an unchecked task list item
3648### Definition lists ###
3650#### Extension: `definition_lists` ####
3652Pandoc supports definition lists, using the syntax of
3653[PHP Markdown Extra] with some extensions.[^3]
3659 Term 2 with *inline markup*
3663 { some code, part of Definition 2 }
3665 Third paragraph of definition 2.
3667Each term must fit on one line, which may optionally be followed by
3668a blank line, and must be followed by one or more definitions.
3669A definition begins with a colon or tilde, which may be indented one
3672A term may have multiple definitions, and each definition may
3673consist of one or more block elements (paragraph, code block,
3674list, etc.), each indented four spaces or one tab stop. The
3675body of the definition (including the first line, aside from the
3676colon or tilde) should be indented four spaces. However, as with
3677other Markdown lists, you can "lazily" omit indentation except
3678at the beginning of a paragraph or other block element:
3683 with lazy continuation.
3685 Second paragraph of the definition.
3687If you leave space before the definition (as in the example above),
3688the text of the definition will be treated as a paragraph. In some
3689output formats, this will mean greater spacing between term/definition
3690pairs. For a more compact definition list, omit the space before the
3700Note that space between items in a definition list is required.
3701(A variant that loosens this requirement, but disallows "lazy"
3702hard wrapping, can be activated with `compact_definition_lists`: see
3703[Non-pandoc extensions], below.)
3705[^3]: I have been influenced by the suggestions of [David
3706 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3708### Numbered example lists ###
3710#### Extension: `example_lists` ####
3712The special list marker `@` can be used for sequentially numbered
3713examples. The first list item with a `@` marker will be numbered '1',
3714the next '2', and so on, throughout the document. The numbered examples
3715need not occur in a single list; each new list using `@` will take up
3716where the last stopped. So, for example:
3718 (@) My first example will be numbered (1).
3719 (@) My second example will be numbered (2).
3721 Explanation of examples.
3723 (@) My third example will be numbered (3).
3725Numbered examples can be labeled and referred to elsewhere in the
3728 (@good) This is a good example.
3730 As (@good) illustrates, ...
3732The label can be any string of alphanumeric characters, underscores,
3735Note: continuation paragraphs in example lists must always
3736be indented four spaces, regardless of the length of the
3737list marker. That is, example lists always behave as if the
3738`four_space_rule` extension is set. This is because example
3739labels tend to be long, and indenting content to the
3740first non-space character after the label would be awkward.
3743### Ending a list ###
3745What if you want to put an indented code block after a list?
3752Trouble! Here pandoc (like other Markdown implementations) will treat
3753`{ my code block }` as the second paragraph of item two, and not as
3756To "cut off" the list after item two, you can insert some non-indented
3757content, like an HTML comment, which won't produce visible output in
3763 <!-- end of list -->
3767You can use the same trick if you want two consecutive lists instead
3782A line containing a row of three or more `*`, `-`, or `_` characters
3783(optionally separated by spaces) produces a horizontal rule:
3792Four kinds of tables may be used. The first three kinds presuppose the use of
3793a fixed-width font, such as Courier. The fourth kind can be used with
3794proportionally spaced fonts, as it does not require lining up columns.
3796#### Extension: `table_captions` ####
3798A caption may optionally be provided with all 4 kinds of tables (as
3799illustrated in the examples below). A caption is a paragraph beginning
3800with the string `Table:` (or just `:`), which will be stripped off.
3801It may appear either before or after the table.
3803#### Extension: `simple_tables` ####
3805Simple tables look like this:
3807 Right Left Center Default
3808 ------- ------ ---------- -------
3813 Table: Demonstration of simple table syntax.
3815The header and table rows must each fit on one line. Column
3816alignments are determined by the position of the header text relative
3817to the dashed line below it:[^4]
3819 - If the dashed line is flush with the header text on the right side
3820 but extends beyond it on the left, the column is right-aligned.
3821 - If the dashed line is flush with the header text on the left side
3822 but extends beyond it on the right, the column is left-aligned.
3823 - If the dashed line extends beyond the header text on both sides,
3824 the column is centered.
3825 - If the dashed line is flush with the header text on both sides,
3826 the default alignment is used (in most cases, this will be left).
3828[^4]: This scheme is due to Michel Fortin, who proposed it on the
3829 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3831The table must end with a blank line, or a line of dashes followed by
3834The column header row may be omitted, provided a dashed line is used
3835to end the table. For example:
3837 ------- ------ ---------- -------
3841 ------- ------ ---------- -------
3843When the header row is omitted, column alignments are determined on the basis
3844of the first line of the table body. So, in the tables above, the columns
3845would be right, left, center, and right aligned, respectively.
3847#### Extension: `multiline_tables` ####
3849Multiline tables allow header and table rows to span multiple lines
3850of text (but cells that span multiple columns or rows of the table are
3851not supported). Here is an example:
3853 -------------------------------------------------------------
3854 Centered Default Right Left
3855 Header Aligned Aligned Aligned
3856 ----------- ------- --------------- -------------------------
3857 First row 12.0 Example of a row that
3858 spans multiple lines.
3860 Second row 5.0 Here's another one. Note
3861 the blank line between
3863 -------------------------------------------------------------
3865 Table: Here's the caption. It, too, may span
3868These work like simple tables, but with the following differences:
3870 - They must begin with a row of dashes, before the header text
3871 (unless the header row is omitted).
3872 - They must end with a row of dashes, then a blank line.
3873 - The rows must be separated by blank lines.
3875In multiline tables, the table parser pays attention to the widths of
3876the columns, and the writers try to reproduce these relative widths in
3877the output. So, if you find that one of the columns is too narrow in the
3878output, try widening it in the Markdown source.
3880The header may be omitted in multiline tables as well as simple tables:
3882 ----------- ------- --------------- -------------------------
3883 First row 12.0 Example of a row that
3884 spans multiple lines.
3886 Second row 5.0 Here's another one. Note
3887 the blank line between
3889 ----------- ------- --------------- -------------------------
3891 : Here's a multiline table without a header.
3893It is possible for a multiline table to have just one row, but the row
3894should be followed by a blank line (and then the row of dashes that ends
3895the table), or the table may be interpreted as a simple table.
3897#### Extension: `grid_tables` ####
3899Grid tables look like this:
3901 : Sample grid table.
3903 +---------------+---------------+--------------------+
3904 | Fruit | Price | Advantages |
3905 +===============+===============+====================+
3906 | Bananas | $1.34 | - built-in wrapper |
3907 | | | - bright color |
3908 +---------------+---------------+--------------------+
3909 | Oranges | $2.10 | - cures scurvy |
3911 +---------------+---------------+--------------------+
3913The row of `=`s separates the header from the table body, and can be
3914omitted for a headerless table. The cells of grid tables may contain
3915arbitrary block elements (multiple paragraphs, code blocks, lists,
3916etc.). Cells that span multiple columns or rows are not
3917supported. Grid tables can be created easily using Emacs' table-mode
3918(`M-x table-insert`).
3920Alignments can be specified as with pipe tables, by putting
3921colons at the boundaries of the separator line after the
3924 +---------------+---------------+--------------------+
3925 | Right | Left | Centered |
3926 +==============:+:==============+:==================:+
3927 | Bananas | $1.34 | built-in wrapper |
3928 +---------------+---------------+--------------------+
3930For headerless tables, the colons go on the top line instead:
3932 +--------------:+:--------------+:------------------:+
3933 | Right | Left | Centered |
3934 +---------------+---------------+--------------------+
3936##### Grid Table Limitations #####
3938Pandoc does not support grid tables with row spans or column spans.
3939This means that neither variable numbers of columns across rows nor
3940variable numbers of rows across columns are supported by Pandoc.
3941All grid tables must have the same number of columns in each row,
3942and the same number of rows in each column. For example, the
3943Docutils [sample grid tables] will not render as expected with
3946[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3949#### Extension: `pipe_tables` ####
3951Pipe tables look like this:
3953 | Right | Left | Default | Center |
3954 |------:|:-----|---------|:------:|
3955 | 12 | 12 | 12 | 12 |
3956 | 123 | 123 | 123 | 123 |
3959 : Demonstration of pipe table syntax.
3961The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3962ending pipe characters are optional, but pipes are required between all
3963columns. The colons indicate column alignment as shown. The header
3964cannot be omitted. To simulate a headerless table, include a header
3967Since the pipes indicate column boundaries, columns need not be vertically
3968aligned, as they are in the above example. So, this is a perfectly
3969legal (though ugly) pipe table:
3977The cells of pipe tables cannot contain block elements like paragraphs
3978and lists, and cannot span multiple lines. If a pipe table contains a
3979row whose Markdown content is wider than the column width (see
3980`--columns`), then the table will take up the full text width and
3981the cell contents will wrap, with the relative cell widths determined
3982by the number of dashes in the line separating the table header from
3983the table body. (For example `---|-` would make the first column 3/4
3984and the second column 1/4 of the full text width.)
3985On the other hand, if no lines are wider than column width, then
3986cell contents will not be wrapped, and the cells will be sized
3989Note: pandoc also recognizes pipe tables of the following
3990form, as can be produced by Emacs' orgtbl-mode:
3997The difference is that `+` is used instead of `|`. Other orgtbl features
3998are not supported. In particular, to get non-default column alignment,
3999you'll need to add colons as above.
4001[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4005#### Extension: `pandoc_title_block` ####
4007If the file begins with a title block
4010 % author(s) (separated by semicolons)
4013it will be parsed as bibliographic information, not regular text. (It
4014will be used, for example, in the title of standalone LaTeX or HTML
4015output.) The block may contain just a title, a title and an author,
4016or all three elements. If you want to include an author but no
4017title, or a title and a date but no author, you need a blank line:
4030The title may occupy multiple lines, but continuation lines must
4031begin with leading space, thus:
4038If a document has multiple authors, the authors may be put on
4039separate lines with leading space, or separated by semicolons, or
4040both. So, all of the following are equivalent:
4048% Author One; Author Two
4056The date must fit on one line.
4058All three metadata fields may contain standard inline formatting
4059(italics, links, footnotes, etc.).
4061Title blocks will always be parsed, but they will affect the output only
4062when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4063will appear twice: once in the document head -- this is the title that
4064will appear at the top of the window in a browser -- and once at the
4065beginning of the document body. The title in the document head can have
4066an optional prefix attached (`--title-prefix` or `-T` option). The title
4067in the body appears as an H1 element with class "title", so it can be
4068suppressed or reformatted with CSS. If a title prefix is specified with
4069`-T` and no title block appears in the document, the title prefix will
4070be used by itself as the HTML title.
4072The man page writer extracts a title, man page section number, and
4073other header and footer information from the title line. The title
4074is assumed to be the first word on the title line, which may optionally
4075end with a (single-digit) section number in parentheses. (There should
4076be no space between the title and the parentheses.) Anything after
4077this is assumed to be additional footer and header text. A single pipe
4078character (`|`) should be used to separate the footer text from the header
4083will yield a man page with the title `PANDOC` and section 1.
4085 % PANDOC(1) Pandoc User Manuals
4087will also have "Pandoc User Manuals" in the footer.
4089 % PANDOC(1) Pandoc User Manuals | Version 4.0
4091will also have "Version 4.0" in the header.
4093#### Extension: `yaml_metadata_block` ####
4095A [YAML] metadata block is a valid YAML object, delimited by a line of three
4096hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4097(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4098document, but if it is not at the beginning, it must be preceded by a blank
4099line. (Note that, because of the way pandoc concatenates input files when
4100several are provided, you may also keep the metadata in a separate YAML file
4101and pass it to pandoc as an argument, along with your Markdown files:
4103 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4105Just be sure that the YAML file begins with `---` and ends with `---` or
4106`...`.) Alternatively, you can use the `--metadata-file` option. Using
4107that approach however, you cannot reference content (like footnotes)
4108from the main markdown input document.
4110Metadata will be taken from the fields of the YAML object and added to any
4111existing document metadata. Metadata can contain lists and objects (nested
4112arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4113with names ending in an underscore will be ignored by pandoc. (They may be
4114given a role by external processors.) Field names must not be
4115interpretable as YAML numbers or boolean values (so, for
4116example, `yes`, `True`, and `15` cannot be used as field names).
4118A document may contain multiple metadata blocks. If two
4119metadata blocks attempt to set the same field, the value from
4120the second block will be taken.
4122When pandoc is used with `-t markdown` to create a Markdown document,
4123a YAML metadata block will be produced only if the `-s/--standalone`
4124option is used. All of the metadata will appear in a single block
4125at the beginning of the document.
4127Note that [YAML] escaping rules must be followed. Thus, for example,
4128if a title contains a colon, it must be quoted. The pipe character
4129(`|`) can be used to begin an indented block that will be interpreted
4130literally, without need for escaping. This form is necessary
4131when the field contains blank lines or block-level formatting:
4134 title: 'This is the title: it contains a colon'
4138 keywords: [nothing, nothingness]
4140 This is the abstract.
4142 It consists of two paragraphs.
4145Template variables will be set automatically from the metadata. Thus, for
4146example, in writing HTML, the variable `abstract` will be set to the HTML
4147equivalent of the Markdown in the `abstract` field:
4149 <p>This is the abstract.</p>
4150 <p>It consists of two paragraphs.</p>
4152Variables can contain arbitrary YAML structures, but the template must match
4153this structure. The `author` variable in the default templates expects a
4154simple list or string, but can be changed to support more complicated
4155structures. The following combination, for example, would add an affiliation
4156to the author if one is given:
4159 title: The document title
4162 affiliation: University of Somewhere
4164 affiliation: University of Nowhere
4167To use the structured authors in the example above, you would need a custom
4172 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4178Raw content to include in the document's header may be specified
4179using `header-includes`; however, it is important to mark up
4180this content as raw code for a particular output format, using
4181the [`raw_attribute` extension](#extension-raw_attribute)), or it
4182will be interpreted as markdown. For example:
4187 \let\oldsection\section
4188 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4193#### Extension: `all_symbols_escapable` ####
4195Except inside a code block or inline code, any punctuation or space
4196character preceded by a backslash will be treated literally, even if it
4197would normally indicate formatting. Thus, for example, if one writes
4207 <strong>hello</strong>
4209This rule is easier to remember than standard Markdown's rule,
4210which allows only the following characters to be backslash-escaped:
4214(However, if the `markdown_strict` format is used, the standard Markdown rule
4217A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4218it will appear as `~`. In HTML and XML output, it will appear as a
4219literal unicode nonbreaking space character (note that it will thus
4220actually look "invisible" in the generated HTML source; you can still
4221use the `--ascii` command-line option to make it appear as an explicit
4224A backslash-escaped newline (i.e. a backslash occurring at the end of
4225a line) is parsed as a hard line break. It will appear in TeX output as
4226`\\` and in HTML as `<br />`. This is a nice alternative to
4227Markdown's "invisible" way of indicating hard line breaks using
4228two trailing spaces on a line.
4230Backslash escapes do not work in verbatim contexts.
4236To *emphasize* some text, surround it with `*`s or `_`, like this:
4238 This text is _emphasized with underscores_, and this
4239 is *emphasized with asterisks*.
4241Double `*` or `_` produces **strong emphasis**:
4243 This is **strong emphasis** and __with underscores__.
4245A `*` or `_` character surrounded by spaces, or backslash-escaped,
4246will not trigger emphasis:
4248 This is * not emphasized *, and \*neither is this\*.
4250#### Extension: `intraword_underscores` ####
4252Because `_` is sometimes used inside words and identifiers,
4253pandoc does not interpret a `_` surrounded by alphanumeric
4254characters as an emphasis marker. If you want to emphasize
4255just part of a word, use `*`:
4257 feas*ible*, not feas*able*.
4262#### Extension: `strikeout` ####
4264To strikeout a section of text with a horizontal line, begin and end it
4265with `~~`. Thus, for example,
4267 This ~~is deleted text.~~
4270### Superscripts and subscripts ###
4272#### Extension: `superscript`, `subscript` ####
4274Superscripts may be written by surrounding the superscripted text by `^`
4275characters; subscripts may be written by surrounding the subscripted
4276text by `~` characters. Thus, for example,
4278 H~2~O is a liquid. 2^10^ is 1024.
4280The text between `^...^` or `~...~` may not contain spaces or
4281newlines. If the superscripted or subscripted text contains
4282spaces, these spaces must be escaped with backslashes. (This is
4283to prevent accidental superscripting and subscripting through
4284the ordinary use of `~` and `^`, and also bad interactions with
4285footnotes.) Thus, if you want the letter P with 'a cat' in
4286subscripts, use `P~a\ cat~`, not `P~a cat~`.
4290To make a short span of text verbatim, put it inside backticks:
4292 What is the difference between `>>=` and `>>`?
4294If the verbatim text includes a backtick, use double backticks:
4296 Here is a literal backtick `` ` ``.
4298(The spaces after the opening backticks and before the closing
4299backticks will be ignored.)
4301The general rule is that a verbatim span starts with a string
4302of consecutive backticks (optionally followed by a space)
4303and ends with a string of the same number of backticks (optionally
4304preceded by a space).
4306Note that backslash-escapes (and other Markdown constructs) do not
4307work in verbatim contexts:
4309 This is a backslash followed by an asterisk: `\*`.
4311#### Extension: `inline_code_attributes` ####
4313Attributes can be attached to verbatim text, just as with
4314[fenced code blocks]:
4320To write small caps, use the `smallcaps` class:
4322 [Small caps]{.smallcaps}
4324Or, without the `bracketed_spans` extension:
4326 <span class="smallcaps">Small caps</span>
4328For compatibility with other Markdown flavors, CSS is also supported:
4330 <span style="font-variant:small-caps;">Small caps</span>
4332This will work in all output formats that support small caps.
4337#### Extension: `tex_math_dollars` ####
4339Anything between two `$` characters will be treated as TeX math. The
4340opening `$` must have a non-space character immediately to its right,
4341while the closing `$` must have a non-space character immediately to its
4342left, and must not be followed immediately by a digit. Thus,
4343`$20,000 and $30,000` won't parse as math. If for some reason
4344you need to enclose text in literal `$` characters, backslash-escape
4345them and they won't be treated as math delimiters.
4347For display math, use `$$` delimiters. (In this case, the delimiters
4348may be separated from the formula by whitespace.)
4350TeX math will be printed in all output formats. How it is rendered
4351depends on the output format:
4354 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4355 math) or `\[...\]` (for display math).
4357Markdown, Emacs Org mode, ConTeXt, ZimWiki
4358 ~ It will appear verbatim surrounded by `$...$` (for inline
4359 math) or `$$...$$` (for display math).
4362 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4365 ~ It will be rendered using an [interpreted text role `:math:`].
4368 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4369 surrounded by `latexmath:[$...$]` (for inline math) or
4370 `[latexmath]++++\[...\]+++` (for display math).
4371 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4372 (`$..$` and `\[..\]`) are omitted.
4375 ~ It will be rendered inside a `@math` command.
4377roff man, Jira markup
4378 ~ It will be rendered verbatim without `$`'s.
4381 ~ It will be rendered inside `<math>` tags.
4384 ~ It will be rendered inside `<span class="math">` tags.
4387 ~ It will be rendered, if possible, using Unicode characters,
4388 and will otherwise appear verbatim.
4391 ~ It will be rendered, if possible, using MathML.
4394 ~ If the `--mathml` flag is used, it will be rendered using MathML
4395 in an `inlineequation` or `informalequation` tag. Otherwise it
4396 will be rendered, if possible, using Unicode characters.
4399 ~ It will be rendered using OMML math markup.
4402 ~ If the `--webtex` option is used, formulas are rendered as images
4403 using CodeCogs or other compatible web service, downloaded
4404 and embedded in the e-book. Otherwise, they will appear verbatim.
4406HTML, Slidy, DZSlides, S5, EPUB
4407 ~ The way math is rendered in HTML will depend on the
4408 command-line options selected. Therefore see [Math rendering in HTML]
4411[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4415#### Extension: `raw_html` ####
4417Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4418(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4419literally). (Technically this is not an extension, since standard
4420Markdown allows it, but it has been made an extension so that it can
4421be disabled if desired.)
4423The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4424DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4425output, and suppressed in other formats.
4427For a more explicit way of including raw HTML in a Markdown
4428document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4430In the CommonMark format, if `raw_html` is enabled, superscripts,
4431subscripts, strikeouts and small capitals will be represented as HTML.
4432Otherwise, plain-text fallbacks will be used. Note that even if
4433`raw_html` is disabled, tables will be rendered with HTML syntax if
4434they cannot use pipe syntax.
4436#### Extension: `markdown_in_html_blocks` ####
4438Standard Markdown allows you to include HTML "blocks": blocks
4439of HTML between balanced tags that are separated from the surrounding text
4440with blank lines, and start and end at the left margin. Within
4441these blocks, everything is interpreted as HTML, not Markdown;
4442so (for example), `*` does not signify emphasis.
4444Pandoc behaves this way when the `markdown_strict` format is used; but
4445by default, pandoc interprets material between HTML block tags as Markdown.
4446Thus, for example, pandoc will turn
4451 <td>[a link](https://google.com)</td>
4459 <td><em>one</em></td>
4460 <td><a href="https://google.com">a link</a></td>
4464whereas `Markdown.pl` will preserve it as is.
4466There is one exception to this rule: text between `<script>` and
4467`<style>` tags is not interpreted as Markdown.
4469This departure from standard Markdown should make it easier to mix
4470Markdown with HTML block elements. For example, one can surround
4471a block of Markdown text with `<div>` tags without preventing it
4472from being interpreted as Markdown.
4474#### Extension: `native_divs` ####
4476Use native pandoc `Div` blocks for content inside `<div>` tags.
4477For the most part this should give the same output as
4478`markdown_in_html_blocks`, but it makes it easier to write pandoc
4479filters to manipulate groups of blocks.
4481#### Extension: `native_spans` ####
4483Use native pandoc `Span` blocks for content inside `<span>` tags.
4484For the most part this should give the same output as `raw_html`,
4485but it makes it easier to write pandoc filters to manipulate groups
4488#### Extension: `raw_tex` ####
4490In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4491included in a document. Inline TeX commands will be preserved and passed
4492unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4493LaTeX to include BibTeX citations:
4495 This result was proved in \cite{jones.1967}.
4497Note that in LaTeX environments, like
4499 \begin{tabular}{|l|l|}\hline
4500 Age & Frequency \\ \hline
4503 36--45 & 22 \\ \hline
4506the material between the begin and end tags will be interpreted as raw
4507LaTeX, not as Markdown.
4509For a more explicit and flexible way of including raw TeX in a
4510Markdown document, see the [`raw_attribute`
4511extension][Extension: `raw_attribute`].
4513Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4514Emacs Org mode, and ConTeXt.
4516### Generic raw attribute ###
4518#### Extension: `raw_attribute` ####
4520Inline spans and fenced code blocks with a special
4521kind of attribute will be parsed as raw content with the
4522designated format. For example, the following produces a raw
4529And the following produces a raw `html` inline element:
4531 This is `<a>html</a>`{=html}
4533This can be useful to insert raw xml into `docx` documents, e.g.
4539 <w:br w:type="page"/>
4544The format name should match the target format name (see
4545`-t/--to`, above, for a list, or use `pandoc
4546--list-output-formats`). Use `openxml` for `docx` output,
4547`opendocument` for `odt` output, `html5` for `epub3` output,
4548`html4` for `epub2` output, and `latex`, `beamer`,
4549`ms`, or `html5` for `pdf` output (depending on what you
4550use for `--pdf-engine`).
4552This extension presupposes that the relevant kind of
4553inline code or fenced code block is enabled. Thus, for
4554example, to use a raw attribute with a backtick code block,
4555`backtick_code_blocks` must be enabled.
4557The raw attribute cannot be combined with regular attributes.
4561#### Extension: `latex_macros` ####
4563When this extension is enabled, pandoc will parse LaTeX
4564macro definitions and apply the resulting macros to all LaTeX
4565math and raw LaTeX. So, for example, the following will work in
4566all output formats, not just LaTeX:
4568 \newcommand{\tuple}[1]{\langle #1 \rangle}
4572Note that LaTeX macros will not be applied if they occur
4573inside a raw span or block marked with the
4574[`raw_attribute` extension](#extension-raw_attribute).
4576When `latex_macros` is disabled, the raw LaTeX and math will
4577not have macros applied. This is usually a better approach when
4578you are targeting LaTeX or PDF.
4580Macro definitions in LaTeX will be passed through as raw LaTeX
4581only if `latex_macros` is not enabled. Macro definitions in
4582Markdown source (or other formats allowing `raw_tex`) will
4583be passed through regardless of whether `latex_macros` is
4588Markdown allows links to be specified in several ways.
4590### Automatic links ###
4592If you enclose a URL or email address in pointy brackets, it
4595 <https://google.com>
4596 <sam@green.eggs.ham>
4600An inline link consists of the link text in square brackets,
4601followed by the URL in parentheses. (Optionally, the URL can
4602be followed by a link title, in quotes.)
4604 This is an [inline link](/url), and here's [one with
4605 a title](https://fsf.org "click here for a good time!").
4607There can be no space between the bracketed part and the parenthesized part.
4608The link text can contain formatting (such as emphasis), but the title cannot.
4610Email addresses in inline links are not autodetected, so they have to be
4611prefixed with `mailto`:
4613 [Write me!](mailto:sam@green.eggs.ham)
4615### Reference links ###
4617An *explicit* reference link has two parts, the link itself and the link
4618definition, which may occur elsewhere in the document (either
4619before or after the link).
4621The link consists of link text in square brackets, followed by a label in
4622square brackets. (There cannot be space between the two unless the
4623`spaced_reference_links` extension is enabled.) The link definition
4624consists of the bracketed label, followed by a colon and a space, followed by
4625the URL, and optionally (after a space) a link title either in quotes or in
4626parentheses. The label must not be parseable as a citation (assuming
4627the `citations` extension is enabled): citations take precedence over
4630Here are some examples:
4632 [my label 1]: /foo/bar.html "My title, optional"
4634 [my label 3]: https://fsf.org (The free software foundation)
4635 [my label 4]: /bar#special 'A title in single quotes'
4637The URL may optionally be surrounded by angle brackets:
4639 [my label 5]: <http://foo.bar.baz>
4641The title may go on the next line:
4643 [my label 3]: https://fsf.org
4644 "The free software foundation"
4646Note that link labels are not case sensitive. So, this will work:
4648 Here is [my link][FOO]
4652In an *implicit* reference link, the second pair of brackets is
4657 [my website]: http://foo.bar.baz
4659Note: In `Markdown.pl` and most other Markdown implementations,
4660reference link definitions cannot occur in nested constructions
4661such as list items or block quotes. Pandoc lifts this arbitrary
4662seeming restriction. So the following is fine in pandoc, though
4663not in most other implementations:
4669#### Extension: `shortcut_reference_links` ####
4671In a *shortcut* reference link, the second pair of brackets may
4676 [my website]: http://foo.bar.baz
4678### Internal links ###
4680To link to another section of the same document, use the automatically
4681generated identifier (see [Heading identifiers]). For example:
4683 See the [Introduction](#introduction).
4687 See the [Introduction].
4689 [Introduction]: #introduction
4691Internal links are currently supported for HTML formats (including
4692HTML slide shows and EPUB), LaTeX, and ConTeXt.
4696A link immediately preceded by a `!` will be treated as an image.
4697The link text will be used as the image's alt text:
4699 
4703 [movie reel]: movie.gif
4705#### Extension: `implicit_figures` ####
4707An image with nonempty alt text, occurring by itself in a
4708paragraph, will be rendered as a figure with a caption. The
4709image's alt text will be used as the caption.
4711 
4713How this is rendered depends on the output format. Some output
4714formats (e.g. RTF) do not yet support figures. In those
4715formats, you'll just get an image in a paragraph by itself, with
4718If you just want a regular inline image, just make sure it is not
4719the only thing in the paragraph. One way to do this is to insert a
4720nonbreaking space after the image:
4722 \
4724Note that in reveal.js slide shows, an image in a paragraph
4725by itself that has the `stretch` class will fill the screen,
4726and the caption and figure tags will be omitted.
4728#### Extension: `link_attributes` ####
4730Attributes can be set on links and images:
4732 An inline {#id .class width=30 height=20px}
4733 and a reference ![image][ref] with attributes.
4735 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4737(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4738and `.class` are used.)
4740For HTML and EPUB, all known HTML5 attributes except `width` and
4741`height` (but including `srcset` and `sizes`) are passed through
4742as is. Unknown attributes are passed through as custom
4743attributes, with `data-` prepended. The other writers ignore
4744attributes that are not specifically supported by their output format.
4746The `width` and `height` attributes on images are treated specially. When
4747used without a unit, the unit is assumed to be pixels. However, any of
4748the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4749and `%`. There must not be any spaces between the number and the unit.
4753{ width=50% }
4756- Dimensions may be converted to a form that is compatible with
4757 the output format (for example, dimensions given in pixels will
4758 be converted to inches when converting HTML to LaTeX). Conversion
4759 between pixels and physical measurements is affected by the
4760 `--dpi` option (by default, 96 dpi is assumed, unless the image
4761 itself contains dpi information).
4762- The `%` unit is generally relative to some available space.
4763 For example the above example will render to the following.
4764 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4765 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4766 (If you're using a custom template, you need to configure `graphicx`
4767 as in the default template.)
4768 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4769- Some output formats have a notion of a class
4770 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4771 or a unique identifier (LaTeX `\caption`), or both (HTML).
4772- When no `width` or `height` attributes are specified, the fallback
4773 is to look at the image resolution and the dpi metadata embedded in
4778Using the `native_divs` and `native_spans` extensions
4779(see [above][Extension: `native_divs`]), HTML syntax can
4780be used as part of markdown to create native `Div` and `Span`
4781elements in the pandoc AST (as opposed to raw HTML).
4782However, there is also nicer syntax available:
4784#### Extension: `fenced_divs` ####
4786Allow special fenced syntax for native `Div` blocks. A Div
4787starts with a fence containing at least three consecutive
4788colons plus some attributes. The attributes may optionally
4789be followed by another string of consecutive colons.
4790The attribute syntax is exactly as in fenced code blocks (see
4791[Extension: `fenced_code_attributes`]). As with fenced
4792code blocks, one can use either attributes in curly braces
4793or a single unbraced word, which will be treated as a class
4794name. The Div ends with another line containing a string of at
4795least three consecutive colons. The fenced Div should be
4796separated by blank lines from preceding and following blocks.
4800 ::::: {#special .sidebar}
4801 Here is a paragraph.
4806Fenced divs can be nested. Opening fences are distinguished
4807because they *must* have attributes:
4813 This is a warning within a warning.
4817Fences without attributes are always closing fences. Unlike
4818with fenced code blocks, the number of colons in the closing
4819fence need not match the number in the opening fence. However,
4820it can be helpful for visual clarity to use fences of different
4821lengths to distinguish nested divs from their parents.
4824#### Extension: `bracketed_spans` ####
4826A bracketed sequence of inlines, as one would use to begin
4827a link, will be treated as a `Span` with attributes if it is
4828followed immediately by attributes:
4830 [This is *some text*]{.class key="val"}
4834#### Extension: `footnotes` ####
4836Pandoc's Markdown allows footnotes, using the following syntax:
4838 Here is a footnote reference,[^1] and another.[^longnote]
4840 [^1]: Here is the footnote.
4842 [^longnote]: Here's one with multiple blocks.
4844 Subsequent paragraphs are indented to show that they
4845 belong to the previous footnote.
4849 The whole paragraph can be indented, or just the first
4850 line. In this way, multi-paragraph footnotes work like
4851 multi-paragraph list items.
4853 This paragraph won't be part of the note, because it
4856The identifiers in footnote references may not contain spaces, tabs,
4857or newlines. These identifiers are used only to correlate the
4858footnote reference with the note itself; in the output, footnotes
4859will be numbered sequentially.
4861The footnotes themselves need not be placed at the end of the
4862document. They may appear anywhere except inside other block elements
4863(lists, block quotes, tables, etc.). Each footnote should be
4864separated from surrounding content (including other footnotes)
4867#### Extension: `inline_notes` ####
4869Inline footnotes are also allowed (though, unlike regular notes,
4870they cannot contain multiple paragraphs). The syntax is as follows:
4872 Here is an inline note.^[Inlines notes are easier to write, since
4873 you don't have to pick an identifier and move down to type the
4876Inline and regular footnotes may be mixed freely.
4880#### Extension: `citations` ####
4882Markdown citations go inside square brackets and are separated
4883by semicolons. Each citation must have a key, composed of '@' +
4884the citation identifier from the database, and may optionally
4885have a prefix, a locator, and a suffix. The citation key must
4886begin with a letter, digit, or `_`, and may contain
4887alphanumerics, `_`, and internal punctuation characters
4888(`:.#$%&-+?<>~/`). Here are some examples:
4890 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4892 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4894 Blah blah [@smith04; @doe99].
4896`pandoc` detects locator terms in the [CSL locale files].
4897Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4898locale, locator terms can be written in either singular or plural forms,
4899as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4900`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4901`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4902`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4903`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4904`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4905locator term is used, "page" is assumed.
4907`pandoc` will use heuristics to distinguish the locator
4908from the suffix. In complex cases, the locator can be enclosed
4911 [@smith{ii, A, D-Z}, with a suffix]
4912 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4914A minus sign (`-`) before the `@` will suppress mention of
4915the author in the citation. This can be useful when the
4916author is already mentioned in the text:
4918 Smith says blah [-@smith04].
4920You can also write an in-text citation, as follows:
4924 @smith04 [p. 33] says blah.
4927[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4928[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4929[Chicago Manual of Style]: https://chicagomanualofstyle.org
4930[Citation Style Language]: https://citationstyles.org
4931[Zotero Style Repository]: https://www.zotero.org/styles
4932[finding and editing styles]: https://citationstyles.org/authors/
4933[CSL locale files]: https://github.com/citation-style-language/locales
4935## Non-pandoc extensions
4937The following Markdown syntax extensions are not enabled by default
4938in pandoc, but may be enabled by adding `+EXTENSION` to the format
4939name, where `EXTENSION` is the name of the extension. Thus, for
4940example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4942#### Extension: `attributes` ####
4944Allows attributes to be attached to any inline or block-level
4945element. The syntax for the attributes is the same as that
4946used in [`header_attributes`][Extension: `header_attributes`].
4948- Attributes that occur immediately after an inline
4949 element affect that element. If they follow a space, then they
4950 belong to the space. (Hence, this option subsumes
4951 `inline_code_attributes` and `link_attributes`.)
4952- Attributes that occur immediately before a block
4953 element, on a line by themselves, affect that
4955- Consecutive attribute specifiers may be used,
4956 either for blocks or for inlines. Their attributes
4958- Attributes that occur at the end of the text of
4959 a Setext or ATX heading (separated by whitespace
4960 from the text) affect the heading element. (Hence, this
4961 option subsumes `header_attributes`.)
4962- Attributes that occur after the opening fence
4963 in a fenced code block affect the code block element. (Hence,
4964 this option subsumes `fenced_code_attributes`.)
4965- Attributes that occur at the end of a reference
4966 link definition affect links that refer to that
4969Note that pandoc's AST does not currently allow attributes
4970to be attached to arbitrary elements. Hence a Span or Div
4971container will be added if needed.
4973#### Extension: `old_dashes` ####
4975Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4976`-` before a numeral is an en-dash, and `--` is an em-dash.
4977This option only has an effect if `smart` is enabled. It is
4978selected automatically for `textile` input.
4980#### Extension: `angle_brackets_escapable` ####
4982Allow `<` and `>` to be backslash-escaped, as they can be in
4983GitHub flavored Markdown but not original Markdown. This is
4984implied by pandoc's default `all_symbols_escapable`.
4986#### Extension: `lists_without_preceding_blankline` ####
4988Allow a list to occur right after a paragraph, with no intervening
4991#### Extension: `four_space_rule` ####
4993Selects the pandoc <= 2.0 behavior for parsing lists, so that
4994four spaces indent are needed for list item continuation
4997#### Extension: `spaced_reference_links` ####
4999Allow whitespace between the two components of a reference link,
5004#### Extension: `hard_line_breaks` ####
5006Causes all newlines within a paragraph to be interpreted as hard line
5007breaks instead of spaces.
5009#### Extension: `ignore_line_breaks` ####
5011Causes newlines within a paragraph to be ignored, rather than being
5012treated as spaces or as hard line breaks. This option is intended for
5013use with East Asian languages where spaces are not used between words,
5014but text is divided into lines for readability.
5016#### Extension: `east_asian_line_breaks` ####
5018Causes newlines within a paragraph to be ignored, rather than
5019being treated as spaces or as hard line breaks, when they occur
5020between two East Asian wide characters. This is a better choice
5021than `ignore_line_breaks` for texts that include a mix of East
5022Asian wide characters and other characters.
5024#### Extension: `emoji` ####
5026Parses textual emojis like `:smile:` as Unicode emoticons.
5028#### Extension: `tex_math_single_backslash` ####
5030Causes anything between `\(` and `\)` to be interpreted as inline
5031TeX math, and anything between `\[` and `\]` to be interpreted
5032as display TeX math. Note: a drawback of this extension is that
5033it precludes escaping `(` and `[`.
5035#### Extension: `tex_math_double_backslash` ####
5037Causes anything between `\\(` and `\\)` to be interpreted as inline
5038TeX math, and anything between `\\[` and `\\]` to be interpreted
5041#### Extension: `markdown_attribute` ####
5043By default, pandoc interprets material inside block-level tags as Markdown.
5044This extension changes the behavior so that Markdown is only parsed
5045inside block-level tags if the tags have the attribute `markdown=1`.
5047#### Extension: `mmd_title_block` ####
5049Enables a [MultiMarkdown] style title block at the top of
5050the document, for example:
5054 Date: September 1, 2008
5055 Comment: This is a sample mmd title block, with
5056 a field spanning multiple lines.
5058See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5059`yaml_metadata_block` is enabled, it will take precedence over
5062#### Extension: `abbreviations` ####
5064Parses PHP Markdown Extra abbreviation keys, like
5066 *[HTML]: Hypertext Markup Language
5068Note that the pandoc document model does not support
5069abbreviations, so if this extension is enabled, abbreviation keys are
5070simply skipped (as opposed to being parsed as paragraphs).
5072#### Extension: `autolink_bare_uris` ####
5074Makes all absolute URIs into links, even when not surrounded by
5075pointy braces `<...>`.
5077#### Extension: `mmd_link_attributes` ####
5079Parses multimarkdown style key-value attributes on link
5080and image references. This extension should not be confused with the
5081[`link_attributes`](#extension-link_attributes) extension.
5083 This is a reference ![image][ref] with multimarkdown attributes.
5085 [ref]: https://path.to/image "Image title" width=20px height=30px
5086 id=myId class="myClass1 myClass2"
5088#### Extension: `mmd_header_identifiers` ####
5090Parses multimarkdown style heading identifiers (in square brackets,
5091after the heading but before any trailing `#`s in an ATX heading).
5093#### Extension: `compact_definition_lists` ####
5095Activates the definition list syntax of pandoc 1.12.x and earlier.
5096This syntax differs from the one described above under [Definition lists]
5099 - No blank line is required between consecutive items of the
5101 - To get a "tight" or "compact" list, omit space between consecutive
5102 items; the space between a term and its definition does not affect
5104 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5105 be indented four spaces.[^6]
5107[^6]: To see why laziness is incompatible with relaxing the requirement
5108 of a blank line between items, consider the following example:
5115 Is this a single list item with two definitions of "bar," the first of
5116 which is lazily wrapped, or two list items? To remove the ambiguity
5117 we must either disallow lazy wrapping or require a blank line between
5120#### Extension: `gutenberg` ####
5122Use [Project Gutenberg] conventions for `plain` output:
5123all-caps for strong emphasis, surround by underscores
5124for regular emphasis, add extra blank space around headings.
5126 [Project Gutenberg]: https://www.gutenberg.org
5128#### Extension: `sourcepos` ####
5130Include source position attributes when parsing `commonmark`.
5131For elements that accept attributes, a `data-pos` attribute
5132is added; other elements are placed in a surrounding
5133Div or Span elemnet with a `data-pos` attribute.
5137In addition to pandoc's extended Markdown, the following Markdown
5138variants are supported:
5140- `markdown_phpextra` (PHP Markdown Extra)
5141- `markdown_github` (deprecated GitHub-Flavored Markdown)
5142- `markdown_mmd` (MultiMarkdown)
5143- `markdown_strict` (Markdown.pl)
5144- `commonmark` (CommonMark)
5145- `gfm` (Github-Flavored Markdown)
5146- `commonmark_x` (CommonMark with many pandoc extensions)
5148To see which extensions are supported for a given format,
5149and which are enabled by default, you can use the command
5151 pandoc --list-extensions=FORMAT
5153where `FORMAT` is replaced with the name of the format.
5155Note that the list of extensions for `commonmark`,
5156`gfm`, and `commonmark_x` are defined relative to default
5157commonmark. So, for example, `backtick_code_blocks`
5158does not appear as an extension, since it is enabled by
5159default and cannot be disabled.
5163When the `--citeproc` option is used, pandoc can automatically generate
5164citations and a bibliography in a number of styles. Basic usage is
5166 pandoc --citeproc myinput.txt
5168To use this feature, you will need to have
5170- a document containing citations (see [Extension: `citations`]);
5171- a source of bibliographic data: either an external bibliography
5172 file or a list of `references` in the document's YAML metadata
5173- optionally, a [CSL] citation style.
5175## Specifying bibliographic data
5177You can specify an external bibliography using the
5178`bibliography` metadata field in a YAML metadata section or the
5179`--bibliography` command line argument. If you want to use
5180multiple bibliography files, you can supply multiple
5181`--bibliography` arguments or set `bibliography` metadata field
5182to YAML array. A bibliography may have any of these formats:
5184 Format File extension
5185 ------------ --------------
5191Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5192use the extension `.bibtex` to force interpretation as BibTeX.
5194In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5195inside fields such as `title`; in CSL YAML databases, pandoc
5196Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5205`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5214`<span class="nocase">...</span>`
5215: prevent a phrase from being capitalized as title case
5217As an alternative to specifying a bibliography file using
5218`--bibliography` or the YAML metadata field `bibliography`, you
5219can include the citation data directly in the `references` field
5220of the document's YAML metadata. The field should contain an
5221array of YAML-encoded references, for example:
5225 - type: article-journal
5237 title: 'Molecular structure of nucleic acids: a structure for
5238 deoxyribose nucleic acid'
5239 title-short: Molecular structure of nucleic acids
5240 container-title: Nature
5244 DOI: 10.1038/171737a0
5245 URL: https://www.nature.com/articles/171737a0
5249If both an external bibliography and inline (YAML metadata)
5250references are provided, both will be used. In case of
5251conflicting `id`s, the inline references will take precedence.
5253Note that `pandoc` can be used to produce such a YAML metadata
5254section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5256 pandoc chem.bib -s -f biblatex -t markdown
5257 pandoc chem.json -s -f csljson -t markdown
5259`pandoc` can also be used to produce CSL JSON bibliography
5260from BibTeX, BibLaTeX, or markdown YAML:
5262 pandoc chem.bib -s -f biblatex -t csljson
5263 pandoc chem.yaml -s -f markdown -t csljson
5265Running pandoc on a bibliography file with the `--citeproc`
5266option will create a formatted bibliography in the format
5269 pandoc chem.bib -s --citeproc -o chem.html
5270 pandoc chem.bib -s --citeproc -o chem.pdf
5272### Capitalization in titles
5274If you are using a bibtex or biblatex bibliography, then observe
5277 - English titles should be in title case. Non-English titles should
5278 be in sentence case, and the `langid` field in biblatex should be
5279 set to the relevant language. (The following values are treated
5280 as English: `american`, `british`, `canadian`, `english`,
5281 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5283 - As is standard with bibtex/biblatex, proper names should be
5284 protected with curly braces so that they won't be lowercased
5285 in styles that call for sentence case. For example:
5287 title = {My Dinner with {Andre}}
5289 - In addition, words that should remain lowercase (or camelCase)
5290 should be protected:
5292 title = {Spin Wave Dispersion on the {nm} Scale}
5294 Though this is not necessary in bibtex/biblatex, it is necessary
5295 with citeproc, which stores titles internally in sentence case,
5296 and converts to title case in styles that require it. Here we
5297 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5299If you are using a CSL bibliography (either JSON or YAML), then observe
5302 - All titles should be in sentence case.
5304 - Use the `language` field for non-English titles to prevent their
5305 conversion to title case in styles that call for this. (Conversion
5306 happens only if `language` begins with `en` or is left empty.)
5308 - Protect words that should not be converted to title case using
5311 Spin wave dispersion on the <span class="nocase">nm</span> scale
5313### Conference Papers, Published vs. Unpublished
5315For a formally published conference paper, use the biblatex entry type
5316`inproceedings` (which will be mapped to CSL `paper-conference`).
5318For an unpublished manuscript, use the biblatex entry type
5319`unpublished` without an `eventtitle` field (this entry type
5320will be mapped to CSL `manuscript`).
5322For a talk, an unpublished conference paper, or a poster
5323presentation, use the biblatex entry type `unpublished` with an
5324`eventtitle` field (this entry type will be mapped to CSL
5325`speech`). Use the biblatex `type` field to indicate the type,
5326e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5327too, though `eventdate` will not be rendered by most CSL styles.
5328Note that `venue` is for the event's venue, unlike `location`
5329which describes the publisher's location; do not use the latter
5330for an unpublished conference paper.
5333## Specifying a citation style
5335Citations and references can be formatted using any style supported by the
5336[Citation Style Language], listed in the [Zotero Style Repository].
5337These files are specified using the `--csl` option or the `csl`
5338(or `citation-style`) metadata field. By default, pandoc will
5339use the [Chicago Manual of Style] author-date format. (You can
5340override this default by copying a CSL style of your choice
5341to `default.csl` in your user data directory.)
5342The CSL project provides further information on [finding and
5345The `--citation-abbreviations` option (or the
5346`citation-abbreviations` metadata field) may be used to specify
5347a JSON file containing abbreviations of journals that should be
5348used in formatted bibliographies when `form="short"` is
5349specified. The format of the file can be illustrated with an
5354 "container-title": {
5355 "Lloyd's Law Reports": "Lloyd's Rep",
5356 "Estates Gazette": "EG",
5357 "Scots Law Times": "SLT"
5362## Raw content in a style
5364To include raw content in a prefix, suffix, delimiter, or term,
5365surround it with these tags indicating the format:
5367 {{jats}}<ref>{{/jats}}
5369Without the tags, the string will be interpreted as a string
5370and escaped in the output, rather than being passed through raw.
5372This feature allows stylesheets to be customized to give
5373different output for different output formats. However,
5374stylesheets customized in this way will not be usable
5375by other CSL implementations.
5379## Placement of the bibliography
5381If the style calls for a list of works cited, it will be placed
5382in a div with id `refs`, if one exists:
5387Otherwise, it will be placed at the end of the document.
5388Generation of the bibliography can be suppressed by setting
5389`suppress-bibliography: true` in the YAML metadata.
5391If you wish the bibliography to have a section heading, you can
5392set `reference-section-title` in the metadata, or put the heading
5393at the beginning of the div with id `refs` (if you are using it)
5394or at the end of your document:
5400The bibliography will be inserted after this heading. Note that
5401the `unnumbered` class will be added to this heading, so that the
5402section will not be numbered.
5404## Including uncited items in the bibliography
5406If you want to include items in the bibliography without actually
5407citing them in the body text, you can define a dummy `nocite` metadata
5408field and put the citations there:
5417In this example, the document will contain a citation for `item3`
5418only, but the bibliography will contain entries for `item1`, `item2`, and
5421It is possible to create a bibliography with all the citations,
5422whether or not they appear in the document, by using a wildcard:
5429For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5430render the bibliography. In order to do so, specify bibliography
5431files as outlined above, and add `--natbib` or `--biblatex`
5432argument to `pandoc` invocation. Bear in mind that bibliography
5433files have to be in either BibTeX (for `--natbib`)
5434or BibLaTeX (for `--biblatex`) format.
5436## Other relevant metadata fields
5438A few other metadata fields affect bibliography formatting:
5441: If true, citations will be
5442 hyperlinked to the corresponding bibliography entries
5443 (for author-date and numerical styles only).
5446: The `lang` field will affect how the style is localized,
5447 for example in the translation of labels and the use
5448 of quotation marks. (For backwards compatibility,
5449 `locale` may be used instead of `lang`, but this use
5452`notes-after-punctuation`
5453: If true (the default), pandoc will put footnote citations
5454 after following punctuation. For example, if the source
5455 contains `blah blah [@jones99].`, the result will look like
5456 `blah blah.[^1]`, with the note moved after the period and
5457 the space collapsed. If false, the space will still be
5458 collapsed, but the footnote will not be moved after the
5470You can use pandoc to produce an HTML + JavaScript slide presentation
5471that can be viewed via a web browser. There are five ways to do this,
5472using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5473You can also produce a PDF slide show using LaTeX [`beamer`], or
5474slides shows in Microsoft [PowerPoint] format.
5476Here's the Markdown source for a simple slide show, `habits.txt`:
5503 
5510To produce an HTML/JavaScript slide show, simply type
5512 pandoc -t FORMAT -s habits.txt -o habits.html
5514where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5516For Slidy, Slideous, reveal.js, and S5, the file produced by
5517pandoc with the `-s/--standalone` option embeds a link to
5518JavaScript and CSS files, which are assumed to be available at
5519the relative path `s5/default` (for S5), `slideous` (for
5520Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5521at `w3.org` (for Slidy). (These paths can be changed by setting
5522the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5523variables; see [Variables for HTML slides], above.) For
5524DZSlides, the (relatively short) JavaScript and CSS are included
5525in the file by default.
5527With all HTML slide formats, the `--self-contained` option can
5528be used to produce a single file that contains all of the data
5529necessary to display the slide show, including linked scripts,
5530stylesheets, images, and videos.
5532To produce a PDF slide show using beamer, type
5534 pandoc -t beamer habits.txt -o habits.pdf
5536Note that a reveal.js slide show can also be converted to a PDF
5537by printing it to a file from the browser.
5539To produce a Powerpoint slide show, type
5541 pandoc habits.txt -o habits.pptx
5543## Structuring the slide show
5545By default, the *slide level* is the highest heading level in
5546the hierarchy that is followed immediately by content, and not another
5547heading, somewhere in the document. In the example above, level-1 headings
5548are always followed by level-2 headings, which are followed by content,
5549so the slide level is 2. This default can be overridden using
5550the `--slide-level` option.
5552The document is carved up into slides according to the following
5555 * A horizontal rule always starts a new slide.
5557 * A heading at the slide level always starts a new slide.
5559 * Headings *below* the slide level in the hierarchy create
5560 headings *within* a slide.
5562 * Headings *above* the slide level in the hierarchy create
5563 "title slides," which just contain the section title
5564 and help to break the slide show into sections.
5565 Non-slide content under these headings will be included
5566 on the title slide (for HTML slide shows) or in a
5567 subsequent slide with the same title (for beamer).
5569 * A title page is constructed automatically from the document's title
5570 block, if present. (In the case of beamer, this can be disabled
5571 by commenting out some lines in the default template.)
5573These rules are designed to support many different styles of slide show. If
5574you don't care about structuring your slides into sections and subsections,
5575you can just use level-1 headings for all each slide. (In that case, level-1
5576will be the slide level.) But you can also structure the slide show into
5577sections, as in the example above.
5579Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5580layout will be produced, with level-1 headings building horizontally
5581and level-2 headings building vertically. It is not recommended that
5582you use deeper nesting of section levels with reveal.js.
5586By default, these writers produce lists that display "all at once."
5587If you want your lists to display incrementally (one item at a time),
5588use the `-i` option. If you want a particular list to depart from the
5589default, put it in a `div` block with class `incremental` or
5590`nonincremental`. So, for example, using the `fenced div` syntax, the
5591following would be incremental regardless of the document default:
5609While using `incremental` and `nonincremental` divs are the
5610recommended method of setting incremental lists on a per-case basis,
5611an older method is also supported: putting lists inside a blockquote
5612will depart from the document default (that is, it will display
5613incrementally without the `-i` option and all at once with the `-i`
5619Both methods allow incremental and nonincremental lists to be mixed
5620in a single document.
5622Note: Neither the `-i/--incremental` option nor any of the
5623methods described here currently works for PowerPoint output.
5627You can add "pauses" within a slide by including a paragraph containing
5628three dots, separated by spaces:
5630 # Slide with a pause
5632 content before the pause
5636 content after the pause
5638Note: this feature is not yet implemented for PowerPoint output.
5640## Styling the slides
5642You can change the style of HTML slides by putting customized CSS files
5643in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5644or `$DATADIR/slideous` (for Slideous),
5645where `$DATADIR` is the user data directory (see `--data-dir`, above).
5646The originals may be found in pandoc's system data directory (generally
5647`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5648files it does not find in the user data directory.
5650For dzslides, the CSS is included in the HTML file itself, and may
5653All [reveal.js configuration options] can be set through variables.
5654For example, themes can be used by setting the `theme` variable:
5658Or you can specify a custom stylesheet using the `--css` option.
5660To style beamer slides, you can specify a `theme`, `colortheme`,
5661`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5663 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5665Note that heading attributes will turn into slide attributes
5666(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5667to style individual slides. In beamer, the only heading attribute
5668that affects slides is the `allowframebreaks` class, which sets the
5669`allowframebreaks` option, causing multiple slides to be created
5670if the content overfills the frame. This is recommended especially for
5673 # References {.allowframebreaks}
5677Speaker notes are supported in reveal.js and PowerPoint (pptx)
5678output. You can add notes to your Markdown document thus:
5684 - It can contain Markdown
5689To show the notes window in reveal.js, press `s` while viewing the
5690presentation. Speaker notes in PowerPoint will be available, as usual,
5691in handouts and presenter view.
5693Notes are not yet supported for other slide formats, but the notes
5694will not appear on the slides themselves.
5698To put material in side by side columns, you can use a native
5699div container with class `columns`, containing two or more div
5700containers with class `column` and a `width` attribute:
5702 :::::::::::::: {.columns}
5703 ::: {.column width="40%"}
5706 ::: {.column width="60%"}
5711### Additional columns attributes in beamer
5713The div containers with classes `columns` and `column` can optionally have
5714an `align` attribute.
5715The class `columns` can optionally have a `totalwidth` attribute or an
5716`onlytextwidth` class.
5718 :::::::::::::: {.columns align=center totalwidth=8em}
5719 ::: {.column width="40%"}
5722 ::: {.column width="60%" align=bottom}
5727The `align` attributes on `columns` and `column` can be used with the
5728values `top`, `top-baseline`, `center` and `bottom` to vertically align
5729the columns. It defaults to `top` in `columns`.
5731The `totalwidth` attribute limits the width of the columns to the given value.
5733 :::::::::::::: {.columns align=top .onlytextwidth}
5734 ::: {.column width="40%" align=center}
5737 ::: {.column width="60%"}
5742The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5744See Section 12.7 of the [Beamer User's Guide] for more details.
5746## Frame attributes in beamer
5748Sometimes it is necessary to add the LaTeX `[fragile]` option to
5749a frame in beamer (for example, when using the `minted` environment).
5750This can be forced by adding the `fragile` class to the heading
5751introducing the slide:
5753 # Fragile slide {.fragile}
5755All of the other frame attributes described in Section 8.1 of
5756the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5757`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5758`shrink`, `standout`, `noframenumbering`.
5760## Background in reveal.js and beamer
5762Background images can be added to self-contained reveal.js slideshows and
5763to beamer slideshows.
5765For the same image on every slide, use the configuration
5766option `background-image` either in the YAML metadata block
5767or as a command-line variable. (There are no other options in
5768beamer and the rest of this section concerns reveal.js slideshows.)
5770For reveal.js, you can instead use the reveal.js-native option
5771`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5772and `parallaxBackgroundVertical` the same way and must also set
5773`parallaxBackgroundSize` to have your values take effect.
5775To set an image for a particular reveal.js slide, add
5776`{data-background-image="/path/to/image"}`
5777to the first slide-level heading on the slide (which may even be empty).
5779In reveal.js's overview mode, the parallaxBackgroundImage will show up
5780only on the first slide.
5782Other reveal.js background settings also work on individual slides, including
5783`data-background-size`, `data-background-repeat`, `data-background-color`,
5784`data-transition`, and `data-transition-speed`.
5786To add a background image to the automatically generated title slide, use the
5787`title-slide-attributes` variable in the YAML metadata block. It must contain
5788a map of attribute names and values.
5790See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5793For example in reveal.js:
5798parallaxBackgroundImage: /path/to/my/background_image.png
5799title-slide-attributes:
5800 data-background-image: /path/to/title_image.png
5801 data-background-size: contain
5806Slide 1 has background_image.png as its background.
5808## {data-background-image="/path/to/special_image.jpg"}
5810Slide 2 has a special image for its background, even though the heading has no content.
5817EPUB metadata may be specified using the `--epub-metadata` option, but
5818if the source document is Markdown, it is better to use a [YAML metadata
5819block][Extension: `yaml_metadata_block`]. Here is an example:
5826 text: An investigation of metadata
5834 text: doi:10.234234.234/33
5836 rights: © 2007 John Smith, CC BY-NC
5841The following fields are recognized:
5844 ~ Either a string value or an object with fields `text` and
5845 `scheme`. Valid values for `scheme` are `ISBN-10`,
5846 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5847 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5848 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5851 ~ Either a string value, or an object with fields `file-as` and
5852 `type`, or a list of such objects. Valid values for `type` are
5853 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5856 ~ Either a string value, or an object with fields `role`, `file-as`,
5857 and `text`, or a list of such objects. Valid values for `role` are
5858 [MARC relators], but
5859 pandoc will attempt to translate the human-readable versions
5860 (like "author" and "editor") to the appropriate marc relators.
5863 ~ Same format as `creator`.
5866 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5867 Pandoc will attempt to convert other common date formats.
5869`lang` (or legacy: `language`)
5870 ~ A string value in [BCP 47] format. Pandoc will default to the local
5871 language if nothing is specified.
5874 ~ A string value or a list of such values.
5895 ~ A string value (path to cover image).
5897`css` (or legacy: `stylesheet`)
5898 ~ A string value (path to CSS stylesheet).
5900`page-progression-direction`
5901 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5902 attribute for the [`spine` element].
5905 ~ iBooks-specific metadata, with the following fields:
5907 - `version`: (string)
5908 - `specified-fonts`: `true`|`false` (default `false`)
5909 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5910 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5911 - `binding`: `true`|`false` (default `true`)
5912 - `scroll-axis`: `vertical`|`horizontal`|`default`
5914[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5915[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5917## The `epub:type` attribute
5919For `epub3` output, you can mark up the heading that corresponds to an EPUB
5920chapter using the [`epub:type` attribute][epub-type]. For example, to set
5921the attribute to the value `prologue`, use this markdown:
5923 # My chapter {epub:type=prologue}
5925Which will result in:
5927 <body epub:type="frontmatter">
5928 <section epub:type="prologue">
5931Pandoc will output `<body epub:type="bodymatter">`, unless
5932you use one of the following values, in which case either
5933`frontmatter` or `backmatter` will be output.
5935`epub:type` of first section `epub:type` of body
5936---------------------------- ------------------
5939acknowledgments frontmatter
5940copyright-page frontmatter
5941dedication frontmatter
5945contributors frontmatter
5946other-credits frontmatter
5948revision-history frontmatter
5949titlepage frontmatter
5950halftitlepage frontmatter
5951seriespage frontmatter
5956bibliography backmatter
5959[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5963By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5964`<video>` or `<source>` element present in the generated EPUB,
5965and include it in the EPUB container, yielding a completely
5966self-contained EPUB. If you want to link to external media resources
5967instead, use raw HTML in your source and add `data-external="1"` to the tag
5968with the `src` attribute. For example:
5970 <audio controls="1">
5971 <source src="https://example.com/music/toccata.mp3"
5972 data-external="1" type="audio/mpeg">
5978When creating a [Jupyter notebook], pandoc will try to infer the
5979notebook structure. Code blocks with the class `code` will be
5980taken as code cells, and intervening content will be taken as
5981Markdown cells. Attachments will automatically be created for
5982images in Markdown cells. Metadata will be taken from the
5983`jupyter` metadata field. For example:
5992 display_name: Python 2
5999 file_extension: ".py"
6000 mimetype: "text/x-python"
6002 nbconvert_exporter: "python"
6003 pygments_lexer: "ipython2"
6009**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6010bibendum felis dictum sodales.
6019from IPython.display import HTML
6022console.log("hello");
6030This image  will be
6031included as a cell attachment.
6034If you want to add cell attributes, group cells differently, or
6035add output to code cells, then you need to include divs to
6036indicate the structure. You can use either [fenced
6037divs][Extension: `fenced_divs`] or [native divs][Extension:
6038`native_divs`] for this. Here is an example:
6041:::::: {.cell .markdown}
6044**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6045bibendum felis dictum sodales.
6048:::::: {.cell .code execution_count=1}
6053::: {.output .stream .stdout}
6060:::::: {.cell .code execution_count=2}
6062from IPython.display import HTML
6065console.log("hello");
6071::: {.output .execute_result execution_count=2}
6074console.log("hello");
6083If you include raw HTML or TeX in an output cell, use the
6084[raw attribute][Extension: `fenced_attribute`], as shown
6085in the last cell of the example above. Although pandoc can
6086process "bare" raw HTML and TeX, the result is often
6087interspersed raw elements and normal textual elements, and
6088in an output cell pandoc expects a single, connected raw
6089block. To avoid using raw HTML or TeX except when
6090marked explicitly using raw attributes, we recommend
6091specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6092translating between Markdown and ipynb notebooks.
6094Note that options and extensions that affect reading and
6095writing of Markdown will also affect Markdown cells in ipynb
6096notebooks. For example, `--wrap=preserve` will preserve
6097soft line breaks in Markdown cells; `--atx-headers` will
6098cause ATX-style headings to be used; and `--preserve-tabs` will
6099prevent tabs from being turned to spaces.
6101# Syntax highlighting
6103Pandoc will automatically highlight syntax in [fenced code blocks] that
6104are marked with a language name. The Haskell library [skylighting] is
6105used for highlighting. Currently highlighting is supported only for
6106HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6107that pandoc will recognize, type `pandoc --list-highlight-languages`.
6109The color scheme can be selected using the `--highlight-style` option.
6110The default color scheme is `pygments`, which imitates the default color
6111scheme used by the Python library pygments (though pygments is not actually
6112used to do the highlighting). To see a list of highlight styles,
6113type `pandoc --list-highlight-styles`.
6115If you are not satisfied with the predefined styles, you can
6116use `--print-highlight-style` to generate a JSON `.theme` file which
6117can be modified and used as the argument to `--highlight-style`. To
6118get a JSON version of the `pygments` style, for example:
6120 pandoc --print-highlight-style pygments > my.theme
6122Then edit `my.theme` and use it like this:
6124 pandoc --highlight-style my.theme
6126If you are not satisfied with the built-in highlighting, or you
6127want highlight a language that isn't supported, you can use the
6128`--syntax-definition` option to load a [KDE-style XML syntax definition
6129file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6130Before writing your own, have a look at KDE's [repository of syntax
6131definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6133To disable highlighting, use the `--no-highlight` option.
6135[skylighting]: https://github.com/jgm/skylighting
6139Custom styles can be used in the docx and ICML formats.
6143By default, pandoc's docx and ICML output applies a predefined set of styles
6144for blocks such as paragraphs and block quotes, and uses largely default
6145formatting (italics, bold) for inlines. This will work for most
6146purposes, especially alongside a `reference.docx` file. However, if you
6147need to apply your own styles to blocks, or match a preexisting set of
6148styles, pandoc allows you to define custom styles for blocks and text
6149using `div`s and `span`s, respectively.
6151If you define a `div` or `span` with the attribute `custom-style`,
6152pandoc will apply your specified style to the contained elements (with
6153the exception of elements whose function depends on a style, like
6154headings, code blocks, block quotes, or links). So, for example, using
6155the `bracketed_spans` syntax,
6157 [Get out]{custom-style="Emphatically"}, he said.
6159would produce a docx file with "Get out" styled with character
6160style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6162 Dickinson starts the poem simply:
6164 ::: {custom-style="Poetry"}
6165 | A Bird came down the Walk---
6166 | He did not know I saw---
6169would style the two contained lines with the `Poetry` paragraph style.
6171For docx output, styles will be defined in the output file as inheriting
6172from normal text, if the styles are not yet in your reference.docx.
6173If they are already defined, pandoc will not alter the definition.
6175This feature allows for greatest customization in conjunction with
6176[pandoc filters]. If you want all paragraphs after block quotes to be
6177indented, you can write a filter to apply the styles necessary. If you
6178want all italics to be transformed to the `Emphasis` character style
6179(perhaps to change their color), you can write a filter which will
6180transform all italicized inlines to inlines within an `Emphasis`
6183For docx output, you don't need to enable any extensions for
6184custom styles to work.
6186[pandoc filters]: https://pandoc.org/filters.html
6190The docx reader, by default, only reads those styles that it can
6191convert into pandoc elements, either by direct conversion or
6192interpreting the derivation of the input document's styles.
6194By enabling the [`styles` extension](#ext-styles) in the docx reader
6195(`-f docx+styles`), you can produce output that maintains the styles
6196of the input document, using the `custom-style` class. Paragraph
6197styles are interpreted as divs, while character styles are interpreted
6200For example, using the `custom-style-reference.docx` file in the test
6201directory, we have the following different outputs:
6203Without the `+styles` extension:
6205 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6208 This is text with an *emphasized* text style. And this is text with a
6209 **strengthened** text style.
6211 > Here is a styled paragraph that inherits from Block Text.
6213And with the extension:
6215 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6217 ::: {custom-style="First Paragraph"}
6221 ::: {custom-style="Body Text"}
6222 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6223 And this is text with a [strengthened]{custom-style="Strengthened"}
6227 ::: {custom-style="My Block Style"}
6228 > Here is a styled paragraph that inherits from Block Text.
6231With these custom styles, you can use your input document as a
6232reference-doc while creating docx output (see below), and maintain the
6233same styles in your input and output files.
6237Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6238includes a Lua interpreter, so Lua need not be installed separately.)
6240To use a custom writer, simply specify the path to the Lua script
6241in place of the output format. For example:
6243 pandoc -t data/sample.lua
6245Creating a custom writer requires writing a Lua function for each
6246possible element in a pandoc document. To get a documented example
6247which you can modify according to your needs, do
6249 pandoc --print-default-data-file sample.lua
6251Note that custom writers have no default template. If you want
6252to use `--standalone` with a custom writer, you will need to
6253specify a template manually using `--template` or add a new
6254default template with the name
6255`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6256subdirectory of your user data directory (see [Templates]).
6258[Lua]: https://www.lua.org
6262If you use pandoc to convert user-contributed content in a web
6263application, here are some things to keep in mind:
62651. Although pandoc itself will not create or modify any files other
6266 than those you explicitly ask it create (with the exception
6267 of temporary files used in producing PDFs), a filter or custom
6268 writer could in principle do anything on your file system. Please
6269 audit filters and custom writers very carefully before using them.
62712. If your application uses pandoc as a Haskell library (rather than
6272 shelling out to the executable), it is possible to use it in a mode
6273 that fully isolates pandoc from your file system, by running the
6274 pandoc operations in the `PandocPure` monad. See the document
6275 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
62783. Pandoc's parsers can exhibit pathological performance on some
6279 corner cases. It is wise to put any pandoc operations under
6280 a timeout, to avoid DOS attacks that exploit these issues.
6281 If you are using the pandoc executable, you can add the
6282 command line options `+RTS -M512M -RTS` (for example) to limit
6283 the heap size to 512MB.
62854. The HTML generated by pandoc is not guaranteed to be safe.
6286 If `raw_html` is enabled for the Markdown input, users can
6287 inject arbitrary HTML. Even if `raw_html` is disabled,
6288 users can include dangerous content in attributes for
6289 headings, spans, and code blocks. To be safe, you should
6290 run all the generated HTML through an HTML sanitizer.
6294Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6295under the [GPL], version 2 or greater. This software carries no
6296warranty of any kind. (See COPYRIGHT for full copyright and
6297warranty notices.) For a full list of contributors, see the file
6298AUTHORS.md in the pandoc source code.
6300[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6301[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list