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 `--resource-path` only has an effect if (a) the output
903 format embeds images (for example, `docx`, `pdf`, or `html`
904 with `--self-contained`) or (b) it is used together with
907`--request-header=`*NAME*`:`*VAL*
909: Set the request header *NAME* to the value *VAL* when making
910 HTTP requests (for example, when a URL is given on the
911 command line, or when resources used in a document must be
912 downloaded). If you're behind a proxy, you also need to set
913 the environment variable `http_proxy` to `http://...`.
915`--no-check-certificate`
917: Disable the certificate verification to allow access to
918 unsecure HTTP resources (for example when the certificate
919 is no longer valid or self signed).
921## Options affecting specific writers {.options}
925: Produce a standalone HTML file with no external dependencies, using
926 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
927 images, and videos. Implies `--standalone`. The resulting file should be
928 "self-contained," in the sense that it needs no external files and no net
929 access to be displayed properly by a browser. This option works only with
930 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
931 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
932 and stylesheets at absolute URLs will be downloaded; those at relative
933 URLs will be sought relative to the working directory (if the first source
934 file is local) or relative to the base URL (if the first source
935 file is remote). Elements with the attribute
936 `data-external="1"` will be left alone; the documents they
937 link to will not be incorporated in the document.
938 Limitation: resources that are loaded dynamically through
939 JavaScript cannot be incorporated; as a result,
940 `--self-contained` does not work with `--mathjax`, and some
941 advanced features (e.g. zoom or speaker notes) may not work
942 in an offline "self-contained" `reveal.js` slide show.
946: Use `<q>` tags for quotes in HTML. (This option only has an
947 effect if the `smart` extension is enabled for the input
952: Use only ASCII characters in output. Currently supported for XML
953 and HTML formats (which use entities instead of UTF-8 when this
954 option is selected), CommonMark, gfm, and Markdown (which use
955 entities), roff ms (which use hexadecimal escapes), and to a
956 limited degree LaTeX (which uses standard commands for accented
957 characters when possible). roff man output uses ASCII by default.
961: Use reference-style links, rather than inline links, in writing Markdown
962 or reStructuredText. By default inline links are used. The
963 placement of link references is affected by the
964 `--reference-location` option.
966`--reference-location=block`|`section`|`document`
968: Specify whether footnotes (and references, if `reference-links` is
969 set) are placed at the end of the current (top-level) block, the
970 current section, or the document. The default is
971 `document`. Currently only affects the markdown writer.
973`--markdown-headings=setext`|`atx`
975: Specify whether to use ATX-style (`#`-prefixed) or
976 Setext-style (underlined) headings for level 1 and 2
977 headings in Markdown output. (The default is `atx`.)
978 ATX-style headings are always used for levels 3+.
979 This option also affects Markdown cells in `ipynb` output.
983: *Deprecated synonym for `--markdown-headings=atx`.*
985`--top-level-division=default`|`section`|`chapter`|`part`
987: Treat top-level headings as the given division type in
988 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
989 order is part, chapter, then section; all headings are
990 shifted such that the top-level heading becomes the
991 specified type. The default behavior is to determine the
992 best division type via heuristics: unless other conditions
993 apply, `section` is chosen. When the `documentclass`
994 variable is set to `report`, `book`, or `memoir` (unless the
995 `article` option is specified), `chapter` is implied as the
996 setting for this option. If `beamer` is the output format,
997 specifying either `chapter` or `part` will cause top-level
998 headings to become `\part{..}`, while second-level headings
999 remain as their default type.
1001`-N`, `--number-sections`
1003: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
1004 By default, sections are not numbered. Sections with class
1005 `unnumbered` will never be numbered, even if `--number-sections`
1008`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
1010: Offset for section headings in HTML output (ignored in other
1011 output formats). The first number is added to the section number for
1012 top-level headings, the second for second-level headings, and so on.
1013 So, for example, if you want the first top-level heading in your
1014 document to be numbered "6", specify `--number-offset=5`.
1015 If your document starts with a level-2 heading which you want to
1016 be numbered "1.5", specify `--number-offset=1,4`.
1017 Offsets are 0 by default. Implies `--number-sections`.
1021: Use the [`listings`] package for LaTeX code blocks. The package
1022 does not support multi-byte encoding for source code. To handle UTF-8
1023 you would need to use a custom template. This issue is fully
1024 documented here: [Encoding issue with the listings package].
1026`-i`, `--incremental`
1028: Make list items in slide shows display incrementally (one by one).
1029 The default is for lists to be displayed all at once.
1031`--slide-level=`*NUMBER*
1033: Specifies that headings with the specified level create
1034 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1035 above this level in the hierarchy are used to divide the
1036 slide show into sections; headings below this level create
1037 subheads within a slide. Note that content that is
1038 not contained under slide-level headings will not appear in
1039 the slide show. The default is to set the slide level based
1040 on the contents of the document; see [Structuring the slide
1045: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1046 and attach identifiers to the enclosing `<section>` (or `<div>`)
1047 rather than the heading itself. See
1048 [Heading identifiers], below.
1050`--email-obfuscation=none`|`javascript`|`references`
1052: Specify a method for obfuscating `mailto:` links in HTML documents.
1053 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1054 them using JavaScript. `references` obfuscates them by printing their
1055 letters as decimal or hexadecimal character references. The default
1058`--id-prefix=`*STRING*
1060: Specify a prefix to be added to all identifiers and internal links
1061 in HTML and DocBook output, and to footnote numbers in Markdown
1062 and Haddock output. This is useful for preventing duplicate
1063 identifiers when generating fragments to be included in other pages.
1065`-T` *STRING*, `--title-prefix=`*STRING*
1067: Specify *STRING* as a prefix at the beginning of the title
1068 that appears in the HTML header (but not in the title as it
1069 appears at the beginning of the HTML body). Implies `--standalone`.
1071`-c` *URL*, `--css=`*URL*
1073: Link to a CSS style sheet. This option can be used repeatedly to
1074 include multiple files. They will be included in the order specified.
1076 A stylesheet is required for generating EPUB. If none is
1077 provided using this option (or the `css` or `stylesheet`
1078 metadata fields), pandoc will look for a file `epub.css` in the
1079 user data directory (see `--data-dir`). If it is not
1080 found there, sensible defaults will be used.
1082`--reference-doc=`*FILE*
1084: Use the specified file as a style reference in producing a
1089 : For best results, the reference docx should be a modified
1090 version of a docx file produced using pandoc. The contents
1091 of the reference docx are ignored, but its stylesheets and
1092 document properties (including margins, page size, header,
1093 and footer) are used in the new docx. If no reference docx
1094 is specified on the command line, pandoc will look for a
1095 file `reference.docx` in the user data directory (see
1096 `--data-dir`). If this is not found either, sensible
1097 defaults will be used.
1099 To produce a custom `reference.docx`, first get a copy of
1100 the default `reference.docx`: `pandoc
1101 -o custom-reference.docx --print-default-data-file reference.docx`.
1102 Then open `custom-reference.docx` in Word, modify the
1103 styles as you wish, and save the file. For best
1104 results, do not make changes to this file other than
1105 modifying the styles used by pandoc:
1141 - Default Paragraph Font
1144 - Footnote Reference
1154 : For best results, the reference ODT should be a modified
1155 version of an ODT produced using pandoc. The contents of
1156 the reference ODT are ignored, but its stylesheets are used
1157 in the new ODT. If no reference ODT is specified on the
1158 command line, pandoc will look for a file `reference.odt` in
1159 the user data directory (see `--data-dir`). If this is not
1160 found either, sensible defaults will be used.
1162 To produce a custom `reference.odt`, first get a copy of
1163 the default `reference.odt`: `pandoc
1164 -o custom-reference.odt --print-default-data-file reference.odt`.
1165 Then open `custom-reference.odt` in LibreOffice, modify
1166 the styles as you wish, and save the file.
1170 : Templates included with Microsoft PowerPoint 2013 (either with
1171 `.pptx` or `.potx` extension) are known to work, as are most
1172 templates derived from these.
1174 The specific requirement is that the template should begin with
1175 the following first four layouts:
1178 2. Title and Content
1182 All templates included with a recent version of MS PowerPoint
1183 will fit these criteria. (You can click on `Layout` under the
1184 `Home` menu to check.)
1186 You can also modify the default `reference.pptx`: first run
1187 `pandoc -o custom-reference.pptx --print-default-data-file
1188 reference.pptx`, and then modify `custom-reference.pptx`
1189 in MS PowerPoint (pandoc will use the first four layout
1190 slides, as mentioned above).
1192`--epub-cover-image=`*FILE*
1194: Use the specified image as the EPUB cover. It is recommended
1195 that the image be less than 1000px in width and height. Note that
1196 in a Markdown source document you can also specify `cover-image`
1197 in a YAML metadata block (see [EPUB Metadata], below).
1199`--epub-metadata=`*FILE*
1201: Look in the specified XML file for metadata for the EPUB.
1202 The file should contain a series of [Dublin Core elements].
1205 <dc:rights>Creative Commons</dc:rights>
1206 <dc:language>es-AR</dc:language>
1208 By default, pandoc will include the following metadata elements:
1209 `<dc:title>` (from the document title), `<dc:creator>` (from the
1210 document authors), `<dc:date>` (from the document date, which should
1211 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1212 variable, or, if is not set, the locale), and `<dc:identifier
1213 id="BookId">` (a randomly generated UUID). Any of these may be
1214 overridden by elements in the metadata file.
1216 Note: if the source document is Markdown, a YAML metadata block
1217 in the document can be used instead. See below under
1220`--epub-embed-font=`*FILE*
1222: Embed the specified font in the EPUB. This option can be repeated
1223 to embed multiple fonts. Wildcards can also be used: for example,
1224 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1225 line, be sure to escape them or put the whole filename in single quotes,
1226 to prevent them from being interpreted by the shell. To use the
1227 embedded fonts, you will need to add declarations like the following
1228 to your CSS (see `--css`):
1231 font-family: DejaVuSans;
1233 font-weight: normal;
1234 src:url("DejaVuSans-Regular.ttf");
1237 font-family: DejaVuSans;
1240 src:url("DejaVuSans-Bold.ttf");
1243 font-family: DejaVuSans;
1245 font-weight: normal;
1246 src:url("DejaVuSans-Oblique.ttf");
1249 font-family: DejaVuSans;
1252 src:url("DejaVuSans-BoldOblique.ttf");
1254 body { font-family: "DejaVuSans"; }
1256`--epub-chapter-level=`*NUMBER*
1258: Specify the heading level at which to split the EPUB into separate
1259 "chapter" files. The default is to split into chapters at level-1
1260 headings. This option only affects the internal composition of the
1261 EPUB, not the way chapters and sections are displayed to users. Some
1262 readers may be slow if the chapter files are too large, so for large
1263 documents with few level-1 headings, one might want to use a chapter
1266`--epub-subdirectory=`*DIRNAME*
1268: Specify the subdirectory in the OCF container that is to hold
1269 the EPUB-specific contents. The default is `EPUB`. To put
1270 the EPUB contents in the top level, use an empty string.
1272`--ipynb-output=all|none|best`
1274: Determines how ipynb output cells are treated. `all` means
1275 that all of the data formats included in the original are
1276 preserved. `none` means that the contents of data cells
1277 are omitted. `best` causes pandoc to try to pick the
1278 richest data block in each output cell that is compatible
1279 with the output format. The default is `best`.
1281`--pdf-engine=`*PROGRAM*
1283: Use the specified engine when producing PDF output.
1284 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1285 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1286 and `pdfroff`. If the engine is not in your PATH, the full
1287 path of the engine may be specified here. If this option
1288 is not specified, pandoc uses the following defaults
1289 depending on the output format specified using `-t/--to`:
1291 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1292 `tectonic`, `latexmk`)
1293 - `-t context`: `context`
1294 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1295 see [print-css.rocks](https://print-css.rocks) for a good
1296 introduction to PDF generation from HTML/CSS.)
1297 - `-t ms`: `pdfroff`
1299`--pdf-engine-opt=`*STRING*
1301: Use the given string as a command-line argument to the `pdf-engine`.
1302 For example, to use a persistent directory `foo` for `latexmk`'s
1303 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1304 Note that no check for duplicate options is done.
1306[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1307[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1308[Encoding issue with the listings package]:
1309 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1311## Citation rendering {.options}
1315: Process the citations in the file, replacing them with
1316 rendered citations and adding a bibliography.
1317 Citation processing will not take place unless bibliographic
1318 data is supplied, either through an external file specified
1319 using the `--bibliography` option or the `bibliography`
1320 field in metadata, or via a `references` section in metadata
1321 containing a list of citations in CSL YAML format with
1322 Markdown formatting. The style is controlled by a [CSL]
1323 stylesheet specified using the `--csl` option or the `csl`
1324 field in metadata. (If no stylesheet is specified,
1325 the `chicago-author-date` style will be used by default.)
1326 The citation processing transformation may be applied before
1327 or after filters or Lua filters (see `--filter`,
1328 `--lua-filter`): these transformations are applied in the
1329 order they appear on the command line. For more
1330 information, see the section on [Citations].
1332`--bibliography=`*FILE*
1334: Set the `bibliography` field in the document's metadata to *FILE*,
1335 overriding any value set in the metadata. If you supply
1336 this argument multiple times, each *FILE* will be added to
1341: Set the `csl` field in the document's metadata to *FILE*,
1342 overriding any value set in the metadata. (This is equivalent to
1343 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1344 fetched via HTTP. If *FILE* is not found relative to the
1345 working directory, it will be sought in the resource path
1346 and finally in the `csl` subdirectory of the
1347 pandoc user data directory.
1349`--citation-abbreviations=`*FILE*
1351: Set the `citation-abbreviations` field in the document's metadata to
1352 *FILE*, overriding any value set in the metadata. (This is equivalent to
1353 `--metadata citation-abbreviations=FILE`.)
1354 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1355 found relative to the working directory, it will be sought
1356 in the resource path and finally in the `csl` subdirectory
1357 of the pandoc user data directory.
1361: Use [`natbib`] for citations in LaTeX output. This option
1362 is not for use with the `--citeproc` option or with PDF
1363 output. It is intended for use in producing a LaTeX file
1364 that can be processed with [`bibtex`].
1368: Use [`biblatex`] for citations in LaTeX output. This option
1369 is not for use with the `--citeproc` option or with PDF
1370 output. It is intended for use in producing a LaTeX file
1371 that can be processed with [`bibtex`] or [`biber`].
1373## Math rendering in HTML {.options}
1375The default is to render TeX math as far as possible using
1376Unicode characters. Formulas are put inside a `span` with
1377`class="math"`, so that they may be styled differently from the
1378surrounding text if needed. However, this gives acceptable
1379results only for basic math, usually you will want to use
1380`--mathjax` or another of the following options.
1382`--mathjax`[`=`*URL*]
1384: Use [MathJax] to display embedded TeX math in HTML output.
1385 TeX math will be put between `\(...\)` (for inline math)
1386 or `\[...\]` (for display math) and wrapped in `<span>` tags
1387 with class `math`. Then the MathJax JavaScript will render it.
1388 The *URL* should point to the `MathJax.js` load script.
1389 If a *URL* is not provided, a link to the Cloudflare CDN will
1394: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1395 `docbook5`, `jats`, `html4` and `html5`). This is the
1396 default in `odt` output. Note that currently only Firefox
1397 and Safari (and select e-book readers) natively support
1402: Convert TeX formulas to `<img>` tags that link to an external script
1403 that converts formulas to images. The formula will be URL-encoded
1404 and concatenated with the URL provided. For SVG images you can for
1405 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1406 If no URL is specified, the CodeCogs URL generating PNGs
1407 will be used (`https://latex.codecogs.com/png.latex?`).
1408 Note: the `--webtex` option will affect Markdown output
1409 as well as HTML, which is useful if you're targeting a
1410 version of Markdown without native math support.
1414: Use [KaTeX] to display embedded TeX math in HTML output.
1415 The *URL* is the base URL for the KaTeX library. That directory
1416 should contain a `katex.min.js` and a `katex.min.css` file.
1417 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1421: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1422 can then be processed by [GladTeX] to produce images of the typeset
1423 formulas and an HTML file with links to these images.
1424 So, the procedure is:
1426 pandoc -s --gladtex input.md -o myfile.htex
1427 gladtex -d myfile-images myfile.htex
1428 # produces myfile.html and images in myfile-images
1430[MathML]: https://www.w3.org/Math/
1431[MathJax]: https://www.mathjax.org
1432[KaTeX]: https://github.com/Khan/KaTeX
1433[GladTeX]: https://humenda.github.io/GladTeX/
1435## Options for wrapper scripts {.options}
1439: Print information about command-line arguments to *stdout*, then exit.
1440 This option is intended primarily for use in wrapper scripts.
1441 The first line of output contains the name of the output file specified
1442 with the `-o` option, or `-` (for *stdout*) if no output file was
1443 specified. The remaining lines contain the command-line arguments,
1444 one per line, in the order they appear. These do not include regular
1445 pandoc options and their arguments, but do include any options appearing
1446 after a `--` separator at the end of the line.
1450: Ignore command-line arguments (for use in wrapper scripts).
1451 Regular pandoc options are not ignored. Thus, for example,
1453 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1457 pandoc -o foo.html -s
1461If pandoc completes successfully, it will return exit code 0.
1462Nonzero exit codes have the following meanings:
1465----- ------------------------------------
1466 3 PandocFailOnWarningError
1468 5 PandocTemplateError
1470 21 PandocUnknownReaderError
1471 22 PandocUnknownWriterError
1472 23 PandocUnsupportedExtensionError
1473 24 PandocCiteprocError
1474 31 PandocEpubSubdirectoryError
1476 47 PandocPDFProgramNotFoundError
1478 62 PandocShouldNeverHappenError
1481 65 PandocParsecError
1482 66 PandocMakePDFError
1483 67 PandocSyntaxMapError
1484 83 PandocFilterError
1486 92 PandocUTF8DecodingError
1487 93 PandocIpynbDecodingError
1488 97 PandocCouldNotFindDataFileError
1489 99 PandocResourceNotFound
1490----- ------------------------------------
1494The `--defaults` option may be used to specify a package
1495of options. Here is a sample defaults file demonstrating all of
1496the fields that may be used:
1500# reader: may be used instead of from:
1502# writer: may be used instead of to:
1504# leave blank for output to stdout:
1506# leave blank for input from stdin, use [] for no input:
1510# or you may use input-file: with a single value
1514self-contained: false
1516# note that structured variables may be specified:
1523# metadata values specified here are parsed as literal
1524# string text, not markdown:
1531# or you may use metadata-file: with a single value
1533# Note that these take files, not their contents:
1534include-before-body: []
1535include-after-body: []
1536include-in-header: []
1539# turn on built-in citation processing. Note that if you need
1540# control over when the citeproc processing is done relative
1541# to other filters, you should instead use `citeproc` in the
1542# list of `filters` (see below).
1548citation-abbreviations: abbrevs.json
1550# Filters will be assumed to be Lua filters if they have
1551# the .lua extension, and json filters otherwise. But
1552# the filter type can also be specified explicitly, as shown.
1553# Filters are run in the order specified.
1554# To include the built-in citeproc filter, use either `citeproc`
1555# or `{type: citeproc}`.
1565# ERROR, WARNING, or INFO
1569# citeproc, natbib, or biblatex
1570cite-method: citeproc
1571# part, chapter, section, or default:
1572top-level-division: chapter
1578# you may also use pdf-engine-opt: with a single option
1579# pdf-engine-opt: "-shell-escape"
1581# auto, preserve, or none
1586extract-media: mediadir
1588table-of-contents: true
1590number-sections: false
1591# a list of offsets at each heading level
1592number-offset: [0,0,0,0,0,0]
1593# toc: may also be used instead of table-of-contents:
1594shift-heading-level-by: 1
1596identifier-prefix: foo
1598strip-empty-paragraphs: true
1599# lf, crlf, or native
1601strip-comments: false
1602indented-code-classes: []
1604default-image-extension: ".jpg"
1606# either a style name of a style definition file:
1607highlight-style: pygments
1610# or you may use syntax-definition: with a single value
1613reference-doc: myref.docx
1615# method is plain, webtex, gladtex, mathml, mathjax, katex
1616# you may specify a url with webtex, mathjax, katex
1619 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1620# none, references, or javascript
1621email-obfuscation: javascript
1629epub-subdirectory: EPUB
1630epub-metadata: meta.xml
1633epub-chapter-level: 1
1634epub-cover-image: cover.jpg
1636reference-links: true
1637# block, section, or document
1638reference-location: block
1639markdown-headings: setext
1641# accept, reject, or all
1642track-changes: accept
1651# A list of two-element lists
1653- ["User-Agent", "Mozilla/5.0"]
1655fail-if-warnings: false
1661Fields that are omitted will just have their regular
1662default values. So a defaults file can be as simple as
1669Default files can be placed in the `defaults` subdirectory of
1670the user data directory and used from any directory. For
1671example, one could create a file specifying defaults for writing
1672letters, save it as `letter.yaml` in the `defaults` subdirectory
1673of the user data directory, and then invoke these defaults
1674from any directory using `pandoc --defaults letter`
1675or `pandoc -dletter`.
1677When multiple defaults are used, their contents will be combined.
1679Note that, where command-line arguments may be repeated
1680(`--metadata-file`, `--css`, `--include-in-header`,
1681`--include-before-body`, `--include-after-body`, `--variable`,
1682`--metadata`, `--syntax-definition`), the values specified on
1683the command line will combine with values specified in the
1684defaults file, rather than replacing them.
1688When the `-s/--standalone` option is used, pandoc uses a template to
1689add header and footer material that is needed for a self-standing
1690document. To see the default template that is used, just type
1694where *FORMAT* is the name of the output format. A custom template
1695can be specified using the `--template` option. You can also override
1696the system default templates for a given output format *FORMAT*
1697by putting a file `templates/default.*FORMAT*` in the user data
1698directory (see `--data-dir`, above). *Exceptions:*
1700- For `odt` output, customize the `default.opendocument`
1702- For `pdf` output, customize the `default.latex` template
1703 (or the `default.context` template, if you use `-t context`,
1704 or the `default.ms` template, if you use `-t ms`, or the
1705 `default.html` template, if you use `-t html`).
1706- `docx` and `pptx` have no template (however, you can use
1707 `--reference-doc` to customize the output).
1709Templates contain *variables*, which allow for the inclusion of
1710arbitrary information at any point in the file. They may be set at the
1711command line using the `-V/--variable` option. If a variable is not set,
1712pandoc will look for the key in the document's metadata, which can be set
1713using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1714or with the `-M/--metadata` option. In addition, some variables
1715are given default values by pandoc. See [Variables] below for
1716a list of variables used in pandoc's default templates.
1718If you use custom templates, you may need to revise them as pandoc
1719changes. We recommend tracking the changes in the default templates,
1720and modifying your custom templates accordingly. An easy way to do this
1721is to fork the [pandoc-templates] repository and merge in
1722changes after each pandoc release.
1724 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1730Anything between the sequence `$--` and the end of the
1731line will be treated as a comment and omitted from the output.
1735To mark variables and control structures in the template,
1736either `$`...`$` or `${`...`}` may be used as delimiters.
1737The styles may also be mixed in the same template, but the
1738opening and closing delimiter must match in each case. The
1739opening delimiter may be followed by one or more spaces
1740or tabs, which will be ignored. The closing delimiter may
1741be followed by one or more spaces or tabs, which will be
1744To include a literal `$` in the document, use `$$`.
1746### Interpolated variables
1748A slot for an interpolated variable is a variable name surrounded
1749by matched delimiters. Variable names must begin with a letter
1750and can contain letters, numbers, `_`, `-`, and `.`. The
1751keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1752not be used as variable names. Examples:
1765Variable names with periods are used to get at structured
1766variable values. So, for example, `employee.salary` will return the
1767value of the `salary` field of the object that is the value of
1768the `employee` field.
1770- If the value of the variable is simple value, it will be
1771 rendered verbatim. (Note that no escaping is done;
1772 the assumption is that the calling program will escape
1773 the strings appropriately for the output format.)
1774- If the value is a list, the values will be concatenated.
1775- If the value is a map, the string `true` will be rendered.
1776- Every other value will be rendered as the empty string.
1780A conditional begins with `if(variable)` (enclosed in
1781matched delimiters) and ends with `endif` (enclosed in matched
1782delimiters). It may optionally contain an `else` (enclosed in
1783matched delimiters). The `if` section is used if
1784`variable` has a non-empty value, otherwise the `else`
1785section is used (if present). Examples:
1800${if(foo)}bar${endif}
1813The keyword `elseif` may be used to simplify complex nested
1828A for loop begins with `for(variable)` (enclosed in
1829matched delimiters) and ends with `endfor` (enclosed in matched
1832- If `variable` is an array, the material inside the loop will
1833 be evaluated repeatedly, with `variable` being set to each
1834 value of the array in turn, and concatenated.
1835- If `variable` is a map, the material inside will be set to
1837- If the value of the associated variable is not an array or
1838 a map, a single iteration will be performed on its value.
1843$for(foo)$$foo$$sep$, $endfor$
1846 - $foo.last$, $foo.first$
1850 - ${ foo.bar.last }, ${ foo.bar.first }
1854$it.name$: $it.office$
1858You may optionally specify a separator between consecutive
1859values using `sep` (enclosed in matched delimiters). The
1860material between `sep` and the `endfor` is the separator.
1863${ for(foo) }${ foo }${ sep }, ${ endfor }
1866Instead of using `variable` inside the loop, the special
1867anaphoric keyword `it` may be used.
1871 - ${ it.last }, ${ it.first }
1877Partials (subtemplates stored in different files) may be
1878included by using the name of the partial, followed
1879by `()`, for example:
1885Partials will be sought in the directory containing
1886the main template. The file name will be assumed to
1887have the same extension as the main template if it
1888lacks an extension. When calling the partial, the
1889full name including file extension can also be used:
1895(If a partial is not found in the directory of the
1896template, it will also be sought in the `templates`
1897subdirectory of the user data directory.)
1899Partials may optionally be applied to variables using
1905${ articles:bibentry() }
1908If `articles` is an array, this will iterate over its
1909values, applying the partial `bibentry()` to each one. So the
1910second example above is equivalent to
1918Note that the anaphoric keyword `it` must be used when
1919iterating over partials. In the above examples,
1920the `bibentry` partial should contain `it.title`
1921(and so on) instead of `articles.title`.
1923Final newlines are omitted from included partials.
1925Partials may include other partials.
1927A separator between values of an array may be specified
1928in square brackets, immediately after the variable name
1934${articles:bibentry()[; ]$
1937The separator in this case is literal and (unlike with `sep`
1938in an explicit `for` loop) cannot contain interpolated
1939variables or other template directives.
1943To ensure that content is "nested," that is, subsequent lines
1944indented, use the `^` directive:
1947$item.number$ $^$$item.description$ ($item.price$)
1950In this example, if `item.description` has multiple lines,
1951they will all be indented to line up with the first line:
195400123 A fine bottle of 18-year old
1955 Oban whiskey. ($148)
1958To nest multiple lines to the same level, align them
1959with the `^` directive in the template. For example:
1962$item.number$ $^$$item.description$ ($item.price$)
1963 (Available til $item.sellby$.)
196900123 A fine bottle of 18-year old
1970 Oban whiskey. ($148)
1971 (Available til March 30, 2020.)
1974If a variable occurs by itself on a line, preceded by whitespace
1975and not followed by further text or directives on the same line,
1976and the variable's value contains multiple lines, it will be
1977nested automatically.
1981Normally, spaces in the template itself (as opposed to values of
1982the interpolated variables) are not breakable, but they can be
1983made breakable in part of the template by using the `~` keyword
1984(ended with another `~`).
1987$~$This long line may break if the document is rendered
1988with a short line length.$~$
1993A pipe transforms the value of a variable or partial. Pipes are
1994specified using a slash (`/`) between the variable name (or partial)
1995and the pipe name. Example:
2002$for(metadata/pairs)$
2003- $it.key$: $it.value$
2006$employee:name()/uppercase$
2009Pipes may be chained:
2012$for(employees/pairs)$
2013$it.key/alpha/uppercase$. $it.name$
2017Some pipes take parameters:
2020|----------------------|------------|
2022$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2024|----------------------|------------|
2027Currently the following pipes are predefined:
2029- `pairs`: Converts a map or array to an array of maps,
2030 each with `key` and `value` fields. If the original
2031 value was an array, the `key` will be the array index,
2034- `uppercase`: Converts text to uppercase.
2036- `lowercase`: Converts text to lowercase.
2038- `length`: Returns the length of the value: number
2039 of characters for a textual value, number of elements
2042- `reverse`: Reverses a textual value or array,
2043 and has no effect on other values.
2045- `first`: Returns the first value of an array, if
2046 applied to a non-empty array; otherwise returns
2049- `last`: Returns the last value of an array, if
2050 applied to a non-empty array; otherwise returns
2053- `rest`: Returns all but the first value of an array, if
2054 applied to a non-empty array; otherwise returns
2057- `allbutlast`: Returns all but the last value of an array, if
2058 applied to a non-empty array; otherwise returns
2061- `chomp`: Removes trailing newlines (and breakable space).
2063- `nowrap`: Disables line wrapping on breakable spaces.
2065- `alpha`: Converts textual values that can be
2066 read as an integer into lowercase alphabetic
2067 characters `a..z` (mod 26). This can be used to get lettered
2068 enumeration from array indices. To get uppercase
2069 letters, chain with `uppercase`.
2071- `roman`: Converts textual values that can be
2072 read as an integer into lowercase roman numerials.
2073 This can be used to get lettered enumeration from array indices.
2074 To get uppercase roman, chain with `uppercase`.
2076- `left n "leftborder" "rightborder"`: Renders a textual value
2077 in a block of width `n`, aligned to the left, with an optional
2078 left and right border. Has no effect on other values. This
2079 can be used to align material in tables. Widths are positive
2080 integers indicating the number of characters. Borders
2081 are strings inside double quotes; literal `"` and `\` characters
2082 must be backslash-escaped.
2084- `right n "leftborder" "rightborder"`: Renders a textual value
2085 in a block of width `n`, aligned to the right, and has no
2086 effect on other values.
2088- `center n "leftborder" "rightborder"`: Renders a textual
2089 value in a block of width `n`, aligned to the center, and has
2090 no effect on other values.
2095### Metadata variables
2097`title`, `author`, `date`
2098: allow identification of basic aspects of the document. Included
2099 in PDF metadata through LaTeX and ConTeXt. These can be set
2100 through a [pandoc title block][Extension: `pandoc_title_block`],
2101 which allows for multiple authors, or through a
2102 [YAML metadata block][Extension: `yaml_metadata_block`]:
2110 Note that if you just want to set PDF or HTML metadata, without
2111 including a title block in the document itself, you can
2112 set the `title-meta`, `author-meta`, and `date-meta`
2113 variables. (By default these are set automatically, based
2114 on `title`, `author`, and `date`.) The page title in HTML
2115 is set by `pagetitle`, which is equal to `title` by default.
2118: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2122: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2126: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2127 and AsciiDoc metadata; repeat as for `author`, above
2130: document subject, included in ODT, PDF, docx and pptx metadata
2133: document description, included in ODT, docx and pptx metadata. Some
2134 applications show this as `Comments` metadata.
2137: document category, included in docx and pptx metadata
2140any root-level string metadata, not included in ODT, docx
2141or pptx metadata is added as a *custom property*.
2142The following [YAML] metadata block for instance:
2145 title: 'This is the title'
2146 subtitle: "This is the subtitle"
2154 It consists of two paragraphs
2157will include `title`, `author` and `description` as standard document
2158properties and `subtitle` as a custom property when converting to docx,
2161### Language variables
2164: identifies the main language of the document using IETF language
2165 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2166 The [Language subtag lookup] tool can look up or verify these tags.
2167 This affects most formats, and controls hyphenation in PDF output
2168 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2170 Use native pandoc [Divs and Spans] with the `lang` attribute to
2171 switch the language:
2177 Text in the main document language (British English).
2180 > Cette citation est écrite en français canadien.
2183 More text in English. ['Zitat auf Deutsch.']{lang=de}
2186: the base script direction, either `rtl` (right-to-left)
2187 or `ltr` (left-to-right).
2189 For bidirectional documents, native pandoc `span`s and
2190 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2191 be used to override the base direction in some output
2192 formats. This may not always be necessary if the final
2193 renderer (e.g. the browser, when generating HTML) supports
2194 the [Unicode Bidirectional Algorithm].
2196 When using LaTeX for bidirectional documents, only the
2197 `xelatex` engine is fully supported (use
2198 `--pdf-engine=xelatex`).
2200[BCP 47]: https://tools.ietf.org/html/bcp47
2201[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2202[Language subtag lookup]: https://r12a.github.io/app-subtags/
2204### Variables for HTML
2207: Enables inclusion of most of the [CSS] in the `styles.html`
2208 [partial](#partials) (have a look with
2209 `pandoc --print-default-data-file=templates/styles.html`).
2210 Unless you use [`--css`](#option--css), this variable
2211 is set to `true` by default. You can disable it with
2212 e.g. `pandoc -M document-css=false`.
2215: sets the CSS `font-family` property on the `html` element.
2218: sets the base CSS `font-size`, which you'd usually set
2219 to e.g. `20px`, but it also accepts `pt`
2220 (12pt = 16px in most browsers).
2223: sets the CSS `color` property on the `html` element.
2226: sets the CSS `color` property on all links.
2229: sets the CSS `font-family` property on `code` elements.
2231`monobackgroundcolor`
2232: sets the CSS `background-color` property on `code` elements
2233 and adds extra padding.
2236: sets the CSS `line-height` property on the `html` element,
2237 which is preferred to be unitless.
2240: sets the CSS `background-color` property on the `html` element.
2242`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2243: sets the corresponding CSS `padding` properties on the `body` element.
2245To override or extend some [CSS] for just one document, include for example:
2254 background-color: #f0f0f0;
2257 padding: 0.5em 2em 0.5em 0.5em;
2260 border-bottom: none;
2265[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2267### Variables for HTML math
2270: when using [KaTeX](#option--katex), you can render display
2271math equations flush left using [YAML metadata](#layout) or with
2272`-M classoption=fleqn`.
2274### Variables for HTML slides
2276These affect HTML output when [producing slide shows with pandoc].
2278All [reveal.js configuration options] are available as variables.
2279To turn off boolean flags that default to true in reveal.js, use `0`.
2282: base URL for reveal.js documents (defaults to
2283 `https://unpkg.com/reveal.js@^4/`)
2286: base URL for S5 documents (defaults to `s5/default`)
2289: base URL for Slidy documents (defaults to
2290 `https://www.w3.org/Talks/Tools/Slidy2`)
2293: base URL for Slideous documents (defaults to `slideous`)
2295`title-slide-attributes`
2296: additional attributes for the title slide of reveal.js slide shows.
2297 See [background in reveal.js and beamer] for an example.
2299[reveal.js configuration options]: https://revealjs.com/config/
2301### Variables for Beamer slides
2303These variables change the appearance of PDF slides using [`beamer`].
2306: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2307 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2311: produce an article from Beamer slides
2314: add extra beamer option with `\setbeameroption{}`
2317: author affiliations: can be a list when there are multiple authors
2320: logo image for slides
2323: controls navigation symbols (default is `empty` for no navigation
2324 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2327: enables "title pages" for new sections (default is true)
2329`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2333: options for LaTeX beamer themes (a list).
2336: image for title slide
2338### Variables for PowerPoint
2340These variables control the visual aspects of a slide show that
2341are not easily controlled via templates.
2344: font to use for code.
2346### Variables for LaTeX
2348Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2353: make `\paragraph` and `\subparagraph` (fourth- and
2354 fifth-level headings, or fifth- and sixth-level with book
2355 classes) free-standing rather than run-in; requires further
2356 formatting to distinguish from `\subsubsection` (third- or
2357 fourth-level headings). Instead of using this option,
2358 [KOMA-Script] can adjust headings more extensively:
2361 documentclass: scrartcl
2363 \RedeclareSectionCommand[
2364 beforeskip=-10pt plus -2pt minus -1pt,
2365 afterskip=1sp plus -1sp minus 1sp,
2366 font=\normalfont\itshape]{paragraph}
2367 \RedeclareSectionCommand[
2368 beforeskip=-10pt plus -2pt minus -1pt,
2369 afterskip=1sp plus -1sp minus 1sp,
2370 font=\normalfont\scshape,
2371 indent=0pt]{subparagraph}
2375: option for document class, e.g. `oneside`; repeat for multiple options:
2384: document class: usually one of the standard classes,
2385 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2386 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2387 default to smaller margins; or [`memoir`]
2390: option for [`geometry`] package, e.g. `margin=1in`;
2391 repeat for multiple options:
2401: option for [`hyperref`] package, e.g. `linktoc=all`;
2402 repeat for multiple options:
2408 - pdfpagemode=FullScreen
2412: if true, pandoc will use document class settings for
2413 indentation (the default LaTeX template otherwise removes
2414 indentation and adds space between paragraphs)
2417: adjusts line spacing using the [`setspace`]
2418 package, e.g. `1.25`, `1.5`
2420`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2421: sets margins if `geometry` is not used (otherwise `geometry`
2425: control `\pagestyle{}`: the default article class
2426 supports `plain` (default), `empty` (no running heads or page numbers),
2427 and `headings` (section titles in running heads)
2430: paper size, e.g. `letter`, `a4`
2433: numbering depth for sections (with `--number-sections` option
2434 or `numbersections` variable)
2439: allows font encoding to be specified through `fontenc` package (with
2440 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2443: font package for use with `pdflatex`:
2444 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2445 The default is [Latin Modern][`lm`].
2448: options for package used as `fontfamily`; repeat for multiple options.
2449 For example, to use the Libertine font with proportional lowercase
2450 (old-style) figures through the [`libertinus`] package:
2453 fontfamily: libertinus
2460: font size for body text. The standard classes allow 10pt, 11pt, and
2461 12pt. To use another size, set `documentclass` to one of
2462 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2464`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2465: font families for use with `xelatex` or
2466 `lualatex`: take the name of any system font, using the
2467 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2469`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2470: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2471 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2472 choices available through [`fontspec`]; repeat for multiple
2473 options. For example, to use the [TeX Gyre] version of
2474 Palatino with lowercase figures:
2477 mainfont: TeX Gyre Pagella
2480 - Numbers=Proportional
2484: options to pass to the microtype package
2489: add color to link text; automatically enabled if any of
2490 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2492`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2493: color for internal links, external links, citation links, linked
2494 URLs, and links in table of contents, respectively: uses options
2495 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2499: causes links to be printed as footnotes
2504: include list of figures, list of tables
2507: contents of acknowledgments footnote after document title
2510: include table of contents (can also be set using
2511 `--toc/--table-of-contents`)
2514: level of section to include in table of contents
2516#### BibLaTeX Bibliographies
2518These variables function when using BibLaTeX for [citation rendering].
2521: list of options for biblatex
2524: bibliography style, when used with `--natbib` and `--biblatex`.
2527: bibliography title, when used with `--natbib` and `--biblatex`.
2530: bibliography to use for resolving references
2533: list of options for natbib
2535[KOMA-Script]: https://ctan.org/pkg/koma-script
2536[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2537[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2538[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2539[`article`]: https://ctan.org/pkg/article
2540[`book`]: https://ctan.org/pkg/book
2541[`libertinus`]: https://ctan.org/pkg/libertinus
2542[`memoir`]: https://ctan.org/pkg/memoir
2543[`report`]: https://ctan.org/pkg/report
2545### Variables for ConTeXt
2547Pandoc uses these variables when [creating a PDF] with ConTeXt.
2550: font size for body text (e.g. `10pt`, `12pt`)
2552`headertext`, `footertext`
2553: text to be placed in running header or footer (see [ConTeXt Headers and
2554 Footers]); repeat up to four times for different placement
2557: controls indentation of paragraphs, e.g. `yes,small,next` (see
2558 [ConTeXt Indentation]); repeat for multiple options
2561: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2562 repeat for multiple options
2565: options for page margins and text arrangement (see [ConTeXt Layout]);
2566 repeat for multiple options
2568`linkcolor`, `contrastcolor`
2569: color for links outside and inside a page, e.g. `red`, `blue` (see
2573: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2574 `type`, `cap`, `small`
2577: include list of figures, list of tables
2579`mainfont`, `sansfont`, `monofont`, `mathfont`
2580: font families: take the name of any system font (see
2581 [ConTeXt Font Switching])
2583`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2584: sets margins, if `layout` is not used (otherwise `layout`
2588: page number style and location (using [`setuppagenumbering`]);
2589 repeat for multiple options
2592: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2593 repeat for multiple options
2596: adds to the preamble the setup necessary to generate PDF/A
2597 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2598 specified (i.e. the value is set to True, by e.g.
2599 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2600 `1b:2005` will be used as default, for reasons of backwards
2601 compatibility. Using `--variable=pdfa` without specified value
2602 is not supported. To successfully generate PDF/A the required
2603 ICC color profiles have to be available and the content and all
2604 included files (such as images) have to be standard conforming.
2605 The ICC profiles and output intent may be specified using the
2606 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2607 PDFA] for more details.
2610: when used in conjunction with `pdfa`, specifies the ICC profile to use
2611 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2612 used as default. May be repeated to include multiple profiles. Note that
2613 the profiles have to be available on the system. They can be obtained
2614 from [ConTeXt ICC Profiles].
2617: when used in conjunction with `pdfa`, specifies the output intent for
2618 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2619 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2622: include table of contents (can also be set using
2623 `--toc/--table-of-contents`)
2626: spacing between paragraphs, e.g. `none`, `small` (using
2627 [`setupwhitespace`])
2630: include all source documents as file attachments in the PDF file
2632[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2633[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2634[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2635[ConTeXt Color]: https://wiki.contextgarden.net/Color
2636[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2637[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2638[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2639[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2640[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2641[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2642[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2644### Variables for `wkhtmltopdf`
2646Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2647The `--css` option also affects the output.
2649`footer-html`, `header-html`
2650: add information to the header and footer
2652`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2653: set the page margins
2656: sets the PDF paper size
2658### Variables for man pages
2661: adjusts text to left (`l`), right (`r`), center (`c`),
2662 or both (`b`) margins
2665: footer in man pages
2668: header in man pages
2671: if `true` (the default), hyphenation will be used
2674: section number in man pages
2679: font family (e.g. `T` or `P`)
2682: paragraph indent (e.g. `2m`)
2685: line height (e.g. `12p`)
2688: point size (e.g. `10p`)
2690### Variables set automatically
2692Pandoc sets these variables automatically in response to [options] or
2693document contents; users can also modify them. These vary depending
2694on the output format, and include the following:
2700: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2701 included in all HTML based formats (dzslides, epub,
2702 html, html4, html5, revealjs, s5, slideous, slidy).
2703 The recognized formats for `date` are: `mm/dd/yyyy`,
2704 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2705 (e.g. either `02 Apr 2018` or `02 April 2018`),
2706 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2707 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2710: contents specified by `-H/--include-in-header` (may have multiple
2714: contents specified by `-B/--include-before-body` (may have
2718: contents specified by `-A/--include-after-body` (may have
2722: JSON representation of all of the document's metadata. Field
2723 values are transformed to the selected output format.
2726: non-null value if `-N/--number-sections` was specified
2728`sourcefile`, `outputfile`
2729: source and destination filenames, as given on the command line.
2730 `sourcefile` can also be a list if input comes from multiple files,
2731 or empty if input is from stdin. You can use the following snippet in
2732 your template to distinguish them:
2742 Similarly, `outputfile` can be `-` if output goes to the terminal.
2744 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2747: working directory from which pandoc is run.
2750: non-null value if `--toc/--table-of-contents` was specified
2753: title of table of contents (works only with EPUB,
2754 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2756[pandoc-templates]: https://github.com/jgm/pandoc-templates
2760The behavior of some of the readers and writers can be adjusted by
2761enabling or disabling various extensions.
2763An extension can be enabled by adding `+EXTENSION`
2764to the format name and disabled by adding `-EXTENSION`. For example,
2765`--from markdown_strict+footnotes` is strict Markdown with footnotes
2766enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2767Markdown without footnotes or pipe tables.
2769The markdown reader and writer make by far the most use of extensions.
2770Extensions only used by them are therefore covered in the
2771section [Pandoc's Markdown] below (See [Markdown variants] for
2772`commonmark` and `gfm`.) In the following, extensions that also work
2773for other formats are covered.
2775Note that markdown extensions added to the `ipynb` format
2776affect Markdown cells in Jupyter notebooks (as do command-line
2777options like `--atx-headers`).
2781#### Extension: `smart` ####
2783Interpret straight quotes as curly quotes, `---` as em-dashes,
2784`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2785inserted after certain abbreviations, such as "Mr."
2787This extension can be enabled/disabled for the following formats:
2790: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2793: `markdown`, `latex`, `context`, `rst`
2795enabled by default in
2796: `markdown`, `latex`, `context` (both input and output)
2798Note: If you are *writing* Markdown, then the `smart` extension
2799has the reverse effect: what would have been curly quotes comes
2802In LaTeX, `smart` means to use the standard TeX ligatures
2803for quotation marks (` `` ` and ` '' ` for double quotes,
2804`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2805en-dash and `---` for em-dash). If `smart` is disabled,
2806then in reading LaTeX pandoc will parse these characters
2807literally. In writing LaTeX, enabling `smart` tells pandoc
2808to use the ligatures when possible; if `smart` is disabled
2809pandoc will use unicode quotation mark and dash characters.
2811## Headings and sections
2813#### Extension: `auto_identifiers` ####
2815A heading without an explicitly specified identifier will be
2816automatically assigned a unique identifier based on the heading text.
2818This extension can be enabled/disabled for the following formats:
2821: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2826enabled by default in
2829The default algorithm used to derive the identifier from the
2832 - Remove all formatting, links, etc.
2833 - Remove all footnotes.
2834 - Remove all non-alphanumeric characters,
2835 except underscores, hyphens, and periods.
2836 - Replace all spaces and newlines with hyphens.
2837 - Convert all alphabetic characters to lowercase.
2838 - Remove everything up to the first letter (identifiers may
2839 not begin with a number or punctuation mark).
2840 - If nothing is left after this, use the identifier `section`.
2845 ------------------------------- ----------------------------
2846 `Heading identifiers in HTML` `heading-identifiers-in-html`
2847 `Maître d'hôtel` `maître-dhôtel`
2848 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2849 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2850 `3. Applications` `applications`
2853These rules should, in most cases, allow one to determine the identifier
2854from the heading text. The exception is when several headings have the
2855same text; in this case, the first will get an identifier as described
2856above; the second will get the same identifier with `-1` appended; the
2857third with `-2`; and so on.
2859(However, a different algorithm is used if
2860`gfm_auto_identifiers` is enabled; see below.)
2862These identifiers are used to provide link targets in the table of
2863contents generated by the `--toc|--table-of-contents` option. They
2864also make it easy to provide links from one section of a document to
2865another. A link to this section, for example, might look like this:
2868 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2870Note, however, that this method of providing links to sections works
2871only in HTML, LaTeX, and ConTeXt formats.
2873If the `--section-divs` option is specified, then each section will
2874be wrapped in a `section` (or a `div`, if `html4` was specified),
2875and the identifier will be attached to the enclosing `<section>`
2876(or `<div>`) tag rather than the heading itself. This allows entire
2877sections to be manipulated using JavaScript or treated differently in
2880#### Extension: `ascii_identifiers` ####
2882Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2883Accents are stripped off of accented Latin letters, and non-Latin
2886#### Extension: `gfm_auto_identifiers` ####
2888Changes the algorithm used by `auto_identifiers` to conform to
2889GitHub's method. Spaces are converted to dashes (`-`),
2890uppercase characters to lowercase characters, and punctuation
2891characters other than `-` and `_` are removed.
2892Emojis are replaced by their names.
2896The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2897[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2898[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2899are described in the section about Pandoc's Markdown.
2901However, they can also be used with HTML input. This is handy for
2902reading web pages formatted using MathJax, for example.
2906The following extensions are described in more detail in
2907their respective sections of [Pandoc's Markdown]:
2909- [`raw_html`](#extension-raw_html) allows HTML elements which
2910 are not representable in pandoc's AST to be parsed as raw HTML.
2911 By default, this is disabled for HTML input.
2913- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2914 to be included in a document. This extension can be enabled/disabled
2915 for the following formats (in addition to `markdown`):
2918 : `latex`, `textile`, `html` (environments, `\ref`, and
2919 `\eqref` only), `ipynb`
2922 : `textile`, `commonmark`
2924 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2925 only raw TeX in markdown cells, but data with mime type
2926 `text/html` in output cells. Since the `ipynb` reader attempts
2927 to preserve the richest possible outputs when several options
2928 are given, you will get best results if you disable `raw_html`
2929 and `raw_tex` when converting to formats like `docx` which don't
2930 allow raw `html` or `tex`.
2932- [`native_divs`](#extension-native_divs) causes HTML `div`
2933 elements to be parsed as native pandoc Div blocks.
2934 If you want them to be parsed as raw HTML, use
2935 `-f html-native_divs+raw_html`.
2937- [`native_spans`](#extension-native_spans) causes HTML `span`
2938 elements to be parsed as native pandoc Span inlines.
2939 If you want them to be parsed as raw HTML, use
2940 `-f html-native_spans+raw_html`. If you want to drop all
2941 `div`s and `span`s when converting HTML to Markdown, you
2942 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2944## Literate Haskell support
2946#### Extension: `literate_haskell` ####
2948Treat the document as literate Haskell source.
2950This extension can be enabled/disabled for the following formats:
2953: `markdown`, `rst`, `latex`
2956: `markdown`, `rst`, `latex`, `html`
2958If you append `+lhs` (or `+literate_haskell`) to one of the formats
2959above, pandoc will treat the document as literate Haskell source.
2962 - In Markdown input, "bird track" sections will be parsed as Haskell
2963 code rather than block quotations. Text between `\begin{code}`
2964 and `\end{code}` will also be treated as Haskell code. For
2965 ATX-style headings the character '=' will be used instead of '#'.
2967 - In Markdown output, code blocks with classes `haskell` and `literate`
2968 will be rendered using bird tracks, and block quotations will be
2969 indented one space, so they will not be treated as Haskell code.
2970 In addition, headings will be rendered setext-style (with underlines)
2971 rather than ATX-style (with '#' characters). (This is because ghc
2972 treats '#' characters in column 1 as introducing line numbers.)
2974 - In restructured text input, "bird track" sections will be parsed
2977 - In restructured text output, code blocks with class `haskell` will
2978 be rendered using bird tracks.
2980 - In LaTeX input, text in `code` environments will be parsed as
2983 - In LaTeX output, code blocks with class `haskell` will be rendered
2984 inside `code` environments.
2986 - In HTML output, code blocks with class `haskell` will be rendered
2987 with class `literatehaskell` and bird tracks.
2991 pandoc -f markdown+lhs -t html
2993reads literate Haskell source formatted with Markdown conventions and writes
2994ordinary HTML (without bird tracks).
2996 pandoc -f markdown+lhs -t html+lhs
2998writes HTML with the Haskell code in bird tracks, so it can be copied
2999and pasted as literate Haskell source.
3001Note that GHC expects the bird tracks in the first column, so indented
3002literate code blocks (e.g. inside an itemized environment) will not be
3003picked up by the Haskell compiler.
3007#### Extension: `empty_paragraphs` ####
3009Allows empty paragraphs. By default empty paragraphs are
3012This extension can be enabled/disabled for the following formats:
3018: `docx`, `odt`, `opendocument`, `html`
3020#### Extension: `native_numbering` ####
3022Enables native numbering of figures and tables. Enumeration
3025This extension can be enabled/disabled for the following formats:
3028: `odt`, `opendocument`
3030#### Extension: `styles` #### {#ext-styles}
3032When converting from docx, read all docx styles as divs (for
3033paragraph styles) and spans (for character styles) regardless
3034of whether pandoc understands the meaning of these styles.
3035This can be used with [docx custom styles](#custom-styles).
3041#### Extension: `amuse` ####
3043In the `muse` input format, this enables Text::Amuse
3044extensions to Emacs Muse markup.
3046#### Extension: `raw_markdown` ####
3048In the `ipynb` input format, this causes Markdown cells
3049to be included as raw Markdown blocks (allowing lossless
3050round-tripping) rather than being parsed. Use this only
3051when you are targeting `ipynb` or a markdown-based
3054#### Extension: `citations` {#org-citations}
3056Some aspects of [Pandoc's Markdown citation syntax](#citations)
3057are also accepted in `org` input.
3059#### Extension: `ntb` ####
3061In the `context` output format this enables the use of [Natural Tables
3062(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3063[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3064Natural tables allow more fine-grained global customization but come
3065at a performance penalty compared to extreme tables.
3070Pandoc understands an extended and slightly revised version of
3071John Gruber's [Markdown] syntax. This document explains the syntax,
3072noting differences from standard Markdown. Except where noted, these
3073differences can be suppressed by using the `markdown_strict` format instead
3074of `markdown`. Extensions can be enabled or disabled to specify the
3075behavior more granularly. They are described in the following. See also
3076[Extensions] above, for extensions that work also on other formats.
3080Markdown is designed to be easy to write, and, even more importantly,
3083> A Markdown-formatted document should be publishable as-is, as plain
3084> text, without looking like it's been marked up with tags or formatting
3086> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3088This principle has guided pandoc's decisions in finding syntax for
3089tables, footnotes, and other extensions.
3091There is, however, one respect in which pandoc's aims are different
3092from the original aims of Markdown. Whereas Markdown was originally
3093designed with HTML generation in mind, pandoc is designed for multiple
3094output formats. Thus, while pandoc allows the embedding of raw HTML,
3095it discourages it, and provides other, non-HTMLish ways of representing
3096important document elements like definition lists, tables, mathematics, and
3101A paragraph is one or more lines of text followed by one or more blank lines.
3102Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3103If you need a hard line break, put two or more spaces at the end of a line.
3105#### Extension: `escaped_line_breaks` ####
3107A backslash followed by a newline is also a hard line break.
3108Note: in multiline and grid table cells, this is the only way
3109to create a hard line break, since trailing spaces in the cells
3114There are two kinds of headings: Setext and ATX.
3116### Setext-style headings ###
3118A setext-style heading is a line of text "underlined" with a row of `=` signs
3119(for a level-one heading) or `-` signs (for a level-two heading):
3127The heading text can contain inline formatting, such as emphasis (see
3128[Inline formatting], below).
3131### ATX-style headings ###
3133An ATX-style heading consists of one to six `#` signs and a line of
3134text, optionally followed by any number of `#` signs. The number of
3135`#` signs at the beginning of the line is the heading level:
3137 ## A level-two heading
3139 ### A level-three heading ###
3141As with setext-style headings, the heading text can contain formatting:
3143 # A level-one heading with a [link](/url) and *emphasis*
3145#### Extension: `blank_before_header` ####
3147Standard Markdown syntax does not require a blank line before a heading.
3148Pandoc does require this (except, of course, at the beginning of the
3149document). The reason for the requirement is that it is all too easy for a
3150`#` to end up at the beginning of a line by accident (perhaps through line
3151wrapping). Consider, for example:
3153 I like several of their flavors of ice cream:
3154 #22, for example, and #5.
3156#### Extension: `space_in_atx_header` ####
3158Many Markdown implementations do not require a space between the
3159opening `#`s of an ATX heading and the heading text, so that
3160`#5 bolt` and `#hashtag` count as headings. With this extension,
3161pandoc does require the space.
3163### Heading identifiers ###
3165See also the [`auto_identifiers`
3166extension](#extension-auto_identifiers) above.
3168#### Extension: `header_attributes` ####
3170Headings can be assigned attributes using this syntax at the end
3171of the line containing the heading text:
3173 {#identifier .class .class key=value key=value}
3175Thus, for example, the following headings will all be assigned the identifier
3180 ## My heading ## {#foo}
3182 My other heading {#foo}
3185(This syntax is compatible with [PHP Markdown Extra].)
3187Note that although this syntax allows assignment of classes and key/value
3188attributes, writers generally don't use all of this information. Identifiers,
3189classes, and key/value attributes are used in HTML and HTML-based formats such
3190as EPUB and slidy. Identifiers are used for labels and link anchors in the
3191LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3193Headings with the class `unnumbered` will not be numbered, even if
3194`--number-sections` is specified. A single hyphen (`-`) in an attribute
3195context is equivalent to `.unnumbered`, and preferable in non-English
3202 # My heading {.unnumbered}
3204If the `unlisted` class is present in addition to `unnumbered`,
3205the heading will not be included in a table of contents.
3206(Currently this feature is only implemented for certain
3207formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3209#### Extension: `implicit_header_references` ####
3211Pandoc behaves as if reference links have been defined for each heading.
3212So, to link to a heading
3214 # Heading identifiers in HTML
3218 [Heading identifiers in HTML]
3222 [Heading identifiers in HTML][]
3226 [the section on heading identifiers][heading identifiers in
3229instead of giving the identifier explicitly:
3231 [Heading identifiers in HTML](#heading-identifiers-in-html)
3233If there are multiple headings with identical text, the corresponding
3234reference will link to the first one only, and you will need to use explicit
3235links to link to the others, as described above.
3237Like regular reference links, these references are case-insensitive.
3239Explicit link reference definitions always take priority over
3240implicit heading references. So, in the following example, the
3241link will point to `bar`, not to `#foo`:
3251Markdown uses email conventions for quoting blocks of text.
3252A block quotation is one or more paragraphs or other block elements
3253(such as lists or headings), with each line preceded by a `>` character
3254and an optional space. (The `>` need not start at the left margin, but
3255it should not be indented more than three spaces.)
3257 > This is a block quote. This
3258 > paragraph has two lines.
3260 > 1. This is a list inside a block quote.
3263A "lazy" form, which requires the `>` character only on the first
3264line of each block, is also allowed:
3266 > This is a block quote. This
3267 paragraph has two lines.
3269 > 1. This is a list inside a block quote.
3272Among the block elements that can be contained in a block quote are
3273other block quotes. That is, block quotes can be nested:
3275 > This is a block quote.
3277 > > A block quote within a block quote.
3279If the `>` character is followed by an optional space, that space
3280will be considered part of the block quote marker and not part of
3281the indentation of the contents. Thus, to put an indented code
3282block in a block quote, you need five spaces after the `>`:
3286#### Extension: `blank_before_blockquote` ####
3288Standard Markdown syntax does not require a blank line before a
3289block quote. Pandoc does require this (except, of course, at
3290the beginning of the document). The reason for the requirement
3291is that it is all too easy for a `>` to end up at the beginning
3292of a line by accident (perhaps through line wrapping). So,
3293unless the `markdown_strict` format is used, the following does
3294not produce a nested block quote in pandoc:
3296 > This is a block quote.
3300## Verbatim (code) blocks
3302### Indented code blocks ###
3304A block of text indented four spaces (or one tab) is treated as verbatim
3305text: that is, special characters do not trigger special formatting,
3306and all spaces and line breaks are preserved. For example,
3309 moveShip(5 * gravity, DOWN);
3312The initial (four space or one tab) indentation is not considered part
3313of the verbatim text, and is removed in the output.
3315Note: blank lines in the verbatim text need not begin with four spaces.
3318### Fenced code blocks ###
3320#### Extension: `fenced_code_blocks` ####
3322In addition to standard indented code blocks, pandoc supports
3323*fenced* code blocks. These begin with a row of three or more
3324tildes (`~`) and end with a row of tildes that must be at least as long as
3325the starting row. Everything between these lines is treated as code. No
3326indentation is necessary:
3330 moveShip(5 * gravity, DOWN);
3334Like regular code blocks, fenced code blocks must be separated
3335from surrounding text by blank lines.
3337If the code itself contains a row of tildes or backticks, just use a longer
3338row of tildes or backticks at the start and end:
3342 code including tildes
3346#### Extension: `backtick_code_blocks` ####
3348Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3351#### Extension: `fenced_code_attributes` ####
3353Optionally, you may attach attributes to fenced or backtick code block using
3356 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3358 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3359 qsort (filter (>= x) xs)
3360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3362Here `mycode` is an identifier, `haskell` and `numberLines` are
3363classes, and `startFrom` is an attribute with value `100`. Some
3364output formats can use this information to do syntax
3365highlighting. Currently, the only output formats that uses this
3366information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3367highlighting is supported for your output format and language,
3368then the code block above will appear highlighted, with numbered
3369lines. (To see which languages are supported, type `pandoc
3370--list-highlight-languages`.) Otherwise, the code block above
3371will appear as follows:
3373 <pre id="mycode" class="haskell numberLines" startFrom="100">
3379The `numberLines` (or `number-lines`) class will cause the lines
3380of the code block to be numbered, starting with `1` or the value
3381of the `startFrom` attribute. The `lineAnchors` (or
3382`line-anchors`) class will cause the lines to be clickable
3383anchors in HTML output.
3385A shortcut form can also be used for specifying the language of
3392This is equivalent to:
3398If the `fenced_code_attributes` extension is disabled, but
3399input contains class attribute(s) for the code block, the first
3400class attribute will be printed after the opening fence as a bare
3403To prevent all highlighting, use the `--no-highlight` flag.
3404To set the highlighting style, use `--highlight-style`.
3405For more information on highlighting, see [Syntax highlighting],
3410#### Extension: `line_blocks` ####
3412A line block is a sequence of lines beginning with a vertical bar (`|`)
3413followed by a space. The division into lines will be preserved in
3414the output, as will any leading spaces; otherwise, the lines will
3415be formatted as Markdown. This is useful for verse and addresses:
3417 | The limerick packs laughs anatomical
3418 | In space that is quite economical.
3419 | But the good ones I've seen
3420 | So seldom are clean
3421 | And the clean ones so seldom are comical
3424 | Berkeley, CA 94718
3426The lines can be hard-wrapped if needed, but the continuation
3427line must begin with a space.
3429 | The Right Honorable Most Venerable and Righteous Samuel L.
3432 | Berkeley, CA 94718
3434This syntax is borrowed from [reStructuredText].
3440A bullet list is a list of bulleted list items. A bulleted list
3441item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3448This will produce a "compact" list. If you want a "loose" list, in which
3449each item is formatted as a paragraph, put spaces between the items:
3457The bullets need not be flush with the left margin; they may be
3458indented one, two, or three spaces. The bullet must be followed
3461List items look best if subsequent lines are flush with the first
3462line (after the bullet):
3468But Markdown also allows a "lazy" format:
3474### Block content in list items ###
3476A list item may contain multiple paragraphs and other block-level
3477content. However, subsequent paragraphs must be preceded by a blank line
3478and indented to line up with the first non-space content after
3485 * Second paragraph. With a code block, which must be indented
3490Exception: if the list marker is followed by an indented code
3491block, which must begin 5 spaces after the list marker, then
3492subsequent paragraphs must begin two columns after the last
3493character of the list marker:
3497 continuation paragraph
3499List items may include other lists. In this case the preceding blank
3500line is optional. The nested list must be indented to line up with
3501the first non-space character after the list marker of the
3502containing list item.
3514As noted above, Markdown allows you to write list items "lazily," instead of
3515indenting continuation lines. However, if there are multiple paragraphs or
3516other blocks in a list item, the first line of each must be indented.
3518 + A lazy, lazy, list
3521 + Another one; this looks
3524 Second paragraph of second
3527### Ordered lists ###
3529Ordered lists work just like bulleted lists, except that the items
3530begin with enumerators rather than bullets.
3532In standard Markdown, enumerators are decimal numbers followed
3533by a period and a space. The numbers themselves are ignored, so
3534there is no difference between this list:
3546#### Extension: `fancy_lists` ####
3548Unlike standard Markdown, pandoc allows ordered list items to be marked
3549with uppercase and lowercase letters and roman numerals, in addition to
3550Arabic numerals. List markers may be enclosed in parentheses or followed by a
3551single right-parentheses or period. They must be separated from the
3552text that follows by at least one space, and, if the list marker is a
3553capital letter with a period, by at least two spaces.[^2]
3555[^2]: The point of this rule is to ensure that normal paragraphs
3556 starting with people's initials, like
3558 B. Russell was an English philosopher.
3560 do not get treated as list items.
3562 This rule will not prevent
3566 from being interpreted as a list item. In this case, a backslash
3571The `fancy_lists` extension also allows '`#`' to be used as an
3572ordered list marker in place of a numeral:
3577#### Extension: `startnum` ####
3579Pandoc also pays attention to the type of list marker used, and to the
3580starting number, and both of these are preserved where possible in the
3581output format. Thus, the following yields a list with numbers followed
3582by a single parenthesis, starting with 9, and a sublist with lowercase
3592Pandoc will start a new list each time a different type of list
3593marker is used. So, the following will create three lists:
3600If default list markers are desired, use `#.`:
3606#### Extension: `task_lists` ####
3608Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3610 - [ ] an unchecked task list item
3613### Definition lists ###
3615#### Extension: `definition_lists` ####
3617Pandoc supports definition lists, using the syntax of
3618[PHP Markdown Extra] with some extensions.[^3]
3624 Term 2 with *inline markup*
3628 { some code, part of Definition 2 }
3630 Third paragraph of definition 2.
3632Each term must fit on one line, which may optionally be followed by
3633a blank line, and must be followed by one or more definitions.
3634A definition begins with a colon or tilde, which may be indented one
3637A term may have multiple definitions, and each definition may
3638consist of one or more block elements (paragraph, code block,
3639list, etc.), each indented four spaces or one tab stop. The
3640body of the definition (including the first line, aside from the
3641colon or tilde) should be indented four spaces. However, as with
3642other Markdown lists, you can "lazily" omit indentation except
3643at the beginning of a paragraph or other block element:
3648 with lazy continuation.
3650 Second paragraph of the definition.
3652If you leave space before the definition (as in the example above),
3653the text of the definition will be treated as a paragraph. In some
3654output formats, this will mean greater spacing between term/definition
3655pairs. For a more compact definition list, omit the space before the
3665Note that space between items in a definition list is required.
3666(A variant that loosens this requirement, but disallows "lazy"
3667hard wrapping, can be activated with `compact_definition_lists`: see
3668[Non-pandoc extensions], below.)
3670[^3]: I have been influenced by the suggestions of [David
3671 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3673### Numbered example lists ###
3675#### Extension: `example_lists` ####
3677The special list marker `@` can be used for sequentially numbered
3678examples. The first list item with a `@` marker will be numbered '1',
3679the next '2', and so on, throughout the document. The numbered examples
3680need not occur in a single list; each new list using `@` will take up
3681where the last stopped. So, for example:
3683 (@) My first example will be numbered (1).
3684 (@) My second example will be numbered (2).
3686 Explanation of examples.
3688 (@) My third example will be numbered (3).
3690Numbered examples can be labeled and referred to elsewhere in the
3693 (@good) This is a good example.
3695 As (@good) illustrates, ...
3697The label can be any string of alphanumeric characters, underscores,
3700Note: continuation paragraphs in example lists must always
3701be indented four spaces, regardless of the length of the
3702list marker. That is, example lists always behave as if the
3703`four_space_rule` extension is set. This is because example
3704labels tend to be long, and indenting content to the
3705first non-space character after the label would be awkward.
3708### Ending a list ###
3710What if you want to put an indented code block after a list?
3717Trouble! Here pandoc (like other Markdown implementations) will treat
3718`{ my code block }` as the second paragraph of item two, and not as
3721To "cut off" the list after item two, you can insert some non-indented
3722content, like an HTML comment, which won't produce visible output in
3728 <!-- end of list -->
3732You can use the same trick if you want two consecutive lists instead
3747A line containing a row of three or more `*`, `-`, or `_` characters
3748(optionally separated by spaces) produces a horizontal rule:
3757Four kinds of tables may be used. The first three kinds presuppose the use of
3758a fixed-width font, such as Courier. The fourth kind can be used with
3759proportionally spaced fonts, as it does not require lining up columns.
3761#### Extension: `table_captions` ####
3763A caption may optionally be provided with all 4 kinds of tables (as
3764illustrated in the examples below). A caption is a paragraph beginning
3765with the string `Table:` (or just `:`), which will be stripped off.
3766It may appear either before or after the table.
3768#### Extension: `simple_tables` ####
3770Simple tables look like this:
3772 Right Left Center Default
3773 ------- ------ ---------- -------
3778 Table: Demonstration of simple table syntax.
3780The header and table rows must each fit on one line. Column
3781alignments are determined by the position of the header text relative
3782to the dashed line below it:[^4]
3784 - If the dashed line is flush with the header text on the right side
3785 but extends beyond it on the left, the column is right-aligned.
3786 - If the dashed line is flush with the header text on the left side
3787 but extends beyond it on the right, the column is left-aligned.
3788 - If the dashed line extends beyond the header text on both sides,
3789 the column is centered.
3790 - If the dashed line is flush with the header text on both sides,
3791 the default alignment is used (in most cases, this will be left).
3793[^4]: This scheme is due to Michel Fortin, who proposed it on the
3794 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3796The table must end with a blank line, or a line of dashes followed by
3799The column header row may be omitted, provided a dashed line is used
3800to end the table. For example:
3802 ------- ------ ---------- -------
3806 ------- ------ ---------- -------
3808When the header row is omitted, column alignments are determined on the basis
3809of the first line of the table body. So, in the tables above, the columns
3810would be right, left, center, and right aligned, respectively.
3812#### Extension: `multiline_tables` ####
3814Multiline tables allow header and table rows to span multiple lines
3815of text (but cells that span multiple columns or rows of the table are
3816not supported). Here is an example:
3818 -------------------------------------------------------------
3819 Centered Default Right Left
3820 Header Aligned Aligned Aligned
3821 ----------- ------- --------------- -------------------------
3822 First row 12.0 Example of a row that
3823 spans multiple lines.
3825 Second row 5.0 Here's another one. Note
3826 the blank line between
3828 -------------------------------------------------------------
3830 Table: Here's the caption. It, too, may span
3833These work like simple tables, but with the following differences:
3835 - They must begin with a row of dashes, before the header text
3836 (unless the header row is omitted).
3837 - They must end with a row of dashes, then a blank line.
3838 - The rows must be separated by blank lines.
3840In multiline tables, the table parser pays attention to the widths of
3841the columns, and the writers try to reproduce these relative widths in
3842the output. So, if you find that one of the columns is too narrow in the
3843output, try widening it in the Markdown source.
3845The header may be omitted in multiline tables as well as simple tables:
3847 ----------- ------- --------------- -------------------------
3848 First row 12.0 Example of a row that
3849 spans multiple lines.
3851 Second row 5.0 Here's another one. Note
3852 the blank line between
3854 ----------- ------- --------------- -------------------------
3856 : Here's a multiline table without a header.
3858It is possible for a multiline table to have just one row, but the row
3859should be followed by a blank line (and then the row of dashes that ends
3860the table), or the table may be interpreted as a simple table.
3862#### Extension: `grid_tables` ####
3864Grid tables look like this:
3866 : Sample grid table.
3868 +---------------+---------------+--------------------+
3869 | Fruit | Price | Advantages |
3870 +===============+===============+====================+
3871 | Bananas | $1.34 | - built-in wrapper |
3872 | | | - bright color |
3873 +---------------+---------------+--------------------+
3874 | Oranges | $2.10 | - cures scurvy |
3876 +---------------+---------------+--------------------+
3878The row of `=`s separates the header from the table body, and can be
3879omitted for a headerless table. The cells of grid tables may contain
3880arbitrary block elements (multiple paragraphs, code blocks, lists,
3881etc.). Cells that span multiple columns or rows are not
3882supported. Grid tables can be created easily using Emacs' table-mode
3883(`M-x table-insert`).
3885Alignments can be specified as with pipe tables, by putting
3886colons at the boundaries of the separator line after the
3889 +---------------+---------------+--------------------+
3890 | Right | Left | Centered |
3891 +==============:+:==============+:==================:+
3892 | Bananas | $1.34 | built-in wrapper |
3893 +---------------+---------------+--------------------+
3895For headerless tables, the colons go on the top line instead:
3897 +--------------:+:--------------+:------------------:+
3898 | Right | Left | Centered |
3899 +---------------+---------------+--------------------+
3901##### Grid Table Limitations #####
3903Pandoc does not support grid tables with row spans or column spans.
3904This means that neither variable numbers of columns across rows nor
3905variable numbers of rows across columns are supported by Pandoc.
3906All grid tables must have the same number of columns in each row,
3907and the same number of rows in each column. For example, the
3908Docutils [sample grid tables] will not render as expected with
3911[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3914#### Extension: `pipe_tables` ####
3916Pipe tables look like this:
3918 | Right | Left | Default | Center |
3919 |------:|:-----|---------|:------:|
3920 | 12 | 12 | 12 | 12 |
3921 | 123 | 123 | 123 | 123 |
3924 : Demonstration of pipe table syntax.
3926The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3927ending pipe characters are optional, but pipes are required between all
3928columns. The colons indicate column alignment as shown. The header
3929cannot be omitted. To simulate a headerless table, include a header
3932Since the pipes indicate column boundaries, columns need not be vertically
3933aligned, as they are in the above example. So, this is a perfectly
3934legal (though ugly) pipe table:
3942The cells of pipe tables cannot contain block elements like paragraphs
3943and lists, and cannot span multiple lines. If a pipe table contains a
3944row whose Markdown content is wider than the column width (see
3945`--columns`), then the table will take up the full text width and
3946the cell contents will wrap, with the relative cell widths determined
3947by the number of dashes in the line separating the table header from
3948the table body. (For example `---|-` would make the first column 3/4
3949and the second column 1/4 of the full text width.)
3950On the other hand, if no lines are wider than column width, then
3951cell contents will not be wrapped, and the cells will be sized
3954Note: pandoc also recognizes pipe tables of the following
3955form, as can be produced by Emacs' orgtbl-mode:
3962The difference is that `+` is used instead of `|`. Other orgtbl features
3963are not supported. In particular, to get non-default column alignment,
3964you'll need to add colons as above.
3966[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3970#### Extension: `pandoc_title_block` ####
3972If the file begins with a title block
3975 % author(s) (separated by semicolons)
3978it will be parsed as bibliographic information, not regular text. (It
3979will be used, for example, in the title of standalone LaTeX or HTML
3980output.) The block may contain just a title, a title and an author,
3981or all three elements. If you want to include an author but no
3982title, or a title and a date but no author, you need a blank line:
3995The title may occupy multiple lines, but continuation lines must
3996begin with leading space, thus:
4003If a document has multiple authors, the authors may be put on
4004separate lines with leading space, or separated by semicolons, or
4005both. So, all of the following are equivalent:
4013% Author One; Author Two
4021The date must fit on one line.
4023All three metadata fields may contain standard inline formatting
4024(italics, links, footnotes, etc.).
4026Title blocks will always be parsed, but they will affect the output only
4027when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4028will appear twice: once in the document head -- this is the title that
4029will appear at the top of the window in a browser -- and once at the
4030beginning of the document body. The title in the document head can have
4031an optional prefix attached (`--title-prefix` or `-T` option). The title
4032in the body appears as an H1 element with class "title", so it can be
4033suppressed or reformatted with CSS. If a title prefix is specified with
4034`-T` and no title block appears in the document, the title prefix will
4035be used by itself as the HTML title.
4037The man page writer extracts a title, man page section number, and
4038other header and footer information from the title line. The title
4039is assumed to be the first word on the title line, which may optionally
4040end with a (single-digit) section number in parentheses. (There should
4041be no space between the title and the parentheses.) Anything after
4042this is assumed to be additional footer and header text. A single pipe
4043character (`|`) should be used to separate the footer text from the header
4048will yield a man page with the title `PANDOC` and section 1.
4050 % PANDOC(1) Pandoc User Manuals
4052will also have "Pandoc User Manuals" in the footer.
4054 % PANDOC(1) Pandoc User Manuals | Version 4.0
4056will also have "Version 4.0" in the header.
4058#### Extension: `yaml_metadata_block` ####
4060A [YAML] metadata block is a valid YAML object, delimited by a line of three
4061hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4062(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4063document, but if it is not at the beginning, it must be preceded by a blank
4064line. (Note that, because of the way pandoc concatenates input files when
4065several are provided, you may also keep the metadata in a separate YAML file
4066and pass it to pandoc as an argument, along with your Markdown files:
4068 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4070Just be sure that the YAML file begins with `---` and ends with `---` or
4071`...`.) Alternatively, you can use the `--metadata-file` option. Using
4072that approach however, you cannot reference content (like footnotes)
4073from the main markdown input document.
4075Metadata will be taken from the fields of the YAML object and added to any
4076existing document metadata. Metadata can contain lists and objects (nested
4077arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4078with names ending in an underscore will be ignored by pandoc. (They may be
4079given a role by external processors.) Field names must not be
4080interpretable as YAML numbers or boolean values (so, for
4081example, `yes`, `True`, and `15` cannot be used as field names).
4083A document may contain multiple metadata blocks. If two
4084metadata blocks attempt to set the same field, the value from
4085the second block will be taken.
4087When pandoc is used with `-t markdown` to create a Markdown document,
4088a YAML metadata block will be produced only if the `-s/--standalone`
4089option is used. All of the metadata will appear in a single block
4090at the beginning of the document.
4092Note that [YAML] escaping rules must be followed. Thus, for example,
4093if a title contains a colon, it must be quoted. The pipe character
4094(`|`) can be used to begin an indented block that will be interpreted
4095literally, without need for escaping. This form is necessary
4096when the field contains blank lines or block-level formatting:
4099 title: 'This is the title: it contains a colon'
4103 keywords: [nothing, nothingness]
4105 This is the abstract.
4107 It consists of two paragraphs.
4110Template variables will be set automatically from the metadata. Thus, for
4111example, in writing HTML, the variable `abstract` will be set to the HTML
4112equivalent of the Markdown in the `abstract` field:
4114 <p>This is the abstract.</p>
4115 <p>It consists of two paragraphs.</p>
4117Variables can contain arbitrary YAML structures, but the template must match
4118this structure. The `author` variable in the default templates expects a
4119simple list or string, but can be changed to support more complicated
4120structures. The following combination, for example, would add an affiliation
4121to the author if one is given:
4124 title: The document title
4127 affiliation: University of Somewhere
4129 affiliation: University of Nowhere
4132To use the structured authors in the example above, you would need a custom
4137 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4143Raw content to include in the document's header may be specified
4144using `header-includes`; however, it is important to mark up
4145this content as raw code for a particular output format, using
4146the [`raw_attribute` extension](#extension-raw_attribute)), or it
4147will be interpreted as markdown. For example:
4152 \let\oldsection\section
4153 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4158#### Extension: `all_symbols_escapable` ####
4160Except inside a code block or inline code, any punctuation or space
4161character preceded by a backslash will be treated literally, even if it
4162would normally indicate formatting. Thus, for example, if one writes
4172 <strong>hello</strong>
4174This rule is easier to remember than standard Markdown's rule,
4175which allows only the following characters to be backslash-escaped:
4179(However, if the `markdown_strict` format is used, the standard Markdown rule
4182A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4183it will appear as `~`. In HTML and XML output, it will appear as a
4184literal unicode nonbreaking space character (note that it will thus
4185actually look "invisible" in the generated HTML source; you can still
4186use the `--ascii` command-line option to make it appear as an explicit
4189A backslash-escaped newline (i.e. a backslash occurring at the end of
4190a line) is parsed as a hard line break. It will appear in TeX output as
4191`\\` and in HTML as `<br />`. This is a nice alternative to
4192Markdown's "invisible" way of indicating hard line breaks using
4193two trailing spaces on a line.
4195Backslash escapes do not work in verbatim contexts.
4201To *emphasize* some text, surround it with `*`s or `_`, like this:
4203 This text is _emphasized with underscores_, and this
4204 is *emphasized with asterisks*.
4206Double `*` or `_` produces **strong emphasis**:
4208 This is **strong emphasis** and __with underscores__.
4210A `*` or `_` character surrounded by spaces, or backslash-escaped,
4211will not trigger emphasis:
4213 This is * not emphasized *, and \*neither is this\*.
4215#### Extension: `intraword_underscores` ####
4217Because `_` is sometimes used inside words and identifiers,
4218pandoc does not interpret a `_` surrounded by alphanumeric
4219characters as an emphasis marker. If you want to emphasize
4220just part of a word, use `*`:
4222 feas*ible*, not feas*able*.
4227#### Extension: `strikeout` ####
4229To strikeout a section of text with a horizontal line, begin and end it
4230with `~~`. Thus, for example,
4232 This ~~is deleted text.~~
4235### Superscripts and subscripts ###
4237#### Extension: `superscript`, `subscript` ####
4239Superscripts may be written by surrounding the superscripted text by `^`
4240characters; subscripts may be written by surrounding the subscripted
4241text by `~` characters. Thus, for example,
4243 H~2~O is a liquid. 2^10^ is 1024.
4245The text between `^...^` or `~...~` may not contain spaces or
4246newlines. If the superscripted or subscripted text contains
4247spaces, these spaces must be escaped with backslashes. (This is
4248to prevent accidental superscripting and subscripting through
4249the ordinary use of `~` and `^`, and also bad interactions with
4250footnotes.) Thus, if you want the letter P with 'a cat' in
4251subscripts, use `P~a\ cat~`, not `P~a cat~`.
4255To make a short span of text verbatim, put it inside backticks:
4257 What is the difference between `>>=` and `>>`?
4259If the verbatim text includes a backtick, use double backticks:
4261 Here is a literal backtick `` ` ``.
4263(The spaces after the opening backticks and before the closing
4264backticks will be ignored.)
4266The general rule is that a verbatim span starts with a string
4267of consecutive backticks (optionally followed by a space)
4268and ends with a string of the same number of backticks (optionally
4269preceded by a space).
4271Note that backslash-escapes (and other Markdown constructs) do not
4272work in verbatim contexts:
4274 This is a backslash followed by an asterisk: `\*`.
4276#### Extension: `inline_code_attributes` ####
4278Attributes can be attached to verbatim text, just as with
4279[fenced code blocks]:
4285To write small caps, use the `smallcaps` class:
4287 [Small caps]{.smallcaps}
4289Or, without the `bracketed_spans` extension:
4291 <span class="smallcaps">Small caps</span>
4293For compatibility with other Markdown flavors, CSS is also supported:
4295 <span style="font-variant:small-caps;">Small caps</span>
4297This will work in all output formats that support small caps.
4302#### Extension: `tex_math_dollars` ####
4304Anything between two `$` characters will be treated as TeX math. The
4305opening `$` must have a non-space character immediately to its right,
4306while the closing `$` must have a non-space character immediately to its
4307left, and must not be followed immediately by a digit. Thus,
4308`$20,000 and $30,000` won't parse as math. If for some reason
4309you need to enclose text in literal `$` characters, backslash-escape
4310them and they won't be treated as math delimiters.
4312For display math, use `$$` delimiters. (In this case, the delimiters
4313may be separated from the formula by whitespace.)
4315TeX math will be printed in all output formats. How it is rendered
4316depends on the output format:
4319 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4320 math) or `\[...\]` (for display math).
4322Markdown, Emacs Org mode, ConTeXt, ZimWiki
4323 ~ It will appear verbatim surrounded by `$...$` (for inline
4324 math) or `$$...$$` (for display math).
4327 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4330 ~ It will be rendered using an [interpreted text role `:math:`].
4333 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4334 surrounded by `latexmath:[$...$]` (for inline math) or
4335 `[latexmath]++++\[...\]+++` (for display math).
4336 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4337 (`$..$` and `\[..\]`) are omitted.
4340 ~ It will be rendered inside a `@math` command.
4342roff man, Jira markup
4343 ~ It will be rendered verbatim without `$`'s.
4346 ~ It will be rendered inside `<math>` tags.
4349 ~ It will be rendered inside `<span class="math">` tags.
4352 ~ It will be rendered, if possible, using Unicode characters,
4353 and will otherwise appear verbatim.
4356 ~ It will be rendered, if possible, using MathML.
4359 ~ If the `--mathml` flag is used, it will be rendered using MathML
4360 in an `inlineequation` or `informalequation` tag. Otherwise it
4361 will be rendered, if possible, using Unicode characters.
4364 ~ It will be rendered using OMML math markup.
4367 ~ If the `--webtex` option is used, formulas are rendered as images
4368 using CodeCogs or other compatible web service, downloaded
4369 and embedded in the e-book. Otherwise, they will appear verbatim.
4371HTML, Slidy, DZSlides, S5, EPUB
4372 ~ The way math is rendered in HTML will depend on the
4373 command-line options selected. Therefore see [Math rendering in HTML]
4376[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4380#### Extension: `raw_html` ####
4382Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4383(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4384literally). (Technically this is not an extension, since standard
4385Markdown allows it, but it has been made an extension so that it can
4386be disabled if desired.)
4388The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4389DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4390output, and suppressed in other formats.
4392For a more explicit way of including raw HTML in a Markdown
4393document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4395In the CommonMark format, if `raw_html` is enabled, superscripts,
4396subscripts, strikeouts and small capitals will be represented as HTML.
4397Otherwise, plain-text fallbacks will be used. Note that even if
4398`raw_html` is disabled, tables will be rendered with HTML syntax if
4399they cannot use pipe syntax.
4401#### Extension: `markdown_in_html_blocks` ####
4403Standard Markdown allows you to include HTML "blocks": blocks
4404of HTML between balanced tags that are separated from the surrounding text
4405with blank lines, and start and end at the left margin. Within
4406these blocks, everything is interpreted as HTML, not Markdown;
4407so (for example), `*` does not signify emphasis.
4409Pandoc behaves this way when the `markdown_strict` format is used; but
4410by default, pandoc interprets material between HTML block tags as Markdown.
4411Thus, for example, pandoc will turn
4416 <td>[a link](https://google.com)</td>
4424 <td><em>one</em></td>
4425 <td><a href="https://google.com">a link</a></td>
4429whereas `Markdown.pl` will preserve it as is.
4431There is one exception to this rule: text between `<script>` and
4432`<style>` tags is not interpreted as Markdown.
4434This departure from standard Markdown should make it easier to mix
4435Markdown with HTML block elements. For example, one can surround
4436a block of Markdown text with `<div>` tags without preventing it
4437from being interpreted as Markdown.
4439#### Extension: `native_divs` ####
4441Use native pandoc `Div` blocks for content inside `<div>` tags.
4442For the most part this should give the same output as
4443`markdown_in_html_blocks`, but it makes it easier to write pandoc
4444filters to manipulate groups of blocks.
4446#### Extension: `native_spans` ####
4448Use native pandoc `Span` blocks for content inside `<span>` tags.
4449For the most part this should give the same output as `raw_html`,
4450but it makes it easier to write pandoc filters to manipulate groups
4453#### Extension: `raw_tex` ####
4455In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4456included in a document. Inline TeX commands will be preserved and passed
4457unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4458LaTeX to include BibTeX citations:
4460 This result was proved in \cite{jones.1967}.
4462Note that in LaTeX environments, like
4464 \begin{tabular}{|l|l|}\hline
4465 Age & Frequency \\ \hline
4468 36--45 & 22 \\ \hline
4471the material between the begin and end tags will be interpreted as raw
4472LaTeX, not as Markdown.
4474For a more explicit and flexible way of including raw TeX in a
4475Markdown document, see the [`raw_attribute`
4476extension][Extension: `raw_attribute`].
4478Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4479Emacs Org mode, and ConTeXt.
4481### Generic raw attribute ###
4483#### Extension: `raw_attribute` ####
4485Inline spans and fenced code blocks with a special
4486kind of attribute will be parsed as raw content with the
4487designated format. For example, the following produces a raw
4494And the following produces a raw `html` inline element:
4496 This is `<a>html</a>`{=html}
4498This can be useful to insert raw xml into `docx` documents, e.g.
4504 <w:br w:type="page"/>
4509The format name should match the target format name (see
4510`-t/--to`, above, for a list, or use `pandoc
4511--list-output-formats`). Use `openxml` for `docx` output,
4512`opendocument` for `odt` output, `html5` for `epub3` output,
4513`html4` for `epub2` output, and `latex`, `beamer`,
4514`ms`, or `html5` for `pdf` output (depending on what you
4515use for `--pdf-engine`).
4517This extension presupposes that the relevant kind of
4518inline code or fenced code block is enabled. Thus, for
4519example, to use a raw attribute with a backtick code block,
4520`backtick_code_blocks` must be enabled.
4522The raw attribute cannot be combined with regular attributes.
4526#### Extension: `latex_macros` ####
4528When this extension is enabled, pandoc will parse LaTeX
4529macro definitions and apply the resulting macros to all LaTeX
4530math and raw LaTeX. So, for example, the following will work in
4531all output formats, not just LaTeX:
4533 \newcommand{\tuple}[1]{\langle #1 \rangle}
4537Note that LaTeX macros will not be applied if they occur
4538inside a raw span or block marked with the
4539[`raw_attribute` extension](#extension-raw_attribute).
4541When `latex_macros` is disabled, the raw LaTeX and math will
4542not have macros applied. This is usually a better approach when
4543you are targeting LaTeX or PDF.
4545Macro definitions in LaTeX will be passed through as raw LaTeX
4546only if `latex_macros` is not enabled. Macro definitions in
4547Markdown source (or other formats allowing `raw_tex`) will
4548be passed through regardless of whether `latex_macros` is
4553Markdown allows links to be specified in several ways.
4555### Automatic links ###
4557If you enclose a URL or email address in pointy brackets, it
4560 <https://google.com>
4561 <sam@green.eggs.ham>
4565An inline link consists of the link text in square brackets,
4566followed by the URL in parentheses. (Optionally, the URL can
4567be followed by a link title, in quotes.)
4569 This is an [inline link](/url), and here's [one with
4570 a title](https://fsf.org "click here for a good time!").
4572There can be no space between the bracketed part and the parenthesized part.
4573The link text can contain formatting (such as emphasis), but the title cannot.
4575Email addresses in inline links are not autodetected, so they have to be
4576prefixed with `mailto`:
4578 [Write me!](mailto:sam@green.eggs.ham)
4580### Reference links ###
4582An *explicit* reference link has two parts, the link itself and the link
4583definition, which may occur elsewhere in the document (either
4584before or after the link).
4586The link consists of link text in square brackets, followed by a label in
4587square brackets. (There cannot be space between the two unless the
4588`spaced_reference_links` extension is enabled.) The link definition
4589consists of the bracketed label, followed by a colon and a space, followed by
4590the URL, and optionally (after a space) a link title either in quotes or in
4591parentheses. The label must not be parseable as a citation (assuming
4592the `citations` extension is enabled): citations take precedence over
4595Here are some examples:
4597 [my label 1]: /foo/bar.html "My title, optional"
4599 [my label 3]: https://fsf.org (The free software foundation)
4600 [my label 4]: /bar#special 'A title in single quotes'
4602The URL may optionally be surrounded by angle brackets:
4604 [my label 5]: <http://foo.bar.baz>
4606The title may go on the next line:
4608 [my label 3]: https://fsf.org
4609 "The free software foundation"
4611Note that link labels are not case sensitive. So, this will work:
4613 Here is [my link][FOO]
4617In an *implicit* reference link, the second pair of brackets is
4622 [my website]: http://foo.bar.baz
4624Note: In `Markdown.pl` and most other Markdown implementations,
4625reference link definitions cannot occur in nested constructions
4626such as list items or block quotes. Pandoc lifts this arbitrary
4627seeming restriction. So the following is fine in pandoc, though
4628not in most other implementations:
4634#### Extension: `shortcut_reference_links` ####
4636In a *shortcut* reference link, the second pair of brackets may
4641 [my website]: http://foo.bar.baz
4643### Internal links ###
4645To link to another section of the same document, use the automatically
4646generated identifier (see [Heading identifiers]). For example:
4648 See the [Introduction](#introduction).
4652 See the [Introduction].
4654 [Introduction]: #introduction
4656Internal links are currently supported for HTML formats (including
4657HTML slide shows and EPUB), LaTeX, and ConTeXt.
4661A link immediately preceded by a `!` will be treated as an image.
4662The link text will be used as the image's alt text:
4664 
4668 [movie reel]: movie.gif
4670#### Extension: `implicit_figures` ####
4672An image with nonempty alt text, occurring by itself in a
4673paragraph, will be rendered as a figure with a caption. The
4674image's alt text will be used as the caption.
4676 
4678How this is rendered depends on the output format. Some output
4679formats (e.g. RTF) do not yet support figures. In those
4680formats, you'll just get an image in a paragraph by itself, with
4683If you just want a regular inline image, just make sure it is not
4684the only thing in the paragraph. One way to do this is to insert a
4685nonbreaking space after the image:
4687 \
4689Note that in reveal.js slide shows, an image in a paragraph
4690by itself that has the `stretch` class will fill the screen,
4691and the caption and figure tags will be omitted.
4693#### Extension: `link_attributes` ####
4695Attributes can be set on links and images:
4697 An inline {#id .class width=30 height=20px}
4698 and a reference ![image][ref] with attributes.
4700 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4702(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4703and `.class` are used.)
4705For HTML and EPUB, all known HTML5 attributes except `width` and
4706`height` (but including `srcset` and `sizes`) are passed through
4707as is. Unknown attributes are passed through as custom
4708attributes, with `data-` prepended. The other writers ignore
4709attributes that are not specifically supported by their output format.
4711The `width` and `height` attributes on images are treated specially. When
4712used without a unit, the unit is assumed to be pixels. However, any of
4713the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4714and `%`. There must not be any spaces between the number and the unit.
4718{ width=50% }
4721- Dimensions may be converted to a form that is compatible with
4722 the output format (for example, dimensions given in pixels will
4723 be converted to inches when converting HTML to LaTeX). Conversion
4724 between pixels and physical measurements is affected by the
4725 `--dpi` option (by default, 96 dpi is assumed, unless the image
4726 itself contains dpi information).
4727- The `%` unit is generally relative to some available space.
4728 For example the above example will render to the following.
4729 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4730 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4731 (If you're using a custom template, you need to configure `graphicx`
4732 as in the default template.)
4733 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4734- Some output formats have a notion of a class
4735 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4736 or a unique identifier (LaTeX `\caption`), or both (HTML).
4737- When no `width` or `height` attributes are specified, the fallback
4738 is to look at the image resolution and the dpi metadata embedded in
4743Using the `native_divs` and `native_spans` extensions
4744(see [above][Extension: `native_divs`]), HTML syntax can
4745be used as part of markdown to create native `Div` and `Span`
4746elements in the pandoc AST (as opposed to raw HTML).
4747However, there is also nicer syntax available:
4749#### Extension: `fenced_divs` ####
4751Allow special fenced syntax for native `Div` blocks. A Div
4752starts with a fence containing at least three consecutive
4753colons plus some attributes. The attributes may optionally
4754be followed by another string of consecutive colons.
4755The attribute syntax is exactly as in fenced code blocks (see
4756[Extension: `fenced_code_attributes`]). As with fenced
4757code blocks, one can use either attributes in curly braces
4758or a single unbraced word, which will be treated as a class
4759name. The Div ends with another line containing a string of at
4760least three consecutive colons. The fenced Div should be
4761separated by blank lines from preceding and following blocks.
4765 ::::: {#special .sidebar}
4766 Here is a paragraph.
4771Fenced divs can be nested. Opening fences are distinguished
4772because they *must* have attributes:
4778 This is a warning within a warning.
4782Fences without attributes are always closing fences. Unlike
4783with fenced code blocks, the number of colons in the closing
4784fence need not match the number in the opening fence. However,
4785it can be helpful for visual clarity to use fences of different
4786lengths to distinguish nested divs from their parents.
4789#### Extension: `bracketed_spans` ####
4791A bracketed sequence of inlines, as one would use to begin
4792a link, will be treated as a `Span` with attributes if it is
4793followed immediately by attributes:
4795 [This is *some text*]{.class key="val"}
4799#### Extension: `footnotes` ####
4801Pandoc's Markdown allows footnotes, using the following syntax:
4803 Here is a footnote reference,[^1] and another.[^longnote]
4805 [^1]: Here is the footnote.
4807 [^longnote]: Here's one with multiple blocks.
4809 Subsequent paragraphs are indented to show that they
4810 belong to the previous footnote.
4814 The whole paragraph can be indented, or just the first
4815 line. In this way, multi-paragraph footnotes work like
4816 multi-paragraph list items.
4818 This paragraph won't be part of the note, because it
4821The identifiers in footnote references may not contain spaces, tabs,
4822or newlines. These identifiers are used only to correlate the
4823footnote reference with the note itself; in the output, footnotes
4824will be numbered sequentially.
4826The footnotes themselves need not be placed at the end of the
4827document. They may appear anywhere except inside other block elements
4828(lists, block quotes, tables, etc.). Each footnote should be
4829separated from surrounding content (including other footnotes)
4832#### Extension: `inline_notes` ####
4834Inline footnotes are also allowed (though, unlike regular notes,
4835they cannot contain multiple paragraphs). The syntax is as follows:
4837 Here is an inline note.^[Inlines notes are easier to write, since
4838 you don't have to pick an identifier and move down to type the
4841Inline and regular footnotes may be mixed freely.
4845#### Extension: `citations` ####
4847Markdown citations go inside square brackets and are separated
4848by semicolons. Each citation must have a key, composed of '@' +
4849the citation identifier from the database, and may optionally
4850have a prefix, a locator, and a suffix. The citation key must
4851begin with a letter, digit, or `_`, and may contain
4852alphanumerics, `_`, and internal punctuation characters
4853(`:.#$%&-+?<>~/`). Here are some examples:
4855 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4857 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4859 Blah blah [@smith04; @doe99].
4861`pandoc` detects locator terms in the [CSL locale files].
4862Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4863locale, locator terms can be written in either singular or plural forms,
4864as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4865`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4866`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4867`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4868`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4869`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4870locator term is used, "page" is assumed.
4872`pandoc` will use heuristics to distinguish the locator
4873from the suffix. In complex cases, the locator can be enclosed
4876 [@smith{ii, A, D-Z}, with a suffix]
4877 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4879A minus sign (`-`) before the `@` will suppress mention of
4880the author in the citation. This can be useful when the
4881author is already mentioned in the text:
4883 Smith says blah [-@smith04].
4885You can also write an in-text citation, as follows:
4889 @smith04 [p. 33] says blah.
4892[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4893[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4894[Chicago Manual of Style]: https://chicagomanualofstyle.org
4895[Citation Style Language]: https://citationstyles.org
4896[Zotero Style Repository]: https://www.zotero.org/styles
4897[finding and editing styles]: https://citationstyles.org/authors/
4898[CSL locale files]: https://github.com/citation-style-language/locales
4900## Non-pandoc extensions
4902The following Markdown syntax extensions are not enabled by default
4903in pandoc, but may be enabled by adding `+EXTENSION` to the format
4904name, where `EXTENSION` is the name of the extension. Thus, for
4905example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4907#### Extension: `attributes` ####
4909Allows attributes to be attached to any inline or block-level
4910element. The syntax for the attributes is the same as that
4911used in [`header_attributes`][Extension: `header_attributes`].
4913- Attributes that occur immediately after an inline
4914 element affect that element. If they follow a space, then they
4915 belong to the space. (Hence, this option subsumes
4916 `inline_code_attributes` and `link_attributes`.)
4917- Attributes that occur immediately before a block
4918 element, on a line by themselves, affect that
4920- Consecutive attribute specifiers may be used,
4921 either for blocks or for inlines. Their attributes
4923- Attributes that occur at the end of the text of
4924 a Setext or ATX heading (separated by whitespace
4925 from the text) affect the heading element. (Hence, this
4926 option subsumes `header_attributes`.)
4927- Attributes that occur after the opening fence
4928 in a fenced code block affect the code block element. (Hence,
4929 this option subsumes `fenced_code_attributes`.)
4930- Attributes that occur at the end of a reference
4931 link definition affect links that refer to that
4934Note that pandoc's AST does not currently allow attributes
4935to be attached to arbitrary elements. Hence a Span or Div
4936container will be added if needed.
4938#### Extension: `old_dashes` ####
4940Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4941`-` before a numeral is an en-dash, and `--` is an em-dash.
4942This option only has an effect if `smart` is enabled. It is
4943selected automatically for `textile` input.
4945#### Extension: `angle_brackets_escapable` ####
4947Allow `<` and `>` to be backslash-escaped, as they can be in
4948GitHub flavored Markdown but not original Markdown. This is
4949implied by pandoc's default `all_symbols_escapable`.
4951#### Extension: `lists_without_preceding_blankline` ####
4953Allow a list to occur right after a paragraph, with no intervening
4956#### Extension: `four_space_rule` ####
4958Selects the pandoc <= 2.0 behavior for parsing lists, so that
4959four spaces indent are needed for list item continuation
4962#### Extension: `spaced_reference_links` ####
4964Allow whitespace between the two components of a reference link,
4969#### Extension: `hard_line_breaks` ####
4971Causes all newlines within a paragraph to be interpreted as hard line
4972breaks instead of spaces.
4974#### Extension: `ignore_line_breaks` ####
4976Causes newlines within a paragraph to be ignored, rather than being
4977treated as spaces or as hard line breaks. This option is intended for
4978use with East Asian languages where spaces are not used between words,
4979but text is divided into lines for readability.
4981#### Extension: `east_asian_line_breaks` ####
4983Causes newlines within a paragraph to be ignored, rather than
4984being treated as spaces or as hard line breaks, when they occur
4985between two East Asian wide characters. This is a better choice
4986than `ignore_line_breaks` for texts that include a mix of East
4987Asian wide characters and other characters.
4989#### Extension: `emoji` ####
4991Parses textual emojis like `:smile:` as Unicode emoticons.
4993#### Extension: `tex_math_single_backslash` ####
4995Causes anything between `\(` and `\)` to be interpreted as inline
4996TeX math, and anything between `\[` and `\]` to be interpreted
4997as display TeX math. Note: a drawback of this extension is that
4998it precludes escaping `(` and `[`.
5000#### Extension: `tex_math_double_backslash` ####
5002Causes anything between `\\(` and `\\)` to be interpreted as inline
5003TeX math, and anything between `\\[` and `\\]` to be interpreted
5006#### Extension: `markdown_attribute` ####
5008By default, pandoc interprets material inside block-level tags as Markdown.
5009This extension changes the behavior so that Markdown is only parsed
5010inside block-level tags if the tags have the attribute `markdown=1`.
5012#### Extension: `mmd_title_block` ####
5014Enables a [MultiMarkdown] style title block at the top of
5015the document, for example:
5019 Date: September 1, 2008
5020 Comment: This is a sample mmd title block, with
5021 a field spanning multiple lines.
5023See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5024`yaml_metadata_block` is enabled, it will take precedence over
5027#### Extension: `abbreviations` ####
5029Parses PHP Markdown Extra abbreviation keys, like
5031 *[HTML]: Hypertext Markup Language
5033Note that the pandoc document model does not support
5034abbreviations, so if this extension is enabled, abbreviation keys are
5035simply skipped (as opposed to being parsed as paragraphs).
5037#### Extension: `autolink_bare_uris` ####
5039Makes all absolute URIs into links, even when not surrounded by
5040pointy braces `<...>`.
5042#### Extension: `mmd_link_attributes` ####
5044Parses multimarkdown style key-value attributes on link
5045and image references. This extension should not be confused with the
5046[`link_attributes`](#extension-link_attributes) extension.
5048 This is a reference ![image][ref] with multimarkdown attributes.
5050 [ref]: https://path.to/image "Image title" width=20px height=30px
5051 id=myId class="myClass1 myClass2"
5053#### Extension: `mmd_header_identifiers` ####
5055Parses multimarkdown style heading identifiers (in square brackets,
5056after the heading but before any trailing `#`s in an ATX heading).
5058#### Extension: `compact_definition_lists` ####
5060Activates the definition list syntax of pandoc 1.12.x and earlier.
5061This syntax differs from the one described above under [Definition lists]
5064 - No blank line is required between consecutive items of the
5066 - To get a "tight" or "compact" list, omit space between consecutive
5067 items; the space between a term and its definition does not affect
5069 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5070 be indented four spaces.[^6]
5072[^6]: To see why laziness is incompatible with relaxing the requirement
5073 of a blank line between items, consider the following example:
5080 Is this a single list item with two definitions of "bar," the first of
5081 which is lazily wrapped, or two list items? To remove the ambiguity
5082 we must either disallow lazy wrapping or require a blank line between
5085#### Extension: `gutenberg` ####
5087Use [Project Gutenberg] conventions for `plain` output:
5088all-caps for strong emphasis, surround by underscores
5089for regular emphasis, add extra blank space around headings.
5091 [Project Gutenberg]: https://www.gutenberg.org
5095In addition to pandoc's extended Markdown, the following Markdown
5096variants are supported:
5098- `markdown_phpextra` (PHP Markdown Extra)
5099- `markdown_github` (deprecated GitHub-Flavored Markdown)
5100- `markdown_mmd` (MultiMarkdown)
5101- `markdown_strict` (Markdown.pl)
5102- `commonmark` (CommonMark)
5103- `gfm` (Github-Flavored Markdown)
5104- `commonmark_x` (CommonMark with many pandoc extensions)
5106To see which extensions are supported for a given format,
5107and which are enabled by default, you can use the command
5109 pandoc --list-extensions=FORMAT
5111where `FORMAT` is replaced with the name of the format.
5113Note that the list of extensions for `commonmark`,
5114`gfm`, and `commonmark_x` are defined relative to default
5115commonmark. So, for example, `backtick_code_blocks`
5116does not appear as an extension, since it is enabled by
5117default and cannot be disabled.
5121When the `--citeproc` option is used, pandoc can automatically generate
5122citations and a bibliography in a number of styles. Basic usage is
5124 pandoc --citeproc myinput.txt
5126To use this feature, you will need to have
5128- a document containing citations (see [Extension: `citations`]);
5129- a source of bibliographic data: either an external bibliography
5130 file or a list of `references` in the document's YAML metadata
5131- optionally, a [CSL] citation style.
5133## Specifying bibliographic data
5135You can specify an external bibliography using the
5136`bibliography` metadata field in a YAML metadata section or the
5137`--bibliography` command line argument. If you want to use
5138multiple bibliography files, you can supply multiple
5139`--bibliography` arguments or set `bibliography` metadata field
5140to YAML array. A bibliography may have any of these formats:
5142 Format File extension
5143 ------------ --------------
5149Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5150use the extension `.bibtex` to force interpretation as BibTeX.
5152In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5153inside fields such as `title`; in CSL YAML databases, pandoc
5154Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5163`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5172`<span class="nocase">...</span>`
5173: prevent a phrase from being capitalized as title case
5175As an alternative to specifying a bibliography file using
5176`--bibliography` or the YAML metadata field `bibliography`, you
5177can include the citation data directly in the `references` field
5178of the document's YAML metadata. The field should contain an
5179array of YAML-encoded references, for example:
5183 - type: article-journal
5195 title: 'Molecular structure of nucleic acids: a structure for
5196 deoxyribose nucleic acid'
5197 title-short: Molecular structure of nucleic acids
5198 container-title: Nature
5202 DOI: 10.1038/171737a0
5203 URL: https://www.nature.com/articles/171737a0
5207Note that `pandoc` can be used to produce such a YAML metadata
5208section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5210 pandoc chem.bib -s -f biblatex -t markdown
5211 pandoc chem.json -s -f csljson -t markdown
5213`pandoc` can also be used to produce CSL JSON bibliography
5214from BibTeX, BibLaTeX, or markdown YAML:
5216 pandoc chem.bib -s -f biblatex -t csljson
5217 pandoc chem.yaml -s -f markdown -t csljson
5219Running pandoc on a bibliography file with the `--citeproc`
5220option will create a formatted bibliography in the format
5223 pandoc chem.bib -s --citeproc -o chem.html
5224 pandoc chem.bib -s --citeproc -o chem.pdf
5226### Capitalization in titles
5228If you are using a bibtex or biblatex bibliography, then observe
5231 - English titles should be in title case. Non-English titles should
5232 be in sentence case, and the `langid` field in biblatex should be
5233 set to the relevant language. (The following values are treated
5234 as English: `american`, `british`, `canadian`, `english`,
5235 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5237 - As is standard with bibtex/biblatex, proper names should be
5238 protected with curly braces so that they won't be lowercased
5239 in styles that call for sentence case. For example:
5241 title = {My Dinner with {Andre}}
5243 - In addition, words that should remain lowercase (or camelCase)
5244 should be protected:
5246 title = {Spin Wave Dispersion on the {nm} Scale}
5248 Though this is not necessary in bibtex/biblatex, it is necessary
5249 with citeproc, which stores titles internally in sentence case,
5250 and converts to title case in styles that require it. Here we
5251 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5253If you are using a CSL bibliography (either JSON or YAML), then observe
5256 - All titles should be in sentence case.
5258 - Use the `language` field for non-English titles to prevent their
5259 conversion to title case in styles that call for this. (Conversion
5260 happens only if `language` begins with `en` or is left empty.)
5262 - Protect words that should not be converted to title case using
5265 Spin wave dispersion on the <span class="nocase">nm</span> scale
5267### Conference Papers, Published vs. Unpublished
5269For a formally published conference paper, use the biblatex entry type
5270`inproceedings` (which will be mapped to CSL `paper-conference`).
5272For an unpublished manuscript, use the biblatex entry type
5273`unpublished` without an `eventtitle` field (this entry type
5274will be mapped to CSL `manuscript`).
5276For a talk, an unpublished conference paper, or a poster
5277presentation, use the biblatex entry type `unpublished` with an
5278`eventtitle` field (this entry type will be mapped to CSL
5279`speech`). Use the biblatex `type` field to indicate the type,
5280e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5281too, though `eventdate` will not be rendered by most CSL styles.
5282Note that `venue` is for the event's venue, unlike `location`
5283which describes the publisher's location; do not use the latter
5284for an unpublished conference paper.
5287## Specifying a citation style
5289Citations and references can be formatted using any style supported by the
5290[Citation Style Language], listed in the [Zotero Style Repository].
5291These files are specified using the `--csl` option or the `csl`
5292(or `citation-style`) metadata field. By default, pandoc will
5293use the [Chicago Manual of Style] author-date format. (You can
5294override this default by copying a CSL style of your choice
5295to `default.csl` in your user data directory.)
5296The CSL project provides further information on [finding and
5299The `--citation-abbreviations` option (or the
5300`citation-abbreviations` metadata field) may be used to specify
5301a JSON file containing abbreviations of journals that should be
5302used in formatted bibliographies when `form="short"` is
5303specified. The format of the file can be illustrated with an
5308 "container-title": {
5309 "Lloyd's Law Reports": "Lloyd's Rep",
5310 "Estates Gazette": "EG",
5311 "Scots Law Times": "SLT"
5316## Raw content in a style
5318To include raw content in a prefix, suffix, delimiter, or term,
5319surround it with these tags indicating the format:
5321 {{jats}}<ref>{{/jats}}
5323Without the tags, the string will be interpreted as a string
5324and escaped in the output, rather than being passed through raw.
5326This feature allows stylesheets to be customized to give
5327different output for different output formats. However,
5328stylesheets customized in this way will not be usable
5329by other CSL implementations.
5333## Placement of the bibliography
5335If the style calls for a list of works cited, it will be placed
5336in a div with id `refs`, if one exists:
5341Otherwise, it will be placed at the end of the document.
5342Generation of the bibliography can be suppressed by setting
5343`suppress-bibliography: true` in the YAML metadata.
5345If you wish the bibliography to have a section heading, you can
5346set `reference-section-title` in the metadata, or put the heading
5347at the beginning of the div with id `refs` (if you are using it)
5348or at the end of your document:
5354The bibliography will be inserted after this heading. Note that
5355the `unnumbered` class will be added to this heading, so that the
5356section will not be numbered.
5358## Including uncited items in the bibliography
5360If you want to include items in the bibliography without actually
5361citing them in the body text, you can define a dummy `nocite` metadata
5362field and put the citations there:
5371In this example, the document will contain a citation for `item3`
5372only, but the bibliography will contain entries for `item1`, `item2`, and
5375It is possible to create a bibliography with all the citations,
5376whether or not they appear in the document, by using a wildcard:
5383For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5384render the bibliography. In order to do so, specify bibliography
5385files as outlined above, and add `--natbib` or `--biblatex`
5386argument to `pandoc` invocation. Bear in mind that bibliography
5387files have to be in either BibTeX (for `--natbib`)
5388or BibLaTeX (for `--biblatex`) format.
5390## Other relevant metadata fields
5392A few other metadata fields affect bibliography formatting:
5395: If true, citations will be
5396 hyperlinked to the corresponding bibliography entries
5397 (for author-date and numerical styles only).
5400: The `lang` field will affect how the style is localized,
5401 for example in the translation of labels and the use
5402 of quotation marks. (For backwards compatibility,
5403 `locale` may be used instead of `lang`, but this use
5406`notes-after-punctuation`
5407: If true (the default), pandoc will put footnote citations
5408 after following punctuation. For example, if the source
5409 contains `blah blah [@jones99].`, the result will look like
5410 `blah blah.[^1]`, with the note moved after the period and
5411 the space collapsed. If false, the space will still be
5412 collapsed, but the footnote will not be moved after the
5424You can use pandoc to produce an HTML + JavaScript slide presentation
5425that can be viewed via a web browser. There are five ways to do this,
5426using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5427You can also produce a PDF slide show using LaTeX [`beamer`], or
5428slides shows in Microsoft [PowerPoint] format.
5430Here's the Markdown source for a simple slide show, `habits.txt`:
5457 
5464To produce an HTML/JavaScript slide show, simply type
5466 pandoc -t FORMAT -s habits.txt -o habits.html
5468where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5470For Slidy, Slideous, reveal.js, and S5, the file produced by
5471pandoc with the `-s/--standalone` option embeds a link to
5472JavaScript and CSS files, which are assumed to be available at
5473the relative path `s5/default` (for S5), `slideous` (for
5474Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5475at `w3.org` (for Slidy). (These paths can be changed by setting
5476the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5477variables; see [Variables for HTML slides], above.) For
5478DZSlides, the (relatively short) JavaScript and CSS are included
5479in the file by default.
5481With all HTML slide formats, the `--self-contained` option can
5482be used to produce a single file that contains all of the data
5483necessary to display the slide show, including linked scripts,
5484stylesheets, images, and videos.
5486To produce a PDF slide show using beamer, type
5488 pandoc -t beamer habits.txt -o habits.pdf
5490Note that a reveal.js slide show can also be converted to a PDF
5491by printing it to a file from the browser.
5493To produce a Powerpoint slide show, type
5495 pandoc habits.txt -o habits.pptx
5497## Structuring the slide show
5499By default, the *slide level* is the highest heading level in
5500the hierarchy that is followed immediately by content, and not another
5501heading, somewhere in the document. In the example above, level-1 headings
5502are always followed by level-2 headings, which are followed by content,
5503so the slide level is 2. This default can be overridden using
5504the `--slide-level` option.
5506The document is carved up into slides according to the following
5509 * A horizontal rule always starts a new slide.
5511 * A heading at the slide level always starts a new slide.
5513 * Headings *below* the slide level in the hierarchy create
5514 headings *within* a slide.
5516 * Headings *above* the slide level in the hierarchy create
5517 "title slides," which just contain the section title
5518 and help to break the slide show into sections.
5519 Non-slide content under these headings will be included
5520 on the title slide (for HTML slide shows) or in a
5521 subsequent slide with the same title (for beamer).
5523 * A title page is constructed automatically from the document's title
5524 block, if present. (In the case of beamer, this can be disabled
5525 by commenting out some lines in the default template.)
5527These rules are designed to support many different styles of slide show. If
5528you don't care about structuring your slides into sections and subsections,
5529you can just use level-1 headings for all each slide. (In that case, level-1
5530will be the slide level.) But you can also structure the slide show into
5531sections, as in the example above.
5533Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5534layout will be produced, with level-1 headings building horizontally
5535and level-2 headings building vertically. It is not recommended that
5536you use deeper nesting of section levels with reveal.js.
5540By default, these writers produce lists that display "all at once."
5541If you want your lists to display incrementally (one item at a time),
5542use the `-i` option. If you want a particular list to depart from the
5543default, put it in a `div` block with class `incremental` or
5544`nonincremental`. So, for example, using the `fenced div` syntax, the
5545following would be incremental regardless of the document default:
5563While using `incremental` and `nonincremental` divs are the
5564recommended method of setting incremental lists on a per-case basis,
5565an older method is also supported: putting lists inside a blockquote
5566will depart from the document default (that is, it will display
5567incrementally without the `-i` option and all at once with the `-i`
5573Both methods allow incremental and nonincremental lists to be mixed
5574in a single document.
5576Note: Neither the `-i/--incremental` option nor any of the
5577methods described here currently works for PowerPoint output.
5581You can add "pauses" within a slide by including a paragraph containing
5582three dots, separated by spaces:
5584 # Slide with a pause
5586 content before the pause
5590 content after the pause
5592Note: this feature is not yet implemented for PowerPoint output.
5594## Styling the slides
5596You can change the style of HTML slides by putting customized CSS files
5597in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5598or `$DATADIR/slideous` (for Slideous),
5599where `$DATADIR` is the user data directory (see `--data-dir`, above).
5600The originals may be found in pandoc's system data directory (generally
5601`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5602files it does not find in the user data directory.
5604For dzslides, the CSS is included in the HTML file itself, and may
5607All [reveal.js configuration options] can be set through variables.
5608For example, themes can be used by setting the `theme` variable:
5612Or you can specify a custom stylesheet using the `--css` option.
5614To style beamer slides, you can specify a `theme`, `colortheme`,
5615`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5617 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5619Note that heading attributes will turn into slide attributes
5620(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5621to style individual slides. In beamer, the only heading attribute
5622that affects slides is the `allowframebreaks` class, which sets the
5623`allowframebreaks` option, causing multiple slides to be created
5624if the content overfills the frame. This is recommended especially for
5627 # References {.allowframebreaks}
5631Speaker notes are supported in reveal.js and PowerPoint (pptx)
5632output. You can add notes to your Markdown document thus:
5638 - It can contain Markdown
5643To show the notes window in reveal.js, press `s` while viewing the
5644presentation. Speaker notes in PowerPoint will be available, as usual,
5645in handouts and presenter view.
5647Notes are not yet supported for other slide formats, but the notes
5648will not appear on the slides themselves.
5652To put material in side by side columns, you can use a native
5653div container with class `columns`, containing two or more div
5654containers with class `column` and a `width` attribute:
5656 :::::::::::::: {.columns}
5657 ::: {.column width="40%"}
5660 ::: {.column width="60%"}
5665### Additional columns attributes in beamer
5667The div containers with classes `columns` and `column` can optionally have
5668an `align` attribute.
5669The class `columns` can optionally have a `totalwidth` attribute or an
5670`onlytextwidth` class.
5672 :::::::::::::: {.columns align=center totalwidth=8em}
5673 ::: {.column width="40%"}
5676 ::: {.column width="60%" align=bottom}
5681The `align` attributes on `columns` and `column` can be used with the
5682values `top`, `top-baseline`, `center` and `bottom` to vertically align
5683the columns. It defaults to `top` in `columns`.
5685The `totalwidth` attribute limits the width of the columns to the given value.
5687 :::::::::::::: {.columns align=top .onlytextwidth}
5688 ::: {.column width="40%" align=center}
5691 ::: {.column width="60%"}
5696The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5698See Section 12.7 of the [Beamer User's Guide] for more details.
5700## Frame attributes in beamer
5702Sometimes it is necessary to add the LaTeX `[fragile]` option to
5703a frame in beamer (for example, when using the `minted` environment).
5704This can be forced by adding the `fragile` class to the heading
5705introducing the slide:
5707 # Fragile slide {.fragile}
5709All of the other frame attributes described in Section 8.1 of
5710the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5711`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5712`shrink`, `standout`, `noframenumbering`.
5714## Background in reveal.js and beamer
5716Background images can be added to self-contained reveal.js slideshows and
5717to beamer slideshows.
5719For the same image on every slide, use the configuration
5720option `background-image` either in the YAML metadata block
5721or as a command-line variable. (There are no other options in
5722beamer and the rest of this section concerns reveal.js slideshows.)
5724For reveal.js, you can instead use the reveal.js-native option
5725`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5726and `parallaxBackgroundVertical` the same way and must also set
5727`parallaxBackgroundSize` to have your values take effect.
5729To set an image for a particular reveal.js slide, add
5730`{data-background-image="/path/to/image"}`
5731to the first slide-level heading on the slide (which may even be empty).
5733In reveal.js's overview mode, the parallaxBackgroundImage will show up
5734only on the first slide.
5736Other reveal.js background settings also work on individual slides, including
5737`data-background-size`, `data-background-repeat`, `data-background-color`,
5738`data-transition`, and `data-transition-speed`.
5740To add a background image to the automatically generated title slide, use the
5741`title-slide-attributes` variable in the YAML metadata block. It must contain
5742a map of attribute names and values.
5744See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5747For example in reveal.js:
5752parallaxBackgroundImage: /path/to/my/background_image.png
5753title-slide-attributes:
5754 data-background-image: /path/to/title_image.png
5755 data-background-size: contain
5760Slide 1 has background_image.png as its background.
5762## {data-background-image="/path/to/special_image.jpg"}
5764Slide 2 has a special image for its background, even though the heading has no content.
5771EPUB metadata may be specified using the `--epub-metadata` option, but
5772if the source document is Markdown, it is better to use a [YAML metadata
5773block][Extension: `yaml_metadata_block`]. Here is an example:
5780 text: An investigation of metadata
5788 text: doi:10.234234.234/33
5790 rights: © 2007 John Smith, CC BY-NC
5795The following fields are recognized:
5798 ~ Either a string value or an object with fields `text` and
5799 `scheme`. Valid values for `scheme` are `ISBN-10`,
5800 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5801 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5802 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5805 ~ Either a string value, or an object with fields `file-as` and
5806 `type`, or a list of such objects. Valid values for `type` are
5807 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5810 ~ Either a string value, or an object with fields `role`, `file-as`,
5811 and `text`, or a list of such objects. Valid values for `role` are
5812 [MARC relators], but
5813 pandoc will attempt to translate the human-readable versions
5814 (like "author" and "editor") to the appropriate marc relators.
5817 ~ Same format as `creator`.
5820 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5821 Pandoc will attempt to convert other common date formats.
5823`lang` (or legacy: `language`)
5824 ~ A string value in [BCP 47] format. Pandoc will default to the local
5825 language if nothing is specified.
5828 ~ A string value or a list of such values.
5849 ~ A string value (path to cover image).
5851`css` (or legacy: `stylesheet`)
5852 ~ A string value (path to CSS stylesheet).
5854`page-progression-direction`
5855 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5856 attribute for the [`spine` element].
5859 ~ iBooks-specific metadata, with the following fields:
5861 - `version`: (string)
5862 - `specified-fonts`: `true`|`false` (default `false`)
5863 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5864 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5865 - `binding`: `true`|`false` (default `true`)
5866 - `scroll-axis`: `vertical`|`horizontal`|`default`
5868[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5869[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5871## The `epub:type` attribute
5873For `epub3` output, you can mark up the heading that corresponds to an EPUB
5874chapter using the [`epub:type` attribute][epub-type]. For example, to set
5875the attribute to the value `prologue`, use this markdown:
5877 # My chapter {epub:type=prologue}
5879Which will result in:
5881 <body epub:type="frontmatter">
5882 <section epub:type="prologue">
5885Pandoc will output `<body epub:type="bodymatter">`, unless
5886you use one of the following values, in which case either
5887`frontmatter` or `backmatter` will be output.
5889`epub:type` of first section `epub:type` of body
5890---------------------------- ------------------
5893acknowledgments frontmatter
5894copyright-page frontmatter
5895dedication frontmatter
5899contributors frontmatter
5900other-credits frontmatter
5902revision-history frontmatter
5903titlepage frontmatter
5904halftitlepage frontmatter
5905seriespage frontmatter
5910bibliography backmatter
5913[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5917By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5918`<video>` or `<source>` element present in the generated EPUB,
5919and include it in the EPUB container, yielding a completely
5920self-contained EPUB. If you want to link to external media resources
5921instead, use raw HTML in your source and add `data-external="1"` to the tag
5922with the `src` attribute. For example:
5924 <audio controls="1">
5925 <source src="https://example.com/music/toccata.mp3"
5926 data-external="1" type="audio/mpeg">
5932When creating a [Jupyter notebook], pandoc will try to infer the
5933notebook structure. Code blocks with the class `code` will be
5934taken as code cells, and intervening content will be taken as
5935Markdown cells. Attachments will automatically be created for
5936images in Markdown cells. Metadata will be taken from the
5937`jupyter` metadata field. For example:
5946 display_name: Python 2
5953 file_extension: ".py"
5954 mimetype: "text/x-python"
5956 nbconvert_exporter: "python"
5957 pygments_lexer: "ipython2"
5963**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5964bibendum felis dictum sodales.
5973from IPython.display import HTML
5976console.log("hello");
5984This image  will be
5985included as a cell attachment.
5988If you want to add cell attributes, group cells differently, or
5989add output to code cells, then you need to include divs to
5990indicate the structure. You can use either [fenced
5991divs][Extension: `fenced_divs`] or [native divs][Extension:
5992`native_divs`] for this. Here is an example:
5995:::::: {.cell .markdown}
5998**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5999bibendum felis dictum sodales.
6002:::::: {.cell .code execution_count=1}
6007::: {.output .stream .stdout}
6014:::::: {.cell .code execution_count=2}
6016from IPython.display import HTML
6019console.log("hello");
6025::: {.output .execute_result execution_count=2}
6028console.log("hello");
6037If you include raw HTML or TeX in an output cell, use the
6038[raw attribute][Extension: `fenced_attribute`], as shown
6039in the last cell of the example above. Although pandoc can
6040process "bare" raw HTML and TeX, the result is often
6041interspersed raw elements and normal textual elements, and
6042in an output cell pandoc expects a single, connected raw
6043block. To avoid using raw HTML or TeX except when
6044marked explicitly using raw attributes, we recommend
6045specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6046translating between Markdown and ipynb notebooks.
6048Note that options and extensions that affect reading and
6049writing of Markdown will also affect Markdown cells in ipynb
6050notebooks. For example, `--wrap=preserve` will preserve
6051soft line breaks in Markdown cells; `--atx-headers` will
6052cause ATX-style headings to be used; and `--preserve-tabs` will
6053prevent tabs from being turned to spaces.
6055# Syntax highlighting
6057Pandoc will automatically highlight syntax in [fenced code blocks] that
6058are marked with a language name. The Haskell library [skylighting] is
6059used for highlighting. Currently highlighting is supported only for
6060HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6061that pandoc will recognize, type `pandoc --list-highlight-languages`.
6063The color scheme can be selected using the `--highlight-style` option.
6064The default color scheme is `pygments`, which imitates the default color
6065scheme used by the Python library pygments (though pygments is not actually
6066used to do the highlighting). To see a list of highlight styles,
6067type `pandoc --list-highlight-styles`.
6069If you are not satisfied with the predefined styles, you can
6070use `--print-highlight-style` to generate a JSON `.theme` file which
6071can be modified and used as the argument to `--highlight-style`. To
6072get a JSON version of the `pygments` style, for example:
6074 pandoc --print-highlight-style pygments > my.theme
6076Then edit `my.theme` and use it like this:
6078 pandoc --highlight-style my.theme
6080If you are not satisfied with the built-in highlighting, or you
6081want highlight a language that isn't supported, you can use the
6082`--syntax-definition` option to load a [KDE-style XML syntax definition
6083file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6084Before writing your own, have a look at KDE's [repository of syntax
6085definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6087To disable highlighting, use the `--no-highlight` option.
6089[skylighting]: https://github.com/jgm/skylighting
6093Custom styles can be used in the docx and ICML formats.
6097By default, pandoc's docx and ICML output applies a predefined set of styles
6098for blocks such as paragraphs and block quotes, and uses largely default
6099formatting (italics, bold) for inlines. This will work for most
6100purposes, especially alongside a `reference.docx` file. However, if you
6101need to apply your own styles to blocks, or match a preexisting set of
6102styles, pandoc allows you to define custom styles for blocks and text
6103using `div`s and `span`s, respectively.
6105If you define a `div` or `span` with the attribute `custom-style`,
6106pandoc will apply your specified style to the contained elements (with
6107the exception of elements whose function depends on a style, like
6108headings, code blocks, block quotes, or links). So, for example, using
6109the `bracketed_spans` syntax,
6111 [Get out]{custom-style="Emphatically"}, he said.
6113would produce a docx file with "Get out" styled with character
6114style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6116 Dickinson starts the poem simply:
6118 ::: {custom-style="Poetry"}
6119 | A Bird came down the Walk---
6120 | He did not know I saw---
6123would style the two contained lines with the `Poetry` paragraph style.
6125For docx output, styles will be defined in the output file as inheriting
6126from normal text, if the styles are not yet in your reference.docx.
6127If they are already defined, pandoc will not alter the definition.
6129This feature allows for greatest customization in conjunction with
6130[pandoc filters]. If you want all paragraphs after block quotes to be
6131indented, you can write a filter to apply the styles necessary. If you
6132want all italics to be transformed to the `Emphasis` character style
6133(perhaps to change their color), you can write a filter which will
6134transform all italicized inlines to inlines within an `Emphasis`
6137For docx output, you don't need to enable any extensions for
6138custom styles to work.
6140[pandoc filters]: https://pandoc.org/filters.html
6144The docx reader, by default, only reads those styles that it can
6145convert into pandoc elements, either by direct conversion or
6146interpreting the derivation of the input document's styles.
6148By enabling the [`styles` extension](#ext-styles) in the docx reader
6149(`-f docx+styles`), you can produce output that maintains the styles
6150of the input document, using the `custom-style` class. Paragraph
6151styles are interpreted as divs, while character styles are interpreted
6154For example, using the `custom-style-reference.docx` file in the test
6155directory, we have the following different outputs:
6157Without the `+styles` extension:
6159 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6162 This is text with an *emphasized* text style. And this is text with a
6163 **strengthened** text style.
6165 > Here is a styled paragraph that inherits from Block Text.
6167And with the extension:
6169 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6171 ::: {custom-style="First Paragraph"}
6175 ::: {custom-style="Body Text"}
6176 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6177 And this is text with a [strengthened]{custom-style="Strengthened"}
6181 ::: {custom-style="My Block Style"}
6182 > Here is a styled paragraph that inherits from Block Text.
6185With these custom styles, you can use your input document as a
6186reference-doc while creating docx output (see below), and maintain the
6187same styles in your input and output files.
6191Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6192includes a Lua interpreter, so Lua need not be installed separately.)
6194To use a custom writer, simply specify the path to the Lua script
6195in place of the output format. For example:
6197 pandoc -t data/sample.lua
6199Creating a custom writer requires writing a Lua function for each
6200possible element in a pandoc document. To get a documented example
6201which you can modify according to your needs, do
6203 pandoc --print-default-data-file sample.lua
6205Note that custom writers have no default template. If you want
6206to use `--standalone` with a custom writer, you will need to
6207specify a template manually using `--template` or add a new
6208default template with the name
6209`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6210subdirectory of your user data directory (see [Templates]).
6212[Lua]: https://www.lua.org
6216If you use pandoc to convert user-contributed content in a web
6217application, here are some things to keep in mind:
62191. Although pandoc itself will not create or modify any files other
6220 than those you explicitly ask it create (with the exception
6221 of temporary files used in producing PDFs), a filter or custom
6222 writer could in principle do anything on your file system. Please
6223 audit filters and custom writers very carefully before using them.
62252. If your application uses pandoc as a Haskell library (rather than
6226 shelling out to the executable), it is possible to use it in a mode
6227 that fully isolates pandoc from your file system, by running the
6228 pandoc operations in the `PandocPure` monad. See the document
6229 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
62323. Pandoc's parsers can exhibit pathological performance on some
6233 corner cases. It is wise to put any pandoc operations under
6234 a timeout, to avoid DOS attacks that exploit these issues.
6235 If you are using the pandoc executable, you can add the
6236 command line options `+RTS -M512M -RTS` (for example) to limit
6237 the heap size to 512MB.
62394. The HTML generated by pandoc is not guaranteed to be safe.
6240 If `raw_html` is enabled for the Markdown input, users can
6241 inject arbitrary HTML. Even if `raw_html` is disabled,
6242 users can include dangerous content in attributes for
6243 headings, spans, and code blocks. To be safe, you should
6244 run all the generated HTML through an HTML sanitizer.
6248Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6249under the [GPL], version 2 or greater. This software carries no
6250warranty of any kind. (See COPYRIGHT for full copyright and
6251warranty notices.) For a full list of contributors, see the file
6252AUTHORS.md in the pandoc source code.
6254[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6255[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