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[`iftex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `lualatex` uses
147[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149`mathspec` variable is set, `xelatex` will use [`mathspec`]
150instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151packages are used if available, and [`csquotes`] will be used
152for [typography] if the `csquotes` variable or metadata field is
153set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`iftex`]: https://ctan.org/pkg/iftex
184[`listings`]: https://ctan.org/pkg/listings
185[`lm`]: https://ctan.org/pkg/lm
186[`longtable`]: https://ctan.org/pkg/longtable
187[`mathspec`]: https://ctan.org/pkg/mathspec
188[`microtype`]: https://ctan.org/pkg/microtype
189[`natbib`]: https://ctan.org/pkg/natbib
190[`parskip`]: https://ctan.org/pkg/parskip
191[`polyglossia`]: https://ctan.org/pkg/polyglossia
192[`prince`]: https://www.princexml.com/
193[`setspace`]: https://ctan.org/pkg/setspace
194[`ulem`]: https://ctan.org/pkg/ulem
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
196[`upquote`]: https://ctan.org/pkg/upquote
197[`weasyprint`]: https://weasyprint.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
199[`xcolor`]: https://ctan.org/pkg/xcolor
200[`xecjk`]: https://ctan.org/pkg/xecjk
201[`xurl`]: https://ctan.org/pkg/xurl
202[`selnolig`]: https://ctan.org/pkg/selnolig
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 - `bibtex` ([BibTeX] bibliography)
229 - `biblatex` ([BibLaTeX] bibliography)
230 - `commonmark` ([CommonMark] Markdown)
231 - `commonmark_x` ([CommonMark] Markdown with extensions)
232 - `creole` ([Creole 1.0])
233 - `csljson` ([CSL JSON] bibliography)
234 - `csv` ([CSV] table)
235 - `docbook` ([DocBook])
236 - `docx` ([Word docx])
237 - `dokuwiki` ([DokuWiki markup])
239 - `fb2` ([FictionBook2] e-book)
240 - `gfm` ([GitHub-Flavored Markdown]),
241 or the deprecated and less accurate `markdown_github`;
242 use [`markdown_github`](#markdown-variants) only
243 if you need extensions not supported in [`gfm`](#markdown-variants).
244 - `haddock` ([Haddock markup])
246 - `ipynb` ([Jupyter notebook])
247 - `jats` ([JATS] XML)
248 - `jira` ([Jira]/Confluence wiki markup)
249 - `json` (JSON version of native AST)
251 - `markdown` ([Pandoc's Markdown])
252 - `markdown_mmd` ([MultiMarkdown])
253 - `markdown_phpextra` ([PHP Markdown Extra])
254 - `markdown_strict` (original unextended [Markdown])
255 - `mediawiki` ([MediaWiki markup])
258 - `native` (native Haskell)
261 - `org` ([Emacs Org mode])
262 - `rst` ([reStructuredText])
264 - `textile` ([Textile])
265 - `tikiwiki` ([TikiWiki markup])
266 - `twiki` ([TWiki markup])
267 - `vimwiki` ([Vimwiki])
270 Extensions can be individually enabled or disabled by
271 appending `+EXTENSION` or `-EXTENSION` to the format name.
272 See [Extensions] below, for a list of extensions and
273 their names. See `--list-input-formats` and `--list-extensions`,
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
278: Specify output format. *FORMAT* can be:
280 ::: {#output-formats}
281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283 - `bibtex` ([BibTeX] bibliography)
284 - `biblatex` ([BibLaTeX] bibliography)
285 - `commonmark` ([CommonMark] Markdown)
286 - `commonmark_x` ([CommonMark] Markdown with extensions)
287 - `context` ([ConTeXt])
288 - `csljson` ([CSL JSON] bibliography)
289 - `docbook` or `docbook4` ([DocBook] 4)
290 - `docbook5` (DocBook 5)
291 - `docx` ([Word docx])
292 - `dokuwiki` ([DokuWiki markup])
293 - `epub` or `epub3` ([EPUB] v3 book)
295 - `fb2` ([FictionBook2] e-book)
296 - `gfm` ([GitHub-Flavored Markdown]),
297 or the deprecated and less accurate `markdown_github`;
298 use [`markdown_github`](#markdown-variants) only
299 if you need extensions not supported in [`gfm`](#markdown-variants).
300 - `haddock` ([Haddock markup])
301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302 - `html4` ([XHTML] 1.0 Transitional)
303 - `icml` ([InDesign ICML])
304 - `ipynb` ([Jupyter notebook])
305 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308 - `jats` (alias for `jats_archiving`)
309 - `jira` ([Jira]/Confluence wiki markup)
310 - `json` (JSON version of native AST)
313 - `markdown` ([Pandoc's Markdown])
314 - `markdown_mmd` ([MultiMarkdown])
315 - `markdown_phpextra` ([PHP Markdown Extra])
316 - `markdown_strict` (original unextended [Markdown])
317 - `mediawiki` ([MediaWiki markup])
320 - `native` (native Haskell),
321 - `odt` ([OpenOffice text document][ODT])
323 - `opendocument` ([OpenDocument])
324 - `org` ([Emacs Org mode])
326 - `plain` (plain text),
327 - `pptx` ([PowerPoint] slide show)
328 - `rst` ([reStructuredText])
329 - `rtf` ([Rich Text Format])
330 - `texinfo` ([GNU Texinfo])
331 - `textile` ([Textile])
332 - `slideous` ([Slideous] HTML and JavaScript slide show)
333 - `slidy` ([Slidy] HTML and JavaScript slide show)
334 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336 - `s5` ([S5] HTML and JavaScript slide show)
337 - `tei` ([TEI Simple])
338 - `xwiki` ([XWiki markup])
339 - `zimwiki` ([ZimWiki markup])
340 - the path of a custom Lua writer, see [Custom writers] below
343 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344 to *stdout* unless forced with `-o -`.
346 Extensions can be individually enabled or
347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348 name. See [Extensions] below, for a list of extensions and their
349 names. See `--list-output-formats` and `--list-extensions`, below.
351`-o` *FILE*, `--output=`*FILE*
353: Write output to *FILE* instead of *stdout*. If *FILE* is
354 `-`, output will go to *stdout*, even if a non-textual format
355 (`docx`, `odt`, `epub2`, `epub3`) is specified.
357`--data-dir=`*DIRECTORY*
359: Specify the user data directory to search for pandoc data files.
360 If this option is not specified, the default user data directory
361 will be used. On \*nix and macOS systems this will be the `pandoc`
362 subdirectory of the XDG data directory (by default,
363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364 environment variable). If that directory does not exist,
365 `$HOME/.pandoc` will be used (for backwards compatibility).
366 In Windows the default user data directory is
367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
368 You can find the default user data directory on your system by
369 looking at the output of `pandoc --version`.
370 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371 `slidy`, `slideous`, or `s5` directory
372 placed in this directory will override pandoc's normal defaults.
374`-d` *FILE*, `--defaults=`*FILE*
376: Specify a set of default option settings. *FILE* is a YAML
377 file whose fields correspond to command-line option
378 settings. All options for document conversion, including input
379 and output files, can be set using a defaults file. The file will
380 be searched for first in the working directory, and then in
381 the `defaults` subdirectory of the user data directory
382 (see `--data-dir`). The `.yaml` extension may be omitted.
383 See the section [Default files] for more information on the
384 file format. Settings from the defaults file may be
385 overridden or extended by subsequent options on the command
390: Generate a bash completion script. To enable bash completion
391 with pandoc, add this to your `.bashrc`:
393 eval "$(pandoc --bash-completion)"
397: Give verbose debugging output.
401: Suppress warning messages.
405: Exit with error status if there are any warnings.
409: Write log messages in machine-readable JSON format to
410 *FILE*. All messages above DEBUG level will be written,
411 regardless of verbosity settings (`--verbose`, `--quiet`).
413`--list-input-formats`
415: List supported input formats, one per line.
417`--list-output-formats`
419: List supported output formats, one per line.
421`--list-extensions`[`=`*FORMAT*]
423: List supported extensions for *FORMAT*, one per line, preceded
424 by a `+` or `-` indicating whether it is enabled by default
425 in *FORMAT*. If *FORMAT* is not specified, defaults for
426 pandoc's Markdown are given.
428`--list-highlight-languages`
430: List supported languages for syntax highlighting, one per
433`--list-highlight-styles`
435: List supported styles for syntax highlighting, one per line.
436 See `--highlight-style`.
446[Markdown]: https://daringfireball.net/projects/markdown/
447[CommonMark]: https://commonmark.org
448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452[S5]: https://meyerweb.com/eric/tools/s5/
453[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454[Slideous]: https://goessner.net/articles/slideous/
455[HTML]: https://www.w3.org/html/
456[HTML5]: https://html.spec.whatwg.org/
457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458[XHTML]: https://www.w3.org/TR/xhtml1/
459[LaTeX]: https://www.latex-project.org/
460[`beamer`]: https://ctan.org/pkg/beamer
461[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462[ConTeXt]: https://www.contextgarden.net/
463[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464[DocBook]: https://docbook.org
465[JATS]: https://jats.nlm.nih.gov
466[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467[txt2tags]: https://txt2tags.org
468[EPUB]: http://idpf.org/epub
469[OPML]: http://dev.opml.org/spec2.html
470[OpenDocument]: http://opendocument.xml.org
471[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472[Textile]: https://www.promptworks.com/textile
473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481[CSV]: https://tools.ietf.org/html/rfc4180
482[roff man]: https://man.cx/groff_man(7)
483[roff ms]: https://man.cx/groff_ms(7)
484[Haskell]: https://www.haskell.org
485[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486[Emacs Org mode]: https://orgmode.org
487[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488[AsciiDoctor]: https://asciidoctor.org/
489[DZSlides]: https://paulrouget.com/dzslides/
490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491[PDF]: https://www.adobe.com/pdf/
492[reveal.js]: https://revealjs.com/
493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496[TEI Simple]: https://github.com/TEIC/TEI-Simple
497[Muse]: https://amusewiki.org/library/manual
498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499[Vimwiki]: https://vimwiki.github.io
500[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501[BibTeX]: https://ctan.org/pkg/bibtex
502[BibLaTeX]: https://ctan.org/pkg/biblatex
504## Reader options {.options}
506`--shift-heading-level-by=`*NUMBER*
508: Shift heading levels by a positive or negative integer.
509 For example, with `--shift-heading-level-by=-1`, level 2
510 headings become level 1 headings, and level 3 headings
511 become level 2 headings. Headings cannot have a level
512 less than 1, so a heading that would be shifted below level 1
513 becomes a regular paragraph. Exception: with a shift of -N,
514 a level-N heading at the beginning of the document
515 replaces the metadata title. `--shift-heading-level-by=-1`
516 is a good choice when converting HTML or Markdown documents that
517 use an initial level-1 heading for the document title and
518 level-2+ headings for sections. `--shift-heading-level-by=1`
519 may be a good choice for converting Markdown documents that
520 use level-1 headings for sections to HTML, since pandoc uses
521 a level-1 heading to render the document title.
523`--base-header-level=`*NUMBER*
525: *Deprecated. Use `--shift-heading-level-by`=X instead,
526 where X = NUMBER - 1.* Specify the base level for headings
529`--strip-empty-paragraphs`
531: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532 Ignore paragraphs with no content. This option is useful
533 for converting word processing documents where users have
534 used empty paragraphs to create inter-paragraph space.
536`--indented-code-classes=`*CLASSES*
538: Specify classes to use for indented code blocks--for example,
539 `perl,numberLines` or `haskell`. Multiple classes may be separated
542`--default-image-extension=`*EXTENSION*
544: Specify a default extension to use when image paths/URLs have no
545 extension. This allows you to use the same source for formats that
546 require different kinds of images. Currently this option only affects
547 the Markdown and LaTeX readers.
551: Parse each file individually before combining for multifile
552 documents. This will allow footnotes in different files with the
553 same identifiers to work as expected. If this option is set,
554 footnotes and links will not work across files. Reading binary
555 files (docx, odt, epub) implies `--file-scope`.
557`-F` *PROGRAM*, `--filter=`*PROGRAM*
559: Specify an executable to be used as a filter transforming the
560 pandoc AST after the input is parsed and before the output is
561 written. The executable should read JSON from stdin and write
562 JSON to stdout. The JSON must be formatted like pandoc's own
563 JSON input and output. The name of the output format will be
564 passed to the filter as the first argument. Hence,
566 pandoc --filter ./caps.py -t latex
570 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
572 The latter form may be useful for debugging filters.
574 Filters may be written in any language. `Text.Pandoc.JSON`
575 exports `toJSONFilter` to facilitate writing filters in Haskell.
576 Those who would prefer to write filters in python can use the
577 module [`pandocfilters`], installable from PyPI. There are also
578 pandoc filter libraries in [PHP], [perl], and
579 [JavaScript/node.js].
581 In order of preference, pandoc will look for filters in
583 1. a specified full or relative path (executable or
586 2. `$DATADIR/filters` (executable or non-executable)
587 where `$DATADIR` is the user data directory (see
588 `--data-dir`, above).
590 3. `$PATH` (executable only)
592 Filters, Lua-filters, and citeproc processing are applied in
593 the order specified on the command line.
595`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
597: Transform the document in a similar fashion as JSON filters (see
598 `--filter`), but use pandoc's built-in Lua filtering system. The given
599 Lua script is expected to return a list of Lua filters which will be
600 applied in order. Each Lua filter must contain element-transforming
601 functions indexed by the name of the AST element on which the filter
602 function should be applied.
604 The `pandoc` Lua module provides helper functions for element
605 creation. It is always loaded into the script's Lua environment.
607 See the [Lua filters documentation] for further details.
609 In order of preference, pandoc will look for Lua filters in
611 1. a specified full or relative path
613 2. `$DATADIR/filters` where `$DATADIR` is the user data
614 directory (see `--data-dir`, above).
616 Filters, Lua filters, and citeproc processing are applied in
617 the order specified on the command line.
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) processes all the insertions and deletions.
661 `reject` ignores them. Both `accept` and `reject` ignore comments.
662 `all` includes all insertions, deletions, and comments, wrapped
663 in spans with `insertion`, `deletion`, `comment-start`, and
664 `comment-end` classes, respectively. The author and time of
665 change is included. `all` is useful for scripting: only
666 accepting changes from a certain reviewer, say, or before a
667 certain date. If a paragraph is inserted or deleted,
668 `track-changes=all` produces a span with the class
669 `paragraph-insertion`/`paragraph-deletion` before the
670 affected paragraph break. This option only affects the docx
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
702[Lua filters documentation]: https://pandoc.org/lua-filters.html
704## General writer options {.options}
708: Produce output with an appropriate header and footer (e.g. a
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711 output. For `native` output, this option causes metadata to
712 be included; otherwise, metadata is suppressed.
714`--template=`*FILE*|*URL*
716: Use the specified file as a custom template for the generated document.
717 Implies `--standalone`. See [Templates], below, for a description
718 of template syntax. If no extension is specified, an extension
719 corresponding to the writer will be added, so that `--template=special`
720 looks for `special.html` for HTML output. If the template is not
721 found, pandoc will search for it in the `templates` subdirectory of
722 the user data directory (see `--data-dir`). If this option is not used,
723 a default template appropriate for the output format will be used (see
724 `-D/--print-default-template`).
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
728: Set the template variable *KEY* to the value *VAL* when rendering the
729 document in standalone mode. If no *VAL* is specified, the
730 key will be given the value `true`.
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
734: Print the system default template for an output *FORMAT*. (See `-t`
735 for a list of possible *FORMAT*s.) Templates in the user data
736 directory are ignored. This option may be used with
737 `-o`/`--output` to redirect output to a file, but
738 `-o`/`--output` must come before `--print-default-template`
741 Note that some of the default templates use partials, for
742 example `styles.html`. To print the partials, use
743 `--print-default-data-file`: for example,
744 `--print-default-data-file=templates/styles.html`.
746`--print-default-data-file=`*FILE*
748: Print a system default data file. Files in the user data directory
749 are ignored. This option may be used with `-o`/`--output` to
750 redirect output to a file, but `-o`/`--output` must come before
751 `--print-default-data-file` on the command line.
753`--eol=crlf`|`lf`|`native`
755: Manually specify line endings: `crlf` (Windows), `lf`
756 (macOS/Linux/UNIX), or `native` (line endings appropriate
757 to the OS on which pandoc is being run). The default is
762: Specify the default dpi (dots per inch) value for conversion
763 from pixels to inch/centimeters and vice versa. (Technically,
764 the correct term would be ppi: pixels per inch.) The default
765 is 96dpi. When images contain information about dpi
766 internally, the encoded value is used instead of the default
767 specified by this option.
769`--wrap=auto`|`none`|`preserve`
771: Determine how text is wrapped in the output (the source
772 code, not the rendered version). With `auto` (the default),
773 pandoc will attempt to wrap lines to the column width specified by
774 `--columns` (default 72). With `none`, pandoc will not wrap
775 lines at all. With `preserve`, pandoc will attempt to
776 preserve the wrapping from the source document (that is,
777 where there are nonsemantic newlines in the source, there
778 will be nonsemantic newlines in the output as well).
779 Automatic wrapping does not currently work in HTML output.
780 In `ipynb` output, this option affects wrapping of the
781 contents of markdown cells.
785: Specify length of lines in characters. This affects text wrapping
786 in the generated source code (see `--wrap`). It also affects
787 calculation of column widths for plain text tables (see [Tables] below).
789`--toc`, `--table-of-contents`
791: Include an automatically generated table of contents (or, in
792 the case of `latex`, `context`, `docx`, `odt`,
793 `opendocument`, `rst`, or `ms`, an instruction to create
794 one) in the output document. This option has no effect
795 unless `-s/--standalone` is used, and it has no effect
796 on `man`, `docbook4`, `docbook5`, or `jats` output.
798 Note that if you are producing a PDF via `ms`, the table
799 of contents will appear at the beginning of the
800 document, before the title. If you would prefer it to
801 be at the end of the document, use the option
802 `--pdf-engine-opt=--no-toc-relocation`.
804`--toc-depth=`*NUMBER*
806: Specify the number of section levels to include in the table
807 of contents. The default is 3 (which means that level-1, 2, and 3
808 headings will be listed in the contents).
812: Strip out HTML comments in the Markdown or Textile source,
813 rather than passing them on to Markdown, Textile or HTML
814 output as raw HTML. This does not apply to HTML comments
815 inside raw HTML blocks when the `markdown_in_html_blocks`
816 extension is not set.
820: Disables syntax highlighting for code blocks and inlines, even when
821 a language attribute is given.
823`--highlight-style=`*STYLE*|*FILE*
825: Specifies the coloring style to be used in highlighted source code.
826 Options are `pygments` (the default), `kate`, `monochrome`,
827 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
828 For more information on syntax highlighting in pandoc, see
829 [Syntax highlighting], below. See also
830 `--list-highlight-styles`.
832 Instead of a *STYLE* name, a JSON file with extension
833 `.theme` may be supplied. This will be parsed as a KDE
834 syntax highlighting theme and (if valid) used as the
837 To generate the JSON version of an existing style,
838 use `--print-highlight-style`.
840`--print-highlight-style=`*STYLE*|*FILE*
842: Prints a JSON version of a highlighting style, which can
843 be modified, saved with a `.theme` extension, and used
844 with `--highlight-style`. This option may be used with
845 `-o`/`--output` to redirect output to a file, but
846 `-o`/`--output` must come before `--print-highlight-style`
849`--syntax-definition=`*FILE*
851: Instructs pandoc to load a KDE XML syntax definition file,
852 which will be used for syntax highlighting of appropriately
853 marked code blocks. This can be used to add support for
854 new languages or to use altered syntax definitions for
855 existing languages. This option may be repeated to add
856 multiple syntax definitions.
858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
860: Include contents of *FILE*, verbatim, at the end of the header.
861 This can be used, for example, to include special
862 CSS or JavaScript in HTML documents. This option can be used
863 repeatedly to include multiple files in the header. They will be
864 included in the order specified. Implies `--standalone`.
866`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
868: Include contents of *FILE*, verbatim, at the beginning of the
869 document body (e.g. after the `<body>` tag in HTML, or the
870 `\begin{document}` command in LaTeX). This can be used to include
871 navigation bars or banners in HTML documents. This option can be
872 used repeatedly to include multiple files. They will be included in
873 the order specified. Implies `--standalone`.
875`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
877: Include contents of *FILE*, verbatim, at the end of the document
878 body (before the `</body>` tag in HTML, or the
879 `\end{document}` command in LaTeX). This option can be used
880 repeatedly to include multiple files. They will be included in the
881 order specified. Implies `--standalone`.
883`--resource-path=`*SEARCHPATH*
885: List of paths to search for images and other resources.
886 The paths should be separated by `:` on Linux, UNIX, and
887 macOS systems, and by `;` on Windows. If `--resource-path`
888 is not specified, the default resource path is the working
889 directory. Note that, if `--resource-path` is specified,
890 the working directory must be explicitly listed or it
891 will not be searched. For example:
892 `--resource-path=.:test` will search the working directory
893 and the `test` subdirectory, in that order.
895`--request-header=`*NAME*`:`*VAL*
897: Set the request header *NAME* to the value *VAL* when making
898 HTTP requests (for example, when a URL is given on the
899 command line, or when resources used in a document must be
900 downloaded). If you're behind a proxy, you also need to set
901 the environment variable `http_proxy` to `http://...`.
903`--no-check-certificate`
905: Disable the certificate verification to allow access to
906 unsecure HTTP resources (for example when the certificate
907 is no longer valid or self signed).
909## Options affecting specific writers {.options}
913: Produce a standalone HTML file with no external dependencies, using
914 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
915 images, and videos. Implies `--standalone`. The resulting file should be
916 "self-contained," in the sense that it needs no external files and no net
917 access to be displayed properly by a browser. This option works only with
918 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
919 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
920 and stylesheets at absolute URLs will be downloaded; those at relative
921 URLs will be sought relative to the working directory (if the first source
922 file is local) or relative to the base URL (if the first source
923 file is remote). Elements with the attribute
924 `data-external="1"` will be left alone; the documents they
925 link to will not be incorporated in the document.
926 Limitation: resources that are loaded dynamically through
927 JavaScript cannot be incorporated; as a result,
928 `--self-contained` does not work with `--mathjax`, and some
929 advanced features (e.g. zoom or speaker notes) may not work
930 in an offline "self-contained" `reveal.js` slide show.
934: Use `<q>` tags for quotes in HTML. (This option only has an
935 effect if the `smart` extension is enabled for the input
940: Use only ASCII characters in output. Currently supported for XML
941 and HTML formats (which use entities instead of UTF-8 when this
942 option is selected), CommonMark, gfm, and Markdown (which use
943 entities), roff ms (which use hexadecimal escapes), and to a
944 limited degree LaTeX (which uses standard commands for accented
945 characters when possible). roff man output uses ASCII by default.
949: Use reference-style links, rather than inline links, in writing Markdown
950 or reStructuredText. By default inline links are used. The
951 placement of link references is affected by the
952 `--reference-location` option.
954`--reference-location=block`|`section`|`document`
956: Specify whether footnotes (and references, if `reference-links` is
957 set) are placed at the end of the current (top-level) block, the
958 current section, or the document. The default is
959 `document`. Currently only affects the markdown writer.
961`--markdown-headings=setext`|`atx`
963: Specify whether to use ATX-style (`#`-prefixed) or
964 Setext-style (underlined) headings for level 1 and 2
965 headings in Markdown output. (The default is `atx`.)
966 ATX-style headings are always used for levels 3+.
967 This option also affects Markdown cells in `ipynb` output.
971: *Deprecated synonym for `--markdown-headings=atx`.*
973`--top-level-division=default`|`section`|`chapter`|`part`
975: Treat top-level headings as the given division type in
976 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
977 order is part, chapter, then section; all headings are
978 shifted such that the top-level heading becomes the
979 specified type. The default behavior is to determine the
980 best division type via heuristics: unless other conditions
981 apply, `section` is chosen. When the `documentclass`
982 variable is set to `report`, `book`, or `memoir` (unless the
983 `article` option is specified), `chapter` is implied as the
984 setting for this option. If `beamer` is the output format,
985 specifying either `chapter` or `part` will cause top-level
986 headings to become `\part{..}`, while second-level headings
987 remain as their default type.
989`-N`, `--number-sections`
991: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
992 output. By default, sections are not numbered. Sections with class
993 `unnumbered` will never be numbered, even if `--number-sections`
996`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
998: Offset for section headings in HTML output (ignored in other
999 output formats). The first number is added to the section number for
1000 top-level headings, the second for second-level headings, and so on.
1001 So, for example, if you want the first top-level heading in your
1002 document to be numbered "6", specify `--number-offset=5`.
1003 If your document starts with a level-2 heading which you want to
1004 be numbered "1.5", specify `--number-offset=1,4`.
1005 Offsets are 0 by default. Implies `--number-sections`.
1009: Use the [`listings`] package for LaTeX code blocks. The package
1010 does not support multi-byte encoding for source code. To handle UTF-8
1011 you would need to use a custom template. This issue is fully
1012 documented here: [Encoding issue with the listings package].
1014`-i`, `--incremental`
1016: Make list items in slide shows display incrementally (one by one).
1017 The default is for lists to be displayed all at once.
1019`--slide-level=`*NUMBER*
1021: Specifies that headings with the specified level create
1022 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1023 above this level in the hierarchy are used to divide the
1024 slide show into sections; headings below this level create
1025 subheads within a slide. Note that content that is
1026 not contained under slide-level headings will not appear in
1027 the slide show. The default is to set the slide level based
1028 on the contents of the document; see [Structuring the slide
1033: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1034 and attach identifiers to the enclosing `<section>` (or `<div>`)
1035 rather than the heading itself. See
1036 [Heading identifiers], below.
1038`--email-obfuscation=none`|`javascript`|`references`
1040: Specify a method for obfuscating `mailto:` links in HTML documents.
1041 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1042 them using JavaScript. `references` obfuscates them by printing their
1043 letters as decimal or hexadecimal character references. The default
1046`--id-prefix=`*STRING*
1048: Specify a prefix to be added to all identifiers and internal links
1049 in HTML and DocBook output, and to footnote numbers in Markdown
1050 and Haddock output. This is useful for preventing duplicate
1051 identifiers when generating fragments to be included in other pages.
1053`-T` *STRING*, `--title-prefix=`*STRING*
1055: Specify *STRING* as a prefix at the beginning of the title
1056 that appears in the HTML header (but not in the title as it
1057 appears at the beginning of the HTML body). Implies `--standalone`.
1059`-c` *URL*, `--css=`*URL*
1061: Link to a CSS style sheet. This option can be used repeatedly to
1062 include multiple files. They will be included in the order specified.
1064 A stylesheet is required for generating EPUB. If none is
1065 provided using this option (or the `css` or `stylesheet`
1066 metadata fields), pandoc will look for a file `epub.css` in the
1067 user data directory (see `--data-dir`). If it is not
1068 found there, sensible defaults will be used.
1070`--reference-doc=`*FILE*
1072: Use the specified file as a style reference in producing a
1077 : For best results, the reference docx should be a modified
1078 version of a docx file produced using pandoc. The contents
1079 of the reference docx are ignored, but its stylesheets and
1080 document properties (including margins, page size, header,
1081 and footer) are used in the new docx. If no reference docx
1082 is specified on the command line, pandoc will look for a
1083 file `reference.docx` in the user data directory (see
1084 `--data-dir`). If this is not found either, sensible
1085 defaults will be used.
1087 To produce a custom `reference.docx`, first get a copy of
1088 the default `reference.docx`: `pandoc
1089 -o custom-reference.docx --print-default-data-file reference.docx`.
1090 Then open `custom-reference.docx` in Word, modify the
1091 styles as you wish, and save the file. For best
1092 results, do not make changes to this file other than
1093 modifying the styles used by pandoc:
1129 - Default Paragraph Font
1132 - Footnote Reference
1142 : For best results, the reference ODT should be a modified
1143 version of an ODT produced using pandoc. The contents of
1144 the reference ODT are ignored, but its stylesheets are used
1145 in the new ODT. If no reference ODT is specified on the
1146 command line, pandoc will look for a file `reference.odt` in
1147 the user data directory (see `--data-dir`). If this is not
1148 found either, sensible defaults will be used.
1150 To produce a custom `reference.odt`, first get a copy of
1151 the default `reference.odt`: `pandoc
1152 -o custom-reference.odt --print-default-data-file reference.odt`.
1153 Then open `custom-reference.odt` in LibreOffice, modify
1154 the styles as you wish, and save the file.
1158 : Templates included with Microsoft PowerPoint 2013 (either with
1159 `.pptx` or `.potx` extension) are known to work, as are most
1160 templates derived from these.
1162 The specific requirement is that the template should begin with
1163 the following first four layouts:
1166 2. Title and Content
1170 All templates included with a recent version of MS PowerPoint
1171 will fit these criteria. (You can click on `Layout` under the
1172 `Home` menu to check.)
1174 You can also modify the default `reference.pptx`: first run
1175 `pandoc -o custom-reference.pptx --print-default-data-file
1176 reference.pptx`, and then modify `custom-reference.pptx`
1177 in MS PowerPoint (pandoc will use the first four layout
1178 slides, as mentioned above).
1180`--epub-cover-image=`*FILE*
1182: Use the specified image as the EPUB cover. It is recommended
1183 that the image be less than 1000px in width and height. Note that
1184 in a Markdown source document you can also specify `cover-image`
1185 in a YAML metadata block (see [EPUB Metadata], below).
1187`--epub-metadata=`*FILE*
1189: Look in the specified XML file for metadata for the EPUB.
1190 The file should contain a series of [Dublin Core elements].
1193 <dc:rights>Creative Commons</dc:rights>
1194 <dc:language>es-AR</dc:language>
1196 By default, pandoc will include the following metadata elements:
1197 `<dc:title>` (from the document title), `<dc:creator>` (from the
1198 document authors), `<dc:date>` (from the document date, which should
1199 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1200 variable, or, if is not set, the locale), and `<dc:identifier
1201 id="BookId">` (a randomly generated UUID). Any of these may be
1202 overridden by elements in the metadata file.
1204 Note: if the source document is Markdown, a YAML metadata block
1205 in the document can be used instead. See below under
1208`--epub-embed-font=`*FILE*
1210: Embed the specified font in the EPUB. This option can be repeated
1211 to embed multiple fonts. Wildcards can also be used: for example,
1212 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1213 line, be sure to escape them or put the whole filename in single quotes,
1214 to prevent them from being interpreted by the shell. To use the
1215 embedded fonts, you will need to add declarations like the following
1216 to your CSS (see `--css`):
1219 font-family: DejaVuSans;
1221 font-weight: normal;
1222 src:url("DejaVuSans-Regular.ttf");
1225 font-family: DejaVuSans;
1228 src:url("DejaVuSans-Bold.ttf");
1231 font-family: DejaVuSans;
1233 font-weight: normal;
1234 src:url("DejaVuSans-Oblique.ttf");
1237 font-family: DejaVuSans;
1240 src:url("DejaVuSans-BoldOblique.ttf");
1242 body { font-family: "DejaVuSans"; }
1244`--epub-chapter-level=`*NUMBER*
1246: Specify the heading level at which to split the EPUB into separate
1247 "chapter" files. The default is to split into chapters at level-1
1248 headings. This option only affects the internal composition of the
1249 EPUB, not the way chapters and sections are displayed to users. Some
1250 readers may be slow if the chapter files are too large, so for large
1251 documents with few level-1 headings, one might want to use a chapter
1254`--epub-subdirectory=`*DIRNAME*
1256: Specify the subdirectory in the OCF container that is to hold
1257 the EPUB-specific contents. The default is `EPUB`. To put
1258 the EPUB contents in the top level, use an empty string.
1260`--ipynb-output=all|none|best`
1262: Determines how ipynb output cells are treated. `all` means
1263 that all of the data formats included in the original are
1264 preserved. `none` means that the contents of data cells
1265 are omitted. `best` causes pandoc to try to pick the
1266 richest data block in each output cell that is compatible
1267 with the output format. The default is `best`.
1269`--pdf-engine=`*PROGRAM*
1271: Use the specified engine when producing PDF output.
1272 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1273 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1274 and `pdfroff`. If the engine is not in your PATH, the full
1275 path of the engine may be specified here. If this option
1276 is not specified, pandoc uses the following defaults
1277 depending on the output format specified using `-t/--to`:
1279 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1280 `tectonic`, `latexmk`)
1281 - `-t context`: `context`
1282 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1283 see [print-css.rocks](https://print-css.rocks) for a good
1284 introduction to PDF generation from HTML/CSS.)
1285 - `-t ms`: `pdfroff`
1287`--pdf-engine-opt=`*STRING*
1289: Use the given string as a command-line argument to the `pdf-engine`.
1290 For example, to use a persistent directory `foo` for `latexmk`'s
1291 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1292 Note that no check for duplicate options is done.
1294[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1295[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1296[Encoding issue with the listings package]:
1297 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1299## Citation rendering {.options}
1303: Process the citations in the file, replacing them with
1304 rendered citations and adding a bibliography.
1305 Citation processing will not take place unless bibliographic
1306 data is supplied, either through an external file specified
1307 using the `--bibliography` option or the `bibliography`
1308 field in metadata, or via a `references` section in metadata
1309 containing a list of citations in CSL YAML format with
1310 Markdown formatting. The style is controlled by a [CSL]
1311 stylesheet specified using the `--csl` option or the `csl`
1312 field in metadata. (If no stylesheet is specified,
1313 the `chicago-author-date` style will be used by default.)
1314 The citation processing transformation may be applied before
1315 or after filters or Lua filters (see `--filter`,
1316 `--lua-filter`): these transformations are applied in the
1317 order they appear on the command line. For more
1318 information, see the section on [Citations].
1320`--bibliography=`*FILE*
1322: Set the `bibliography` field in the document's metadata to *FILE*,
1323 overriding any value set in the metadata. If you supply
1324 this argument multiple times, each *FILE* will be added to
1325 bibliography. If *FILE* is a URL, it will be fetched
1326 via HTTP. If *FILE* is not found relative to the
1327 working directory, it will be sought in the resource path
1328 (see `--resource-path`).
1332: Set the `csl` field in the document's metadata to *FILE*,
1333 overriding any value set in the metadata. (This is equivalent to
1334 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1335 fetched via HTTP. If *FILE* is not found relative to the
1336 working directory, it will be sought in the resource path
1337 (see `--resource-path`) and finally in the `csl`
1338 subdirectory of the pandoc user data directory.
1340`--citation-abbreviations=`*FILE*
1342: Set the `citation-abbreviations` field in the document's metadata to
1343 *FILE*, overriding any value set in the metadata. (This is equivalent to
1344 `--metadata citation-abbreviations=FILE`.)
1345 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1346 found relative to the working directory, it will be sought
1347 in the resource path (see `--resource-path`) and finally in
1348 the `csl` subdirectory of the pandoc user data directory.
1352: Use [`natbib`] for citations in LaTeX output. This option
1353 is not for use with the `--citeproc` option or with PDF
1354 output. It is intended for use in producing a LaTeX file
1355 that can be processed with [`bibtex`].
1359: Use [`biblatex`] for citations in LaTeX output. This option
1360 is not for use with the `--citeproc` option or with PDF
1361 output. It is intended for use in producing a LaTeX file
1362 that can be processed with [`bibtex`] or [`biber`].
1364## Math rendering in HTML {.options}
1366The default is to render TeX math as far as possible using
1367Unicode characters. Formulas are put inside a `span` with
1368`class="math"`, so that they may be styled differently from the
1369surrounding text if needed. However, this gives acceptable
1370results only for basic math, usually you will want to use
1371`--mathjax` or another of the following options.
1373`--mathjax`[`=`*URL*]
1375: Use [MathJax] to display embedded TeX math in HTML output.
1376 TeX math will be put between `\(...\)` (for inline math)
1377 or `\[...\]` (for display math) and wrapped in `<span>` tags
1378 with class `math`. Then the MathJax JavaScript will render it.
1379 The *URL* should point to the `MathJax.js` load script.
1380 If a *URL* is not provided, a link to the Cloudflare CDN will
1385: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1386 `docbook5`, `jats`, `html4` and `html5`). This is the
1387 default in `odt` output. Note that currently only Firefox
1388 and Safari (and select e-book readers) natively support
1393: Convert TeX formulas to `<img>` tags that link to an external script
1394 that converts formulas to images. The formula will be URL-encoded
1395 and concatenated with the URL provided. For SVG images you can for
1396 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1397 If no URL is specified, the CodeCogs URL generating PNGs
1398 will be used (`https://latex.codecogs.com/png.latex?`).
1399 Note: the `--webtex` option will affect Markdown output
1400 as well as HTML, which is useful if you're targeting a
1401 version of Markdown without native math support.
1405: Use [KaTeX] to display embedded TeX math in HTML output.
1406 The *URL* is the base URL for the KaTeX library. That directory
1407 should contain a `katex.min.js` and a `katex.min.css` file.
1408 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1412: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1413 can then be processed by [GladTeX] to produce images of the typeset
1414 formulas and an HTML file with links to these images.
1415 So, the procedure is:
1417 pandoc -s --gladtex input.md -o myfile.htex
1418 gladtex -d myfile-images myfile.htex
1419 # produces myfile.html and images in myfile-images
1421[MathML]: https://www.w3.org/Math/
1422[MathJax]: https://www.mathjax.org
1423[KaTeX]: https://github.com/Khan/KaTeX
1424[GladTeX]: https://humenda.github.io/GladTeX/
1426## Options for wrapper scripts {.options}
1430: Print information about command-line arguments to *stdout*, then exit.
1431 This option is intended primarily for use in wrapper scripts.
1432 The first line of output contains the name of the output file specified
1433 with the `-o` option, or `-` (for *stdout*) if no output file was
1434 specified. The remaining lines contain the command-line arguments,
1435 one per line, in the order they appear. These do not include regular
1436 pandoc options and their arguments, but do include any options appearing
1437 after a `--` separator at the end of the line.
1441: Ignore command-line arguments (for use in wrapper scripts).
1442 Regular pandoc options are not ignored. Thus, for example,
1444 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1448 pandoc -o foo.html -s
1452If pandoc completes successfully, it will return exit code 0.
1453Nonzero exit codes have the following meanings:
1456----- ------------------------------------
1457 3 PandocFailOnWarningError
1459 5 PandocTemplateError
1461 21 PandocUnknownReaderError
1462 22 PandocUnknownWriterError
1463 23 PandocUnsupportedExtensionError
1464 24 PandocCiteprocError
1465 31 PandocEpubSubdirectoryError
1468 47 PandocPDFProgramNotFoundError
1470 62 PandocShouldNeverHappenError
1473 65 PandocParsecError
1474 66 PandocMakePDFError
1475 67 PandocSyntaxMapError
1476 83 PandocFilterError
1478 92 PandocUTF8DecodingError
1479 93 PandocIpynbDecodingError
1480 94 PandocUnsupportedCharsetError
1481 97 PandocCouldNotFindDataFileError
1482 99 PandocResourceNotFound
1483----- ------------------------------------
1487The `--defaults` option may be used to specify a package
1488of options. Here is a sample defaults file demonstrating all of
1489the fields that may be used:
1493# reader: may be used instead of from:
1495# writer: may be used instead of to:
1497# leave blank for output to stdout:
1499# leave blank for input from stdin, use [] for no input:
1503# or you may use input-file: with a single value
1505# Include options from the specified defaults files.
1506# The files will be searched for first in the working directory
1507# and then in the defaults subdirectory of the user data directory.
1508# The files are included in the same order in which they appear in
1509# the list. Options specified in this defaults file always have
1510# priority over the included ones.
1517self-contained: false
1519# note that structured variables may be specified:
1526# metadata values specified here are parsed as literal
1527# string text, not markdown:
1534# or you may use metadata-file: with a single value
1536# Note that these take files, not their contents:
1537include-before-body: []
1538include-after-body: []
1539include-in-header: []
1542# turn on built-in citation processing. Note that if you need
1543# control over when the citeproc processing is done relative
1544# to other filters, you should instead use `citeproc` in the
1545# list of `filters` (see below).
1551citation-abbreviations: abbrevs.json
1553# Filters will be assumed to be Lua filters if they have
1554# the .lua extension, and json filters otherwise. But
1555# the filter type can also be specified explicitly, as shown.
1556# Filters are run in the order specified.
1557# To include the built-in citeproc filter, use either `citeproc`
1558# or `{type: citeproc}`.
1568# ERROR, WARNING, or INFO
1572# citeproc, natbib, or biblatex. This only affects LaTeX
1573# output. If you want to use citeproc to format citations,
1574# you should also set 'citeproc: true' (see above).
1575cite-method: citeproc
1577# part, chapter, section, or default:
1578top-level-division: chapter
1584# you may also use pdf-engine-opt: with a single option
1585# pdf-engine-opt: "-shell-escape"
1587# auto, preserve, or none
1592extract-media: mediadir
1594table-of-contents: true
1596number-sections: false
1597# a list of offsets at each heading level
1598number-offset: [0,0,0,0,0,0]
1599# toc: may also be used instead of table-of-contents:
1600shift-heading-level-by: 1
1602identifier-prefix: foo
1604strip-empty-paragraphs: true
1605# lf, crlf, or native
1607strip-comments: false
1608indented-code-classes: []
1610default-image-extension: ".jpg"
1612# either a style name of a style definition file:
1613highlight-style: pygments
1616# or you may use syntax-definition: with a single value
1619reference-doc: myref.docx
1621# method is plain, webtex, gladtex, mathml, mathjax, katex
1622# you may specify a url with webtex, mathjax, katex
1625 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1626# none, references, or javascript
1627email-obfuscation: javascript
1635epub-subdirectory: EPUB
1636epub-metadata: meta.xml
1639epub-chapter-level: 1
1640epub-cover-image: cover.jpg
1642reference-links: true
1643# block, section, or document
1644reference-location: block
1645markdown-headings: setext
1647# accept, reject, or all
1648track-changes: accept
1657# A list of two-element lists
1659- ["User-Agent", "Mozilla/5.0"]
1661fail-if-warnings: false
1667Fields that are omitted will just have their regular
1668default values. So a defaults file can be as simple as
1675Default files can be placed in the `defaults` subdirectory of
1676the user data directory and used from any directory. For
1677example, one could create a file specifying defaults for writing
1678letters, save it as `letter.yaml` in the `defaults` subdirectory
1679of the user data directory, and then invoke these defaults
1680from any directory using `pandoc --defaults letter`
1681or `pandoc -dletter`.
1683When multiple defaults are used, their contents will be combined.
1685Note that, where command-line arguments may be repeated
1686(`--metadata-file`, `--css`, `--include-in-header`,
1687`--include-before-body`, `--include-after-body`, `--variable`,
1688`--metadata`, `--syntax-definition`), the values specified on
1689the command line will combine with values specified in the
1690defaults file, rather than replacing them.
1694When the `-s/--standalone` option is used, pandoc uses a template to
1695add header and footer material that is needed for a self-standing
1696document. To see the default template that is used, just type
1700where *FORMAT* is the name of the output format. A custom template
1701can be specified using the `--template` option. You can also override
1702the system default templates for a given output format *FORMAT*
1703by putting a file `templates/default.*FORMAT*` in the user data
1704directory (see `--data-dir`, above). *Exceptions:*
1706- For `odt` output, customize the `default.opendocument`
1708- For `pdf` output, customize the `default.latex` template
1709 (or the `default.context` template, if you use `-t context`,
1710 or the `default.ms` template, if you use `-t ms`, or the
1711 `default.html` template, if you use `-t html`).
1712- `docx` and `pptx` have no template (however, you can use
1713 `--reference-doc` to customize the output).
1715Templates contain *variables*, which allow for the inclusion of
1716arbitrary information at any point in the file. They may be set at the
1717command line using the `-V/--variable` option. If a variable is not set,
1718pandoc will look for the key in the document's metadata, which can be set
1719using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1720or with the `-M/--metadata` option. In addition, some variables
1721are given default values by pandoc. See [Variables] below for
1722a list of variables used in pandoc's default templates.
1724If you use custom templates, you may need to revise them as pandoc
1725changes. We recommend tracking the changes in the default templates,
1726and modifying your custom templates accordingly. An easy way to do this
1727is to fork the [pandoc-templates] repository and merge in
1728changes after each pandoc release.
1730 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1736Anything between the sequence `$--` and the end of the
1737line will be treated as a comment and omitted from the output.
1741To mark variables and control structures in the template,
1742either `$`...`$` or `${`...`}` may be used as delimiters.
1743The styles may also be mixed in the same template, but the
1744opening and closing delimiter must match in each case. The
1745opening delimiter may be followed by one or more spaces
1746or tabs, which will be ignored. The closing delimiter may
1747be followed by one or more spaces or tabs, which will be
1750To include a literal `$` in the document, use `$$`.
1752### Interpolated variables
1754A slot for an interpolated variable is a variable name surrounded
1755by matched delimiters. Variable names must begin with a letter
1756and can contain letters, numbers, `_`, `-`, and `.`. The
1757keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1758not be used as variable names. Examples:
1771Variable names with periods are used to get at structured
1772variable values. So, for example, `employee.salary` will return the
1773value of the `salary` field of the object that is the value of
1774the `employee` field.
1776- If the value of the variable is simple value, it will be
1777 rendered verbatim. (Note that no escaping is done;
1778 the assumption is that the calling program will escape
1779 the strings appropriately for the output format.)
1780- If the value is a list, the values will be concatenated.
1781- If the value is a map, the string `true` will be rendered.
1782- Every other value will be rendered as the empty string.
1786A conditional begins with `if(variable)` (enclosed in
1787matched delimiters) and ends with `endif` (enclosed in matched
1788delimiters). It may optionally contain an `else` (enclosed in
1789matched delimiters). The `if` section is used if
1790`variable` has a non-empty value, otherwise the `else`
1791section is used (if present). Examples:
1806${if(foo)}bar${endif}
1819The keyword `elseif` may be used to simplify complex nested
1834A for loop begins with `for(variable)` (enclosed in
1835matched delimiters) and ends with `endfor` (enclosed in matched
1838- If `variable` is an array, the material inside the loop will
1839 be evaluated repeatedly, with `variable` being set to each
1840 value of the array in turn, and concatenated.
1841- If `variable` is a map, the material inside will be set to
1843- If the value of the associated variable is not an array or
1844 a map, a single iteration will be performed on its value.
1849$for(foo)$$foo$$sep$, $endfor$
1852 - $foo.last$, $foo.first$
1856 - ${ foo.bar.last }, ${ foo.bar.first }
1860$it.name$: $it.office$
1864You may optionally specify a separator between consecutive
1865values using `sep` (enclosed in matched delimiters). The
1866material between `sep` and the `endfor` is the separator.
1869${ for(foo) }${ foo }${ sep }, ${ endfor }
1872Instead of using `variable` inside the loop, the special
1873anaphoric keyword `it` may be used.
1877 - ${ it.last }, ${ it.first }
1883Partials (subtemplates stored in different files) may be
1884included by using the name of the partial, followed
1885by `()`, for example:
1891Partials will be sought in the directory containing
1892the main template. The file name will be assumed to
1893have the same extension as the main template if it
1894lacks an extension. When calling the partial, the
1895full name including file extension can also be used:
1901(If a partial is not found in the directory of the
1902template and the template path is given as a relative
1903path, it will also be sought in the `templates`
1904subdirectory of the user data directory.)
1906Partials may optionally be applied to variables using
1912${ articles:bibentry() }
1915If `articles` is an array, this will iterate over its
1916values, applying the partial `bibentry()` to each one. So the
1917second example above is equivalent to
1925Note that the anaphoric keyword `it` must be used when
1926iterating over partials. In the above examples,
1927the `bibentry` partial should contain `it.title`
1928(and so on) instead of `articles.title`.
1930Final newlines are omitted from included partials.
1932Partials may include other partials.
1934A separator between values of an array may be specified
1935in square brackets, immediately after the variable name
1941${articles:bibentry()[; ]$
1944The separator in this case is literal and (unlike with `sep`
1945in an explicit `for` loop) cannot contain interpolated
1946variables or other template directives.
1950To ensure that content is "nested," that is, subsequent lines
1951indented, use the `^` directive:
1954$item.number$ $^$$item.description$ ($item.price$)
1957In this example, if `item.description` has multiple lines,
1958they will all be indented to line up with the first line:
196100123 A fine bottle of 18-year old
1962 Oban whiskey. ($148)
1965To nest multiple lines to the same level, align them
1966with the `^` directive in the template. For example:
1969$item.number$ $^$$item.description$ ($item.price$)
1970 (Available til $item.sellby$.)
197600123 A fine bottle of 18-year old
1977 Oban whiskey. ($148)
1978 (Available til March 30, 2020.)
1981If a variable occurs by itself on a line, preceded by whitespace
1982and not followed by further text or directives on the same line,
1983and the variable's value contains multiple lines, it will be
1984nested automatically.
1988Normally, spaces in the template itself (as opposed to values of
1989the interpolated variables) are not breakable, but they can be
1990made breakable in part of the template by using the `~` keyword
1991(ended with another `~`).
1994$~$This long line may break if the document is rendered
1995with a short line length.$~$
2000A pipe transforms the value of a variable or partial. Pipes are
2001specified using a slash (`/`) between the variable name (or partial)
2002and the pipe name. Example:
2009$for(metadata/pairs)$
2010- $it.key$: $it.value$
2013$employee:name()/uppercase$
2016Pipes may be chained:
2019$for(employees/pairs)$
2020$it.key/alpha/uppercase$. $it.name$
2024Some pipes take parameters:
2027|----------------------|------------|
2029$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2031|----------------------|------------|
2034Currently the following pipes are predefined:
2036- `pairs`: Converts a map or array to an array of maps,
2037 each with `key` and `value` fields. If the original
2038 value was an array, the `key` will be the array index,
2041- `uppercase`: Converts text to uppercase.
2043- `lowercase`: Converts text to lowercase.
2045- `length`: Returns the length of the value: number
2046 of characters for a textual value, number of elements
2049- `reverse`: Reverses a textual value or array,
2050 and has no effect on other values.
2052- `first`: Returns the first value of an array, if
2053 applied to a non-empty array; otherwise returns
2056- `last`: Returns the last value of an array, if
2057 applied to a non-empty array; otherwise returns
2060- `rest`: Returns all but the first value of an array, if
2061 applied to a non-empty array; otherwise returns
2064- `allbutlast`: Returns all but the last value of an array, if
2065 applied to a non-empty array; otherwise returns
2068- `chomp`: Removes trailing newlines (and breakable space).
2070- `nowrap`: Disables line wrapping on breakable spaces.
2072- `alpha`: Converts textual values that can be
2073 read as an integer into lowercase alphabetic
2074 characters `a..z` (mod 26). This can be used to get lettered
2075 enumeration from array indices. To get uppercase
2076 letters, chain with `uppercase`.
2078- `roman`: Converts textual values that can be
2079 read as an integer into lowercase roman numerials.
2080 This can be used to get lettered enumeration from array indices.
2081 To get uppercase roman, chain with `uppercase`.
2083- `left n "leftborder" "rightborder"`: Renders a textual value
2084 in a block of width `n`, aligned to the left, with an optional
2085 left and right border. Has no effect on other values. This
2086 can be used to align material in tables. Widths are positive
2087 integers indicating the number of characters. Borders
2088 are strings inside double quotes; literal `"` and `\` characters
2089 must be backslash-escaped.
2091- `right n "leftborder" "rightborder"`: Renders a textual value
2092 in a block of width `n`, aligned to the right, and has no
2093 effect on other values.
2095- `center n "leftborder" "rightborder"`: Renders a textual
2096 value in a block of width `n`, aligned to the center, and has
2097 no effect on other values.
2102### Metadata variables
2104`title`, `author`, `date`
2105: allow identification of basic aspects of the document. Included
2106 in PDF metadata through LaTeX and ConTeXt. These can be set
2107 through a [pandoc title block][Extension: `pandoc_title_block`],
2108 which allows for multiple authors, or through a
2109 [YAML metadata block][Extension: `yaml_metadata_block`]:
2117 Note that if you just want to set PDF or HTML metadata, without
2118 including a title block in the document itself, you can
2119 set the `title-meta`, `author-meta`, and `date-meta`
2120 variables. (By default these are set automatically, based
2121 on `title`, `author`, and `date`.) The page title in HTML
2122 is set by `pagetitle`, which is equal to `title` by default.
2125: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2129: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2133: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2134 and AsciiDoc metadata; repeat as for `author`, above
2137: document subject, included in ODT, PDF, docx and pptx metadata
2140: document description, included in ODT, docx and pptx metadata. Some
2141 applications show this as `Comments` metadata.
2144: document category, included in docx and pptx metadata
2147any root-level string metadata, not included in ODT, docx
2148or pptx metadata is added as a *custom property*.
2149The following [YAML] metadata block for instance:
2152 title: 'This is the title'
2153 subtitle: "This is the subtitle"
2161 It consists of two paragraphs
2164will include `title`, `author` and `description` as standard document
2165properties and `subtitle` as a custom property when converting to docx,
2168### Language variables
2171: identifies the main language of the document using IETF language
2172 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2173 The [Language subtag lookup] tool can look up or verify these tags.
2174 This affects most formats, and controls hyphenation in PDF output
2175 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2177 Use native pandoc [Divs and Spans] with the `lang` attribute to
2178 switch the language:
2184 Text in the main document language (British English).
2187 > Cette citation est écrite en français canadien.
2190 More text in English. ['Zitat auf Deutsch.']{lang=de}
2193: the base script direction, either `rtl` (right-to-left)
2194 or `ltr` (left-to-right).
2196 For bidirectional documents, native pandoc `span`s and
2197 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2198 be used to override the base direction in some output
2199 formats. This may not always be necessary if the final
2200 renderer (e.g. the browser, when generating HTML) supports
2201 the [Unicode Bidirectional Algorithm].
2203 When using LaTeX for bidirectional documents, only the
2204 `xelatex` engine is fully supported (use
2205 `--pdf-engine=xelatex`).
2207[BCP 47]: https://tools.ietf.org/html/bcp47
2208[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2209[Language subtag lookup]: https://r12a.github.io/app-subtags/
2211### Variables for HTML
2214: Enables inclusion of most of the [CSS] in the `styles.html`
2215 [partial](#partials) (have a look with
2216 `pandoc --print-default-data-file=templates/styles.html`).
2217 Unless you use [`--css`](#option--css), this variable
2218 is set to `true` by default. You can disable it with
2219 e.g. `pandoc -M document-css=false`.
2222: sets the CSS `font-family` property on the `html` element.
2225: sets the base CSS `font-size`, which you'd usually set
2226 to e.g. `20px`, but it also accepts `pt`
2227 (12pt = 16px in most browsers).
2230: sets the CSS `color` property on the `html` element.
2233: sets the CSS `color` property on all links.
2236: sets the CSS `font-family` property on `code` elements.
2238`monobackgroundcolor`
2239: sets the CSS `background-color` property on `code` elements
2240 and adds extra padding.
2243: sets the CSS `line-height` property on the `html` element,
2244 which is preferred to be unitless.
2247: sets the CSS `background-color` property on the `html` element.
2249`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2250: sets the corresponding CSS `padding` properties on the `body` element.
2252To override or extend some [CSS] for just one document, include for example:
2261 background-color: #f0f0f0;
2264 padding: 0.5em 2em 0.5em 0.5em;
2267 border-bottom: none;
2272[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2274### Variables for HTML math
2277: when using [KaTeX](#option--katex), you can render display
2278math equations flush left using [YAML metadata](#layout) or with
2279`-M classoption=fleqn`.
2281### Variables for HTML slides
2283These affect HTML output when [producing slide shows with pandoc].
2285All [reveal.js configuration options] are available as variables.
2286To turn off boolean flags that default to true in reveal.js, use `0`.
2289: base URL for reveal.js documents (defaults to
2290 `https://unpkg.com/reveal.js@^4/`)
2293: base URL for S5 documents (defaults to `s5/default`)
2296: base URL for Slidy documents (defaults to
2297 `https://www.w3.org/Talks/Tools/Slidy2`)
2300: base URL for Slideous documents (defaults to `slideous`)
2302`title-slide-attributes`
2303: additional attributes for the title slide of reveal.js slide shows.
2304 See [background in reveal.js and beamer] for an example.
2306[reveal.js configuration options]: https://revealjs.com/config/
2308### Variables for Beamer slides
2310These variables change the appearance of PDF slides using [`beamer`].
2313: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2314 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2318: produce an article from Beamer slides
2321: add extra beamer option with `\setbeameroption{}`
2324: author affiliations: can be a list when there are multiple authors
2327: logo image for slides
2330: controls navigation symbols (default is `empty` for no navigation
2331 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2334: enables "title pages" for new sections (default is true)
2336`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2340: options for LaTeX beamer themes (a list).
2343: image for title slide
2345### Variables for PowerPoint
2347These variables control the visual aspects of a slide show that
2348are not easily controlled via templates.
2351: font to use for code.
2353### Variables for LaTeX
2355Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2360: make `\paragraph` and `\subparagraph` (fourth- and
2361 fifth-level headings, or fifth- and sixth-level with book
2362 classes) free-standing rather than run-in; requires further
2363 formatting to distinguish from `\subsubsection` (third- or
2364 fourth-level headings). Instead of using this option,
2365 [KOMA-Script] can adjust headings more extensively:
2368 documentclass: scrartcl
2370 \RedeclareSectionCommand[
2371 beforeskip=-10pt plus -2pt minus -1pt,
2372 afterskip=1sp plus -1sp minus 1sp,
2373 font=\normalfont\itshape]{paragraph}
2374 \RedeclareSectionCommand[
2375 beforeskip=-10pt plus -2pt minus -1pt,
2376 afterskip=1sp plus -1sp minus 1sp,
2377 font=\normalfont\scshape,
2378 indent=0pt]{subparagraph}
2382: option for document class, e.g. `oneside`; repeat for multiple options:
2391: document class: usually one of the standard classes,
2392 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2393 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2394 default to smaller margins; or [`memoir`]
2397: option for [`geometry`] package, e.g. `margin=1in`;
2398 repeat for multiple options:
2408: option for [`hyperref`] package, e.g. `linktoc=all`;
2409 repeat for multiple options:
2415 - pdfpagemode=FullScreen
2419: if true, pandoc will use document class settings for
2420 indentation (the default LaTeX template otherwise removes
2421 indentation and adds space between paragraphs)
2424: adjusts line spacing using the [`setspace`]
2425 package, e.g. `1.25`, `1.5`
2427`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2428: sets margins if `geometry` is not used (otherwise `geometry`
2432: control `\pagestyle{}`: the default article class
2433 supports `plain` (default), `empty` (no running heads or page numbers),
2434 and `headings` (section titles in running heads)
2437: paper size, e.g. `letter`, `a4`
2440: numbering depth for sections (with `--number-sections` option
2441 or `numbersections` variable)
2446: allows font encoding to be specified through `fontenc` package (with
2447 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2450: font package for use with `pdflatex`:
2451 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2452 The default is [Latin Modern][`lm`].
2455: options for package used as `fontfamily`; repeat for multiple options.
2456 For example, to use the Libertine font with proportional lowercase
2457 (old-style) figures through the [`libertinus`] package:
2460 fontfamily: libertinus
2467: font size for body text. The standard classes allow 10pt, 11pt, and
2468 12pt. To use another size, set `documentclass` to one of
2469 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2471`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2472: font families for use with `xelatex` or
2473 `lualatex`: take the name of any system font, using the
2474 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2476`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2477: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2478 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2479 choices available through [`fontspec`]; repeat for multiple
2480 options. For example, to use the [TeX Gyre] version of
2481 Palatino with lowercase figures:
2484 mainfont: TeX Gyre Pagella
2487 - Numbers=Proportional
2491: options to pass to the microtype package
2496: add color to link text; automatically enabled if any of
2497 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2499`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2500: color for internal links, external links, citation links, linked
2501 URLs, and links in table of contents, respectively: uses options
2502 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2506: causes links to be printed as footnotes
2511: include list of figures, list of tables
2514: contents of acknowledgments footnote after document title
2517: include table of contents (can also be set using
2518 `--toc/--table-of-contents`)
2521: level of section to include in table of contents
2523#### BibLaTeX Bibliographies
2525These variables function when using BibLaTeX for [citation rendering].
2528: list of options for biblatex
2531: bibliography style, when used with `--natbib` and `--biblatex`.
2534: bibliography title, when used with `--natbib` and `--biblatex`.
2537: bibliography to use for resolving references
2540: list of options for natbib
2542[KOMA-Script]: https://ctan.org/pkg/koma-script
2543[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2544[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2545[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2546[`article`]: https://ctan.org/pkg/article
2547[`book`]: https://ctan.org/pkg/book
2548[`libertinus`]: https://ctan.org/pkg/libertinus
2549[`memoir`]: https://ctan.org/pkg/memoir
2550[`report`]: https://ctan.org/pkg/report
2552### Variables for ConTeXt
2554Pandoc uses these variables when [creating a PDF] with ConTeXt.
2557: font size for body text (e.g. `10pt`, `12pt`)
2559`headertext`, `footertext`
2560: text to be placed in running header or footer (see [ConTeXt Headers and
2561 Footers]); repeat up to four times for different placement
2564: controls indentation of paragraphs, e.g. `yes,small,next` (see
2565 [ConTeXt Indentation]); repeat for multiple options
2568: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2569 repeat for multiple options
2572: options for page margins and text arrangement (see [ConTeXt Layout]);
2573 repeat for multiple options
2575`linkcolor`, `contrastcolor`
2576: color for links outside and inside a page, e.g. `red`, `blue` (see
2580: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2581 `type`, `cap`, `small`
2584: include list of figures, list of tables
2586`mainfont`, `sansfont`, `monofont`, `mathfont`
2587: font families: take the name of any system font (see
2588 [ConTeXt Font Switching])
2590`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2591: sets margins, if `layout` is not used (otherwise `layout`
2595: page number style and location (using [`setuppagenumbering`]);
2596 repeat for multiple options
2599: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2600 repeat for multiple options
2603: adds to the preamble the setup necessary to generate PDF/A
2604 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2605 specified (i.e. the value is set to True, by e.g.
2606 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2607 `1b:2005` will be used as default, for reasons of backwards
2608 compatibility. Using `--variable=pdfa` without specified value
2609 is not supported. To successfully generate PDF/A the required
2610 ICC color profiles have to be available and the content and all
2611 included files (such as images) have to be standard conforming.
2612 The ICC profiles and output intent may be specified using the
2613 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2614 PDFA] for more details.
2617: when used in conjunction with `pdfa`, specifies the ICC profile to use
2618 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2619 used as default. May be repeated to include multiple profiles. Note that
2620 the profiles have to be available on the system. They can be obtained
2621 from [ConTeXt ICC Profiles].
2624: when used in conjunction with `pdfa`, specifies the output intent for
2625 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2626 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2629: include table of contents (can also be set using
2630 `--toc/--table-of-contents`)
2633: spacing between paragraphs, e.g. `none`, `small` (using
2634 [`setupwhitespace`])
2637: include all source documents as file attachments in the PDF file
2639[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2640[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2641[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2642[ConTeXt Color]: https://wiki.contextgarden.net/Color
2643[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2644[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2645[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2646[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2647[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2648[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2649[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2651### Variables for `wkhtmltopdf`
2653Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2654The `--css` option also affects the output.
2656`footer-html`, `header-html`
2657: add information to the header and footer
2659`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2660: set the page margins
2663: sets the PDF paper size
2665### Variables for man pages
2668: adjusts text to left (`l`), right (`r`), center (`c`),
2669 or both (`b`) margins
2672: footer in man pages
2675: header in man pages
2678: if `true` (the default), hyphenation will be used
2681: section number in man pages
2686: font family (e.g. `T` or `P`)
2689: paragraph indent (e.g. `2m`)
2692: line height (e.g. `12p`)
2695: point size (e.g. `10p`)
2697### Variables set automatically
2699Pandoc sets these variables automatically in response to [options] or
2700document contents; users can also modify them. These vary depending
2701on the output format, and include the following:
2707: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2708 included in all HTML based formats (dzslides, epub,
2709 html, html4, html5, revealjs, s5, slideous, slidy).
2710 The recognized formats for `date` are: `mm/dd/yyyy`,
2711 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2712 (e.g. either `02 Apr 2018` or `02 April 2018`),
2713 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2714 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2717: contents specified by `-H/--include-in-header` (may have multiple
2721: contents specified by `-B/--include-before-body` (may have
2725: contents specified by `-A/--include-after-body` (may have
2729: JSON representation of all of the document's metadata. Field
2730 values are transformed to the selected output format.
2733: non-null value if `-N/--number-sections` was specified
2735`sourcefile`, `outputfile`
2736: source and destination filenames, as given on the command line.
2737 `sourcefile` can also be a list if input comes from multiple files,
2738 or empty if input is from stdin. You can use the following snippet in
2739 your template to distinguish them:
2749 Similarly, `outputfile` can be `-` if output goes to the terminal.
2751 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2754: working directory from which pandoc is run.
2757: non-null value if `--toc/--table-of-contents` was specified
2760: title of table of contents (works only with EPUB,
2761 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2763[pandoc-templates]: https://github.com/jgm/pandoc-templates
2767The behavior of some of the readers and writers can be adjusted by
2768enabling or disabling various extensions.
2770An extension can be enabled by adding `+EXTENSION`
2771to the format name and disabled by adding `-EXTENSION`. For example,
2772`--from markdown_strict+footnotes` is strict Markdown with footnotes
2773enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2774Markdown without footnotes or pipe tables.
2776The markdown reader and writer make by far the most use of extensions.
2777Extensions only used by them are therefore covered in the
2778section [Pandoc's Markdown] below (See [Markdown variants] for
2779`commonmark` and `gfm`.) In the following, extensions that also work
2780for other formats are covered.
2782Note that markdown extensions added to the `ipynb` format
2783affect Markdown cells in Jupyter notebooks (as do command-line
2784options like `--atx-headers`).
2788#### Extension: `smart` ####
2790Interpret straight quotes as curly quotes, `---` as em-dashes,
2791`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2792inserted after certain abbreviations, such as "Mr."
2794This extension can be enabled/disabled for the following formats:
2797: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2800: `markdown`, `latex`, `context`, `rst`
2802enabled by default in
2803: `markdown`, `latex`, `context` (both input and output)
2805Note: If you are *writing* Markdown, then the `smart` extension
2806has the reverse effect: what would have been curly quotes comes
2809In LaTeX, `smart` means to use the standard TeX ligatures
2810for quotation marks (` `` ` and ` '' ` for double quotes,
2811`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2812en-dash and `---` for em-dash). If `smart` is disabled,
2813then in reading LaTeX pandoc will parse these characters
2814literally. In writing LaTeX, enabling `smart` tells pandoc
2815to use the ligatures when possible; if `smart` is disabled
2816pandoc will use unicode quotation mark and dash characters.
2818## Headings and sections
2820#### Extension: `auto_identifiers` ####
2822A heading without an explicitly specified identifier will be
2823automatically assigned a unique identifier based on the heading text.
2825This extension can be enabled/disabled for the following formats:
2828: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2833enabled by default in
2836The default algorithm used to derive the identifier from the
2839 - Remove all formatting, links, etc.
2840 - Remove all footnotes.
2841 - Remove all non-alphanumeric characters,
2842 except underscores, hyphens, and periods.
2843 - Replace all spaces and newlines with hyphens.
2844 - Convert all alphabetic characters to lowercase.
2845 - Remove everything up to the first letter (identifiers may
2846 not begin with a number or punctuation mark).
2847 - If nothing is left after this, use the identifier `section`.
2852 ------------------------------- ----------------------------
2853 `Heading identifiers in HTML` `heading-identifiers-in-html`
2854 `Maître d'hôtel` `maître-dhôtel`
2855 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2856 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2857 `3. Applications` `applications`
2860These rules should, in most cases, allow one to determine the identifier
2861from the heading text. The exception is when several headings have the
2862same text; in this case, the first will get an identifier as described
2863above; the second will get the same identifier with `-1` appended; the
2864third with `-2`; and so on.
2866(However, a different algorithm is used if
2867`gfm_auto_identifiers` is enabled; see below.)
2869These identifiers are used to provide link targets in the table of
2870contents generated by the `--toc|--table-of-contents` option. They
2871also make it easy to provide links from one section of a document to
2872another. A link to this section, for example, might look like this:
2875 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2877Note, however, that this method of providing links to sections works
2878only in HTML, LaTeX, and ConTeXt formats.
2880If the `--section-divs` option is specified, then each section will
2881be wrapped in a `section` (or a `div`, if `html4` was specified),
2882and the identifier will be attached to the enclosing `<section>`
2883(or `<div>`) tag rather than the heading itself. This allows entire
2884sections to be manipulated using JavaScript or treated differently in
2887#### Extension: `ascii_identifiers` ####
2889Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2890Accents are stripped off of accented Latin letters, and non-Latin
2893#### Extension: `gfm_auto_identifiers` ####
2895Changes the algorithm used by `auto_identifiers` to conform to
2896GitHub's method. Spaces are converted to dashes (`-`),
2897uppercase characters to lowercase characters, and punctuation
2898characters other than `-` and `_` are removed.
2899Emojis are replaced by their names.
2903The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2904[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2905[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2906are described in the section about Pandoc's Markdown.
2908However, they can also be used with HTML input. This is handy for
2909reading web pages formatted using MathJax, for example.
2913The following extensions are described in more detail in
2914their respective sections of [Pandoc's Markdown]:
2916- [`raw_html`](#extension-raw_html) allows HTML elements which
2917 are not representable in pandoc's AST to be parsed as raw HTML.
2918 By default, this is disabled for HTML input.
2920- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2921 to be included in a document. This extension can be enabled/disabled
2922 for the following formats (in addition to `markdown`):
2925 : `latex`, `textile`, `html` (environments, `\ref`, and
2926 `\eqref` only), `ipynb`
2929 : `textile`, `commonmark`
2931 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2932 only raw TeX in markdown cells, but data with mime type
2933 `text/html` in output cells. Since the `ipynb` reader attempts
2934 to preserve the richest possible outputs when several options
2935 are given, you will get best results if you disable `raw_html`
2936 and `raw_tex` when converting to formats like `docx` which don't
2937 allow raw `html` or `tex`.
2939- [`native_divs`](#extension-native_divs) causes HTML `div`
2940 elements to be parsed as native pandoc Div blocks.
2941 If you want them to be parsed as raw HTML, use
2942 `-f html-native_divs+raw_html`.
2944- [`native_spans`](#extension-native_spans) causes HTML `span`
2945 elements to be parsed as native pandoc Span inlines.
2946 If you want them to be parsed as raw HTML, use
2947 `-f html-native_spans+raw_html`. If you want to drop all
2948 `div`s and `span`s when converting HTML to Markdown, you
2949 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2951## Literate Haskell support
2953#### Extension: `literate_haskell` ####
2955Treat the document as literate Haskell source.
2957This extension can be enabled/disabled for the following formats:
2960: `markdown`, `rst`, `latex`
2963: `markdown`, `rst`, `latex`, `html`
2965If you append `+lhs` (or `+literate_haskell`) to one of the formats
2966above, pandoc will treat the document as literate Haskell source.
2969 - In Markdown input, "bird track" sections will be parsed as Haskell
2970 code rather than block quotations. Text between `\begin{code}`
2971 and `\end{code}` will also be treated as Haskell code. For
2972 ATX-style headings the character '=' will be used instead of '#'.
2974 - In Markdown output, code blocks with classes `haskell` and `literate`
2975 will be rendered using bird tracks, and block quotations will be
2976 indented one space, so they will not be treated as Haskell code.
2977 In addition, headings will be rendered setext-style (with underlines)
2978 rather than ATX-style (with '#' characters). (This is because ghc
2979 treats '#' characters in column 1 as introducing line numbers.)
2981 - In restructured text input, "bird track" sections will be parsed
2984 - In restructured text output, code blocks with class `haskell` will
2985 be rendered using bird tracks.
2987 - In LaTeX input, text in `code` environments will be parsed as
2990 - In LaTeX output, code blocks with class `haskell` will be rendered
2991 inside `code` environments.
2993 - In HTML output, code blocks with class `haskell` will be rendered
2994 with class `literatehaskell` and bird tracks.
2998 pandoc -f markdown+lhs -t html
3000reads literate Haskell source formatted with Markdown conventions and writes
3001ordinary HTML (without bird tracks).
3003 pandoc -f markdown+lhs -t html+lhs
3005writes HTML with the Haskell code in bird tracks, so it can be copied
3006and pasted as literate Haskell source.
3008Note that GHC expects the bird tracks in the first column, so indented
3009literate code blocks (e.g. inside an itemized environment) will not be
3010picked up by the Haskell compiler.
3014#### Extension: `empty_paragraphs` ####
3016Allows empty paragraphs. By default empty paragraphs are
3019This extension can be enabled/disabled for the following formats:
3025: `docx`, `odt`, `opendocument`, `html`
3027#### Extension: `native_numbering` ####
3029Enables native numbering of figures and tables. Enumeration
3032This extension can be enabled/disabled for the following formats:
3035: `odt`, `opendocument`
3037#### Extension: `xrefs_name` ####
3039Links to headings, figures and tables inside the document are
3040substituted with cross-references that will use the name or caption
3041of the referenced item. The original link text is replaced once
3042the generated document is refreshed. This extension can be combined
3043with `xrefs_number` in which case numbers will appear before the
3046Text in cross-references is only made consistent with the referenced
3047item once the document has been refreshed.
3049This extension can be enabled/disabled for the following formats:
3052: `odt`, `opendocument`
3054#### Extension: `xrefs_number` ####
3056Links to headings, figures and tables inside the document are
3057substituted with cross-references that will use the number
3058of the referenced item. The original link text is discarded.
3059This extension can be combined with `xrefs_name` in which case
3060the name or caption numbers will appear after the number.
3062For the `xrefs_number` to be useful heading numbers must be enabled
3063in the generated document, also table and figure captions must be enabled
3064using for example the `native_numbering` extension.
3066Numbers in cross-references are only visible in the final document once
3067it has been refreshed.
3069This extension can be enabled/disabled for the following formats:
3072: `odt`, `opendocument`
3074#### Extension: `styles` #### {#ext-styles}
3076When converting from docx, read all docx styles as divs (for
3077paragraph styles) and spans (for character styles) regardless
3078of whether pandoc understands the meaning of these styles.
3079This can be used with [docx custom styles](#custom-styles).
3085#### Extension: `amuse` ####
3087In the `muse` input format, this enables Text::Amuse
3088extensions to Emacs Muse markup.
3090#### Extension: `raw_markdown` ####
3092In the `ipynb` input format, this causes Markdown cells
3093to be included as raw Markdown blocks (allowing lossless
3094round-tripping) rather than being parsed. Use this only
3095when you are targeting `ipynb` or a markdown-based
3098#### Extension: `citations` {#org-citations}
3100Some aspects of [Pandoc's Markdown citation syntax](#citations)
3101are also accepted in `org` input.
3103#### Extension: `element_citations` ####
3105In the `jats` output formats, this causes reference items to
3106be replaced with `<element-citation>` elements. These
3107elements are not influenced by CSL styles, but all information
3108on the item is included in tags.
3110#### Extension: `ntb` ####
3112In the `context` output format this enables the use of [Natural Tables
3113(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3114[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3115Natural tables allow more fine-grained global customization but come
3116at a performance penalty compared to extreme tables.
3121Pandoc understands an extended and slightly revised version of
3122John Gruber's [Markdown] syntax. This document explains the syntax,
3123noting differences from standard Markdown. Except where noted, these
3124differences can be suppressed by using the `markdown_strict` format instead
3125of `markdown`. Extensions can be enabled or disabled to specify the
3126behavior more granularly. They are described in the following. See also
3127[Extensions] above, for extensions that work also on other formats.
3131Markdown is designed to be easy to write, and, even more importantly,
3134> A Markdown-formatted document should be publishable as-is, as plain
3135> text, without looking like it's been marked up with tags or formatting
3137> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3139This principle has guided pandoc's decisions in finding syntax for
3140tables, footnotes, and other extensions.
3142There is, however, one respect in which pandoc's aims are different
3143from the original aims of Markdown. Whereas Markdown was originally
3144designed with HTML generation in mind, pandoc is designed for multiple
3145output formats. Thus, while pandoc allows the embedding of raw HTML,
3146it discourages it, and provides other, non-HTMLish ways of representing
3147important document elements like definition lists, tables, mathematics, and
3152A paragraph is one or more lines of text followed by one or more blank lines.
3153Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3154If you need a hard line break, put two or more spaces at the end of a line.
3156#### Extension: `escaped_line_breaks` ####
3158A backslash followed by a newline is also a hard line break.
3159Note: in multiline and grid table cells, this is the only way
3160to create a hard line break, since trailing spaces in the cells
3165There are two kinds of headings: Setext and ATX.
3167### Setext-style headings ###
3169A setext-style heading is a line of text "underlined" with a row of `=` signs
3170(for a level-one heading) or `-` signs (for a level-two heading):
3178The heading text can contain inline formatting, such as emphasis (see
3179[Inline formatting], below).
3182### ATX-style headings ###
3184An ATX-style heading consists of one to six `#` signs and a line of
3185text, optionally followed by any number of `#` signs. The number of
3186`#` signs at the beginning of the line is the heading level:
3188 ## A level-two heading
3190 ### A level-three heading ###
3192As with setext-style headings, the heading text can contain formatting:
3194 # A level-one heading with a [link](/url) and *emphasis*
3196#### Extension: `blank_before_header` ####
3198Standard Markdown syntax does not require a blank line before a heading.
3199Pandoc does require this (except, of course, at the beginning of the
3200document). The reason for the requirement is that it is all too easy for a
3201`#` to end up at the beginning of a line by accident (perhaps through line
3202wrapping). Consider, for example:
3204 I like several of their flavors of ice cream:
3205 #22, for example, and #5.
3207#### Extension: `space_in_atx_header` ####
3209Many Markdown implementations do not require a space between the
3210opening `#`s of an ATX heading and the heading text, so that
3211`#5 bolt` and `#hashtag` count as headings. With this extension,
3212pandoc does require the space.
3214### Heading identifiers ###
3216See also the [`auto_identifiers`
3217extension](#extension-auto_identifiers) above.
3219#### Extension: `header_attributes` ####
3221Headings can be assigned attributes using this syntax at the end
3222of the line containing the heading text:
3224 {#identifier .class .class key=value key=value}
3226Thus, for example, the following headings will all be assigned the identifier
3231 ## My heading ## {#foo}
3233 My other heading {#foo}
3236(This syntax is compatible with [PHP Markdown Extra].)
3238Note that although this syntax allows assignment of classes and key/value
3239attributes, writers generally don't use all of this information. Identifiers,
3240classes, and key/value attributes are used in HTML and HTML-based formats such
3241as EPUB and slidy. Identifiers are used for labels and link anchors in the
3242LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3244Headings with the class `unnumbered` will not be numbered, even if
3245`--number-sections` is specified. A single hyphen (`-`) in an attribute
3246context is equivalent to `.unnumbered`, and preferable in non-English
3253 # My heading {.unnumbered}
3255If the `unlisted` class is present in addition to `unnumbered`,
3256the heading will not be included in a table of contents.
3257(Currently this feature is only implemented for certain
3258formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3260#### Extension: `implicit_header_references` ####
3262Pandoc behaves as if reference links have been defined for each heading.
3263So, to link to a heading
3265 # Heading identifiers in HTML
3269 [Heading identifiers in HTML]
3273 [Heading identifiers in HTML][]
3277 [the section on heading identifiers][heading identifiers in
3280instead of giving the identifier explicitly:
3282 [Heading identifiers in HTML](#heading-identifiers-in-html)
3284If there are multiple headings with identical text, the corresponding
3285reference will link to the first one only, and you will need to use explicit
3286links to link to the others, as described above.
3288Like regular reference links, these references are case-insensitive.
3290Explicit link reference definitions always take priority over
3291implicit heading references. So, in the following example, the
3292link will point to `bar`, not to `#foo`:
3302Markdown uses email conventions for quoting blocks of text.
3303A block quotation is one or more paragraphs or other block elements
3304(such as lists or headings), with each line preceded by a `>` character
3305and an optional space. (The `>` need not start at the left margin, but
3306it should not be indented more than three spaces.)
3308 > This is a block quote. This
3309 > paragraph has two lines.
3311 > 1. This is a list inside a block quote.
3314A "lazy" form, which requires the `>` character only on the first
3315line of each block, is also allowed:
3317 > This is a block quote. This
3318 paragraph has two lines.
3320 > 1. This is a list inside a block quote.
3323Among the block elements that can be contained in a block quote are
3324other block quotes. That is, block quotes can be nested:
3326 > This is a block quote.
3328 > > A block quote within a block quote.
3330If the `>` character is followed by an optional space, that space
3331will be considered part of the block quote marker and not part of
3332the indentation of the contents. Thus, to put an indented code
3333block in a block quote, you need five spaces after the `>`:
3337#### Extension: `blank_before_blockquote` ####
3339Standard Markdown syntax does not require a blank line before a
3340block quote. Pandoc does require this (except, of course, at
3341the beginning of the document). The reason for the requirement
3342is that it is all too easy for a `>` to end up at the beginning
3343of a line by accident (perhaps through line wrapping). So,
3344unless the `markdown_strict` format is used, the following does
3345not produce a nested block quote in pandoc:
3347 > This is a block quote.
3351## Verbatim (code) blocks
3353### Indented code blocks ###
3355A block of text indented four spaces (or one tab) is treated as verbatim
3356text: that is, special characters do not trigger special formatting,
3357and all spaces and line breaks are preserved. For example,
3360 moveShip(5 * gravity, DOWN);
3363The initial (four space or one tab) indentation is not considered part
3364of the verbatim text, and is removed in the output.
3366Note: blank lines in the verbatim text need not begin with four spaces.
3369### Fenced code blocks ###
3371#### Extension: `fenced_code_blocks` ####
3373In addition to standard indented code blocks, pandoc supports
3374*fenced* code blocks. These begin with a row of three or more
3375tildes (`~`) and end with a row of tildes that must be at least as long as
3376the starting row. Everything between these lines is treated as code. No
3377indentation is necessary:
3381 moveShip(5 * gravity, DOWN);
3385Like regular code blocks, fenced code blocks must be separated
3386from surrounding text by blank lines.
3388If the code itself contains a row of tildes or backticks, just use a longer
3389row of tildes or backticks at the start and end:
3393 code including tildes
3397#### Extension: `backtick_code_blocks` ####
3399Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3402#### Extension: `fenced_code_attributes` ####
3404Optionally, you may attach attributes to fenced or backtick code block using
3407 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3409 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3410 qsort (filter (>= x) xs)
3411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3413Here `mycode` is an identifier, `haskell` and `numberLines` are
3414classes, and `startFrom` is an attribute with value `100`. Some
3415output formats can use this information to do syntax
3416highlighting. Currently, the only output formats that uses this
3417information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3418highlighting is supported for your output format and language,
3419then the code block above will appear highlighted, with numbered
3420lines. (To see which languages are supported, type `pandoc
3421--list-highlight-languages`.) Otherwise, the code block above
3422will appear as follows:
3424 <pre id="mycode" class="haskell numberLines" startFrom="100">
3430The `numberLines` (or `number-lines`) class will cause the lines
3431of the code block to be numbered, starting with `1` or the value
3432of the `startFrom` attribute. The `lineAnchors` (or
3433`line-anchors`) class will cause the lines to be clickable
3434anchors in HTML output.
3436A shortcut form can also be used for specifying the language of
3443This is equivalent to:
3449If the `fenced_code_attributes` extension is disabled, but
3450input contains class attribute(s) for the code block, the first
3451class attribute will be printed after the opening fence as a bare
3454To prevent all highlighting, use the `--no-highlight` flag.
3455To set the highlighting style, use `--highlight-style`.
3456For more information on highlighting, see [Syntax highlighting],
3461#### Extension: `line_blocks` ####
3463A line block is a sequence of lines beginning with a vertical bar (`|`)
3464followed by a space. The division into lines will be preserved in
3465the output, as will any leading spaces; otherwise, the lines will
3466be formatted as Markdown. This is useful for verse and addresses:
3468 | The limerick packs laughs anatomical
3469 | In space that is quite economical.
3470 | But the good ones I've seen
3471 | So seldom are clean
3472 | And the clean ones so seldom are comical
3475 | Berkeley, CA 94718
3477The lines can be hard-wrapped if needed, but the continuation
3478line must begin with a space.
3480 | The Right Honorable Most Venerable and Righteous Samuel L.
3483 | Berkeley, CA 94718
3485Inline formatting (such as emphasis) is allowed in the content,
3486but not block-level formatting (such as block quotes or lists).
3488This syntax is borrowed from [reStructuredText].
3494A bullet list is a list of bulleted list items. A bulleted list
3495item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3502This will produce a "compact" list. If you want a "loose" list, in which
3503each item is formatted as a paragraph, put spaces between the items:
3511The bullets need not be flush with the left margin; they may be
3512indented one, two, or three spaces. The bullet must be followed
3515List items look best if subsequent lines are flush with the first
3516line (after the bullet):
3522But Markdown also allows a "lazy" format:
3528### Block content in list items ###
3530A list item may contain multiple paragraphs and other block-level
3531content. However, subsequent paragraphs must be preceded by a blank line
3532and indented to line up with the first non-space content after
3539 * Second paragraph. With a code block, which must be indented
3544Exception: if the list marker is followed by an indented code
3545block, which must begin 5 spaces after the list marker, then
3546subsequent paragraphs must begin two columns after the last
3547character of the list marker:
3551 continuation paragraph
3553List items may include other lists. In this case the preceding blank
3554line is optional. The nested list must be indented to line up with
3555the first non-space character after the list marker of the
3556containing list item.
3568As noted above, Markdown allows you to write list items "lazily," instead of
3569indenting continuation lines. However, if there are multiple paragraphs or
3570other blocks in a list item, the first line of each must be indented.
3572 + A lazy, lazy, list
3575 + Another one; this looks
3578 Second paragraph of second
3581### Ordered lists ###
3583Ordered lists work just like bulleted lists, except that the items
3584begin with enumerators rather than bullets.
3586In standard Markdown, enumerators are decimal numbers followed
3587by a period and a space. The numbers themselves are ignored, so
3588there is no difference between this list:
3600#### Extension: `fancy_lists` ####
3602Unlike standard Markdown, pandoc allows ordered list items to be marked
3603with uppercase and lowercase letters and roman numerals, in addition to
3604Arabic numerals. List markers may be enclosed in parentheses or followed by a
3605single right-parentheses or period. They must be separated from the
3606text that follows by at least one space, and, if the list marker is a
3607capital letter with a period, by at least two spaces.[^2]
3609[^2]: The point of this rule is to ensure that normal paragraphs
3610 starting with people's initials, like
3612 B. Russell was an English philosopher.
3614 do not get treated as list items.
3616 This rule will not prevent
3620 from being interpreted as a list item. In this case, a backslash
3625The `fancy_lists` extension also allows '`#`' to be used as an
3626ordered list marker in place of a numeral:
3631#### Extension: `startnum` ####
3633Pandoc also pays attention to the type of list marker used, and to the
3634starting number, and both of these are preserved where possible in the
3635output format. Thus, the following yields a list with numbers followed
3636by a single parenthesis, starting with 9, and a sublist with lowercase
3646Pandoc will start a new list each time a different type of list
3647marker is used. So, the following will create three lists:
3654If default list markers are desired, use `#.`:
3660#### Extension: `task_lists` ####
3662Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3664 - [ ] an unchecked task list item
3667### Definition lists ###
3669#### Extension: `definition_lists` ####
3671Pandoc supports definition lists, using the syntax of
3672[PHP Markdown Extra] with some extensions.[^3]
3678 Term 2 with *inline markup*
3682 { some code, part of Definition 2 }
3684 Third paragraph of definition 2.
3686Each term must fit on one line, which may optionally be followed by
3687a blank line, and must be followed by one or more definitions.
3688A definition begins with a colon or tilde, which may be indented one
3691A term may have multiple definitions, and each definition may
3692consist of one or more block elements (paragraph, code block,
3693list, etc.), each indented four spaces or one tab stop. The
3694body of the definition (including the first line, aside from the
3695colon or tilde) should be indented four spaces. However, as with
3696other Markdown lists, you can "lazily" omit indentation except
3697at the beginning of a paragraph or other block element:
3702 with lazy continuation.
3704 Second paragraph of the definition.
3706If you leave space before the definition (as in the example above),
3707the text of the definition will be treated as a paragraph. In some
3708output formats, this will mean greater spacing between term/definition
3709pairs. For a more compact definition list, omit the space before the
3719Note that space between items in a definition list is required.
3720(A variant that loosens this requirement, but disallows "lazy"
3721hard wrapping, can be activated with `compact_definition_lists`: see
3722[Non-pandoc extensions], below.)
3724[^3]: I have been influenced by the suggestions of [David
3725 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3727### Numbered example lists ###
3729#### Extension: `example_lists` ####
3731The special list marker `@` can be used for sequentially numbered
3732examples. The first list item with a `@` marker will be numbered '1',
3733the next '2', and so on, throughout the document. The numbered examples
3734need not occur in a single list; each new list using `@` will take up
3735where the last stopped. So, for example:
3737 (@) My first example will be numbered (1).
3738 (@) My second example will be numbered (2).
3740 Explanation of examples.
3742 (@) My third example will be numbered (3).
3744Numbered examples can be labeled and referred to elsewhere in the
3747 (@good) This is a good example.
3749 As (@good) illustrates, ...
3751The label can be any string of alphanumeric characters, underscores,
3754Note: continuation paragraphs in example lists must always
3755be indented four spaces, regardless of the length of the
3756list marker. That is, example lists always behave as if the
3757`four_space_rule` extension is set. This is because example
3758labels tend to be long, and indenting content to the
3759first non-space character after the label would be awkward.
3762### Ending a list ###
3764What if you want to put an indented code block after a list?
3771Trouble! Here pandoc (like other Markdown implementations) will treat
3772`{ my code block }` as the second paragraph of item two, and not as
3775To "cut off" the list after item two, you can insert some non-indented
3776content, like an HTML comment, which won't produce visible output in
3782 <!-- end of list -->
3786You can use the same trick if you want two consecutive lists instead
3801A line containing a row of three or more `*`, `-`, or `_` characters
3802(optionally separated by spaces) produces a horizontal rule:
3811Four kinds of tables may be used. The first three kinds presuppose the use of
3812a fixed-width font, such as Courier. The fourth kind can be used with
3813proportionally spaced fonts, as it does not require lining up columns.
3815#### Extension: `table_captions` ####
3817A caption may optionally be provided with all 4 kinds of tables (as
3818illustrated in the examples below). A caption is a paragraph beginning
3819with the string `Table:` (or just `:`), which will be stripped off.
3820It may appear either before or after the table.
3822#### Extension: `simple_tables` ####
3824Simple tables look like this:
3826 Right Left Center Default
3827 ------- ------ ---------- -------
3832 Table: Demonstration of simple table syntax.
3834The header and table rows must each fit on one line. Column
3835alignments are determined by the position of the header text relative
3836to the dashed line below it:[^4]
3838 - If the dashed line is flush with the header text on the right side
3839 but extends beyond it on the left, the column is right-aligned.
3840 - If the dashed line is flush with the header text on the left side
3841 but extends beyond it on the right, the column is left-aligned.
3842 - If the dashed line extends beyond the header text on both sides,
3843 the column is centered.
3844 - If the dashed line is flush with the header text on both sides,
3845 the default alignment is used (in most cases, this will be left).
3847[^4]: This scheme is due to Michel Fortin, who proposed it on the
3848 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3850The table must end with a blank line, or a line of dashes followed by
3853The column header row may be omitted, provided a dashed line is used
3854to end the table. For example:
3856 ------- ------ ---------- -------
3860 ------- ------ ---------- -------
3862When the header row is omitted, column alignments are determined on the basis
3863of the first line of the table body. So, in the tables above, the columns
3864would be right, left, center, and right aligned, respectively.
3866#### Extension: `multiline_tables` ####
3868Multiline tables allow header and table rows to span multiple lines
3869of text (but cells that span multiple columns or rows of the table are
3870not supported). Here is an example:
3872 -------------------------------------------------------------
3873 Centered Default Right Left
3874 Header Aligned Aligned Aligned
3875 ----------- ------- --------------- -------------------------
3876 First row 12.0 Example of a row that
3877 spans multiple lines.
3879 Second row 5.0 Here's another one. Note
3880 the blank line between
3882 -------------------------------------------------------------
3884 Table: Here's the caption. It, too, may span
3887These work like simple tables, but with the following differences:
3889 - They must begin with a row of dashes, before the header text
3890 (unless the header row is omitted).
3891 - They must end with a row of dashes, then a blank line.
3892 - The rows must be separated by blank lines.
3894In multiline tables, the table parser pays attention to the widths of
3895the columns, and the writers try to reproduce these relative widths in
3896the output. So, if you find that one of the columns is too narrow in the
3897output, try widening it in the Markdown source.
3899The header may be omitted in multiline tables as well as simple tables:
3901 ----------- ------- --------------- -------------------------
3902 First row 12.0 Example of a row that
3903 spans multiple lines.
3905 Second row 5.0 Here's another one. Note
3906 the blank line between
3908 ----------- ------- --------------- -------------------------
3910 : Here's a multiline table without a header.
3912It is possible for a multiline table to have just one row, but the row
3913should be followed by a blank line (and then the row of dashes that ends
3914the table), or the table may be interpreted as a simple table.
3916#### Extension: `grid_tables` ####
3918Grid tables look like this:
3920 : Sample grid table.
3922 +---------------+---------------+--------------------+
3923 | Fruit | Price | Advantages |
3924 +===============+===============+====================+
3925 | Bananas | $1.34 | - built-in wrapper |
3926 | | | - bright color |
3927 +---------------+---------------+--------------------+
3928 | Oranges | $2.10 | - cures scurvy |
3930 +---------------+---------------+--------------------+
3932The row of `=`s separates the header from the table body, and can be
3933omitted for a headerless table. The cells of grid tables may contain
3934arbitrary block elements (multiple paragraphs, code blocks, lists,
3935etc.). Cells that span multiple columns or rows are not
3936supported. Grid tables can be created easily using Emacs' table-mode
3937(`M-x table-insert`).
3939Alignments can be specified as with pipe tables, by putting
3940colons at the boundaries of the separator line after the
3943 +---------------+---------------+--------------------+
3944 | Right | Left | Centered |
3945 +==============:+:==============+:==================:+
3946 | Bananas | $1.34 | built-in wrapper |
3947 +---------------+---------------+--------------------+
3949For headerless tables, the colons go on the top line instead:
3951 +--------------:+:--------------+:------------------:+
3952 | Right | Left | Centered |
3953 +---------------+---------------+--------------------+
3955##### Grid Table Limitations #####
3957Pandoc does not support grid tables with row spans or column spans.
3958This means that neither variable numbers of columns across rows nor
3959variable numbers of rows across columns are supported by Pandoc.
3960All grid tables must have the same number of columns in each row,
3961and the same number of rows in each column. For example, the
3962Docutils [sample grid tables] will not render as expected with
3965[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3968#### Extension: `pipe_tables` ####
3970Pipe tables look like this:
3972 | Right | Left | Default | Center |
3973 |------:|:-----|---------|:------:|
3974 | 12 | 12 | 12 | 12 |
3975 | 123 | 123 | 123 | 123 |
3978 : Demonstration of pipe table syntax.
3980The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3981ending pipe characters are optional, but pipes are required between all
3982columns. The colons indicate column alignment as shown. The header
3983cannot be omitted. To simulate a headerless table, include a header
3986Since the pipes indicate column boundaries, columns need not be vertically
3987aligned, as they are in the above example. So, this is a perfectly
3988legal (though ugly) pipe table:
3996The cells of pipe tables cannot contain block elements like paragraphs
3997and lists, and cannot span multiple lines. If a pipe table contains a
3998row whose Markdown content is wider than the column width (see
3999`--columns`), then the table will take up the full text width and
4000the cell contents will wrap, with the relative cell widths determined
4001by the number of dashes in the line separating the table header from
4002the table body. (For example `---|-` would make the first column 3/4
4003and the second column 1/4 of the full text width.)
4004On the other hand, if no lines are wider than column width, then
4005cell contents will not be wrapped, and the cells will be sized
4008Note: pandoc also recognizes pipe tables of the following
4009form, as can be produced by Emacs' orgtbl-mode:
4016The difference is that `+` is used instead of `|`. Other orgtbl features
4017are not supported. In particular, to get non-default column alignment,
4018you'll need to add colons as above.
4020[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4024#### Extension: `pandoc_title_block` ####
4026If the file begins with a title block
4029 % author(s) (separated by semicolons)
4032it will be parsed as bibliographic information, not regular text. (It
4033will be used, for example, in the title of standalone LaTeX or HTML
4034output.) The block may contain just a title, a title and an author,
4035or all three elements. If you want to include an author but no
4036title, or a title and a date but no author, you need a blank line:
4049The title may occupy multiple lines, but continuation lines must
4050begin with leading space, thus:
4057If a document has multiple authors, the authors may be put on
4058separate lines with leading space, or separated by semicolons, or
4059both. So, all of the following are equivalent:
4067% Author One; Author Two
4075The date must fit on one line.
4077All three metadata fields may contain standard inline formatting
4078(italics, links, footnotes, etc.).
4080Title blocks will always be parsed, but they will affect the output only
4081when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4082will appear twice: once in the document head -- this is the title that
4083will appear at the top of the window in a browser -- and once at the
4084beginning of the document body. The title in the document head can have
4085an optional prefix attached (`--title-prefix` or `-T` option). The title
4086in the body appears as an H1 element with class "title", so it can be
4087suppressed or reformatted with CSS. If a title prefix is specified with
4088`-T` and no title block appears in the document, the title prefix will
4089be used by itself as the HTML title.
4091The man page writer extracts a title, man page section number, and
4092other header and footer information from the title line. The title
4093is assumed to be the first word on the title line, which may optionally
4094end with a (single-digit) section number in parentheses. (There should
4095be no space between the title and the parentheses.) Anything after
4096this is assumed to be additional footer and header text. A single pipe
4097character (`|`) should be used to separate the footer text from the header
4102will yield a man page with the title `PANDOC` and section 1.
4104 % PANDOC(1) Pandoc User Manuals
4106will also have "Pandoc User Manuals" in the footer.
4108 % PANDOC(1) Pandoc User Manuals | Version 4.0
4110will also have "Version 4.0" in the header.
4112#### Extension: `yaml_metadata_block` ####
4114A [YAML] metadata block is a valid YAML object, delimited by a line of three
4115hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4116(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4117document, but if it is not at the beginning, it must be preceded by a blank
4118line. (Note that, because of the way pandoc concatenates input files when
4119several are provided, you may also keep the metadata in a separate YAML file
4120and pass it to pandoc as an argument, along with your Markdown files:
4122 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4124Just be sure that the YAML file begins with `---` and ends with `---` or
4125`...`.) Alternatively, you can use the `--metadata-file` option. Using
4126that approach however, you cannot reference content (like footnotes)
4127from the main markdown input document.
4129Metadata will be taken from the fields of the YAML object and added to any
4130existing document metadata. Metadata can contain lists and objects (nested
4131arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4132with names ending in an underscore will be ignored by pandoc. (They may be
4133given a role by external processors.) Field names must not be
4134interpretable as YAML numbers or boolean values (so, for
4135example, `yes`, `True`, and `15` cannot be used as field names).
4137A document may contain multiple metadata blocks. If two
4138metadata blocks attempt to set the same field, the value from
4139the second block will be taken.
4141When pandoc is used with `-t markdown` to create a Markdown document,
4142a YAML metadata block will be produced only if the `-s/--standalone`
4143option is used. All of the metadata will appear in a single block
4144at the beginning of the document.
4146Note that [YAML] escaping rules must be followed. Thus, for example,
4147if a title contains a colon, it must be quoted. The pipe character
4148(`|`) can be used to begin an indented block that will be interpreted
4149literally, without need for escaping. This form is necessary
4150when the field contains blank lines or block-level formatting:
4153 title: 'This is the title: it contains a colon'
4157 keywords: [nothing, nothingness]
4159 This is the abstract.
4161 It consists of two paragraphs.
4164Template variables will be set automatically from the metadata. Thus, for
4165example, in writing HTML, the variable `abstract` will be set to the HTML
4166equivalent of the Markdown in the `abstract` field:
4168 <p>This is the abstract.</p>
4169 <p>It consists of two paragraphs.</p>
4171Variables can contain arbitrary YAML structures, but the template must match
4172this structure. The `author` variable in the default templates expects a
4173simple list or string, but can be changed to support more complicated
4174structures. The following combination, for example, would add an affiliation
4175to the author if one is given:
4178 title: The document title
4181 affiliation: University of Somewhere
4183 affiliation: University of Nowhere
4186To use the structured authors in the example above, you would need a custom
4191 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4197Raw content to include in the document's header may be specified
4198using `header-includes`; however, it is important to mark up
4199this content as raw code for a particular output format, using
4200the [`raw_attribute` extension](#extension-raw_attribute)), or it
4201will be interpreted as markdown. For example:
4206 \let\oldsection\section
4207 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4212#### Extension: `all_symbols_escapable` ####
4214Except inside a code block or inline code, any punctuation or space
4215character preceded by a backslash will be treated literally, even if it
4216would normally indicate formatting. Thus, for example, if one writes
4226 <strong>hello</strong>
4228This rule is easier to remember than standard Markdown's rule,
4229which allows only the following characters to be backslash-escaped:
4233(However, if the `markdown_strict` format is used, the standard Markdown rule
4236A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4237it will appear as `~`. In HTML and XML output, it will appear as a
4238literal unicode nonbreaking space character (note that it will thus
4239actually look "invisible" in the generated HTML source; you can still
4240use the `--ascii` command-line option to make it appear as an explicit
4243A backslash-escaped newline (i.e. a backslash occurring at the end of
4244a line) is parsed as a hard line break. It will appear in TeX output as
4245`\\` and in HTML as `<br />`. This is a nice alternative to
4246Markdown's "invisible" way of indicating hard line breaks using
4247two trailing spaces on a line.
4249Backslash escapes do not work in verbatim contexts.
4255To *emphasize* some text, surround it with `*`s or `_`, like this:
4257 This text is _emphasized with underscores_, and this
4258 is *emphasized with asterisks*.
4260Double `*` or `_` produces **strong emphasis**:
4262 This is **strong emphasis** and __with underscores__.
4264A `*` or `_` character surrounded by spaces, or backslash-escaped,
4265will not trigger emphasis:
4267 This is * not emphasized *, and \*neither is this\*.
4269#### Extension: `intraword_underscores` ####
4271Because `_` is sometimes used inside words and identifiers,
4272pandoc does not interpret a `_` surrounded by alphanumeric
4273characters as an emphasis marker. If you want to emphasize
4274just part of a word, use `*`:
4276 feas*ible*, not feas*able*.
4281#### Extension: `strikeout` ####
4283To strikeout a section of text with a horizontal line, begin and end it
4284with `~~`. Thus, for example,
4286 This ~~is deleted text.~~
4289### Superscripts and subscripts ###
4291#### Extension: `superscript`, `subscript` ####
4293Superscripts may be written by surrounding the superscripted text by `^`
4294characters; subscripts may be written by surrounding the subscripted
4295text by `~` characters. Thus, for example,
4297 H~2~O is a liquid. 2^10^ is 1024.
4299The text between `^...^` or `~...~` may not contain spaces or
4300newlines. If the superscripted or subscripted text contains
4301spaces, these spaces must be escaped with backslashes. (This is
4302to prevent accidental superscripting and subscripting through
4303the ordinary use of `~` and `^`, and also bad interactions with
4304footnotes.) Thus, if you want the letter P with 'a cat' in
4305subscripts, use `P~a\ cat~`, not `P~a cat~`.
4309To make a short span of text verbatim, put it inside backticks:
4311 What is the difference between `>>=` and `>>`?
4313If the verbatim text includes a backtick, use double backticks:
4315 Here is a literal backtick `` ` ``.
4317(The spaces after the opening backticks and before the closing
4318backticks will be ignored.)
4320The general rule is that a verbatim span starts with a string
4321of consecutive backticks (optionally followed by a space)
4322and ends with a string of the same number of backticks (optionally
4323preceded by a space).
4325Note that backslash-escapes (and other Markdown constructs) do not
4326work in verbatim contexts:
4328 This is a backslash followed by an asterisk: `\*`.
4330#### Extension: `inline_code_attributes` ####
4332Attributes can be attached to verbatim text, just as with
4333[fenced code blocks]:
4339To write small caps, use the `smallcaps` class:
4341 [Small caps]{.smallcaps}
4343Or, without the `bracketed_spans` extension:
4345 <span class="smallcaps">Small caps</span>
4347For compatibility with other Markdown flavors, CSS is also supported:
4349 <span style="font-variant:small-caps;">Small caps</span>
4351This will work in all output formats that support small caps.
4356#### Extension: `tex_math_dollars` ####
4358Anything between two `$` characters will be treated as TeX math. The
4359opening `$` must have a non-space character immediately to its right,
4360while the closing `$` must have a non-space character immediately to its
4361left, and must not be followed immediately by a digit. Thus,
4362`$20,000 and $30,000` won't parse as math. If for some reason
4363you need to enclose text in literal `$` characters, backslash-escape
4364them and they won't be treated as math delimiters.
4366For display math, use `$$` delimiters. (In this case, the delimiters
4367may be separated from the formula by whitespace. However, there can be
4368no blank lines betwen the opening and closing `$$` delimiters.)
4370TeX math will be printed in all output formats. How it is rendered
4371depends on the output format:
4374 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4375 math) or `\[...\]` (for display math).
4377Markdown, Emacs Org mode, ConTeXt, ZimWiki
4378 ~ It will appear verbatim surrounded by `$...$` (for inline
4379 math) or `$$...$$` (for display math).
4382 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4385 ~ It will be rendered using an [interpreted text role `:math:`].
4388 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4389 surrounded by `latexmath:[$...$]` (for inline math) or
4390 `[latexmath]++++\[...\]+++` (for display math).
4391 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4392 (`$..$` and `\[..\]`) are omitted.
4395 ~ It will be rendered inside a `@math` command.
4397roff man, Jira markup
4398 ~ It will be rendered verbatim without `$`'s.
4401 ~ It will be rendered inside `<math>` tags.
4404 ~ It will be rendered inside `<span class="math">` tags.
4407 ~ It will be rendered, if possible, using Unicode characters,
4408 and will otherwise appear verbatim.
4411 ~ It will be rendered, if possible, using MathML.
4414 ~ If the `--mathml` flag is used, it will be rendered using MathML
4415 in an `inlineequation` or `informalequation` tag. Otherwise it
4416 will be rendered, if possible, using Unicode characters.
4419 ~ It will be rendered using OMML math markup.
4422 ~ If the `--webtex` option is used, formulas are rendered as images
4423 using CodeCogs or other compatible web service, downloaded
4424 and embedded in the e-book. Otherwise, they will appear verbatim.
4426HTML, Slidy, DZSlides, S5, EPUB
4427 ~ The way math is rendered in HTML will depend on the
4428 command-line options selected. Therefore see [Math rendering in HTML]
4431[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4435#### Extension: `raw_html` ####
4437Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4438(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4439literally). (Technically this is not an extension, since standard
4440Markdown allows it, but it has been made an extension so that it can
4441be disabled if desired.)
4443The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4444DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4445output, and suppressed in other formats.
4447For a more explicit way of including raw HTML in a Markdown
4448document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4450In the CommonMark format, if `raw_html` is enabled, superscripts,
4451subscripts, strikeouts and small capitals will be represented as HTML.
4452Otherwise, plain-text fallbacks will be used. Note that even if
4453`raw_html` is disabled, tables will be rendered with HTML syntax if
4454they cannot use pipe syntax.
4456#### Extension: `markdown_in_html_blocks` ####
4458Standard Markdown allows you to include HTML "blocks": blocks
4459of HTML between balanced tags that are separated from the surrounding text
4460with blank lines, and start and end at the left margin. Within
4461these blocks, everything is interpreted as HTML, not Markdown;
4462so (for example), `*` does not signify emphasis.
4464Pandoc behaves this way when the `markdown_strict` format is used; but
4465by default, pandoc interprets material between HTML block tags as Markdown.
4466Thus, for example, pandoc will turn
4471 <td>[a link](https://google.com)</td>
4479 <td><em>one</em></td>
4480 <td><a href="https://google.com">a link</a></td>
4484whereas `Markdown.pl` will preserve it as is.
4486There is one exception to this rule: text between `<script>`,
4487`<style>`, and `<textarea>` tags is not interpreted as Markdown.
4489This departure from standard Markdown should make it easier to mix
4490Markdown with HTML block elements. For example, one can surround
4491a block of Markdown text with `<div>` tags without preventing it
4492from being interpreted as Markdown.
4494#### Extension: `native_divs` ####
4496Use native pandoc `Div` blocks for content inside `<div>` tags.
4497For the most part this should give the same output as
4498`markdown_in_html_blocks`, but it makes it easier to write pandoc
4499filters to manipulate groups of blocks.
4501#### Extension: `native_spans` ####
4503Use native pandoc `Span` blocks for content inside `<span>` tags.
4504For the most part this should give the same output as `raw_html`,
4505but it makes it easier to write pandoc filters to manipulate groups
4508#### Extension: `raw_tex` ####
4510In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4511included in a document. Inline TeX commands will be preserved and passed
4512unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4513LaTeX to include BibTeX citations:
4515 This result was proved in \cite{jones.1967}.
4517Note that in LaTeX environments, like
4519 \begin{tabular}{|l|l|}\hline
4520 Age & Frequency \\ \hline
4523 36--45 & 22 \\ \hline
4526the material between the begin and end tags will be interpreted as raw
4527LaTeX, not as Markdown.
4529For a more explicit and flexible way of including raw TeX in a
4530Markdown document, see the [`raw_attribute`
4531extension][Extension: `raw_attribute`].
4533Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4534Emacs Org mode, and ConTeXt.
4536### Generic raw attribute ###
4538#### Extension: `raw_attribute` ####
4540Inline spans and fenced code blocks with a special
4541kind of attribute will be parsed as raw content with the
4542designated format. For example, the following produces a raw
4549And the following produces a raw `html` inline element:
4551 This is `<a>html</a>`{=html}
4553This can be useful to insert raw xml into `docx` documents, e.g.
4559 <w:br w:type="page"/>
4564The format name should match the target format name (see
4565`-t/--to`, above, for a list, or use `pandoc
4566--list-output-formats`). Use `openxml` for `docx` output,
4567`opendocument` for `odt` output, `html5` for `epub3` output,
4568`html4` for `epub2` output, and `latex`, `beamer`,
4569`ms`, or `html5` for `pdf` output (depending on what you
4570use for `--pdf-engine`).
4572This extension presupposes that the relevant kind of
4573inline code or fenced code block is enabled. Thus, for
4574example, to use a raw attribute with a backtick code block,
4575`backtick_code_blocks` must be enabled.
4577The raw attribute cannot be combined with regular attributes.
4581#### Extension: `latex_macros` ####
4583When this extension is enabled, pandoc will parse LaTeX
4584macro definitions and apply the resulting macros to all LaTeX
4585math and raw LaTeX. So, for example, the following will work in
4586all output formats, not just LaTeX:
4588 \newcommand{\tuple}[1]{\langle #1 \rangle}
4592Note that LaTeX macros will not be applied if they occur
4593inside a raw span or block marked with the
4594[`raw_attribute` extension](#extension-raw_attribute).
4596When `latex_macros` is disabled, the raw LaTeX and math will
4597not have macros applied. This is usually a better approach when
4598you are targeting LaTeX or PDF.
4600Macro definitions in LaTeX will be passed through as raw LaTeX
4601only if `latex_macros` is not enabled. Macro definitions in
4602Markdown source (or other formats allowing `raw_tex`) will
4603be passed through regardless of whether `latex_macros` is
4608Markdown allows links to be specified in several ways.
4610### Automatic links ###
4612If you enclose a URL or email address in pointy brackets, it
4615 <https://google.com>
4616 <sam@green.eggs.ham>
4620An inline link consists of the link text in square brackets,
4621followed by the URL in parentheses. (Optionally, the URL can
4622be followed by a link title, in quotes.)
4624 This is an [inline link](/url), and here's [one with
4625 a title](https://fsf.org "click here for a good time!").
4627There can be no space between the bracketed part and the parenthesized part.
4628The link text can contain formatting (such as emphasis), but the title cannot.
4630Email addresses in inline links are not autodetected, so they have to be
4631prefixed with `mailto`:
4633 [Write me!](mailto:sam@green.eggs.ham)
4635### Reference links ###
4637An *explicit* reference link has two parts, the link itself and the link
4638definition, which may occur elsewhere in the document (either
4639before or after the link).
4641The link consists of link text in square brackets, followed by a label in
4642square brackets. (There cannot be space between the two unless the
4643`spaced_reference_links` extension is enabled.) The link definition
4644consists of the bracketed label, followed by a colon and a space, followed by
4645the URL, and optionally (after a space) a link title either in quotes or in
4646parentheses. The label must not be parseable as a citation (assuming
4647the `citations` extension is enabled): citations take precedence over
4650Here are some examples:
4652 [my label 1]: /foo/bar.html "My title, optional"
4654 [my label 3]: https://fsf.org (The free software foundation)
4655 [my label 4]: /bar#special 'A title in single quotes'
4657The URL may optionally be surrounded by angle brackets:
4659 [my label 5]: <http://foo.bar.baz>
4661The title may go on the next line:
4663 [my label 3]: https://fsf.org
4664 "The free software foundation"
4666Note that link labels are not case sensitive. So, this will work:
4668 Here is [my link][FOO]
4672In an *implicit* reference link, the second pair of brackets is
4677 [my website]: http://foo.bar.baz
4679Note: In `Markdown.pl` and most other Markdown implementations,
4680reference link definitions cannot occur in nested constructions
4681such as list items or block quotes. Pandoc lifts this arbitrary
4682seeming restriction. So the following is fine in pandoc, though
4683not in most other implementations:
4689#### Extension: `shortcut_reference_links` ####
4691In a *shortcut* reference link, the second pair of brackets may
4696 [my website]: http://foo.bar.baz
4698### Internal links ###
4700To link to another section of the same document, use the automatically
4701generated identifier (see [Heading identifiers]). For example:
4703 See the [Introduction](#introduction).
4707 See the [Introduction].
4709 [Introduction]: #introduction
4711Internal links are currently supported for HTML formats (including
4712HTML slide shows and EPUB), LaTeX, and ConTeXt.
4716A link immediately preceded by a `!` will be treated as an image.
4717The link text will be used as the image's alt text:
4719 
4723 [movie reel]: movie.gif
4725#### Extension: `implicit_figures` ####
4727An image with nonempty alt text, occurring by itself in a
4728paragraph, will be rendered as a figure with a caption. The
4729image's alt text will be used as the caption.
4731 
4733How this is rendered depends on the output format. Some output
4734formats (e.g. RTF) do not yet support figures. In those
4735formats, you'll just get an image in a paragraph by itself, with
4738If you just want a regular inline image, just make sure it is not
4739the only thing in the paragraph. One way to do this is to insert a
4740nonbreaking space after the image:
4742 \
4744Note that in reveal.js slide shows, an image in a paragraph
4745by itself that has the `stretch` class will fill the screen,
4746and the caption and figure tags will be omitted.
4748#### Extension: `link_attributes` ####
4750Attributes can be set on links and images:
4752 An inline {#id .class width=30 height=20px}
4753 and a reference ![image][ref] with attributes.
4755 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4757(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4758and `.class` are used.)
4760For HTML and EPUB, all known HTML5 attributes except `width` and
4761`height` (but including `srcset` and `sizes`) are passed through
4762as is. Unknown attributes are passed through as custom
4763attributes, with `data-` prepended. The other writers ignore
4764attributes that are not specifically supported by their output format.
4766The `width` and `height` attributes on images are treated specially. When
4767used without a unit, the unit is assumed to be pixels. However, any of
4768the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4769and `%`. There must not be any spaces between the number and the unit.
4773{ width=50% }
4776- Dimensions may be converted to a form that is compatible with
4777 the output format (for example, dimensions given in pixels will
4778 be converted to inches when converting HTML to LaTeX). Conversion
4779 between pixels and physical measurements is affected by the
4780 `--dpi` option (by default, 96 dpi is assumed, unless the image
4781 itself contains dpi information).
4782- The `%` unit is generally relative to some available space.
4783 For example the above example will render to the following.
4784 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4785 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4786 (If you're using a custom template, you need to configure `graphicx`
4787 as in the default template.)
4788 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4789- Some output formats have a notion of a class
4790 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4791 or a unique identifier (LaTeX `\caption`), or both (HTML).
4792- When no `width` or `height` attributes are specified, the fallback
4793 is to look at the image resolution and the dpi metadata embedded in
4798Using the `native_divs` and `native_spans` extensions
4799(see [above][Extension: `native_divs`]), HTML syntax can
4800be used as part of markdown to create native `Div` and `Span`
4801elements in the pandoc AST (as opposed to raw HTML).
4802However, there is also nicer syntax available:
4804#### Extension: `fenced_divs` ####
4806Allow special fenced syntax for native `Div` blocks. A Div
4807starts with a fence containing at least three consecutive
4808colons plus some attributes. The attributes may optionally
4809be followed by another string of consecutive colons.
4810The attribute syntax is exactly as in fenced code blocks (see
4811[Extension: `fenced_code_attributes`]). As with fenced
4812code blocks, one can use either attributes in curly braces
4813or a single unbraced word, which will be treated as a class
4814name. The Div ends with another line containing a string of at
4815least three consecutive colons. The fenced Div should be
4816separated by blank lines from preceding and following blocks.
4820 ::::: {#special .sidebar}
4821 Here is a paragraph.
4826Fenced divs can be nested. Opening fences are distinguished
4827because they *must* have attributes:
4833 This is a warning within a warning.
4837Fences without attributes are always closing fences. Unlike
4838with fenced code blocks, the number of colons in the closing
4839fence need not match the number in the opening fence. However,
4840it can be helpful for visual clarity to use fences of different
4841lengths to distinguish nested divs from their parents.
4844#### Extension: `bracketed_spans` ####
4846A bracketed sequence of inlines, as one would use to begin
4847a link, will be treated as a `Span` with attributes if it is
4848followed immediately by attributes:
4850 [This is *some text*]{.class key="val"}
4854#### Extension: `footnotes` ####
4856Pandoc's Markdown allows footnotes, using the following syntax:
4858 Here is a footnote reference,[^1] and another.[^longnote]
4860 [^1]: Here is the footnote.
4862 [^longnote]: Here's one with multiple blocks.
4864 Subsequent paragraphs are indented to show that they
4865 belong to the previous footnote.
4869 The whole paragraph can be indented, or just the first
4870 line. In this way, multi-paragraph footnotes work like
4871 multi-paragraph list items.
4873 This paragraph won't be part of the note, because it
4876The identifiers in footnote references may not contain spaces, tabs,
4877or newlines. These identifiers are used only to correlate the
4878footnote reference with the note itself; in the output, footnotes
4879will be numbered sequentially.
4881The footnotes themselves need not be placed at the end of the
4882document. They may appear anywhere except inside other block elements
4883(lists, block quotes, tables, etc.). Each footnote should be
4884separated from surrounding content (including other footnotes)
4887#### Extension: `inline_notes` ####
4889Inline footnotes are also allowed (though, unlike regular notes,
4890they cannot contain multiple paragraphs). The syntax is as follows:
4892 Here is an inline note.^[Inlines notes are easier to write, since
4893 you don't have to pick an identifier and move down to type the
4896Inline and regular footnotes may be mixed freely.
4900#### Extension: `citations` ####
4902Markdown citations go inside square brackets and are separated
4903by semicolons. Each citation must have a key, composed of '@' +
4904the citation identifier from the database, and may optionally
4905have a prefix, a locator, and a suffix. The citation key must
4906begin with a letter, digit, or `_`, and may contain
4907alphanumerics, `_`, and internal punctuation characters
4908(`:.#$%&-+?<>~/`). Here are some examples:
4910 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4912 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4914 Blah blah [@smith04; @doe99].
4916`pandoc` detects locator terms in the [CSL locale files].
4917Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4918locale, locator terms can be written in either singular or plural forms,
4919as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4920`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4921`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4922`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4923`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4924`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4925locator term is used, "page" is assumed.
4927`pandoc` will use heuristics to distinguish the locator
4928from the suffix. In complex cases, the locator can be enclosed
4931 [@smith{ii, A, D-Z}, with a suffix]
4932 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4934A minus sign (`-`) before the `@` will suppress mention of
4935the author in the citation. This can be useful when the
4936author is already mentioned in the text:
4938 Smith says blah [-@smith04].
4940You can also write an in-text citation, as follows:
4944 @smith04 [p. 33] says blah.
4947[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4948[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4949[Chicago Manual of Style]: https://chicagomanualofstyle.org
4950[Citation Style Language]: https://citationstyles.org
4951[Zotero Style Repository]: https://www.zotero.org/styles
4952[finding and editing styles]: https://citationstyles.org/authors/
4953[CSL locale files]: https://github.com/citation-style-language/locales
4955## Non-pandoc extensions
4957The following Markdown syntax extensions are not enabled by default
4958in pandoc, but may be enabled by adding `+EXTENSION` to the format
4959name, where `EXTENSION` is the name of the extension. Thus, for
4960example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4962#### Extension: `attributes` ####
4964Allows attributes to be attached to any inline or block-level
4965element. The syntax for the attributes is the same as that
4966used in [`header_attributes`][Extension: `header_attributes`].
4968- Attributes that occur immediately after an inline
4969 element affect that element. If they follow a space, then they
4970 belong to the space. (Hence, this option subsumes
4971 `inline_code_attributes` and `link_attributes`.)
4972- Attributes that occur immediately before a block
4973 element, on a line by themselves, affect that
4975- Consecutive attribute specifiers may be used,
4976 either for blocks or for inlines. Their attributes
4978- Attributes that occur at the end of the text of
4979 a Setext or ATX heading (separated by whitespace
4980 from the text) affect the heading element. (Hence, this
4981 option subsumes `header_attributes`.)
4982- Attributes that occur after the opening fence
4983 in a fenced code block affect the code block element. (Hence,
4984 this option subsumes `fenced_code_attributes`.)
4985- Attributes that occur at the end of a reference
4986 link definition affect links that refer to that
4989Note that pandoc's AST does not currently allow attributes
4990to be attached to arbitrary elements. Hence a Span or Div
4991container will be added if needed.
4993#### Extension: `old_dashes` ####
4995Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4996`-` before a numeral is an en-dash, and `--` is an em-dash.
4997This option only has an effect if `smart` is enabled. It is
4998selected automatically for `textile` input.
5000#### Extension: `angle_brackets_escapable` ####
5002Allow `<` and `>` to be backslash-escaped, as they can be in
5003GitHub flavored Markdown but not original Markdown. This is
5004implied by pandoc's default `all_symbols_escapable`.
5006#### Extension: `lists_without_preceding_blankline` ####
5008Allow a list to occur right after a paragraph, with no intervening
5011#### Extension: `four_space_rule` ####
5013Selects the pandoc <= 2.0 behavior for parsing lists, so that
5014four spaces indent are needed for list item continuation
5017#### Extension: `spaced_reference_links` ####
5019Allow whitespace between the two components of a reference link,
5024#### Extension: `hard_line_breaks` ####
5026Causes all newlines within a paragraph to be interpreted as hard line
5027breaks instead of spaces.
5029#### Extension: `ignore_line_breaks` ####
5031Causes newlines within a paragraph to be ignored, rather than being
5032treated as spaces or as hard line breaks. This option is intended for
5033use with East Asian languages where spaces are not used between words,
5034but text is divided into lines for readability.
5036#### Extension: `east_asian_line_breaks` ####
5038Causes newlines within a paragraph to be ignored, rather than
5039being treated as spaces or as hard line breaks, when they occur
5040between two East Asian wide characters. This is a better choice
5041than `ignore_line_breaks` for texts that include a mix of East
5042Asian wide characters and other characters.
5044#### Extension: `emoji` ####
5046Parses textual emojis like `:smile:` as Unicode emoticons.
5048#### Extension: `tex_math_single_backslash` ####
5050Causes anything between `\(` and `\)` to be interpreted as inline
5051TeX math, and anything between `\[` and `\]` to be interpreted
5052as display TeX math. Note: a drawback of this extension is that
5053it precludes escaping `(` and `[`.
5055#### Extension: `tex_math_double_backslash` ####
5057Causes anything between `\\(` and `\\)` to be interpreted as inline
5058TeX math, and anything between `\\[` and `\\]` to be interpreted
5061#### Extension: `markdown_attribute` ####
5063By default, pandoc interprets material inside block-level tags as Markdown.
5064This extension changes the behavior so that Markdown is only parsed
5065inside block-level tags if the tags have the attribute `markdown=1`.
5067#### Extension: `mmd_title_block` ####
5069Enables a [MultiMarkdown] style title block at the top of
5070the document, for example:
5074 Date: September 1, 2008
5075 Comment: This is a sample mmd title block, with
5076 a field spanning multiple lines.
5078See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5079`yaml_metadata_block` is enabled, it will take precedence over
5082#### Extension: `abbreviations` ####
5084Parses PHP Markdown Extra abbreviation keys, like
5086 *[HTML]: Hypertext Markup Language
5088Note that the pandoc document model does not support
5089abbreviations, so if this extension is enabled, abbreviation keys are
5090simply skipped (as opposed to being parsed as paragraphs).
5092#### Extension: `autolink_bare_uris` ####
5094Makes all absolute URIs into links, even when not surrounded by
5095pointy braces `<...>`.
5097#### Extension: `mmd_link_attributes` ####
5099Parses multimarkdown style key-value attributes on link
5100and image references. This extension should not be confused with the
5101[`link_attributes`](#extension-link_attributes) extension.
5103 This is a reference ![image][ref] with multimarkdown attributes.
5105 [ref]: https://path.to/image "Image title" width=20px height=30px
5106 id=myId class="myClass1 myClass2"
5108#### Extension: `mmd_header_identifiers` ####
5110Parses multimarkdown style heading identifiers (in square brackets,
5111after the heading but before any trailing `#`s in an ATX heading).
5113#### Extension: `compact_definition_lists` ####
5115Activates the definition list syntax of pandoc 1.12.x and earlier.
5116This syntax differs from the one described above under [Definition lists]
5119 - No blank line is required between consecutive items of the
5121 - To get a "tight" or "compact" list, omit space between consecutive
5122 items; the space between a term and its definition does not affect
5124 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5125 be indented four spaces.[^6]
5127[^6]: To see why laziness is incompatible with relaxing the requirement
5128 of a blank line between items, consider the following example:
5135 Is this a single list item with two definitions of "bar," the first of
5136 which is lazily wrapped, or two list items? To remove the ambiguity
5137 we must either disallow lazy wrapping or require a blank line between
5140#### Extension: `gutenberg` ####
5142Use [Project Gutenberg] conventions for `plain` output:
5143all-caps for strong emphasis, surround by underscores
5144for regular emphasis, add extra blank space around headings.
5146 [Project Gutenberg]: https://www.gutenberg.org
5148#### Extension: `sourcepos` ####
5150Include source position attributes when parsing `commonmark`.
5151For elements that accept attributes, a `data-pos` attribute
5152is added; other elements are placed in a surrounding
5153Div or Span elemnet with a `data-pos` attribute.
5157In addition to pandoc's extended Markdown, the following Markdown
5158variants are supported:
5160- `markdown_phpextra` (PHP Markdown Extra)
5161- `markdown_github` (deprecated GitHub-Flavored Markdown)
5162- `markdown_mmd` (MultiMarkdown)
5163- `markdown_strict` (Markdown.pl)
5164- `commonmark` (CommonMark)
5165- `gfm` (Github-Flavored Markdown)
5166- `commonmark_x` (CommonMark with many pandoc extensions)
5168To see which extensions are supported for a given format,
5169and which are enabled by default, you can use the command
5171 pandoc --list-extensions=FORMAT
5173where `FORMAT` is replaced with the name of the format.
5175Note that the list of extensions for `commonmark`,
5176`gfm`, and `commonmark_x` are defined relative to default
5177commonmark. So, for example, `backtick_code_blocks`
5178does not appear as an extension, since it is enabled by
5179default and cannot be disabled.
5183When the `--citeproc` option is used, pandoc can automatically generate
5184citations and a bibliography in a number of styles. Basic usage is
5186 pandoc --citeproc myinput.txt
5188To use this feature, you will need to have
5190- a document containing citations (see [Extension: `citations`]);
5191- a source of bibliographic data: either an external bibliography
5192 file or a list of `references` in the document's YAML metadata
5193- optionally, a [CSL] citation style.
5195## Specifying bibliographic data
5197You can specify an external bibliography using the
5198`bibliography` metadata field in a YAML metadata section or the
5199`--bibliography` command line argument. If you want to use
5200multiple bibliography files, you can supply multiple
5201`--bibliography` arguments or set `bibliography` metadata field
5202to YAML array. A bibliography may have any of these formats:
5204 Format File extension
5205 ------------ --------------
5211Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5212use the extension `.bibtex` to force interpretation as BibTeX.
5214In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5215inside fields such as `title`; in CSL YAML databases, pandoc
5216Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5225`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5234`<span class="nocase">...</span>`
5235: prevent a phrase from being capitalized as title case
5237As an alternative to specifying a bibliography file using
5238`--bibliography` or the YAML metadata field `bibliography`, you
5239can include the citation data directly in the `references` field
5240of the document's YAML metadata. The field should contain an
5241array of YAML-encoded references, for example:
5245 - type: article-journal
5257 title: 'Molecular structure of nucleic acids: a structure for
5258 deoxyribose nucleic acid'
5259 title-short: Molecular structure of nucleic acids
5260 container-title: Nature
5264 DOI: 10.1038/171737a0
5265 URL: https://www.nature.com/articles/171737a0
5269If both an external bibliography and inline (YAML metadata)
5270references are provided, both will be used. In case of
5271conflicting `id`s, the inline references will take precedence.
5273Note that `pandoc` can be used to produce such a YAML metadata
5274section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5276 pandoc chem.bib -s -f biblatex -t markdown
5277 pandoc chem.json -s -f csljson -t markdown
5279Indeed, `pandoc` can convert between any of these
5282 pandoc chem.bib -s -f biblatex -t csljson
5283 pandoc chem.yaml -s -f markdown -t biblatex
5285Running pandoc on a bibliography file with the `--citeproc`
5286option will create a formatted bibliography in the format
5289 pandoc chem.bib -s --citeproc -o chem.html
5290 pandoc chem.bib -s --citeproc -o chem.pdf
5292### Capitalization in titles
5294If you are using a bibtex or biblatex bibliography, then observe
5297 - English titles should be in title case. Non-English titles should
5298 be in sentence case, and the `langid` field in biblatex should be
5299 set to the relevant language. (The following values are treated
5300 as English: `american`, `british`, `canadian`, `english`,
5301 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5303 - As is standard with bibtex/biblatex, proper names should be
5304 protected with curly braces so that they won't be lowercased
5305 in styles that call for sentence case. For example:
5307 title = {My Dinner with {Andre}}
5309 - In addition, words that should remain lowercase (or camelCase)
5310 should be protected:
5312 title = {Spin Wave Dispersion on the {nm} Scale}
5314 Though this is not necessary in bibtex/biblatex, it is necessary
5315 with citeproc, which stores titles internally in sentence case,
5316 and converts to title case in styles that require it. Here we
5317 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5319If you are using a CSL bibliography (either JSON or YAML), then observe
5322 - All titles should be in sentence case.
5324 - Use the `language` field for non-English titles to prevent their
5325 conversion to title case in styles that call for this. (Conversion
5326 happens only if `language` begins with `en` or is left empty.)
5328 - Protect words that should not be converted to title case using
5331 Spin wave dispersion on the <span class="nocase">nm</span> scale
5333### Conference Papers, Published vs. Unpublished
5335For a formally published conference paper, use the biblatex entry type
5336`inproceedings` (which will be mapped to CSL `paper-conference`).
5338For an unpublished manuscript, use the biblatex entry type
5339`unpublished` without an `eventtitle` field (this entry type
5340will be mapped to CSL `manuscript`).
5342For a talk, an unpublished conference paper, or a poster
5343presentation, use the biblatex entry type `unpublished` with an
5344`eventtitle` field (this entry type will be mapped to CSL
5345`speech`). Use the biblatex `type` field to indicate the type,
5346e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5347too, though `eventdate` will not be rendered by most CSL styles.
5348Note that `venue` is for the event's venue, unlike `location`
5349which describes the publisher's location; do not use the latter
5350for an unpublished conference paper.
5353## Specifying a citation style
5355Citations and references can be formatted using any style supported by the
5356[Citation Style Language], listed in the [Zotero Style Repository].
5357These files are specified using the `--csl` option or the `csl`
5358(or `citation-style`) metadata field. By default, pandoc will
5359use the [Chicago Manual of Style] author-date format. (You can
5360override this default by copying a CSL style of your choice
5361to `default.csl` in your user data directory.)
5362The CSL project provides further information on [finding and
5365The `--citation-abbreviations` option (or the
5366`citation-abbreviations` metadata field) may be used to specify
5367a JSON file containing abbreviations of journals that should be
5368used in formatted bibliographies when `form="short"` is
5369specified. The format of the file can be illustrated with an
5374 "container-title": {
5375 "Lloyd's Law Reports": "Lloyd's Rep",
5376 "Estates Gazette": "EG",
5377 "Scots Law Times": "SLT"
5383## Citations in note styles
5385Pandoc's citation processing is designed to allow you to
5386move between author-date, numerical, and note styles without
5387modifying the markdown source. When you're using a note
5388style, avoid inserting footnotes manually. Instead, insert
5389citations just as you would in an author-date style---for
5392 Blah blah [@foo, p. 33].
5394The footnote will be created automatically. Pandoc will take
5395care of removing the space and moving the note before or
5396after the period, depending on the setting of
5397`notes-after-punctuation`, as described below in [Other relevant
5400In some cases you may need to put a citation inside a regular
5401footnote. Normal citations in footnotes (such as `[@foo, p.
540233]`) will be rendered in parentheses. In-text citations (such
5403as `@foo [p. 33]`) will be rendered without parentheses. (A
5404comma will be added if appropriate.) Thus:
5406 [^1]: Some studies [@foo; @bar, p. 33] show that
5407 frubulicious zoosnaps are quantical. For a survey
5408 of the literature, see @baz [chap. 1].
5410## Raw content in a style
5412To include raw content in a prefix, suffix, delimiter, or term,
5413surround it with these tags indicating the format:
5415 {{jats}}<ref>{{/jats}}
5417Without the tags, the string will be interpreted as a string
5418and escaped in the output, rather than being passed through raw.
5420This feature allows stylesheets to be customized to give
5421different output for different output formats. However,
5422stylesheets customized in this way will not be usable
5423by other CSL implementations.
5427## Placement of the bibliography
5429If the style calls for a list of works cited, it will be placed
5430in a div with id `refs`, if one exists:
5435Otherwise, it will be placed at the end of the document.
5436Generation of the bibliography can be suppressed by setting
5437`suppress-bibliography: true` in the YAML metadata.
5439If you wish the bibliography to have a section heading, you can
5440set `reference-section-title` in the metadata, or put the heading
5441at the beginning of the div with id `refs` (if you are using it)
5442or at the end of your document:
5448The bibliography will be inserted after this heading. Note that
5449the `unnumbered` class will be added to this heading, so that the
5450section will not be numbered.
5452## Including uncited items in the bibliography
5454If you want to include items in the bibliography without actually
5455citing them in the body text, you can define a dummy `nocite` metadata
5456field and put the citations there:
5465In this example, the document will contain a citation for `item3`
5466only, but the bibliography will contain entries for `item1`, `item2`, and
5469It is possible to create a bibliography with all the citations,
5470whether or not they appear in the document, by using a wildcard:
5477For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5478render the bibliography. In order to do so, specify bibliography
5479files as outlined above, and add `--natbib` or `--biblatex`
5480argument to `pandoc` invocation. Bear in mind that bibliography
5481files have to be in either BibTeX (for `--natbib`)
5482or BibLaTeX (for `--biblatex`) format.
5484## Other relevant metadata fields
5486A few other metadata fields affect bibliography formatting:
5489: If true, citations will be
5490 hyperlinked to the corresponding bibliography entries
5491 (for author-date and numerical styles only).
5494: The `lang` field will affect how the style is localized,
5495 for example in the translation of labels and the use
5496 of quotation marks. (For backwards compatibility,
5497 `locale` may be used instead of `lang`, but this use
5500`notes-after-punctuation`
5501: If true (the default), pandoc will put footnote citations
5502 after following punctuation. For example, if the source
5503 contains `blah blah [@jones99].`, the result will look like
5504 `blah blah.[^1]`, with the note moved after the period and
5505 the space collapsed. If false, the space will still be
5506 collapsed, but the footnote will not be moved after the
5518You can use pandoc to produce an HTML + JavaScript slide presentation
5519that can be viewed via a web browser. There are five ways to do this,
5520using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5521You can also produce a PDF slide show using LaTeX [`beamer`], or
5522slides shows in Microsoft [PowerPoint] format.
5524Here's the Markdown source for a simple slide show, `habits.txt`:
5551 
5558To produce an HTML/JavaScript slide show, simply type
5560 pandoc -t FORMAT -s habits.txt -o habits.html
5562where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5564For Slidy, Slideous, reveal.js, and S5, the file produced by
5565pandoc with the `-s/--standalone` option embeds a link to
5566JavaScript and CSS files, which are assumed to be available at
5567the relative path `s5/default` (for S5), `slideous` (for
5568Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5569at `w3.org` (for Slidy). (These paths can be changed by setting
5570the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5571variables; see [Variables for HTML slides], above.) For
5572DZSlides, the (relatively short) JavaScript and CSS are included
5573in the file by default.
5575With all HTML slide formats, the `--self-contained` option can
5576be used to produce a single file that contains all of the data
5577necessary to display the slide show, including linked scripts,
5578stylesheets, images, and videos.
5580To produce a PDF slide show using beamer, type
5582 pandoc -t beamer habits.txt -o habits.pdf
5584Note that a reveal.js slide show can also be converted to a PDF
5585by printing it to a file from the browser.
5587To produce a Powerpoint slide show, type
5589 pandoc habits.txt -o habits.pptx
5591## Structuring the slide show
5593By default, the *slide level* is the highest heading level in
5594the hierarchy that is followed immediately by content, and not another
5595heading, somewhere in the document. In the example above, level-1 headings
5596are always followed by level-2 headings, which are followed by content,
5597so the slide level is 2. This default can be overridden using
5598the `--slide-level` option.
5600The document is carved up into slides according to the following
5603 * A horizontal rule always starts a new slide.
5605 * A heading at the slide level always starts a new slide.
5607 * Headings *below* the slide level in the hierarchy create
5608 headings *within* a slide.
5610 * Headings *above* the slide level in the hierarchy create
5611 "title slides," which just contain the section title
5612 and help to break the slide show into sections.
5613 Non-slide content under these headings will be included
5614 on the title slide (for HTML slide shows) or in a
5615 subsequent slide with the same title (for beamer).
5617 * A title page is constructed automatically from the document's title
5618 block, if present. (In the case of beamer, this can be disabled
5619 by commenting out some lines in the default template.)
5621These rules are designed to support many different styles of slide show. If
5622you don't care about structuring your slides into sections and subsections,
5623you can just use level-1 headings for all each slide. (In that case, level-1
5624will be the slide level.) But you can also structure the slide show into
5625sections, as in the example above.
5627Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5628layout will be produced, with level-1 headings building horizontally
5629and level-2 headings building vertically. It is not recommended that
5630you use deeper nesting of section levels with reveal.js.
5634By default, these writers produce lists that display "all at once."
5635If you want your lists to display incrementally (one item at a time),
5636use the `-i` option. If you want a particular list to depart from the
5637default, put it in a `div` block with class `incremental` or
5638`nonincremental`. So, for example, using the `fenced div` syntax, the
5639following would be incremental regardless of the document default:
5657While using `incremental` and `nonincremental` divs are the
5658recommended method of setting incremental lists on a per-case basis,
5659an older method is also supported: putting lists inside a blockquote
5660will depart from the document default (that is, it will display
5661incrementally without the `-i` option and all at once with the `-i`
5667Both methods allow incremental and nonincremental lists to be mixed
5668in a single document.
5670Note: Neither the `-i/--incremental` option nor any of the
5671methods described here currently works for PowerPoint output.
5675You can add "pauses" within a slide by including a paragraph containing
5676three dots, separated by spaces:
5678 # Slide with a pause
5680 content before the pause
5684 content after the pause
5686Note: this feature is not yet implemented for PowerPoint output.
5688## Styling the slides
5690You can change the style of HTML slides by putting customized CSS files
5691in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5692or `$DATADIR/slideous` (for Slideous),
5693where `$DATADIR` is the user data directory (see `--data-dir`, above).
5694The originals may be found in pandoc's system data directory (generally
5695`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5696files it does not find in the user data directory.
5698For dzslides, the CSS is included in the HTML file itself, and may
5701All [reveal.js configuration options] can be set through variables.
5702For example, themes can be used by setting the `theme` variable:
5706Or you can specify a custom stylesheet using the `--css` option.
5708To style beamer slides, you can specify a `theme`, `colortheme`,
5709`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5711 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5713Note that heading attributes will turn into slide attributes
5714(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5715to style individual slides. In beamer, the only heading attribute
5716that affects slides is the `allowframebreaks` class, which sets the
5717`allowframebreaks` option, causing multiple slides to be created
5718if the content overfills the frame. This is recommended especially for
5721 # References {.allowframebreaks}
5725Speaker notes are supported in reveal.js and PowerPoint (pptx)
5726output. You can add notes to your Markdown document thus:
5732 - It can contain Markdown
5737To show the notes window in reveal.js, press `s` while viewing the
5738presentation. Speaker notes in PowerPoint will be available, as usual,
5739in handouts and presenter view.
5741Notes are not yet supported for other slide formats, but the notes
5742will not appear on the slides themselves.
5746To put material in side by side columns, you can use a native
5747div container with class `columns`, containing two or more div
5748containers with class `column` and a `width` attribute:
5750 :::::::::::::: {.columns}
5751 ::: {.column width="40%"}
5754 ::: {.column width="60%"}
5759### Additional columns attributes in beamer
5761The div containers with classes `columns` and `column` can optionally have
5762an `align` attribute.
5763The class `columns` can optionally have a `totalwidth` attribute or an
5764`onlytextwidth` class.
5766 :::::::::::::: {.columns align=center totalwidth=8em}
5767 ::: {.column width="40%"}
5770 ::: {.column width="60%" align=bottom}
5775The `align` attributes on `columns` and `column` can be used with the
5776values `top`, `top-baseline`, `center` and `bottom` to vertically align
5777the columns. It defaults to `top` in `columns`.
5779The `totalwidth` attribute limits the width of the columns to the given value.
5781 :::::::::::::: {.columns align=top .onlytextwidth}
5782 ::: {.column width="40%" align=center}
5785 ::: {.column width="60%"}
5790The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5792See Section 12.7 of the [Beamer User's Guide] for more details.
5794## Frame attributes in beamer
5796Sometimes it is necessary to add the LaTeX `[fragile]` option to
5797a frame in beamer (for example, when using the `minted` environment).
5798This can be forced by adding the `fragile` class to the heading
5799introducing the slide:
5801 # Fragile slide {.fragile}
5803All of the other frame attributes described in Section 8.1 of
5804the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5805`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5806`shrink`, `standout`, `noframenumbering`.
5808## Background in reveal.js and beamer
5810Background images can be added to self-contained reveal.js slideshows and
5811to beamer slideshows.
5813For the same image on every slide, use the configuration
5814option `background-image` either in the YAML metadata block
5815or as a command-line variable. (There are no other options in
5816beamer and the rest of this section concerns reveal.js slideshows.)
5818For reveal.js, you can instead use the reveal.js-native option
5819`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5820and `parallaxBackgroundVertical` the same way and must also set
5821`parallaxBackgroundSize` to have your values take effect.
5823To set an image for a particular reveal.js slide, add
5824`{data-background-image="/path/to/image"}`
5825to the first slide-level heading on the slide (which may even be empty).
5827In reveal.js's overview mode, the parallaxBackgroundImage will show up
5828only on the first slide.
5830Other reveal.js background settings also work on individual slides, including
5831`data-background-size`, `data-background-repeat`, `data-background-color`,
5832`data-transition`, and `data-transition-speed`.
5834To add a background image to the automatically generated title slide, use the
5835`title-slide-attributes` variable in the YAML metadata block. It must contain
5836a map of attribute names and values.
5838See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5841For example in reveal.js:
5846parallaxBackgroundImage: /path/to/my/background_image.png
5847title-slide-attributes:
5848 data-background-image: /path/to/title_image.png
5849 data-background-size: contain
5854Slide 1 has background_image.png as its background.
5856## {data-background-image="/path/to/special_image.jpg"}
5858Slide 2 has a special image for its background, even though the heading has no content.
5865EPUB metadata may be specified using the `--epub-metadata` option, but
5866if the source document is Markdown, it is better to use a [YAML metadata
5867block][Extension: `yaml_metadata_block`]. Here is an example:
5874 text: An investigation of metadata
5882 text: doi:10.234234.234/33
5884 rights: © 2007 John Smith, CC BY-NC
5889The following fields are recognized:
5892 ~ Either a string value or an object with fields `text` and
5893 `scheme`. Valid values for `scheme` are `ISBN-10`,
5894 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5895 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5896 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5899 ~ Either a string value, or an object with fields `file-as` and
5900 `type`, or a list of such objects. Valid values for `type` are
5901 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5904 ~ Either a string value, or an object with fields `role`, `file-as`,
5905 and `text`, or a list of such objects. Valid values for `role` are
5906 [MARC relators], but
5907 pandoc will attempt to translate the human-readable versions
5908 (like "author" and "editor") to the appropriate marc relators.
5911 ~ Same format as `creator`.
5914 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5915 Pandoc will attempt to convert other common date formats.
5917`lang` (or legacy: `language`)
5918 ~ A string value in [BCP 47] format. Pandoc will default to the local
5919 language if nothing is specified.
5922 ~ A string value or a list of such values.
5942`belongs-to-collection`
5943 ~ A string value. identifies the name of a collection to which
5944 the EPUB Publication belongs.
5947 ~ The `group-position` field indicates the numeric position in which
5948 the EPUB Publication belongs relative to other works belonging to
5949 the same `belongs-to-collection` field.
5952 ~ A string value (path to cover image).
5954`css` (or legacy: `stylesheet`)
5955 ~ A string value (path to CSS stylesheet).
5957`page-progression-direction`
5958 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5959 attribute for the [`spine` element].
5962 ~ iBooks-specific metadata, with the following fields:
5964 - `version`: (string)
5965 - `specified-fonts`: `true`|`false` (default `false`)
5966 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5967 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5968 - `binding`: `true`|`false` (default `true`)
5969 - `scroll-axis`: `vertical`|`horizontal`|`default`
5971[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5972[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5974## The `epub:type` attribute
5976For `epub3` output, you can mark up the heading that corresponds to an EPUB
5977chapter using the [`epub:type` attribute][epub-type]. For example, to set
5978the attribute to the value `prologue`, use this markdown:
5980 # My chapter {epub:type=prologue}
5982Which will result in:
5984 <body epub:type="frontmatter">
5985 <section epub:type="prologue">
5988Pandoc will output `<body epub:type="bodymatter">`, unless
5989you use one of the following values, in which case either
5990`frontmatter` or `backmatter` will be output.
5992`epub:type` of first section `epub:type` of body
5993---------------------------- ------------------
5996acknowledgments frontmatter
5997copyright-page frontmatter
5998dedication frontmatter
6002contributors frontmatter
6003other-credits frontmatter
6005revision-history frontmatter
6006titlepage frontmatter
6007halftitlepage frontmatter
6008seriespage frontmatter
6013bibliography backmatter
6016[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6020By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6021`<video>` or `<source>` element present in the generated EPUB,
6022and include it in the EPUB container, yielding a completely
6023self-contained EPUB. If you want to link to external media resources
6024instead, use raw HTML in your source and add `data-external="1"` to the tag
6025with the `src` attribute. For example:
6027 <audio controls="1">
6028 <source src="https://example.com/music/toccata.mp3"
6029 data-external="1" type="audio/mpeg">
6035When creating a [Jupyter notebook], pandoc will try to infer the
6036notebook structure. Code blocks with the class `code` will be
6037taken as code cells, and intervening content will be taken as
6038Markdown cells. Attachments will automatically be created for
6039images in Markdown cells. Metadata will be taken from the
6040`jupyter` metadata field. For example:
6049 display_name: Python 2
6056 file_extension: ".py"
6057 mimetype: "text/x-python"
6059 nbconvert_exporter: "python"
6060 pygments_lexer: "ipython2"
6066**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6067bibendum felis dictum sodales.
6076from IPython.display import HTML
6079console.log("hello");
6087This image  will be
6088included as a cell attachment.
6091If you want to add cell attributes, group cells differently, or
6092add output to code cells, then you need to include divs to
6093indicate the structure. You can use either [fenced
6094divs][Extension: `fenced_divs`] or [native divs][Extension:
6095`native_divs`] for this. Here is an example:
6098:::::: {.cell .markdown}
6101**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6102bibendum felis dictum sodales.
6105:::::: {.cell .code execution_count=1}
6110::: {.output .stream .stdout}
6117:::::: {.cell .code execution_count=2}
6119from IPython.display import HTML
6122console.log("hello");
6128::: {.output .execute_result execution_count=2}
6131console.log("hello");
6140If you include raw HTML or TeX in an output cell, use the
6141[raw attribute][Extension: `fenced_attribute`], as shown
6142in the last cell of the example above. Although pandoc can
6143process "bare" raw HTML and TeX, the result is often
6144interspersed raw elements and normal textual elements, and
6145in an output cell pandoc expects a single, connected raw
6146block. To avoid using raw HTML or TeX except when
6147marked explicitly using raw attributes, we recommend
6148specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6149translating between Markdown and ipynb notebooks.
6151Note that options and extensions that affect reading and
6152writing of Markdown will also affect Markdown cells in ipynb
6153notebooks. For example, `--wrap=preserve` will preserve
6154soft line breaks in Markdown cells; `--atx-headers` will
6155cause ATX-style headings to be used; and `--preserve-tabs` will
6156prevent tabs from being turned to spaces.
6158# Syntax highlighting
6160Pandoc will automatically highlight syntax in [fenced code blocks] that
6161are marked with a language name. The Haskell library [skylighting] is
6162used for highlighting. Currently highlighting is supported only for
6163HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6164that pandoc will recognize, type `pandoc --list-highlight-languages`.
6166The color scheme can be selected using the `--highlight-style` option.
6167The default color scheme is `pygments`, which imitates the default color
6168scheme used by the Python library pygments (though pygments is not actually
6169used to do the highlighting). To see a list of highlight styles,
6170type `pandoc --list-highlight-styles`.
6172If you are not satisfied with the predefined styles, you can
6173use `--print-highlight-style` to generate a JSON `.theme` file which
6174can be modified and used as the argument to `--highlight-style`. To
6175get a JSON version of the `pygments` style, for example:
6177 pandoc --print-highlight-style pygments > my.theme
6179Then edit `my.theme` and use it like this:
6181 pandoc --highlight-style my.theme
6183If you are not satisfied with the built-in highlighting, or you
6184want highlight a language that isn't supported, you can use the
6185`--syntax-definition` option to load a [KDE-style XML syntax definition
6186file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6187Before writing your own, have a look at KDE's [repository of syntax
6188definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6190To disable highlighting, use the `--no-highlight` option.
6192[skylighting]: https://github.com/jgm/skylighting
6196Custom styles can be used in the docx and ICML formats.
6200By default, pandoc's docx and ICML output applies a predefined set of styles
6201for blocks such as paragraphs and block quotes, and uses largely default
6202formatting (italics, bold) for inlines. This will work for most
6203purposes, especially alongside a `reference.docx` file. However, if you
6204need to apply your own styles to blocks, or match a preexisting set of
6205styles, pandoc allows you to define custom styles for blocks and text
6206using `div`s and `span`s, respectively.
6208If you define a `div` or `span` with the attribute `custom-style`,
6209pandoc will apply your specified style to the contained elements (with
6210the exception of elements whose function depends on a style, like
6211headings, code blocks, block quotes, or links). So, for example, using
6212the `bracketed_spans` syntax,
6214 [Get out]{custom-style="Emphatically"}, he said.
6216would produce a docx file with "Get out" styled with character
6217style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6219 Dickinson starts the poem simply:
6221 ::: {custom-style="Poetry"}
6222 | A Bird came down the Walk---
6223 | He did not know I saw---
6226would style the two contained lines with the `Poetry` paragraph style.
6228For docx output, styles will be defined in the output file as inheriting
6229from normal text, if the styles are not yet in your reference.docx.
6230If they are already defined, pandoc will not alter the definition.
6232This feature allows for greatest customization in conjunction with
6233[pandoc filters]. If you want all paragraphs after block quotes to be
6234indented, you can write a filter to apply the styles necessary. If you
6235want all italics to be transformed to the `Emphasis` character style
6236(perhaps to change their color), you can write a filter which will
6237transform all italicized inlines to inlines within an `Emphasis`
6240For docx output, you don't need to enable any extensions for
6241custom styles to work.
6243[pandoc filters]: https://pandoc.org/filters.html
6247The docx reader, by default, only reads those styles that it can
6248convert into pandoc elements, either by direct conversion or
6249interpreting the derivation of the input document's styles.
6251By enabling the [`styles` extension](#ext-styles) in the docx reader
6252(`-f docx+styles`), you can produce output that maintains the styles
6253of the input document, using the `custom-style` class. Paragraph
6254styles are interpreted as divs, while character styles are interpreted
6257For example, using the `custom-style-reference.docx` file in the test
6258directory, we have the following different outputs:
6260Without the `+styles` extension:
6262 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6265 This is text with an *emphasized* text style. And this is text with a
6266 **strengthened** text style.
6268 > Here is a styled paragraph that inherits from Block Text.
6270And with the extension:
6272 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6274 ::: {custom-style="First Paragraph"}
6278 ::: {custom-style="Body Text"}
6279 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6280 And this is text with a [strengthened]{custom-style="Strengthened"}
6284 ::: {custom-style="My Block Style"}
6285 > Here is a styled paragraph that inherits from Block Text.
6288With these custom styles, you can use your input document as a
6289reference-doc while creating docx output (see below), and maintain the
6290same styles in your input and output files.
6294Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6295includes a Lua interpreter, so Lua need not be installed separately.)
6297To use a custom writer, simply specify the path to the Lua script
6298in place of the output format. For example:
6300 pandoc -t data/sample.lua
6302Creating a custom writer requires writing a Lua function for each
6303possible element in a pandoc document. To get a documented example
6304which you can modify according to your needs, do
6306 pandoc --print-default-data-file sample.lua
6308Note that custom writers have no default template. If you want
6309to use `--standalone` with a custom writer, you will need to
6310specify a template manually using `--template` or add a new
6311default template with the name
6312`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6313subdirectory of your user data directory (see [Templates]).
6315[Lua]: https://www.lua.org
6317# Reproducible builds
6319Some of the document formats pandoc targets (such as EPUB,
6320docx, and ODT) include build timestamps in the generated document.
6321That means that the files generated on successive builds will
6322differ, even if the source does not. To avoid this, set the
6323`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6324be taken from it instead of the current time.
6325`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6326(specifying the number of second since midnight UTC January 1, 1970).
6328Some document formats also include a unique identifier. For
6329EPUB, this can be set explicitly by setting the `identifier`
6330metadata field (see [EPUB Metadata], above).
6334If you use pandoc to convert user-contributed content in a web
6335application, here are some things to keep in mind:
63371. Although pandoc itself will not create or modify any files other
6338 than those you explicitly ask it create (with the exception
6339 of temporary files used in producing PDFs), a filter or custom
6340 writer could in principle do anything on your file system. Please
6341 audit filters and custom writers very carefully before using them.
63432. If your application uses pandoc as a Haskell library (rather than
6344 shelling out to the executable), it is possible to use it in a mode
6345 that fully isolates pandoc from your file system, by running the
6346 pandoc operations in the `PandocPure` monad. See the document
6347 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
63503. Pandoc's parsers can exhibit pathological performance on some
6351 corner cases. It is wise to put any pandoc operations under
6352 a timeout, to avoid DOS attacks that exploit these issues.
6353 If you are using the pandoc executable, you can add the
6354 command line options `+RTS -M512M -RTS` (for example) to limit
6355 the heap size to 512MB.
63574. The HTML generated by pandoc is not guaranteed to be safe.
6358 If `raw_html` is enabled for the Markdown input, users can
6359 inject arbitrary HTML. Even if `raw_html` is disabled,
6360 users can include dangerous content in attributes for
6361 headings, spans, and code blocks. To be safe, you should
6362 run all the generated HTML through an HTML sanitizer.
6366Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
6367under the [GPL], version 2 or greater. This software carries no
6368warranty of any kind. (See COPYRIGHT for full copyright and
6369warranty notices.) For a full list of contributors, see the file
6370AUTHORS.md in the pandoc source code.
6372[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6373[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