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`]. `xelatex` uses
147[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
148`dir` variable set). If the `mathspec` variable is set,
149`xelatex` will use [`mathspec`] instead of [`unicode-math`].
150The [`upquote`] and [`microtype`] packages are used if
151available, and [`csquotes`] will be used for [typography]
152if the `csquotes` variable or metadata field is set to a
153true value. The [`natbib`], [`biblatex`], [`bibtex`], and
154[`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
206## Reading from the Web
208Instead of an input file, an absolute URI may be given. In this case
209pandoc will fetch the content using HTTP:
211 pandoc -f html -t markdown https://www.fsf.org
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
221## General options {.options}
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
225: Specify input format. *FORMAT* can be:
228 - `commonmark` ([CommonMark] Markdown)
229 - `commonmark_x` ([CommonMark] Markdown with extensions)
230 - `creole` ([Creole 1.0])
231 - `csv` ([CSV] table)
232 - `docbook` ([DocBook])
233 - `docx` ([Word docx])
234 - `dokuwiki` ([DokuWiki markup])
236 - `fb2` ([FictionBook2] e-book)
237 - `gfm` ([GitHub-Flavored Markdown]),
238 or the deprecated and less accurate `markdown_github`;
239 use [`markdown_github`](#markdown-variants) only
240 if you need extensions not supported in [`gfm`](#markdown-variants).
241 - `haddock` ([Haddock markup])
243 - `ipynb` ([Jupyter notebook])
244 - `jats` ([JATS] XML)
245 - `jira` ([Jira]/Confluence wiki markup)
246 - `json` (JSON version of native AST)
248 - `markdown` ([Pandoc's Markdown])
249 - `markdown_mmd` ([MultiMarkdown])
250 - `markdown_phpextra` ([PHP Markdown Extra])
251 - `markdown_strict` (original unextended [Markdown])
252 - `mediawiki` ([MediaWiki markup])
255 - `native` (native Haskell)
258 - `org` ([Emacs Org mode])
259 - `rst` ([reStructuredText])
261 - `textile` ([Textile])
262 - `tikiwiki` ([TikiWiki markup])
263 - `twiki` ([TWiki markup])
264 - `vimwiki` ([Vimwiki])
267 Extensions can be individually enabled or disabled by
268 appending `+EXTENSION` or `-EXTENSION` to the format name.
269 See [Extensions] below, for a list of extensions and
270 their names. See `--list-input-formats` and `--list-extensions`,
273`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
275: Specify output format. *FORMAT* can be:
277 ::: {#output-formats}
278 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
279 - `beamer` ([LaTeX beamer][`beamer`] slide show)
280 - `commonmark` ([CommonMark] Markdown)
281 - `commonmark_x` ([CommonMark] Markdown with extensions)
282 - `context` ([ConTeXt])
283 - `docbook` or `docbook4` ([DocBook] 4)
284 - `docbook5` (DocBook 5)
285 - `docx` ([Word docx])
286 - `dokuwiki` ([DokuWiki markup])
287 - `epub` or `epub3` ([EPUB] v3 book)
289 - `fb2` ([FictionBook2] e-book)
290 - `gfm` ([GitHub-Flavored Markdown]),
291 or the deprecated and less accurate `markdown_github`;
292 use [`markdown_github`](#markdown-variants) only
293 if you need extensions not supported in [`gfm`](#markdown-variants).
294 - `haddock` ([Haddock markup])
295 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
296 - `html4` ([XHTML] 1.0 Transitional)
297 - `icml` ([InDesign ICML])
298 - `ipynb` ([Jupyter notebook])
299 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
300 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
301 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
302 - `jats` (alias for `jats_archiving`)
303 - `jira` ([Jira]/Confluence wiki markup)
304 - `json` (JSON version of native AST)
307 - `markdown` ([Pandoc's Markdown])
308 - `markdown_mmd` ([MultiMarkdown])
309 - `markdown_phpextra` ([PHP Markdown Extra])
310 - `markdown_strict` (original unextended [Markdown])
311 - `mediawiki` ([MediaWiki markup])
314 - `native` (native Haskell),
315 - `odt` ([OpenOffice text document][ODT])
317 - `opendocument` ([OpenDocument])
318 - `org` ([Emacs Org mode])
320 - `plain` (plain text),
321 - `pptx` ([PowerPoint] slide show)
322 - `rst` ([reStructuredText])
323 - `rtf` ([Rich Text Format])
324 - `texinfo` ([GNU Texinfo])
325 - `textile` ([Textile])
326 - `slideous` ([Slideous] HTML and JavaScript slide show)
327 - `slidy` ([Slidy] HTML and JavaScript slide show)
328 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
329 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
330 - `s5` ([S5] HTML and JavaScript slide show)
331 - `tei` ([TEI Simple])
332 - `xwiki` ([XWiki markup])
333 - `zimwiki` ([ZimWiki markup])
334 - the path of a custom Lua writer, see [Custom writers] below
337 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
338 to *stdout* unless forced with `-o -`.
340 Extensions can be individually enabled or
341 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
342 name. See [Extensions] below, for a list of extensions and their
343 names. See `--list-output-formats` and `--list-extensions`, below.
345`-o` *FILE*, `--output=`*FILE*
347: Write output to *FILE* instead of *stdout*. If *FILE* is
348 `-`, output will go to *stdout*, even if a non-textual format
349 (`docx`, `odt`, `epub2`, `epub3`) is specified.
351`--data-dir=`*DIRECTORY*
353: Specify the user data directory to search for pandoc data files.
354 If this option is not specified, the default user data directory
355 will be used. On \*nix and macOS systems this will be the `pandoc`
356 subdirectory of the XDG data directory (by default,
357 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
358 environment variable). If that directory does not exist,
359 `$HOME/.pandoc` will be used (for backwards compatibility).
360 In Windows the default user data directory is
361 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
362 You can find the default user data directory on your system by
363 looking at the output of `pandoc --version`.
364 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
365 `slidy`, `slideous`, or `s5` directory
366 placed in this directory will override pandoc's normal defaults.
368`-d` *FILE*, `--defaults=`*FILE*
370: Specify a set of default option settings. *FILE* is a YAML
371 file whose fields correspond to command-line option
372 settings. All options for document conversion, including input
373 and output files, can be set using a defaults file. The file will
374 be searched for first in the working directory, and then in
375 the `defaults` subdirectory of the user data directory
376 (see `--data-dir`). The `.yaml` extension may be omitted.
377 See the section [Default files] for more information on the
378 file format. Settings from the defaults file may be
379 overridden or extended by subsequent options on the command
384: Generate a bash completion script. To enable bash completion
385 with pandoc, add this to your `.bashrc`:
387 eval "$(pandoc --bash-completion)"
391: Give verbose debugging output.
395: Suppress warning messages.
399: Exit with error status if there are any warnings.
403: Write log messages in machine-readable JSON format to
404 *FILE*. All messages above DEBUG level will be written,
405 regardless of verbosity settings (`--verbose`, `--quiet`).
407`--list-input-formats`
409: List supported input formats, one per line.
411`--list-output-formats`
413: List supported output formats, one per line.
415`--list-extensions`[`=`*FORMAT*]
417: List supported extensions for *FORMAT*, one per line, preceded
418 by a `+` or `-` indicating whether it is enabled by default
419 in *FORMAT*. If *FORMAT* is not specified, defaults for
420 pandoc's Markdown are given.
422`--list-highlight-languages`
424: List supported languages for syntax highlighting, one per
427`--list-highlight-styles`
429: List supported styles for syntax highlighting, one per line.
430 See `--highlight-style`.
440[Markdown]: https://daringfireball.net/projects/markdown/
441[CommonMark]: https://commonmark.org
442[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
443[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
444[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
445[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
446[S5]: https://meyerweb.com/eric/tools/s5/
447[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
448[Slideous]: https://goessner.net/articles/slideous/
449[HTML]: https://www.w3.org/html/
450[HTML5]: https://html.spec.whatwg.org/
451[polyglot markup]: https://www.w3.org/TR/html-polyglot/
452[XHTML]: https://www.w3.org/TR/xhtml1/
453[LaTeX]: https://www.latex-project.org/
454[`beamer`]: https://ctan.org/pkg/beamer
455[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
456[ConTeXt]: https://www.contextgarden.net/
457[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
458[DocBook]: https://docbook.org
459[JATS]: https://jats.nlm.nih.gov
460[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
461[txt2tags]: https://txt2tags.org
462[EPUB]: http://idpf.org/epub
463[OPML]: http://dev.opml.org/spec2.html
464[OpenDocument]: http://opendocument.xml.org
465[ODT]: https://en.wikipedia.org/wiki/OpenDocument
466[Textile]: https://www.promptworks.com/textile
467[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
468[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
469[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
470[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
471[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
472[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
473[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
474[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
475[CSV]: https://tools.ietf.org/html/rfc4180
476[roff man]: https://man.cx/groff_man(7)
477[roff ms]: https://man.cx/groff_ms(7)
478[Haskell]: https://www.haskell.org
479[GNU Texinfo]: https://www.gnu.org/software/texinfo/
480[Emacs Org mode]: https://orgmode.org
481[AsciiDoc]: https://www.methods.co.nz/asciidoc/
482[AsciiDoctor]: https://asciidoctor.org/
483[DZSlides]: http://paulrouget.com/dzslides/
484[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
485[PDF]: https://www.adobe.com/pdf/
486[reveal.js]: https://revealjs.com/
487[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
488[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
489[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
490[TEI Simple]: https://github.com/TEIC/TEI-Simple
491[Muse]: https://amusewiki.org/library/manual
492[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
493[Vimwiki]: https://vimwiki.github.io
495## Reader options {.options}
497`--shift-heading-level-by=`*NUMBER*
499: Shift heading levels by a positive or negative integer.
500 For example, with `--shift-heading-level-by=-1`, level 2
501 headings become level 1 headings, and level 3 headings
502 become level 2 headings. Headings cannot have a level
503 less than 1, so a heading that would be shifted below level 1
504 becomes a regular paragraph. Exception: with a shift of -N,
505 a level-N heading at the beginning of the document
506 replaces the metadata title. `--shift-heading-level-by=-1`
507 is a good choice when converting HTML or Markdown documents that
508 use an initial level-1 heading for the document title and
509 level-2+ headings for sections. `--shift-heading-level-by=1`
510 may be a good choice for converting Markdown documents that
511 use level-1 headings for sections to HTML, since pandoc uses
512 a level-1 heading to render the document title.
514`--base-header-level=`*NUMBER*
516: *Deprecated. Use `--shift-heading-level-by`=X instead,
517 where X = NUMBER - 1.* Specify the base level for headings
520`--strip-empty-paragraphs`
522: *Deprecated. Use the `+empty_paragraphs` extension instead.*
523 Ignore paragraphs with no content. This option is useful
524 for converting word processing documents where users have
525 used empty paragraphs to create inter-paragraph space.
527`--indented-code-classes=`*CLASSES*
529: Specify classes to use for indented code blocks--for example,
530 `perl,numberLines` or `haskell`. Multiple classes may be separated
533`--default-image-extension=`*EXTENSION*
535: Specify a default extension to use when image paths/URLs have no
536 extension. This allows you to use the same source for formats that
537 require different kinds of images. Currently this option only affects
538 the Markdown and LaTeX readers.
542: Parse each file individually before combining for multifile
543 documents. This will allow footnotes in different files with the
544 same identifiers to work as expected. If this option is set,
545 footnotes and links will not work across files. Reading binary
546 files (docx, odt, epub) implies `--file-scope`.
548`-F` *PROGRAM*, `--filter=`*PROGRAM*
550: Specify an executable to be used as a filter transforming the
551 pandoc AST after the input is parsed and before the output is
552 written. The executable should read JSON from stdin and write
553 JSON to stdout. The JSON must be formatted like pandoc's own
554 JSON input and output. The name of the output format will be
555 passed to the filter as the first argument. Hence,
557 pandoc --filter ./caps.py -t latex
561 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
563 The latter form may be useful for debugging filters.
565 Filters may be written in any language. `Text.Pandoc.JSON`
566 exports `toJSONFilter` to facilitate writing filters in Haskell.
567 Those who would prefer to write filters in python can use the
568 module [`pandocfilters`], installable from PyPI. There are also
569 pandoc filter libraries in [PHP], [perl], and
570 [JavaScript/node.js].
572 In order of preference, pandoc will look for filters in
574 1. a specified full or relative path (executable or
577 2. `$DATADIR/filters` (executable or non-executable)
578 where `$DATADIR` is the user data directory (see
579 `--data-dir`, above).
581 3. `$PATH` (executable only)
583 Filters and Lua-filters are applied in the order specified
586`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
588: Transform the document in a similar fashion as JSON filters (see
589 `--filter`), but use pandoc's build-in Lua filtering system. The given
590 Lua script is expected to return a list of Lua filters which will be
591 applied in order. Each Lua filter must contain element-transforming
592 functions indexed by the name of the AST element on which the filter
593 function should be applied.
595 The `pandoc` Lua module provides helper functions for element
596 creation. It is always loaded into the script's Lua environment.
598 The following is an example Lua script for macro-expansion:
600 function expand_hello_world(inline)
601 if inline.c == '{{helloworld}}' then
602 return pandoc.Emph{ pandoc.Str "Hello, World" }
608 return {{Str = expand_hello_world}}
610 In order of preference, pandoc will look for Lua filters in
612 1. a specified full or relative path (executable or
615 2. `$DATADIR/filters` (executable or non-executable)
616 where `$DATADIR` is the user data directory (see
617 `--data-dir`, above).
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
621: Set the metadata field *KEY* to the value *VAL*. A value specified
622 on the command line overrides a value specified in the document
623 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
624 Values will be parsed as YAML boolean or string values. If no value is
625 specified, the value will be treated as Boolean true. Like
626 `--variable`, `--metadata` causes template variables to be set.
627 But unlike `--variable`, `--metadata` affects the metadata of the
628 underlying document (which is accessible from filters and may be
629 printed in some output formats) and metadata values will be escaped
630 when inserted into the template.
632`--metadata-file=`*FILE*
634: Read metadata from the supplied YAML (or JSON) file. This
635 option can be used with every input format, but string scalars
636 in the YAML file will always be parsed as Markdown. Generally,
637 the input will be handled the same as in [YAML metadata
638 blocks][Extension: `yaml_metadata_block`]. This option can be
639 used repeatedly to include multiple metadata files; values in
640 files specified later on the command line will be preferred
641 over those specified in earlier files. Metadata values
642 specified inside the document, or by using `-M`, overwrite
643 values specified with this option.
645`-p`, `--preserve-tabs`
647: Preserve tabs instead of converting them to spaces. (By default, pandoc
648 converts tabs to spaces before parsing its input.) Note that this will
649 only affect tabs in literal code spans and code blocks. Tabs in regular
650 text are always treated as spaces.
654: Specify the number of spaces per tab (default is 4).
656`--track-changes=accept`|`reject`|`all`
658: Specifies what to do with insertions, deletions, and comments
659 produced by the MS Word "Track Changes" feature. `accept` (the
660 default), inserts all insertions, and ignores all
661 deletions. `reject` inserts all deletions and ignores
662 insertions. Both `accept` and `reject` ignore comments. `all` puts
663 in insertions, deletions, and comments, wrapped in spans with
664 `insertion`, `deletion`, `comment-start`, and `comment-end`
665 classes, respectively. The author and time of change is
666 included. `all` is useful for scripting: only accepting changes
667 from a certain reviewer, say, or before a certain date. If a
668 paragraph is inserted or deleted, `track-changes=all` produces a
669 span with the class `paragraph-insertion`/`paragraph-deletion`
670 before the affected paragraph break. This option only affects the
673`--extract-media=`*DIR*
675: Extract images and other media contained in or linked from
676 the source document to the path *DIR*, creating it if
677 necessary, and adjust the images references in the document
678 so they point to the extracted files. If the source format is
679 a binary container (docx, epub, or odt), the media is
680 extracted from the container and the original
681 filenames are used. Otherwise the media is read from the
682 file system or downloaded, and new filenames are constructed
683 based on SHA1 hashes of the contents.
685`--abbreviations=`*FILE*
687: Specifies a custom abbreviations file, with abbreviations
688 one to a line. If this option is not specified, pandoc will
689 read the data file `abbreviations` from the user data
690 directory or fall back on a system default. To see the
692 `pandoc --print-default-data-file=abbreviations`. The only
693 use pandoc makes of this list is in the Markdown reader.
694 Strings ending in a period that are found in this list will
695 be followed by a nonbreaking space, so that the period will
696 not produce sentence-ending space in formats like LaTeX.
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
699[PHP]: https://github.com/vinai/pandocfilters-php
700[perl]: https://metacpan.org/pod/Pandoc::Filter
701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
703## General writer options {.options}
707: Produce output with an appropriate header and footer (e.g. a
708 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
709 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
710 output. For `native` output, this option causes metadata to
711 be included; otherwise, metadata is suppressed.
713`--template=`*FILE*|*URL*
715: Use the specified file as a custom template for the generated document.
716 Implies `--standalone`. See [Templates], below, for a description
717 of template syntax. If no extension is specified, an extension
718 corresponding to the writer will be added, so that `--template=special`
719 looks for `special.html` for HTML output. If the template is not
720 found, pandoc will search for it in the `templates` subdirectory of
721 the user data directory (see `--data-dir`). If this option is not used,
722 a default template appropriate for the output format will be used (see
723 `-D/--print-default-template`).
725`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727: Set the template variable *KEY* to the value *VAL* when rendering the
728 document in standalone mode. If no *VAL* is specified, the
729 key will be given the value `true`.
731`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733: Print the system default template for an output *FORMAT*. (See `-t`
734 for a list of possible *FORMAT*s.) Templates in the user data
735 directory are ignored. This option may be used with
736 `-o`/`--output` to redirect output to a file, but
737 `-o`/`--output` must come before `--print-default-template`
740 Note that some of the default templates use partials, for
741 example `styles.html`. To print the partials, use
742 `--print-default-data-file`: for example,
743 `--print-default-data-file=templates/styles.html`.
745`--print-default-data-file=`*FILE*
747: Print a system default data file. Files in the user data directory
748 are ignored. This option may be used with `-o`/`--output` to
749 redirect output to a file, but `-o`/`--output` must come before
750 `--print-default-data-file` on the command line.
752`--eol=crlf`|`lf`|`native`
754: Manually specify line endings: `crlf` (Windows), `lf`
755 (macOS/Linux/UNIX), or `native` (line endings appropriate
756 to the OS on which pandoc is being run). The default is
761: Specify the default dpi (dots per inch) value for conversion
762 from pixels to inch/centimeters and vice versa. (Technically,
763 the correct term would be ppi: pixels per inch.) The default
764 is 96dpi. When images contain information about dpi
765 internally, the encoded value is used instead of the default
766 specified by this option.
768`--wrap=auto`|`none`|`preserve`
770: Determine how text is wrapped in the output (the source
771 code, not the rendered version). With `auto` (the default),
772 pandoc will attempt to wrap lines to the column width specified by
773 `--columns` (default 72). With `none`, pandoc will not wrap
774 lines at all. With `preserve`, pandoc will attempt to
775 preserve the wrapping from the source document (that is,
776 where there are nonsemantic newlines in the source, there
777 will be nonsemantic newlines in the output as well).
778 Automatic wrapping does not currently work in HTML output.
779 In `ipynb` output, this option affects wrapping of the
780 contents of markdown cells.
784: Specify length of lines in characters. This affects text wrapping
785 in the generated source code (see `--wrap`). It also affects
786 calculation of column widths for plain text tables (see [Tables] below).
788`--toc`, `--table-of-contents`
790: Include an automatically generated table of contents (or, in
791 the case of `latex`, `context`, `docx`, `odt`,
792 `opendocument`, `rst`, or `ms`, an instruction to create
793 one) in the output document. This option has no effect
794 unless `-s/--standalone` is used, and it has no effect
795 on `man`, `docbook4`, `docbook5`, or `jats` output.
797 Note that if you are producing a PDF via `ms`, the table
798 of contents will appear at the beginning of the
799 document, before the title. If you would prefer it to
800 be at the end of the document, use the option
801 `--pdf-engine-opt=--no-toc-relocation`.
803`--toc-depth=`*NUMBER*
805: Specify the number of section levels to include in the table
806 of contents. The default is 3 (which means that level-1, 2, and 3
807 headings will be listed in the contents).
811: Strip out HTML comments in the Markdown or Textile source,
812 rather than passing them on to Markdown, Textile or HTML
813 output as raw HTML. This does not apply to HTML comments
814 inside raw HTML blocks when the `markdown_in_html_blocks`
815 extension is not set.
819: Disables syntax highlighting for code blocks and inlines, even when
820 a language attribute is given.
822`--highlight-style=`*STYLE*|*FILE*
824: Specifies the coloring style to be used in highlighted source code.
825 Options are `pygments` (the default), `kate`, `monochrome`,
826 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
827 For more information on syntax highlighting in pandoc, see
828 [Syntax highlighting], below. See also
829 `--list-highlight-styles`.
831 Instead of a *STYLE* name, a JSON file with extension
832 `.theme` may be supplied. This will be parsed as a KDE
833 syntax highlighting theme and (if valid) used as the
836 To generate the JSON version of an existing style,
837 use `--print-highlight-style`.
839`--print-highlight-style=`*STYLE*|*FILE*
841: Prints a JSON version of a highlighting style, which can
842 be modified, saved with a `.theme` extension, and used
843 with `--highlight-style`. This option may be used with
844 `-o`/`--output` to redirect output to a file, but
845 `-o`/`--output` must come before `--print-highlight-style`
848`--syntax-definition=`*FILE*
850: Instructs pandoc to load a KDE XML syntax definition file,
851 which will be used for syntax highlighting of appropriately
852 marked code blocks. This can be used to add support for
853 new languages or to use altered syntax definitions for
854 existing languages. This option may be repeated to add
855 multiple syntax definitions.
857`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
859: Include contents of *FILE*, verbatim, at the end of the header.
860 This can be used, for example, to include special
861 CSS or JavaScript in HTML documents. This option can be used
862 repeatedly to include multiple files in the header. They will be
863 included in the order specified. Implies `--standalone`.
865`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
867: Include contents of *FILE*, verbatim, at the beginning of the
868 document body (e.g. after the `<body>` tag in HTML, or the
869 `\begin{document}` command in LaTeX). This can be used to include
870 navigation bars or banners in HTML documents. This option can be
871 used repeatedly to include multiple files. They will be included in
872 the order specified. Implies `--standalone`.
874`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
876: Include contents of *FILE*, verbatim, at the end of the document
877 body (before the `</body>` tag in HTML, or the
878 `\end{document}` command in LaTeX). This option can be used
879 repeatedly to include multiple files. They will be included in the
880 order specified. Implies `--standalone`.
882`--resource-path=`*SEARCHPATH*
884: List of paths to search for images and other resources.
885 The paths should be separated by `:` on Linux, UNIX, and
886 macOS systems, and by `;` on Windows. If `--resource-path`
887 is not specified, the default resource path is the working
888 directory. Note that, if `--resource-path` is specified,
889 the working directory must be explicitly listed or it
890 will not be searched. For example:
891 `--resource-path=.:test` will search the working directory
892 and the `test` subdirectory, in that order.
894 `--resource-path` only has an effect if (a) the output
895 format embeds images (for example, `docx`, `pdf`, or `html`
896 with `--self-contained`) or (b) it is used together with
899`--request-header=`*NAME*`:`*VAL*
901: Set the request header *NAME* to the value *VAL* when making
902 HTTP requests (for example, when a URL is given on the
903 command line, or when resources used in a document must be
904 downloaded). If you're behind a proxy, you also need to set
905 the environment variable `http_proxy` to `http://...`.
907`--no-check-certificate`
909: Disable the certificate verification to allow access to
910 unsecure HTTP resources (for example when the certificate
911 is no longer valid or self signed).
913## Options affecting specific writers {.options}
917: Produce a standalone HTML file with no external dependencies, using
918 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
919 images, and videos. Implies `--standalone`. The resulting file should be
920 "self-contained," in the sense that it needs no external files and no net
921 access to be displayed properly by a browser. This option works only with
922 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
923 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
924 and stylesheets at absolute URLs will be downloaded; those at relative
925 URLs will be sought relative to the working directory (if the first source
926 file is local) or relative to the base URL (if the first source
927 file is remote). Elements with the attribute
928 `data-external="1"` will be left alone; the documents they
929 link to will not be incorporated in the document.
930 Limitation: resources that are loaded dynamically through
931 JavaScript cannot be incorporated; as a result,
932 `--self-contained` does not work with `--mathjax`, and some
933 advanced features (e.g. zoom or speaker notes) may not work
934 in an offline "self-contained" `reveal.js` slide show.
938: Use `<q>` tags for quotes in HTML.
942: Use only ASCII characters in output. Currently supported for XML
943 and HTML formats (which use entities instead of UTF-8 when this
944 option is selected), CommonMark, gfm, and Markdown (which use
945 entities), roff ms (which use hexadecimal escapes), and to a
946 limited degree LaTeX (which uses standard commands for accented
947 characters when possible). roff man output uses ASCII by default.
951: Use reference-style links, rather than inline links, in writing Markdown
952 or reStructuredText. By default inline links are used. The
953 placement of link references is affected by the
954 `--reference-location` option.
956`--reference-location = block`|`section`|`document`
958: Specify whether footnotes (and references, if `reference-links` is
959 set) are placed at the end of the current (top-level) block, the
960 current section, or the document. The default is
961 `document`. Currently only affects the markdown writer.
965: Use ATX-style headings in Markdown output. The default is
966 to use setext-style headings for levels 1 to 2, and then ATX headings.
967 (Note: for `gfm` output, ATX headings are always used.)
968 This option also affects markdown cells in `ipynb` output.
970`--top-level-division=[default|section|chapter|part]`
972: Treat top-level headings as the given division type in LaTeX, ConTeXt,
973 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
974 all headings are shifted such that the top-level heading becomes the specified
975 type. The default behavior is to determine the best division type via
976 heuristics: unless other conditions apply, `section` is chosen. When the
977 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
978 `article` option is specified), `chapter` is implied as the setting for this
979 option. If `beamer` is the output format, specifying either `chapter` or
980 `part` will cause top-level headings to become `\part{..}`, while
981 second-level headings remain as their default type.
983`-N`, `--number-sections`
985: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
986 By default, sections are not numbered. Sections with class
987 `unnumbered` will never be numbered, even if `--number-sections`
990`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
992: Offset for section headings in HTML output (ignored in other
993 output formats). The first number is added to the section number for
994 top-level headings, the second for second-level headings, and so on.
995 So, for example, if you want the first top-level heading in your
996 document to be numbered "6", specify `--number-offset=5`.
997 If your document starts with a level-2 heading which you want to
998 be numbered "1.5", specify `--number-offset=1,4`.
999 Offsets are 0 by default. Implies `--number-sections`.
1003: Use the [`listings`] package for LaTeX code blocks. The package
1004 does not support multi-byte encoding for source code. To handle UTF-8
1005 you would need to use a custom template. This issue is fully
1006 documented here: [Encoding issue with the listings package].
1008`-i`, `--incremental`
1010: Make list items in slide shows display incrementally (one by one).
1011 The default is for lists to be displayed all at once.
1013`--slide-level=`*NUMBER*
1015: Specifies that headings with the specified level create
1016 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1017 above this level in the hierarchy are used to divide the
1018 slide show into sections; headings below this level create
1019 subheads within a slide. Note that content that is
1020 not contained under slide-level headings will not appear in
1021 the slide show. The default is to set the slide level based
1022 on the contents of the document; see [Structuring the slide
1027: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1028 and attach identifiers to the enclosing `<section>` (or `<div>`)
1029 rather than the heading itself. See
1030 [Heading identifiers], below.
1032`--email-obfuscation=none`|`javascript`|`references`
1034: Specify a method for obfuscating `mailto:` links in HTML documents.
1035 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1036 them using JavaScript. `references` obfuscates them by printing their
1037 letters as decimal or hexadecimal character references. The default
1040`--id-prefix=`*STRING*
1042: Specify a prefix to be added to all identifiers and internal links
1043 in HTML and DocBook output, and to footnote numbers in Markdown
1044 and Haddock output. This is useful for preventing duplicate
1045 identifiers when generating fragments to be included in other pages.
1047`-T` *STRING*, `--title-prefix=`*STRING*
1049: Specify *STRING* as a prefix at the beginning of the title
1050 that appears in the HTML header (but not in the title as it
1051 appears at the beginning of the HTML body). Implies `--standalone`.
1053`-c` *URL*, `--css=`*URL*
1055: Link to a CSS style sheet. This option can be used repeatedly to
1056 include multiple files. They will be included in the order specified.
1058 A stylesheet is required for generating EPUB. If none is
1059 provided using this option (or the `css` or `stylesheet`
1060 metadata fields), pandoc will look for a file `epub.css` in the
1061 user data directory (see `--data-dir`). If it is not
1062 found there, sensible defaults will be used.
1064`--reference-doc=`*FILE*
1066: Use the specified file as a style reference in producing a
1071 : For best results, the reference docx should be a modified
1072 version of a docx file produced using pandoc. The contents
1073 of the reference docx are ignored, but its stylesheets and
1074 document properties (including margins, page size, header,
1075 and footer) are used in the new docx. If no reference docx
1076 is specified on the command line, pandoc will look for a
1077 file `reference.docx` in the user data directory (see
1078 `--data-dir`). If this is not found either, sensible
1079 defaults will be used.
1081 To produce a custom `reference.docx`, first get a copy of
1082 the default `reference.docx`: `pandoc
1083 -o custom-reference.docx --print-default-data-file reference.docx`.
1084 Then open `custom-reference.docx` in Word, modify the
1085 styles as you wish, and save the file. For best
1086 results, do not make changes to this file other than
1087 modifying the styles used by pandoc:
1123 - Default Paragraph Font
1126 - Footnote Reference
1136 : For best results, the reference ODT should be a modified
1137 version of an ODT produced using pandoc. The contents of
1138 the reference ODT are ignored, but its stylesheets are used
1139 in the new ODT. If no reference ODT is specified on the
1140 command line, pandoc will look for a file `reference.odt` in
1141 the user data directory (see `--data-dir`). If this is not
1142 found either, sensible defaults will be used.
1144 To produce a custom `reference.odt`, first get a copy of
1145 the default `reference.odt`: `pandoc
1146 -o custom-reference.odt --print-default-data-file reference.odt`.
1147 Then open `custom-reference.odt` in LibreOffice, modify
1148 the styles as you wish, and save the file.
1152 : Templates included with Microsoft PowerPoint 2013 (either with
1153 `.pptx` or `.potx` extension) are known to work, as are most
1154 templates derived from these.
1156 The specific requirement is that the template should begin with
1157 the following first four layouts:
1160 2. Title and Content
1164 All templates included with a recent version of MS PowerPoint
1165 will fit these criteria. (You can click on `Layout` under the
1166 `Home` menu to check.)
1168 You can also modify the default `reference.pptx`: first run
1169 `pandoc -o custom-reference.pptx --print-default-data-file
1170 reference.pptx`, and then modify `custom-reference.pptx`
1171 in MS PowerPoint (pandoc will use the first four layout
1172 slides, as mentioned above).
1174`--epub-cover-image=`*FILE*
1176: Use the specified image as the EPUB cover. It is recommended
1177 that the image be less than 1000px in width and height. Note that
1178 in a Markdown source document you can also specify `cover-image`
1179 in a YAML metadata block (see [EPUB Metadata], below).
1181`--epub-metadata=`*FILE*
1183: Look in the specified XML file for metadata for the EPUB.
1184 The file should contain a series of [Dublin Core elements].
1187 <dc:rights>Creative Commons</dc:rights>
1188 <dc:language>es-AR</dc:language>
1190 By default, pandoc will include the following metadata elements:
1191 `<dc:title>` (from the document title), `<dc:creator>` (from the
1192 document authors), `<dc:date>` (from the document date, which should
1193 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1194 variable, or, if is not set, the locale), and `<dc:identifier
1195 id="BookId">` (a randomly generated UUID). Any of these may be
1196 overridden by elements in the metadata file.
1198 Note: if the source document is Markdown, a YAML metadata block
1199 in the document can be used instead. See below under
1202`--epub-embed-font=`*FILE*
1204: Embed the specified font in the EPUB. This option can be repeated
1205 to embed multiple fonts. Wildcards can also be used: for example,
1206 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1207 line, be sure to escape them or put the whole filename in single quotes,
1208 to prevent them from being interpreted by the shell. To use the
1209 embedded fonts, you will need to add declarations like the following
1210 to your CSS (see `--css`):
1213 font-family: DejaVuSans;
1215 font-weight: normal;
1216 src:url("DejaVuSans-Regular.ttf");
1219 font-family: DejaVuSans;
1222 src:url("DejaVuSans-Bold.ttf");
1225 font-family: DejaVuSans;
1227 font-weight: normal;
1228 src:url("DejaVuSans-Oblique.ttf");
1231 font-family: DejaVuSans;
1234 src:url("DejaVuSans-BoldOblique.ttf");
1236 body { font-family: "DejaVuSans"; }
1238`--epub-chapter-level=`*NUMBER*
1240: Specify the heading level at which to split the EPUB into separate
1241 "chapter" files. The default is to split into chapters at level-1
1242 headings. This option only affects the internal composition of the
1243 EPUB, not the way chapters and sections are displayed to users. Some
1244 readers may be slow if the chapter files are too large, so for large
1245 documents with few level-1 headings, one might want to use a chapter
1248`--epub-subdirectory=`*DIRNAME*
1250: Specify the subdirectory in the OCF container that is to hold
1251 the EPUB-specific contents. The default is `EPUB`. To put
1252 the EPUB contents in the top level, use an empty string.
1254`--ipynb-output=all|none|best`
1256: Determines how ipynb output cells are treated. `all` means
1257 that all of the data formats included in the original are
1258 preserved. `none` means that the contents of data cells
1259 are omitted. `best` causes pandoc to try to pick the
1260 richest data block in each output cell that is compatible
1261 with the output format. The default is `best`.
1263`--pdf-engine=`*PROGRAM*
1265: Use the specified engine when producing PDF output.
1266 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1267 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1268 and `pdfroff`. If the engine is not in your PATH, the full
1269 path of the engine may be specified here. If this option
1270 is not specified, pandoc uses the following defaults
1271 depending on the output format specified using `-t/--to`:
1273 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1274 `tectonic`, `latexmk`)
1275 - `-t context`: `context`
1276 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1277 see [print-css.rocks](https://print-css.rocks) for a good
1278 introduction to PDF generation from HTML/CSS.)
1279 - `-t ms`: `pdfroff`
1281`--pdf-engine-opt=`*STRING*
1283: Use the given string as a command-line argument to the `pdf-engine`.
1284 For example, to use a persistent directory `foo` for `latexmk`'s
1285 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1286 Note that no check for duplicate options is done.
1288[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1289[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1290[Encoding issue with the listings package]:
1291 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1293## Citation rendering {.options}
1295`--bibliography=`*FILE*
1297: Set the `bibliography` field in the document's metadata to *FILE*,
1298 overriding any value set in the metadata, and process citations
1299 using `pandoc-citeproc`. (This is equivalent to
1300 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1301 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1302 used, making this equivalent to `--metadata bibliography=FILE`.
1303 If you supply this argument multiple times, each *FILE* will be added
1308: Set the `csl` field in the document's metadata to *FILE*,
1309 overriding any value set in the metadata. (This is equivalent to
1310 `--metadata csl=FILE`.)
1311 This option is only relevant with `pandoc-citeproc`.
1313`--citation-abbreviations=`*FILE*
1315: Set the `citation-abbreviations` field in the document's metadata to
1316 *FILE*, overriding any value set in the metadata. (This is equivalent to
1317 `--metadata citation-abbreviations=FILE`.)
1318 This option is only relevant with `pandoc-citeproc`.
1322: Use [`natbib`] for citations in LaTeX output. This option is not for use
1323 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1324 use in producing a LaTeX file that can be processed with [`bibtex`].
1328: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1329 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1330 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1332## Math rendering in HTML {.options}
1334The default is to render TeX math as far as possible using Unicode characters.
1335Formulas are put inside a `span` with `class="math"`, so that they may be styled
1336differently from the surrounding text if needed. However, this gives acceptable
1337results only for basic math, usually you will want to use `--mathjax` or another
1338of the following options.
1340`--mathjax`[`=`*URL*]
1342: Use [MathJax] to display embedded TeX math in HTML output.
1343 TeX math will be put between `\(...\)` (for inline math)
1344 or `\[...\]` (for display math) and wrapped in `<span>` tags
1345 with class `math`. Then the MathJax JavaScript will render it.
1346 The *URL* should point to the `MathJax.js` load script.
1347 If a *URL* is not provided, a link to the Cloudflare CDN will
1352: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1353 `html4` and `html5`). This is the default in `odt` output. Note that
1354 currently only Firefox and Safari (and select e-book readers) natively
1359: Convert TeX formulas to `<img>` tags that link to an external script
1360 that converts formulas to images. The formula will be URL-encoded
1361 and concatenated with the URL provided. For SVG images you can for
1362 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1363 If no URL is specified, the CodeCogs URL generating PNGs
1364 will be used (`https://latex.codecogs.com/png.latex?`).
1365 Note: the `--webtex` option will affect Markdown output
1366 as well as HTML, which is useful if you're targeting a
1367 version of Markdown without native math support.
1371: Use [KaTeX] to display embedded TeX math in HTML output.
1372 The *URL* is the base URL for the KaTeX library. That directory
1373 should contain a `katex.min.js` and a `katex.min.css` file.
1374 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1378: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1379 can then be processed by [GladTeX] to produce images of the typeset
1380 formulas and an HTML file with links to these images.
1381 So, the procedure is:
1383 pandoc -s --gladtex input.md -o myfile.htex
1384 gladtex -d myfile-images myfile.htex
1385 # produces myfile.html and images in myfile-images
1387[MathML]: https://www.w3.org/Math/
1388[MathJax]: https://www.mathjax.org
1389[KaTeX]: https://github.com/Khan/KaTeX
1390[GladTeX]: https://humenda.github.io/GladTeX/
1392## Options for wrapper scripts {.options}
1396: Print information about command-line arguments to *stdout*, then exit.
1397 This option is intended primarily for use in wrapper scripts.
1398 The first line of output contains the name of the output file specified
1399 with the `-o` option, or `-` (for *stdout*) if no output file was
1400 specified. The remaining lines contain the command-line arguments,
1401 one per line, in the order they appear. These do not include regular
1402 pandoc options and their arguments, but do include any options appearing
1403 after a `--` separator at the end of the line.
1407: Ignore command-line arguments (for use in wrapper scripts).
1408 Regular pandoc options are not ignored. Thus, for example,
1410 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1414 pandoc -o foo.html -s
1418If pandoc completes successfully, it will return exit code 0.
1419Nonzero exit codes have the following meanings:
1422----- ------------------------------------
1423 3 PandocFailOnWarningError
1425 5 PandocTemplateError
1427 21 PandocUnknownReaderError
1428 22 PandocUnknownWriterError
1429 23 PandocUnsupportedExtensionError
1430 31 PandocEpubSubdirectoryError
1432 47 PandocPDFProgramNotFoundError
1434 62 PandocShouldNeverHappenError
1437 65 PandocParsecError
1438 66 PandocMakePDFError
1439 67 PandocSyntaxMapError
1440 83 PandocFilterError
1442 92 PandocUTF8DecodingError
1443 93 PandocIpynbDecodingError
1444 97 PandocCouldNotFindDataFileError
1445 99 PandocResourceNotFound
1446----- ------------------------------------
1450The `--defaults` option may be used to specify a package
1451of options. Here is a sample defaults file demonstrating all of
1452the fields that may be used:
1456# reader: may be used instead of from:
1458# writer: may be used instead of to:
1460# leave blank for output to stdout:
1462# leave blank for input from stdin, use [] for no input:
1466# or you may use input-file: with a single value
1470self-contained: false
1472# note that structured variables may be specified:
1479# metadata values specified here are parsed as literal
1480# string text, not markdown:
1487# or you may use metadata-file: with a single value
1489# Note that these take files, not their contents:
1490include-before-body: []
1491include-after-body: []
1492include-in-header: []
1495# filters will be assumed to be Lua filters if they have
1496# the .lua extension, and json filters otherwise. But
1497# the filter type can also be specified explicitly, as shown:
1508# ERROR, WARNING, or INFO
1512# citeproc, natbib, or biblatex
1513cite-method: citeproc
1514# part, chapter, section, or default:
1515top-level-division: chapter
1521# you may also use pdf-engine-opt: with a single option
1522# pdf-engine-opt: "-shell-escape"
1524# auto, preserve, or none
1529extract-media: mediadir
1531table-of-contents: true
1533number-sections: false
1534# a list of offsets at each heading level
1535number-offset: [0,0,0,0,0,0]
1536# toc: may also be used instead of table-of-contents:
1537shift-heading-level-by: 1
1539identifier-prefix: foo
1541strip-empty-paragraphs: true
1542# lf, crlf, or native
1544strip-comments: false
1545indented-code-classes: []
1547default-image-extension: ".jpg"
1549# either a style name of a style definition file:
1550highlight-style: pygments
1553# or you may use syntax-definition: with a single value
1556reference-doc: myref.docx
1558# method is plain, webtex, gladtex, mathml, mathjax, katex
1559# you may specify a url with webtex, mathjax, katex
1562 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1563# none, references, or javascript
1564email-obfuscation: javascript
1572epub-subdirectory: EPUB
1573epub-metadata: meta.xml
1576epub-chapter-level: 1
1577epub-cover-image: cover.jpg
1579reference-links: true
1580# block, section, or document
1581reference-location: block
1584# accept, reject, or all
1585track-changes: accept
1594# A list of two-element lists
1596- ["User-Agent", "Mozilla/5.0"]
1598fail-if-warnings: false
1604Fields that are omitted will just have their regular
1605default values. So a defaults file can be as simple as
1612Default files can be placed in the `defaults` subdirectory of
1613the user data directory and used from any directory. For
1614example, one could create a file specifying defaults for writing
1615letters, save it as `letter.yaml` in the `defaults` subdirectory
1616of the user data directory, and then invoke these defaults
1617from any directory using `pandoc --defaults letter`
1618or `pandoc -dletter`.
1620When multiple defaults are used, their contents will be combined.
1622Note that, where command-line arguments may be repeated
1623(`--metadata-file`, `--css`, `--include-in-header`,
1624`--include-before-body`, `--include-after-body`, `--variable`,
1625`--metadata`, `--syntax-definition`), the values specified on
1626the command line will combine with values specified in the
1627defaults file, rather than replacing them.
1631When the `-s/--standalone` option is used, pandoc uses a template to
1632add header and footer material that is needed for a self-standing
1633document. To see the default template that is used, just type
1637where *FORMAT* is the name of the output format. A custom template
1638can be specified using the `--template` option. You can also override
1639the system default templates for a given output format *FORMAT*
1640by putting a file `templates/default.*FORMAT*` in the user data
1641directory (see `--data-dir`, above). *Exceptions:*
1643- For `odt` output, customize the `default.opendocument`
1645- For `pdf` output, customize the `default.latex` template
1646 (or the `default.context` template, if you use `-t context`,
1647 or the `default.ms` template, if you use `-t ms`, or the
1648 `default.html` template, if you use `-t html`).
1649- `docx` and `pptx` have no template (however, you can use
1650 `--reference-doc` to customize the output).
1652Templates contain *variables*, which allow for the inclusion of
1653arbitrary information at any point in the file. They may be set at the
1654command line using the `-V/--variable` option. If a variable is not set,
1655pandoc will look for the key in the document's metadata, which can be set
1656using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1657or with the `-M/--metadata` option. In addition, some variables
1658are given default values by pandoc. See [Variables] below for
1659a list of variables used in pandoc's default templates.
1661If you use custom templates, you may need to revise them as pandoc
1662changes. We recommend tracking the changes in the default templates,
1663and modifying your custom templates accordingly. An easy way to do this
1664is to fork the [pandoc-templates] repository and merge in
1665changes after each pandoc release.
1667 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1673Anything between the sequence `$--` and the end of the
1674line will be treated as a comment and omitted from the output.
1678To mark variables and control structures in the template,
1679either `$`...`$` or `${`...`}` may be used as delimiters.
1680The styles may also be mixed in the same template, but the
1681opening and closing delimiter must match in each case. The
1682opening delimiter may be followed by one or more spaces
1683or tabs, which will be ignored. The closing delimiter may
1684be followed by one or more spaces or tabs, which will be
1687To include a literal `$` in the document, use `$$`.
1689### Interpolated variables
1691A slot for an interpolated variable is a variable name surrounded
1692by matched delimiters. Variable names must begin with a letter
1693and can contain letters, numbers, `_`, `-`, and `.`. The
1694keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1695not be used as variable names. Examples:
1708Variable names with periods are used to get at structured
1709variable values. So, for example, `employee.salary` will return the
1710value of the `salary` field of the object that is the value of
1711the `employee` field.
1713- If the value of the variable is simple value, it will be
1714 rendered verbatim. (Note that no escaping is done;
1715 the assumption is that the calling program will escape
1716 the strings appropriately for the output format.)
1717- If the value is a list, the values will be concatenated.
1718- If the value is a map, the string `true` will be rendered.
1719- Every other value will be rendered as the empty string.
1723A conditional begins with `if(variable)` (enclosed in
1724matched delimiters) and ends with `endif` (enclosed in matched
1725delimiters). It may optionally contain an `else` (enclosed in
1726matched delimiters). The `if` section is used if
1727`variable` has a non-empty value, otherwise the `else`
1728section is used (if present). Examples:
1743${if(foo)}bar${endif}
1756The keyword `elseif` may be used to simplify complex nested
1771A for loop begins with `for(variable)` (enclosed in
1772matched delimiters) and ends with `endfor` (enclosed in matched
1775- If `variable` is an array, the material inside the loop will
1776 be evaluated repeatedly, with `variable` being set to each
1777 value of the array in turn, and concatenated.
1778- If `variable` is a map, the material inside will be set to
1780- If the value of the associated variable is not an array or
1781 a map, a single iteration will be performed on its value.
1786$for(foo)$$foo$$sep$, $endfor$
1789 - $foo.last$, $foo.first$
1793 - ${ foo.bar.last }, ${ foo.bar.first }
1797$it.name$: $it.office$
1801You may optionally specify a separator between consecutive
1802values using `sep` (enclosed in matched delimiters). The
1803material between `sep` and the `endfor` is the separator.
1806${ for(foo) }${ foo }${ sep }, ${ endfor }
1809Instead of using `variable` inside the loop, the special
1810anaphoric keyword `it` may be used.
1814 - ${ it.last }, ${ it.first }
1820Partials (subtemplates stored in different files) may be
1821included by using the name of the partial, followed
1822by `()`, for example:
1828Partials will be sought in the directory containing
1829the main template. The file name will be assumed to
1830have the same extension as the main template if it
1831lacks an extension. When calling the partial, the
1832full name including file extension can also be used:
1838(If a partial is not found in the directory of the
1839template, it will also be sought in the `templates`
1840subdirectory of the user data directory.)
1842Partials may optionally be applied to variables using
1848${ articles:bibentry() }
1851If `articles` is an array, this will iterate over its
1852values, applying the partial `bibentry()` to each one. So the
1853second example above is equivalent to
1861Note that the anaphoric keyword `it` must be used when
1862iterating over partials. In the above examples,
1863the `bibentry` partial should contain `it.title`
1864(and so on) instead of `articles.title`.
1866Final newlines are omitted from included partials.
1868Partials may include other partials.
1870A separator between values of an array may be specified
1871in square brackets, immediately after the variable name
1877${articles:bibentry()[; ]$
1880The separator in this case is literal and (unlike with `sep`
1881in an explicit `for` loop) cannot contain interpolated
1882variables or other template directives.
1886To ensure that content is "nested," that is, subsequent lines
1887indented, use the `^` directive:
1890$item.number$ $^$$item.description$ ($item.price$)
1893In this example, if `item.description` has multiple lines,
1894they will all be indented to line up with the first line:
189700123 A fine bottle of 18-year old
1898 Oban whiskey. ($148)
1901To nest multiple lines to the same level, align them
1902with the `^` directive in the template. For example:
1905$item.number$ $^$$item.description$ ($item.price$)
1906 (Available til $item.sellby$.)
191200123 A fine bottle of 18-year old
1913 Oban whiskey. ($148)
1914 (Available til March 30, 2020.)
1917If a variable occurs by itself on a line, preceded by whitespace
1918and not followed by further text or directives on the same line,
1919and the variable's value contains multiple lines, it will be
1920nested automatically.
1924Normally, spaces in the template itself (as opposed to values of
1925the interpolated variables) are not breakable, but they can be
1926made breakable in part of the template by using the `~` keyword
1927(ended with another `~`).
1930$~$This long line may break if the document is rendered
1931with a short line length.$~$
1936A pipe transforms the value of a variable or partial. Pipes are
1937specified using a slash (`/`) between the variable name (or partial)
1938and the pipe name. Example:
1945$for(metadata/pairs)$
1946- $it.key$: $it.value$
1949$employee:name()/uppercase$
1952Pipes may be chained:
1955$for(employees/pairs)$
1956$it.key/alpha/uppercase$. $it.name$
1960Some pipes take parameters:
1963|----------------------|------------|
1965$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1967|----------------------|------------|
1970Currently the following pipes are predefined:
1972- `pairs`: Converts a map or array to an array of maps,
1973 each with `key` and `value` fields. If the original
1974 value was an array, the `key` will be the array index,
1977- `uppercase`: Converts text to uppercase.
1979- `lowercase`: Converts text to lowercase.
1981- `length`: Returns the length of the value: number
1982 of characters for a textual value, number of elements
1985- `reverse`: Reverses a textual value or array,
1986 and has no effect on other values.
1988- `first`: Returns the first value of an array, if
1989 applied to a non-empty array; otherwise returns
1992- `last`: Returns the last value of an array, if
1993 applied to a non-empty array; otherwise returns
1996- `rest`: Returns all but the first value of an array, if
1997 applied to a non-empty array; otherwise returns
2000- `allbutlast`: Returns all but the last value of an array, if
2001 applied to a non-empty array; otherwise returns
2004- `chomp`: Removes trailing newlines (and breakable space).
2006- `nowrap`: Disables line wrapping on breakable spaces.
2008- `alpha`: Converts textual values that can be
2009 read as an integer into lowercase alphabetic
2010 characters `a..z` (mod 26). This can be used to get lettered
2011 enumeration from array indices. To get uppercase
2012 letters, chain with `uppercase`.
2014- `roman`: Converts textual values that can be
2015 read as an integer into lowercase roman numerials.
2016 This can be used to get lettered enumeration from array indices.
2017 To get uppercase roman, chain with `uppercase`.
2019- `left n "leftborder" "rightborder"`: Renders a textual value
2020 in a block of width `n`, aligned to the left, with an optional
2021 left and right border. Has no effect on other values. This
2022 can be used to align material in tables. Widths are positive
2023 integers indicating the number of characters. Borders
2024 are strings inside double quotes; literal `"` and `\` characters
2025 must be backslash-escaped.
2027- `right n "leftborder" "rightborder"`: Renders a textual value
2028 in a block of width `n`, aligned to the right, and has no
2029 effect on other values.
2031- `center n "leftborder" "rightborder"`: Renders a textual
2032 value in a block of width `n`, aligned to the center, and has
2033 no effect on other values.
2038### Metadata variables
2040`title`, `author`, `date`
2041: allow identification of basic aspects of the document. Included
2042 in PDF metadata through LaTeX and ConTeXt. These can be set
2043 through a [pandoc title block][Extension: `pandoc_title_block`],
2044 which allows for multiple authors, or through a
2045 [YAML metadata block][Extension: `yaml_metadata_block`]:
2053 Note that if you just want to set PDF or HTML metadata, without
2054 including a title block in the document itself, you can
2055 set the `title-meta`, `author-meta`, and `date-meta`
2056 variables. (By default these are set automatically, based
2057 on `title`, `author`, and `date`.)
2060: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2064: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2068: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2069 and AsciiDoc metadata; repeat as for `author`, above
2072: document subject, included in ODT, PDF, docx and pptx metadata
2075: document description, included in ODT, docx and pptx metadata. Some
2076 applications show this as `Comments` metadata.
2079: document category, included in docx and pptx metadata
2082any root-level string metadata, not included in ODT, docx
2083or pptx metadata is added as a *custom property*.
2084The following [YAML] metadata block for instance:
2087 title: 'This is the title'
2088 subtitle: "This is the subtitle"
2096 It consists of two paragraphs
2099will include `title`, `author` and `description` as standard document
2100properties and `subtitle` as a custom property when converting to docx,
2103### Language variables
2106: identifies the main language of the document using IETF language
2107 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2108 The [Language subtag lookup] tool can look up or verify these tags.
2109 This affects most formats, and controls hyphenation in PDF output
2110 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2112 Use native pandoc [Divs and Spans] with the `lang` attribute to
2113 switch the language:
2119 Text in the main document language (British English).
2122 > Cette citation est écrite en français canadien.
2125 More text in English. ['Zitat auf Deutsch.']{lang=de}
2128: the base script direction, either `rtl` (right-to-left)
2129 or `ltr` (left-to-right).
2131 For bidirectional documents, native pandoc `span`s and `div`s
2132 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2133 override the base direction in some output formats.
2134 This may not always be necessary if the final renderer
2135 (e.g. the browser, when generating HTML) supports the
2136 [Unicode Bidirectional Algorithm].
2138 When using LaTeX for bidirectional documents, only the `xelatex` engine
2139 is fully supported (use `--pdf-engine=xelatex`).
2141[BCP 47]: https://tools.ietf.org/html/bcp47
2142[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2143[Language subtag lookup]: https://r12a.github.io/app-subtags/
2145### Variables for HTML math
2148: when using [KaTeX](#option--katex), you can render display math equations
2149 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2151### Variables for HTML slides
2153These affect HTML output when [producing slide shows with pandoc].
2155All [reveal.js configuration options] are available as variables.
2156To turn off boolean flags that default to true in reveal.js, use `0`.
2159: base URL for reveal.js documents (defaults to
2160 `https://unpkg.com/reveal.js@^4/`)
2163: base URL for S5 documents (defaults to `s5/default`)
2166: base URL for Slidy documents (defaults to
2167 `https://www.w3.org/Talks/Tools/Slidy2`)
2170: base URL for Slideous documents (defaults to `slideous`)
2172`title-slide-attributes`
2173: additional attributes for the title slide of reveal.js slide shows.
2174 See [background in reveal.js and beamer] for an example.
2176[reveal.js configuration options]: https://revealjs.com/config/
2178### Variables for Beamer slides
2180These variables change the appearance of PDF slides using [`beamer`].
2183: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2184 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2188: produce an article from Beamer slides
2191: add extra beamer option with `\setbeameroption{}`
2194: author affiliations: can be a list when there are multiple authors
2197: logo image for slides
2200: controls navigation symbols (default is `empty` for no navigation
2201 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2204: enables "title pages" for new sections (default is true)
2206`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2210: options for LaTeX beamer themes (a list).
2213: image for title slide
2215### Variables for PowerPoint
2217These variables control the visual aspects of a slide show that
2218are not easily controlled via templates.
2221: font to use for code.
2223### Variables for LaTeX
2225Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2230: make `\paragraph` and `\subparagraph` (fourth- and
2231 fifth-level headings, or fifth- and sixth-level with book
2232 classes) free-standing rather than run-in; requires further
2233 formatting to distinguish from `\subsubsection` (third- or
2234 fourth-level headings). Instead of using this option,
2235 [KOMA-Script] can adjust headings more extensively:
2238 documentclass: scrartcl
2240 \RedeclareSectionCommand[
2241 beforeskip=-10pt plus -2pt minus -1pt,
2242 afterskip=1sp plus -1sp minus 1sp,
2243 font=\normalfont\itshape]{paragraph}
2244 \RedeclareSectionCommand[
2245 beforeskip=-10pt plus -2pt minus -1pt,
2246 afterskip=1sp plus -1sp minus 1sp,
2247 font=\normalfont\scshape,
2248 indent=0pt]{subparagraph}
2252: option for document class, e.g. `oneside`; repeat for multiple options:
2261: document class: usually one of the standard classes, [`article`], [`book`],
2262 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2263 and `scrreprt`, which default to smaller margins; or [`memoir`]
2266: option for [`geometry`] package, e.g. `margin=1in`;
2267 repeat for multiple options:
2277: option for [`hyperref`] package, e.g. `linktoc=all`;
2278 repeat for multiple options:
2284 - pdfpagemode=FullScreen
2288: uses document class settings for indentation (the default LaTeX template
2289 otherwise removes indentation and adds space between paragraphs)
2292: adjusts line spacing using the [`setspace`]
2293 package, e.g. `1.25`, `1.5`
2295`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2296: sets margins if `geometry` is not used (otherwise `geometry`
2300: control `\pagestyle{}`: the default article class
2301 supports `plain` (default), `empty` (no running heads or page numbers),
2302 and `headings` (section titles in running heads)
2305: paper size, e.g. `letter`, `a4`
2308: numbering depth for sections (with `--number-sections` option
2309 or `numbersections` variable)
2314: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2315 default is `T1` (see [LaTeX font encodings guide])
2318: font package for use with `pdflatex`:
2319 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2320 The default is [Latin Modern][`lm`].
2323: options for package used as `fontfamily`; repeat for multiple options.
2324 For example, to use the Libertine font with proportional lowercase
2325 (old-style) figures through the [`libertinus`] package:
2328 fontfamily: libertinus
2335: font size for body text. The standard classes allow 10pt, 11pt, and
2336 12pt. To use another size, set `documentclass` to one of
2337 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2339`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2340: font families for use with `xelatex` or
2341 `lualatex`: take the name of any system font, using the
2342 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2344`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2345: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2346 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2347 choices available through [`fontspec`]; repeat for multiple
2348 options. For example, to use the [TeX Gyre] version of
2349 Palatino with lowercase figures:
2352 mainfont: TeX Gyre Pagella
2355 - Numbers=Proportional
2359: options to pass to the microtype package
2364: add color to link text; automatically enabled if any of
2365 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2367`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2368: color for internal links, external links, citation links, linked
2369 URLs, and links in table of contents, respectively: uses options
2370 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2374: causes links to be printed as footnotes
2379: include list of figures, list of tables
2382: contents of acknowledgments footnote after document title
2385: include table of contents (can also be set using `--toc/--table-of-contents`)
2388: level of section to include in table of contents
2390#### BibLaTeX Bibliographies
2392These variables function when using BibLaTeX for [citation rendering].
2395: list of options for biblatex
2398: bibliography style, when used with `--natbib` and `--biblatex`.
2401: bibliography title, when used with `--natbib` and `--biblatex`.
2404: bibliography to use for resolving references
2407: list of options for natbib
2409[KOMA-Script]: https://ctan.org/pkg/koma-script
2410[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2411[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2412[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2413[`article`]: https://ctan.org/pkg/article
2414[`book`]: https://ctan.org/pkg/book
2415[`libertinus`]: https://ctan.org/pkg/libertinus
2416[`memoir`]: https://ctan.org/pkg/memoir
2417[`report`]: https://ctan.org/pkg/report
2419### Variables for ConTeXt
2421Pandoc uses these variables when [creating a PDF] with ConTeXt.
2424: font size for body text (e.g. `10pt`, `12pt`)
2426`headertext`, `footertext`
2427: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2428 repeat up to four times for different placement
2431: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2432 repeat for multiple options
2435: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2436 repeat for multiple options
2439: options for page margins and text arrangement (see [ConTeXt Layout]);
2440 repeat for multiple options
2442`linkcolor`, `contrastcolor`
2443: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2446: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2449: include list of figures, list of tables
2451`mainfont`, `sansfont`, `monofont`, `mathfont`
2452: font families: take the name of any system font (see [ConTeXt Font Switching])
2454`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2455: sets margins, if `layout` is not used (otherwise `layout`
2459: page number style and location (using [`setuppagenumbering`]);
2460 repeat for multiple options
2463: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2464 repeat for multiple options
2467: adds to the preamble the setup necessary to generate PDF/A of the type
2468 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2469 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2470 block), `1b:2005` will be used as default, for reasons of backwards
2471 compatibility. Using `--variable=pdfa` without specified value is not supported.
2472 To successfully generate PDF/A the required ICC color profiles have to
2473 be available and the content and all included files (such as images)
2474 have to be standard conforming. The ICC profiles and output intent
2475 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2476 See also [ConTeXt PDFA] for more details.
2479: when used in conjunction with `pdfa`, specifies the ICC profile to use
2480 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2481 used as default. May be repeated to include multiple profiles. Note that
2482 the profiles have to be available on the system. They can be obtained
2483 from [ConTeXt ICC Profiles].
2486: when used in conjunction with `pdfa`, specifies the output intent for
2487 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2488 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2491: include table of contents (can also be set using `--toc/--table-of-contents`)
2494: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2497: include all source documents as file attachments in the PDF file
2499[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2500[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2501[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2502[ConTeXt Color]: https://wiki.contextgarden.net/Color
2503[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2504[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2505[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2506[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2507[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2508[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2509[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2511### Variables for `wkhtmltopdf`
2513Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2514The `--css` option also affects the output.
2516`footer-html`, `header-html`
2517: add information to the header and footer
2519`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2520: set the page margins
2523: sets the PDF paper size
2525### Variables for man pages
2528: adjusts text to left (`l`), right (`r`), center (`c`),
2529 or both (`b`) margins
2532: footer in man pages
2535: header in man pages
2538: if `true` (the default), hyphenation will be used
2541: section number in man pages
2546: font family (e.g. `T` or `P`)
2549: paragraph indent (e.g. `2m`)
2552: line height (e.g. `12p`)
2555: point size (e.g. `10p`)
2557### Variables set automatically
2559Pandoc sets these variables automatically in response to [options] or
2560document contents; users can also modify them. These vary depending
2561on the output format, and include the following:
2567: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2568 included in all HTML based formats (dzslides, epub,
2569 html, html4, html5, revealjs, s5, slideous, slidy).
2570 The recognized formats for `date` are: `mm/dd/yyyy`,
2571 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2572 (e.g. either `02 Apr 2018` or `02 April 2018`),
2573 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2574 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2577: contents specified by `-H/--include-in-header` (may have multiple
2581: contents specified by `-B/--include-before-body` (may have
2585: contents specified by `-A/--include-after-body` (may have
2589: JSON representation of all of the document's metadata. Field
2590 values are transformed to the selected output format.
2593: non-null value if `-N/--number-sections` was specified
2595`sourcefile`, `outputfile`
2596: source and destination filenames, as given on the command line.
2597 `sourcefile` can also be a list if input comes from multiple files,
2598 or empty if input is from stdin. You can use the following snippet in
2599 your template to distinguish them:
2609 Similarly, `outputfile` can be `-` if output goes to the terminal.
2611 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2614: working directory from which pandoc is run.
2617: non-null value if `--toc/--table-of-contents` was specified
2620: title of table of contents (works only with EPUB,
2621 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2623[pandoc-templates]: https://github.com/jgm/pandoc-templates
2627The behavior of some of the readers and writers can be adjusted by
2628enabling or disabling various extensions.
2630An extension can be enabled by adding `+EXTENSION`
2631to the format name and disabled by adding `-EXTENSION`. For example,
2632`--from markdown_strict+footnotes` is strict Markdown with footnotes
2633enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2634Markdown without footnotes or pipe tables.
2636The markdown reader and writer make by far the most use of extensions.
2637Extensions only used by them are therefore covered in the
2638section [Pandoc's Markdown] below (See [Markdown variants] for
2639`commonmark` and `gfm`.) In the following, extensions that also work
2640for other formats are covered.
2642Note that markdown extensions added to the `ipynb` format
2643affect Markdown cells in Jupyter notebooks (as do command-line
2644options like `--atx-headers`).
2648#### Extension: `smart` ####
2650Interpret straight quotes as curly quotes, `---` as em-dashes,
2651`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2652inserted after certain abbreviations, such as "Mr."
2654This extension can be enabled/disabled for the following formats:
2657: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2660: `markdown`, `latex`, `context`, `rst`
2662enabled by default in
2663: `markdown`, `latex`, `context` (both input and output)
2665Note: If you are *writing* Markdown, then the `smart` extension
2666has the reverse effect: what would have been curly quotes comes
2669In LaTeX, `smart` means to use the standard TeX ligatures
2670for quotation marks (` `` ` and ` '' ` for double quotes,
2671`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2672en-dash and `---` for em-dash). If `smart` is disabled,
2673then in reading LaTeX pandoc will parse these characters
2674literally. In writing LaTeX, enabling `smart` tells pandoc
2675to use the ligatures when possible; if `smart` is disabled
2676pandoc will use unicode quotation mark and dash characters.
2678## Headings and sections
2680#### Extension: `auto_identifiers` ####
2682A heading without an explicitly specified identifier will be
2683automatically assigned a unique identifier based on the heading text.
2685This extension can be enabled/disabled for the following formats:
2688: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2693enabled by default in
2696The default algorithm used to derive the identifier from the
2699 - Remove all formatting, links, etc.
2700 - Remove all footnotes.
2701 - Remove all non-alphanumeric characters,
2702 except underscores, hyphens, and periods.
2703 - Replace all spaces and newlines with hyphens.
2704 - Convert all alphabetic characters to lowercase.
2705 - Remove everything up to the first letter (identifiers may
2706 not begin with a number or punctuation mark).
2707 - If nothing is left after this, use the identifier `section`.
2712 ------------------------------- ----------------------------
2713 `Heading identifiers in HTML` `heading-identifiers-in-html`
2714 `Maître d'hôtel` `maître-dhôtel`
2715 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2716 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2717 `3. Applications` `applications`
2720These rules should, in most cases, allow one to determine the identifier
2721from the heading text. The exception is when several headings have the
2722same text; in this case, the first will get an identifier as described
2723above; the second will get the same identifier with `-1` appended; the
2724third with `-2`; and so on.
2726(However, a different algorithm is used if
2727`gfm_auto_identifiers` is enabled; see below.)
2729These identifiers are used to provide link targets in the table of
2730contents generated by the `--toc|--table-of-contents` option. They
2731also make it easy to provide links from one section of a document to
2732another. A link to this section, for example, might look like this:
2735 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2737Note, however, that this method of providing links to sections works
2738only in HTML, LaTeX, and ConTeXt formats.
2740If the `--section-divs` option is specified, then each section will
2741be wrapped in a `section` (or a `div`, if `html4` was specified),
2742and the identifier will be attached to the enclosing `<section>`
2743(or `<div>`) tag rather than the heading itself. This allows entire
2744sections to be manipulated using JavaScript or treated differently in
2747#### Extension: `ascii_identifiers` ####
2749Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2750Accents are stripped off of accented Latin letters, and non-Latin
2753#### Extension: `gfm_auto_identifiers` ####
2755Changes the algorithm used by `auto_identifiers` to conform to
2756GitHub's method. Spaces are converted to dashes (`-`),
2757uppercase characters to lowercase characters, and punctuation
2758characters other than `-` and `_` are removed.
2759Emojis are replaced by their names.
2763The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2764[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2765[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2766are described in the section about Pandoc's Markdown.
2768However, they can also be used with HTML input. This is handy for
2769reading web pages formatted using MathJax, for example.
2773The following extensions are described in more detail in
2774their respective sections of [Pandoc's Markdown]:
2776- [`raw_html`](#extension-raw_html) allows HTML elements which
2777 are not representable in pandoc's AST to be parsed as raw HTML.
2778 By default, this is disabled for HTML input.
2780- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2781 to be included in a document. This extension can be enabled/disabled
2782 for the following formats (in addition to `markdown`):
2785 : `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2786 `\eqref` only), `ipynb`
2789 : `textile`, `commonmark`
2791 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2792 only raw TeX in markdown cells, but data with mime type
2793 `text/html` in output cells. Since the `ipynb` reader attempts
2794 to preserve the richest possible outputs when several options
2795 are given, you will get best results if you disable `raw_html`
2796 and `raw_tex` when converting to formats like `docx` which don't
2797 allow raw `html` or `tex`.
2799- [`native_divs`](#extension-native_divs) causes HTML `div`
2800 elements to be parsed as native pandoc Div blocks.
2801 If you want them to be parsed as raw HTML, use
2802 `-f html-native_divs+raw_html`.
2804- [`native_spans`](#extension-native_spans) causes HTML `span`
2805 elements to be parsed as native pandoc Span inlines.
2806 If you want them to be parsed as raw HTML, use
2807 `-f html-native_spans+raw_html`. If you want to drop all
2808 `div`s and `span`s when converting HTML to Markdown, you
2809 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2811## Literate Haskell support
2813#### Extension: `literate_haskell` ####
2815Treat the document as literate Haskell source.
2817This extension can be enabled/disabled for the following formats:
2820: `markdown`, `rst`, `latex`
2823: `markdown`, `rst`, `latex`, `html`
2825If you append `+lhs` (or `+literate_haskell`) to one of the formats
2826above, pandoc will treat the document as literate Haskell source.
2829 - In Markdown input, "bird track" sections will be parsed as Haskell
2830 code rather than block quotations. Text between `\begin{code}`
2831 and `\end{code}` will also be treated as Haskell code. For
2832 ATX-style headings the character '=' will be used instead of '#'.
2834 - In Markdown output, code blocks with classes `haskell` and `literate`
2835 will be rendered using bird tracks, and block quotations will be
2836 indented one space, so they will not be treated as Haskell code.
2837 In addition, headings will be rendered setext-style (with underlines)
2838 rather than ATX-style (with '#' characters). (This is because ghc
2839 treats '#' characters in column 1 as introducing line numbers.)
2841 - In restructured text input, "bird track" sections will be parsed
2844 - In restructured text output, code blocks with class `haskell` will
2845 be rendered using bird tracks.
2847 - In LaTeX input, text in `code` environments will be parsed as
2850 - In LaTeX output, code blocks with class `haskell` will be rendered
2851 inside `code` environments.
2853 - In HTML output, code blocks with class `haskell` will be rendered
2854 with class `literatehaskell` and bird tracks.
2858 pandoc -f markdown+lhs -t html
2860reads literate Haskell source formatted with Markdown conventions and writes
2861ordinary HTML (without bird tracks).
2863 pandoc -f markdown+lhs -t html+lhs
2865writes HTML with the Haskell code in bird tracks, so it can be copied
2866and pasted as literate Haskell source.
2868Note that GHC expects the bird tracks in the first column, so indented
2869literate code blocks (e.g. inside an itemized environment) will not be
2870picked up by the Haskell compiler.
2874#### Extension: `empty_paragraphs` ####
2876Allows empty paragraphs. By default empty paragraphs are
2879This extension can be enabled/disabled for the following formats:
2885: `docx`, `odt`, `opendocument`, `html`
2887#### Extension: `native_numbering` ####
2889Enables native numbering of figures and tables. Enumeration
2892This extension can be enabled/disabled for the following formats:
2895: `odt`, `opendocument`
2897#### Extension: `styles` {#ext-styles} ####
2899When converting from docx, read all docx styles as divs (for
2900paragraph styles) and spans (for character styles) regardless
2901of whether pandoc understands the meaning of these styles.
2902This can be used with [docx custom styles](#custom-styles).
2908#### Extension: `amuse` ####
2910In the `muse` input format, this enables Text::Amuse
2911extensions to Emacs Muse markup.
2913#### Extension: `raw_markdown` ####
2915In the `ipynb` input format, this causes Markdown cells
2916to be included as raw Markdown blocks (allowing lossless
2917round-tripping) rather than being parsed. Use this only
2918when you are targetting `ipynb` or a markdown-based
2921#### Extension: `citations` {#org-citations}
2923Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2926#### Extension: `ntb` ####
2928In the `context` output format this enables the use of [Natural Tables
2929(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2930[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2931Natural tables allow more fine-grained global customization but come
2932at a performance penalty compared to extreme tables.
2937Pandoc understands an extended and slightly revised version of
2938John Gruber's [Markdown] syntax. This document explains the syntax,
2939noting differences from standard Markdown. Except where noted, these
2940differences can be suppressed by using the `markdown_strict` format instead
2941of `markdown`. Extensions can be enabled or disabled to specify the
2942behavior more granularly. They are described in the following. See also
2943[Extensions] above, for extensions that work also on other formats.
2947Markdown is designed to be easy to write, and, even more importantly,
2950> A Markdown-formatted document should be publishable as-is, as plain
2951> text, without looking like it's been marked up with tags or formatting
2953> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2955This principle has guided pandoc's decisions in finding syntax for
2956tables, footnotes, and other extensions.
2958There is, however, one respect in which pandoc's aims are different
2959from the original aims of Markdown. Whereas Markdown was originally
2960designed with HTML generation in mind, pandoc is designed for multiple
2961output formats. Thus, while pandoc allows the embedding of raw HTML,
2962it discourages it, and provides other, non-HTMLish ways of representing
2963important document elements like definition lists, tables, mathematics, and
2968A paragraph is one or more lines of text followed by one or more blank lines.
2969Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2970If you need a hard line break, put two or more spaces at the end of a line.
2972#### Extension: `escaped_line_breaks` ####
2974A backslash followed by a newline is also a hard line break.
2975Note: in multiline and grid table cells, this is the only way
2976to create a hard line break, since trailing spaces in the cells
2981There are two kinds of headings: Setext and ATX.
2983### Setext-style headings ###
2985A setext-style heading is a line of text "underlined" with a row of `=` signs
2986(for a level-one heading) or `-` signs (for a level-two heading):
2994The heading text can contain inline formatting, such as emphasis (see
2995[Inline formatting], below).
2998### ATX-style headings ###
3000An ATX-style heading consists of one to six `#` signs and a line of
3001text, optionally followed by any number of `#` signs. The number of
3002`#` signs at the beginning of the line is the heading level:
3004 ## A level-two heading
3006 ### A level-three heading ###
3008As with setext-style headings, the heading text can contain formatting:
3010 # A level-one heading with a [link](/url) and *emphasis*
3012#### Extension: `blank_before_header` ####
3014Standard Markdown syntax does not require a blank line before a heading.
3015Pandoc does require this (except, of course, at the beginning of the
3016document). The reason for the requirement is that it is all too easy for a
3017`#` to end up at the beginning of a line by accident (perhaps through line
3018wrapping). Consider, for example:
3020 I like several of their flavors of ice cream:
3021 #22, for example, and #5.
3023#### Extension: `space_in_atx_header` ####
3025Many Markdown implementations do not require a space between the
3026opening `#`s of an ATX heading and the heading text, so that
3027`#5 bolt` and `#hashtag` count as headings. With this extension,
3028pandoc does require the space.
3030### Heading identifiers ###
3032See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3034#### Extension: `header_attributes` ####
3036Headings can be assigned attributes using this syntax at the end
3037of the line containing the heading text:
3039 {#identifier .class .class key=value key=value}
3041Thus, for example, the following headings will all be assigned the identifier
3046 ## My heading ## {#foo}
3048 My other heading {#foo}
3051(This syntax is compatible with [PHP Markdown Extra].)
3053Note that although this syntax allows assignment of classes and key/value
3054attributes, writers generally don't use all of this information. Identifiers,
3055classes, and key/value attributes are used in HTML and HTML-based formats such
3056as EPUB and slidy. Identifiers are used for labels and link anchors in the
3057LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3059Headings with the class `unnumbered` will not be numbered, even if
3060`--number-sections` is specified. A single hyphen (`-`) in an attribute
3061context is equivalent to `.unnumbered`, and preferable in non-English
3068 # My heading {.unnumbered}
3070If the `unlisted` class is present in addition to `unnumbered`,
3071the heading will not be included in a table of contents.
3072(Currently this feature is only implemented for certain
3073formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3075#### Extension: `implicit_header_references` ####
3077Pandoc behaves as if reference links have been defined for each heading.
3078So, to link to a heading
3080 # Heading identifiers in HTML
3084 [Heading identifiers in HTML]
3088 [Heading identifiers in HTML][]
3092 [the section on heading identifiers][heading identifiers in
3095instead of giving the identifier explicitly:
3097 [Heading identifiers in HTML](#heading-identifiers-in-html)
3099If there are multiple headings with identical text, the corresponding
3100reference will link to the first one only, and you will need to use explicit
3101links to link to the others, as described above.
3103Like regular reference links, these references are case-insensitive.
3105Explicit link reference definitions always take priority over
3106implicit heading references. So, in the following example, the
3107link will point to `bar`, not to `#foo`:
3117Markdown uses email conventions for quoting blocks of text.
3118A block quotation is one or more paragraphs or other block elements
3119(such as lists or headings), with each line preceded by a `>` character
3120and an optional space. (The `>` need not start at the left margin, but
3121it should not be indented more than three spaces.)
3123 > This is a block quote. This
3124 > paragraph has two lines.
3126 > 1. This is a list inside a block quote.
3129A "lazy" form, which requires the `>` character only on the first
3130line of each block, is also allowed:
3132 > This is a block quote. This
3133 paragraph has two lines.
3135 > 1. This is a list inside a block quote.
3138Among the block elements that can be contained in a block quote are
3139other block quotes. That is, block quotes can be nested:
3141 > This is a block quote.
3143 > > A block quote within a block quote.
3145If the `>` character is followed by an optional space, that space
3146will be considered part of the block quote marker and not part of
3147the indentation of the contents. Thus, to put an indented code
3148block in a block quote, you need five spaces after the `>`:
3152#### Extension: `blank_before_blockquote` ####
3154Standard Markdown syntax does not require a blank line before a block
3155quote. Pandoc does require this (except, of course, at the beginning of the
3156document). The reason for the requirement is that it is all too easy for a
3157`>` to end up at the beginning of a line by accident (perhaps through line
3158wrapping). So, unless the `markdown_strict` format is used, the following does
3159not produce a nested block quote in pandoc:
3161 > This is a block quote.
3165## Verbatim (code) blocks
3167### Indented code blocks ###
3169A block of text indented four spaces (or one tab) is treated as verbatim
3170text: that is, special characters do not trigger special formatting,
3171and all spaces and line breaks are preserved. For example,
3174 moveShip(5 * gravity, DOWN);
3177The initial (four space or one tab) indentation is not considered part
3178of the verbatim text, and is removed in the output.
3180Note: blank lines in the verbatim text need not begin with four spaces.
3183### Fenced code blocks ###
3185#### Extension: `fenced_code_blocks` ####
3187In addition to standard indented code blocks, pandoc supports
3188*fenced* code blocks. These begin with a row of three or more
3189tildes (`~`) and end with a row of tildes that must be at least as long as
3190the starting row. Everything between these lines is treated as code. No
3191indentation is necessary:
3195 moveShip(5 * gravity, DOWN);
3199Like regular code blocks, fenced code blocks must be separated
3200from surrounding text by blank lines.
3202If the code itself contains a row of tildes or backticks, just use a longer
3203row of tildes or backticks at the start and end:
3207 code including tildes
3211#### Extension: `backtick_code_blocks` ####
3213Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3216#### Extension: `fenced_code_attributes` ####
3218Optionally, you may attach attributes to fenced or backtick code block using
3221 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3223 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3224 qsort (filter (>= x) xs)
3225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3227Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3228`startFrom` is an attribute with value `100`. Some output formats can use this
3229information to do syntax highlighting. Currently, the only output formats
3230that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3231highlighting is supported for your output format and language, then the code
3232block above will appear highlighted, with numbered lines. (To see which
3233languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3234the code block above will appear as follows:
3236 <pre id="mycode" class="haskell numberLines" startFrom="100">
3242The `numberLines` (or `number-lines`) class will cause the lines
3243of the code block to be numbered, starting with `1` or the value
3244of the `startFrom` attribute. The `lineAnchors` (or
3245`line-anchors`) class will cause the lines to be clickable
3246anchors in HTML output.
3248A shortcut form can also be used for specifying the language of
3255This is equivalent to:
3261If the `fenced_code_attributes` extension is disabled, but
3262input contains class attribute(s) for the code block, the first
3263class attribute will be printed after the opening fence as a bare
3266To prevent all highlighting, use the `--no-highlight` flag.
3267To set the highlighting style, use `--highlight-style`.
3268For more information on highlighting, see [Syntax highlighting],
3273#### Extension: `line_blocks` ####
3275A line block is a sequence of lines beginning with a vertical bar (`|`)
3276followed by a space. The division into lines will be preserved in
3277the output, as will any leading spaces; otherwise, the lines will
3278be formatted as Markdown. This is useful for verse and addresses:
3280 | The limerick packs laughs anatomical
3281 | In space that is quite economical.
3282 | But the good ones I've seen
3283 | So seldom are clean
3284 | And the clean ones so seldom are comical
3287 | Berkeley, CA 94718
3289The lines can be hard-wrapped if needed, but the continuation
3290line must begin with a space.
3292 | The Right Honorable Most Venerable and Righteous Samuel L.
3295 | Berkeley, CA 94718
3297This syntax is borrowed from [reStructuredText].
3303A bullet list is a list of bulleted list items. A bulleted list
3304item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3311This will produce a "compact" list. If you want a "loose" list, in which
3312each item is formatted as a paragraph, put spaces between the items:
3320The bullets need not be flush with the left margin; they may be
3321indented one, two, or three spaces. The bullet must be followed
3324List items look best if subsequent lines are flush with the first
3325line (after the bullet):
3331But Markdown also allows a "lazy" format:
3337### Block content in list items ###
3339A list item may contain multiple paragraphs and other block-level
3340content. However, subsequent paragraphs must be preceded by a blank line
3341and indented to line up with the first non-space content after
3348 * Second paragraph. With a code block, which must be indented
3353Exception: if the list marker is followed by an indented code
3354block, which must begin 5 spaces after the list marker, then
3355subsequent paragraphs must begin two columns after the last
3356character of the list marker:
3360 continuation paragraph
3362List items may include other lists. In this case the preceding blank
3363line is optional. The nested list must be indented to line up with
3364the first non-space character after the list marker of the
3365containing list item.
3377As noted above, Markdown allows you to write list items "lazily," instead of
3378indenting continuation lines. However, if there are multiple paragraphs or
3379other blocks in a list item, the first line of each must be indented.
3381 + A lazy, lazy, list
3384 + Another one; this looks
3387 Second paragraph of second
3390### Ordered lists ###
3392Ordered lists work just like bulleted lists, except that the items
3393begin with enumerators rather than bullets.
3395In standard Markdown, enumerators are decimal numbers followed
3396by a period and a space. The numbers themselves are ignored, so
3397there is no difference between this list:
3409#### Extension: `fancy_lists` ####
3411Unlike standard Markdown, pandoc allows ordered list items to be marked
3412with uppercase and lowercase letters and roman numerals, in addition to
3413Arabic numerals. List markers may be enclosed in parentheses or followed by a
3414single right-parentheses or period. They must be separated from the
3415text that follows by at least one space, and, if the list marker is a
3416capital letter with a period, by at least two spaces.[^2]
3418[^2]: The point of this rule is to ensure that normal paragraphs
3419 starting with people's initials, like
3421 B. Russell was an English philosopher.
3423 do not get treated as list items.
3425 This rule will not prevent
3429 from being interpreted as a list item. In this case, a backslash
3434The `fancy_lists` extension also allows '`#`' to be used as an
3435ordered list marker in place of a numeral:
3440#### Extension: `startnum` ####
3442Pandoc also pays attention to the type of list marker used, and to the
3443starting number, and both of these are preserved where possible in the
3444output format. Thus, the following yields a list with numbers followed
3445by a single parenthesis, starting with 9, and a sublist with lowercase
3455Pandoc will start a new list each time a different type of list
3456marker is used. So, the following will create three lists:
3463If default list markers are desired, use `#.`:
3469#### Extension: `task_lists` ####
3471Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3473 - [ ] an unchecked task list item
3476### Definition lists ###
3478#### Extension: `definition_lists` ####
3480Pandoc supports definition lists, using the syntax of
3481[PHP Markdown Extra] with some extensions.[^3]
3487 Term 2 with *inline markup*
3491 { some code, part of Definition 2 }
3493 Third paragraph of definition 2.
3495Each term must fit on one line, which may optionally be followed by
3496a blank line, and must be followed by one or more definitions.
3497A definition begins with a colon or tilde, which may be indented one
3500A term may have multiple definitions, and each definition may consist of one or
3501more block elements (paragraph, code block, list, etc.), each indented four
3502spaces or one tab stop. The body of the definition (including the first line,
3503aside from the colon or tilde) should be indented four spaces. However,
3504as with other Markdown lists, you can "lazily" omit indentation except
3505at the beginning of a paragraph or other block element:
3510 with lazy continuation.
3512 Second paragraph of the definition.
3514If you leave space before the definition (as in the example above),
3515the text of the definition will be treated as a paragraph. In some
3516output formats, this will mean greater spacing between term/definition
3517pairs. For a more compact definition list, omit the space before the
3527Note that space between items in a definition list is required.
3528(A variant that loosens this requirement, but disallows "lazy"
3529hard wrapping, can be activated with `compact_definition_lists`: see
3530[Non-pandoc extensions], below.)
3532[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3534### Numbered example lists ###
3536#### Extension: `example_lists` ####
3538The special list marker `@` can be used for sequentially numbered
3539examples. The first list item with a `@` marker will be numbered '1',
3540the next '2', and so on, throughout the document. The numbered examples
3541need not occur in a single list; each new list using `@` will take up
3542where the last stopped. So, for example:
3544 (@) My first example will be numbered (1).
3545 (@) My second example will be numbered (2).
3547 Explanation of examples.
3549 (@) My third example will be numbered (3).
3551Numbered examples can be labeled and referred to elsewhere in the
3554 (@good) This is a good example.
3556 As (@good) illustrates, ...
3558The label can be any string of alphanumeric characters, underscores,
3561Note: continuation paragraphs in example lists must always
3562be indented four spaces, regardless of the length of the
3563list marker. That is, example lists always behave as if the
3564`four_space_rule` extension is set. This is because example
3565labels tend to be long, and indenting content to the
3566first non-space character after the label would be awkward.
3568### Compact and loose lists ###
3570Pandoc behaves differently from `Markdown.pl` on some "edge
3571cases" involving lists. Consider this source:
3581Pandoc transforms this into a "compact list" (with no `<p>` tags around
3582"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3583"Second" and "Third" (but not "First"), because of the blank space
3584around "Third". Pandoc follows a simple rule: if the text is followed by
3585a blank line, it is treated as a paragraph. Since "Second" is followed
3586by a list, and not a blank line, it isn't treated as a paragraph. The
3587fact that the list is followed by a blank line is irrelevant. (Note:
3588Pandoc works this way even when the `markdown_strict` format is specified. This
3589behavior is consistent with the official Markdown syntax description,
3590even though it is different from that of `Markdown.pl`.)
3593### Ending a list ###
3595What if you want to put an indented code block after a list?
3602Trouble! Here pandoc (like other Markdown implementations) will treat
3603`{ my code block }` as the second paragraph of item two, and not as
3606To "cut off" the list after item two, you can insert some non-indented
3607content, like an HTML comment, which won't produce visible output in
3613 <!-- end of list -->
3617You can use the same trick if you want two consecutive lists instead
3632A line containing a row of three or more `*`, `-`, or `_` characters
3633(optionally separated by spaces) produces a horizontal rule:
3642Four kinds of tables may be used. The first three kinds presuppose the use of
3643a fixed-width font, such as Courier. The fourth kind can be used with
3644proportionally spaced fonts, as it does not require lining up columns.
3646#### Extension: `table_captions` ####
3648A caption may optionally be provided with all 4 kinds of tables (as
3649illustrated in the examples below). A caption is a paragraph beginning
3650with the string `Table:` (or just `:`), which will be stripped off.
3651It may appear either before or after the table.
3653#### Extension: `simple_tables` ####
3655Simple tables look like this:
3657 Right Left Center Default
3658 ------- ------ ---------- -------
3663 Table: Demonstration of simple table syntax.
3665The header and table rows must each fit on one line. Column
3666alignments are determined by the position of the header text relative
3667to the dashed line below it:[^4]
3669 - If the dashed line is flush with the header text on the right side
3670 but extends beyond it on the left, the column is right-aligned.
3671 - If the dashed line is flush with the header text on the left side
3672 but extends beyond it on the right, the column is left-aligned.
3673 - If the dashed line extends beyond the header text on both sides,
3674 the column is centered.
3675 - If the dashed line is flush with the header text on both sides,
3676 the default alignment is used (in most cases, this will be left).
3678[^4]: This scheme is due to Michel Fortin, who proposed it on the
3679 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3681The table must end with a blank line, or a line of dashes followed by
3684The column header row may be omitted, provided a dashed line is used
3685to end the table. For example:
3687 ------- ------ ---------- -------
3691 ------- ------ ---------- -------
3693When the header row is omitted, column alignments are determined on the basis
3694of the first line of the table body. So, in the tables above, the columns
3695would be right, left, center, and right aligned, respectively.
3697#### Extension: `multiline_tables` ####
3699Multiline tables allow header and table rows to span multiple lines
3700of text (but cells that span multiple columns or rows of the table are
3701not supported). Here is an example:
3703 -------------------------------------------------------------
3704 Centered Default Right Left
3705 Header Aligned Aligned Aligned
3706 ----------- ------- --------------- -------------------------
3707 First row 12.0 Example of a row that
3708 spans multiple lines.
3710 Second row 5.0 Here's another one. Note
3711 the blank line between
3713 -------------------------------------------------------------
3715 Table: Here's the caption. It, too, may span
3718These work like simple tables, but with the following differences:
3720 - They must begin with a row of dashes, before the header text
3721 (unless the header row is omitted).
3722 - They must end with a row of dashes, then a blank line.
3723 - The rows must be separated by blank lines.
3725In multiline tables, the table parser pays attention to the widths of
3726the columns, and the writers try to reproduce these relative widths in
3727the output. So, if you find that one of the columns is too narrow in the
3728output, try widening it in the Markdown source.
3730The header may be omitted in multiline tables as well as simple tables:
3732 ----------- ------- --------------- -------------------------
3733 First row 12.0 Example of a row that
3734 spans multiple lines.
3736 Second row 5.0 Here's another one. Note
3737 the blank line between
3739 ----------- ------- --------------- -------------------------
3741 : Here's a multiline table without a header.
3743It is possible for a multiline table to have just one row, but the row
3744should be followed by a blank line (and then the row of dashes that ends
3745the table), or the table may be interpreted as a simple table.
3747#### Extension: `grid_tables` ####
3749Grid tables look like this:
3751 : Sample grid table.
3753 +---------------+---------------+--------------------+
3754 | Fruit | Price | Advantages |
3755 +===============+===============+====================+
3756 | Bananas | $1.34 | - built-in wrapper |
3757 | | | - bright color |
3758 +---------------+---------------+--------------------+
3759 | Oranges | $2.10 | - cures scurvy |
3761 +---------------+---------------+--------------------+
3763The row of `=`s separates the header from the table body, and can be
3764omitted for a headerless table. The cells of grid tables may contain
3765arbitrary block elements (multiple paragraphs, code blocks, lists,
3766etc.). Cells that span multiple columns or rows are not
3767supported. Grid tables can be created easily using Emacs' table-mode
3768(`M-x table-insert`).
3770Alignments can be specified as with pipe tables, by putting
3771colons at the boundaries of the separator line after the
3774 +---------------+---------------+--------------------+
3775 | Right | Left | Centered |
3776 +==============:+:==============+:==================:+
3777 | Bananas | $1.34 | built-in wrapper |
3778 +---------------+---------------+--------------------+
3780For headerless tables, the colons go on the top line instead:
3782 +--------------:+:--------------+:------------------:+
3783 | Right | Left | Centered |
3784 +---------------+---------------+--------------------+
3786##### Grid Table Limitations #####
3788Pandoc does not support grid tables with row spans or column spans.
3789This means that neither variable numbers of columns across rows nor
3790variable numbers of rows across columns are supported by Pandoc.
3791All grid tables must have the same number of columns in each row,
3792and the same number of rows in each column. For example, the
3793Docutils [sample grid tables] will not render as expected with
3796[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3799#### Extension: `pipe_tables` ####
3801Pipe tables look like this:
3803 | Right | Left | Default | Center |
3804 |------:|:-----|---------|:------:|
3805 | 12 | 12 | 12 | 12 |
3806 | 123 | 123 | 123 | 123 |
3809 : Demonstration of pipe table syntax.
3811The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3812ending pipe characters are optional, but pipes are required between all
3813columns. The colons indicate column alignment as shown. The header
3814cannot be omitted. To simulate a headerless table, include a header
3817Since the pipes indicate column boundaries, columns need not be vertically
3818aligned, as they are in the above example. So, this is a perfectly
3819legal (though ugly) pipe table:
3827The cells of pipe tables cannot contain block elements like paragraphs
3828and lists, and cannot span multiple lines. If a pipe table contains a
3829row whose Markdown content is wider than the column width (see
3830`--columns`), then the table will take up the full text width and
3831the cell contents will wrap, with the relative cell widths determined
3832by the number of dashes in the line separating the table header from
3833the table body. (For example `---|-` would make the first column 3/4
3834and the second column 1/4 of the full text width.)
3835On the other hand, if no lines are wider than column width, then
3836cell contents will not be wrapped, and the cells will be sized
3839Note: pandoc also recognizes pipe tables of the following
3840form, as can be produced by Emacs' orgtbl-mode:
3847The difference is that `+` is used instead of `|`. Other orgtbl features
3848are not supported. In particular, to get non-default column alignment,
3849you'll need to add colons as above.
3851[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3855#### Extension: `pandoc_title_block` ####
3857If the file begins with a title block
3860 % author(s) (separated by semicolons)
3863it will be parsed as bibliographic information, not regular text. (It
3864will be used, for example, in the title of standalone LaTeX or HTML
3865output.) The block may contain just a title, a title and an author,
3866or all three elements. If you want to include an author but no
3867title, or a title and a date but no author, you need a blank line:
3880The title may occupy multiple lines, but continuation lines must
3881begin with leading space, thus:
3888If a document has multiple authors, the authors may be put on
3889separate lines with leading space, or separated by semicolons, or
3890both. So, all of the following are equivalent:
3898% Author One; Author Two
3906The date must fit on one line.
3908All three metadata fields may contain standard inline formatting
3909(italics, links, footnotes, etc.).
3911Title blocks will always be parsed, but they will affect the output only
3912when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3913will appear twice: once in the document head -- this is the title that
3914will appear at the top of the window in a browser -- and once at the
3915beginning of the document body. The title in the document head can have
3916an optional prefix attached (`--title-prefix` or `-T` option). The title
3917in the body appears as an H1 element with class "title", so it can be
3918suppressed or reformatted with CSS. If a title prefix is specified with
3919`-T` and no title block appears in the document, the title prefix will
3920be used by itself as the HTML title.
3922The man page writer extracts a title, man page section number, and
3923other header and footer information from the title line. The title
3924is assumed to be the first word on the title line, which may optionally
3925end with a (single-digit) section number in parentheses. (There should
3926be no space between the title and the parentheses.) Anything after
3927this is assumed to be additional footer and header text. A single pipe
3928character (`|`) should be used to separate the footer text from the header
3933will yield a man page with the title `PANDOC` and section 1.
3935 % PANDOC(1) Pandoc User Manuals
3937will also have "Pandoc User Manuals" in the footer.
3939 % PANDOC(1) Pandoc User Manuals | Version 4.0
3941will also have "Version 4.0" in the header.
3943#### Extension: `yaml_metadata_block` ####
3945A [YAML] metadata block is a valid YAML object, delimited by a line of three
3946hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3947(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3948document, but if it is not at the beginning, it must be preceded by a blank
3949line. (Note that, because of the way pandoc concatenates input files when
3950several are provided, you may also keep the metadata in a separate YAML file
3951and pass it to pandoc as an argument, along with your Markdown files:
3953 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3955Just be sure that the YAML file begins with `---` and ends with `---` or
3956`...`.) Alternatively, you can use the `--metadata-file` option. Using
3957that approach however, you cannot reference content (like footnotes)
3958from the main markdown input document.
3960Metadata will be taken from the fields of the YAML object and added to any
3961existing document metadata. Metadata can contain lists and objects (nested
3962arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3963with names ending in an underscore will be ignored by pandoc. (They may be
3964given a role by external processors.) Field names must not be
3965interpretable as YAML numbers or boolean values (so, for
3966example, `yes`, `True`, and `15` cannot be used as field names).
3968A document may contain multiple metadata blocks. If two
3969metadata blocks attempt to set the same field, the value from
3970the second block will be taken.
3972When pandoc is used with `-t markdown` to create a Markdown document,
3973a YAML metadata block will be produced only if the `-s/--standalone`
3974option is used. All of the metadata will appear in a single block
3975at the beginning of the document.
3977Note that [YAML] escaping rules must be followed. Thus, for example,
3978if a title contains a colon, it must be quoted. The pipe character
3979(`|`) can be used to begin an indented block that will be interpreted
3980literally, without need for escaping. This form is necessary
3981when the field contains blank lines or block-level formatting:
3984 title: 'This is the title: it contains a colon'
3988 keywords: [nothing, nothingness]
3990 This is the abstract.
3992 It consists of two paragraphs.
3995Template variables will be set automatically from the metadata. Thus, for
3996example, in writing HTML, the variable `abstract` will be set to the HTML
3997equivalent of the Markdown in the `abstract` field:
3999 <p>This is the abstract.</p>
4000 <p>It consists of two paragraphs.</p>
4002Variables can contain arbitrary YAML structures, but the template must match
4003this structure. The `author` variable in the default templates expects a
4004simple list or string, but can be changed to support more complicated
4005structures. The following combination, for example, would add an affiliation
4006to the author if one is given:
4009 title: The document title
4012 affiliation: University of Somewhere
4014 affiliation: University of Nowhere
4017To use the structured authors in the example above, you would need a custom
4022 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4028Raw content to include in the document's header may be specified
4029using `header-includes`; however, it is important to mark up
4030this content as raw code for a particular output format, using
4031the [`raw_attribute` extension](#extension-raw_attribute)), or it
4032will be interpreted as markdown. For example:
4037 \let\oldsection\section
4038 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4043#### Extension: `all_symbols_escapable` ####
4045Except inside a code block or inline code, any punctuation or space
4046character preceded by a backslash will be treated literally, even if it
4047would normally indicate formatting. Thus, for example, if one writes
4057 <strong>hello</strong>
4059This rule is easier to remember than standard Markdown's rule,
4060which allows only the following characters to be backslash-escaped:
4064(However, if the `markdown_strict` format is used, the standard Markdown rule
4067A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4068it will appear as `~`. In HTML and XML output, it will appear as a
4069literal unicode nonbreaking space character (note that it will thus
4070actually look "invisible" in the generated HTML source; you can still
4071use the `--ascii` command-line option to make it appear as an explicit
4074A backslash-escaped newline (i.e. a backslash occurring at the end of
4075a line) is parsed as a hard line break. It will appear in TeX output as
4076`\\` and in HTML as `<br />`. This is a nice alternative to
4077Markdown's "invisible" way of indicating hard line breaks using
4078two trailing spaces on a line.
4080Backslash escapes do not work in verbatim contexts.
4086To *emphasize* some text, surround it with `*`s or `_`, like this:
4088 This text is _emphasized with underscores_, and this
4089 is *emphasized with asterisks*.
4091Double `*` or `_` produces **strong emphasis**:
4093 This is **strong emphasis** and __with underscores__.
4095A `*` or `_` character surrounded by spaces, or backslash-escaped,
4096will not trigger emphasis:
4098 This is * not emphasized *, and \*neither is this\*.
4100#### Extension: `intraword_underscores` ####
4102Because `_` is sometimes used inside words and identifiers,
4103pandoc does not interpret a `_` surrounded by alphanumeric
4104characters as an emphasis marker. If you want to emphasize
4105just part of a word, use `*`:
4107 feas*ible*, not feas*able*.
4112#### Extension: `strikeout` ####
4114To strikeout a section of text with a horizontal line, begin and end it
4115with `~~`. Thus, for example,
4117 This ~~is deleted text.~~
4120### Superscripts and subscripts ###
4122#### Extension: `superscript`, `subscript` ####
4124Superscripts may be written by surrounding the superscripted text by `^`
4125characters; subscripts may be written by surrounding the subscripted
4126text by `~` characters. Thus, for example,
4128 H~2~O is a liquid. 2^10^ is 1024.
4130The text between `^...^` or `~...~` may not contain spaces or
4131newlines. If the superscripted or subscripted text contains
4132spaces, these spaces must be escaped with backslashes. (This is
4133to prevent accidental superscripting and subscripting through
4134the ordinary use of `~` and `^`, and also bad interactions with
4135footnotes.) Thus, if you want the letter P with 'a cat' in
4136subscripts, use `P~a\ cat~`, not `P~a cat~`.
4140To make a short span of text verbatim, put it inside backticks:
4142 What is the difference between `>>=` and `>>`?
4144If the verbatim text includes a backtick, use double backticks:
4146 Here is a literal backtick `` ` ``.
4148(The spaces after the opening backticks and before the closing
4149backticks will be ignored.)
4151The general rule is that a verbatim span starts with a string
4152of consecutive backticks (optionally followed by a space)
4153and ends with a string of the same number of backticks (optionally
4154preceded by a space).
4156Note that backslash-escapes (and other Markdown constructs) do not
4157work in verbatim contexts:
4159 This is a backslash followed by an asterisk: `\*`.
4161#### Extension: `inline_code_attributes` ####
4163Attributes can be attached to verbatim text, just as with
4164[fenced code blocks]:
4170To write small caps, use the `smallcaps` class:
4172 [Small caps]{.smallcaps}
4174Or, without the `bracketed_spans` extension:
4176 <span class="smallcaps">Small caps</span>
4178For compatibility with other Markdown flavors, CSS is also supported:
4180 <span style="font-variant:small-caps;">Small caps</span>
4182This will work in all output formats that support small caps.
4187#### Extension: `tex_math_dollars` ####
4189Anything between two `$` characters will be treated as TeX math. The
4190opening `$` must have a non-space character immediately to its right,
4191while the closing `$` must have a non-space character immediately to its
4192left, and must not be followed immediately by a digit. Thus,
4193`$20,000 and $30,000` won't parse as math. If for some reason
4194you need to enclose text in literal `$` characters, backslash-escape
4195them and they won't be treated as math delimiters.
4197For display math, use `$$` delimiters. (In this case, the delimiters
4198may be separated from the formula by whitespace.)
4200TeX math will be printed in all output formats. How it is rendered
4201depends on the output format:
4204 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4205 math) or `\[...\]` (for display math).
4207Markdown, Emacs Org mode, ConTeXt, ZimWiki
4208 ~ It will appear verbatim surrounded by `$...$` (for inline
4209 math) or `$$...$$` (for display math).
4212 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4215 ~ It will be rendered using an [interpreted text role `:math:`].
4218 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4219 surrounded by `latexmath:[$...$]` (for inline math) or
4220 `[latexmath]++++\[...\]+++` (for display math).
4221 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4222 (`$..$` and `\[..\]`) are omitted.
4225 ~ It will be rendered inside a `@math` command.
4227roff man, Jira markup
4228 ~ It will be rendered verbatim without `$`'s.
4231 ~ It will be rendered inside `<math>` tags.
4234 ~ It will be rendered inside `<span class="math">` tags.
4237 ~ It will be rendered, if possible, using Unicode characters,
4238 and will otherwise appear verbatim.
4241 ~ It will be rendered, if possible, using MathML.
4244 ~ If the `--mathml` flag is used, it will be rendered using MathML
4245 in an `inlineequation` or `informalequation` tag. Otherwise it
4246 will be rendered, if possible, using Unicode characters.
4249 ~ It will be rendered using OMML math markup.
4252 ~ If the `--webtex` option is used, formulas are rendered as images
4253 using CodeCogs or other compatible web service, downloaded
4254 and embedded in the e-book. Otherwise, they will appear verbatim.
4256HTML, Slidy, DZSlides, S5, EPUB
4257 ~ The way math is rendered in HTML will depend on the
4258 command-line options selected. Therefore see [Math rendering in HTML]
4261[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4265#### Extension: `raw_html` ####
4267Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4268(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4269literally). (Technically this is not an extension, since standard
4270Markdown allows it, but it has been made an extension so that it can
4271be disabled if desired.)
4273The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4274DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4275output, and suppressed in other formats.
4277For a more explicit way of including raw HTML in a Markdown
4278document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4280In the CommonMark format, if `raw_html` is enabled, superscripts,
4281subscripts, strikeouts and small capitals will be represented as HTML.
4282Otherwise, plain-text fallbacks will be used. Note that even if
4283`raw_html` is disabled, tables will be rendered with HTML syntax if
4284they cannot use pipe syntax.
4286#### Extension: `markdown_in_html_blocks` ####
4288Standard Markdown allows you to include HTML "blocks": blocks
4289of HTML between balanced tags that are separated from the surrounding text
4290with blank lines, and start and end at the left margin. Within
4291these blocks, everything is interpreted as HTML, not Markdown;
4292so (for example), `*` does not signify emphasis.
4294Pandoc behaves this way when the `markdown_strict` format is used; but
4295by default, pandoc interprets material between HTML block tags as Markdown.
4296Thus, for example, pandoc will turn
4301 <td>[a link](https://google.com)</td>
4309 <td><em>one</em></td>
4310 <td><a href="https://google.com">a link</a></td>
4314whereas `Markdown.pl` will preserve it as is.
4316There is one exception to this rule: text between `<script>` and
4317`<style>` tags is not interpreted as Markdown.
4319This departure from standard Markdown should make it easier to mix
4320Markdown with HTML block elements. For example, one can surround
4321a block of Markdown text with `<div>` tags without preventing it
4322from being interpreted as Markdown.
4324#### Extension: `native_divs` ####
4326Use native pandoc `Div` blocks for content inside `<div>` tags.
4327For the most part this should give the same output as
4328`markdown_in_html_blocks`, but it makes it easier to write pandoc
4329filters to manipulate groups of blocks.
4331#### Extension: `native_spans` ####
4333Use native pandoc `Span` blocks for content inside `<span>` tags.
4334For the most part this should give the same output as `raw_html`,
4335but it makes it easier to write pandoc filters to manipulate groups
4338#### Extension: `raw_tex` ####
4340In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4341included in a document. Inline TeX commands will be preserved and passed
4342unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4343LaTeX to include BibTeX citations:
4345 This result was proved in \cite{jones.1967}.
4347Note that in LaTeX environments, like
4349 \begin{tabular}{|l|l|}\hline
4350 Age & Frequency \\ \hline
4353 36--45 & 22 \\ \hline
4356the material between the begin and end tags will be interpreted as raw
4357LaTeX, not as Markdown.
4359For a more explicit and flexible way of including raw TeX in a
4360Markdown document, see the [`raw_attribute`
4361extension][Extension: `raw_attribute`].
4363Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4364Emacs Org mode, and ConTeXt.
4366### Generic raw attribute ###
4368#### Extension: `raw_attribute` ####
4370Inline spans and fenced code blocks with a special
4371kind of attribute will be parsed as raw content with the
4372designated format. For example, the following produces a raw
4379And the following produces a raw `html` inline element:
4381 This is `<a>html</a>`{=html}
4383This can be useful to insert raw xml into `docx` documents, e.g.
4389 <w:br w:type="page"/>
4394The format name should match the target format name (see
4395`-t/--to`, above, for a list, or use `pandoc
4396--list-output-formats`). Use `openxml` for `docx` output,
4397`opendocument` for `odt` output, `html5` for `epub3` output,
4398`html4` for `epub2` output, and `latex`, `beamer`,
4399`ms`, or `html5` for `pdf` output (depending on what you
4400use for `--pdf-engine`).
4402This extension presupposes that the relevant kind of
4403inline code or fenced code block is enabled. Thus, for
4404example, to use a raw attribute with a backtick code block,
4405`backtick_code_blocks` must be enabled.
4407The raw attribute cannot be combined with regular attributes.
4411#### Extension: `latex_macros` ####
4413When this extension is enabled, pandoc will parse LaTeX
4414macro definitions and apply the resulting macros to all LaTeX
4415math and raw LaTeX. So, for example, the following will work in
4416all output formats, not just LaTeX:
4418 \newcommand{\tuple}[1]{\langle #1 \rangle}
4422Note that LaTeX macros will not be applied if they occur
4423inside a raw span or block marked with the
4424[`raw_attribute` extension](#extension-raw_attribute).
4426When `latex_macros` is disabled, the raw LaTeX and math will
4427not have macros applied. This is usually a better approach when
4428you are targeting LaTeX or PDF.
4430Macro definitions in LaTeX will be passed through as raw LaTeX
4431only if `latex_macros` is not enabled. Macro definitions in
4432Markdown source (or other formats allowing `raw_tex`) will
4433be passed through regardless of whether `latex_macros` is
4438Markdown allows links to be specified in several ways.
4440### Automatic links ###
4442If you enclose a URL or email address in pointy brackets, it
4445 <https://google.com>
4446 <sam@green.eggs.ham>
4450An inline link consists of the link text in square brackets,
4451followed by the URL in parentheses. (Optionally, the URL can
4452be followed by a link title, in quotes.)
4454 This is an [inline link](/url), and here's [one with
4455 a title](https://fsf.org "click here for a good time!").
4457There can be no space between the bracketed part and the parenthesized part.
4458The link text can contain formatting (such as emphasis), but the title cannot.
4460Email addresses in inline links are not autodetected, so they have to be
4461prefixed with `mailto`:
4463 [Write me!](mailto:sam@green.eggs.ham)
4465### Reference links ###
4467An *explicit* reference link has two parts, the link itself and the link
4468definition, which may occur elsewhere in the document (either
4469before or after the link).
4471The link consists of link text in square brackets, followed by a label in
4472square brackets. (There cannot be space between the two unless the
4473`spaced_reference_links` extension is enabled.) The link definition
4474consists of the bracketed label, followed by a colon and a space, followed by
4475the URL, and optionally (after a space) a link title either in quotes or in
4476parentheses. The label must not be parseable as a citation (assuming
4477the `citations` extension is enabled): citations take precedence over
4480Here are some examples:
4482 [my label 1]: /foo/bar.html "My title, optional"
4484 [my label 3]: https://fsf.org (The free software foundation)
4485 [my label 4]: /bar#special 'A title in single quotes'
4487The URL may optionally be surrounded by angle brackets:
4489 [my label 5]: <http://foo.bar.baz>
4491The title may go on the next line:
4493 [my label 3]: https://fsf.org
4494 "The free software foundation"
4496Note that link labels are not case sensitive. So, this will work:
4498 Here is [my link][FOO]
4502In an *implicit* reference link, the second pair of brackets is
4507 [my website]: http://foo.bar.baz
4509Note: In `Markdown.pl` and most other Markdown implementations,
4510reference link definitions cannot occur in nested constructions
4511such as list items or block quotes. Pandoc lifts this arbitrary
4512seeming restriction. So the following is fine in pandoc, though
4513not in most other implementations:
4519#### Extension: `shortcut_reference_links` ####
4521In a *shortcut* reference link, the second pair of brackets may
4526 [my website]: http://foo.bar.baz
4528### Internal links ###
4530To link to another section of the same document, use the automatically
4531generated identifier (see [Heading identifiers]). For example:
4533 See the [Introduction](#introduction).
4537 See the [Introduction].
4539 [Introduction]: #introduction
4541Internal links are currently supported for HTML formats (including
4542HTML slide shows and EPUB), LaTeX, and ConTeXt.
4546A link immediately preceded by a `!` will be treated as an image.
4547The link text will be used as the image's alt text:
4549 
4553 [movie reel]: movie.gif
4555#### Extension: `implicit_figures` ####
4557An image with nonempty alt text, occurring by itself in a
4558paragraph, will be rendered as a figure with a caption. The
4559image's alt text will be used as the caption.
4561 
4563How this is rendered depends on the output format. Some output
4564formats (e.g. RTF) do not yet support figures. In those
4565formats, you'll just get an image in a paragraph by itself, with
4568If you just want a regular inline image, just make sure it is not
4569the only thing in the paragraph. One way to do this is to insert a
4570nonbreaking space after the image:
4572 \
4574Note that in reveal.js slide shows, an image in a paragraph
4575by itself that has the `stretch` class will fill the screen,
4576and the caption and figure tags will be omitted.
4578#### Extension: `link_attributes` ####
4580Attributes can be set on links and images:
4582 An inline {#id .class width=30 height=20px}
4583 and a reference ![image][ref] with attributes.
4585 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4587(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4588and `.class` are used.)
4590For HTML and EPUB, all known HTML5 attributes except `width` and
4591`height` (but including `srcset` and `sizes`) are passed through
4592as is. Unknown attributes are passed through as custom
4593attributes, with `data-` prepended. The other writers ignore
4594attributes that are not specifically supported by their output format.
4596The `width` and `height` attributes on images are treated specially. When
4597used without a unit, the unit is assumed to be pixels. However, any of
4598the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4599and `%`. There must not be any spaces between the number and the unit.
4603{ width=50% }
4606- Dimensions may be converted to a form that is compatible with
4607 the output format (for example, dimensions given in pixels will
4608 be converted to inches when converting HTML to LaTeX). Conversion
4609 between pixels and physical measurements is affected by the
4610 `--dpi` option (by default, 96 dpi is assumed, unless the image
4611 itself contains dpi information).
4612- The `%` unit is generally relative to some available space.
4613 For example the above example will render to the following.
4614 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4615 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4616 (If you're using a custom template, you need to configure `graphicx`
4617 as in the default template.)
4618 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4619- Some output formats have a notion of a class
4620 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4621 or a unique identifier (LaTeX `\caption`), or both (HTML).
4622- When no `width` or `height` attributes are specified, the fallback
4623 is to look at the image resolution and the dpi metadata embedded in
4628Using the `native_divs` and `native_spans` extensions
4629(see [above][Extension: `native_divs`]), HTML syntax can
4630be used as part of markdown to create native `Div` and `Span`
4631elements in the pandoc AST (as opposed to raw HTML).
4632However, there is also nicer syntax available:
4634#### Extension: `fenced_divs` ####
4636Allow special fenced syntax for native `Div` blocks. A Div
4637starts with a fence containing at least three consecutive
4638colons plus some attributes. The attributes may optionally
4639be followed by another string of consecutive colons.
4640The attribute syntax is exactly as in fenced code blocks (see
4641[Extension: `fenced_code_attributes`]). As with fenced
4642code blocks, one can use either attributes in curly braces
4643or a single unbraced word, which will be treated as a class
4644name. The Div ends with another line containing a string of at
4645least three consecutive colons. The fenced Div should be
4646separated by blank lines from preceding and following blocks.
4650 ::::: {#special .sidebar}
4651 Here is a paragraph.
4656Fenced divs can be nested. Opening fences are distinguished
4657because they *must* have attributes:
4663 This is a warning within a warning.
4667Fences without attributes are always closing fences. Unlike
4668with fenced code blocks, the number of colons in the closing
4669fence need not match the number in the opening fence. However,
4670it can be helpful for visual clarity to use fences of different
4671lengths to distinguish nested divs from their parents.
4674#### Extension: `bracketed_spans` ####
4676A bracketed sequence of inlines, as one would use to begin
4677a link, will be treated as a `Span` with attributes if it is
4678followed immediately by attributes:
4680 [This is *some text*]{.class key="val"}
4684#### Extension: `footnotes` ####
4686Pandoc's Markdown allows footnotes, using the following syntax:
4688 Here is a footnote reference,[^1] and another.[^longnote]
4690 [^1]: Here is the footnote.
4692 [^longnote]: Here's one with multiple blocks.
4694 Subsequent paragraphs are indented to show that they
4695 belong to the previous footnote.
4699 The whole paragraph can be indented, or just the first
4700 line. In this way, multi-paragraph footnotes work like
4701 multi-paragraph list items.
4703 This paragraph won't be part of the note, because it
4706The identifiers in footnote references may not contain spaces, tabs,
4707or newlines. These identifiers are used only to correlate the
4708footnote reference with the note itself; in the output, footnotes
4709will be numbered sequentially.
4711The footnotes themselves need not be placed at the end of the
4712document. They may appear anywhere except inside other block elements
4713(lists, block quotes, tables, etc.). Each footnote should be
4714separated from surrounding content (including other footnotes)
4717#### Extension: `inline_notes` ####
4719Inline footnotes are also allowed (though, unlike regular notes,
4720they cannot contain multiple paragraphs). The syntax is as follows:
4722 Here is an inline note.^[Inlines notes are easier to write, since
4723 you don't have to pick an identifier and move down to type the
4726Inline and regular footnotes may be mixed freely.
4730#### Extension: `citations` ####
4732Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4733citations and a bibliography in a number of styles. Basic usage is
4735 pandoc --filter pandoc-citeproc myinput.txt
4737In order to use this feature, you will need to specify a bibliography file
4738using the `bibliography` metadata field in a YAML metadata section, or
4739`--bibliography` command line argument. You can supply multiple `--bibliography`
4740arguments or set `bibliography` metadata field to YAML array, if you want to
4741use multiple bibliography files. The bibliography may have any of these
4744 Format File extension
4745 ------------ --------------
4758Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4759use `.bibtex` to force BibTeX.
4761Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4762can produce `.json` and `.yaml` files from any of the supported formats.
4764In-field markup: In BibTeX and BibLaTeX databases,
4765pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4766databases, pandoc Markdown; and in CSL JSON databases, an
4767[HTML-like markup][CSL markup specs]:
4775`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4784`<span class="nocase">...</span>`
4785: prevent a phrase from being capitalized as title case
4787`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4788and CSL YAML formats as far as possible.
4790As an alternative to specifying a bibliography file using `--bibliography`
4791or the YAML metadata field `bibliography`, you can include
4792the citation data directly in the `references` field of the
4793document's YAML metadata. The field should contain an array of
4794YAML-encoded references, for example:
4798 - type: article-journal
4810 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4812 title-short: Molecular structure of nucleic acids
4813 container-title: Nature
4817 DOI: 10.1038/171737a0
4818 URL: https://www.nature.com/articles/171737a0
4822(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4823of the supported formats.)
4825Citations and references can be formatted using any style supported by the
4826[Citation Style Language], listed in the [Zotero Style Repository].
4827These files are specified using the `--csl` option or the `csl` metadata field.
4828By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4829format. The CSL project provides further information on [finding and editing styles].
4831To make your citations hyperlinks to the corresponding bibliography
4832entries, add `link-citations: true` to your YAML metadata.
4834Citations go inside square brackets and are separated by semicolons.
4835Each citation must have a key, composed of '@' + the citation
4836identifier from the database, and may optionally have a prefix,
4837a locator, and a suffix. The citation key must begin with a letter, digit,
4838or `_`, and may contain alphanumerics, `_`, and internal punctuation
4839characters (`:.#$%&-+?<>~/`). Here are some examples:
4841 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4843 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4845 Blah blah [@smith04; @doe99].
4847`pandoc-citeproc` detects locator terms in the [CSL locale files].
4848Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4849locale, locator terms can be written in either singular or plural forms,
4850as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4851`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4852`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4853`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4854`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4855`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4856locator term is used, "page" is assumed.
4858`pandoc-citeproc` will use heuristics to distinguish the locator
4859from the suffix. In complex cases, the locator can be enclosed
4860in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4862 [@smith{ii, A, D-Z}, with a suffix]
4863 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4865A minus sign (`-`) before the `@` will suppress mention of
4866the author in the citation. This can be useful when the
4867author is already mentioned in the text:
4869 Smith says blah [-@smith04].
4871You can also write an in-text citation, as follows:
4875 @smith04 [p. 33] says blah.
4877If the style calls for a list of works cited, it will be placed
4878in a div with id `refs`, if one exists:
4883Otherwise, it will be placed at the end of the document.
4884Generation of the bibliography can be suppressed by setting
4885`suppress-bibliography: true` in the YAML metadata.
4887If you wish the bibliography to have a section heading, you can
4888set `reference-section-title` in the metadata, or put the heading
4889at the beginning of the div with id `refs` (if you are using it)
4890or at the end of your document:
4896The bibliography will be inserted after this heading. Note that
4897the `unnumbered` class will be added to this heading, so that the
4898section will not be numbered.
4900If you want to include items in the bibliography without actually
4901citing them in the body text, you can define a dummy `nocite` metadata
4902field and put the citations there:
4911In this example, the document will contain a citation for `item3`
4912only, but the bibliography will contain entries for `item1`, `item2`, and
4915It is possible to create a bibliography with all the citations,
4916whether or not they appear in the document, by using a wildcard:
4923For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4924render the bibliography. In order to do so, specify bibliography
4925files as outlined above, and add `--natbib` or `--biblatex`
4926argument to `pandoc` invocation. Bear in mind that bibliography
4927files have to be in respective format (either BibTeX or
4930For more information, see the [pandoc-citeproc man page].
4932[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4933[Chicago Manual of Style]: https://chicagomanualofstyle.org
4934[Citation Style Language]: https://citationstyles.org
4935[Zotero Style Repository]: https://www.zotero.org/styles
4936[finding and editing styles]: https://citationstyles.org/authors/
4937[CSL locale files]: https://github.com/citation-style-language/locales
4938[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4940## Non-pandoc extensions
4942The following Markdown syntax extensions are not enabled by default
4943in pandoc, but may be enabled by adding `+EXTENSION` to the format
4944name, where `EXTENSION` is the name of the extension. Thus, for
4945example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4947#### Extension: `attributes` ####
4949Allows attributes to be attached to any inline or block-level
4950element. The syntax for the attributes is the same as that
4951used in [`header_attributes`][Extension: `header_attributes`].
4953- Attributes that occur immediately after an inline
4954 element affect that element. If they follow a space, then they
4955 belong to the space. (Hence, this option subsumes
4956 `inline_code_attributes` and `link_attributes`.)
4957- Attributes that occur immediately before a block
4958 element, on a line by themselves, affect that
4960- Consecutive attribute specifiers may be used,
4961 either for blocks or for inlines. Their attributes
4963- Attributes that occur at the end of the text of
4964 a Setext or ATX heading (separated by whitespace
4965 from the text) affect the heading element. (Hence, this
4966 option subsumes `header_attributes`.)
4967- Attributes that occur after the opening fence
4968 in a fenced code block affect the code block element. (Hence,
4969 this option subsumes `fenced_code_attributes`.)
4970- Attributes that occur at the end of a reference
4971 link definition affect links that refer to that
4974Note that pandoc's AST does not currently allow attributes
4975to be attached to arbitrary elements. Hence a Span or Div
4976container will be added if needed.
4978#### Extension: `old_dashes` ####
4980Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4981`-` before a numeral is an en-dash, and `--` is an em-dash.
4982This option only has an effect if `smart` is enabled. It is
4983selected automatically for `textile` input.
4985#### Extension: `angle_brackets_escapable` ####
4987Allow `<` and `>` to be backslash-escaped, as they can be in
4988GitHub flavored Markdown but not original Markdown. This is
4989implied by pandoc's default `all_symbols_escapable`.
4991#### Extension: `lists_without_preceding_blankline` ####
4993Allow a list to occur right after a paragraph, with no intervening
4996#### Extension: `four_space_rule` ####
4998Selects the pandoc <= 2.0 behavior for parsing lists, so that
4999four spaces indent are needed for list item continuation
5002#### Extension: `spaced_reference_links` ####
5004Allow whitespace between the two components of a reference link,
5009#### Extension: `hard_line_breaks` ####
5011Causes all newlines within a paragraph to be interpreted as hard line
5012breaks instead of spaces.
5014#### Extension: `ignore_line_breaks` ####
5016Causes newlines within a paragraph to be ignored, rather than being
5017treated as spaces or as hard line breaks. This option is intended for
5018use with East Asian languages where spaces are not used between words,
5019but text is divided into lines for readability.
5021#### Extension: `east_asian_line_breaks` ####
5023Causes newlines within a paragraph to be ignored, rather than
5024being treated as spaces or as hard line breaks, when they occur
5025between two East Asian wide characters. This is a better choice
5026than `ignore_line_breaks` for texts that include a mix of East
5027Asian wide characters and other characters.
5029#### Extension: `emoji` ####
5031Parses textual emojis like `:smile:` as Unicode emoticons.
5033#### Extension: `tex_math_single_backslash` ####
5035Causes anything between `\(` and `\)` to be interpreted as inline
5036TeX math, and anything between `\[` and `\]` to be interpreted
5037as display TeX math. Note: a drawback of this extension is that
5038it precludes escaping `(` and `[`.
5040#### Extension: `tex_math_double_backslash` ####
5042Causes anything between `\\(` and `\\)` to be interpreted as inline
5043TeX math, and anything between `\\[` and `\\]` to be interpreted
5046#### Extension: `markdown_attribute` ####
5048By default, pandoc interprets material inside block-level tags as Markdown.
5049This extension changes the behavior so that Markdown is only parsed
5050inside block-level tags if the tags have the attribute `markdown=1`.
5052#### Extension: `mmd_title_block` ####
5054Enables a [MultiMarkdown] style title block at the top of
5055the document, for example:
5059 Date: September 1, 2008
5060 Comment: This is a sample mmd title block, with
5061 a field spanning multiple lines.
5063See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5064`yaml_metadata_block` is enabled, it will take precedence over
5067#### Extension: `abbreviations` ####
5069Parses PHP Markdown Extra abbreviation keys, like
5071 *[HTML]: Hypertext Markup Language
5073Note that the pandoc document model does not support
5074abbreviations, so if this extension is enabled, abbreviation keys are
5075simply skipped (as opposed to being parsed as paragraphs).
5077#### Extension: `autolink_bare_uris` ####
5079Makes all absolute URIs into links, even when not surrounded by
5080pointy braces `<...>`.
5082#### Extension: `mmd_link_attributes` ####
5084Parses multimarkdown style key-value attributes on link
5085and image references. This extension should not be confused with the
5086[`link_attributes`](#extension-link_attributes) extension.
5088 This is a reference ![image][ref] with multimarkdown attributes.
5090 [ref]: https://path.to/image "Image title" width=20px height=30px
5091 id=myId class="myClass1 myClass2"
5093#### Extension: `mmd_header_identifiers` ####
5095Parses multimarkdown style heading identifiers (in square brackets,
5096after the heading but before any trailing `#`s in an ATX heading).
5098#### Extension: `compact_definition_lists` ####
5100Activates the definition list syntax of pandoc 1.12.x and earlier.
5101This syntax differs from the one described above under [Definition lists]
5104 - No blank line is required between consecutive items of the
5106 - To get a "tight" or "compact" list, omit space between consecutive
5107 items; the space between a term and its definition does not affect
5109 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5110 be indented four spaces.[^6]
5112[^6]: To see why laziness is incompatible with relaxing the requirement
5113 of a blank line between items, consider the following example:
5120 Is this a single list item with two definitions of "bar," the first of
5121 which is lazily wrapped, or two list items? To remove the ambiguity
5122 we must either disallow lazy wrapping or require a blank line between
5125#### Extension: `gutenberg` ####
5127Use [Project Gutenberg] conventions for `plain` output:
5128all-caps for strong emphasis, surround by underscores
5129for regular emphasis, add extra blank space around headings.
5131 [Project Gutenberg]: https://www.gutenberg.org
5135In addition to pandoc's extended Markdown, the following Markdown
5136variants are supported:
5138- `markdown_phpextra` (PHP Markdown Extra)
5139- `markdown_github` (deprecated GitHub-Flavored Markdown)
5140- `markdown_mmd` (MultiMarkdown)
5141- `markdown_strict` (Markdown.pl)
5142- `commonmark` (CommonMark)
5143- `gfm` (Github-Flavored Markdown)
5144- `commonmark_x` (CommonMark with many pandoc extensions)
5146To see which extensions are supported for a given format,
5147and which are enabled by default, you can use the command
5149 pandoc --list-extensions=FORMAT
5151where `FORMAT` is replaced with the name of the format.
5153Note that the list of extensions for `commonmark`,
5154`gfm`, and `commonmark_x` are defined relative to default
5155commonmark. So, for example, `backtick_code_blocks`
5156does not appear as an extension, since it is enabled by
5157default and cannot be disabled.
5159# Producing slide shows with pandoc
5161You can use pandoc to produce an HTML + JavaScript slide presentation
5162that can be viewed via a web browser. There are five ways to do this,
5163using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5164You can also produce a PDF slide show using LaTeX [`beamer`], or
5165slides shows in Microsoft [PowerPoint] format.
5167Here's the Markdown source for a simple slide show, `habits.txt`:
5194 
5201To produce an HTML/JavaScript slide show, simply type
5203 pandoc -t FORMAT -s habits.txt -o habits.html
5205where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5207For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5208`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5209assumed to be available at the relative path `s5/default` (for S5), `slideous`
5210(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5211`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5212`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5213above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5216With all HTML slide formats, the `--self-contained` option can be used to
5217produce a single file that contains all of the data necessary to display the
5218slide show, including linked scripts, stylesheets, images, and videos.
5220To produce a PDF slide show using beamer, type
5222 pandoc -t beamer habits.txt -o habits.pdf
5224Note that a reveal.js slide show can also be converted to a PDF
5225by printing it to a file from the browser.
5227To produce a Powerpoint slide show, type
5229 pandoc habits.txt -o habits.pptx
5231## Structuring the slide show
5233By default, the *slide level* is the highest heading level in
5234the hierarchy that is followed immediately by content, and not another
5235heading, somewhere in the document. In the example above, level-1 headings
5236are always followed by level-2 headings, which are followed by content,
5237so the slide level is 2. This default can be overridden using
5238the `--slide-level` option.
5240The document is carved up into slides according to the following
5243 * A horizontal rule always starts a new slide.
5245 * A heading at the slide level always starts a new slide.
5247 * Headings *below* the slide level in the hierarchy create
5248 headings *within* a slide.
5250 * Headings *above* the slide level in the hierarchy create
5251 "title slides," which just contain the section title
5252 and help to break the slide show into sections.
5253 Non-slide content under these headings will be included
5254 on the title slide (for HTML slide shows) or in a
5255 subsequent slide with the same title (for beamer).
5257 * A title page is constructed automatically from the document's title
5258 block, if present. (In the case of beamer, this can be disabled
5259 by commenting out some lines in the default template.)
5261These rules are designed to support many different styles of slide show. If
5262you don't care about structuring your slides into sections and subsections,
5263you can just use level-1 headings for all each slide. (In that case, level-1
5264will be the slide level.) But you can also structure the slide show into
5265sections, as in the example above.
5267Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5268layout will be produced, with level-1 headings building horizontally
5269and level-2 headings building vertically. It is not recommended that
5270you use deeper nesting of section levels with reveal.js.
5274By default, these writers produce lists that display "all at once."
5275If you want your lists to display incrementally (one item at a time),
5276use the `-i` option. If you want a particular list to depart from the
5277default, put it in a `div` block with class `incremental` or
5278`nonincremental`. So, for example, using the `fenced div` syntax, the
5279following would be incremental regardless of the document default:
5297While using `incremental` and `nonincremental` divs are the
5298recommended method of setting incremental lists on a per-case basis,
5299an older method is also supported: putting lists inside a blockquote
5300will depart from the document default (that is, it will display
5301incrementally without the `-i` option and all at once with the `-i`
5307Both methods allow incremental and nonincremental lists to be mixed
5308in a single document.
5310Note: Neither the `-i/--incremental` option nor any of the
5311methods described here currently works for PowerPoint output.
5315You can add "pauses" within a slide by including a paragraph containing
5316three dots, separated by spaces:
5318 # Slide with a pause
5320 content before the pause
5324 content after the pause
5326Note: this feature is not yet implemented for PowerPoint output.
5328## Styling the slides
5330You can change the style of HTML slides by putting customized CSS files
5331in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5332or `$DATADIR/slideous` (for Slideous),
5333where `$DATADIR` is the user data directory (see `--data-dir`, above).
5334The originals may be found in pandoc's system data directory (generally
5335`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5336files it does not find in the user data directory.
5338For dzslides, the CSS is included in the HTML file itself, and may
5341All [reveal.js configuration options] can be set through variables.
5342For example, themes can be used by setting the `theme` variable:
5346Or you can specify a custom stylesheet using the `--css` option.
5348To style beamer slides, you can specify a `theme`, `colortheme`,
5349`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5351 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5353Note that heading attributes will turn into slide attributes
5354(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5355to style individual slides. In beamer, the only heading attribute
5356that affects slides is the `allowframebreaks` class, which sets the
5357`allowframebreaks` option, causing multiple slides to be created
5358if the content overfills the frame. This is recommended especially for
5361 # References {.allowframebreaks}
5365Speaker notes are supported in reveal.js and PowerPoint (pptx)
5366output. You can add notes to your Markdown document thus:
5372 - It can contain Markdown
5377To show the notes window in reveal.js, press `s` while viewing the
5378presentation. Speaker notes in PowerPoint will be available, as usual,
5379in handouts and presenter view.
5381Notes are not yet supported for other slide formats, but the notes
5382will not appear on the slides themselves.
5386To put material in side by side columns, you can use a native
5387div container with class `columns`, containing two or more div
5388containers with class `column` and a `width` attribute:
5390 :::::::::::::: {.columns}
5391 ::: {.column width="40%"}
5394 ::: {.column width="60%"}
5399### Additional columns attributes in beamer
5401The div containers with classes `columns` and `column` can optionally have
5402an `align` attribute.
5403The class `columns` can optionally have a `totalwidth` attribute or an
5404`onlytextwidth` class.
5406 :::::::::::::: {.columns align=center totalwidth=8em}
5407 ::: {.column width="40%"}
5410 ::: {.column width="60%" align=bottom}
5415The `align` attributes on `columns` and `column` can be used with the
5416values `top`, `top-baseline`, `center` and `bottom` to vertically align
5417the columns. It defaults to `top` in `columns`.
5419The `totalwidth` attribute limits the width of the columns to the given value.
5421 :::::::::::::: {.columns align=top .onlytextwidth}
5422 ::: {.column width="40%" align=center}
5425 ::: {.column width="60%"}
5430The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5432See Section 12.7 of the [Beamer User's Guide] for more details.
5434## Frame attributes in beamer
5436Sometimes it is necessary to add the LaTeX `[fragile]` option to
5437a frame in beamer (for example, when using the `minted` environment).
5438This can be forced by adding the `fragile` class to the heading
5439introducing the slide:
5441 # Fragile slide {.fragile}
5443All of the other frame attributes described in Section 8.1 of
5444the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5445`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5446`shrink`, `standout`, `noframenumbering`.
5448## Background in reveal.js and beamer
5450Background images can be added to self-contained reveal.js slideshows and
5451to beamer slideshows.
5453For the same image on every slide, use the configuration
5454option `background-image` either in the YAML metadata block
5455or as a command-line variable. (There are no other options in
5456beamer and the rest of this section concerns reveal.js slideshows.)
5458For reveal.js, you can instead use the reveal.js-native option
5459`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5460and `parallaxBackgroundVertical` the same way and must also set
5461`parallaxBackgroundSize` to have your values take effect.
5463To set an image for a particular reveal.js slide, add
5464`{data-background-image="/path/to/image"}`
5465to the first slide-level heading on the slide (which may even be empty).
5467In reveal.js's overview mode, the parallaxBackgroundImage will show up
5468only on the first slide.
5470Other reveal.js background settings also work on individual slides, including
5471`data-background-size`, `data-background-repeat`, `data-background-color`,
5472`data-transition`, and `data-transition-speed`.
5474To add a background image to the automatically generated title slide, use the
5475`title-slide-attributes` variable in the YAML metadata block. It must contain
5476a map of attribute names and values.
5478See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5481For example in reveal.js:
5486parallaxBackgroundImage: /path/to/my/background_image.png
5487title-slide-attributes:
5488 data-background-image: /path/to/title_image.png
5489 data-background-size: contain
5494Slide 1 has background_image.png as its background.
5496## {data-background-image="/path/to/special_image.jpg"}
5498Slide 2 has a special image for its background, even though the heading has no content.
5501# Creating EPUBs with pandoc
5505EPUB metadata may be specified using the `--epub-metadata` option, but
5506if the source document is Markdown, it is better to use a [YAML metadata
5507block][Extension: `yaml_metadata_block`]. Here is an example:
5514 text: An investigation of metadata
5522 text: doi:10.234234.234/33
5524 rights: © 2007 John Smith, CC BY-NC
5529The following fields are recognized:
5532 ~ Either a string value or an object with fields `text` and
5533 `scheme`. Valid values for `scheme` are `ISBN-10`,
5534 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5535 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5536 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5539 ~ Either a string value, or an object with fields `file-as` and
5540 `type`, or a list of such objects. Valid values for `type` are
5541 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5544 ~ Either a string value, or an object with fields `role`, `file-as`,
5545 and `text`, or a list of such objects. Valid values for `role` are
5546 [MARC relators], but
5547 pandoc will attempt to translate the human-readable versions
5548 (like "author" and "editor") to the appropriate marc relators.
5551 ~ Same format as `creator`.
5554 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5555 Pandoc will attempt to convert other common date formats.
5557`lang` (or legacy: `language`)
5558 ~ A string value in [BCP 47] format. Pandoc will default to the local
5559 language if nothing is specified.
5562 ~ A string value or a list of such values.
5583 ~ A string value (path to cover image).
5585`css` (or legacy: `stylesheet`)
5586 ~ A string value (path to CSS stylesheet).
5588`page-progression-direction`
5589 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5590 attribute for the [`spine` element].
5593 ~ iBooks-specific metadata, with the following fields:
5595 - `version`: (string)
5596 - `specified-fonts`: `true`|`false` (default `false`)
5597 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5598 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5599 - `binding`: `true`|`false` (default `true`)
5600 - `scroll-axis`: `vertical`|`horizontal`|`default`
5602[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5603[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5605## The `epub:type` attribute
5607For `epub3` output, you can mark up the heading that corresponds to an EPUB
5608chapter using the [`epub:type` attribute][epub-type]. For example, to set
5609the attribute to the value `prologue`, use this markdown:
5611 # My chapter {epub:type=prologue}
5613Which will result in:
5615 <body epub:type="frontmatter">
5616 <section epub:type="prologue">
5619Pandoc will output `<body epub:type="bodymatter">`, unless
5620you use one of the following values, in which case either
5621`frontmatter` or `backmatter` will be output.
5623`epub:type` of first section `epub:type` of body
5624---------------------------- ------------------
5627acknowledgments frontmatter
5628copyright-page frontmatter
5629dedication frontmatter
5633contributors frontmatter
5634other-credits frontmatter
5636revision-history frontmatter
5637titlepage frontmatter
5638halftitlepage frontmatter
5639seriespage frontmatter
5644bibliography backmatter
5647[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5651By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5652`<video>` or `<source>` element present in the generated EPUB,
5653and include it in the EPUB container, yielding a completely
5654self-contained EPUB. If you want to link to external media resources
5655instead, use raw HTML in your source and add `data-external="1"` to the tag
5656with the `src` attribute. For example:
5658 <audio controls="1">
5659 <source src="https://example.com/music/toccata.mp3"
5660 data-external="1" type="audio/mpeg">
5664# Creating Jupyter notebooks with pandoc
5666When creating a [Jupyter notebook], pandoc will try to infer the
5667notebook structure. Code blocks with the class `code` will be
5668taken as code cells, and intervening content will be taken as
5669Markdown cells. Attachments will automatically be created for
5670images in Markdown cells. Metadata will be taken from the
5671`jupyter` metadata field. For example:
5680 display_name: Python 2
5687 file_extension: ".py"
5688 mimetype: "text/x-python"
5690 nbconvert_exporter: "python"
5691 pygments_lexer: "ipython2"
5697**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5698bibendum felis dictum sodales.
5707from IPython.display import HTML
5710console.log("hello");
5718This image  will be
5719included as a cell attachment.
5722If you want to add cell attributes, group cells differently, or
5723add output to code cells, then you need to include divs to
5724indicate the structure. You can use either [fenced
5725divs][Extension: `fenced_divs`] or [native divs][Extension:
5726`native_divs`] for this. Here is an example:
5729:::::: {.cell .markdown}
5732**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5733bibendum felis dictum sodales.
5736:::::: {.cell .code execution_count=1}
5741::: {.output .stream .stdout}
5748:::::: {.cell .code execution_count=2}
5750from IPython.display import HTML
5753console.log("hello");
5759::: {.output .execute_result execution_count=2}
5762console.log("hello");
5771If you include raw HTML or TeX in an output cell, use the
5772[raw attribute][Extension: `fenced_attribute`], as shown
5773in the last cell of the example above. Although pandoc can
5774process "bare" raw HTML and TeX, the result is often
5775interspersed raw elements and normal textual elements, and
5776in an output cell pandoc expects a single, connected raw
5777block. To avoid using raw HTML or TeX except when
5778marked explicitly using raw attributes, we recommend
5779specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5780translating between Markdown and ipynb notebooks.
5782Note that options and extensions that affect reading and
5783writing of Markdown will also affect Markdown cells in ipynb
5784notebooks. For example, `--wrap=preserve` will preserve
5785soft line breaks in Markdown cells; `--atx-headers` will
5786cause ATX-style headings to be used; and `--preserve-tabs` will
5787prevent tabs from being turned to spaces.
5789# Syntax highlighting
5791Pandoc will automatically highlight syntax in [fenced code blocks] that
5792are marked with a language name. The Haskell library [skylighting] is
5793used for highlighting. Currently highlighting is supported only for
5794HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5795that pandoc will recognize, type `pandoc --list-highlight-languages`.
5797The color scheme can be selected using the `--highlight-style` option.
5798The default color scheme is `pygments`, which imitates the default color
5799scheme used by the Python library pygments (though pygments is not actually
5800used to do the highlighting). To see a list of highlight styles,
5801type `pandoc --list-highlight-styles`.
5803If you are not satisfied with the predefined styles, you can
5804use `--print-highlight-style` to generate a JSON `.theme` file which
5805can be modified and used as the argument to `--highlight-style`. To
5806get a JSON version of the `pygments` style, for example:
5808 pandoc --print-highlight-style pygments > my.theme
5810Then edit `my.theme` and use it like this:
5812 pandoc --highlight-style my.theme
5814If you are not satisfied with the built-in highlighting, or you
5815want highlight a language that isn't supported, you can use the
5816`--syntax-definition` option to load a [KDE-style XML syntax definition
5817file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5818Before writing your own, have a look at KDE's [repository of syntax
5819definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5821To disable highlighting, use the `--no-highlight` option.
5823[skylighting]: https://github.com/jgm/skylighting
5827Custom styles can be used in the docx and ICML formats.
5831By default, pandoc's docx and ICML output applies a predefined set of styles
5832for blocks such as paragraphs and block quotes, and uses largely default
5833formatting (italics, bold) for inlines. This will work for most
5834purposes, especially alongside a `reference.docx` file. However, if you
5835need to apply your own styles to blocks, or match a preexisting set of
5836styles, pandoc allows you to define custom styles for blocks and text
5837using `div`s and `span`s, respectively.
5839If you define a `div` or `span` with the attribute `custom-style`,
5840pandoc will apply your specified style to the contained elements (with
5841the exception of elements whose function depends on a style, like
5842headings, code blocks, block quotes, or links). So, for example, using
5843the `bracketed_spans` syntax,
5845 [Get out]{custom-style="Emphatically"}, he said.
5847would produce a docx file with "Get out" styled with character
5848style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5850 Dickinson starts the poem simply:
5852 ::: {custom-style="Poetry"}
5853 | A Bird came down the Walk---
5854 | He did not know I saw---
5857would style the two contained lines with the `Poetry` paragraph style.
5859For docx output, styles will be defined in the output file as inheriting
5860from normal text, if the styles are not yet in your reference.docx.
5861If they are already defined, pandoc will not alter the definition.
5863This feature allows for greatest customization in conjunction with
5864[pandoc filters]. If you want all paragraphs after block quotes to be
5865indented, you can write a filter to apply the styles necessary. If you
5866want all italics to be transformed to the `Emphasis` character style
5867(perhaps to change their color), you can write a filter which will
5868transform all italicized inlines to inlines within an `Emphasis`
5871For docx output, you don't need to enable any extensions for
5872custom styles to work.
5874[pandoc filters]: https://pandoc.org/filters.html
5878The docx reader, by default, only reads those styles that it can
5879convert into pandoc elements, either by direct conversion or
5880interpreting the derivation of the input document's styles.
5882By enabling the [`styles` extension](#ext-styles) in the docx reader
5883(`-f docx+styles`), you can produce output that maintains the styles
5884of the input document, using the `custom-style` class. Paragraph
5885styles are interpreted as divs, while character styles are interpreted
5888For example, using the `custom-style-reference.docx` file in the test
5889directory, we have the following different outputs:
5891Without the `+styles` extension:
5893 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5896 This is text with an *emphasized* text style. And this is text with a
5897 **strengthened** text style.
5899 > Here is a styled paragraph that inherits from Block Text.
5901And with the extension:
5903 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5905 ::: {custom-style="First Paragraph"}
5909 ::: {custom-style="Body Text"}
5910 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5911 And this is text with a [strengthened]{custom-style="Strengthened"}
5915 ::: {custom-style="My Block Style"}
5916 > Here is a styled paragraph that inherits from Block Text.
5919With these custom styles, you can use your input document as a
5920reference-doc while creating docx output (see below), and maintain the
5921same styles in your input and output files.
5925Pandoc can be extended with custom writers written in [Lua]. (Pandoc
5926includes a Lua interpreter, so Lua need not be installed separately.)
5928To use a custom writer, simply specify the path to the Lua script
5929in place of the output format. For example:
5931 pandoc -t data/sample.lua
5933Creating a custom writer requires writing a Lua function for each
5934possible element in a pandoc document. To get a documented example
5935which you can modify according to your needs, do
5937 pandoc --print-default-data-file sample.lua
5939Note that custom writers have no default template. If you want
5940to use `--standalone` with a custom writer, you will need to
5941specify a template manually using `--template` or add a new
5942default template with the name
5943`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5944subdirectory of your user data directory (see [Templates]).
5946[Lua]: https://www.lua.org
5950If you use pandoc to convert user-contributed content in a web
5951application, here are some things to keep in mind:
59531. Although pandoc itself will not create or modify any files other
5954 than those you explicitly ask it create (with the exception
5955 of temporary files used in producing PDFs), a filter or custom
5956 writer could in principle do anything on your file system. Please
5957 audit filters and custom writers very carefully before using them.
59592. If your application uses pandoc as a Haskell library (rather than
5960 shelling out to the executable), it is possible to use it in a mode
5961 that fully isolates pandoc from your file system, by running the
5962 pandoc operations in the `PandocPure` monad. See the document
5963 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
59663. Pandoc's parsers can exhibit pathological performance on some
5967 corner cases. It is wise to put any pandoc operations under
5968 a timeout, to avoid DOS attacks that exploit these issues.
5969 If you are using the pandoc executable, you can add the
5970 command line options `+RTS -M512M -RTS` (for example) to limit
5971 the heap size to 512MB.
59734. The HTML generated by pandoc is not guaranteed to be safe.
5974 If `raw_html` is enabled for the Markdown input, users can
5975 inject arbitrary HTML. Even if `raw_html` is disabled,
5976 users can include dangerous content in attributes for
5977 headings, spans, and code blocks. To be safe, you should
5978 run all the generated HTML through an HTML sanitizer.
5982Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
5983under the [GPL], version 2 or greater. This software carries no
5984warranty of any kind. (See COPYRIGHT for full copyright and
5985warranty notices.) For a full list of contributors, see the file
5986AUTHORS.md in the pandoc source code.
5988[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5989[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