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), inserts all insertions, and ignores all
669 deletions. `reject` inserts all deletions and ignores
670 insertions. Both `accept` and `reject` ignore comments. `all` puts
671 in insertions, deletions, and comments, wrapped in spans with
672 `insertion`, `deletion`, `comment-start`, and `comment-end`
673 classes, respectively. The author and time of change is
674 included. `all` is useful for scripting: only accepting changes
675 from a certain reviewer, say, or before a certain date. If a
676 paragraph is inserted or deleted, `track-changes=all` produces a
677 span with the class `paragraph-insertion`/`paragraph-deletion`
678 before the affected paragraph break. This option only affects the
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.
950: Use only ASCII characters in output. Currently supported for XML
951 and HTML formats (which use entities instead of UTF-8 when this
952 option is selected), CommonMark, gfm, and Markdown (which use
953 entities), roff ms (which use hexadecimal escapes), and to a
954 limited degree LaTeX (which uses standard commands for accented
955 characters when possible). roff man output uses ASCII by default.
959: Use reference-style links, rather than inline links, in writing Markdown
960 or reStructuredText. By default inline links are used. The
961 placement of link references is affected by the
962 `--reference-location` option.
964`--reference-location = block`|`section`|`document`
966: Specify whether footnotes (and references, if `reference-links` is
967 set) are placed at the end of the current (top-level) block, the
968 current section, or the document. The default is
969 `document`. Currently only affects the markdown writer.
973: Use ATX-style headings in Markdown output. The default is
974 to use setext-style headings for levels 1 to 2, and then ATX headings.
975 (Note: for `gfm` output, ATX headings are always used.)
976 This option also affects markdown cells in `ipynb` output.
978`--top-level-division=[default|section|chapter|part]`
980: Treat top-level headings as the given division type in LaTeX, ConTeXt,
981 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
982 all headings are shifted such that the top-level heading becomes the specified
983 type. The default behavior is to determine the best division type via
984 heuristics: unless other conditions apply, `section` is chosen. When the
985 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
986 `article` option is specified), `chapter` is implied as the setting for this
987 option. If `beamer` is the output format, specifying either `chapter` or
988 `part` will cause top-level headings to become `\part{..}`, while
989 second-level headings remain as their default type.
991`-N`, `--number-sections`
993: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
994 By default, sections are not numbered. Sections with class
995 `unnumbered` will never be numbered, even if `--number-sections`
998`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
1000: Offset for section headings in HTML output (ignored in other
1001 output formats). The first number is added to the section number for
1002 top-level headings, the second for second-level headings, and so on.
1003 So, for example, if you want the first top-level heading in your
1004 document to be numbered "6", specify `--number-offset=5`.
1005 If your document starts with a level-2 heading which you want to
1006 be numbered "1.5", specify `--number-offset=1,4`.
1007 Offsets are 0 by default. Implies `--number-sections`.
1011: Use the [`listings`] package for LaTeX code blocks. The package
1012 does not support multi-byte encoding for source code. To handle UTF-8
1013 you would need to use a custom template. This issue is fully
1014 documented here: [Encoding issue with the listings package].
1016`-i`, `--incremental`
1018: Make list items in slide shows display incrementally (one by one).
1019 The default is for lists to be displayed all at once.
1021`--slide-level=`*NUMBER*
1023: Specifies that headings with the specified level create
1024 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1025 above this level in the hierarchy are used to divide the
1026 slide show into sections; headings below this level create
1027 subheads within a slide. Note that content that is
1028 not contained under slide-level headings will not appear in
1029 the slide show. The default is to set the slide level based
1030 on the contents of the document; see [Structuring the slide
1035: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1036 and attach identifiers to the enclosing `<section>` (or `<div>`)
1037 rather than the heading itself. See
1038 [Heading identifiers], below.
1040`--email-obfuscation=none`|`javascript`|`references`
1042: Specify a method for obfuscating `mailto:` links in HTML documents.
1043 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1044 them using JavaScript. `references` obfuscates them by printing their
1045 letters as decimal or hexadecimal character references. The default
1048`--id-prefix=`*STRING*
1050: Specify a prefix to be added to all identifiers and internal links
1051 in HTML and DocBook output, and to footnote numbers in Markdown
1052 and Haddock output. This is useful for preventing duplicate
1053 identifiers when generating fragments to be included in other pages.
1055`-T` *STRING*, `--title-prefix=`*STRING*
1057: Specify *STRING* as a prefix at the beginning of the title
1058 that appears in the HTML header (but not in the title as it
1059 appears at the beginning of the HTML body). Implies `--standalone`.
1061`-c` *URL*, `--css=`*URL*
1063: Link to a CSS style sheet. This option can be used repeatedly to
1064 include multiple files. They will be included in the order specified.
1066 A stylesheet is required for generating EPUB. If none is
1067 provided using this option (or the `css` or `stylesheet`
1068 metadata fields), pandoc will look for a file `epub.css` in the
1069 user data directory (see `--data-dir`). If it is not
1070 found there, sensible defaults will be used.
1072`--reference-doc=`*FILE*
1074: Use the specified file as a style reference in producing a
1079 : For best results, the reference docx should be a modified
1080 version of a docx file produced using pandoc. The contents
1081 of the reference docx are ignored, but its stylesheets and
1082 document properties (including margins, page size, header,
1083 and footer) are used in the new docx. If no reference docx
1084 is specified on the command line, pandoc will look for a
1085 file `reference.docx` in the user data directory (see
1086 `--data-dir`). If this is not found either, sensible
1087 defaults will be used.
1089 To produce a custom `reference.docx`, first get a copy of
1090 the default `reference.docx`: `pandoc
1091 -o custom-reference.docx --print-default-data-file reference.docx`.
1092 Then open `custom-reference.docx` in Word, modify the
1093 styles as you wish, and save the file. For best
1094 results, do not make changes to this file other than
1095 modifying the styles used by pandoc:
1131 - Default Paragraph Font
1134 - Footnote Reference
1144 : For best results, the reference ODT should be a modified
1145 version of an ODT produced using pandoc. The contents of
1146 the reference ODT are ignored, but its stylesheets are used
1147 in the new ODT. If no reference ODT is specified on the
1148 command line, pandoc will look for a file `reference.odt` in
1149 the user data directory (see `--data-dir`). If this is not
1150 found either, sensible defaults will be used.
1152 To produce a custom `reference.odt`, first get a copy of
1153 the default `reference.odt`: `pandoc
1154 -o custom-reference.odt --print-default-data-file reference.odt`.
1155 Then open `custom-reference.odt` in LibreOffice, modify
1156 the styles as you wish, and save the file.
1160 : Templates included with Microsoft PowerPoint 2013 (either with
1161 `.pptx` or `.potx` extension) are known to work, as are most
1162 templates derived from these.
1164 The specific requirement is that the template should begin with
1165 the following first four layouts:
1168 2. Title and Content
1172 All templates included with a recent version of MS PowerPoint
1173 will fit these criteria. (You can click on `Layout` under the
1174 `Home` menu to check.)
1176 You can also modify the default `reference.pptx`: first run
1177 `pandoc -o custom-reference.pptx --print-default-data-file
1178 reference.pptx`, and then modify `custom-reference.pptx`
1179 in MS PowerPoint (pandoc will use the first four layout
1180 slides, as mentioned above).
1182`--epub-cover-image=`*FILE*
1184: Use the specified image as the EPUB cover. It is recommended
1185 that the image be less than 1000px in width and height. Note that
1186 in a Markdown source document you can also specify `cover-image`
1187 in a YAML metadata block (see [EPUB Metadata], below).
1189`--epub-metadata=`*FILE*
1191: Look in the specified XML file for metadata for the EPUB.
1192 The file should contain a series of [Dublin Core elements].
1195 <dc:rights>Creative Commons</dc:rights>
1196 <dc:language>es-AR</dc:language>
1198 By default, pandoc will include the following metadata elements:
1199 `<dc:title>` (from the document title), `<dc:creator>` (from the
1200 document authors), `<dc:date>` (from the document date, which should
1201 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1202 variable, or, if is not set, the locale), and `<dc:identifier
1203 id="BookId">` (a randomly generated UUID). Any of these may be
1204 overridden by elements in the metadata file.
1206 Note: if the source document is Markdown, a YAML metadata block
1207 in the document can be used instead. See below under
1210`--epub-embed-font=`*FILE*
1212: Embed the specified font in the EPUB. This option can be repeated
1213 to embed multiple fonts. Wildcards can also be used: for example,
1214 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1215 line, be sure to escape them or put the whole filename in single quotes,
1216 to prevent them from being interpreted by the shell. To use the
1217 embedded fonts, you will need to add declarations like the following
1218 to your CSS (see `--css`):
1221 font-family: DejaVuSans;
1223 font-weight: normal;
1224 src:url("DejaVuSans-Regular.ttf");
1227 font-family: DejaVuSans;
1230 src:url("DejaVuSans-Bold.ttf");
1233 font-family: DejaVuSans;
1235 font-weight: normal;
1236 src:url("DejaVuSans-Oblique.ttf");
1239 font-family: DejaVuSans;
1242 src:url("DejaVuSans-BoldOblique.ttf");
1244 body { font-family: "DejaVuSans"; }
1246`--epub-chapter-level=`*NUMBER*
1248: Specify the heading level at which to split the EPUB into separate
1249 "chapter" files. The default is to split into chapters at level-1
1250 headings. This option only affects the internal composition of the
1251 EPUB, not the way chapters and sections are displayed to users. Some
1252 readers may be slow if the chapter files are too large, so for large
1253 documents with few level-1 headings, one might want to use a chapter
1256`--epub-subdirectory=`*DIRNAME*
1258: Specify the subdirectory in the OCF container that is to hold
1259 the EPUB-specific contents. The default is `EPUB`. To put
1260 the EPUB contents in the top level, use an empty string.
1262`--ipynb-output=all|none|best`
1264: Determines how ipynb output cells are treated. `all` means
1265 that all of the data formats included in the original are
1266 preserved. `none` means that the contents of data cells
1267 are omitted. `best` causes pandoc to try to pick the
1268 richest data block in each output cell that is compatible
1269 with the output format. The default is `best`.
1271`--pdf-engine=`*PROGRAM*
1273: Use the specified engine when producing PDF output.
1274 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1275 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1276 and `pdfroff`. If the engine is not in your PATH, the full
1277 path of the engine may be specified here. If this option
1278 is not specified, pandoc uses the following defaults
1279 depending on the output format specified using `-t/--to`:
1281 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1282 `tectonic`, `latexmk`)
1283 - `-t context`: `context`
1284 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1285 see [print-css.rocks](https://print-css.rocks) for a good
1286 introduction to PDF generation from HTML/CSS.)
1287 - `-t ms`: `pdfroff`
1289`--pdf-engine-opt=`*STRING*
1291: Use the given string as a command-line argument to the `pdf-engine`.
1292 For example, to use a persistent directory `foo` for `latexmk`'s
1293 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1294 Note that no check for duplicate options is done.
1296[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1297[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1298[Encoding issue with the listings package]:
1299 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1301## Citation rendering {.options}
1305: Process the citations in the file, replacing them with
1306 rendered citations and adding a bibliography.
1307 Citation processing will not take place unless bibliographic
1308 data is supplied, either through an external file specified
1309 using the `--bibliography` option or the `bibliography`
1310 field in metadata, or via a `references` section in metadata
1311 containing a list of citations in CSL YAML format with
1312 Markdown formatting. The style is controlled by a [CSL]
1313 stylesheet specified using the `--csl` option or the `csl`
1314 field in metadata. (If no stylesheet is specified,
1315 the `chicago-author-date` style will be used by default.)
1316 The citation processing transformation may be applied before
1317 or after filters or Lua filters (see `--filter`,
1318 `--lua-filter`): these transformations are applied in the
1319 order they appear on the command line. For more
1320 information, see the section on [Citations].
1322`--bibliography=`*FILE*
1324: Set the `bibliography` field in the document's metadata to *FILE*,
1325 overriding any value set in the metadata. If you supply
1326 this argument multiple times, each *FILE* will be added to
1331: Set the `csl` field in the document's metadata to *FILE*,
1332 overriding any value set in the metadata. (This is equivalent to
1333 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1334 fetched via HTTP. If *FILE* is not found relative to the
1335 working directory, it will be sought in the resource path
1336 and finally in the `csl` subdirectory of the
1337 pandoc user data directory.
1339`--citation-abbreviations=`*FILE*
1341: Set the `citation-abbreviations` field in the document's metadata to
1342 *FILE*, overriding any value set in the metadata. (This is equivalent to
1343 `--metadata citation-abbreviations=FILE`.)
1344 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1345 found relative to the working directory, it will be sought
1346 in the resource path and finally in the `csl` subdirectory
1347 of the pandoc user data directory.
1351: Use [`natbib`] for citations in LaTeX output. This option is not for use
1352 with the `--citeproc` option or with PDF output. It is intended for
1353 use in producing a LaTeX file that can be processed with [`bibtex`].
1357: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1358 with the `--citeproc` option or with PDF output. It is intended for
1359 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1361## Math rendering in HTML {.options}
1363The default is to render TeX math as far as possible using Unicode characters.
1364Formulas are put inside a `span` with `class="math"`, so that they may be styled
1365differently from the surrounding text if needed. However, this gives acceptable
1366results only for basic math, usually you will want to use `--mathjax` or another
1367of the following options.
1369`--mathjax`[`=`*URL*]
1371: Use [MathJax] to display embedded TeX math in HTML output.
1372 TeX math will be put between `\(...\)` (for inline math)
1373 or `\[...\]` (for display math) and wrapped in `<span>` tags
1374 with class `math`. Then the MathJax JavaScript will render it.
1375 The *URL* should point to the `MathJax.js` load script.
1376 If a *URL* is not provided, a link to the Cloudflare CDN will
1381: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1382 `html4` and `html5`). This is the default in `odt` output. Note that
1383 currently only Firefox and Safari (and select e-book readers) natively
1388: Convert TeX formulas to `<img>` tags that link to an external script
1389 that converts formulas to images. The formula will be URL-encoded
1390 and concatenated with the URL provided. For SVG images you can for
1391 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1392 If no URL is specified, the CodeCogs URL generating PNGs
1393 will be used (`https://latex.codecogs.com/png.latex?`).
1394 Note: the `--webtex` option will affect Markdown output
1395 as well as HTML, which is useful if you're targeting a
1396 version of Markdown without native math support.
1400: Use [KaTeX] to display embedded TeX math in HTML output.
1401 The *URL* is the base URL for the KaTeX library. That directory
1402 should contain a `katex.min.js` and a `katex.min.css` file.
1403 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1407: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1408 can then be processed by [GladTeX] to produce images of the typeset
1409 formulas and an HTML file with links to these images.
1410 So, the procedure is:
1412 pandoc -s --gladtex input.md -o myfile.htex
1413 gladtex -d myfile-images myfile.htex
1414 # produces myfile.html and images in myfile-images
1416[MathML]: https://www.w3.org/Math/
1417[MathJax]: https://www.mathjax.org
1418[KaTeX]: https://github.com/Khan/KaTeX
1419[GladTeX]: https://humenda.github.io/GladTeX/
1421## Options for wrapper scripts {.options}
1425: Print information about command-line arguments to *stdout*, then exit.
1426 This option is intended primarily for use in wrapper scripts.
1427 The first line of output contains the name of the output file specified
1428 with the `-o` option, or `-` (for *stdout*) if no output file was
1429 specified. The remaining lines contain the command-line arguments,
1430 one per line, in the order they appear. These do not include regular
1431 pandoc options and their arguments, but do include any options appearing
1432 after a `--` separator at the end of the line.
1436: Ignore command-line arguments (for use in wrapper scripts).
1437 Regular pandoc options are not ignored. Thus, for example,
1439 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1443 pandoc -o foo.html -s
1447If pandoc completes successfully, it will return exit code 0.
1448Nonzero exit codes have the following meanings:
1451----- ------------------------------------
1452 3 PandocFailOnWarningError
1454 5 PandocTemplateError
1456 21 PandocUnknownReaderError
1457 22 PandocUnknownWriterError
1458 23 PandocUnsupportedExtensionError
1459 24 PandocCiteprocError
1460 31 PandocEpubSubdirectoryError
1462 47 PandocPDFProgramNotFoundError
1464 62 PandocShouldNeverHappenError
1467 65 PandocParsecError
1468 66 PandocMakePDFError
1469 67 PandocSyntaxMapError
1470 83 PandocFilterError
1472 92 PandocUTF8DecodingError
1473 93 PandocIpynbDecodingError
1474 97 PandocCouldNotFindDataFileError
1475 99 PandocResourceNotFound
1476----- ------------------------------------
1480The `--defaults` option may be used to specify a package
1481of options. Here is a sample defaults file demonstrating all of
1482the fields that may be used:
1486# reader: may be used instead of from:
1488# writer: may be used instead of to:
1490# leave blank for output to stdout:
1492# leave blank for input from stdin, use [] for no input:
1496# or you may use input-file: with a single value
1500self-contained: false
1502# note that structured variables may be specified:
1509# metadata values specified here are parsed as literal
1510# string text, not markdown:
1517# or you may use metadata-file: with a single value
1519# Note that these take files, not their contents:
1520include-before-body: []
1521include-after-body: []
1522include-in-header: []
1525# turn on built-in citation processing. Note that if you need
1526# control over when the citeproc processing is done relative
1527# to other filters, you should instead use `citeproc` in the
1528# list of `filters` (see below).
1535# Filters will be assumed to be Lua filters if they have
1536# the .lua extension, and json filters otherwise. But
1537# the filter type can also be specified explicitly, as shown.
1538# Filters are run in the order specified.
1539# To include the built-in citeproc filter, use either `citeproc`
1540# or `{type: citeproc}`.
1550# ERROR, WARNING, or INFO
1554# citeproc, natbib, or biblatex
1555cite-method: citeproc
1556# part, chapter, section, or default:
1557top-level-division: chapter
1563# you may also use pdf-engine-opt: with a single option
1564# pdf-engine-opt: "-shell-escape"
1566# auto, preserve, or none
1571extract-media: mediadir
1573table-of-contents: true
1575number-sections: false
1576# a list of offsets at each heading level
1577number-offset: [0,0,0,0,0,0]
1578# toc: may also be used instead of table-of-contents:
1579shift-heading-level-by: 1
1581identifier-prefix: foo
1583strip-empty-paragraphs: true
1584# lf, crlf, or native
1586strip-comments: false
1587indented-code-classes: []
1589default-image-extension: ".jpg"
1591# either a style name of a style definition file:
1592highlight-style: pygments
1595# or you may use syntax-definition: with a single value
1598reference-doc: myref.docx
1600# method is plain, webtex, gladtex, mathml, mathjax, katex
1601# you may specify a url with webtex, mathjax, katex
1604 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1605# none, references, or javascript
1606email-obfuscation: javascript
1614epub-subdirectory: EPUB
1615epub-metadata: meta.xml
1618epub-chapter-level: 1
1619epub-cover-image: cover.jpg
1621reference-links: true
1622# block, section, or document
1623reference-location: block
1626# accept, reject, or all
1627track-changes: accept
1636# A list of two-element lists
1638- ["User-Agent", "Mozilla/5.0"]
1640fail-if-warnings: false
1646Fields that are omitted will just have their regular
1647default values. So a defaults file can be as simple as
1654Default files can be placed in the `defaults` subdirectory of
1655the user data directory and used from any directory. For
1656example, one could create a file specifying defaults for writing
1657letters, save it as `letter.yaml` in the `defaults` subdirectory
1658of the user data directory, and then invoke these defaults
1659from any directory using `pandoc --defaults letter`
1660or `pandoc -dletter`.
1662When multiple defaults are used, their contents will be combined.
1664Note that, where command-line arguments may be repeated
1665(`--metadata-file`, `--css`, `--include-in-header`,
1666`--include-before-body`, `--include-after-body`, `--variable`,
1667`--metadata`, `--syntax-definition`), the values specified on
1668the command line will combine with values specified in the
1669defaults file, rather than replacing them.
1673When the `-s/--standalone` option is used, pandoc uses a template to
1674add header and footer material that is needed for a self-standing
1675document. To see the default template that is used, just type
1679where *FORMAT* is the name of the output format. A custom template
1680can be specified using the `--template` option. You can also override
1681the system default templates for a given output format *FORMAT*
1682by putting a file `templates/default.*FORMAT*` in the user data
1683directory (see `--data-dir`, above). *Exceptions:*
1685- For `odt` output, customize the `default.opendocument`
1687- For `pdf` output, customize the `default.latex` template
1688 (or the `default.context` template, if you use `-t context`,
1689 or the `default.ms` template, if you use `-t ms`, or the
1690 `default.html` template, if you use `-t html`).
1691- `docx` and `pptx` have no template (however, you can use
1692 `--reference-doc` to customize the output).
1694Templates contain *variables*, which allow for the inclusion of
1695arbitrary information at any point in the file. They may be set at the
1696command line using the `-V/--variable` option. If a variable is not set,
1697pandoc will look for the key in the document's metadata, which can be set
1698using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1699or with the `-M/--metadata` option. In addition, some variables
1700are given default values by pandoc. See [Variables] below for
1701a list of variables used in pandoc's default templates.
1703If you use custom templates, you may need to revise them as pandoc
1704changes. We recommend tracking the changes in the default templates,
1705and modifying your custom templates accordingly. An easy way to do this
1706is to fork the [pandoc-templates] repository and merge in
1707changes after each pandoc release.
1709 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1715Anything between the sequence `$--` and the end of the
1716line will be treated as a comment and omitted from the output.
1720To mark variables and control structures in the template,
1721either `$`...`$` or `${`...`}` may be used as delimiters.
1722The styles may also be mixed in the same template, but the
1723opening and closing delimiter must match in each case. The
1724opening delimiter may be followed by one or more spaces
1725or tabs, which will be ignored. The closing delimiter may
1726be followed by one or more spaces or tabs, which will be
1729To include a literal `$` in the document, use `$$`.
1731### Interpolated variables
1733A slot for an interpolated variable is a variable name surrounded
1734by matched delimiters. Variable names must begin with a letter
1735and can contain letters, numbers, `_`, `-`, and `.`. The
1736keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1737not be used as variable names. Examples:
1750Variable names with periods are used to get at structured
1751variable values. So, for example, `employee.salary` will return the
1752value of the `salary` field of the object that is the value of
1753the `employee` field.
1755- If the value of the variable is simple value, it will be
1756 rendered verbatim. (Note that no escaping is done;
1757 the assumption is that the calling program will escape
1758 the strings appropriately for the output format.)
1759- If the value is a list, the values will be concatenated.
1760- If the value is a map, the string `true` will be rendered.
1761- Every other value will be rendered as the empty string.
1765A conditional begins with `if(variable)` (enclosed in
1766matched delimiters) and ends with `endif` (enclosed in matched
1767delimiters). It may optionally contain an `else` (enclosed in
1768matched delimiters). The `if` section is used if
1769`variable` has a non-empty value, otherwise the `else`
1770section is used (if present). Examples:
1785${if(foo)}bar${endif}
1798The keyword `elseif` may be used to simplify complex nested
1813A for loop begins with `for(variable)` (enclosed in
1814matched delimiters) and ends with `endfor` (enclosed in matched
1817- If `variable` is an array, the material inside the loop will
1818 be evaluated repeatedly, with `variable` being set to each
1819 value of the array in turn, and concatenated.
1820- If `variable` is a map, the material inside will be set to
1822- If the value of the associated variable is not an array or
1823 a map, a single iteration will be performed on its value.
1828$for(foo)$$foo$$sep$, $endfor$
1831 - $foo.last$, $foo.first$
1835 - ${ foo.bar.last }, ${ foo.bar.first }
1839$it.name$: $it.office$
1843You may optionally specify a separator between consecutive
1844values using `sep` (enclosed in matched delimiters). The
1845material between `sep` and the `endfor` is the separator.
1848${ for(foo) }${ foo }${ sep }, ${ endfor }
1851Instead of using `variable` inside the loop, the special
1852anaphoric keyword `it` may be used.
1856 - ${ it.last }, ${ it.first }
1862Partials (subtemplates stored in different files) may be
1863included by using the name of the partial, followed
1864by `()`, for example:
1870Partials will be sought in the directory containing
1871the main template. The file name will be assumed to
1872have the same extension as the main template if it
1873lacks an extension. When calling the partial, the
1874full name including file extension can also be used:
1880(If a partial is not found in the directory of the
1881template, it will also be sought in the `templates`
1882subdirectory of the user data directory.)
1884Partials may optionally be applied to variables using
1890${ articles:bibentry() }
1893If `articles` is an array, this will iterate over its
1894values, applying the partial `bibentry()` to each one. So the
1895second example above is equivalent to
1903Note that the anaphoric keyword `it` must be used when
1904iterating over partials. In the above examples,
1905the `bibentry` partial should contain `it.title`
1906(and so on) instead of `articles.title`.
1908Final newlines are omitted from included partials.
1910Partials may include other partials.
1912A separator between values of an array may be specified
1913in square brackets, immediately after the variable name
1919${articles:bibentry()[; ]$
1922The separator in this case is literal and (unlike with `sep`
1923in an explicit `for` loop) cannot contain interpolated
1924variables or other template directives.
1928To ensure that content is "nested," that is, subsequent lines
1929indented, use the `^` directive:
1932$item.number$ $^$$item.description$ ($item.price$)
1935In this example, if `item.description` has multiple lines,
1936they will all be indented to line up with the first line:
193900123 A fine bottle of 18-year old
1940 Oban whiskey. ($148)
1943To nest multiple lines to the same level, align them
1944with the `^` directive in the template. For example:
1947$item.number$ $^$$item.description$ ($item.price$)
1948 (Available til $item.sellby$.)
195400123 A fine bottle of 18-year old
1955 Oban whiskey. ($148)
1956 (Available til March 30, 2020.)
1959If a variable occurs by itself on a line, preceded by whitespace
1960and not followed by further text or directives on the same line,
1961and the variable's value contains multiple lines, it will be
1962nested automatically.
1966Normally, spaces in the template itself (as opposed to values of
1967the interpolated variables) are not breakable, but they can be
1968made breakable in part of the template by using the `~` keyword
1969(ended with another `~`).
1972$~$This long line may break if the document is rendered
1973with a short line length.$~$
1978A pipe transforms the value of a variable or partial. Pipes are
1979specified using a slash (`/`) between the variable name (or partial)
1980and the pipe name. Example:
1987$for(metadata/pairs)$
1988- $it.key$: $it.value$
1991$employee:name()/uppercase$
1994Pipes may be chained:
1997$for(employees/pairs)$
1998$it.key/alpha/uppercase$. $it.name$
2002Some pipes take parameters:
2005|----------------------|------------|
2007$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2009|----------------------|------------|
2012Currently the following pipes are predefined:
2014- `pairs`: Converts a map or array to an array of maps,
2015 each with `key` and `value` fields. If the original
2016 value was an array, the `key` will be the array index,
2019- `uppercase`: Converts text to uppercase.
2021- `lowercase`: Converts text to lowercase.
2023- `length`: Returns the length of the value: number
2024 of characters for a textual value, number of elements
2027- `reverse`: Reverses a textual value or array,
2028 and has no effect on other values.
2030- `first`: Returns the first value of an array, if
2031 applied to a non-empty array; otherwise returns
2034- `last`: Returns the last value of an array, if
2035 applied to a non-empty array; otherwise returns
2038- `rest`: Returns all but the first value of an array, if
2039 applied to a non-empty array; otherwise returns
2042- `allbutlast`: Returns all but the last value of an array, if
2043 applied to a non-empty array; otherwise returns
2046- `chomp`: Removes trailing newlines (and breakable space).
2048- `nowrap`: Disables line wrapping on breakable spaces.
2050- `alpha`: Converts textual values that can be
2051 read as an integer into lowercase alphabetic
2052 characters `a..z` (mod 26). This can be used to get lettered
2053 enumeration from array indices. To get uppercase
2054 letters, chain with `uppercase`.
2056- `roman`: Converts textual values that can be
2057 read as an integer into lowercase roman numerials.
2058 This can be used to get lettered enumeration from array indices.
2059 To get uppercase roman, chain with `uppercase`.
2061- `left n "leftborder" "rightborder"`: Renders a textual value
2062 in a block of width `n`, aligned to the left, with an optional
2063 left and right border. Has no effect on other values. This
2064 can be used to align material in tables. Widths are positive
2065 integers indicating the number of characters. Borders
2066 are strings inside double quotes; literal `"` and `\` characters
2067 must be backslash-escaped.
2069- `right n "leftborder" "rightborder"`: Renders a textual value
2070 in a block of width `n`, aligned to the right, and has no
2071 effect on other values.
2073- `center n "leftborder" "rightborder"`: Renders a textual
2074 value in a block of width `n`, aligned to the center, and has
2075 no effect on other values.
2080### Metadata variables
2082`title`, `author`, `date`
2083: allow identification of basic aspects of the document. Included
2084 in PDF metadata through LaTeX and ConTeXt. These can be set
2085 through a [pandoc title block][Extension: `pandoc_title_block`],
2086 which allows for multiple authors, or through a
2087 [YAML metadata block][Extension: `yaml_metadata_block`]:
2095 Note that if you just want to set PDF or HTML metadata, without
2096 including a title block in the document itself, you can
2097 set the `title-meta`, `author-meta`, and `date-meta`
2098 variables. (By default these are set automatically, based
2099 on `title`, `author`, and `date`.)
2102: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2106: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2110: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2111 and AsciiDoc metadata; repeat as for `author`, above
2114: document subject, included in ODT, PDF, docx and pptx metadata
2117: document description, included in ODT, docx and pptx metadata. Some
2118 applications show this as `Comments` metadata.
2121: document category, included in docx and pptx metadata
2124any root-level string metadata, not included in ODT, docx
2125or pptx metadata is added as a *custom property*.
2126The following [YAML] metadata block for instance:
2129 title: 'This is the title'
2130 subtitle: "This is the subtitle"
2138 It consists of two paragraphs
2141will include `title`, `author` and `description` as standard document
2142properties and `subtitle` as a custom property when converting to docx,
2145### Language variables
2148: identifies the main language of the document using IETF language
2149 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2150 The [Language subtag lookup] tool can look up or verify these tags.
2151 This affects most formats, and controls hyphenation in PDF output
2152 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2154 Use native pandoc [Divs and Spans] with the `lang` attribute to
2155 switch the language:
2161 Text in the main document language (British English).
2164 > Cette citation est écrite en français canadien.
2167 More text in English. ['Zitat auf Deutsch.']{lang=de}
2170: the base script direction, either `rtl` (right-to-left)
2171 or `ltr` (left-to-right).
2173 For bidirectional documents, native pandoc `span`s and `div`s
2174 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2175 override the base direction in some output formats.
2176 This may not always be necessary if the final renderer
2177 (e.g. the browser, when generating HTML) supports the
2178 [Unicode Bidirectional Algorithm].
2180 When using LaTeX for bidirectional documents, only the `xelatex` engine
2181 is fully supported (use `--pdf-engine=xelatex`).
2183[BCP 47]: https://tools.ietf.org/html/bcp47
2184[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2185[Language subtag lookup]: https://r12a.github.io/app-subtags/
2187### Variables for HTML
2190: Enables inclusion of most of the CSS in the `styles.html`
2191 [partial](#partials) (have a look with
2192 `pandoc --print-default-data-file=templates/styles.html`).
2193 Unless you use [`--css`](#option--css), this variable
2194 is set to `true` by default. You can disable it with
2195 e.g. `pandoc -M document-css=false`.
2198: sets the CSS `font-family` property on the `html` element.
2201: sets the base CSS `font-size`, which you'd usually set
2202 to e.g. `20px`, but it also accepts `pt`
2203 (12pt = 16px in most browsers).
2206: sets the CSS `color` property on the `html` element.
2209: sets the CSS `color` property on all links.
2212: sets the CSS `font-family` property on `code` elements.
2215: sets the CSS `line-height` property on the `html` element,
2216 which is preferred to be unitless.
2219: sets the CSS `background-color` property on the `html` element.
2221`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2222: sets the corresponding CSS `padding` properties on the `body` element.
2224### Variables for HTML math
2227: when using [KaTeX](#option--katex), you can render display math equations
2228 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2230### Variables for HTML slides
2232These affect HTML output when [producing slide shows with pandoc].
2234All [reveal.js configuration options] are available as variables.
2235To turn off boolean flags that default to true in reveal.js, use `0`.
2238: base URL for reveal.js documents (defaults to
2239 `https://unpkg.com/reveal.js@^4/`)
2242: base URL for S5 documents (defaults to `s5/default`)
2245: base URL for Slidy documents (defaults to
2246 `https://www.w3.org/Talks/Tools/Slidy2`)
2249: base URL for Slideous documents (defaults to `slideous`)
2251`title-slide-attributes`
2252: additional attributes for the title slide of reveal.js slide shows.
2253 See [background in reveal.js and beamer] for an example.
2255[reveal.js configuration options]: https://revealjs.com/config/
2257### Variables for Beamer slides
2259These variables change the appearance of PDF slides using [`beamer`].
2262: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2263 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2267: produce an article from Beamer slides
2270: add extra beamer option with `\setbeameroption{}`
2273: author affiliations: can be a list when there are multiple authors
2276: logo image for slides
2279: controls navigation symbols (default is `empty` for no navigation
2280 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2283: enables "title pages" for new sections (default is true)
2285`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2289: options for LaTeX beamer themes (a list).
2292: image for title slide
2294### Variables for PowerPoint
2296These variables control the visual aspects of a slide show that
2297are not easily controlled via templates.
2300: font to use for code.
2302### Variables for LaTeX
2304Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2309: make `\paragraph` and `\subparagraph` (fourth- and
2310 fifth-level headings, or fifth- and sixth-level with book
2311 classes) free-standing rather than run-in; requires further
2312 formatting to distinguish from `\subsubsection` (third- or
2313 fourth-level headings). Instead of using this option,
2314 [KOMA-Script] can adjust headings more extensively:
2317 documentclass: scrartcl
2319 \RedeclareSectionCommand[
2320 beforeskip=-10pt plus -2pt minus -1pt,
2321 afterskip=1sp plus -1sp minus 1sp,
2322 font=\normalfont\itshape]{paragraph}
2323 \RedeclareSectionCommand[
2324 beforeskip=-10pt plus -2pt minus -1pt,
2325 afterskip=1sp plus -1sp minus 1sp,
2326 font=\normalfont\scshape,
2327 indent=0pt]{subparagraph}
2331: option for document class, e.g. `oneside`; repeat for multiple options:
2340: document class: usually one of the standard classes, [`article`], [`book`],
2341 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2342 and `scrreprt`, which default to smaller margins; or [`memoir`]
2345: option for [`geometry`] package, e.g. `margin=1in`;
2346 repeat for multiple options:
2356: option for [`hyperref`] package, e.g. `linktoc=all`;
2357 repeat for multiple options:
2363 - pdfpagemode=FullScreen
2367: if true, pandoc will use document class settings for indentation (the default LaTeX template
2368 otherwise removes indentation and adds space between paragraphs)
2371: adjusts line spacing using the [`setspace`]
2372 package, e.g. `1.25`, `1.5`
2374`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2375: sets margins if `geometry` is not used (otherwise `geometry`
2379: control `\pagestyle{}`: the default article class
2380 supports `plain` (default), `empty` (no running heads or page numbers),
2381 and `headings` (section titles in running heads)
2384: paper size, e.g. `letter`, `a4`
2387: numbering depth for sections (with `--number-sections` option
2388 or `numbersections` variable)
2393: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2394 default is `T1` (see [LaTeX font encodings guide])
2397: font package for use with `pdflatex`:
2398 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2399 The default is [Latin Modern][`lm`].
2402: options for package used as `fontfamily`; repeat for multiple options.
2403 For example, to use the Libertine font with proportional lowercase
2404 (old-style) figures through the [`libertinus`] package:
2407 fontfamily: libertinus
2414: font size for body text. The standard classes allow 10pt, 11pt, and
2415 12pt. To use another size, set `documentclass` to one of
2416 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2418`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2419: font families for use with `xelatex` or
2420 `lualatex`: take the name of any system font, using the
2421 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2423`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2424: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2425 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2426 choices available through [`fontspec`]; repeat for multiple
2427 options. For example, to use the [TeX Gyre] version of
2428 Palatino with lowercase figures:
2431 mainfont: TeX Gyre Pagella
2434 - Numbers=Proportional
2438: options to pass to the microtype package
2443: add color to link text; automatically enabled if any of
2444 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2446`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2447: color for internal links, external links, citation links, linked
2448 URLs, and links in table of contents, respectively: uses options
2449 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2453: causes links to be printed as footnotes
2458: include list of figures, list of tables
2461: contents of acknowledgments footnote after document title
2464: include table of contents (can also be set using `--toc/--table-of-contents`)
2467: level of section to include in table of contents
2469#### BibLaTeX Bibliographies
2471These variables function when using BibLaTeX for [citation rendering].
2474: list of options for biblatex
2477: bibliography style, when used with `--natbib` and `--biblatex`.
2480: bibliography title, when used with `--natbib` and `--biblatex`.
2483: bibliography to use for resolving references
2486: list of options for natbib
2488[KOMA-Script]: https://ctan.org/pkg/koma-script
2489[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2490[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2491[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2492[`article`]: https://ctan.org/pkg/article
2493[`book`]: https://ctan.org/pkg/book
2494[`libertinus`]: https://ctan.org/pkg/libertinus
2495[`memoir`]: https://ctan.org/pkg/memoir
2496[`report`]: https://ctan.org/pkg/report
2498### Variables for ConTeXt
2500Pandoc uses these variables when [creating a PDF] with ConTeXt.
2503: font size for body text (e.g. `10pt`, `12pt`)
2505`headertext`, `footertext`
2506: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2507 repeat up to four times for different placement
2510: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2511 repeat for multiple options
2514: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2515 repeat for multiple options
2518: options for page margins and text arrangement (see [ConTeXt Layout]);
2519 repeat for multiple options
2521`linkcolor`, `contrastcolor`
2522: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2525: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2528: include list of figures, list of tables
2530`mainfont`, `sansfont`, `monofont`, `mathfont`
2531: font families: take the name of any system font (see [ConTeXt Font Switching])
2533`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2534: sets margins, if `layout` is not used (otherwise `layout`
2538: page number style and location (using [`setuppagenumbering`]);
2539 repeat for multiple options
2542: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2543 repeat for multiple options
2546: adds to the preamble the setup necessary to generate PDF/A of the type
2547 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2548 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2549 block), `1b:2005` will be used as default, for reasons of backwards
2550 compatibility. Using `--variable=pdfa` without specified value is not supported.
2551 To successfully generate PDF/A the required ICC color profiles have to
2552 be available and the content and all included files (such as images)
2553 have to be standard conforming. The ICC profiles and output intent
2554 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2555 See also [ConTeXt PDFA] for more details.
2558: when used in conjunction with `pdfa`, specifies the ICC profile to use
2559 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2560 used as default. May be repeated to include multiple profiles. Note that
2561 the profiles have to be available on the system. They can be obtained
2562 from [ConTeXt ICC Profiles].
2565: when used in conjunction with `pdfa`, specifies the output intent for
2566 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2567 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2570: include table of contents (can also be set using `--toc/--table-of-contents`)
2573: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2576: include all source documents as file attachments in the PDF file
2578[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2579[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2580[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2581[ConTeXt Color]: https://wiki.contextgarden.net/Color
2582[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2583[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2584[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2585[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2586[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2587[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2588[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2590### Variables for `wkhtmltopdf`
2592Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2593The `--css` option also affects the output.
2595`footer-html`, `header-html`
2596: add information to the header and footer
2598`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2599: set the page margins
2602: sets the PDF paper size
2604### Variables for man pages
2607: adjusts text to left (`l`), right (`r`), center (`c`),
2608 or both (`b`) margins
2611: footer in man pages
2614: header in man pages
2617: if `true` (the default), hyphenation will be used
2620: section number in man pages
2625: font family (e.g. `T` or `P`)
2628: paragraph indent (e.g. `2m`)
2631: line height (e.g. `12p`)
2634: point size (e.g. `10p`)
2636### Variables set automatically
2638Pandoc sets these variables automatically in response to [options] or
2639document contents; users can also modify them. These vary depending
2640on the output format, and include the following:
2646: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2647 included in all HTML based formats (dzslides, epub,
2648 html, html4, html5, revealjs, s5, slideous, slidy).
2649 The recognized formats for `date` are: `mm/dd/yyyy`,
2650 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2651 (e.g. either `02 Apr 2018` or `02 April 2018`),
2652 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2653 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2656: contents specified by `-H/--include-in-header` (may have multiple
2660: contents specified by `-B/--include-before-body` (may have
2664: contents specified by `-A/--include-after-body` (may have
2668: JSON representation of all of the document's metadata. Field
2669 values are transformed to the selected output format.
2672: non-null value if `-N/--number-sections` was specified
2674`sourcefile`, `outputfile`
2675: source and destination filenames, as given on the command line.
2676 `sourcefile` can also be a list if input comes from multiple files,
2677 or empty if input is from stdin. You can use the following snippet in
2678 your template to distinguish them:
2688 Similarly, `outputfile` can be `-` if output goes to the terminal.
2690 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2693: working directory from which pandoc is run.
2696: non-null value if `--toc/--table-of-contents` was specified
2699: title of table of contents (works only with EPUB,
2700 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2702[pandoc-templates]: https://github.com/jgm/pandoc-templates
2706The behavior of some of the readers and writers can be adjusted by
2707enabling or disabling various extensions.
2709An extension can be enabled by adding `+EXTENSION`
2710to the format name and disabled by adding `-EXTENSION`. For example,
2711`--from markdown_strict+footnotes` is strict Markdown with footnotes
2712enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2713Markdown without footnotes or pipe tables.
2715The markdown reader and writer make by far the most use of extensions.
2716Extensions only used by them are therefore covered in the
2717section [Pandoc's Markdown] below (See [Markdown variants] for
2718`commonmark` and `gfm`.) In the following, extensions that also work
2719for other formats are covered.
2721Note that markdown extensions added to the `ipynb` format
2722affect Markdown cells in Jupyter notebooks (as do command-line
2723options like `--atx-headers`).
2727#### Extension: `smart` ####
2729Interpret straight quotes as curly quotes, `---` as em-dashes,
2730`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2731inserted after certain abbreviations, such as "Mr."
2733This extension can be enabled/disabled for the following formats:
2736: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2739: `markdown`, `latex`, `context`, `rst`
2741enabled by default in
2742: `markdown`, `latex`, `context` (both input and output)
2744Note: If you are *writing* Markdown, then the `smart` extension
2745has the reverse effect: what would have been curly quotes comes
2748In LaTeX, `smart` means to use the standard TeX ligatures
2749for quotation marks (` `` ` and ` '' ` for double quotes,
2750`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2751en-dash and `---` for em-dash). If `smart` is disabled,
2752then in reading LaTeX pandoc will parse these characters
2753literally. In writing LaTeX, enabling `smart` tells pandoc
2754to use the ligatures when possible; if `smart` is disabled
2755pandoc will use unicode quotation mark and dash characters.
2757## Headings and sections
2759#### Extension: `auto_identifiers` ####
2761A heading without an explicitly specified identifier will be
2762automatically assigned a unique identifier based on the heading text.
2764This extension can be enabled/disabled for the following formats:
2767: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2772enabled by default in
2775The default algorithm used to derive the identifier from the
2778 - Remove all formatting, links, etc.
2779 - Remove all footnotes.
2780 - Remove all non-alphanumeric characters,
2781 except underscores, hyphens, and periods.
2782 - Replace all spaces and newlines with hyphens.
2783 - Convert all alphabetic characters to lowercase.
2784 - Remove everything up to the first letter (identifiers may
2785 not begin with a number or punctuation mark).
2786 - If nothing is left after this, use the identifier `section`.
2791 ------------------------------- ----------------------------
2792 `Heading identifiers in HTML` `heading-identifiers-in-html`
2793 `Maître d'hôtel` `maître-dhôtel`
2794 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2795 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2796 `3. Applications` `applications`
2799These rules should, in most cases, allow one to determine the identifier
2800from the heading text. The exception is when several headings have the
2801same text; in this case, the first will get an identifier as described
2802above; the second will get the same identifier with `-1` appended; the
2803third with `-2`; and so on.
2805(However, a different algorithm is used if
2806`gfm_auto_identifiers` is enabled; see below.)
2808These identifiers are used to provide link targets in the table of
2809contents generated by the `--toc|--table-of-contents` option. They
2810also make it easy to provide links from one section of a document to
2811another. A link to this section, for example, might look like this:
2814 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2816Note, however, that this method of providing links to sections works
2817only in HTML, LaTeX, and ConTeXt formats.
2819If the `--section-divs` option is specified, then each section will
2820be wrapped in a `section` (or a `div`, if `html4` was specified),
2821and the identifier will be attached to the enclosing `<section>`
2822(or `<div>`) tag rather than the heading itself. This allows entire
2823sections to be manipulated using JavaScript or treated differently in
2826#### Extension: `ascii_identifiers` ####
2828Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2829Accents are stripped off of accented Latin letters, and non-Latin
2832#### Extension: `gfm_auto_identifiers` ####
2834Changes the algorithm used by `auto_identifiers` to conform to
2835GitHub's method. Spaces are converted to dashes (`-`),
2836uppercase characters to lowercase characters, and punctuation
2837characters other than `-` and `_` are removed.
2838Emojis are replaced by their names.
2842The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2843[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2844[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2845are described in the section about Pandoc's Markdown.
2847However, they can also be used with HTML input. This is handy for
2848reading web pages formatted using MathJax, for example.
2852The following extensions are described in more detail in
2853their respective sections of [Pandoc's Markdown]:
2855- [`raw_html`](#extension-raw_html) allows HTML elements which
2856 are not representable in pandoc's AST to be parsed as raw HTML.
2857 By default, this is disabled for HTML input.
2859- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2860 to be included in a document. This extension can be enabled/disabled
2861 for the following formats (in addition to `markdown`):
2864 : `latex`, `textile`, `html` (environments, `\ref`, and
2865 `\eqref` only), `ipynb`
2868 : `textile`, `commonmark`
2870 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2871 only raw TeX in markdown cells, but data with mime type
2872 `text/html` in output cells. Since the `ipynb` reader attempts
2873 to preserve the richest possible outputs when several options
2874 are given, you will get best results if you disable `raw_html`
2875 and `raw_tex` when converting to formats like `docx` which don't
2876 allow raw `html` or `tex`.
2878- [`native_divs`](#extension-native_divs) causes HTML `div`
2879 elements to be parsed as native pandoc Div blocks.
2880 If you want them to be parsed as raw HTML, use
2881 `-f html-native_divs+raw_html`.
2883- [`native_spans`](#extension-native_spans) causes HTML `span`
2884 elements to be parsed as native pandoc Span inlines.
2885 If you want them to be parsed as raw HTML, use
2886 `-f html-native_spans+raw_html`. If you want to drop all
2887 `div`s and `span`s when converting HTML to Markdown, you
2888 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2890## Literate Haskell support
2892#### Extension: `literate_haskell` ####
2894Treat the document as literate Haskell source.
2896This extension can be enabled/disabled for the following formats:
2899: `markdown`, `rst`, `latex`
2902: `markdown`, `rst`, `latex`, `html`
2904If you append `+lhs` (or `+literate_haskell`) to one of the formats
2905above, pandoc will treat the document as literate Haskell source.
2908 - In Markdown input, "bird track" sections will be parsed as Haskell
2909 code rather than block quotations. Text between `\begin{code}`
2910 and `\end{code}` will also be treated as Haskell code. For
2911 ATX-style headings the character '=' will be used instead of '#'.
2913 - In Markdown output, code blocks with classes `haskell` and `literate`
2914 will be rendered using bird tracks, and block quotations will be
2915 indented one space, so they will not be treated as Haskell code.
2916 In addition, headings will be rendered setext-style (with underlines)
2917 rather than ATX-style (with '#' characters). (This is because ghc
2918 treats '#' characters in column 1 as introducing line numbers.)
2920 - In restructured text input, "bird track" sections will be parsed
2923 - In restructured text output, code blocks with class `haskell` will
2924 be rendered using bird tracks.
2926 - In LaTeX input, text in `code` environments will be parsed as
2929 - In LaTeX output, code blocks with class `haskell` will be rendered
2930 inside `code` environments.
2932 - In HTML output, code blocks with class `haskell` will be rendered
2933 with class `literatehaskell` and bird tracks.
2937 pandoc -f markdown+lhs -t html
2939reads literate Haskell source formatted with Markdown conventions and writes
2940ordinary HTML (without bird tracks).
2942 pandoc -f markdown+lhs -t html+lhs
2944writes HTML with the Haskell code in bird tracks, so it can be copied
2945and pasted as literate Haskell source.
2947Note that GHC expects the bird tracks in the first column, so indented
2948literate code blocks (e.g. inside an itemized environment) will not be
2949picked up by the Haskell compiler.
2953#### Extension: `empty_paragraphs` ####
2955Allows empty paragraphs. By default empty paragraphs are
2958This extension can be enabled/disabled for the following formats:
2964: `docx`, `odt`, `opendocument`, `html`
2966#### Extension: `native_numbering` ####
2968Enables native numbering of figures and tables. Enumeration
2971This extension can be enabled/disabled for the following formats:
2974: `odt`, `opendocument`
2976#### Extension: `styles` #### {#ext-styles}
2978When converting from docx, read all docx styles as divs (for
2979paragraph styles) and spans (for character styles) regardless
2980of whether pandoc understands the meaning of these styles.
2981This can be used with [docx custom styles](#custom-styles).
2987#### Extension: `amuse` ####
2989In the `muse` input format, this enables Text::Amuse
2990extensions to Emacs Muse markup.
2992#### Extension: `raw_markdown` ####
2994In the `ipynb` input format, this causes Markdown cells
2995to be included as raw Markdown blocks (allowing lossless
2996round-tripping) rather than being parsed. Use this only
2997when you are targeting `ipynb` or a markdown-based
3000#### Extension: `citations` {#org-citations}
3002Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3005#### Extension: `ntb` ####
3007In the `context` output format this enables the use of [Natural Tables
3008(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3009[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3010Natural tables allow more fine-grained global customization but come
3011at a performance penalty compared to extreme tables.
3016Pandoc understands an extended and slightly revised version of
3017John Gruber's [Markdown] syntax. This document explains the syntax,
3018noting differences from standard Markdown. Except where noted, these
3019differences can be suppressed by using the `markdown_strict` format instead
3020of `markdown`. Extensions can be enabled or disabled to specify the
3021behavior more granularly. They are described in the following. See also
3022[Extensions] above, for extensions that work also on other formats.
3026Markdown is designed to be easy to write, and, even more importantly,
3029> A Markdown-formatted document should be publishable as-is, as plain
3030> text, without looking like it's been marked up with tags or formatting
3032> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3034This principle has guided pandoc's decisions in finding syntax for
3035tables, footnotes, and other extensions.
3037There is, however, one respect in which pandoc's aims are different
3038from the original aims of Markdown. Whereas Markdown was originally
3039designed with HTML generation in mind, pandoc is designed for multiple
3040output formats. Thus, while pandoc allows the embedding of raw HTML,
3041it discourages it, and provides other, non-HTMLish ways of representing
3042important document elements like definition lists, tables, mathematics, and
3047A paragraph is one or more lines of text followed by one or more blank lines.
3048Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3049If you need a hard line break, put two or more spaces at the end of a line.
3051#### Extension: `escaped_line_breaks` ####
3053A backslash followed by a newline is also a hard line break.
3054Note: in multiline and grid table cells, this is the only way
3055to create a hard line break, since trailing spaces in the cells
3060There are two kinds of headings: Setext and ATX.
3062### Setext-style headings ###
3064A setext-style heading is a line of text "underlined" with a row of `=` signs
3065(for a level-one heading) or `-` signs (for a level-two heading):
3073The heading text can contain inline formatting, such as emphasis (see
3074[Inline formatting], below).
3077### ATX-style headings ###
3079An ATX-style heading consists of one to six `#` signs and a line of
3080text, optionally followed by any number of `#` signs. The number of
3081`#` signs at the beginning of the line is the heading level:
3083 ## A level-two heading
3085 ### A level-three heading ###
3087As with setext-style headings, the heading text can contain formatting:
3089 # A level-one heading with a [link](/url) and *emphasis*
3091#### Extension: `blank_before_header` ####
3093Standard Markdown syntax does not require a blank line before a heading.
3094Pandoc does require this (except, of course, at the beginning of the
3095document). The reason for the requirement is that it is all too easy for a
3096`#` to end up at the beginning of a line by accident (perhaps through line
3097wrapping). Consider, for example:
3099 I like several of their flavors of ice cream:
3100 #22, for example, and #5.
3102#### Extension: `space_in_atx_header` ####
3104Many Markdown implementations do not require a space between the
3105opening `#`s of an ATX heading and the heading text, so that
3106`#5 bolt` and `#hashtag` count as headings. With this extension,
3107pandoc does require the space.
3109### Heading identifiers ###
3111See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3113#### Extension: `header_attributes` ####
3115Headings can be assigned attributes using this syntax at the end
3116of the line containing the heading text:
3118 {#identifier .class .class key=value key=value}
3120Thus, for example, the following headings will all be assigned the identifier
3125 ## My heading ## {#foo}
3127 My other heading {#foo}
3130(This syntax is compatible with [PHP Markdown Extra].)
3132Note that although this syntax allows assignment of classes and key/value
3133attributes, writers generally don't use all of this information. Identifiers,
3134classes, and key/value attributes are used in HTML and HTML-based formats such
3135as EPUB and slidy. Identifiers are used for labels and link anchors in the
3136LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3138Headings with the class `unnumbered` will not be numbered, even if
3139`--number-sections` is specified. A single hyphen (`-`) in an attribute
3140context is equivalent to `.unnumbered`, and preferable in non-English
3147 # My heading {.unnumbered}
3149If the `unlisted` class is present in addition to `unnumbered`,
3150the heading will not be included in a table of contents.
3151(Currently this feature is only implemented for certain
3152formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3154#### Extension: `implicit_header_references` ####
3156Pandoc behaves as if reference links have been defined for each heading.
3157So, to link to a heading
3159 # Heading identifiers in HTML
3163 [Heading identifiers in HTML]
3167 [Heading identifiers in HTML][]
3171 [the section on heading identifiers][heading identifiers in
3174instead of giving the identifier explicitly:
3176 [Heading identifiers in HTML](#heading-identifiers-in-html)
3178If there are multiple headings with identical text, the corresponding
3179reference will link to the first one only, and you will need to use explicit
3180links to link to the others, as described above.
3182Like regular reference links, these references are case-insensitive.
3184Explicit link reference definitions always take priority over
3185implicit heading references. So, in the following example, the
3186link will point to `bar`, not to `#foo`:
3196Markdown uses email conventions for quoting blocks of text.
3197A block quotation is one or more paragraphs or other block elements
3198(such as lists or headings), with each line preceded by a `>` character
3199and an optional space. (The `>` need not start at the left margin, but
3200it should not be indented more than three spaces.)
3202 > This is a block quote. This
3203 > paragraph has two lines.
3205 > 1. This is a list inside a block quote.
3208A "lazy" form, which requires the `>` character only on the first
3209line of each block, is also allowed:
3211 > This is a block quote. This
3212 paragraph has two lines.
3214 > 1. This is a list inside a block quote.
3217Among the block elements that can be contained in a block quote are
3218other block quotes. That is, block quotes can be nested:
3220 > This is a block quote.
3222 > > A block quote within a block quote.
3224If the `>` character is followed by an optional space, that space
3225will be considered part of the block quote marker and not part of
3226the indentation of the contents. Thus, to put an indented code
3227block in a block quote, you need five spaces after the `>`:
3231#### Extension: `blank_before_blockquote` ####
3233Standard Markdown syntax does not require a blank line before a block
3234quote. Pandoc does require this (except, of course, at the beginning of the
3235document). The reason for the requirement is that it is all too easy for a
3236`>` to end up at the beginning of a line by accident (perhaps through line
3237wrapping). So, unless the `markdown_strict` format is used, the following does
3238not produce a nested block quote in pandoc:
3240 > This is a block quote.
3244## Verbatim (code) blocks
3246### Indented code blocks ###
3248A block of text indented four spaces (or one tab) is treated as verbatim
3249text: that is, special characters do not trigger special formatting,
3250and all spaces and line breaks are preserved. For example,
3253 moveShip(5 * gravity, DOWN);
3256The initial (four space or one tab) indentation is not considered part
3257of the verbatim text, and is removed in the output.
3259Note: blank lines in the verbatim text need not begin with four spaces.
3262### Fenced code blocks ###
3264#### Extension: `fenced_code_blocks` ####
3266In addition to standard indented code blocks, pandoc supports
3267*fenced* code blocks. These begin with a row of three or more
3268tildes (`~`) and end with a row of tildes that must be at least as long as
3269the starting row. Everything between these lines is treated as code. No
3270indentation is necessary:
3274 moveShip(5 * gravity, DOWN);
3278Like regular code blocks, fenced code blocks must be separated
3279from surrounding text by blank lines.
3281If the code itself contains a row of tildes or backticks, just use a longer
3282row of tildes or backticks at the start and end:
3286 code including tildes
3290#### Extension: `backtick_code_blocks` ####
3292Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3295#### Extension: `fenced_code_attributes` ####
3297Optionally, you may attach attributes to fenced or backtick code block using
3300 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3302 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3303 qsort (filter (>= x) xs)
3304 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3306Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3307`startFrom` is an attribute with value `100`. Some output formats can use this
3308information to do syntax highlighting. Currently, the only output formats
3309that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3310highlighting is supported for your output format and language, then the code
3311block above will appear highlighted, with numbered lines. (To see which
3312languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3313the code block above will appear as follows:
3315 <pre id="mycode" class="haskell numberLines" startFrom="100">
3321The `numberLines` (or `number-lines`) class will cause the lines
3322of the code block to be numbered, starting with `1` or the value
3323of the `startFrom` attribute. The `lineAnchors` (or
3324`line-anchors`) class will cause the lines to be clickable
3325anchors in HTML output.
3327A shortcut form can also be used for specifying the language of
3334This is equivalent to:
3340If the `fenced_code_attributes` extension is disabled, but
3341input contains class attribute(s) for the code block, the first
3342class attribute will be printed after the opening fence as a bare
3345To prevent all highlighting, use the `--no-highlight` flag.
3346To set the highlighting style, use `--highlight-style`.
3347For more information on highlighting, see [Syntax highlighting],
3352#### Extension: `line_blocks` ####
3354A line block is a sequence of lines beginning with a vertical bar (`|`)
3355followed by a space. The division into lines will be preserved in
3356the output, as will any leading spaces; otherwise, the lines will
3357be formatted as Markdown. This is useful for verse and addresses:
3359 | The limerick packs laughs anatomical
3360 | In space that is quite economical.
3361 | But the good ones I've seen
3362 | So seldom are clean
3363 | And the clean ones so seldom are comical
3366 | Berkeley, CA 94718
3368The lines can be hard-wrapped if needed, but the continuation
3369line must begin with a space.
3371 | The Right Honorable Most Venerable and Righteous Samuel L.
3374 | Berkeley, CA 94718
3376This syntax is borrowed from [reStructuredText].
3382A bullet list is a list of bulleted list items. A bulleted list
3383item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3390This will produce a "compact" list. If you want a "loose" list, in which
3391each item is formatted as a paragraph, put spaces between the items:
3399The bullets need not be flush with the left margin; they may be
3400indented one, two, or three spaces. The bullet must be followed
3403List items look best if subsequent lines are flush with the first
3404line (after the bullet):
3410But Markdown also allows a "lazy" format:
3416### Block content in list items ###
3418A list item may contain multiple paragraphs and other block-level
3419content. However, subsequent paragraphs must be preceded by a blank line
3420and indented to line up with the first non-space content after
3427 * Second paragraph. With a code block, which must be indented
3432Exception: if the list marker is followed by an indented code
3433block, which must begin 5 spaces after the list marker, then
3434subsequent paragraphs must begin two columns after the last
3435character of the list marker:
3439 continuation paragraph
3441List items may include other lists. In this case the preceding blank
3442line is optional. The nested list must be indented to line up with
3443the first non-space character after the list marker of the
3444containing list item.
3456As noted above, Markdown allows you to write list items "lazily," instead of
3457indenting continuation lines. However, if there are multiple paragraphs or
3458other blocks in a list item, the first line of each must be indented.
3460 + A lazy, lazy, list
3463 + Another one; this looks
3466 Second paragraph of second
3469### Ordered lists ###
3471Ordered lists work just like bulleted lists, except that the items
3472begin with enumerators rather than bullets.
3474In standard Markdown, enumerators are decimal numbers followed
3475by a period and a space. The numbers themselves are ignored, so
3476there is no difference between this list:
3488#### Extension: `fancy_lists` ####
3490Unlike standard Markdown, pandoc allows ordered list items to be marked
3491with uppercase and lowercase letters and roman numerals, in addition to
3492Arabic numerals. List markers may be enclosed in parentheses or followed by a
3493single right-parentheses or period. They must be separated from the
3494text that follows by at least one space, and, if the list marker is a
3495capital letter with a period, by at least two spaces.[^2]
3497[^2]: The point of this rule is to ensure that normal paragraphs
3498 starting with people's initials, like
3500 B. Russell was an English philosopher.
3502 do not get treated as list items.
3504 This rule will not prevent
3508 from being interpreted as a list item. In this case, a backslash
3513The `fancy_lists` extension also allows '`#`' to be used as an
3514ordered list marker in place of a numeral:
3519#### Extension: `startnum` ####
3521Pandoc also pays attention to the type of list marker used, and to the
3522starting number, and both of these are preserved where possible in the
3523output format. Thus, the following yields a list with numbers followed
3524by a single parenthesis, starting with 9, and a sublist with lowercase
3534Pandoc will start a new list each time a different type of list
3535marker is used. So, the following will create three lists:
3542If default list markers are desired, use `#.`:
3548#### Extension: `task_lists` ####
3550Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3552 - [ ] an unchecked task list item
3555### Definition lists ###
3557#### Extension: `definition_lists` ####
3559Pandoc supports definition lists, using the syntax of
3560[PHP Markdown Extra] with some extensions.[^3]
3566 Term 2 with *inline markup*
3570 { some code, part of Definition 2 }
3572 Third paragraph of definition 2.
3574Each term must fit on one line, which may optionally be followed by
3575a blank line, and must be followed by one or more definitions.
3576A definition begins with a colon or tilde, which may be indented one
3579A term may have multiple definitions, and each definition may consist of one or
3580more block elements (paragraph, code block, list, etc.), each indented four
3581spaces or one tab stop. The body of the definition (including the first line,
3582aside from the colon or tilde) should be indented four spaces. However,
3583as with other Markdown lists, you can "lazily" omit indentation except
3584at the beginning of a paragraph or other block element:
3589 with lazy continuation.
3591 Second paragraph of the definition.
3593If you leave space before the definition (as in the example above),
3594the text of the definition will be treated as a paragraph. In some
3595output formats, this will mean greater spacing between term/definition
3596pairs. For a more compact definition list, omit the space before the
3606Note that space between items in a definition list is required.
3607(A variant that loosens this requirement, but disallows "lazy"
3608hard wrapping, can be activated with `compact_definition_lists`: see
3609[Non-pandoc extensions], below.)
3611[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3613### Numbered example lists ###
3615#### Extension: `example_lists` ####
3617The special list marker `@` can be used for sequentially numbered
3618examples. The first list item with a `@` marker will be numbered '1',
3619the next '2', and so on, throughout the document. The numbered examples
3620need not occur in a single list; each new list using `@` will take up
3621where the last stopped. So, for example:
3623 (@) My first example will be numbered (1).
3624 (@) My second example will be numbered (2).
3626 Explanation of examples.
3628 (@) My third example will be numbered (3).
3630Numbered examples can be labeled and referred to elsewhere in the
3633 (@good) This is a good example.
3635 As (@good) illustrates, ...
3637The label can be any string of alphanumeric characters, underscores,
3640Note: continuation paragraphs in example lists must always
3641be indented four spaces, regardless of the length of the
3642list marker. That is, example lists always behave as if the
3643`four_space_rule` extension is set. This is because example
3644labels tend to be long, and indenting content to the
3645first non-space character after the label would be awkward.
3648### Ending a list ###
3650What if you want to put an indented code block after a list?
3657Trouble! Here pandoc (like other Markdown implementations) will treat
3658`{ my code block }` as the second paragraph of item two, and not as
3661To "cut off" the list after item two, you can insert some non-indented
3662content, like an HTML comment, which won't produce visible output in
3668 <!-- end of list -->
3672You can use the same trick if you want two consecutive lists instead
3687A line containing a row of three or more `*`, `-`, or `_` characters
3688(optionally separated by spaces) produces a horizontal rule:
3697Four kinds of tables may be used. The first three kinds presuppose the use of
3698a fixed-width font, such as Courier. The fourth kind can be used with
3699proportionally spaced fonts, as it does not require lining up columns.
3701#### Extension: `table_captions` ####
3703A caption may optionally be provided with all 4 kinds of tables (as
3704illustrated in the examples below). A caption is a paragraph beginning
3705with the string `Table:` (or just `:`), which will be stripped off.
3706It may appear either before or after the table.
3708#### Extension: `simple_tables` ####
3710Simple tables look like this:
3712 Right Left Center Default
3713 ------- ------ ---------- -------
3718 Table: Demonstration of simple table syntax.
3720The header and table rows must each fit on one line. Column
3721alignments are determined by the position of the header text relative
3722to the dashed line below it:[^4]
3724 - If the dashed line is flush with the header text on the right side
3725 but extends beyond it on the left, the column is right-aligned.
3726 - If the dashed line is flush with the header text on the left side
3727 but extends beyond it on the right, the column is left-aligned.
3728 - If the dashed line extends beyond the header text on both sides,
3729 the column is centered.
3730 - If the dashed line is flush with the header text on both sides,
3731 the default alignment is used (in most cases, this will be left).
3733[^4]: This scheme is due to Michel Fortin, who proposed it on the
3734 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3736The table must end with a blank line, or a line of dashes followed by
3739The column header row may be omitted, provided a dashed line is used
3740to end the table. For example:
3742 ------- ------ ---------- -------
3746 ------- ------ ---------- -------
3748When the header row is omitted, column alignments are determined on the basis
3749of the first line of the table body. So, in the tables above, the columns
3750would be right, left, center, and right aligned, respectively.
3752#### Extension: `multiline_tables` ####
3754Multiline tables allow header and table rows to span multiple lines
3755of text (but cells that span multiple columns or rows of the table are
3756not supported). Here is an example:
3758 -------------------------------------------------------------
3759 Centered Default Right Left
3760 Header Aligned Aligned Aligned
3761 ----------- ------- --------------- -------------------------
3762 First row 12.0 Example of a row that
3763 spans multiple lines.
3765 Second row 5.0 Here's another one. Note
3766 the blank line between
3768 -------------------------------------------------------------
3770 Table: Here's the caption. It, too, may span
3773These work like simple tables, but with the following differences:
3775 - They must begin with a row of dashes, before the header text
3776 (unless the header row is omitted).
3777 - They must end with a row of dashes, then a blank line.
3778 - The rows must be separated by blank lines.
3780In multiline tables, the table parser pays attention to the widths of
3781the columns, and the writers try to reproduce these relative widths in
3782the output. So, if you find that one of the columns is too narrow in the
3783output, try widening it in the Markdown source.
3785The header may be omitted in multiline tables as well as simple tables:
3787 ----------- ------- --------------- -------------------------
3788 First row 12.0 Example of a row that
3789 spans multiple lines.
3791 Second row 5.0 Here's another one. Note
3792 the blank line between
3794 ----------- ------- --------------- -------------------------
3796 : Here's a multiline table without a header.
3798It is possible for a multiline table to have just one row, but the row
3799should be followed by a blank line (and then the row of dashes that ends
3800the table), or the table may be interpreted as a simple table.
3802#### Extension: `grid_tables` ####
3804Grid tables look like this:
3806 : Sample grid table.
3808 +---------------+---------------+--------------------+
3809 | Fruit | Price | Advantages |
3810 +===============+===============+====================+
3811 | Bananas | $1.34 | - built-in wrapper |
3812 | | | - bright color |
3813 +---------------+---------------+--------------------+
3814 | Oranges | $2.10 | - cures scurvy |
3816 +---------------+---------------+--------------------+
3818The row of `=`s separates the header from the table body, and can be
3819omitted for a headerless table. The cells of grid tables may contain
3820arbitrary block elements (multiple paragraphs, code blocks, lists,
3821etc.). Cells that span multiple columns or rows are not
3822supported. Grid tables can be created easily using Emacs' table-mode
3823(`M-x table-insert`).
3825Alignments can be specified as with pipe tables, by putting
3826colons at the boundaries of the separator line after the
3829 +---------------+---------------+--------------------+
3830 | Right | Left | Centered |
3831 +==============:+:==============+:==================:+
3832 | Bananas | $1.34 | built-in wrapper |
3833 +---------------+---------------+--------------------+
3835For headerless tables, the colons go on the top line instead:
3837 +--------------:+:--------------+:------------------:+
3838 | Right | Left | Centered |
3839 +---------------+---------------+--------------------+
3841##### Grid Table Limitations #####
3843Pandoc does not support grid tables with row spans or column spans.
3844This means that neither variable numbers of columns across rows nor
3845variable numbers of rows across columns are supported by Pandoc.
3846All grid tables must have the same number of columns in each row,
3847and the same number of rows in each column. For example, the
3848Docutils [sample grid tables] will not render as expected with
3851[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3854#### Extension: `pipe_tables` ####
3856Pipe tables look like this:
3858 | Right | Left | Default | Center |
3859 |------:|:-----|---------|:------:|
3860 | 12 | 12 | 12 | 12 |
3861 | 123 | 123 | 123 | 123 |
3864 : Demonstration of pipe table syntax.
3866The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3867ending pipe characters are optional, but pipes are required between all
3868columns. The colons indicate column alignment as shown. The header
3869cannot be omitted. To simulate a headerless table, include a header
3872Since the pipes indicate column boundaries, columns need not be vertically
3873aligned, as they are in the above example. So, this is a perfectly
3874legal (though ugly) pipe table:
3882The cells of pipe tables cannot contain block elements like paragraphs
3883and lists, and cannot span multiple lines. If a pipe table contains a
3884row whose Markdown content is wider than the column width (see
3885`--columns`), then the table will take up the full text width and
3886the cell contents will wrap, with the relative cell widths determined
3887by the number of dashes in the line separating the table header from
3888the table body. (For example `---|-` would make the first column 3/4
3889and the second column 1/4 of the full text width.)
3890On the other hand, if no lines are wider than column width, then
3891cell contents will not be wrapped, and the cells will be sized
3894Note: pandoc also recognizes pipe tables of the following
3895form, as can be produced by Emacs' orgtbl-mode:
3902The difference is that `+` is used instead of `|`. Other orgtbl features
3903are not supported. In particular, to get non-default column alignment,
3904you'll need to add colons as above.
3906[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3910#### Extension: `pandoc_title_block` ####
3912If the file begins with a title block
3915 % author(s) (separated by semicolons)
3918it will be parsed as bibliographic information, not regular text. (It
3919will be used, for example, in the title of standalone LaTeX or HTML
3920output.) The block may contain just a title, a title and an author,
3921or all three elements. If you want to include an author but no
3922title, or a title and a date but no author, you need a blank line:
3935The title may occupy multiple lines, but continuation lines must
3936begin with leading space, thus:
3943If a document has multiple authors, the authors may be put on
3944separate lines with leading space, or separated by semicolons, or
3945both. So, all of the following are equivalent:
3953% Author One; Author Two
3961The date must fit on one line.
3963All three metadata fields may contain standard inline formatting
3964(italics, links, footnotes, etc.).
3966Title blocks will always be parsed, but they will affect the output only
3967when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3968will appear twice: once in the document head -- this is the title that
3969will appear at the top of the window in a browser -- and once at the
3970beginning of the document body. The title in the document head can have
3971an optional prefix attached (`--title-prefix` or `-T` option). The title
3972in the body appears as an H1 element with class "title", so it can be
3973suppressed or reformatted with CSS. If a title prefix is specified with
3974`-T` and no title block appears in the document, the title prefix will
3975be used by itself as the HTML title.
3977The man page writer extracts a title, man page section number, and
3978other header and footer information from the title line. The title
3979is assumed to be the first word on the title line, which may optionally
3980end with a (single-digit) section number in parentheses. (There should
3981be no space between the title and the parentheses.) Anything after
3982this is assumed to be additional footer and header text. A single pipe
3983character (`|`) should be used to separate the footer text from the header
3988will yield a man page with the title `PANDOC` and section 1.
3990 % PANDOC(1) Pandoc User Manuals
3992will also have "Pandoc User Manuals" in the footer.
3994 % PANDOC(1) Pandoc User Manuals | Version 4.0
3996will also have "Version 4.0" in the header.
3998#### Extension: `yaml_metadata_block` ####
4000A [YAML] metadata block is a valid YAML object, delimited by a line of three
4001hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4002(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4003document, but if it is not at the beginning, it must be preceded by a blank
4004line. (Note that, because of the way pandoc concatenates input files when
4005several are provided, you may also keep the metadata in a separate YAML file
4006and pass it to pandoc as an argument, along with your Markdown files:
4008 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4010Just be sure that the YAML file begins with `---` and ends with `---` or
4011`...`.) Alternatively, you can use the `--metadata-file` option. Using
4012that approach however, you cannot reference content (like footnotes)
4013from the main markdown input document.
4015Metadata will be taken from the fields of the YAML object and added to any
4016existing document metadata. Metadata can contain lists and objects (nested
4017arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4018with names ending in an underscore will be ignored by pandoc. (They may be
4019given a role by external processors.) Field names must not be
4020interpretable as YAML numbers or boolean values (so, for
4021example, `yes`, `True`, and `15` cannot be used as field names).
4023A document may contain multiple metadata blocks. If two
4024metadata blocks attempt to set the same field, the value from
4025the second block will be taken.
4027When pandoc is used with `-t markdown` to create a Markdown document,
4028a YAML metadata block will be produced only if the `-s/--standalone`
4029option is used. All of the metadata will appear in a single block
4030at the beginning of the document.
4032Note that [YAML] escaping rules must be followed. Thus, for example,
4033if a title contains a colon, it must be quoted. The pipe character
4034(`|`) can be used to begin an indented block that will be interpreted
4035literally, without need for escaping. This form is necessary
4036when the field contains blank lines or block-level formatting:
4039 title: 'This is the title: it contains a colon'
4043 keywords: [nothing, nothingness]
4045 This is the abstract.
4047 It consists of two paragraphs.
4050Template variables will be set automatically from the metadata. Thus, for
4051example, in writing HTML, the variable `abstract` will be set to the HTML
4052equivalent of the Markdown in the `abstract` field:
4054 <p>This is the abstract.</p>
4055 <p>It consists of two paragraphs.</p>
4057Variables can contain arbitrary YAML structures, but the template must match
4058this structure. The `author` variable in the default templates expects a
4059simple list or string, but can be changed to support more complicated
4060structures. The following combination, for example, would add an affiliation
4061to the author if one is given:
4064 title: The document title
4067 affiliation: University of Somewhere
4069 affiliation: University of Nowhere
4072To use the structured authors in the example above, you would need a custom
4077 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4083Raw content to include in the document's header may be specified
4084using `header-includes`; however, it is important to mark up
4085this content as raw code for a particular output format, using
4086the [`raw_attribute` extension](#extension-raw_attribute)), or it
4087will be interpreted as markdown. For example:
4092 \let\oldsection\section
4093 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4098#### Extension: `all_symbols_escapable` ####
4100Except inside a code block or inline code, any punctuation or space
4101character preceded by a backslash will be treated literally, even if it
4102would normally indicate formatting. Thus, for example, if one writes
4112 <strong>hello</strong>
4114This rule is easier to remember than standard Markdown's rule,
4115which allows only the following characters to be backslash-escaped:
4119(However, if the `markdown_strict` format is used, the standard Markdown rule
4122A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4123it will appear as `~`. In HTML and XML output, it will appear as a
4124literal unicode nonbreaking space character (note that it will thus
4125actually look "invisible" in the generated HTML source; you can still
4126use the `--ascii` command-line option to make it appear as an explicit
4129A backslash-escaped newline (i.e. a backslash occurring at the end of
4130a line) is parsed as a hard line break. It will appear in TeX output as
4131`\\` and in HTML as `<br />`. This is a nice alternative to
4132Markdown's "invisible" way of indicating hard line breaks using
4133two trailing spaces on a line.
4135Backslash escapes do not work in verbatim contexts.
4141To *emphasize* some text, surround it with `*`s or `_`, like this:
4143 This text is _emphasized with underscores_, and this
4144 is *emphasized with asterisks*.
4146Double `*` or `_` produces **strong emphasis**:
4148 This is **strong emphasis** and __with underscores__.
4150A `*` or `_` character surrounded by spaces, or backslash-escaped,
4151will not trigger emphasis:
4153 This is * not emphasized *, and \*neither is this\*.
4155#### Extension: `intraword_underscores` ####
4157Because `_` is sometimes used inside words and identifiers,
4158pandoc does not interpret a `_` surrounded by alphanumeric
4159characters as an emphasis marker. If you want to emphasize
4160just part of a word, use `*`:
4162 feas*ible*, not feas*able*.
4167#### Extension: `strikeout` ####
4169To strikeout a section of text with a horizontal line, begin and end it
4170with `~~`. Thus, for example,
4172 This ~~is deleted text.~~
4175### Superscripts and subscripts ###
4177#### Extension: `superscript`, `subscript` ####
4179Superscripts may be written by surrounding the superscripted text by `^`
4180characters; subscripts may be written by surrounding the subscripted
4181text by `~` characters. Thus, for example,
4183 H~2~O is a liquid. 2^10^ is 1024.
4185The text between `^...^` or `~...~` may not contain spaces or
4186newlines. If the superscripted or subscripted text contains
4187spaces, these spaces must be escaped with backslashes. (This is
4188to prevent accidental superscripting and subscripting through
4189the ordinary use of `~` and `^`, and also bad interactions with
4190footnotes.) Thus, if you want the letter P with 'a cat' in
4191subscripts, use `P~a\ cat~`, not `P~a cat~`.
4195To make a short span of text verbatim, put it inside backticks:
4197 What is the difference between `>>=` and `>>`?
4199If the verbatim text includes a backtick, use double backticks:
4201 Here is a literal backtick `` ` ``.
4203(The spaces after the opening backticks and before the closing
4204backticks will be ignored.)
4206The general rule is that a verbatim span starts with a string
4207of consecutive backticks (optionally followed by a space)
4208and ends with a string of the same number of backticks (optionally
4209preceded by a space).
4211Note that backslash-escapes (and other Markdown constructs) do not
4212work in verbatim contexts:
4214 This is a backslash followed by an asterisk: `\*`.
4216#### Extension: `inline_code_attributes` ####
4218Attributes can be attached to verbatim text, just as with
4219[fenced code blocks]:
4225To write small caps, use the `smallcaps` class:
4227 [Small caps]{.smallcaps}
4229Or, without the `bracketed_spans` extension:
4231 <span class="smallcaps">Small caps</span>
4233For compatibility with other Markdown flavors, CSS is also supported:
4235 <span style="font-variant:small-caps;">Small caps</span>
4237This will work in all output formats that support small caps.
4242#### Extension: `tex_math_dollars` ####
4244Anything between two `$` characters will be treated as TeX math. The
4245opening `$` must have a non-space character immediately to its right,
4246while the closing `$` must have a non-space character immediately to its
4247left, and must not be followed immediately by a digit. Thus,
4248`$20,000 and $30,000` won't parse as math. If for some reason
4249you need to enclose text in literal `$` characters, backslash-escape
4250them and they won't be treated as math delimiters.
4252For display math, use `$$` delimiters. (In this case, the delimiters
4253may be separated from the formula by whitespace.)
4255TeX math will be printed in all output formats. How it is rendered
4256depends on the output format:
4259 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4260 math) or `\[...\]` (for display math).
4262Markdown, Emacs Org mode, ConTeXt, ZimWiki
4263 ~ It will appear verbatim surrounded by `$...$` (for inline
4264 math) or `$$...$$` (for display math).
4267 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4270 ~ It will be rendered using an [interpreted text role `:math:`].
4273 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4274 surrounded by `latexmath:[$...$]` (for inline math) or
4275 `[latexmath]++++\[...\]+++` (for display math).
4276 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4277 (`$..$` and `\[..\]`) are omitted.
4280 ~ It will be rendered inside a `@math` command.
4282roff man, Jira markup
4283 ~ It will be rendered verbatim without `$`'s.
4286 ~ It will be rendered inside `<math>` tags.
4289 ~ It will be rendered inside `<span class="math">` tags.
4292 ~ It will be rendered, if possible, using Unicode characters,
4293 and will otherwise appear verbatim.
4296 ~ It will be rendered, if possible, using MathML.
4299 ~ If the `--mathml` flag is used, it will be rendered using MathML
4300 in an `inlineequation` or `informalequation` tag. Otherwise it
4301 will be rendered, if possible, using Unicode characters.
4304 ~ It will be rendered using OMML math markup.
4307 ~ If the `--webtex` option is used, formulas are rendered as images
4308 using CodeCogs or other compatible web service, downloaded
4309 and embedded in the e-book. Otherwise, they will appear verbatim.
4311HTML, Slidy, DZSlides, S5, EPUB
4312 ~ The way math is rendered in HTML will depend on the
4313 command-line options selected. Therefore see [Math rendering in HTML]
4316[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4320#### Extension: `raw_html` ####
4322Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4323(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4324literally). (Technically this is not an extension, since standard
4325Markdown allows it, but it has been made an extension so that it can
4326be disabled if desired.)
4328The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4329DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4330output, and suppressed in other formats.
4332For a more explicit way of including raw HTML in a Markdown
4333document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4335In the CommonMark format, if `raw_html` is enabled, superscripts,
4336subscripts, strikeouts and small capitals will be represented as HTML.
4337Otherwise, plain-text fallbacks will be used. Note that even if
4338`raw_html` is disabled, tables will be rendered with HTML syntax if
4339they cannot use pipe syntax.
4341#### Extension: `markdown_in_html_blocks` ####
4343Standard Markdown allows you to include HTML "blocks": blocks
4344of HTML between balanced tags that are separated from the surrounding text
4345with blank lines, and start and end at the left margin. Within
4346these blocks, everything is interpreted as HTML, not Markdown;
4347so (for example), `*` does not signify emphasis.
4349Pandoc behaves this way when the `markdown_strict` format is used; but
4350by default, pandoc interprets material between HTML block tags as Markdown.
4351Thus, for example, pandoc will turn
4356 <td>[a link](https://google.com)</td>
4364 <td><em>one</em></td>
4365 <td><a href="https://google.com">a link</a></td>
4369whereas `Markdown.pl` will preserve it as is.
4371There is one exception to this rule: text between `<script>` and
4372`<style>` tags is not interpreted as Markdown.
4374This departure from standard Markdown should make it easier to mix
4375Markdown with HTML block elements. For example, one can surround
4376a block of Markdown text with `<div>` tags without preventing it
4377from being interpreted as Markdown.
4379#### Extension: `native_divs` ####
4381Use native pandoc `Div` blocks for content inside `<div>` tags.
4382For the most part this should give the same output as
4383`markdown_in_html_blocks`, but it makes it easier to write pandoc
4384filters to manipulate groups of blocks.
4386#### Extension: `native_spans` ####
4388Use native pandoc `Span` blocks for content inside `<span>` tags.
4389For the most part this should give the same output as `raw_html`,
4390but it makes it easier to write pandoc filters to manipulate groups
4393#### Extension: `raw_tex` ####
4395In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4396included in a document. Inline TeX commands will be preserved and passed
4397unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4398LaTeX to include BibTeX citations:
4400 This result was proved in \cite{jones.1967}.
4402Note that in LaTeX environments, like
4404 \begin{tabular}{|l|l|}\hline
4405 Age & Frequency \\ \hline
4408 36--45 & 22 \\ \hline
4411the material between the begin and end tags will be interpreted as raw
4412LaTeX, not as Markdown.
4414For a more explicit and flexible way of including raw TeX in a
4415Markdown document, see the [`raw_attribute`
4416extension][Extension: `raw_attribute`].
4418Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4419Emacs Org mode, and ConTeXt.
4421### Generic raw attribute ###
4423#### Extension: `raw_attribute` ####
4425Inline spans and fenced code blocks with a special
4426kind of attribute will be parsed as raw content with the
4427designated format. For example, the following produces a raw
4434And the following produces a raw `html` inline element:
4436 This is `<a>html</a>`{=html}
4438This can be useful to insert raw xml into `docx` documents, e.g.
4444 <w:br w:type="page"/>
4449The format name should match the target format name (see
4450`-t/--to`, above, for a list, or use `pandoc
4451--list-output-formats`). Use `openxml` for `docx` output,
4452`opendocument` for `odt` output, `html5` for `epub3` output,
4453`html4` for `epub2` output, and `latex`, `beamer`,
4454`ms`, or `html5` for `pdf` output (depending on what you
4455use for `--pdf-engine`).
4457This extension presupposes that the relevant kind of
4458inline code or fenced code block is enabled. Thus, for
4459example, to use a raw attribute with a backtick code block,
4460`backtick_code_blocks` must be enabled.
4462The raw attribute cannot be combined with regular attributes.
4466#### Extension: `latex_macros` ####
4468When this extension is enabled, pandoc will parse LaTeX
4469macro definitions and apply the resulting macros to all LaTeX
4470math and raw LaTeX. So, for example, the following will work in
4471all output formats, not just LaTeX:
4473 \newcommand{\tuple}[1]{\langle #1 \rangle}
4477Note that LaTeX macros will not be applied if they occur
4478inside a raw span or block marked with the
4479[`raw_attribute` extension](#extension-raw_attribute).
4481When `latex_macros` is disabled, the raw LaTeX and math will
4482not have macros applied. This is usually a better approach when
4483you are targeting LaTeX or PDF.
4485Macro definitions in LaTeX will be passed through as raw LaTeX
4486only if `latex_macros` is not enabled. Macro definitions in
4487Markdown source (or other formats allowing `raw_tex`) will
4488be passed through regardless of whether `latex_macros` is
4493Markdown allows links to be specified in several ways.
4495### Automatic links ###
4497If you enclose a URL or email address in pointy brackets, it
4500 <https://google.com>
4501 <sam@green.eggs.ham>
4505An inline link consists of the link text in square brackets,
4506followed by the URL in parentheses. (Optionally, the URL can
4507be followed by a link title, in quotes.)
4509 This is an [inline link](/url), and here's [one with
4510 a title](https://fsf.org "click here for a good time!").
4512There can be no space between the bracketed part and the parenthesized part.
4513The link text can contain formatting (such as emphasis), but the title cannot.
4515Email addresses in inline links are not autodetected, so they have to be
4516prefixed with `mailto`:
4518 [Write me!](mailto:sam@green.eggs.ham)
4520### Reference links ###
4522An *explicit* reference link has two parts, the link itself and the link
4523definition, which may occur elsewhere in the document (either
4524before or after the link).
4526The link consists of link text in square brackets, followed by a label in
4527square brackets. (There cannot be space between the two unless the
4528`spaced_reference_links` extension is enabled.) The link definition
4529consists of the bracketed label, followed by a colon and a space, followed by
4530the URL, and optionally (after a space) a link title either in quotes or in
4531parentheses. The label must not be parseable as a citation (assuming
4532the `citations` extension is enabled): citations take precedence over
4535Here are some examples:
4537 [my label 1]: /foo/bar.html "My title, optional"
4539 [my label 3]: https://fsf.org (The free software foundation)
4540 [my label 4]: /bar#special 'A title in single quotes'
4542The URL may optionally be surrounded by angle brackets:
4544 [my label 5]: <http://foo.bar.baz>
4546The title may go on the next line:
4548 [my label 3]: https://fsf.org
4549 "The free software foundation"
4551Note that link labels are not case sensitive. So, this will work:
4553 Here is [my link][FOO]
4557In an *implicit* reference link, the second pair of brackets is
4562 [my website]: http://foo.bar.baz
4564Note: In `Markdown.pl` and most other Markdown implementations,
4565reference link definitions cannot occur in nested constructions
4566such as list items or block quotes. Pandoc lifts this arbitrary
4567seeming restriction. So the following is fine in pandoc, though
4568not in most other implementations:
4574#### Extension: `shortcut_reference_links` ####
4576In a *shortcut* reference link, the second pair of brackets may
4581 [my website]: http://foo.bar.baz
4583### Internal links ###
4585To link to another section of the same document, use the automatically
4586generated identifier (see [Heading identifiers]). For example:
4588 See the [Introduction](#introduction).
4592 See the [Introduction].
4594 [Introduction]: #introduction
4596Internal links are currently supported for HTML formats (including
4597HTML slide shows and EPUB), LaTeX, and ConTeXt.
4601A link immediately preceded by a `!` will be treated as an image.
4602The link text will be used as the image's alt text:
4604 
4608 [movie reel]: movie.gif
4610#### Extension: `implicit_figures` ####
4612An image with nonempty alt text, occurring by itself in a
4613paragraph, will be rendered as a figure with a caption. The
4614image's alt text will be used as the caption.
4616 
4618How this is rendered depends on the output format. Some output
4619formats (e.g. RTF) do not yet support figures. In those
4620formats, you'll just get an image in a paragraph by itself, with
4623If you just want a regular inline image, just make sure it is not
4624the only thing in the paragraph. One way to do this is to insert a
4625nonbreaking space after the image:
4627 \
4629Note that in reveal.js slide shows, an image in a paragraph
4630by itself that has the `stretch` class will fill the screen,
4631and the caption and figure tags will be omitted.
4633#### Extension: `link_attributes` ####
4635Attributes can be set on links and images:
4637 An inline {#id .class width=30 height=20px}
4638 and a reference ![image][ref] with attributes.
4640 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4642(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4643and `.class` are used.)
4645For HTML and EPUB, all known HTML5 attributes except `width` and
4646`height` (but including `srcset` and `sizes`) are passed through
4647as is. Unknown attributes are passed through as custom
4648attributes, with `data-` prepended. The other writers ignore
4649attributes that are not specifically supported by their output format.
4651The `width` and `height` attributes on images are treated specially. When
4652used without a unit, the unit is assumed to be pixels. However, any of
4653the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4654and `%`. There must not be any spaces between the number and the unit.
4658{ width=50% }
4661- Dimensions may be converted to a form that is compatible with
4662 the output format (for example, dimensions given in pixels will
4663 be converted to inches when converting HTML to LaTeX). Conversion
4664 between pixels and physical measurements is affected by the
4665 `--dpi` option (by default, 96 dpi is assumed, unless the image
4666 itself contains dpi information).
4667- The `%` unit is generally relative to some available space.
4668 For example the above example will render to the following.
4669 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4670 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4671 (If you're using a custom template, you need to configure `graphicx`
4672 as in the default template.)
4673 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4674- Some output formats have a notion of a class
4675 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4676 or a unique identifier (LaTeX `\caption`), or both (HTML).
4677- When no `width` or `height` attributes are specified, the fallback
4678 is to look at the image resolution and the dpi metadata embedded in
4683Using the `native_divs` and `native_spans` extensions
4684(see [above][Extension: `native_divs`]), HTML syntax can
4685be used as part of markdown to create native `Div` and `Span`
4686elements in the pandoc AST (as opposed to raw HTML).
4687However, there is also nicer syntax available:
4689#### Extension: `fenced_divs` ####
4691Allow special fenced syntax for native `Div` blocks. A Div
4692starts with a fence containing at least three consecutive
4693colons plus some attributes. The attributes may optionally
4694be followed by another string of consecutive colons.
4695The attribute syntax is exactly as in fenced code blocks (see
4696[Extension: `fenced_code_attributes`]). As with fenced
4697code blocks, one can use either attributes in curly braces
4698or a single unbraced word, which will be treated as a class
4699name. The Div ends with another line containing a string of at
4700least three consecutive colons. The fenced Div should be
4701separated by blank lines from preceding and following blocks.
4705 ::::: {#special .sidebar}
4706 Here is a paragraph.
4711Fenced divs can be nested. Opening fences are distinguished
4712because they *must* have attributes:
4718 This is a warning within a warning.
4722Fences without attributes are always closing fences. Unlike
4723with fenced code blocks, the number of colons in the closing
4724fence need not match the number in the opening fence. However,
4725it can be helpful for visual clarity to use fences of different
4726lengths to distinguish nested divs from their parents.
4729#### Extension: `bracketed_spans` ####
4731A bracketed sequence of inlines, as one would use to begin
4732a link, will be treated as a `Span` with attributes if it is
4733followed immediately by attributes:
4735 [This is *some text*]{.class key="val"}
4739#### Extension: `footnotes` ####
4741Pandoc's Markdown allows footnotes, using the following syntax:
4743 Here is a footnote reference,[^1] and another.[^longnote]
4745 [^1]: Here is the footnote.
4747 [^longnote]: Here's one with multiple blocks.
4749 Subsequent paragraphs are indented to show that they
4750 belong to the previous footnote.
4754 The whole paragraph can be indented, or just the first
4755 line. In this way, multi-paragraph footnotes work like
4756 multi-paragraph list items.
4758 This paragraph won't be part of the note, because it
4761The identifiers in footnote references may not contain spaces, tabs,
4762or newlines. These identifiers are used only to correlate the
4763footnote reference with the note itself; in the output, footnotes
4764will be numbered sequentially.
4766The footnotes themselves need not be placed at the end of the
4767document. They may appear anywhere except inside other block elements
4768(lists, block quotes, tables, etc.). Each footnote should be
4769separated from surrounding content (including other footnotes)
4772#### Extension: `inline_notes` ####
4774Inline footnotes are also allowed (though, unlike regular notes,
4775they cannot contain multiple paragraphs). The syntax is as follows:
4777 Here is an inline note.^[Inlines notes are easier to write, since
4778 you don't have to pick an identifier and move down to type the
4781Inline and regular footnotes may be mixed freely.
4785#### Extension: `citations` ####
4787Markdown citations go inside square brackets and are separated
4788by semicolons. Each citation must have a key, composed of '@' +
4789the citation identifier from the database, and may optionally
4790have a prefix, a locator, and a suffix. The citation key must
4791begin with a letter, digit, or `_`, and may contain
4792alphanumerics, `_`, and internal punctuation characters
4793(`:.#$%&-+?<>~/`). Here are some examples:
4795 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4797 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4799 Blah blah [@smith04; @doe99].
4801`pandoc` detects locator terms in the [CSL locale files].
4802Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4803locale, locator terms can be written in either singular or plural forms,
4804as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4805`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4806`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4807`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4808`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4809`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4810locator term is used, "page" is assumed.
4812`pandoc` will use heuristics to distinguish the locator
4813from the suffix. In complex cases, the locator can be enclosed
4816 [@smith{ii, A, D-Z}, with a suffix]
4817 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4819A minus sign (`-`) before the `@` will suppress mention of
4820the author in the citation. This can be useful when the
4821author is already mentioned in the text:
4823 Smith says blah [-@smith04].
4825You can also write an in-text citation, as follows:
4829 @smith04 [p. 33] says blah.
4832[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4833[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4834[Chicago Manual of Style]: https://chicagomanualofstyle.org
4835[Citation Style Language]: https://citationstyles.org
4836[Zotero Style Repository]: https://www.zotero.org/styles
4837[finding and editing styles]: https://citationstyles.org/authors/
4838[CSL locale files]: https://github.com/citation-style-language/locales
4840## Non-pandoc extensions
4842The following Markdown syntax extensions are not enabled by default
4843in pandoc, but may be enabled by adding `+EXTENSION` to the format
4844name, where `EXTENSION` is the name of the extension. Thus, for
4845example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4847#### Extension: `attributes` ####
4849Allows attributes to be attached to any inline or block-level
4850element. The syntax for the attributes is the same as that
4851used in [`header_attributes`][Extension: `header_attributes`].
4853- Attributes that occur immediately after an inline
4854 element affect that element. If they follow a space, then they
4855 belong to the space. (Hence, this option subsumes
4856 `inline_code_attributes` and `link_attributes`.)
4857- Attributes that occur immediately before a block
4858 element, on a line by themselves, affect that
4860- Consecutive attribute specifiers may be used,
4861 either for blocks or for inlines. Their attributes
4863- Attributes that occur at the end of the text of
4864 a Setext or ATX heading (separated by whitespace
4865 from the text) affect the heading element. (Hence, this
4866 option subsumes `header_attributes`.)
4867- Attributes that occur after the opening fence
4868 in a fenced code block affect the code block element. (Hence,
4869 this option subsumes `fenced_code_attributes`.)
4870- Attributes that occur at the end of a reference
4871 link definition affect links that refer to that
4874Note that pandoc's AST does not currently allow attributes
4875to be attached to arbitrary elements. Hence a Span or Div
4876container will be added if needed.
4878#### Extension: `old_dashes` ####
4880Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4881`-` before a numeral is an en-dash, and `--` is an em-dash.
4882This option only has an effect if `smart` is enabled. It is
4883selected automatically for `textile` input.
4885#### Extension: `angle_brackets_escapable` ####
4887Allow `<` and `>` to be backslash-escaped, as they can be in
4888GitHub flavored Markdown but not original Markdown. This is
4889implied by pandoc's default `all_symbols_escapable`.
4891#### Extension: `lists_without_preceding_blankline` ####
4893Allow a list to occur right after a paragraph, with no intervening
4896#### Extension: `four_space_rule` ####
4898Selects the pandoc <= 2.0 behavior for parsing lists, so that
4899four spaces indent are needed for list item continuation
4902#### Extension: `spaced_reference_links` ####
4904Allow whitespace between the two components of a reference link,
4909#### Extension: `hard_line_breaks` ####
4911Causes all newlines within a paragraph to be interpreted as hard line
4912breaks instead of spaces.
4914#### Extension: `ignore_line_breaks` ####
4916Causes newlines within a paragraph to be ignored, rather than being
4917treated as spaces or as hard line breaks. This option is intended for
4918use with East Asian languages where spaces are not used between words,
4919but text is divided into lines for readability.
4921#### Extension: `east_asian_line_breaks` ####
4923Causes newlines within a paragraph to be ignored, rather than
4924being treated as spaces or as hard line breaks, when they occur
4925between two East Asian wide characters. This is a better choice
4926than `ignore_line_breaks` for texts that include a mix of East
4927Asian wide characters and other characters.
4929#### Extension: `emoji` ####
4931Parses textual emojis like `:smile:` as Unicode emoticons.
4933#### Extension: `tex_math_single_backslash` ####
4935Causes anything between `\(` and `\)` to be interpreted as inline
4936TeX math, and anything between `\[` and `\]` to be interpreted
4937as display TeX math. Note: a drawback of this extension is that
4938it precludes escaping `(` and `[`.
4940#### Extension: `tex_math_double_backslash` ####
4942Causes anything between `\\(` and `\\)` to be interpreted as inline
4943TeX math, and anything between `\\[` and `\\]` to be interpreted
4946#### Extension: `markdown_attribute` ####
4948By default, pandoc interprets material inside block-level tags as Markdown.
4949This extension changes the behavior so that Markdown is only parsed
4950inside block-level tags if the tags have the attribute `markdown=1`.
4952#### Extension: `mmd_title_block` ####
4954Enables a [MultiMarkdown] style title block at the top of
4955the document, for example:
4959 Date: September 1, 2008
4960 Comment: This is a sample mmd title block, with
4961 a field spanning multiple lines.
4963See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4964`yaml_metadata_block` is enabled, it will take precedence over
4967#### Extension: `abbreviations` ####
4969Parses PHP Markdown Extra abbreviation keys, like
4971 *[HTML]: Hypertext Markup Language
4973Note that the pandoc document model does not support
4974abbreviations, so if this extension is enabled, abbreviation keys are
4975simply skipped (as opposed to being parsed as paragraphs).
4977#### Extension: `autolink_bare_uris` ####
4979Makes all absolute URIs into links, even when not surrounded by
4980pointy braces `<...>`.
4982#### Extension: `mmd_link_attributes` ####
4984Parses multimarkdown style key-value attributes on link
4985and image references. This extension should not be confused with the
4986[`link_attributes`](#extension-link_attributes) extension.
4988 This is a reference ![image][ref] with multimarkdown attributes.
4990 [ref]: https://path.to/image "Image title" width=20px height=30px
4991 id=myId class="myClass1 myClass2"
4993#### Extension: `mmd_header_identifiers` ####
4995Parses multimarkdown style heading identifiers (in square brackets,
4996after the heading but before any trailing `#`s in an ATX heading).
4998#### Extension: `compact_definition_lists` ####
5000Activates the definition list syntax of pandoc 1.12.x and earlier.
5001This syntax differs from the one described above under [Definition lists]
5004 - No blank line is required between consecutive items of the
5006 - To get a "tight" or "compact" list, omit space between consecutive
5007 items; the space between a term and its definition does not affect
5009 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5010 be indented four spaces.[^6]
5012[^6]: To see why laziness is incompatible with relaxing the requirement
5013 of a blank line between items, consider the following example:
5020 Is this a single list item with two definitions of "bar," the first of
5021 which is lazily wrapped, or two list items? To remove the ambiguity
5022 we must either disallow lazy wrapping or require a blank line between
5025#### Extension: `gutenberg` ####
5027Use [Project Gutenberg] conventions for `plain` output:
5028all-caps for strong emphasis, surround by underscores
5029for regular emphasis, add extra blank space around headings.
5031 [Project Gutenberg]: https://www.gutenberg.org
5035In addition to pandoc's extended Markdown, the following Markdown
5036variants are supported:
5038- `markdown_phpextra` (PHP Markdown Extra)
5039- `markdown_github` (deprecated GitHub-Flavored Markdown)
5040- `markdown_mmd` (MultiMarkdown)
5041- `markdown_strict` (Markdown.pl)
5042- `commonmark` (CommonMark)
5043- `gfm` (Github-Flavored Markdown)
5044- `commonmark_x` (CommonMark with many pandoc extensions)
5046To see which extensions are supported for a given format,
5047and which are enabled by default, you can use the command
5049 pandoc --list-extensions=FORMAT
5051where `FORMAT` is replaced with the name of the format.
5053Note that the list of extensions for `commonmark`,
5054`gfm`, and `commonmark_x` are defined relative to default
5055commonmark. So, for example, `backtick_code_blocks`
5056does not appear as an extension, since it is enabled by
5057default and cannot be disabled.
5061When the `--citeproc` option is used, pandoc can automatically generate
5062citations and a bibliography in a number of styles. Basic usage is
5064 pandoc --citeproc myinput.txt
5066To use this feature, you will need to have
5068- a document containing citations (see [Extension: `citations`]);
5069- a source of bibliographic data: either an external bibliography
5070 file or a list of `references` in the document's YAML metadata
5071- optionally, a [CSL] citation style.
5073## Specifying bibliographic data
5075You can specify an external bibliography using the
5076`bibliography` metadata field in a YAML metadata section or the
5077`--bibliography` command line argument. If you want to use
5078multiple bibliography files, you can supply multiple
5079`--bibliography` arguments or set `bibliography` metadata field
5080to YAML array. A bibliography may have any of these formats:
5082 Format File extension
5083 ------------ --------------
5089Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5090use the extension `.bibtex` to force interpretation as BibTeX.
5092In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5093inside fields such as `title`; in CSL YAML databases, pandoc
5094Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5103`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5112`<span class="nocase">...</span>`
5113: prevent a phrase from being capitalized as title case
5115As an alternative to specifying a bibliography file using
5116`--bibliography` or the YAML metadata field `bibliography`, you
5117can include the citation data directly in the `references` field
5118of the document's YAML metadata. The field should contain an
5119array of YAML-encoded references, for example:
5123 - type: article-journal
5135 title: 'Molecular structure of nucleic acids: a structure for
5136 deoxyribose nucleic acid'
5137 title-short: Molecular structure of nucleic acids
5138 container-title: Nature
5142 DOI: 10.1038/171737a0
5143 URL: https://www.nature.com/articles/171737a0
5147Note that `pandoc` can be used to produce such a YAML metadata
5148section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5150 pandoc chem.bib -s -f biblatex -t markdown
5151 pandoc chem.json -s -f csljson -t markdown
5153`pandoc` can also be used to produce CSL JSON bibliography
5154from BibTeX, BibLaTeX, or markdown YAML:
5156 pandoc chem.bib -s -f biblatex -t csljson
5157 pandoc chem.yaml -s -f markdown -t csljson
5159Running pandoc on a bibliography file with the `--citeproc`
5160option will create a formatted bibliography in the format
5163 pandoc chem.bib -s --citeproc -o chem.html
5164 pandoc chem.bib -s --citeproc -o chem.pdf
5166### Capitalization in titles
5168If you are using a bibtex or biblatex bibliography, then observe
5171 - English titles should be in title case. Non-English titles should
5172 be in sentence case, and the `langid` field in biblatex should be
5173 set to the relevant language. (The following values are treated
5174 as English: `american`, `british`, `canadian`, `english`,
5175 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5177 - As is standard with bibtex/biblatex, proper names should be
5178 protected with curly braces so that they won't be lowercased
5179 in styles that call for sentence case. For example:
5181 title = {My Dinner with {Andre}}
5183 - In addition, words that should remain lowercase (or camelCase)
5184 should be protected:
5186 title = {Spin Wave Dispersion on the {nm} Scale}
5188 Though this is not necessary in bibtex/biblatex, it is necessary
5189 with citeproc, which stores titles internally in sentence case,
5190 and converts to title case in styles that require it. Here we
5191 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5193If you are using a CSL bibliography (either JSON or YAML), then observe
5196 - All titles should be in sentence case.
5198 - Use the `language` field for non-English titles to prevent their
5199 conversion to title case in styles that call for this. (Conversion
5200 happens only if `language` begins with `en` or is left empty.)
5202 - Protect words that should not be converted to title case using
5205 Spin wave dispersion on the <span class="nocase">nm</span> scale
5207### Conference Papers, Published vs. Unpublished
5209For a formally published conference paper, use the biblatex entry type
5210`inproceedings` (which will be mapped to CSL `paper-conference`).
5212For an unpublished manuscript, use the biblatex entry type
5213`unpublished` without an `eventtitle` field (this entry type
5214will be mapped to CSL `manuscript`).
5216For a talk, an unpublished conference paper, or a poster
5217presentation, use the biblatex entry type `unpublished` with an
5218`eventtitle` field (this entry type will be mapped to CSL
5219`speech`). Use the biblatex `type` field to indicate the type,
5220e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5221too, though `eventdate` will not be rendered by most CSL styles.
5222Note that `venue` is for the event's venue, unlike `location`
5223which describes the publisher's location; do not use the latter
5224for an unpublished conference paper.
5227## Specifying a citation style
5229Citations and references can be formatted using any style supported by the
5230[Citation Style Language], listed in the [Zotero Style Repository].
5231These files are specified using the `--csl` option or the `csl`
5232(or `citation-style`) metadata field. By default, pandoc will
5233use the [Chicago Manual of Style] author-date format. (You can
5234override this default by copying a CSL style of your choice
5235to `default.csl` in your user data directory.)
5236The CSL project provides further information on [finding and
5239The `--citation-abbreviations` option (or the
5240`citation-abbreviations` metadata field) may be used to
5241specify a JSON file containing abbreviations of journals
5242that should be used in formatted bibliographies when
5243`form="short"` is specified. The format of the file
5244can be illustrated with an example:
5248 "container-title": {
5249 "Lloyd's Law Reports": "Lloyd's Rep",
5250 "Estates Gazette": "EG",
5251 "Scots Law Times": "SLT"
5256## Raw content in a style
5258To include raw content in a prefix, suffix, delimiter, or term,
5259surround it with these tags indicating the format:
5261 {{jats}}<ref>{{/jats}}
5263Without the tags, the string will be interpreted as a string
5264and escaped in the output, rather than being passed through raw.
5266This feature allows stylesheets to be customized to give
5267different output for different output formats. However,
5268stylesheets customized in this way will not be usable
5269by other CSL implementations.
5273## Placement of the bibliography
5275If the style calls for a list of works cited, it will be placed
5276in a div with id `refs`, if one exists:
5281Otherwise, it will be placed at the end of the document.
5282Generation of the bibliography can be suppressed by setting
5283`suppress-bibliography: true` in the YAML metadata.
5285If you wish the bibliography to have a section heading, you can
5286set `reference-section-title` in the metadata, or put the heading
5287at the beginning of the div with id `refs` (if you are using it)
5288or at the end of your document:
5294The bibliography will be inserted after this heading. Note that
5295the `unnumbered` class will be added to this heading, so that the
5296section will not be numbered.
5298## Including uncited items in the bibliography
5300If you want to include items in the bibliography without actually
5301citing them in the body text, you can define a dummy `nocite` metadata
5302field and put the citations there:
5311In this example, the document will contain a citation for `item3`
5312only, but the bibliography will contain entries for `item1`, `item2`, and
5315It is possible to create a bibliography with all the citations,
5316whether or not they appear in the document, by using a wildcard:
5323For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5324render the bibliography. In order to do so, specify bibliography
5325files as outlined above, and add `--natbib` or `--biblatex`
5326argument to `pandoc` invocation. Bear in mind that bibliography
5327files have to be in either BibTeX (for `--natbib`)
5328or BibLaTeX (for `--biblatex`) format.
5330## Other relevant metadata fields
5332A few other metadata fields affect bibliography formatting:
5335: If true, citations will be
5336 hyperlinked to the corresponding bibliography entries
5337 (for author-date and numerical styles only).
5340: The `lang` field will affect how the style is localized,
5341 for example in the translation of labels and the use
5342 of quotation marks. (For backwards compatibility,
5343 `locale` may be used instead of `lang`, but this use
5346`notes-after-punctuation`
5347: If true (the default), pandoc will put footnote citations
5348 after following punctuation. For example, if the source
5349 contains `blah blah [@jones99].`, the result will look like
5350 `blah blah.[^1]`, with the note moved after the period and
5351 the space collapsed. If false, the space will still be
5352 collapsed, but the footnote will not be moved after the
5364You can use pandoc to produce an HTML + JavaScript slide presentation
5365that can be viewed via a web browser. There are five ways to do this,
5366using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5367You can also produce a PDF slide show using LaTeX [`beamer`], or
5368slides shows in Microsoft [PowerPoint] format.
5370Here's the Markdown source for a simple slide show, `habits.txt`:
5397 
5404To produce an HTML/JavaScript slide show, simply type
5406 pandoc -t FORMAT -s habits.txt -o habits.html
5408where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5410For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5411`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5412assumed to be available at the relative path `s5/default` (for S5), `slideous`
5413(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5414`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5415`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5416above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5419With all HTML slide formats, the `--self-contained` option can be used to
5420produce a single file that contains all of the data necessary to display the
5421slide show, including linked scripts, stylesheets, images, and videos.
5423To produce a PDF slide show using beamer, type
5425 pandoc -t beamer habits.txt -o habits.pdf
5427Note that a reveal.js slide show can also be converted to a PDF
5428by printing it to a file from the browser.
5430To produce a Powerpoint slide show, type
5432 pandoc habits.txt -o habits.pptx
5434## Structuring the slide show
5436By default, the *slide level* is the highest heading level in
5437the hierarchy that is followed immediately by content, and not another
5438heading, somewhere in the document. In the example above, level-1 headings
5439are always followed by level-2 headings, which are followed by content,
5440so the slide level is 2. This default can be overridden using
5441the `--slide-level` option.
5443The document is carved up into slides according to the following
5446 * A horizontal rule always starts a new slide.
5448 * A heading at the slide level always starts a new slide.
5450 * Headings *below* the slide level in the hierarchy create
5451 headings *within* a slide.
5453 * Headings *above* the slide level in the hierarchy create
5454 "title slides," which just contain the section title
5455 and help to break the slide show into sections.
5456 Non-slide content under these headings will be included
5457 on the title slide (for HTML slide shows) or in a
5458 subsequent slide with the same title (for beamer).
5460 * A title page is constructed automatically from the document's title
5461 block, if present. (In the case of beamer, this can be disabled
5462 by commenting out some lines in the default template.)
5464These rules are designed to support many different styles of slide show. If
5465you don't care about structuring your slides into sections and subsections,
5466you can just use level-1 headings for all each slide. (In that case, level-1
5467will be the slide level.) But you can also structure the slide show into
5468sections, as in the example above.
5470Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5471layout will be produced, with level-1 headings building horizontally
5472and level-2 headings building vertically. It is not recommended that
5473you use deeper nesting of section levels with reveal.js.
5477By default, these writers produce lists that display "all at once."
5478If you want your lists to display incrementally (one item at a time),
5479use the `-i` option. If you want a particular list to depart from the
5480default, put it in a `div` block with class `incremental` or
5481`nonincremental`. So, for example, using the `fenced div` syntax, the
5482following would be incremental regardless of the document default:
5500While using `incremental` and `nonincremental` divs are the
5501recommended method of setting incremental lists on a per-case basis,
5502an older method is also supported: putting lists inside a blockquote
5503will depart from the document default (that is, it will display
5504incrementally without the `-i` option and all at once with the `-i`
5510Both methods allow incremental and nonincremental lists to be mixed
5511in a single document.
5513Note: Neither the `-i/--incremental` option nor any of the
5514methods described here currently works for PowerPoint output.
5518You can add "pauses" within a slide by including a paragraph containing
5519three dots, separated by spaces:
5521 # Slide with a pause
5523 content before the pause
5527 content after the pause
5529Note: this feature is not yet implemented for PowerPoint output.
5531## Styling the slides
5533You can change the style of HTML slides by putting customized CSS files
5534in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5535or `$DATADIR/slideous` (for Slideous),
5536where `$DATADIR` is the user data directory (see `--data-dir`, above).
5537The originals may be found in pandoc's system data directory (generally
5538`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5539files it does not find in the user data directory.
5541For dzslides, the CSS is included in the HTML file itself, and may
5544All [reveal.js configuration options] can be set through variables.
5545For example, themes can be used by setting the `theme` variable:
5549Or you can specify a custom stylesheet using the `--css` option.
5551To style beamer slides, you can specify a `theme`, `colortheme`,
5552`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5554 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5556Note that heading attributes will turn into slide attributes
5557(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5558to style individual slides. In beamer, the only heading attribute
5559that affects slides is the `allowframebreaks` class, which sets the
5560`allowframebreaks` option, causing multiple slides to be created
5561if the content overfills the frame. This is recommended especially for
5564 # References {.allowframebreaks}
5568Speaker notes are supported in reveal.js and PowerPoint (pptx)
5569output. You can add notes to your Markdown document thus:
5575 - It can contain Markdown
5580To show the notes window in reveal.js, press `s` while viewing the
5581presentation. Speaker notes in PowerPoint will be available, as usual,
5582in handouts and presenter view.
5584Notes are not yet supported for other slide formats, but the notes
5585will not appear on the slides themselves.
5589To put material in side by side columns, you can use a native
5590div container with class `columns`, containing two or more div
5591containers with class `column` and a `width` attribute:
5593 :::::::::::::: {.columns}
5594 ::: {.column width="40%"}
5597 ::: {.column width="60%"}
5602### Additional columns attributes in beamer
5604The div containers with classes `columns` and `column` can optionally have
5605an `align` attribute.
5606The class `columns` can optionally have a `totalwidth` attribute or an
5607`onlytextwidth` class.
5609 :::::::::::::: {.columns align=center totalwidth=8em}
5610 ::: {.column width="40%"}
5613 ::: {.column width="60%" align=bottom}
5618The `align` attributes on `columns` and `column` can be used with the
5619values `top`, `top-baseline`, `center` and `bottom` to vertically align
5620the columns. It defaults to `top` in `columns`.
5622The `totalwidth` attribute limits the width of the columns to the given value.
5624 :::::::::::::: {.columns align=top .onlytextwidth}
5625 ::: {.column width="40%" align=center}
5628 ::: {.column width="60%"}
5633The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5635See Section 12.7 of the [Beamer User's Guide] for more details.
5637## Frame attributes in beamer
5639Sometimes it is necessary to add the LaTeX `[fragile]` option to
5640a frame in beamer (for example, when using the `minted` environment).
5641This can be forced by adding the `fragile` class to the heading
5642introducing the slide:
5644 # Fragile slide {.fragile}
5646All of the other frame attributes described in Section 8.1 of
5647the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5648`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5649`shrink`, `standout`, `noframenumbering`.
5651## Background in reveal.js and beamer
5653Background images can be added to self-contained reveal.js slideshows and
5654to beamer slideshows.
5656For the same image on every slide, use the configuration
5657option `background-image` either in the YAML metadata block
5658or as a command-line variable. (There are no other options in
5659beamer and the rest of this section concerns reveal.js slideshows.)
5661For reveal.js, you can instead use the reveal.js-native option
5662`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5663and `parallaxBackgroundVertical` the same way and must also set
5664`parallaxBackgroundSize` to have your values take effect.
5666To set an image for a particular reveal.js slide, add
5667`{data-background-image="/path/to/image"}`
5668to the first slide-level heading on the slide (which may even be empty).
5670In reveal.js's overview mode, the parallaxBackgroundImage will show up
5671only on the first slide.
5673Other reveal.js background settings also work on individual slides, including
5674`data-background-size`, `data-background-repeat`, `data-background-color`,
5675`data-transition`, and `data-transition-speed`.
5677To add a background image to the automatically generated title slide, use the
5678`title-slide-attributes` variable in the YAML metadata block. It must contain
5679a map of attribute names and values.
5681See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5684For example in reveal.js:
5689parallaxBackgroundImage: /path/to/my/background_image.png
5690title-slide-attributes:
5691 data-background-image: /path/to/title_image.png
5692 data-background-size: contain
5697Slide 1 has background_image.png as its background.
5699## {data-background-image="/path/to/special_image.jpg"}
5701Slide 2 has a special image for its background, even though the heading has no content.
5708EPUB metadata may be specified using the `--epub-metadata` option, but
5709if the source document is Markdown, it is better to use a [YAML metadata
5710block][Extension: `yaml_metadata_block`]. Here is an example:
5717 text: An investigation of metadata
5725 text: doi:10.234234.234/33
5727 rights: © 2007 John Smith, CC BY-NC
5732The following fields are recognized:
5735 ~ Either a string value or an object with fields `text` and
5736 `scheme`. Valid values for `scheme` are `ISBN-10`,
5737 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5738 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5739 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5742 ~ Either a string value, or an object with fields `file-as` and
5743 `type`, or a list of such objects. Valid values for `type` are
5744 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5747 ~ Either a string value, or an object with fields `role`, `file-as`,
5748 and `text`, or a list of such objects. Valid values for `role` are
5749 [MARC relators], but
5750 pandoc will attempt to translate the human-readable versions
5751 (like "author" and "editor") to the appropriate marc relators.
5754 ~ Same format as `creator`.
5757 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5758 Pandoc will attempt to convert other common date formats.
5760`lang` (or legacy: `language`)
5761 ~ A string value in [BCP 47] format. Pandoc will default to the local
5762 language if nothing is specified.
5765 ~ A string value or a list of such values.
5786 ~ A string value (path to cover image).
5788`css` (or legacy: `stylesheet`)
5789 ~ A string value (path to CSS stylesheet).
5791`page-progression-direction`
5792 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5793 attribute for the [`spine` element].
5796 ~ iBooks-specific metadata, with the following fields:
5798 - `version`: (string)
5799 - `specified-fonts`: `true`|`false` (default `false`)
5800 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5801 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5802 - `binding`: `true`|`false` (default `true`)
5803 - `scroll-axis`: `vertical`|`horizontal`|`default`
5805[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5806[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5808## The `epub:type` attribute
5810For `epub3` output, you can mark up the heading that corresponds to an EPUB
5811chapter using the [`epub:type` attribute][epub-type]. For example, to set
5812the attribute to the value `prologue`, use this markdown:
5814 # My chapter {epub:type=prologue}
5816Which will result in:
5818 <body epub:type="frontmatter">
5819 <section epub:type="prologue">
5822Pandoc will output `<body epub:type="bodymatter">`, unless
5823you use one of the following values, in which case either
5824`frontmatter` or `backmatter` will be output.
5826`epub:type` of first section `epub:type` of body
5827---------------------------- ------------------
5830acknowledgments frontmatter
5831copyright-page frontmatter
5832dedication frontmatter
5836contributors frontmatter
5837other-credits frontmatter
5839revision-history frontmatter
5840titlepage frontmatter
5841halftitlepage frontmatter
5842seriespage frontmatter
5847bibliography backmatter
5850[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5854By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5855`<video>` or `<source>` element present in the generated EPUB,
5856and include it in the EPUB container, yielding a completely
5857self-contained EPUB. If you want to link to external media resources
5858instead, use raw HTML in your source and add `data-external="1"` to the tag
5859with the `src` attribute. For example:
5861 <audio controls="1">
5862 <source src="https://example.com/music/toccata.mp3"
5863 data-external="1" type="audio/mpeg">
5869When creating a [Jupyter notebook], pandoc will try to infer the
5870notebook structure. Code blocks with the class `code` will be
5871taken as code cells, and intervening content will be taken as
5872Markdown cells. Attachments will automatically be created for
5873images in Markdown cells. Metadata will be taken from the
5874`jupyter` metadata field. For example:
5883 display_name: Python 2
5890 file_extension: ".py"
5891 mimetype: "text/x-python"
5893 nbconvert_exporter: "python"
5894 pygments_lexer: "ipython2"
5900**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5901bibendum felis dictum sodales.
5910from IPython.display import HTML
5913console.log("hello");
5921This image  will be
5922included as a cell attachment.
5925If you want to add cell attributes, group cells differently, or
5926add output to code cells, then you need to include divs to
5927indicate the structure. You can use either [fenced
5928divs][Extension: `fenced_divs`] or [native divs][Extension:
5929`native_divs`] for this. Here is an example:
5932:::::: {.cell .markdown}
5935**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5936bibendum felis dictum sodales.
5939:::::: {.cell .code execution_count=1}
5944::: {.output .stream .stdout}
5951:::::: {.cell .code execution_count=2}
5953from IPython.display import HTML
5956console.log("hello");
5962::: {.output .execute_result execution_count=2}
5965console.log("hello");
5974If you include raw HTML or TeX in an output cell, use the
5975[raw attribute][Extension: `fenced_attribute`], as shown
5976in the last cell of the example above. Although pandoc can
5977process "bare" raw HTML and TeX, the result is often
5978interspersed raw elements and normal textual elements, and
5979in an output cell pandoc expects a single, connected raw
5980block. To avoid using raw HTML or TeX except when
5981marked explicitly using raw attributes, we recommend
5982specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5983translating between Markdown and ipynb notebooks.
5985Note that options and extensions that affect reading and
5986writing of Markdown will also affect Markdown cells in ipynb
5987notebooks. For example, `--wrap=preserve` will preserve
5988soft line breaks in Markdown cells; `--atx-headers` will
5989cause ATX-style headings to be used; and `--preserve-tabs` will
5990prevent tabs from being turned to spaces.
5992# Syntax highlighting
5994Pandoc will automatically highlight syntax in [fenced code blocks] that
5995are marked with a language name. The Haskell library [skylighting] is
5996used for highlighting. Currently highlighting is supported only for
5997HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5998that pandoc will recognize, type `pandoc --list-highlight-languages`.
6000The color scheme can be selected using the `--highlight-style` option.
6001The default color scheme is `pygments`, which imitates the default color
6002scheme used by the Python library pygments (though pygments is not actually
6003used to do the highlighting). To see a list of highlight styles,
6004type `pandoc --list-highlight-styles`.
6006If you are not satisfied with the predefined styles, you can
6007use `--print-highlight-style` to generate a JSON `.theme` file which
6008can be modified and used as the argument to `--highlight-style`. To
6009get a JSON version of the `pygments` style, for example:
6011 pandoc --print-highlight-style pygments > my.theme
6013Then edit `my.theme` and use it like this:
6015 pandoc --highlight-style my.theme
6017If you are not satisfied with the built-in highlighting, or you
6018want highlight a language that isn't supported, you can use the
6019`--syntax-definition` option to load a [KDE-style XML syntax definition
6020file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6021Before writing your own, have a look at KDE's [repository of syntax
6022definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6024To disable highlighting, use the `--no-highlight` option.
6026[skylighting]: https://github.com/jgm/skylighting
6030Custom styles can be used in the docx and ICML formats.
6034By default, pandoc's docx and ICML output applies a predefined set of styles
6035for blocks such as paragraphs and block quotes, and uses largely default
6036formatting (italics, bold) for inlines. This will work for most
6037purposes, especially alongside a `reference.docx` file. However, if you
6038need to apply your own styles to blocks, or match a preexisting set of
6039styles, pandoc allows you to define custom styles for blocks and text
6040using `div`s and `span`s, respectively.
6042If you define a `div` or `span` with the attribute `custom-style`,
6043pandoc will apply your specified style to the contained elements (with
6044the exception of elements whose function depends on a style, like
6045headings, code blocks, block quotes, or links). So, for example, using
6046the `bracketed_spans` syntax,
6048 [Get out]{custom-style="Emphatically"}, he said.
6050would produce a docx file with "Get out" styled with character
6051style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6053 Dickinson starts the poem simply:
6055 ::: {custom-style="Poetry"}
6056 | A Bird came down the Walk---
6057 | He did not know I saw---
6060would style the two contained lines with the `Poetry` paragraph style.
6062For docx output, styles will be defined in the output file as inheriting
6063from normal text, if the styles are not yet in your reference.docx.
6064If they are already defined, pandoc will not alter the definition.
6066This feature allows for greatest customization in conjunction with
6067[pandoc filters]. If you want all paragraphs after block quotes to be
6068indented, you can write a filter to apply the styles necessary. If you
6069want all italics to be transformed to the `Emphasis` character style
6070(perhaps to change their color), you can write a filter which will
6071transform all italicized inlines to inlines within an `Emphasis`
6074For docx output, you don't need to enable any extensions for
6075custom styles to work.
6077[pandoc filters]: https://pandoc.org/filters.html
6081The docx reader, by default, only reads those styles that it can
6082convert into pandoc elements, either by direct conversion or
6083interpreting the derivation of the input document's styles.
6085By enabling the [`styles` extension](#ext-styles) in the docx reader
6086(`-f docx+styles`), you can produce output that maintains the styles
6087of the input document, using the `custom-style` class. Paragraph
6088styles are interpreted as divs, while character styles are interpreted
6091For example, using the `custom-style-reference.docx` file in the test
6092directory, we have the following different outputs:
6094Without the `+styles` extension:
6096 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6099 This is text with an *emphasized* text style. And this is text with a
6100 **strengthened** text style.
6102 > Here is a styled paragraph that inherits from Block Text.
6104And with the extension:
6106 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6108 ::: {custom-style="First Paragraph"}
6112 ::: {custom-style="Body Text"}
6113 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6114 And this is text with a [strengthened]{custom-style="Strengthened"}
6118 ::: {custom-style="My Block Style"}
6119 > Here is a styled paragraph that inherits from Block Text.
6122With these custom styles, you can use your input document as a
6123reference-doc while creating docx output (see below), and maintain the
6124same styles in your input and output files.
6128Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6129includes a Lua interpreter, so Lua need not be installed separately.)
6131To use a custom writer, simply specify the path to the Lua script
6132in place of the output format. For example:
6134 pandoc -t data/sample.lua
6136Creating a custom writer requires writing a Lua function for each
6137possible element in a pandoc document. To get a documented example
6138which you can modify according to your needs, do
6140 pandoc --print-default-data-file sample.lua
6142Note that custom writers have no default template. If you want
6143to use `--standalone` with a custom writer, you will need to
6144specify a template manually using `--template` or add a new
6145default template with the name
6146`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6147subdirectory of your user data directory (see [Templates]).
6149[Lua]: https://www.lua.org
6153If you use pandoc to convert user-contributed content in a web
6154application, here are some things to keep in mind:
61561. Although pandoc itself will not create or modify any files other
6157 than those you explicitly ask it create (with the exception
6158 of temporary files used in producing PDFs), a filter or custom
6159 writer could in principle do anything on your file system. Please
6160 audit filters and custom writers very carefully before using them.
61622. If your application uses pandoc as a Haskell library (rather than
6163 shelling out to the executable), it is possible to use it in a mode
6164 that fully isolates pandoc from your file system, by running the
6165 pandoc operations in the `PandocPure` monad. See the document
6166 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
61693. Pandoc's parsers can exhibit pathological performance on some
6170 corner cases. It is wise to put any pandoc operations under
6171 a timeout, to avoid DOS attacks that exploit these issues.
6172 If you are using the pandoc executable, you can add the
6173 command line options `+RTS -M512M -RTS` (for example) to limit
6174 the heap size to 512MB.
61764. The HTML generated by pandoc is not guaranteed to be safe.
6177 If `raw_html` is enabled for the Markdown input, users can
6178 inject arbitrary HTML. Even if `raw_html` is disabled,
6179 users can include dangerous content in attributes for
6180 headings, spans, and code blocks. To be safe, you should
6181 run all the generated HTML through an HTML sanitizer.
6185Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6186under the [GPL], version 2 or greater. This software carries no
6187warranty of any kind. (See COPYRIGHT for full copyright and
6188warranty notices.) For a full list of contributors, see the file
6189AUTHORS.md in the pandoc source code.
6191[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6192[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