2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: https://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`ifxetex`], [`ifluatex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `lualatex` uses
147[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149`mathspec` variable is set, `xelatex` will use [`mathspec`]
150instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151packages are used if available, and [`csquotes`] will be used
152for [typography] if the `csquotes` variable or metadata field is
153set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`ifluatex`]: https://ctan.org/pkg/ifluatex
184[`ifxetex`]: https://ctan.org/pkg/ifxetex
185[`listings`]: https://ctan.org/pkg/listings
186[`lm`]: https://ctan.org/pkg/lm
187[`longtable`]: https://ctan.org/pkg/longtable
188[`mathspec`]: https://ctan.org/pkg/mathspec
189[`microtype`]: https://ctan.org/pkg/microtype
190[`natbib`]: https://ctan.org/pkg/natbib
191[`parskip`]: https://ctan.org/pkg/parskip
192[`polyglossia`]: https://ctan.org/pkg/polyglossia
193[`prince`]: https://www.princexml.com/
194[`setspace`]: https://ctan.org/pkg/setspace
195[`ulem`]: https://ctan.org/pkg/ulem
196[`unicode-math`]: https://ctan.org/pkg/unicode-math
197[`upquote`]: https://ctan.org/pkg/upquote
198[`weasyprint`]: https://weasyprint.org
199[`wkhtmltopdf`]: https://wkhtmltopdf.org
200[`xcolor`]: https://ctan.org/pkg/xcolor
201[`xecjk`]: https://ctan.org/pkg/xecjk
202[`xurl`]: https://ctan.org/pkg/xurl
203[`selnolig`]: https://ctan.org/pkg/selnolig
207## Reading from the Web
209Instead of an input file, an absolute URI may be given. In this case
210pandoc will fetch the content using HTTP:
212 pandoc -f html -t markdown https://www.fsf.org
214It is possible to supply a custom User-Agent string or other
215header when requesting a document from a URL:
217 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
222## General options {.options}
224`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
226: Specify input format. *FORMAT* can be:
229 - `bibtex` ([BibTeX] bibliography)
230 - `biblatex` ([BibLaTeX] bibliography)
231 - `commonmark` ([CommonMark] Markdown)
232 - `commonmark_x` ([CommonMark] Markdown with extensions)
233 - `creole` ([Creole 1.0])
234 - `csljson` ([CSL JSON] bibliography)
235 - `csv` ([CSV] table)
236 - `docbook` ([DocBook])
237 - `docx` ([Word docx])
238 - `dokuwiki` ([DokuWiki markup])
240 - `fb2` ([FictionBook2] e-book)
241 - `gfm` ([GitHub-Flavored Markdown]),
242 or the deprecated and less accurate `markdown_github`;
243 use [`markdown_github`](#markdown-variants) only
244 if you need extensions not supported in [`gfm`](#markdown-variants).
245 - `haddock` ([Haddock markup])
247 - `ipynb` ([Jupyter notebook])
248 - `jats` ([JATS] XML)
249 - `jira` ([Jira]/Confluence wiki markup)
250 - `json` (JSON version of native AST)
252 - `markdown` ([Pandoc's Markdown])
253 - `markdown_mmd` ([MultiMarkdown])
254 - `markdown_phpextra` ([PHP Markdown Extra])
255 - `markdown_strict` (original unextended [Markdown])
256 - `mediawiki` ([MediaWiki markup])
259 - `native` (native Haskell)
262 - `org` ([Emacs Org mode])
263 - `rst` ([reStructuredText])
265 - `textile` ([Textile])
266 - `tikiwiki` ([TikiWiki markup])
267 - `twiki` ([TWiki markup])
268 - `vimwiki` ([Vimwiki])
271 Extensions can be individually enabled or disabled by
272 appending `+EXTENSION` or `-EXTENSION` to the format name.
273 See [Extensions] below, for a list of extensions and
274 their names. See `--list-input-formats` and `--list-extensions`,
277`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
279: Specify output format. *FORMAT* can be:
281 ::: {#output-formats}
282 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283 - `beamer` ([LaTeX beamer][`beamer`] slide show)
284 - `bibtex` ([BibTeX] bibliography)
285 - `biblatex` ([BibLaTeX] bibliography)
286 - `commonmark` ([CommonMark] Markdown)
287 - `commonmark_x` ([CommonMark] Markdown with extensions)
288 - `context` ([ConTeXt])
289 - `csljson` ([CSL JSON] bibliography)
290 - `docbook` or `docbook4` ([DocBook] 4)
291 - `docbook5` (DocBook 5)
292 - `docx` ([Word docx])
293 - `dokuwiki` ([DokuWiki markup])
294 - `epub` or `epub3` ([EPUB] v3 book)
296 - `fb2` ([FictionBook2] e-book)
297 - `gfm` ([GitHub-Flavored Markdown]),
298 or the deprecated and less accurate `markdown_github`;
299 use [`markdown_github`](#markdown-variants) only
300 if you need extensions not supported in [`gfm`](#markdown-variants).
301 - `haddock` ([Haddock markup])
302 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
303 - `html4` ([XHTML] 1.0 Transitional)
304 - `icml` ([InDesign ICML])
305 - `ipynb` ([Jupyter notebook])
306 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
307 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
308 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
309 - `jats` (alias for `jats_archiving`)
310 - `jira` ([Jira]/Confluence wiki markup)
311 - `json` (JSON version of native AST)
314 - `markdown` ([Pandoc's Markdown])
315 - `markdown_mmd` ([MultiMarkdown])
316 - `markdown_phpextra` ([PHP Markdown Extra])
317 - `markdown_strict` (original unextended [Markdown])
318 - `mediawiki` ([MediaWiki markup])
321 - `native` (native Haskell),
322 - `odt` ([OpenOffice text document][ODT])
324 - `opendocument` ([OpenDocument])
325 - `org` ([Emacs Org mode])
327 - `plain` (plain text),
328 - `pptx` ([PowerPoint] slide show)
329 - `rst` ([reStructuredText])
330 - `rtf` ([Rich Text Format])
331 - `texinfo` ([GNU Texinfo])
332 - `textile` ([Textile])
333 - `slideous` ([Slideous] HTML and JavaScript slide show)
334 - `slidy` ([Slidy] HTML and JavaScript slide show)
335 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
336 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
337 - `s5` ([S5] HTML and JavaScript slide show)
338 - `tei` ([TEI Simple])
339 - `xwiki` ([XWiki markup])
340 - `zimwiki` ([ZimWiki markup])
341 - the path of a custom Lua writer, see [Custom writers] below
344 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
345 to *stdout* unless forced with `-o -`.
347 Extensions can be individually enabled or
348 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
349 name. See [Extensions] below, for a list of extensions and their
350 names. See `--list-output-formats` and `--list-extensions`, below.
352`-o` *FILE*, `--output=`*FILE*
354: Write output to *FILE* instead of *stdout*. If *FILE* is
355 `-`, output will go to *stdout*, even if a non-textual format
356 (`docx`, `odt`, `epub2`, `epub3`) is specified.
358`--data-dir=`*DIRECTORY*
360: Specify the user data directory to search for pandoc data files.
361 If this option is not specified, the default user data directory
362 will be used. On \*nix and macOS systems this will be the `pandoc`
363 subdirectory of the XDG data directory (by default,
364 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
365 environment variable). If that directory does not exist,
366 `$HOME/.pandoc` will be used (for backwards compatibility).
367 In Windows the default user data directory is
368 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
369 You can find the default user data directory on your system by
370 looking at the output of `pandoc --version`.
371 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
372 `slidy`, `slideous`, or `s5` directory
373 placed in this directory will override pandoc's normal defaults.
375`-d` *FILE*, `--defaults=`*FILE*
377: Specify a set of default option settings. *FILE* is a YAML
378 file whose fields correspond to command-line option
379 settings. All options for document conversion, including input
380 and output files, can be set using a defaults file. The file will
381 be searched for first in the working directory, and then in
382 the `defaults` subdirectory of the user data directory
383 (see `--data-dir`). The `.yaml` extension may be omitted.
384 See the section [Default files] for more information on the
385 file format. Settings from the defaults file may be
386 overridden or extended by subsequent options on the command
391: Generate a bash completion script. To enable bash completion
392 with pandoc, add this to your `.bashrc`:
394 eval "$(pandoc --bash-completion)"
398: Give verbose debugging output.
402: Suppress warning messages.
406: Exit with error status if there are any warnings.
410: Write log messages in machine-readable JSON format to
411 *FILE*. All messages above DEBUG level will be written,
412 regardless of verbosity settings (`--verbose`, `--quiet`).
414`--list-input-formats`
416: List supported input formats, one per line.
418`--list-output-formats`
420: List supported output formats, one per line.
422`--list-extensions`[`=`*FORMAT*]
424: List supported extensions for *FORMAT*, one per line, preceded
425 by a `+` or `-` indicating whether it is enabled by default
426 in *FORMAT*. If *FORMAT* is not specified, defaults for
427 pandoc's Markdown are given.
429`--list-highlight-languages`
431: List supported languages for syntax highlighting, one per
434`--list-highlight-styles`
436: List supported styles for syntax highlighting, one per line.
437 See `--highlight-style`.
447[Markdown]: https://daringfireball.net/projects/markdown/
448[CommonMark]: https://commonmark.org
449[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
450[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
451[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
452[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
453[S5]: https://meyerweb.com/eric/tools/s5/
454[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
455[Slideous]: https://goessner.net/articles/slideous/
456[HTML]: https://www.w3.org/html/
457[HTML5]: https://html.spec.whatwg.org/
458[polyglot markup]: https://www.w3.org/TR/html-polyglot/
459[XHTML]: https://www.w3.org/TR/xhtml1/
460[LaTeX]: https://www.latex-project.org/
461[`beamer`]: https://ctan.org/pkg/beamer
462[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
463[ConTeXt]: https://www.contextgarden.net/
464[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
465[DocBook]: https://docbook.org
466[JATS]: https://jats.nlm.nih.gov
467[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
468[txt2tags]: https://txt2tags.org
469[EPUB]: http://idpf.org/epub
470[OPML]: http://dev.opml.org/spec2.html
471[OpenDocument]: http://opendocument.xml.org
472[ODT]: https://en.wikipedia.org/wiki/OpenDocument
473[Textile]: https://www.promptworks.com/textile
474[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
475[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
476[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
477[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
478[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
479[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
480[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
481[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
482[CSV]: https://tools.ietf.org/html/rfc4180
483[roff man]: https://man.cx/groff_man(7)
484[roff ms]: https://man.cx/groff_ms(7)
485[Haskell]: https://www.haskell.org
486[GNU Texinfo]: https://www.gnu.org/software/texinfo/
487[Emacs Org mode]: https://orgmode.org
488[AsciiDoc]: https://www.methods.co.nz/asciidoc/
489[AsciiDoctor]: https://asciidoctor.org/
490[DZSlides]: http://paulrouget.com/dzslides/
491[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
492[PDF]: https://www.adobe.com/pdf/
493[reveal.js]: https://revealjs.com/
494[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
495[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
496[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
497[TEI Simple]: https://github.com/TEIC/TEI-Simple
498[Muse]: https://amusewiki.org/library/manual
499[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
500[Vimwiki]: https://vimwiki.github.io
501[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
502[BibTeX]: https://ctan.org/pkg/bibtex
503[BibLaTeX]: https://ctan.org/pkg/biblatex
505## Reader options {.options}
507`--shift-heading-level-by=`*NUMBER*
509: Shift heading levels by a positive or negative integer.
510 For example, with `--shift-heading-level-by=-1`, level 2
511 headings become level 1 headings, and level 3 headings
512 become level 2 headings. Headings cannot have a level
513 less than 1, so a heading that would be shifted below level 1
514 becomes a regular paragraph. Exception: with a shift of -N,
515 a level-N heading at the beginning of the document
516 replaces the metadata title. `--shift-heading-level-by=-1`
517 is a good choice when converting HTML or Markdown documents that
518 use an initial level-1 heading for the document title and
519 level-2+ headings for sections. `--shift-heading-level-by=1`
520 may be a good choice for converting Markdown documents that
521 use level-1 headings for sections to HTML, since pandoc uses
522 a level-1 heading to render the document title.
524`--base-header-level=`*NUMBER*
526: *Deprecated. Use `--shift-heading-level-by`=X instead,
527 where X = NUMBER - 1.* Specify the base level for headings
530`--strip-empty-paragraphs`
532: *Deprecated. Use the `+empty_paragraphs` extension instead.*
533 Ignore paragraphs with no content. This option is useful
534 for converting word processing documents where users have
535 used empty paragraphs to create inter-paragraph space.
537`--indented-code-classes=`*CLASSES*
539: Specify classes to use for indented code blocks--for example,
540 `perl,numberLines` or `haskell`. Multiple classes may be separated
543`--default-image-extension=`*EXTENSION*
545: Specify a default extension to use when image paths/URLs have no
546 extension. This allows you to use the same source for formats that
547 require different kinds of images. Currently this option only affects
548 the Markdown and LaTeX readers.
552: Parse each file individually before combining for multifile
553 documents. This will allow footnotes in different files with the
554 same identifiers to work as expected. If this option is set,
555 footnotes and links will not work across files. Reading binary
556 files (docx, odt, epub) implies `--file-scope`.
558`-F` *PROGRAM*, `--filter=`*PROGRAM*
560: Specify an executable to be used as a filter transforming the
561 pandoc AST after the input is parsed and before the output is
562 written. The executable should read JSON from stdin and write
563 JSON to stdout. The JSON must be formatted like pandoc's own
564 JSON input and output. The name of the output format will be
565 passed to the filter as the first argument. Hence,
567 pandoc --filter ./caps.py -t latex
571 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
573 The latter form may be useful for debugging filters.
575 Filters may be written in any language. `Text.Pandoc.JSON`
576 exports `toJSONFilter` to facilitate writing filters in Haskell.
577 Those who would prefer to write filters in python can use the
578 module [`pandocfilters`], installable from PyPI. There are also
579 pandoc filter libraries in [PHP], [perl], and
580 [JavaScript/node.js].
582 In order of preference, pandoc will look for filters in
584 1. a specified full or relative path (executable or
587 2. `$DATADIR/filters` (executable or non-executable)
588 where `$DATADIR` is the user data directory (see
589 `--data-dir`, above).
591 3. `$PATH` (executable only)
593 Filters, Lua-filters, and citeproc processing are applied in
594 the order specified on the command line.
596`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
598: Transform the document in a similar fashion as JSON filters (see
599 `--filter`), but use pandoc's built-in Lua filtering system. The given
600 Lua script is expected to return a list of Lua filters which will be
601 applied in order. Each Lua filter must contain element-transforming
602 functions indexed by the name of the AST element on which the filter
603 function should be applied.
605 The `pandoc` Lua module provides helper functions for element
606 creation. It is always loaded into the script's Lua environment.
608 See the [Lua filters documentation] for further details.
610 In order of preference, pandoc will look for Lua filters in
612 1. a specified full or relative path
614 2. `$DATADIR/filters` where `$DATADIR` is the user data
615 directory (see `--data-dir`, above).
617 Filters, Lua filters, and citeproc processing are applied in
618 the order specified on the command line.
620`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
622: Set the metadata field *KEY* to the value *VAL*. A value specified
623 on the command line overrides a value specified in the document
624 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
625 Values will be parsed as YAML boolean or string values. If no value is
626 specified, the value will be treated as Boolean true. Like
627 `--variable`, `--metadata` causes template variables to be set.
628 But unlike `--variable`, `--metadata` affects the metadata of the
629 underlying document (which is accessible from filters and may be
630 printed in some output formats) and metadata values will be escaped
631 when inserted into the template.
633`--metadata-file=`*FILE*
635: Read metadata from the supplied YAML (or JSON) file. This
636 option can be used with every input format, but string scalars
637 in the YAML file will always be parsed as Markdown. Generally,
638 the input will be handled the same as in [YAML metadata
639 blocks][Extension: `yaml_metadata_block`]. This option can be
640 used repeatedly to include multiple metadata files; values in
641 files specified later on the command line will be preferred
642 over those specified in earlier files. Metadata values
643 specified inside the document, or by using `-M`, overwrite
644 values specified with this option.
646`-p`, `--preserve-tabs`
648: Preserve tabs instead of converting them to spaces. (By default, pandoc
649 converts tabs to spaces before parsing its input.) Note that this will
650 only affect tabs in literal code spans and code blocks. Tabs in regular
651 text are always treated as spaces.
655: Specify the number of spaces per tab (default is 4).
657`--track-changes=accept`|`reject`|`all`
659: Specifies what to do with insertions, deletions, and comments
660 produced by the MS Word "Track Changes" feature. `accept` (the
661 default) processes all the insertions and deletions.
662 `reject` ignores them. Both `accept` and `reject` ignore comments.
663 `all` includes all insertions, deletions, and comments, wrapped
664 in spans with `insertion`, `deletion`, `comment-start`, and
665 `comment-end` classes, respectively. The author and time of
666 change is included. `all` is useful for scripting: only
667 accepting changes from a certain reviewer, say, or before a
668 certain date. If a paragraph is inserted or deleted,
669 `track-changes=all` produces a span with the class
670 `paragraph-insertion`/`paragraph-deletion` before the
671 affected paragraph break. This option only affects the docx
674`--extract-media=`*DIR*
676: Extract images and other media contained in or linked from
677 the source document to the path *DIR*, creating it if
678 necessary, and adjust the images references in the document
679 so they point to the extracted files. If the source format is
680 a binary container (docx, epub, or odt), the media is
681 extracted from the container and the original
682 filenames are used. Otherwise the media is read from the
683 file system or downloaded, and new filenames are constructed
684 based on SHA1 hashes of the contents.
686`--abbreviations=`*FILE*
688: Specifies a custom abbreviations file, with abbreviations
689 one to a line. If this option is not specified, pandoc will
690 read the data file `abbreviations` from the user data
691 directory or fall back on a system default. To see the
693 `pandoc --print-default-data-file=abbreviations`. The only
694 use pandoc makes of this list is in the Markdown reader.
695 Strings ending in a period that are found in this list will
696 be followed by a nonbreaking space, so that the period will
697 not produce sentence-ending space in formats like LaTeX.
699[`pandocfilters`]: https://github.com/jgm/pandocfilters
700[PHP]: https://github.com/vinai/pandocfilters-php
701[perl]: https://metacpan.org/pod/Pandoc::Filter
702[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
703[Lua filters documentation]: https://pandoc.org/lua-filters.html
705## General writer options {.options}
709: Produce output with an appropriate header and footer (e.g. a
710 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
711 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
712 output. For `native` output, this option causes metadata to
713 be included; otherwise, metadata is suppressed.
715`--template=`*FILE*|*URL*
717: Use the specified file as a custom template for the generated document.
718 Implies `--standalone`. See [Templates], below, for a description
719 of template syntax. If no extension is specified, an extension
720 corresponding to the writer will be added, so that `--template=special`
721 looks for `special.html` for HTML output. If the template is not
722 found, pandoc will search for it in the `templates` subdirectory of
723 the user data directory (see `--data-dir`). If this option is not used,
724 a default template appropriate for the output format will be used (see
725 `-D/--print-default-template`).
727`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
729: Set the template variable *KEY* to the value *VAL* when rendering the
730 document in standalone mode. If no *VAL* is specified, the
731 key will be given the value `true`.
733`-D` *FORMAT*, `--print-default-template=`*FORMAT*
735: Print the system default template for an output *FORMAT*. (See `-t`
736 for a list of possible *FORMAT*s.) Templates in the user data
737 directory are ignored. This option may be used with
738 `-o`/`--output` to redirect output to a file, but
739 `-o`/`--output` must come before `--print-default-template`
742 Note that some of the default templates use partials, for
743 example `styles.html`. To print the partials, use
744 `--print-default-data-file`: for example,
745 `--print-default-data-file=templates/styles.html`.
747`--print-default-data-file=`*FILE*
749: Print a system default data file. Files in the user data directory
750 are ignored. This option may be used with `-o`/`--output` to
751 redirect output to a file, but `-o`/`--output` must come before
752 `--print-default-data-file` on the command line.
754`--eol=crlf`|`lf`|`native`
756: Manually specify line endings: `crlf` (Windows), `lf`
757 (macOS/Linux/UNIX), or `native` (line endings appropriate
758 to the OS on which pandoc is being run). The default is
763: Specify the default dpi (dots per inch) value for conversion
764 from pixels to inch/centimeters and vice versa. (Technically,
765 the correct term would be ppi: pixels per inch.) The default
766 is 96dpi. When images contain information about dpi
767 internally, the encoded value is used instead of the default
768 specified by this option.
770`--wrap=auto`|`none`|`preserve`
772: Determine how text is wrapped in the output (the source
773 code, not the rendered version). With `auto` (the default),
774 pandoc will attempt to wrap lines to the column width specified by
775 `--columns` (default 72). With `none`, pandoc will not wrap
776 lines at all. With `preserve`, pandoc will attempt to
777 preserve the wrapping from the source document (that is,
778 where there are nonsemantic newlines in the source, there
779 will be nonsemantic newlines in the output as well).
780 Automatic wrapping does not currently work in HTML output.
781 In `ipynb` output, this option affects wrapping of the
782 contents of markdown cells.
786: Specify length of lines in characters. This affects text wrapping
787 in the generated source code (see `--wrap`). It also affects
788 calculation of column widths for plain text tables (see [Tables] below).
790`--toc`, `--table-of-contents`
792: Include an automatically generated table of contents (or, in
793 the case of `latex`, `context`, `docx`, `odt`,
794 `opendocument`, `rst`, or `ms`, an instruction to create
795 one) in the output document. This option has no effect
796 unless `-s/--standalone` is used, and it has no effect
797 on `man`, `docbook4`, `docbook5`, or `jats` output.
799 Note that if you are producing a PDF via `ms`, the table
800 of contents will appear at the beginning of the
801 document, before the title. If you would prefer it to
802 be at the end of the document, use the option
803 `--pdf-engine-opt=--no-toc-relocation`.
805`--toc-depth=`*NUMBER*
807: Specify the number of section levels to include in the table
808 of contents. The default is 3 (which means that level-1, 2, and 3
809 headings will be listed in the contents).
813: Strip out HTML comments in the Markdown or Textile source,
814 rather than passing them on to Markdown, Textile or HTML
815 output as raw HTML. This does not apply to HTML comments
816 inside raw HTML blocks when the `markdown_in_html_blocks`
817 extension is not set.
821: Disables syntax highlighting for code blocks and inlines, even when
822 a language attribute is given.
824`--highlight-style=`*STYLE*|*FILE*
826: Specifies the coloring style to be used in highlighted source code.
827 Options are `pygments` (the default), `kate`, `monochrome`,
828 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
829 For more information on syntax highlighting in pandoc, see
830 [Syntax highlighting], below. See also
831 `--list-highlight-styles`.
833 Instead of a *STYLE* name, a JSON file with extension
834 `.theme` may be supplied. This will be parsed as a KDE
835 syntax highlighting theme and (if valid) used as the
838 To generate the JSON version of an existing style,
839 use `--print-highlight-style`.
841`--print-highlight-style=`*STYLE*|*FILE*
843: Prints a JSON version of a highlighting style, which can
844 be modified, saved with a `.theme` extension, and used
845 with `--highlight-style`. This option may be used with
846 `-o`/`--output` to redirect output to a file, but
847 `-o`/`--output` must come before `--print-highlight-style`
850`--syntax-definition=`*FILE*
852: Instructs pandoc to load a KDE XML syntax definition file,
853 which will be used for syntax highlighting of appropriately
854 marked code blocks. This can be used to add support for
855 new languages or to use altered syntax definitions for
856 existing languages. This option may be repeated to add
857 multiple syntax definitions.
859`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
861: Include contents of *FILE*, verbatim, at the end of the header.
862 This can be used, for example, to include special
863 CSS or JavaScript in HTML documents. This option can be used
864 repeatedly to include multiple files in the header. They will be
865 included in the order specified. Implies `--standalone`.
867`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
869: Include contents of *FILE*, verbatim, at the beginning of the
870 document body (e.g. after the `<body>` tag in HTML, or the
871 `\begin{document}` command in LaTeX). This can be used to include
872 navigation bars or banners in HTML documents. This option can be
873 used repeatedly to include multiple files. They will be included in
874 the order specified. Implies `--standalone`.
876`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
878: Include contents of *FILE*, verbatim, at the end of the document
879 body (before the `</body>` tag in HTML, or the
880 `\end{document}` command in LaTeX). This option can be used
881 repeatedly to include multiple files. They will be included in the
882 order specified. Implies `--standalone`.
884`--resource-path=`*SEARCHPATH*
886: List of paths to search for images and other resources.
887 The paths should be separated by `:` on Linux, UNIX, and
888 macOS systems, and by `;` on Windows. If `--resource-path`
889 is not specified, the default resource path is the working
890 directory. Note that, if `--resource-path` is specified,
891 the working directory must be explicitly listed or it
892 will not be searched. For example:
893 `--resource-path=.:test` will search the working directory
894 and the `test` subdirectory, in that order.
896`--request-header=`*NAME*`:`*VAL*
898: Set the request header *NAME* to the value *VAL* when making
899 HTTP requests (for example, when a URL is given on the
900 command line, or when resources used in a document must be
901 downloaded). If you're behind a proxy, you also need to set
902 the environment variable `http_proxy` to `http://...`.
904`--no-check-certificate`
906: Disable the certificate verification to allow access to
907 unsecure HTTP resources (for example when the certificate
908 is no longer valid or self signed).
910## Options affecting specific writers {.options}
914: Produce a standalone HTML file with no external dependencies, using
915 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
916 images, and videos. Implies `--standalone`. The resulting file should be
917 "self-contained," in the sense that it needs no external files and no net
918 access to be displayed properly by a browser. This option works only with
919 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
920 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
921 and stylesheets at absolute URLs will be downloaded; those at relative
922 URLs will be sought relative to the working directory (if the first source
923 file is local) or relative to the base URL (if the first source
924 file is remote). Elements with the attribute
925 `data-external="1"` will be left alone; the documents they
926 link to will not be incorporated in the document.
927 Limitation: resources that are loaded dynamically through
928 JavaScript cannot be incorporated; as a result,
929 `--self-contained` does not work with `--mathjax`, and some
930 advanced features (e.g. zoom or speaker notes) may not work
931 in an offline "self-contained" `reveal.js` slide show.
935: Use `<q>` tags for quotes in HTML. (This option only has an
936 effect if the `smart` extension is enabled for the input
941: Use only ASCII characters in output. Currently supported for XML
942 and HTML formats (which use entities instead of UTF-8 when this
943 option is selected), CommonMark, gfm, and Markdown (which use
944 entities), roff ms (which use hexadecimal escapes), and to a
945 limited degree LaTeX (which uses standard commands for accented
946 characters when possible). roff man output uses ASCII by default.
950: Use reference-style links, rather than inline links, in writing Markdown
951 or reStructuredText. By default inline links are used. The
952 placement of link references is affected by the
953 `--reference-location` option.
955`--reference-location=block`|`section`|`document`
957: Specify whether footnotes (and references, if `reference-links` is
958 set) are placed at the end of the current (top-level) block, the
959 current section, or the document. The default is
960 `document`. Currently only affects the markdown writer.
962`--markdown-headings=setext`|`atx`
964: Specify whether to use ATX-style (`#`-prefixed) or
965 Setext-style (underlined) headings for level 1 and 2
966 headings in Markdown output. (The default is `atx`.)
967 ATX-style headings are always used for levels 3+.
968 This option also affects Markdown cells in `ipynb` output.
972: *Deprecated synonym for `--markdown-headings=atx`.*
974`--top-level-division=default`|`section`|`chapter`|`part`
976: Treat top-level headings as the given division type in
977 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
978 order is part, chapter, then section; all headings are
979 shifted such that the top-level heading becomes the
980 specified type. The default behavior is to determine the
981 best division type via heuristics: unless other conditions
982 apply, `section` is chosen. When the `documentclass`
983 variable is set to `report`, `book`, or `memoir` (unless the
984 `article` option is specified), `chapter` is implied as the
985 setting for this option. If `beamer` is the output format,
986 specifying either `chapter` or `part` will cause top-level
987 headings to become `\part{..}`, while second-level headings
988 remain as their default type.
990`-N`, `--number-sections`
992: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
993 output. By default, sections are not numbered. Sections with class
994 `unnumbered` will never be numbered, even if `--number-sections`
997`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
999: Offset for section headings in HTML output (ignored in other
1000 output formats). The first number is added to the section number for
1001 top-level headings, the second for second-level headings, and so on.
1002 So, for example, if you want the first top-level heading in your
1003 document to be numbered "6", specify `--number-offset=5`.
1004 If your document starts with a level-2 heading which you want to
1005 be numbered "1.5", specify `--number-offset=1,4`.
1006 Offsets are 0 by default. Implies `--number-sections`.
1010: Use the [`listings`] package for LaTeX code blocks. The package
1011 does not support multi-byte encoding for source code. To handle UTF-8
1012 you would need to use a custom template. This issue is fully
1013 documented here: [Encoding issue with the listings package].
1015`-i`, `--incremental`
1017: Make list items in slide shows display incrementally (one by one).
1018 The default is for lists to be displayed all at once.
1020`--slide-level=`*NUMBER*
1022: Specifies that headings with the specified level create
1023 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1024 above this level in the hierarchy are used to divide the
1025 slide show into sections; headings below this level create
1026 subheads within a slide. Note that content that is
1027 not contained under slide-level headings will not appear in
1028 the slide show. The default is to set the slide level based
1029 on the contents of the document; see [Structuring the slide
1034: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1035 and attach identifiers to the enclosing `<section>` (or `<div>`)
1036 rather than the heading itself. See
1037 [Heading identifiers], below.
1039`--email-obfuscation=none`|`javascript`|`references`
1041: Specify a method for obfuscating `mailto:` links in HTML documents.
1042 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1043 them using JavaScript. `references` obfuscates them by printing their
1044 letters as decimal or hexadecimal character references. The default
1047`--id-prefix=`*STRING*
1049: Specify a prefix to be added to all identifiers and internal links
1050 in HTML and DocBook output, and to footnote numbers in Markdown
1051 and Haddock output. This is useful for preventing duplicate
1052 identifiers when generating fragments to be included in other pages.
1054`-T` *STRING*, `--title-prefix=`*STRING*
1056: Specify *STRING* as a prefix at the beginning of the title
1057 that appears in the HTML header (but not in the title as it
1058 appears at the beginning of the HTML body). Implies `--standalone`.
1060`-c` *URL*, `--css=`*URL*
1062: Link to a CSS style sheet. This option can be used repeatedly to
1063 include multiple files. They will be included in the order specified.
1065 A stylesheet is required for generating EPUB. If none is
1066 provided using this option (or the `css` or `stylesheet`
1067 metadata fields), pandoc will look for a file `epub.css` in the
1068 user data directory (see `--data-dir`). If it is not
1069 found there, sensible defaults will be used.
1071`--reference-doc=`*FILE*
1073: Use the specified file as a style reference in producing a
1078 : For best results, the reference docx should be a modified
1079 version of a docx file produced using pandoc. The contents
1080 of the reference docx are ignored, but its stylesheets and
1081 document properties (including margins, page size, header,
1082 and footer) are used in the new docx. If no reference docx
1083 is specified on the command line, pandoc will look for a
1084 file `reference.docx` in the user data directory (see
1085 `--data-dir`). If this is not found either, sensible
1086 defaults will be used.
1088 To produce a custom `reference.docx`, first get a copy of
1089 the default `reference.docx`: `pandoc
1090 -o custom-reference.docx --print-default-data-file reference.docx`.
1091 Then open `custom-reference.docx` in Word, modify the
1092 styles as you wish, and save the file. For best
1093 results, do not make changes to this file other than
1094 modifying the styles used by pandoc:
1130 - Default Paragraph Font
1133 - Footnote Reference
1143 : For best results, the reference ODT should be a modified
1144 version of an ODT produced using pandoc. The contents of
1145 the reference ODT are ignored, but its stylesheets are used
1146 in the new ODT. If no reference ODT is specified on the
1147 command line, pandoc will look for a file `reference.odt` in
1148 the user data directory (see `--data-dir`). If this is not
1149 found either, sensible defaults will be used.
1151 To produce a custom `reference.odt`, first get a copy of
1152 the default `reference.odt`: `pandoc
1153 -o custom-reference.odt --print-default-data-file reference.odt`.
1154 Then open `custom-reference.odt` in LibreOffice, modify
1155 the styles as you wish, and save the file.
1159 : Templates included with Microsoft PowerPoint 2013 (either with
1160 `.pptx` or `.potx` extension) are known to work, as are most
1161 templates derived from these.
1163 The specific requirement is that the template should begin with
1164 the following first four layouts:
1167 2. Title and Content
1171 All templates included with a recent version of MS PowerPoint
1172 will fit these criteria. (You can click on `Layout` under the
1173 `Home` menu to check.)
1175 You can also modify the default `reference.pptx`: first run
1176 `pandoc -o custom-reference.pptx --print-default-data-file
1177 reference.pptx`, and then modify `custom-reference.pptx`
1178 in MS PowerPoint (pandoc will use the first four layout
1179 slides, as mentioned above).
1181`--epub-cover-image=`*FILE*
1183: Use the specified image as the EPUB cover. It is recommended
1184 that the image be less than 1000px in width and height. Note that
1185 in a Markdown source document you can also specify `cover-image`
1186 in a YAML metadata block (see [EPUB Metadata], below).
1188`--epub-metadata=`*FILE*
1190: Look in the specified XML file for metadata for the EPUB.
1191 The file should contain a series of [Dublin Core elements].
1194 <dc:rights>Creative Commons</dc:rights>
1195 <dc:language>es-AR</dc:language>
1197 By default, pandoc will include the following metadata elements:
1198 `<dc:title>` (from the document title), `<dc:creator>` (from the
1199 document authors), `<dc:date>` (from the document date, which should
1200 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1201 variable, or, if is not set, the locale), and `<dc:identifier
1202 id="BookId">` (a randomly generated UUID). Any of these may be
1203 overridden by elements in the metadata file.
1205 Note: if the source document is Markdown, a YAML metadata block
1206 in the document can be used instead. See below under
1209`--epub-embed-font=`*FILE*
1211: Embed the specified font in the EPUB. This option can be repeated
1212 to embed multiple fonts. Wildcards can also be used: for example,
1213 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1214 line, be sure to escape them or put the whole filename in single quotes,
1215 to prevent them from being interpreted by the shell. To use the
1216 embedded fonts, you will need to add declarations like the following
1217 to your CSS (see `--css`):
1220 font-family: DejaVuSans;
1222 font-weight: normal;
1223 src:url("DejaVuSans-Regular.ttf");
1226 font-family: DejaVuSans;
1229 src:url("DejaVuSans-Bold.ttf");
1232 font-family: DejaVuSans;
1234 font-weight: normal;
1235 src:url("DejaVuSans-Oblique.ttf");
1238 font-family: DejaVuSans;
1241 src:url("DejaVuSans-BoldOblique.ttf");
1243 body { font-family: "DejaVuSans"; }
1245`--epub-chapter-level=`*NUMBER*
1247: Specify the heading level at which to split the EPUB into separate
1248 "chapter" files. The default is to split into chapters at level-1
1249 headings. This option only affects the internal composition of the
1250 EPUB, not the way chapters and sections are displayed to users. Some
1251 readers may be slow if the chapter files are too large, so for large
1252 documents with few level-1 headings, one might want to use a chapter
1255`--epub-subdirectory=`*DIRNAME*
1257: Specify the subdirectory in the OCF container that is to hold
1258 the EPUB-specific contents. The default is `EPUB`. To put
1259 the EPUB contents in the top level, use an empty string.
1261`--ipynb-output=all|none|best`
1263: Determines how ipynb output cells are treated. `all` means
1264 that all of the data formats included in the original are
1265 preserved. `none` means that the contents of data cells
1266 are omitted. `best` causes pandoc to try to pick the
1267 richest data block in each output cell that is compatible
1268 with the output format. The default is `best`.
1270`--pdf-engine=`*PROGRAM*
1272: Use the specified engine when producing PDF output.
1273 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1274 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1275 and `pdfroff`. If the engine is not in your PATH, the full
1276 path of the engine may be specified here. If this option
1277 is not specified, pandoc uses the following defaults
1278 depending on the output format specified using `-t/--to`:
1280 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1281 `tectonic`, `latexmk`)
1282 - `-t context`: `context`
1283 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1284 see [print-css.rocks](https://print-css.rocks) for a good
1285 introduction to PDF generation from HTML/CSS.)
1286 - `-t ms`: `pdfroff`
1288`--pdf-engine-opt=`*STRING*
1290: Use the given string as a command-line argument to the `pdf-engine`.
1291 For example, to use a persistent directory `foo` for `latexmk`'s
1292 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1293 Note that no check for duplicate options is done.
1295[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1296[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1297[Encoding issue with the listings package]:
1298 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1300## Citation rendering {.options}
1304: Process the citations in the file, replacing them with
1305 rendered citations and adding a bibliography.
1306 Citation processing will not take place unless bibliographic
1307 data is supplied, either through an external file specified
1308 using the `--bibliography` option or the `bibliography`
1309 field in metadata, or via a `references` section in metadata
1310 containing a list of citations in CSL YAML format with
1311 Markdown formatting. The style is controlled by a [CSL]
1312 stylesheet specified using the `--csl` option or the `csl`
1313 field in metadata. (If no stylesheet is specified,
1314 the `chicago-author-date` style will be used by default.)
1315 The citation processing transformation may be applied before
1316 or after filters or Lua filters (see `--filter`,
1317 `--lua-filter`): these transformations are applied in the
1318 order they appear on the command line. For more
1319 information, see the section on [Citations].
1321`--bibliography=`*FILE*
1323: Set the `bibliography` field in the document's metadata to *FILE*,
1324 overriding any value set in the metadata. If you supply
1325 this argument multiple times, each *FILE* will be added to
1326 bibliography. If *FILE* is a URL, it will be fetched
1327 via HTTP. If *FILE* is not found relative to the
1328 working directory, it will be sought in the resource path
1329 (see `--resource-path`).
1333: Set the `csl` field in the document's metadata to *FILE*,
1334 overriding any value set in the metadata. (This is equivalent to
1335 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1336 fetched via HTTP. If *FILE* is not found relative to the
1337 working directory, it will be sought in the resource path
1338 (see `--resource-path`) and finally in the `csl`
1339 subdirectory of the pandoc user data directory.
1341`--citation-abbreviations=`*FILE*
1343: Set the `citation-abbreviations` field in the document's metadata to
1344 *FILE*, overriding any value set in the metadata. (This is equivalent to
1345 `--metadata citation-abbreviations=FILE`.)
1346 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1347 found relative to the working directory, it will be sought
1348 in the resource path (see `--resource-path`) and finally in
1349 the `csl` subdirectory of the pandoc user data directory.
1353: Use [`natbib`] for citations in LaTeX output. This option
1354 is not for use with the `--citeproc` option or with PDF
1355 output. It is intended for use in producing a LaTeX file
1356 that can be processed with [`bibtex`].
1360: Use [`biblatex`] for citations in LaTeX output. This option
1361 is not for use with the `--citeproc` option or with PDF
1362 output. It is intended for use in producing a LaTeX file
1363 that can be processed with [`bibtex`] or [`biber`].
1365## Math rendering in HTML {.options}
1367The default is to render TeX math as far as possible using
1368Unicode characters. Formulas are put inside a `span` with
1369`class="math"`, so that they may be styled differently from the
1370surrounding text if needed. However, this gives acceptable
1371results only for basic math, usually you will want to use
1372`--mathjax` or another of the following options.
1374`--mathjax`[`=`*URL*]
1376: Use [MathJax] to display embedded TeX math in HTML output.
1377 TeX math will be put between `\(...\)` (for inline math)
1378 or `\[...\]` (for display math) and wrapped in `<span>` tags
1379 with class `math`. Then the MathJax JavaScript will render it.
1380 The *URL* should point to the `MathJax.js` load script.
1381 If a *URL* is not provided, a link to the Cloudflare CDN will
1386: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1387 `docbook5`, `jats`, `html4` and `html5`). This is the
1388 default in `odt` output. Note that currently only Firefox
1389 and Safari (and select e-book readers) natively support
1394: Convert TeX formulas to `<img>` tags that link to an external script
1395 that converts formulas to images. The formula will be URL-encoded
1396 and concatenated with the URL provided. For SVG images you can for
1397 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1398 If no URL is specified, the CodeCogs URL generating PNGs
1399 will be used (`https://latex.codecogs.com/png.latex?`).
1400 Note: the `--webtex` option will affect Markdown output
1401 as well as HTML, which is useful if you're targeting a
1402 version of Markdown without native math support.
1406: Use [KaTeX] to display embedded TeX math in HTML output.
1407 The *URL* is the base URL for the KaTeX library. That directory
1408 should contain a `katex.min.js` and a `katex.min.css` file.
1409 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1413: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1414 can then be processed by [GladTeX] to produce images of the typeset
1415 formulas and an HTML file with links to these images.
1416 So, the procedure is:
1418 pandoc -s --gladtex input.md -o myfile.htex
1419 gladtex -d myfile-images myfile.htex
1420 # produces myfile.html and images in myfile-images
1422[MathML]: https://www.w3.org/Math/
1423[MathJax]: https://www.mathjax.org
1424[KaTeX]: https://github.com/Khan/KaTeX
1425[GladTeX]: https://humenda.github.io/GladTeX/
1427## Options for wrapper scripts {.options}
1431: Print information about command-line arguments to *stdout*, then exit.
1432 This option is intended primarily for use in wrapper scripts.
1433 The first line of output contains the name of the output file specified
1434 with the `-o` option, or `-` (for *stdout*) if no output file was
1435 specified. The remaining lines contain the command-line arguments,
1436 one per line, in the order they appear. These do not include regular
1437 pandoc options and their arguments, but do include any options appearing
1438 after a `--` separator at the end of the line.
1442: Ignore command-line arguments (for use in wrapper scripts).
1443 Regular pandoc options are not ignored. Thus, for example,
1445 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1449 pandoc -o foo.html -s
1453If pandoc completes successfully, it will return exit code 0.
1454Nonzero exit codes have the following meanings:
1457----- ------------------------------------
1458 3 PandocFailOnWarningError
1460 5 PandocTemplateError
1462 21 PandocUnknownReaderError
1463 22 PandocUnknownWriterError
1464 23 PandocUnsupportedExtensionError
1465 24 PandocCiteprocError
1466 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 97 PandocCouldNotFindDataFileError
1481 99 PandocResourceNotFound
1482----- ------------------------------------
1486The `--defaults` option may be used to specify a package
1487of options. Here is a sample defaults file demonstrating all of
1488the fields that may be used:
1492# reader: may be used instead of from:
1494# writer: may be used instead of to:
1496# leave blank for output to stdout:
1498# leave blank for input from stdin, use [] for no input:
1502# or you may use input-file: with a single value
1504# Include options from the specified defaults files.
1505# The files will be searched for first in the working directory
1506# and then in the defaults subdirectory of the user data directory.
1507# The files are included in the same order in which they appear in
1508# the list. Options specified in this defaults file always have
1509# priority over the included ones.
1516self-contained: false
1518# note that structured variables may be specified:
1525# metadata values specified here are parsed as literal
1526# string text, not markdown:
1533# or you may use metadata-file: with a single value
1535# Note that these take files, not their contents:
1536include-before-body: []
1537include-after-body: []
1538include-in-header: []
1541# turn on built-in citation processing. Note that if you need
1542# control over when the citeproc processing is done relative
1543# to other filters, you should instead use `citeproc` in the
1544# list of `filters` (see below).
1550citation-abbreviations: abbrevs.json
1552# Filters will be assumed to be Lua filters if they have
1553# the .lua extension, and json filters otherwise. But
1554# the filter type can also be specified explicitly, as shown.
1555# Filters are run in the order specified.
1556# To include the built-in citeproc filter, use either `citeproc`
1557# or `{type: citeproc}`.
1567# ERROR, WARNING, or INFO
1571# citeproc, natbib, or biblatex
1572cite-method: citeproc
1573# part, chapter, section, or default:
1574top-level-division: chapter
1580# you may also use pdf-engine-opt: with a single option
1581# pdf-engine-opt: "-shell-escape"
1583# auto, preserve, or none
1588extract-media: mediadir
1590table-of-contents: true
1592number-sections: false
1593# a list of offsets at each heading level
1594number-offset: [0,0,0,0,0,0]
1595# toc: may also be used instead of table-of-contents:
1596shift-heading-level-by: 1
1598identifier-prefix: foo
1600strip-empty-paragraphs: true
1601# lf, crlf, or native
1603strip-comments: false
1604indented-code-classes: []
1606default-image-extension: ".jpg"
1608# either a style name of a style definition file:
1609highlight-style: pygments
1612# or you may use syntax-definition: with a single value
1615reference-doc: myref.docx
1617# method is plain, webtex, gladtex, mathml, mathjax, katex
1618# you may specify a url with webtex, mathjax, katex
1621 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1622# none, references, or javascript
1623email-obfuscation: javascript
1631epub-subdirectory: EPUB
1632epub-metadata: meta.xml
1635epub-chapter-level: 1
1636epub-cover-image: cover.jpg
1638reference-links: true
1639# block, section, or document
1640reference-location: block
1641markdown-headings: setext
1643# accept, reject, or all
1644track-changes: accept
1653# A list of two-element lists
1655- ["User-Agent", "Mozilla/5.0"]
1657fail-if-warnings: false
1663Fields that are omitted will just have their regular
1664default values. So a defaults file can be as simple as
1671Default files can be placed in the `defaults` subdirectory of
1672the user data directory and used from any directory. For
1673example, one could create a file specifying defaults for writing
1674letters, save it as `letter.yaml` in the `defaults` subdirectory
1675of the user data directory, and then invoke these defaults
1676from any directory using `pandoc --defaults letter`
1677or `pandoc -dletter`.
1679When multiple defaults are used, their contents will be combined.
1681Note that, where command-line arguments may be repeated
1682(`--metadata-file`, `--css`, `--include-in-header`,
1683`--include-before-body`, `--include-after-body`, `--variable`,
1684`--metadata`, `--syntax-definition`), the values specified on
1685the command line will combine with values specified in the
1686defaults file, rather than replacing them.
1690When the `-s/--standalone` option is used, pandoc uses a template to
1691add header and footer material that is needed for a self-standing
1692document. To see the default template that is used, just type
1696where *FORMAT* is the name of the output format. A custom template
1697can be specified using the `--template` option. You can also override
1698the system default templates for a given output format *FORMAT*
1699by putting a file `templates/default.*FORMAT*` in the user data
1700directory (see `--data-dir`, above). *Exceptions:*
1702- For `odt` output, customize the `default.opendocument`
1704- For `pdf` output, customize the `default.latex` template
1705 (or the `default.context` template, if you use `-t context`,
1706 or the `default.ms` template, if you use `-t ms`, or the
1707 `default.html` template, if you use `-t html`).
1708- `docx` and `pptx` have no template (however, you can use
1709 `--reference-doc` to customize the output).
1711Templates contain *variables*, which allow for the inclusion of
1712arbitrary information at any point in the file. They may be set at the
1713command line using the `-V/--variable` option. If a variable is not set,
1714pandoc will look for the key in the document's metadata, which can be set
1715using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1716or with the `-M/--metadata` option. In addition, some variables
1717are given default values by pandoc. See [Variables] below for
1718a list of variables used in pandoc's default templates.
1720If you use custom templates, you may need to revise them as pandoc
1721changes. We recommend tracking the changes in the default templates,
1722and modifying your custom templates accordingly. An easy way to do this
1723is to fork the [pandoc-templates] repository and merge in
1724changes after each pandoc release.
1726 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1732Anything between the sequence `$--` and the end of the
1733line will be treated as a comment and omitted from the output.
1737To mark variables and control structures in the template,
1738either `$`...`$` or `${`...`}` may be used as delimiters.
1739The styles may also be mixed in the same template, but the
1740opening and closing delimiter must match in each case. The
1741opening delimiter may be followed by one or more spaces
1742or tabs, which will be ignored. The closing delimiter may
1743be followed by one or more spaces or tabs, which will be
1746To include a literal `$` in the document, use `$$`.
1748### Interpolated variables
1750A slot for an interpolated variable is a variable name surrounded
1751by matched delimiters. Variable names must begin with a letter
1752and can contain letters, numbers, `_`, `-`, and `.`. The
1753keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1754not be used as variable names. Examples:
1767Variable names with periods are used to get at structured
1768variable values. So, for example, `employee.salary` will return the
1769value of the `salary` field of the object that is the value of
1770the `employee` field.
1772- If the value of the variable is simple value, it will be
1773 rendered verbatim. (Note that no escaping is done;
1774 the assumption is that the calling program will escape
1775 the strings appropriately for the output format.)
1776- If the value is a list, the values will be concatenated.
1777- If the value is a map, the string `true` will be rendered.
1778- Every other value will be rendered as the empty string.
1782A conditional begins with `if(variable)` (enclosed in
1783matched delimiters) and ends with `endif` (enclosed in matched
1784delimiters). It may optionally contain an `else` (enclosed in
1785matched delimiters). The `if` section is used if
1786`variable` has a non-empty value, otherwise the `else`
1787section is used (if present). Examples:
1802${if(foo)}bar${endif}
1815The keyword `elseif` may be used to simplify complex nested
1830A for loop begins with `for(variable)` (enclosed in
1831matched delimiters) and ends with `endfor` (enclosed in matched
1834- If `variable` is an array, the material inside the loop will
1835 be evaluated repeatedly, with `variable` being set to each
1836 value of the array in turn, and concatenated.
1837- If `variable` is a map, the material inside will be set to
1839- If the value of the associated variable is not an array or
1840 a map, a single iteration will be performed on its value.
1845$for(foo)$$foo$$sep$, $endfor$
1848 - $foo.last$, $foo.first$
1852 - ${ foo.bar.last }, ${ foo.bar.first }
1856$it.name$: $it.office$
1860You may optionally specify a separator between consecutive
1861values using `sep` (enclosed in matched delimiters). The
1862material between `sep` and the `endfor` is the separator.
1865${ for(foo) }${ foo }${ sep }, ${ endfor }
1868Instead of using `variable` inside the loop, the special
1869anaphoric keyword `it` may be used.
1873 - ${ it.last }, ${ it.first }
1879Partials (subtemplates stored in different files) may be
1880included by using the name of the partial, followed
1881by `()`, for example:
1887Partials will be sought in the directory containing
1888the main template. The file name will be assumed to
1889have the same extension as the main template if it
1890lacks an extension. When calling the partial, the
1891full name including file extension can also be used:
1897(If a partial is not found in the directory of the
1898template, it will also be sought in the `templates`
1899subdirectory of the user data directory.)
1901Partials may optionally be applied to variables using
1907${ articles:bibentry() }
1910If `articles` is an array, this will iterate over its
1911values, applying the partial `bibentry()` to each one. So the
1912second example above is equivalent to
1920Note that the anaphoric keyword `it` must be used when
1921iterating over partials. In the above examples,
1922the `bibentry` partial should contain `it.title`
1923(and so on) instead of `articles.title`.
1925Final newlines are omitted from included partials.
1927Partials may include other partials.
1929A separator between values of an array may be specified
1930in square brackets, immediately after the variable name
1936${articles:bibentry()[; ]$
1939The separator in this case is literal and (unlike with `sep`
1940in an explicit `for` loop) cannot contain interpolated
1941variables or other template directives.
1945To ensure that content is "nested," that is, subsequent lines
1946indented, use the `^` directive:
1949$item.number$ $^$$item.description$ ($item.price$)
1952In this example, if `item.description` has multiple lines,
1953they will all be indented to line up with the first line:
195600123 A fine bottle of 18-year old
1957 Oban whiskey. ($148)
1960To nest multiple lines to the same level, align them
1961with the `^` directive in the template. For example:
1964$item.number$ $^$$item.description$ ($item.price$)
1965 (Available til $item.sellby$.)
197100123 A fine bottle of 18-year old
1972 Oban whiskey. ($148)
1973 (Available til March 30, 2020.)
1976If a variable occurs by itself on a line, preceded by whitespace
1977and not followed by further text or directives on the same line,
1978and the variable's value contains multiple lines, it will be
1979nested automatically.
1983Normally, spaces in the template itself (as opposed to values of
1984the interpolated variables) are not breakable, but they can be
1985made breakable in part of the template by using the `~` keyword
1986(ended with another `~`).
1989$~$This long line may break if the document is rendered
1990with a short line length.$~$
1995A pipe transforms the value of a variable or partial. Pipes are
1996specified using a slash (`/`) between the variable name (or partial)
1997and the pipe name. Example:
2004$for(metadata/pairs)$
2005- $it.key$: $it.value$
2008$employee:name()/uppercase$
2011Pipes may be chained:
2014$for(employees/pairs)$
2015$it.key/alpha/uppercase$. $it.name$
2019Some pipes take parameters:
2022|----------------------|------------|
2024$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2026|----------------------|------------|
2029Currently the following pipes are predefined:
2031- `pairs`: Converts a map or array to an array of maps,
2032 each with `key` and `value` fields. If the original
2033 value was an array, the `key` will be the array index,
2036- `uppercase`: Converts text to uppercase.
2038- `lowercase`: Converts text to lowercase.
2040- `length`: Returns the length of the value: number
2041 of characters for a textual value, number of elements
2044- `reverse`: Reverses a textual value or array,
2045 and has no effect on other values.
2047- `first`: Returns the first value of an array, if
2048 applied to a non-empty array; otherwise returns
2051- `last`: Returns the last value of an array, if
2052 applied to a non-empty array; otherwise returns
2055- `rest`: Returns all but the first value of an array, if
2056 applied to a non-empty array; otherwise returns
2059- `allbutlast`: Returns all but the last value of an array, if
2060 applied to a non-empty array; otherwise returns
2063- `chomp`: Removes trailing newlines (and breakable space).
2065- `nowrap`: Disables line wrapping on breakable spaces.
2067- `alpha`: Converts textual values that can be
2068 read as an integer into lowercase alphabetic
2069 characters `a..z` (mod 26). This can be used to get lettered
2070 enumeration from array indices. To get uppercase
2071 letters, chain with `uppercase`.
2073- `roman`: Converts textual values that can be
2074 read as an integer into lowercase roman numerials.
2075 This can be used to get lettered enumeration from array indices.
2076 To get uppercase roman, chain with `uppercase`.
2078- `left n "leftborder" "rightborder"`: Renders a textual value
2079 in a block of width `n`, aligned to the left, with an optional
2080 left and right border. Has no effect on other values. This
2081 can be used to align material in tables. Widths are positive
2082 integers indicating the number of characters. Borders
2083 are strings inside double quotes; literal `"` and `\` characters
2084 must be backslash-escaped.
2086- `right n "leftborder" "rightborder"`: Renders a textual value
2087 in a block of width `n`, aligned to the right, and has no
2088 effect on other values.
2090- `center n "leftborder" "rightborder"`: Renders a textual
2091 value in a block of width `n`, aligned to the center, and has
2092 no effect on other values.
2097### Metadata variables
2099`title`, `author`, `date`
2100: allow identification of basic aspects of the document. Included
2101 in PDF metadata through LaTeX and ConTeXt. These can be set
2102 through a [pandoc title block][Extension: `pandoc_title_block`],
2103 which allows for multiple authors, or through a
2104 [YAML metadata block][Extension: `yaml_metadata_block`]:
2112 Note that if you just want to set PDF or HTML metadata, without
2113 including a title block in the document itself, you can
2114 set the `title-meta`, `author-meta`, and `date-meta`
2115 variables. (By default these are set automatically, based
2116 on `title`, `author`, and `date`.) The page title in HTML
2117 is set by `pagetitle`, which is equal to `title` by default.
2120: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2124: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2128: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2129 and AsciiDoc metadata; repeat as for `author`, above
2132: document subject, included in ODT, PDF, docx and pptx metadata
2135: document description, included in ODT, docx and pptx metadata. Some
2136 applications show this as `Comments` metadata.
2139: document category, included in docx and pptx metadata
2142any root-level string metadata, not included in ODT, docx
2143or pptx metadata is added as a *custom property*.
2144The following [YAML] metadata block for instance:
2147 title: 'This is the title'
2148 subtitle: "This is the subtitle"
2156 It consists of two paragraphs
2159will include `title`, `author` and `description` as standard document
2160properties and `subtitle` as a custom property when converting to docx,
2163### Language variables
2166: identifies the main language of the document using IETF language
2167 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2168 The [Language subtag lookup] tool can look up or verify these tags.
2169 This affects most formats, and controls hyphenation in PDF output
2170 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2172 Use native pandoc [Divs and Spans] with the `lang` attribute to
2173 switch the language:
2179 Text in the main document language (British English).
2182 > Cette citation est écrite en français canadien.
2185 More text in English. ['Zitat auf Deutsch.']{lang=de}
2188: the base script direction, either `rtl` (right-to-left)
2189 or `ltr` (left-to-right).
2191 For bidirectional documents, native pandoc `span`s and
2192 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2193 be used to override the base direction in some output
2194 formats. This may not always be necessary if the final
2195 renderer (e.g. the browser, when generating HTML) supports
2196 the [Unicode Bidirectional Algorithm].
2198 When using LaTeX for bidirectional documents, only the
2199 `xelatex` engine is fully supported (use
2200 `--pdf-engine=xelatex`).
2202[BCP 47]: https://tools.ietf.org/html/bcp47
2203[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2204[Language subtag lookup]: https://r12a.github.io/app-subtags/
2206### Variables for HTML
2209: Enables inclusion of most of the [CSS] in the `styles.html`
2210 [partial](#partials) (have a look with
2211 `pandoc --print-default-data-file=templates/styles.html`).
2212 Unless you use [`--css`](#option--css), this variable
2213 is set to `true` by default. You can disable it with
2214 e.g. `pandoc -M document-css=false`.
2217: sets the CSS `font-family` property on the `html` element.
2220: sets the base CSS `font-size`, which you'd usually set
2221 to e.g. `20px`, but it also accepts `pt`
2222 (12pt = 16px in most browsers).
2225: sets the CSS `color` property on the `html` element.
2228: sets the CSS `color` property on all links.
2231: sets the CSS `font-family` property on `code` elements.
2233`monobackgroundcolor`
2234: sets the CSS `background-color` property on `code` elements
2235 and adds extra padding.
2238: sets the CSS `line-height` property on the `html` element,
2239 which is preferred to be unitless.
2242: sets the CSS `background-color` property on the `html` element.
2244`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2245: sets the corresponding CSS `padding` properties on the `body` element.
2247To override or extend some [CSS] for just one document, include for example:
2256 background-color: #f0f0f0;
2259 padding: 0.5em 2em 0.5em 0.5em;
2262 border-bottom: none;
2267[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2269### Variables for HTML math
2272: when using [KaTeX](#option--katex), you can render display
2273math equations flush left using [YAML metadata](#layout) or with
2274`-M classoption=fleqn`.
2276### Variables for HTML slides
2278These affect HTML output when [producing slide shows with pandoc].
2280All [reveal.js configuration options] are available as variables.
2281To turn off boolean flags that default to true in reveal.js, use `0`.
2284: base URL for reveal.js documents (defaults to
2285 `https://unpkg.com/reveal.js@^4/`)
2288: base URL for S5 documents (defaults to `s5/default`)
2291: base URL for Slidy documents (defaults to
2292 `https://www.w3.org/Talks/Tools/Slidy2`)
2295: base URL for Slideous documents (defaults to `slideous`)
2297`title-slide-attributes`
2298: additional attributes for the title slide of reveal.js slide shows.
2299 See [background in reveal.js and beamer] for an example.
2301[reveal.js configuration options]: https://revealjs.com/config/
2303### Variables for Beamer slides
2305These variables change the appearance of PDF slides using [`beamer`].
2308: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2309 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2313: produce an article from Beamer slides
2316: add extra beamer option with `\setbeameroption{}`
2319: author affiliations: can be a list when there are multiple authors
2322: logo image for slides
2325: controls navigation symbols (default is `empty` for no navigation
2326 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2329: enables "title pages" for new sections (default is true)
2331`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2335: options for LaTeX beamer themes (a list).
2338: image for title slide
2340### Variables for PowerPoint
2342These variables control the visual aspects of a slide show that
2343are not easily controlled via templates.
2346: font to use for code.
2348### Variables for LaTeX
2350Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2355: make `\paragraph` and `\subparagraph` (fourth- and
2356 fifth-level headings, or fifth- and sixth-level with book
2357 classes) free-standing rather than run-in; requires further
2358 formatting to distinguish from `\subsubsection` (third- or
2359 fourth-level headings). Instead of using this option,
2360 [KOMA-Script] can adjust headings more extensively:
2363 documentclass: scrartcl
2365 \RedeclareSectionCommand[
2366 beforeskip=-10pt plus -2pt minus -1pt,
2367 afterskip=1sp plus -1sp minus 1sp,
2368 font=\normalfont\itshape]{paragraph}
2369 \RedeclareSectionCommand[
2370 beforeskip=-10pt plus -2pt minus -1pt,
2371 afterskip=1sp plus -1sp minus 1sp,
2372 font=\normalfont\scshape,
2373 indent=0pt]{subparagraph}
2377: option for document class, e.g. `oneside`; repeat for multiple options:
2386: document class: usually one of the standard classes,
2387 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2388 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2389 default to smaller margins; or [`memoir`]
2392: option for [`geometry`] package, e.g. `margin=1in`;
2393 repeat for multiple options:
2403: option for [`hyperref`] package, e.g. `linktoc=all`;
2404 repeat for multiple options:
2410 - pdfpagemode=FullScreen
2414: if true, pandoc will use document class settings for
2415 indentation (the default LaTeX template otherwise removes
2416 indentation and adds space between paragraphs)
2419: adjusts line spacing using the [`setspace`]
2420 package, e.g. `1.25`, `1.5`
2422`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2423: sets margins if `geometry` is not used (otherwise `geometry`
2427: control `\pagestyle{}`: the default article class
2428 supports `plain` (default), `empty` (no running heads or page numbers),
2429 and `headings` (section titles in running heads)
2432: paper size, e.g. `letter`, `a4`
2435: numbering depth for sections (with `--number-sections` option
2436 or `numbersections` variable)
2441: allows font encoding to be specified through `fontenc` package (with
2442 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2445: font package for use with `pdflatex`:
2446 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2447 The default is [Latin Modern][`lm`].
2450: options for package used as `fontfamily`; repeat for multiple options.
2451 For example, to use the Libertine font with proportional lowercase
2452 (old-style) figures through the [`libertinus`] package:
2455 fontfamily: libertinus
2462: font size for body text. The standard classes allow 10pt, 11pt, and
2463 12pt. To use another size, set `documentclass` to one of
2464 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2466`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2467: font families for use with `xelatex` or
2468 `lualatex`: take the name of any system font, using the
2469 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2471`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2472: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2473 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2474 choices available through [`fontspec`]; repeat for multiple
2475 options. For example, to use the [TeX Gyre] version of
2476 Palatino with lowercase figures:
2479 mainfont: TeX Gyre Pagella
2482 - Numbers=Proportional
2486: options to pass to the microtype package
2491: add color to link text; automatically enabled if any of
2492 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2494`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2495: color for internal links, external links, citation links, linked
2496 URLs, and links in table of contents, respectively: uses options
2497 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2501: causes links to be printed as footnotes
2506: include list of figures, list of tables
2509: contents of acknowledgments footnote after document title
2512: include table of contents (can also be set using
2513 `--toc/--table-of-contents`)
2516: level of section to include in table of contents
2518#### BibLaTeX Bibliographies
2520These variables function when using BibLaTeX for [citation rendering].
2523: list of options for biblatex
2526: bibliography style, when used with `--natbib` and `--biblatex`.
2529: bibliography title, when used with `--natbib` and `--biblatex`.
2532: bibliography to use for resolving references
2535: list of options for natbib
2537[KOMA-Script]: https://ctan.org/pkg/koma-script
2538[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2539[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2540[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2541[`article`]: https://ctan.org/pkg/article
2542[`book`]: https://ctan.org/pkg/book
2543[`libertinus`]: https://ctan.org/pkg/libertinus
2544[`memoir`]: https://ctan.org/pkg/memoir
2545[`report`]: https://ctan.org/pkg/report
2547### Variables for ConTeXt
2549Pandoc uses these variables when [creating a PDF] with ConTeXt.
2552: font size for body text (e.g. `10pt`, `12pt`)
2554`headertext`, `footertext`
2555: text to be placed in running header or footer (see [ConTeXt Headers and
2556 Footers]); repeat up to four times for different placement
2559: controls indentation of paragraphs, e.g. `yes,small,next` (see
2560 [ConTeXt Indentation]); repeat for multiple options
2563: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2564 repeat for multiple options
2567: options for page margins and text arrangement (see [ConTeXt Layout]);
2568 repeat for multiple options
2570`linkcolor`, `contrastcolor`
2571: color for links outside and inside a page, e.g. `red`, `blue` (see
2575: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2576 `type`, `cap`, `small`
2579: include list of figures, list of tables
2581`mainfont`, `sansfont`, `monofont`, `mathfont`
2582: font families: take the name of any system font (see
2583 [ConTeXt Font Switching])
2585`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2586: sets margins, if `layout` is not used (otherwise `layout`
2590: page number style and location (using [`setuppagenumbering`]);
2591 repeat for multiple options
2594: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2595 repeat for multiple options
2598: adds to the preamble the setup necessary to generate PDF/A
2599 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2600 specified (i.e. the value is set to True, by e.g.
2601 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2602 `1b:2005` will be used as default, for reasons of backwards
2603 compatibility. Using `--variable=pdfa` without specified value
2604 is not supported. To successfully generate PDF/A the required
2605 ICC color profiles have to be available and the content and all
2606 included files (such as images) have to be standard conforming.
2607 The ICC profiles and output intent may be specified using the
2608 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2609 PDFA] for more details.
2612: when used in conjunction with `pdfa`, specifies the ICC profile to use
2613 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2614 used as default. May be repeated to include multiple profiles. Note that
2615 the profiles have to be available on the system. They can be obtained
2616 from [ConTeXt ICC Profiles].
2619: when used in conjunction with `pdfa`, specifies the output intent for
2620 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2621 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2624: include table of contents (can also be set using
2625 `--toc/--table-of-contents`)
2628: spacing between paragraphs, e.g. `none`, `small` (using
2629 [`setupwhitespace`])
2632: include all source documents as file attachments in the PDF file
2634[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2635[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2636[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2637[ConTeXt Color]: https://wiki.contextgarden.net/Color
2638[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2639[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2640[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2641[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2642[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2643[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2644[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2646### Variables for `wkhtmltopdf`
2648Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2649The `--css` option also affects the output.
2651`footer-html`, `header-html`
2652: add information to the header and footer
2654`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2655: set the page margins
2658: sets the PDF paper size
2660### Variables for man pages
2663: adjusts text to left (`l`), right (`r`), center (`c`),
2664 or both (`b`) margins
2667: footer in man pages
2670: header in man pages
2673: if `true` (the default), hyphenation will be used
2676: section number in man pages
2681: font family (e.g. `T` or `P`)
2684: paragraph indent (e.g. `2m`)
2687: line height (e.g. `12p`)
2690: point size (e.g. `10p`)
2692### Variables set automatically
2694Pandoc sets these variables automatically in response to [options] or
2695document contents; users can also modify them. These vary depending
2696on the output format, and include the following:
2702: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2703 included in all HTML based formats (dzslides, epub,
2704 html, html4, html5, revealjs, s5, slideous, slidy).
2705 The recognized formats for `date` are: `mm/dd/yyyy`,
2706 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2707 (e.g. either `02 Apr 2018` or `02 April 2018`),
2708 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2709 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2712: contents specified by `-H/--include-in-header` (may have multiple
2716: contents specified by `-B/--include-before-body` (may have
2720: contents specified by `-A/--include-after-body` (may have
2724: JSON representation of all of the document's metadata. Field
2725 values are transformed to the selected output format.
2728: non-null value if `-N/--number-sections` was specified
2730`sourcefile`, `outputfile`
2731: source and destination filenames, as given on the command line.
2732 `sourcefile` can also be a list if input comes from multiple files,
2733 or empty if input is from stdin. You can use the following snippet in
2734 your template to distinguish them:
2744 Similarly, `outputfile` can be `-` if output goes to the terminal.
2746 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2749: working directory from which pandoc is run.
2752: non-null value if `--toc/--table-of-contents` was specified
2755: title of table of contents (works only with EPUB,
2756 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2758[pandoc-templates]: https://github.com/jgm/pandoc-templates
2762The behavior of some of the readers and writers can be adjusted by
2763enabling or disabling various extensions.
2765An extension can be enabled by adding `+EXTENSION`
2766to the format name and disabled by adding `-EXTENSION`. For example,
2767`--from markdown_strict+footnotes` is strict Markdown with footnotes
2768enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2769Markdown without footnotes or pipe tables.
2771The markdown reader and writer make by far the most use of extensions.
2772Extensions only used by them are therefore covered in the
2773section [Pandoc's Markdown] below (See [Markdown variants] for
2774`commonmark` and `gfm`.) In the following, extensions that also work
2775for other formats are covered.
2777Note that markdown extensions added to the `ipynb` format
2778affect Markdown cells in Jupyter notebooks (as do command-line
2779options like `--atx-headers`).
2783#### Extension: `smart` ####
2785Interpret straight quotes as curly quotes, `---` as em-dashes,
2786`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2787inserted after certain abbreviations, such as "Mr."
2789This extension can be enabled/disabled for the following formats:
2792: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2795: `markdown`, `latex`, `context`, `rst`
2797enabled by default in
2798: `markdown`, `latex`, `context` (both input and output)
2800Note: If you are *writing* Markdown, then the `smart` extension
2801has the reverse effect: what would have been curly quotes comes
2804In LaTeX, `smart` means to use the standard TeX ligatures
2805for quotation marks (` `` ` and ` '' ` for double quotes,
2806`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2807en-dash and `---` for em-dash). If `smart` is disabled,
2808then in reading LaTeX pandoc will parse these characters
2809literally. In writing LaTeX, enabling `smart` tells pandoc
2810to use the ligatures when possible; if `smart` is disabled
2811pandoc will use unicode quotation mark and dash characters.
2813## Headings and sections
2815#### Extension: `auto_identifiers` ####
2817A heading without an explicitly specified identifier will be
2818automatically assigned a unique identifier based on the heading text.
2820This extension can be enabled/disabled for the following formats:
2823: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2828enabled by default in
2831The default algorithm used to derive the identifier from the
2834 - Remove all formatting, links, etc.
2835 - Remove all footnotes.
2836 - Remove all non-alphanumeric characters,
2837 except underscores, hyphens, and periods.
2838 - Replace all spaces and newlines with hyphens.
2839 - Convert all alphabetic characters to lowercase.
2840 - Remove everything up to the first letter (identifiers may
2841 not begin with a number or punctuation mark).
2842 - If nothing is left after this, use the identifier `section`.
2847 ------------------------------- ----------------------------
2848 `Heading identifiers in HTML` `heading-identifiers-in-html`
2849 `Maître d'hôtel` `maître-dhôtel`
2850 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2851 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2852 `3. Applications` `applications`
2855These rules should, in most cases, allow one to determine the identifier
2856from the heading text. The exception is when several headings have the
2857same text; in this case, the first will get an identifier as described
2858above; the second will get the same identifier with `-1` appended; the
2859third with `-2`; and so on.
2861(However, a different algorithm is used if
2862`gfm_auto_identifiers` is enabled; see below.)
2864These identifiers are used to provide link targets in the table of
2865contents generated by the `--toc|--table-of-contents` option. They
2866also make it easy to provide links from one section of a document to
2867another. A link to this section, for example, might look like this:
2870 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2872Note, however, that this method of providing links to sections works
2873only in HTML, LaTeX, and ConTeXt formats.
2875If the `--section-divs` option is specified, then each section will
2876be wrapped in a `section` (or a `div`, if `html4` was specified),
2877and the identifier will be attached to the enclosing `<section>`
2878(or `<div>`) tag rather than the heading itself. This allows entire
2879sections to be manipulated using JavaScript or treated differently in
2882#### Extension: `ascii_identifiers` ####
2884Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2885Accents are stripped off of accented Latin letters, and non-Latin
2888#### Extension: `gfm_auto_identifiers` ####
2890Changes the algorithm used by `auto_identifiers` to conform to
2891GitHub's method. Spaces are converted to dashes (`-`),
2892uppercase characters to lowercase characters, and punctuation
2893characters other than `-` and `_` are removed.
2894Emojis are replaced by their names.
2898The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2899[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2900[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2901are described in the section about Pandoc's Markdown.
2903However, they can also be used with HTML input. This is handy for
2904reading web pages formatted using MathJax, for example.
2908The following extensions are described in more detail in
2909their respective sections of [Pandoc's Markdown]:
2911- [`raw_html`](#extension-raw_html) allows HTML elements which
2912 are not representable in pandoc's AST to be parsed as raw HTML.
2913 By default, this is disabled for HTML input.
2915- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2916 to be included in a document. This extension can be enabled/disabled
2917 for the following formats (in addition to `markdown`):
2920 : `latex`, `textile`, `html` (environments, `\ref`, and
2921 `\eqref` only), `ipynb`
2924 : `textile`, `commonmark`
2926 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2927 only raw TeX in markdown cells, but data with mime type
2928 `text/html` in output cells. Since the `ipynb` reader attempts
2929 to preserve the richest possible outputs when several options
2930 are given, you will get best results if you disable `raw_html`
2931 and `raw_tex` when converting to formats like `docx` which don't
2932 allow raw `html` or `tex`.
2934- [`native_divs`](#extension-native_divs) causes HTML `div`
2935 elements to be parsed as native pandoc Div blocks.
2936 If you want them to be parsed as raw HTML, use
2937 `-f html-native_divs+raw_html`.
2939- [`native_spans`](#extension-native_spans) causes HTML `span`
2940 elements to be parsed as native pandoc Span inlines.
2941 If you want them to be parsed as raw HTML, use
2942 `-f html-native_spans+raw_html`. If you want to drop all
2943 `div`s and `span`s when converting HTML to Markdown, you
2944 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2946## Literate Haskell support
2948#### Extension: `literate_haskell` ####
2950Treat the document as literate Haskell source.
2952This extension can be enabled/disabled for the following formats:
2955: `markdown`, `rst`, `latex`
2958: `markdown`, `rst`, `latex`, `html`
2960If you append `+lhs` (or `+literate_haskell`) to one of the formats
2961above, pandoc will treat the document as literate Haskell source.
2964 - In Markdown input, "bird track" sections will be parsed as Haskell
2965 code rather than block quotations. Text between `\begin{code}`
2966 and `\end{code}` will also be treated as Haskell code. For
2967 ATX-style headings the character '=' will be used instead of '#'.
2969 - In Markdown output, code blocks with classes `haskell` and `literate`
2970 will be rendered using bird tracks, and block quotations will be
2971 indented one space, so they will not be treated as Haskell code.
2972 In addition, headings will be rendered setext-style (with underlines)
2973 rather than ATX-style (with '#' characters). (This is because ghc
2974 treats '#' characters in column 1 as introducing line numbers.)
2976 - In restructured text input, "bird track" sections will be parsed
2979 - In restructured text output, code blocks with class `haskell` will
2980 be rendered using bird tracks.
2982 - In LaTeX input, text in `code` environments will be parsed as
2985 - In LaTeX output, code blocks with class `haskell` will be rendered
2986 inside `code` environments.
2988 - In HTML output, code blocks with class `haskell` will be rendered
2989 with class `literatehaskell` and bird tracks.
2993 pandoc -f markdown+lhs -t html
2995reads literate Haskell source formatted with Markdown conventions and writes
2996ordinary HTML (without bird tracks).
2998 pandoc -f markdown+lhs -t html+lhs
3000writes HTML with the Haskell code in bird tracks, so it can be copied
3001and pasted as literate Haskell source.
3003Note that GHC expects the bird tracks in the first column, so indented
3004literate code blocks (e.g. inside an itemized environment) will not be
3005picked up by the Haskell compiler.
3009#### Extension: `empty_paragraphs` ####
3011Allows empty paragraphs. By default empty paragraphs are
3014This extension can be enabled/disabled for the following formats:
3020: `docx`, `odt`, `opendocument`, `html`
3022#### Extension: `native_numbering` ####
3024Enables native numbering of figures and tables. Enumeration
3027This extension can be enabled/disabled for the following formats:
3030: `odt`, `opendocument`
3032#### Extension: `xrefs_name` ####
3034Links to headings, figures and tables inside the document are
3035substituted with cross-references that will use the name or caption
3036of the referenced item. The original link text is replaced once
3037the generated document is refreshed. This extension can be combined
3038with `xrefs_number` in which case numbers will appear before the
3041Text in cross-references is only made consistent with the referenced
3042item once the document has been refreshed.
3044This extension can be enabled/disabled for the following formats:
3047: `odt`, `opendocument`
3049#### Extension: `xrefs_number` ####
3051Links to headings, figures and tables inside the document are
3052substituted with cross-references that will use the number
3053of the referenced item. The original link text is discarded.
3054This extension can be combined with `xrefs_name` in which case
3055the name or caption numbers will appear after the number.
3057For the `xrefs_number` to be useful heading numbers must be enabled
3058in the generated document, also table and figure captions must be enabled
3059using for example the `native_numbering` extension.
3061Numbers in cross-references are only visible in the final document once
3062it has been refreshed.
3064This extension can be enabled/disabled for the following formats:
3067: `odt`, `opendocument`
3069#### Extension: `styles` #### {#ext-styles}
3071When converting from docx, read all docx styles as divs (for
3072paragraph styles) and spans (for character styles) regardless
3073of whether pandoc understands the meaning of these styles.
3074This can be used with [docx custom styles](#custom-styles).
3080#### Extension: `amuse` ####
3082In the `muse` input format, this enables Text::Amuse
3083extensions to Emacs Muse markup.
3085#### Extension: `raw_markdown` ####
3087In the `ipynb` input format, this causes Markdown cells
3088to be included as raw Markdown blocks (allowing lossless
3089round-tripping) rather than being parsed. Use this only
3090when you are targeting `ipynb` or a markdown-based
3093#### Extension: `citations` {#org-citations}
3095Some aspects of [Pandoc's Markdown citation syntax](#citations)
3096are also accepted in `org` input.
3098#### Extension: `element_citations` ####
3100In the `jats` output formats, this causes reference items to
3101be replaced with `<element-citation>` elements. These
3102elements are not influenced by CSL styles, but all information
3103on the item is included in tags.
3105#### Extension: `ntb` ####
3107In the `context` output format this enables the use of [Natural Tables
3108(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3109[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3110Natural tables allow more fine-grained global customization but come
3111at a performance penalty compared to extreme tables.
3116Pandoc understands an extended and slightly revised version of
3117John Gruber's [Markdown] syntax. This document explains the syntax,
3118noting differences from standard Markdown. Except where noted, these
3119differences can be suppressed by using the `markdown_strict` format instead
3120of `markdown`. Extensions can be enabled or disabled to specify the
3121behavior more granularly. They are described in the following. See also
3122[Extensions] above, for extensions that work also on other formats.
3126Markdown is designed to be easy to write, and, even more importantly,
3129> A Markdown-formatted document should be publishable as-is, as plain
3130> text, without looking like it's been marked up with tags or formatting
3132> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3134This principle has guided pandoc's decisions in finding syntax for
3135tables, footnotes, and other extensions.
3137There is, however, one respect in which pandoc's aims are different
3138from the original aims of Markdown. Whereas Markdown was originally
3139designed with HTML generation in mind, pandoc is designed for multiple
3140output formats. Thus, while pandoc allows the embedding of raw HTML,
3141it discourages it, and provides other, non-HTMLish ways of representing
3142important document elements like definition lists, tables, mathematics, and
3147A paragraph is one or more lines of text followed by one or more blank lines.
3148Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3149If you need a hard line break, put two or more spaces at the end of a line.
3151#### Extension: `escaped_line_breaks` ####
3153A backslash followed by a newline is also a hard line break.
3154Note: in multiline and grid table cells, this is the only way
3155to create a hard line break, since trailing spaces in the cells
3160There are two kinds of headings: Setext and ATX.
3162### Setext-style headings ###
3164A setext-style heading is a line of text "underlined" with a row of `=` signs
3165(for a level-one heading) or `-` signs (for a level-two heading):
3173The heading text can contain inline formatting, such as emphasis (see
3174[Inline formatting], below).
3177### ATX-style headings ###
3179An ATX-style heading consists of one to six `#` signs and a line of
3180text, optionally followed by any number of `#` signs. The number of
3181`#` signs at the beginning of the line is the heading level:
3183 ## A level-two heading
3185 ### A level-three heading ###
3187As with setext-style headings, the heading text can contain formatting:
3189 # A level-one heading with a [link](/url) and *emphasis*
3191#### Extension: `blank_before_header` ####
3193Standard Markdown syntax does not require a blank line before a heading.
3194Pandoc does require this (except, of course, at the beginning of the
3195document). The reason for the requirement is that it is all too easy for a
3196`#` to end up at the beginning of a line by accident (perhaps through line
3197wrapping). Consider, for example:
3199 I like several of their flavors of ice cream:
3200 #22, for example, and #5.
3202#### Extension: `space_in_atx_header` ####
3204Many Markdown implementations do not require a space between the
3205opening `#`s of an ATX heading and the heading text, so that
3206`#5 bolt` and `#hashtag` count as headings. With this extension,
3207pandoc does require the space.
3209### Heading identifiers ###
3211See also the [`auto_identifiers`
3212extension](#extension-auto_identifiers) above.
3214#### Extension: `header_attributes` ####
3216Headings can be assigned attributes using this syntax at the end
3217of the line containing the heading text:
3219 {#identifier .class .class key=value key=value}
3221Thus, for example, the following headings will all be assigned the identifier
3226 ## My heading ## {#foo}
3228 My other heading {#foo}
3231(This syntax is compatible with [PHP Markdown Extra].)
3233Note that although this syntax allows assignment of classes and key/value
3234attributes, writers generally don't use all of this information. Identifiers,
3235classes, and key/value attributes are used in HTML and HTML-based formats such
3236as EPUB and slidy. Identifiers are used for labels and link anchors in the
3237LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3239Headings with the class `unnumbered` will not be numbered, even if
3240`--number-sections` is specified. A single hyphen (`-`) in an attribute
3241context is equivalent to `.unnumbered`, and preferable in non-English
3248 # My heading {.unnumbered}
3250If the `unlisted` class is present in addition to `unnumbered`,
3251the heading will not be included in a table of contents.
3252(Currently this feature is only implemented for certain
3253formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3255#### Extension: `implicit_header_references` ####
3257Pandoc behaves as if reference links have been defined for each heading.
3258So, to link to a heading
3260 # Heading identifiers in HTML
3264 [Heading identifiers in HTML]
3268 [Heading identifiers in HTML][]
3272 [the section on heading identifiers][heading identifiers in
3275instead of giving the identifier explicitly:
3277 [Heading identifiers in HTML](#heading-identifiers-in-html)
3279If there are multiple headings with identical text, the corresponding
3280reference will link to the first one only, and you will need to use explicit
3281links to link to the others, as described above.
3283Like regular reference links, these references are case-insensitive.
3285Explicit link reference definitions always take priority over
3286implicit heading references. So, in the following example, the
3287link will point to `bar`, not to `#foo`:
3297Markdown uses email conventions for quoting blocks of text.
3298A block quotation is one or more paragraphs or other block elements
3299(such as lists or headings), with each line preceded by a `>` character
3300and an optional space. (The `>` need not start at the left margin, but
3301it should not be indented more than three spaces.)
3303 > This is a block quote. This
3304 > paragraph has two lines.
3306 > 1. This is a list inside a block quote.
3309A "lazy" form, which requires the `>` character only on the first
3310line of each block, is also allowed:
3312 > This is a block quote. This
3313 paragraph has two lines.
3315 > 1. This is a list inside a block quote.
3318Among the block elements that can be contained in a block quote are
3319other block quotes. That is, block quotes can be nested:
3321 > This is a block quote.
3323 > > A block quote within a block quote.
3325If the `>` character is followed by an optional space, that space
3326will be considered part of the block quote marker and not part of
3327the indentation of the contents. Thus, to put an indented code
3328block in a block quote, you need five spaces after the `>`:
3332#### Extension: `blank_before_blockquote` ####
3334Standard Markdown syntax does not require a blank line before a
3335block quote. Pandoc does require this (except, of course, at
3336the beginning of the document). The reason for the requirement
3337is that it is all too easy for a `>` to end up at the beginning
3338of a line by accident (perhaps through line wrapping). So,
3339unless the `markdown_strict` format is used, the following does
3340not produce a nested block quote in pandoc:
3342 > This is a block quote.
3346## Verbatim (code) blocks
3348### Indented code blocks ###
3350A block of text indented four spaces (or one tab) is treated as verbatim
3351text: that is, special characters do not trigger special formatting,
3352and all spaces and line breaks are preserved. For example,
3355 moveShip(5 * gravity, DOWN);
3358The initial (four space or one tab) indentation is not considered part
3359of the verbatim text, and is removed in the output.
3361Note: blank lines in the verbatim text need not begin with four spaces.
3364### Fenced code blocks ###
3366#### Extension: `fenced_code_blocks` ####
3368In addition to standard indented code blocks, pandoc supports
3369*fenced* code blocks. These begin with a row of three or more
3370tildes (`~`) and end with a row of tildes that must be at least as long as
3371the starting row. Everything between these lines is treated as code. No
3372indentation is necessary:
3376 moveShip(5 * gravity, DOWN);
3380Like regular code blocks, fenced code blocks must be separated
3381from surrounding text by blank lines.
3383If the code itself contains a row of tildes or backticks, just use a longer
3384row of tildes or backticks at the start and end:
3388 code including tildes
3392#### Extension: `backtick_code_blocks` ####
3394Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3397#### Extension: `fenced_code_attributes` ####
3399Optionally, you may attach attributes to fenced or backtick code block using
3402 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3404 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3405 qsort (filter (>= x) xs)
3406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3408Here `mycode` is an identifier, `haskell` and `numberLines` are
3409classes, and `startFrom` is an attribute with value `100`. Some
3410output formats can use this information to do syntax
3411highlighting. Currently, the only output formats that uses this
3412information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3413highlighting is supported for your output format and language,
3414then the code block above will appear highlighted, with numbered
3415lines. (To see which languages are supported, type `pandoc
3416--list-highlight-languages`.) Otherwise, the code block above
3417will appear as follows:
3419 <pre id="mycode" class="haskell numberLines" startFrom="100">
3425The `numberLines` (or `number-lines`) class will cause the lines
3426of the code block to be numbered, starting with `1` or the value
3427of the `startFrom` attribute. The `lineAnchors` (or
3428`line-anchors`) class will cause the lines to be clickable
3429anchors in HTML output.
3431A shortcut form can also be used for specifying the language of
3438This is equivalent to:
3444If the `fenced_code_attributes` extension is disabled, but
3445input contains class attribute(s) for the code block, the first
3446class attribute will be printed after the opening fence as a bare
3449To prevent all highlighting, use the `--no-highlight` flag.
3450To set the highlighting style, use `--highlight-style`.
3451For more information on highlighting, see [Syntax highlighting],
3456#### Extension: `line_blocks` ####
3458A line block is a sequence of lines beginning with a vertical bar (`|`)
3459followed by a space. The division into lines will be preserved in
3460the output, as will any leading spaces; otherwise, the lines will
3461be formatted as Markdown. This is useful for verse and addresses:
3463 | The limerick packs laughs anatomical
3464 | In space that is quite economical.
3465 | But the good ones I've seen
3466 | So seldom are clean
3467 | And the clean ones so seldom are comical
3470 | Berkeley, CA 94718
3472The lines can be hard-wrapped if needed, but the continuation
3473line must begin with a space.
3475 | The Right Honorable Most Venerable and Righteous Samuel L.
3478 | Berkeley, CA 94718
3480This syntax is borrowed from [reStructuredText].
3486A bullet list is a list of bulleted list items. A bulleted list
3487item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3494This will produce a "compact" list. If you want a "loose" list, in which
3495each item is formatted as a paragraph, put spaces between the items:
3503The bullets need not be flush with the left margin; they may be
3504indented one, two, or three spaces. The bullet must be followed
3507List items look best if subsequent lines are flush with the first
3508line (after the bullet):
3514But Markdown also allows a "lazy" format:
3520### Block content in list items ###
3522A list item may contain multiple paragraphs and other block-level
3523content. However, subsequent paragraphs must be preceded by a blank line
3524and indented to line up with the first non-space content after
3531 * Second paragraph. With a code block, which must be indented
3536Exception: if the list marker is followed by an indented code
3537block, which must begin 5 spaces after the list marker, then
3538subsequent paragraphs must begin two columns after the last
3539character of the list marker:
3543 continuation paragraph
3545List items may include other lists. In this case the preceding blank
3546line is optional. The nested list must be indented to line up with
3547the first non-space character after the list marker of the
3548containing list item.
3560As noted above, Markdown allows you to write list items "lazily," instead of
3561indenting continuation lines. However, if there are multiple paragraphs or
3562other blocks in a list item, the first line of each must be indented.
3564 + A lazy, lazy, list
3567 + Another one; this looks
3570 Second paragraph of second
3573### Ordered lists ###
3575Ordered lists work just like bulleted lists, except that the items
3576begin with enumerators rather than bullets.
3578In standard Markdown, enumerators are decimal numbers followed
3579by a period and a space. The numbers themselves are ignored, so
3580there is no difference between this list:
3592#### Extension: `fancy_lists` ####
3594Unlike standard Markdown, pandoc allows ordered list items to be marked
3595with uppercase and lowercase letters and roman numerals, in addition to
3596Arabic numerals. List markers may be enclosed in parentheses or followed by a
3597single right-parentheses or period. They must be separated from the
3598text that follows by at least one space, and, if the list marker is a
3599capital letter with a period, by at least two spaces.[^2]
3601[^2]: The point of this rule is to ensure that normal paragraphs
3602 starting with people's initials, like
3604 B. Russell was an English philosopher.
3606 do not get treated as list items.
3608 This rule will not prevent
3612 from being interpreted as a list item. In this case, a backslash
3617The `fancy_lists` extension also allows '`#`' to be used as an
3618ordered list marker in place of a numeral:
3623#### Extension: `startnum` ####
3625Pandoc also pays attention to the type of list marker used, and to the
3626starting number, and both of these are preserved where possible in the
3627output format. Thus, the following yields a list with numbers followed
3628by a single parenthesis, starting with 9, and a sublist with lowercase
3638Pandoc will start a new list each time a different type of list
3639marker is used. So, the following will create three lists:
3646If default list markers are desired, use `#.`:
3652#### Extension: `task_lists` ####
3654Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3656 - [ ] an unchecked task list item
3659### Definition lists ###
3661#### Extension: `definition_lists` ####
3663Pandoc supports definition lists, using the syntax of
3664[PHP Markdown Extra] with some extensions.[^3]
3670 Term 2 with *inline markup*
3674 { some code, part of Definition 2 }
3676 Third paragraph of definition 2.
3678Each term must fit on one line, which may optionally be followed by
3679a blank line, and must be followed by one or more definitions.
3680A definition begins with a colon or tilde, which may be indented one
3683A term may have multiple definitions, and each definition may
3684consist of one or more block elements (paragraph, code block,
3685list, etc.), each indented four spaces or one tab stop. The
3686body of the definition (including the first line, aside from the
3687colon or tilde) should be indented four spaces. However, as with
3688other Markdown lists, you can "lazily" omit indentation except
3689at the beginning of a paragraph or other block element:
3694 with lazy continuation.
3696 Second paragraph of the definition.
3698If you leave space before the definition (as in the example above),
3699the text of the definition will be treated as a paragraph. In some
3700output formats, this will mean greater spacing between term/definition
3701pairs. For a more compact definition list, omit the space before the
3711Note that space between items in a definition list is required.
3712(A variant that loosens this requirement, but disallows "lazy"
3713hard wrapping, can be activated with `compact_definition_lists`: see
3714[Non-pandoc extensions], below.)
3716[^3]: I have been influenced by the suggestions of [David
3717 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3719### Numbered example lists ###
3721#### Extension: `example_lists` ####
3723The special list marker `@` can be used for sequentially numbered
3724examples. The first list item with a `@` marker will be numbered '1',
3725the next '2', and so on, throughout the document. The numbered examples
3726need not occur in a single list; each new list using `@` will take up
3727where the last stopped. So, for example:
3729 (@) My first example will be numbered (1).
3730 (@) My second example will be numbered (2).
3732 Explanation of examples.
3734 (@) My third example will be numbered (3).
3736Numbered examples can be labeled and referred to elsewhere in the
3739 (@good) This is a good example.
3741 As (@good) illustrates, ...
3743The label can be any string of alphanumeric characters, underscores,
3746Note: continuation paragraphs in example lists must always
3747be indented four spaces, regardless of the length of the
3748list marker. That is, example lists always behave as if the
3749`four_space_rule` extension is set. This is because example
3750labels tend to be long, and indenting content to the
3751first non-space character after the label would be awkward.
3754### Ending a list ###
3756What if you want to put an indented code block after a list?
3763Trouble! Here pandoc (like other Markdown implementations) will treat
3764`{ my code block }` as the second paragraph of item two, and not as
3767To "cut off" the list after item two, you can insert some non-indented
3768content, like an HTML comment, which won't produce visible output in
3774 <!-- end of list -->
3778You can use the same trick if you want two consecutive lists instead
3793A line containing a row of three or more `*`, `-`, or `_` characters
3794(optionally separated by spaces) produces a horizontal rule:
3803Four kinds of tables may be used. The first three kinds presuppose the use of
3804a fixed-width font, such as Courier. The fourth kind can be used with
3805proportionally spaced fonts, as it does not require lining up columns.
3807#### Extension: `table_captions` ####
3809A caption may optionally be provided with all 4 kinds of tables (as
3810illustrated in the examples below). A caption is a paragraph beginning
3811with the string `Table:` (or just `:`), which will be stripped off.
3812It may appear either before or after the table.
3814#### Extension: `simple_tables` ####
3816Simple tables look like this:
3818 Right Left Center Default
3819 ------- ------ ---------- -------
3824 Table: Demonstration of simple table syntax.
3826The header and table rows must each fit on one line. Column
3827alignments are determined by the position of the header text relative
3828to the dashed line below it:[^4]
3830 - If the dashed line is flush with the header text on the right side
3831 but extends beyond it on the left, the column is right-aligned.
3832 - If the dashed line is flush with the header text on the left side
3833 but extends beyond it on the right, the column is left-aligned.
3834 - If the dashed line extends beyond the header text on both sides,
3835 the column is centered.
3836 - If the dashed line is flush with the header text on both sides,
3837 the default alignment is used (in most cases, this will be left).
3839[^4]: This scheme is due to Michel Fortin, who proposed it on the
3840 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3842The table must end with a blank line, or a line of dashes followed by
3845The column header row may be omitted, provided a dashed line is used
3846to end the table. For example:
3848 ------- ------ ---------- -------
3852 ------- ------ ---------- -------
3854When the header row is omitted, column alignments are determined on the basis
3855of the first line of the table body. So, in the tables above, the columns
3856would be right, left, center, and right aligned, respectively.
3858#### Extension: `multiline_tables` ####
3860Multiline tables allow header and table rows to span multiple lines
3861of text (but cells that span multiple columns or rows of the table are
3862not supported). Here is an example:
3864 -------------------------------------------------------------
3865 Centered Default Right Left
3866 Header Aligned Aligned Aligned
3867 ----------- ------- --------------- -------------------------
3868 First row 12.0 Example of a row that
3869 spans multiple lines.
3871 Second row 5.0 Here's another one. Note
3872 the blank line between
3874 -------------------------------------------------------------
3876 Table: Here's the caption. It, too, may span
3879These work like simple tables, but with the following differences:
3881 - They must begin with a row of dashes, before the header text
3882 (unless the header row is omitted).
3883 - They must end with a row of dashes, then a blank line.
3884 - The rows must be separated by blank lines.
3886In multiline tables, the table parser pays attention to the widths of
3887the columns, and the writers try to reproduce these relative widths in
3888the output. So, if you find that one of the columns is too narrow in the
3889output, try widening it in the Markdown source.
3891The header may be omitted in multiline tables as well as simple tables:
3893 ----------- ------- --------------- -------------------------
3894 First row 12.0 Example of a row that
3895 spans multiple lines.
3897 Second row 5.0 Here's another one. Note
3898 the blank line between
3900 ----------- ------- --------------- -------------------------
3902 : Here's a multiline table without a header.
3904It is possible for a multiline table to have just one row, but the row
3905should be followed by a blank line (and then the row of dashes that ends
3906the table), or the table may be interpreted as a simple table.
3908#### Extension: `grid_tables` ####
3910Grid tables look like this:
3912 : Sample grid table.
3914 +---------------+---------------+--------------------+
3915 | Fruit | Price | Advantages |
3916 +===============+===============+====================+
3917 | Bananas | $1.34 | - built-in wrapper |
3918 | | | - bright color |
3919 +---------------+---------------+--------------------+
3920 | Oranges | $2.10 | - cures scurvy |
3922 +---------------+---------------+--------------------+
3924The row of `=`s separates the header from the table body, and can be
3925omitted for a headerless table. The cells of grid tables may contain
3926arbitrary block elements (multiple paragraphs, code blocks, lists,
3927etc.). Cells that span multiple columns or rows are not
3928supported. Grid tables can be created easily using Emacs' table-mode
3929(`M-x table-insert`).
3931Alignments can be specified as with pipe tables, by putting
3932colons at the boundaries of the separator line after the
3935 +---------------+---------------+--------------------+
3936 | Right | Left | Centered |
3937 +==============:+:==============+:==================:+
3938 | Bananas | $1.34 | built-in wrapper |
3939 +---------------+---------------+--------------------+
3941For headerless tables, the colons go on the top line instead:
3943 +--------------:+:--------------+:------------------:+
3944 | Right | Left | Centered |
3945 +---------------+---------------+--------------------+
3947##### Grid Table Limitations #####
3949Pandoc does not support grid tables with row spans or column spans.
3950This means that neither variable numbers of columns across rows nor
3951variable numbers of rows across columns are supported by Pandoc.
3952All grid tables must have the same number of columns in each row,
3953and the same number of rows in each column. For example, the
3954Docutils [sample grid tables] will not render as expected with
3957[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3960#### Extension: `pipe_tables` ####
3962Pipe tables look like this:
3964 | Right | Left | Default | Center |
3965 |------:|:-----|---------|:------:|
3966 | 12 | 12 | 12 | 12 |
3967 | 123 | 123 | 123 | 123 |
3970 : Demonstration of pipe table syntax.
3972The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3973ending pipe characters are optional, but pipes are required between all
3974columns. The colons indicate column alignment as shown. The header
3975cannot be omitted. To simulate a headerless table, include a header
3978Since the pipes indicate column boundaries, columns need not be vertically
3979aligned, as they are in the above example. So, this is a perfectly
3980legal (though ugly) pipe table:
3988The cells of pipe tables cannot contain block elements like paragraphs
3989and lists, and cannot span multiple lines. If a pipe table contains a
3990row whose Markdown content is wider than the column width (see
3991`--columns`), then the table will take up the full text width and
3992the cell contents will wrap, with the relative cell widths determined
3993by the number of dashes in the line separating the table header from
3994the table body. (For example `---|-` would make the first column 3/4
3995and the second column 1/4 of the full text width.)
3996On the other hand, if no lines are wider than column width, then
3997cell contents will not be wrapped, and the cells will be sized
4000Note: pandoc also recognizes pipe tables of the following
4001form, as can be produced by Emacs' orgtbl-mode:
4008The difference is that `+` is used instead of `|`. Other orgtbl features
4009are not supported. In particular, to get non-default column alignment,
4010you'll need to add colons as above.
4012[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4016#### Extension: `pandoc_title_block` ####
4018If the file begins with a title block
4021 % author(s) (separated by semicolons)
4024it will be parsed as bibliographic information, not regular text. (It
4025will be used, for example, in the title of standalone LaTeX or HTML
4026output.) The block may contain just a title, a title and an author,
4027or all three elements. If you want to include an author but no
4028title, or a title and a date but no author, you need a blank line:
4041The title may occupy multiple lines, but continuation lines must
4042begin with leading space, thus:
4049If a document has multiple authors, the authors may be put on
4050separate lines with leading space, or separated by semicolons, or
4051both. So, all of the following are equivalent:
4059% Author One; Author Two
4067The date must fit on one line.
4069All three metadata fields may contain standard inline formatting
4070(italics, links, footnotes, etc.).
4072Title blocks will always be parsed, but they will affect the output only
4073when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4074will appear twice: once in the document head -- this is the title that
4075will appear at the top of the window in a browser -- and once at the
4076beginning of the document body. The title in the document head can have
4077an optional prefix attached (`--title-prefix` or `-T` option). The title
4078in the body appears as an H1 element with class "title", so it can be
4079suppressed or reformatted with CSS. If a title prefix is specified with
4080`-T` and no title block appears in the document, the title prefix will
4081be used by itself as the HTML title.
4083The man page writer extracts a title, man page section number, and
4084other header and footer information from the title line. The title
4085is assumed to be the first word on the title line, which may optionally
4086end with a (single-digit) section number in parentheses. (There should
4087be no space between the title and the parentheses.) Anything after
4088this is assumed to be additional footer and header text. A single pipe
4089character (`|`) should be used to separate the footer text from the header
4094will yield a man page with the title `PANDOC` and section 1.
4096 % PANDOC(1) Pandoc User Manuals
4098will also have "Pandoc User Manuals" in the footer.
4100 % PANDOC(1) Pandoc User Manuals | Version 4.0
4102will also have "Version 4.0" in the header.
4104#### Extension: `yaml_metadata_block` ####
4106A [YAML] metadata block is a valid YAML object, delimited by a line of three
4107hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4108(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4109document, but if it is not at the beginning, it must be preceded by a blank
4110line. (Note that, because of the way pandoc concatenates input files when
4111several are provided, you may also keep the metadata in a separate YAML file
4112and pass it to pandoc as an argument, along with your Markdown files:
4114 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4116Just be sure that the YAML file begins with `---` and ends with `---` or
4117`...`.) Alternatively, you can use the `--metadata-file` option. Using
4118that approach however, you cannot reference content (like footnotes)
4119from the main markdown input document.
4121Metadata will be taken from the fields of the YAML object and added to any
4122existing document metadata. Metadata can contain lists and objects (nested
4123arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4124with names ending in an underscore will be ignored by pandoc. (They may be
4125given a role by external processors.) Field names must not be
4126interpretable as YAML numbers or boolean values (so, for
4127example, `yes`, `True`, and `15` cannot be used as field names).
4129A document may contain multiple metadata blocks. If two
4130metadata blocks attempt to set the same field, the value from
4131the second block will be taken.
4133When pandoc is used with `-t markdown` to create a Markdown document,
4134a YAML metadata block will be produced only if the `-s/--standalone`
4135option is used. All of the metadata will appear in a single block
4136at the beginning of the document.
4138Note that [YAML] escaping rules must be followed. Thus, for example,
4139if a title contains a colon, it must be quoted. The pipe character
4140(`|`) can be used to begin an indented block that will be interpreted
4141literally, without need for escaping. This form is necessary
4142when the field contains blank lines or block-level formatting:
4145 title: 'This is the title: it contains a colon'
4149 keywords: [nothing, nothingness]
4151 This is the abstract.
4153 It consists of two paragraphs.
4156Template variables will be set automatically from the metadata. Thus, for
4157example, in writing HTML, the variable `abstract` will be set to the HTML
4158equivalent of the Markdown in the `abstract` field:
4160 <p>This is the abstract.</p>
4161 <p>It consists of two paragraphs.</p>
4163Variables can contain arbitrary YAML structures, but the template must match
4164this structure. The `author` variable in the default templates expects a
4165simple list or string, but can be changed to support more complicated
4166structures. The following combination, for example, would add an affiliation
4167to the author if one is given:
4170 title: The document title
4173 affiliation: University of Somewhere
4175 affiliation: University of Nowhere
4178To use the structured authors in the example above, you would need a custom
4183 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4189Raw content to include in the document's header may be specified
4190using `header-includes`; however, it is important to mark up
4191this content as raw code for a particular output format, using
4192the [`raw_attribute` extension](#extension-raw_attribute)), or it
4193will be interpreted as markdown. For example:
4198 \let\oldsection\section
4199 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4204#### Extension: `all_symbols_escapable` ####
4206Except inside a code block or inline code, any punctuation or space
4207character preceded by a backslash will be treated literally, even if it
4208would normally indicate formatting. Thus, for example, if one writes
4218 <strong>hello</strong>
4220This rule is easier to remember than standard Markdown's rule,
4221which allows only the following characters to be backslash-escaped:
4225(However, if the `markdown_strict` format is used, the standard Markdown rule
4228A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4229it will appear as `~`. In HTML and XML output, it will appear as a
4230literal unicode nonbreaking space character (note that it will thus
4231actually look "invisible" in the generated HTML source; you can still
4232use the `--ascii` command-line option to make it appear as an explicit
4235A backslash-escaped newline (i.e. a backslash occurring at the end of
4236a line) is parsed as a hard line break. It will appear in TeX output as
4237`\\` and in HTML as `<br />`. This is a nice alternative to
4238Markdown's "invisible" way of indicating hard line breaks using
4239two trailing spaces on a line.
4241Backslash escapes do not work in verbatim contexts.
4247To *emphasize* some text, surround it with `*`s or `_`, like this:
4249 This text is _emphasized with underscores_, and this
4250 is *emphasized with asterisks*.
4252Double `*` or `_` produces **strong emphasis**:
4254 This is **strong emphasis** and __with underscores__.
4256A `*` or `_` character surrounded by spaces, or backslash-escaped,
4257will not trigger emphasis:
4259 This is * not emphasized *, and \*neither is this\*.
4261#### Extension: `intraword_underscores` ####
4263Because `_` is sometimes used inside words and identifiers,
4264pandoc does not interpret a `_` surrounded by alphanumeric
4265characters as an emphasis marker. If you want to emphasize
4266just part of a word, use `*`:
4268 feas*ible*, not feas*able*.
4273#### Extension: `strikeout` ####
4275To strikeout a section of text with a horizontal line, begin and end it
4276with `~~`. Thus, for example,
4278 This ~~is deleted text.~~
4281### Superscripts and subscripts ###
4283#### Extension: `superscript`, `subscript` ####
4285Superscripts may be written by surrounding the superscripted text by `^`
4286characters; subscripts may be written by surrounding the subscripted
4287text by `~` characters. Thus, for example,
4289 H~2~O is a liquid. 2^10^ is 1024.
4291The text between `^...^` or `~...~` may not contain spaces or
4292newlines. If the superscripted or subscripted text contains
4293spaces, these spaces must be escaped with backslashes. (This is
4294to prevent accidental superscripting and subscripting through
4295the ordinary use of `~` and `^`, and also bad interactions with
4296footnotes.) Thus, if you want the letter P with 'a cat' in
4297subscripts, use `P~a\ cat~`, not `P~a cat~`.
4301To make a short span of text verbatim, put it inside backticks:
4303 What is the difference between `>>=` and `>>`?
4305If the verbatim text includes a backtick, use double backticks:
4307 Here is a literal backtick `` ` ``.
4309(The spaces after the opening backticks and before the closing
4310backticks will be ignored.)
4312The general rule is that a verbatim span starts with a string
4313of consecutive backticks (optionally followed by a space)
4314and ends with a string of the same number of backticks (optionally
4315preceded by a space).
4317Note that backslash-escapes (and other Markdown constructs) do not
4318work in verbatim contexts:
4320 This is a backslash followed by an asterisk: `\*`.
4322#### Extension: `inline_code_attributes` ####
4324Attributes can be attached to verbatim text, just as with
4325[fenced code blocks]:
4331To write small caps, use the `smallcaps` class:
4333 [Small caps]{.smallcaps}
4335Or, without the `bracketed_spans` extension:
4337 <span class="smallcaps">Small caps</span>
4339For compatibility with other Markdown flavors, CSS is also supported:
4341 <span style="font-variant:small-caps;">Small caps</span>
4343This will work in all output formats that support small caps.
4348#### Extension: `tex_math_dollars` ####
4350Anything between two `$` characters will be treated as TeX math. The
4351opening `$` must have a non-space character immediately to its right,
4352while the closing `$` must have a non-space character immediately to its
4353left, and must not be followed immediately by a digit. Thus,
4354`$20,000 and $30,000` won't parse as math. If for some reason
4355you need to enclose text in literal `$` characters, backslash-escape
4356them and they won't be treated as math delimiters.
4358For display math, use `$$` delimiters. (In this case, the delimiters
4359may be separated from the formula by whitespace.)
4361TeX math will be printed in all output formats. How it is rendered
4362depends on the output format:
4365 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4366 math) or `\[...\]` (for display math).
4368Markdown, Emacs Org mode, ConTeXt, ZimWiki
4369 ~ It will appear verbatim surrounded by `$...$` (for inline
4370 math) or `$$...$$` (for display math).
4373 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4376 ~ It will be rendered using an [interpreted text role `:math:`].
4379 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4380 surrounded by `latexmath:[$...$]` (for inline math) or
4381 `[latexmath]++++\[...\]+++` (for display math).
4382 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4383 (`$..$` and `\[..\]`) are omitted.
4386 ~ It will be rendered inside a `@math` command.
4388roff man, Jira markup
4389 ~ It will be rendered verbatim without `$`'s.
4392 ~ It will be rendered inside `<math>` tags.
4395 ~ It will be rendered inside `<span class="math">` tags.
4398 ~ It will be rendered, if possible, using Unicode characters,
4399 and will otherwise appear verbatim.
4402 ~ It will be rendered, if possible, using MathML.
4405 ~ If the `--mathml` flag is used, it will be rendered using MathML
4406 in an `inlineequation` or `informalequation` tag. Otherwise it
4407 will be rendered, if possible, using Unicode characters.
4410 ~ It will be rendered using OMML math markup.
4413 ~ If the `--webtex` option is used, formulas are rendered as images
4414 using CodeCogs or other compatible web service, downloaded
4415 and embedded in the e-book. Otherwise, they will appear verbatim.
4417HTML, Slidy, DZSlides, S5, EPUB
4418 ~ The way math is rendered in HTML will depend on the
4419 command-line options selected. Therefore see [Math rendering in HTML]
4422[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4426#### Extension: `raw_html` ####
4428Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4429(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4430literally). (Technically this is not an extension, since standard
4431Markdown allows it, but it has been made an extension so that it can
4432be disabled if desired.)
4434The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4435DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4436output, and suppressed in other formats.
4438For a more explicit way of including raw HTML in a Markdown
4439document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4441In the CommonMark format, if `raw_html` is enabled, superscripts,
4442subscripts, strikeouts and small capitals will be represented as HTML.
4443Otherwise, plain-text fallbacks will be used. Note that even if
4444`raw_html` is disabled, tables will be rendered with HTML syntax if
4445they cannot use pipe syntax.
4447#### Extension: `markdown_in_html_blocks` ####
4449Standard Markdown allows you to include HTML "blocks": blocks
4450of HTML between balanced tags that are separated from the surrounding text
4451with blank lines, and start and end at the left margin. Within
4452these blocks, everything is interpreted as HTML, not Markdown;
4453so (for example), `*` does not signify emphasis.
4455Pandoc behaves this way when the `markdown_strict` format is used; but
4456by default, pandoc interprets material between HTML block tags as Markdown.
4457Thus, for example, pandoc will turn
4462 <td>[a link](https://google.com)</td>
4470 <td><em>one</em></td>
4471 <td><a href="https://google.com">a link</a></td>
4475whereas `Markdown.pl` will preserve it as is.
4477There is one exception to this rule: text between `<script>`,
4478`<style>`, and `<textarea>` tags is not interpreted as Markdown.
4480This departure from standard Markdown should make it easier to mix
4481Markdown with HTML block elements. For example, one can surround
4482a block of Markdown text with `<div>` tags without preventing it
4483from being interpreted as Markdown.
4485#### Extension: `native_divs` ####
4487Use native pandoc `Div` blocks for content inside `<div>` tags.
4488For the most part this should give the same output as
4489`markdown_in_html_blocks`, but it makes it easier to write pandoc
4490filters to manipulate groups of blocks.
4492#### Extension: `native_spans` ####
4494Use native pandoc `Span` blocks for content inside `<span>` tags.
4495For the most part this should give the same output as `raw_html`,
4496but it makes it easier to write pandoc filters to manipulate groups
4499#### Extension: `raw_tex` ####
4501In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4502included in a document. Inline TeX commands will be preserved and passed
4503unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4504LaTeX to include BibTeX citations:
4506 This result was proved in \cite{jones.1967}.
4508Note that in LaTeX environments, like
4510 \begin{tabular}{|l|l|}\hline
4511 Age & Frequency \\ \hline
4514 36--45 & 22 \\ \hline
4517the material between the begin and end tags will be interpreted as raw
4518LaTeX, not as Markdown.
4520For a more explicit and flexible way of including raw TeX in a
4521Markdown document, see the [`raw_attribute`
4522extension][Extension: `raw_attribute`].
4524Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4525Emacs Org mode, and ConTeXt.
4527### Generic raw attribute ###
4529#### Extension: `raw_attribute` ####
4531Inline spans and fenced code blocks with a special
4532kind of attribute will be parsed as raw content with the
4533designated format. For example, the following produces a raw
4540And the following produces a raw `html` inline element:
4542 This is `<a>html</a>`{=html}
4544This can be useful to insert raw xml into `docx` documents, e.g.
4550 <w:br w:type="page"/>
4555The format name should match the target format name (see
4556`-t/--to`, above, for a list, or use `pandoc
4557--list-output-formats`). Use `openxml` for `docx` output,
4558`opendocument` for `odt` output, `html5` for `epub3` output,
4559`html4` for `epub2` output, and `latex`, `beamer`,
4560`ms`, or `html5` for `pdf` output (depending on what you
4561use for `--pdf-engine`).
4563This extension presupposes that the relevant kind of
4564inline code or fenced code block is enabled. Thus, for
4565example, to use a raw attribute with a backtick code block,
4566`backtick_code_blocks` must be enabled.
4568The raw attribute cannot be combined with regular attributes.
4572#### Extension: `latex_macros` ####
4574When this extension is enabled, pandoc will parse LaTeX
4575macro definitions and apply the resulting macros to all LaTeX
4576math and raw LaTeX. So, for example, the following will work in
4577all output formats, not just LaTeX:
4579 \newcommand{\tuple}[1]{\langle #1 \rangle}
4583Note that LaTeX macros will not be applied if they occur
4584inside a raw span or block marked with the
4585[`raw_attribute` extension](#extension-raw_attribute).
4587When `latex_macros` is disabled, the raw LaTeX and math will
4588not have macros applied. This is usually a better approach when
4589you are targeting LaTeX or PDF.
4591Macro definitions in LaTeX will be passed through as raw LaTeX
4592only if `latex_macros` is not enabled. Macro definitions in
4593Markdown source (or other formats allowing `raw_tex`) will
4594be passed through regardless of whether `latex_macros` is
4599Markdown allows links to be specified in several ways.
4601### Automatic links ###
4603If you enclose a URL or email address in pointy brackets, it
4606 <https://google.com>
4607 <sam@green.eggs.ham>
4611An inline link consists of the link text in square brackets,
4612followed by the URL in parentheses. (Optionally, the URL can
4613be followed by a link title, in quotes.)
4615 This is an [inline link](/url), and here's [one with
4616 a title](https://fsf.org "click here for a good time!").
4618There can be no space between the bracketed part and the parenthesized part.
4619The link text can contain formatting (such as emphasis), but the title cannot.
4621Email addresses in inline links are not autodetected, so they have to be
4622prefixed with `mailto`:
4624 [Write me!](mailto:sam@green.eggs.ham)
4626### Reference links ###
4628An *explicit* reference link has two parts, the link itself and the link
4629definition, which may occur elsewhere in the document (either
4630before or after the link).
4632The link consists of link text in square brackets, followed by a label in
4633square brackets. (There cannot be space between the two unless the
4634`spaced_reference_links` extension is enabled.) The link definition
4635consists of the bracketed label, followed by a colon and a space, followed by
4636the URL, and optionally (after a space) a link title either in quotes or in
4637parentheses. The label must not be parseable as a citation (assuming
4638the `citations` extension is enabled): citations take precedence over
4641Here are some examples:
4643 [my label 1]: /foo/bar.html "My title, optional"
4645 [my label 3]: https://fsf.org (The free software foundation)
4646 [my label 4]: /bar#special 'A title in single quotes'
4648The URL may optionally be surrounded by angle brackets:
4650 [my label 5]: <http://foo.bar.baz>
4652The title may go on the next line:
4654 [my label 3]: https://fsf.org
4655 "The free software foundation"
4657Note that link labels are not case sensitive. So, this will work:
4659 Here is [my link][FOO]
4663In an *implicit* reference link, the second pair of brackets is
4668 [my website]: http://foo.bar.baz
4670Note: In `Markdown.pl` and most other Markdown implementations,
4671reference link definitions cannot occur in nested constructions
4672such as list items or block quotes. Pandoc lifts this arbitrary
4673seeming restriction. So the following is fine in pandoc, though
4674not in most other implementations:
4680#### Extension: `shortcut_reference_links` ####
4682In a *shortcut* reference link, the second pair of brackets may
4687 [my website]: http://foo.bar.baz
4689### Internal links ###
4691To link to another section of the same document, use the automatically
4692generated identifier (see [Heading identifiers]). For example:
4694 See the [Introduction](#introduction).
4698 See the [Introduction].
4700 [Introduction]: #introduction
4702Internal links are currently supported for HTML formats (including
4703HTML slide shows and EPUB), LaTeX, and ConTeXt.
4707A link immediately preceded by a `!` will be treated as an image.
4708The link text will be used as the image's alt text:
4710 
4714 [movie reel]: movie.gif
4716#### Extension: `implicit_figures` ####
4718An image with nonempty alt text, occurring by itself in a
4719paragraph, will be rendered as a figure with a caption. The
4720image's alt text will be used as the caption.
4722 
4724How this is rendered depends on the output format. Some output
4725formats (e.g. RTF) do not yet support figures. In those
4726formats, you'll just get an image in a paragraph by itself, with
4729If you just want a regular inline image, just make sure it is not
4730the only thing in the paragraph. One way to do this is to insert a
4731nonbreaking space after the image:
4733 \
4735Note that in reveal.js slide shows, an image in a paragraph
4736by itself that has the `stretch` class will fill the screen,
4737and the caption and figure tags will be omitted.
4739#### Extension: `link_attributes` ####
4741Attributes can be set on links and images:
4743 An inline {#id .class width=30 height=20px}
4744 and a reference ![image][ref] with attributes.
4746 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4748(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4749and `.class` are used.)
4751For HTML and EPUB, all known HTML5 attributes except `width` and
4752`height` (but including `srcset` and `sizes`) are passed through
4753as is. Unknown attributes are passed through as custom
4754attributes, with `data-` prepended. The other writers ignore
4755attributes that are not specifically supported by their output format.
4757The `width` and `height` attributes on images are treated specially. When
4758used without a unit, the unit is assumed to be pixels. However, any of
4759the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4760and `%`. There must not be any spaces between the number and the unit.
4764{ width=50% }
4767- Dimensions may be converted to a form that is compatible with
4768 the output format (for example, dimensions given in pixels will
4769 be converted to inches when converting HTML to LaTeX). Conversion
4770 between pixels and physical measurements is affected by the
4771 `--dpi` option (by default, 96 dpi is assumed, unless the image
4772 itself contains dpi information).
4773- The `%` unit is generally relative to some available space.
4774 For example the above example will render to the following.
4775 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4776 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4777 (If you're using a custom template, you need to configure `graphicx`
4778 as in the default template.)
4779 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4780- Some output formats have a notion of a class
4781 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4782 or a unique identifier (LaTeX `\caption`), or both (HTML).
4783- When no `width` or `height` attributes are specified, the fallback
4784 is to look at the image resolution and the dpi metadata embedded in
4789Using the `native_divs` and `native_spans` extensions
4790(see [above][Extension: `native_divs`]), HTML syntax can
4791be used as part of markdown to create native `Div` and `Span`
4792elements in the pandoc AST (as opposed to raw HTML).
4793However, there is also nicer syntax available:
4795#### Extension: `fenced_divs` ####
4797Allow special fenced syntax for native `Div` blocks. A Div
4798starts with a fence containing at least three consecutive
4799colons plus some attributes. The attributes may optionally
4800be followed by another string of consecutive colons.
4801The attribute syntax is exactly as in fenced code blocks (see
4802[Extension: `fenced_code_attributes`]). As with fenced
4803code blocks, one can use either attributes in curly braces
4804or a single unbraced word, which will be treated as a class
4805name. The Div ends with another line containing a string of at
4806least three consecutive colons. The fenced Div should be
4807separated by blank lines from preceding and following blocks.
4811 ::::: {#special .sidebar}
4812 Here is a paragraph.
4817Fenced divs can be nested. Opening fences are distinguished
4818because they *must* have attributes:
4824 This is a warning within a warning.
4828Fences without attributes are always closing fences. Unlike
4829with fenced code blocks, the number of colons in the closing
4830fence need not match the number in the opening fence. However,
4831it can be helpful for visual clarity to use fences of different
4832lengths to distinguish nested divs from their parents.
4835#### Extension: `bracketed_spans` ####
4837A bracketed sequence of inlines, as one would use to begin
4838a link, will be treated as a `Span` with attributes if it is
4839followed immediately by attributes:
4841 [This is *some text*]{.class key="val"}
4845#### Extension: `footnotes` ####
4847Pandoc's Markdown allows footnotes, using the following syntax:
4849 Here is a footnote reference,[^1] and another.[^longnote]
4851 [^1]: Here is the footnote.
4853 [^longnote]: Here's one with multiple blocks.
4855 Subsequent paragraphs are indented to show that they
4856 belong to the previous footnote.
4860 The whole paragraph can be indented, or just the first
4861 line. In this way, multi-paragraph footnotes work like
4862 multi-paragraph list items.
4864 This paragraph won't be part of the note, because it
4867The identifiers in footnote references may not contain spaces, tabs,
4868or newlines. These identifiers are used only to correlate the
4869footnote reference with the note itself; in the output, footnotes
4870will be numbered sequentially.
4872The footnotes themselves need not be placed at the end of the
4873document. They may appear anywhere except inside other block elements
4874(lists, block quotes, tables, etc.). Each footnote should be
4875separated from surrounding content (including other footnotes)
4878#### Extension: `inline_notes` ####
4880Inline footnotes are also allowed (though, unlike regular notes,
4881they cannot contain multiple paragraphs). The syntax is as follows:
4883 Here is an inline note.^[Inlines notes are easier to write, since
4884 you don't have to pick an identifier and move down to type the
4887Inline and regular footnotes may be mixed freely.
4891#### Extension: `citations` ####
4893Markdown citations go inside square brackets and are separated
4894by semicolons. Each citation must have a key, composed of '@' +
4895the citation identifier from the database, and may optionally
4896have a prefix, a locator, and a suffix. The citation key must
4897begin with a letter, digit, or `_`, and may contain
4898alphanumerics, `_`, and internal punctuation characters
4899(`:.#$%&-+?<>~/`). Here are some examples:
4901 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4903 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4905 Blah blah [@smith04; @doe99].
4907`pandoc` detects locator terms in the [CSL locale files].
4908Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4909locale, locator terms can be written in either singular or plural forms,
4910as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4911`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4912`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4913`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4914`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4915`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4916locator term is used, "page" is assumed.
4918`pandoc` will use heuristics to distinguish the locator
4919from the suffix. In complex cases, the locator can be enclosed
4922 [@smith{ii, A, D-Z}, with a suffix]
4923 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4925A minus sign (`-`) before the `@` will suppress mention of
4926the author in the citation. This can be useful when the
4927author is already mentioned in the text:
4929 Smith says blah [-@smith04].
4931You can also write an in-text citation, as follows:
4935 @smith04 [p. 33] says blah.
4938[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4939[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4940[Chicago Manual of Style]: https://chicagomanualofstyle.org
4941[Citation Style Language]: https://citationstyles.org
4942[Zotero Style Repository]: https://www.zotero.org/styles
4943[finding and editing styles]: https://citationstyles.org/authors/
4944[CSL locale files]: https://github.com/citation-style-language/locales
4946## Non-pandoc extensions
4948The following Markdown syntax extensions are not enabled by default
4949in pandoc, but may be enabled by adding `+EXTENSION` to the format
4950name, where `EXTENSION` is the name of the extension. Thus, for
4951example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4953#### Extension: `attributes` ####
4955Allows attributes to be attached to any inline or block-level
4956element. The syntax for the attributes is the same as that
4957used in [`header_attributes`][Extension: `header_attributes`].
4959- Attributes that occur immediately after an inline
4960 element affect that element. If they follow a space, then they
4961 belong to the space. (Hence, this option subsumes
4962 `inline_code_attributes` and `link_attributes`.)
4963- Attributes that occur immediately before a block
4964 element, on a line by themselves, affect that
4966- Consecutive attribute specifiers may be used,
4967 either for blocks or for inlines. Their attributes
4969- Attributes that occur at the end of the text of
4970 a Setext or ATX heading (separated by whitespace
4971 from the text) affect the heading element. (Hence, this
4972 option subsumes `header_attributes`.)
4973- Attributes that occur after the opening fence
4974 in a fenced code block affect the code block element. (Hence,
4975 this option subsumes `fenced_code_attributes`.)
4976- Attributes that occur at the end of a reference
4977 link definition affect links that refer to that
4980Note that pandoc's AST does not currently allow attributes
4981to be attached to arbitrary elements. Hence a Span or Div
4982container will be added if needed.
4984#### Extension: `old_dashes` ####
4986Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4987`-` before a numeral is an en-dash, and `--` is an em-dash.
4988This option only has an effect if `smart` is enabled. It is
4989selected automatically for `textile` input.
4991#### Extension: `angle_brackets_escapable` ####
4993Allow `<` and `>` to be backslash-escaped, as they can be in
4994GitHub flavored Markdown but not original Markdown. This is
4995implied by pandoc's default `all_symbols_escapable`.
4997#### Extension: `lists_without_preceding_blankline` ####
4999Allow a list to occur right after a paragraph, with no intervening
5002#### Extension: `four_space_rule` ####
5004Selects the pandoc <= 2.0 behavior for parsing lists, so that
5005four spaces indent are needed for list item continuation
5008#### Extension: `spaced_reference_links` ####
5010Allow whitespace between the two components of a reference link,
5015#### Extension: `hard_line_breaks` ####
5017Causes all newlines within a paragraph to be interpreted as hard line
5018breaks instead of spaces.
5020#### Extension: `ignore_line_breaks` ####
5022Causes newlines within a paragraph to be ignored, rather than being
5023treated as spaces or as hard line breaks. This option is intended for
5024use with East Asian languages where spaces are not used between words,
5025but text is divided into lines for readability.
5027#### Extension: `east_asian_line_breaks` ####
5029Causes newlines within a paragraph to be ignored, rather than
5030being treated as spaces or as hard line breaks, when they occur
5031between two East Asian wide characters. This is a better choice
5032than `ignore_line_breaks` for texts that include a mix of East
5033Asian wide characters and other characters.
5035#### Extension: `emoji` ####
5037Parses textual emojis like `:smile:` as Unicode emoticons.
5039#### Extension: `tex_math_single_backslash` ####
5041Causes anything between `\(` and `\)` to be interpreted as inline
5042TeX math, and anything between `\[` and `\]` to be interpreted
5043as display TeX math. Note: a drawback of this extension is that
5044it precludes escaping `(` and `[`.
5046#### Extension: `tex_math_double_backslash` ####
5048Causes anything between `\\(` and `\\)` to be interpreted as inline
5049TeX math, and anything between `\\[` and `\\]` to be interpreted
5052#### Extension: `markdown_attribute` ####
5054By default, pandoc interprets material inside block-level tags as Markdown.
5055This extension changes the behavior so that Markdown is only parsed
5056inside block-level tags if the tags have the attribute `markdown=1`.
5058#### Extension: `mmd_title_block` ####
5060Enables a [MultiMarkdown] style title block at the top of
5061the document, for example:
5065 Date: September 1, 2008
5066 Comment: This is a sample mmd title block, with
5067 a field spanning multiple lines.
5069See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5070`yaml_metadata_block` is enabled, it will take precedence over
5073#### Extension: `abbreviations` ####
5075Parses PHP Markdown Extra abbreviation keys, like
5077 *[HTML]: Hypertext Markup Language
5079Note that the pandoc document model does not support
5080abbreviations, so if this extension is enabled, abbreviation keys are
5081simply skipped (as opposed to being parsed as paragraphs).
5083#### Extension: `autolink_bare_uris` ####
5085Makes all absolute URIs into links, even when not surrounded by
5086pointy braces `<...>`.
5088#### Extension: `mmd_link_attributes` ####
5090Parses multimarkdown style key-value attributes on link
5091and image references. This extension should not be confused with the
5092[`link_attributes`](#extension-link_attributes) extension.
5094 This is a reference ![image][ref] with multimarkdown attributes.
5096 [ref]: https://path.to/image "Image title" width=20px height=30px
5097 id=myId class="myClass1 myClass2"
5099#### Extension: `mmd_header_identifiers` ####
5101Parses multimarkdown style heading identifiers (in square brackets,
5102after the heading but before any trailing `#`s in an ATX heading).
5104#### Extension: `compact_definition_lists` ####
5106Activates the definition list syntax of pandoc 1.12.x and earlier.
5107This syntax differs from the one described above under [Definition lists]
5110 - No blank line is required between consecutive items of the
5112 - To get a "tight" or "compact" list, omit space between consecutive
5113 items; the space between a term and its definition does not affect
5115 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5116 be indented four spaces.[^6]
5118[^6]: To see why laziness is incompatible with relaxing the requirement
5119 of a blank line between items, consider the following example:
5126 Is this a single list item with two definitions of "bar," the first of
5127 which is lazily wrapped, or two list items? To remove the ambiguity
5128 we must either disallow lazy wrapping or require a blank line between
5131#### Extension: `gutenberg` ####
5133Use [Project Gutenberg] conventions for `plain` output:
5134all-caps for strong emphasis, surround by underscores
5135for regular emphasis, add extra blank space around headings.
5137 [Project Gutenberg]: https://www.gutenberg.org
5139#### Extension: `sourcepos` ####
5141Include source position attributes when parsing `commonmark`.
5142For elements that accept attributes, a `data-pos` attribute
5143is added; other elements are placed in a surrounding
5144Div or Span elemnet with a `data-pos` attribute.
5148In addition to pandoc's extended Markdown, the following Markdown
5149variants are supported:
5151- `markdown_phpextra` (PHP Markdown Extra)
5152- `markdown_github` (deprecated GitHub-Flavored Markdown)
5153- `markdown_mmd` (MultiMarkdown)
5154- `markdown_strict` (Markdown.pl)
5155- `commonmark` (CommonMark)
5156- `gfm` (Github-Flavored Markdown)
5157- `commonmark_x` (CommonMark with many pandoc extensions)
5159To see which extensions are supported for a given format,
5160and which are enabled by default, you can use the command
5162 pandoc --list-extensions=FORMAT
5164where `FORMAT` is replaced with the name of the format.
5166Note that the list of extensions for `commonmark`,
5167`gfm`, and `commonmark_x` are defined relative to default
5168commonmark. So, for example, `backtick_code_blocks`
5169does not appear as an extension, since it is enabled by
5170default and cannot be disabled.
5174When the `--citeproc` option is used, pandoc can automatically generate
5175citations and a bibliography in a number of styles. Basic usage is
5177 pandoc --citeproc myinput.txt
5179To use this feature, you will need to have
5181- a document containing citations (see [Extension: `citations`]);
5182- a source of bibliographic data: either an external bibliography
5183 file or a list of `references` in the document's YAML metadata
5184- optionally, a [CSL] citation style.
5186## Specifying bibliographic data
5188You can specify an external bibliography using the
5189`bibliography` metadata field in a YAML metadata section or the
5190`--bibliography` command line argument. If you want to use
5191multiple bibliography files, you can supply multiple
5192`--bibliography` arguments or set `bibliography` metadata field
5193to YAML array. A bibliography may have any of these formats:
5195 Format File extension
5196 ------------ --------------
5202Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5203use the extension `.bibtex` to force interpretation as BibTeX.
5205In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5206inside fields such as `title`; in CSL YAML databases, pandoc
5207Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5216`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5225`<span class="nocase">...</span>`
5226: prevent a phrase from being capitalized as title case
5228As an alternative to specifying a bibliography file using
5229`--bibliography` or the YAML metadata field `bibliography`, you
5230can include the citation data directly in the `references` field
5231of the document's YAML metadata. The field should contain an
5232array of YAML-encoded references, for example:
5236 - type: article-journal
5248 title: 'Molecular structure of nucleic acids: a structure for
5249 deoxyribose nucleic acid'
5250 title-short: Molecular structure of nucleic acids
5251 container-title: Nature
5255 DOI: 10.1038/171737a0
5256 URL: https://www.nature.com/articles/171737a0
5260If both an external bibliography and inline (YAML metadata)
5261references are provided, both will be used. In case of
5262conflicting `id`s, the inline references will take precedence.
5264Note that `pandoc` can be used to produce such a YAML metadata
5265section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5267 pandoc chem.bib -s -f biblatex -t markdown
5268 pandoc chem.json -s -f csljson -t markdown
5270Indeed, `pandoc` can convert between any of these
5273 pandoc chem.bib -s -f biblatex -t csljson
5274 pandoc chem.yaml -s -f markdown -t biblatex
5276Running pandoc on a bibliography file with the `--citeproc`
5277option will create a formatted bibliography in the format
5280 pandoc chem.bib -s --citeproc -o chem.html
5281 pandoc chem.bib -s --citeproc -o chem.pdf
5283### Capitalization in titles
5285If you are using a bibtex or biblatex bibliography, then observe
5288 - English titles should be in title case. Non-English titles should
5289 be in sentence case, and the `langid` field in biblatex should be
5290 set to the relevant language. (The following values are treated
5291 as English: `american`, `british`, `canadian`, `english`,
5292 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5294 - As is standard with bibtex/biblatex, proper names should be
5295 protected with curly braces so that they won't be lowercased
5296 in styles that call for sentence case. For example:
5298 title = {My Dinner with {Andre}}
5300 - In addition, words that should remain lowercase (or camelCase)
5301 should be protected:
5303 title = {Spin Wave Dispersion on the {nm} Scale}
5305 Though this is not necessary in bibtex/biblatex, it is necessary
5306 with citeproc, which stores titles internally in sentence case,
5307 and converts to title case in styles that require it. Here we
5308 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5310If you are using a CSL bibliography (either JSON or YAML), then observe
5313 - All titles should be in sentence case.
5315 - Use the `language` field for non-English titles to prevent their
5316 conversion to title case in styles that call for this. (Conversion
5317 happens only if `language` begins with `en` or is left empty.)
5319 - Protect words that should not be converted to title case using
5322 Spin wave dispersion on the <span class="nocase">nm</span> scale
5324### Conference Papers, Published vs. Unpublished
5326For a formally published conference paper, use the biblatex entry type
5327`inproceedings` (which will be mapped to CSL `paper-conference`).
5329For an unpublished manuscript, use the biblatex entry type
5330`unpublished` without an `eventtitle` field (this entry type
5331will be mapped to CSL `manuscript`).
5333For a talk, an unpublished conference paper, or a poster
5334presentation, use the biblatex entry type `unpublished` with an
5335`eventtitle` field (this entry type will be mapped to CSL
5336`speech`). Use the biblatex `type` field to indicate the type,
5337e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5338too, though `eventdate` will not be rendered by most CSL styles.
5339Note that `venue` is for the event's venue, unlike `location`
5340which describes the publisher's location; do not use the latter
5341for an unpublished conference paper.
5344## Specifying a citation style
5346Citations and references can be formatted using any style supported by the
5347[Citation Style Language], listed in the [Zotero Style Repository].
5348These files are specified using the `--csl` option or the `csl`
5349(or `citation-style`) metadata field. By default, pandoc will
5350use the [Chicago Manual of Style] author-date format. (You can
5351override this default by copying a CSL style of your choice
5352to `default.csl` in your user data directory.)
5353The CSL project provides further information on [finding and
5356The `--citation-abbreviations` option (or the
5357`citation-abbreviations` metadata field) may be used to specify
5358a JSON file containing abbreviations of journals that should be
5359used in formatted bibliographies when `form="short"` is
5360specified. The format of the file can be illustrated with an
5365 "container-title": {
5366 "Lloyd's Law Reports": "Lloyd's Rep",
5367 "Estates Gazette": "EG",
5368 "Scots Law Times": "SLT"
5374## Citations in note styles
5376Pandoc's citation processing is designed to allow you to
5377move between author-date, numerical, and note styles without
5378modifying the markdown source. When you're using a note
5379style, avoid inserting footnotes manually. Instead, insert
5380citations just as you would in an author-date style---for
5383 Blah blah [@foo, p. 33].
5385The footnote will be created automatically. Pandoc will take
5386care of removing the space and moving the note before or
5387after the period, depending on the setting of
5388`notes-after-punctuation`, as described below in [Other relevant
5391In some cases you may need to put a citation inside a regular
5392footnote. Normal citations in footnotes (such as `[@foo, p.
539333]`) will be rendered in parentheses. In-text citations (such
5394as `@foo [p. 33]`) will be rendered without parentheses. (A
5395comma will be added if appropriate.) Thus:
5397 [^1]: Some studies [@foo; @bar, p. 33] show that
5398 frubulicious zoosnaps are quantical. For a survey
5399 of the literature, see @baz [chap. 1].
5401## Raw content in a style
5403To include raw content in a prefix, suffix, delimiter, or term,
5404surround it with these tags indicating the format:
5406 {{jats}}<ref>{{/jats}}
5408Without the tags, the string will be interpreted as a string
5409and escaped in the output, rather than being passed through raw.
5411This feature allows stylesheets to be customized to give
5412different output for different output formats. However,
5413stylesheets customized in this way will not be usable
5414by other CSL implementations.
5418## Placement of the bibliography
5420If the style calls for a list of works cited, it will be placed
5421in a div with id `refs`, if one exists:
5426Otherwise, it will be placed at the end of the document.
5427Generation of the bibliography can be suppressed by setting
5428`suppress-bibliography: true` in the YAML metadata.
5430If you wish the bibliography to have a section heading, you can
5431set `reference-section-title` in the metadata, or put the heading
5432at the beginning of the div with id `refs` (if you are using it)
5433or at the end of your document:
5439The bibliography will be inserted after this heading. Note that
5440the `unnumbered` class will be added to this heading, so that the
5441section will not be numbered.
5443## Including uncited items in the bibliography
5445If you want to include items in the bibliography without actually
5446citing them in the body text, you can define a dummy `nocite` metadata
5447field and put the citations there:
5456In this example, the document will contain a citation for `item3`
5457only, but the bibliography will contain entries for `item1`, `item2`, and
5460It is possible to create a bibliography with all the citations,
5461whether or not they appear in the document, by using a wildcard:
5468For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5469render the bibliography. In order to do so, specify bibliography
5470files as outlined above, and add `--natbib` or `--biblatex`
5471argument to `pandoc` invocation. Bear in mind that bibliography
5472files have to be in either BibTeX (for `--natbib`)
5473or BibLaTeX (for `--biblatex`) format.
5475## Other relevant metadata fields
5477A few other metadata fields affect bibliography formatting:
5480: If true, citations will be
5481 hyperlinked to the corresponding bibliography entries
5482 (for author-date and numerical styles only).
5485: The `lang` field will affect how the style is localized,
5486 for example in the translation of labels and the use
5487 of quotation marks. (For backwards compatibility,
5488 `locale` may be used instead of `lang`, but this use
5491`notes-after-punctuation`
5492: If true (the default), pandoc will put footnote citations
5493 after following punctuation. For example, if the source
5494 contains `blah blah [@jones99].`, the result will look like
5495 `blah blah.[^1]`, with the note moved after the period and
5496 the space collapsed. If false, the space will still be
5497 collapsed, but the footnote will not be moved after the
5509You can use pandoc to produce an HTML + JavaScript slide presentation
5510that can be viewed via a web browser. There are five ways to do this,
5511using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5512You can also produce a PDF slide show using LaTeX [`beamer`], or
5513slides shows in Microsoft [PowerPoint] format.
5515Here's the Markdown source for a simple slide show, `habits.txt`:
5542 
5549To produce an HTML/JavaScript slide show, simply type
5551 pandoc -t FORMAT -s habits.txt -o habits.html
5553where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5555For Slidy, Slideous, reveal.js, and S5, the file produced by
5556pandoc with the `-s/--standalone` option embeds a link to
5557JavaScript and CSS files, which are assumed to be available at
5558the relative path `s5/default` (for S5), `slideous` (for
5559Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5560at `w3.org` (for Slidy). (These paths can be changed by setting
5561the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5562variables; see [Variables for HTML slides], above.) For
5563DZSlides, the (relatively short) JavaScript and CSS are included
5564in the file by default.
5566With all HTML slide formats, the `--self-contained` option can
5567be used to produce a single file that contains all of the data
5568necessary to display the slide show, including linked scripts,
5569stylesheets, images, and videos.
5571To produce a PDF slide show using beamer, type
5573 pandoc -t beamer habits.txt -o habits.pdf
5575Note that a reveal.js slide show can also be converted to a PDF
5576by printing it to a file from the browser.
5578To produce a Powerpoint slide show, type
5580 pandoc habits.txt -o habits.pptx
5582## Structuring the slide show
5584By default, the *slide level* is the highest heading level in
5585the hierarchy that is followed immediately by content, and not another
5586heading, somewhere in the document. In the example above, level-1 headings
5587are always followed by level-2 headings, which are followed by content,
5588so the slide level is 2. This default can be overridden using
5589the `--slide-level` option.
5591The document is carved up into slides according to the following
5594 * A horizontal rule always starts a new slide.
5596 * A heading at the slide level always starts a new slide.
5598 * Headings *below* the slide level in the hierarchy create
5599 headings *within* a slide.
5601 * Headings *above* the slide level in the hierarchy create
5602 "title slides," which just contain the section title
5603 and help to break the slide show into sections.
5604 Non-slide content under these headings will be included
5605 on the title slide (for HTML slide shows) or in a
5606 subsequent slide with the same title (for beamer).
5608 * A title page is constructed automatically from the document's title
5609 block, if present. (In the case of beamer, this can be disabled
5610 by commenting out some lines in the default template.)
5612These rules are designed to support many different styles of slide show. If
5613you don't care about structuring your slides into sections and subsections,
5614you can just use level-1 headings for all each slide. (In that case, level-1
5615will be the slide level.) But you can also structure the slide show into
5616sections, as in the example above.
5618Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5619layout will be produced, with level-1 headings building horizontally
5620and level-2 headings building vertically. It is not recommended that
5621you use deeper nesting of section levels with reveal.js.
5625By default, these writers produce lists that display "all at once."
5626If you want your lists to display incrementally (one item at a time),
5627use the `-i` option. If you want a particular list to depart from the
5628default, put it in a `div` block with class `incremental` or
5629`nonincremental`. So, for example, using the `fenced div` syntax, the
5630following would be incremental regardless of the document default:
5648While using `incremental` and `nonincremental` divs are the
5649recommended method of setting incremental lists on a per-case basis,
5650an older method is also supported: putting lists inside a blockquote
5651will depart from the document default (that is, it will display
5652incrementally without the `-i` option and all at once with the `-i`
5658Both methods allow incremental and nonincremental lists to be mixed
5659in a single document.
5661Note: Neither the `-i/--incremental` option nor any of the
5662methods described here currently works for PowerPoint output.
5666You can add "pauses" within a slide by including a paragraph containing
5667three dots, separated by spaces:
5669 # Slide with a pause
5671 content before the pause
5675 content after the pause
5677Note: this feature is not yet implemented for PowerPoint output.
5679## Styling the slides
5681You can change the style of HTML slides by putting customized CSS files
5682in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5683or `$DATADIR/slideous` (for Slideous),
5684where `$DATADIR` is the user data directory (see `--data-dir`, above).
5685The originals may be found in pandoc's system data directory (generally
5686`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5687files it does not find in the user data directory.
5689For dzslides, the CSS is included in the HTML file itself, and may
5692All [reveal.js configuration options] can be set through variables.
5693For example, themes can be used by setting the `theme` variable:
5697Or you can specify a custom stylesheet using the `--css` option.
5699To style beamer slides, you can specify a `theme`, `colortheme`,
5700`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5702 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5704Note that heading attributes will turn into slide attributes
5705(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5706to style individual slides. In beamer, the only heading attribute
5707that affects slides is the `allowframebreaks` class, which sets the
5708`allowframebreaks` option, causing multiple slides to be created
5709if the content overfills the frame. This is recommended especially for
5712 # References {.allowframebreaks}
5716Speaker notes are supported in reveal.js and PowerPoint (pptx)
5717output. You can add notes to your Markdown document thus:
5723 - It can contain Markdown
5728To show the notes window in reveal.js, press `s` while viewing the
5729presentation. Speaker notes in PowerPoint will be available, as usual,
5730in handouts and presenter view.
5732Notes are not yet supported for other slide formats, but the notes
5733will not appear on the slides themselves.
5737To put material in side by side columns, you can use a native
5738div container with class `columns`, containing two or more div
5739containers with class `column` and a `width` attribute:
5741 :::::::::::::: {.columns}
5742 ::: {.column width="40%"}
5745 ::: {.column width="60%"}
5750### Additional columns attributes in beamer
5752The div containers with classes `columns` and `column` can optionally have
5753an `align` attribute.
5754The class `columns` can optionally have a `totalwidth` attribute or an
5755`onlytextwidth` class.
5757 :::::::::::::: {.columns align=center totalwidth=8em}
5758 ::: {.column width="40%"}
5761 ::: {.column width="60%" align=bottom}
5766The `align` attributes on `columns` and `column` can be used with the
5767values `top`, `top-baseline`, `center` and `bottom` to vertically align
5768the columns. It defaults to `top` in `columns`.
5770The `totalwidth` attribute limits the width of the columns to the given value.
5772 :::::::::::::: {.columns align=top .onlytextwidth}
5773 ::: {.column width="40%" align=center}
5776 ::: {.column width="60%"}
5781The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5783See Section 12.7 of the [Beamer User's Guide] for more details.
5785## Frame attributes in beamer
5787Sometimes it is necessary to add the LaTeX `[fragile]` option to
5788a frame in beamer (for example, when using the `minted` environment).
5789This can be forced by adding the `fragile` class to the heading
5790introducing the slide:
5792 # Fragile slide {.fragile}
5794All of the other frame attributes described in Section 8.1 of
5795the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5796`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5797`shrink`, `standout`, `noframenumbering`.
5799## Background in reveal.js and beamer
5801Background images can be added to self-contained reveal.js slideshows and
5802to beamer slideshows.
5804For the same image on every slide, use the configuration
5805option `background-image` either in the YAML metadata block
5806or as a command-line variable. (There are no other options in
5807beamer and the rest of this section concerns reveal.js slideshows.)
5809For reveal.js, you can instead use the reveal.js-native option
5810`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5811and `parallaxBackgroundVertical` the same way and must also set
5812`parallaxBackgroundSize` to have your values take effect.
5814To set an image for a particular reveal.js slide, add
5815`{data-background-image="/path/to/image"}`
5816to the first slide-level heading on the slide (which may even be empty).
5818In reveal.js's overview mode, the parallaxBackgroundImage will show up
5819only on the first slide.
5821Other reveal.js background settings also work on individual slides, including
5822`data-background-size`, `data-background-repeat`, `data-background-color`,
5823`data-transition`, and `data-transition-speed`.
5825To add a background image to the automatically generated title slide, use the
5826`title-slide-attributes` variable in the YAML metadata block. It must contain
5827a map of attribute names and values.
5829See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5832For example in reveal.js:
5837parallaxBackgroundImage: /path/to/my/background_image.png
5838title-slide-attributes:
5839 data-background-image: /path/to/title_image.png
5840 data-background-size: contain
5845Slide 1 has background_image.png as its background.
5847## {data-background-image="/path/to/special_image.jpg"}
5849Slide 2 has a special image for its background, even though the heading has no content.
5856EPUB metadata may be specified using the `--epub-metadata` option, but
5857if the source document is Markdown, it is better to use a [YAML metadata
5858block][Extension: `yaml_metadata_block`]. Here is an example:
5865 text: An investigation of metadata
5873 text: doi:10.234234.234/33
5875 rights: © 2007 John Smith, CC BY-NC
5880The following fields are recognized:
5883 ~ Either a string value or an object with fields `text` and
5884 `scheme`. Valid values for `scheme` are `ISBN-10`,
5885 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5886 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5887 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5890 ~ Either a string value, or an object with fields `file-as` and
5891 `type`, or a list of such objects. Valid values for `type` are
5892 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5895 ~ Either a string value, or an object with fields `role`, `file-as`,
5896 and `text`, or a list of such objects. Valid values for `role` are
5897 [MARC relators], but
5898 pandoc will attempt to translate the human-readable versions
5899 (like "author" and "editor") to the appropriate marc relators.
5902 ~ Same format as `creator`.
5905 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5906 Pandoc will attempt to convert other common date formats.
5908`lang` (or legacy: `language`)
5909 ~ A string value in [BCP 47] format. Pandoc will default to the local
5910 language if nothing is specified.
5913 ~ A string value or a list of such values.
5934 ~ A string value (path to cover image).
5936`css` (or legacy: `stylesheet`)
5937 ~ A string value (path to CSS stylesheet).
5939`page-progression-direction`
5940 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5941 attribute for the [`spine` element].
5944 ~ iBooks-specific metadata, with the following fields:
5946 - `version`: (string)
5947 - `specified-fonts`: `true`|`false` (default `false`)
5948 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5949 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5950 - `binding`: `true`|`false` (default `true`)
5951 - `scroll-axis`: `vertical`|`horizontal`|`default`
5953[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5954[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5956## The `epub:type` attribute
5958For `epub3` output, you can mark up the heading that corresponds to an EPUB
5959chapter using the [`epub:type` attribute][epub-type]. For example, to set
5960the attribute to the value `prologue`, use this markdown:
5962 # My chapter {epub:type=prologue}
5964Which will result in:
5966 <body epub:type="frontmatter">
5967 <section epub:type="prologue">
5970Pandoc will output `<body epub:type="bodymatter">`, unless
5971you use one of the following values, in which case either
5972`frontmatter` or `backmatter` will be output.
5974`epub:type` of first section `epub:type` of body
5975---------------------------- ------------------
5978acknowledgments frontmatter
5979copyright-page frontmatter
5980dedication frontmatter
5984contributors frontmatter
5985other-credits frontmatter
5987revision-history frontmatter
5988titlepage frontmatter
5989halftitlepage frontmatter
5990seriespage frontmatter
5995bibliography backmatter
5998[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6002By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6003`<video>` or `<source>` element present in the generated EPUB,
6004and include it in the EPUB container, yielding a completely
6005self-contained EPUB. If you want to link to external media resources
6006instead, use raw HTML in your source and add `data-external="1"` to the tag
6007with the `src` attribute. For example:
6009 <audio controls="1">
6010 <source src="https://example.com/music/toccata.mp3"
6011 data-external="1" type="audio/mpeg">
6017When creating a [Jupyter notebook], pandoc will try to infer the
6018notebook structure. Code blocks with the class `code` will be
6019taken as code cells, and intervening content will be taken as
6020Markdown cells. Attachments will automatically be created for
6021images in Markdown cells. Metadata will be taken from the
6022`jupyter` metadata field. For example:
6031 display_name: Python 2
6038 file_extension: ".py"
6039 mimetype: "text/x-python"
6041 nbconvert_exporter: "python"
6042 pygments_lexer: "ipython2"
6048**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6049bibendum felis dictum sodales.
6058from IPython.display import HTML
6061console.log("hello");
6069This image  will be
6070included as a cell attachment.
6073If you want to add cell attributes, group cells differently, or
6074add output to code cells, then you need to include divs to
6075indicate the structure. You can use either [fenced
6076divs][Extension: `fenced_divs`] or [native divs][Extension:
6077`native_divs`] for this. Here is an example:
6080:::::: {.cell .markdown}
6083**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6084bibendum felis dictum sodales.
6087:::::: {.cell .code execution_count=1}
6092::: {.output .stream .stdout}
6099:::::: {.cell .code execution_count=2}
6101from IPython.display import HTML
6104console.log("hello");
6110::: {.output .execute_result execution_count=2}
6113console.log("hello");
6122If you include raw HTML or TeX in an output cell, use the
6123[raw attribute][Extension: `fenced_attribute`], as shown
6124in the last cell of the example above. Although pandoc can
6125process "bare" raw HTML and TeX, the result is often
6126interspersed raw elements and normal textual elements, and
6127in an output cell pandoc expects a single, connected raw
6128block. To avoid using raw HTML or TeX except when
6129marked explicitly using raw attributes, we recommend
6130specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6131translating between Markdown and ipynb notebooks.
6133Note that options and extensions that affect reading and
6134writing of Markdown will also affect Markdown cells in ipynb
6135notebooks. For example, `--wrap=preserve` will preserve
6136soft line breaks in Markdown cells; `--atx-headers` will
6137cause ATX-style headings to be used; and `--preserve-tabs` will
6138prevent tabs from being turned to spaces.
6140# Syntax highlighting
6142Pandoc will automatically highlight syntax in [fenced code blocks] that
6143are marked with a language name. The Haskell library [skylighting] is
6144used for highlighting. Currently highlighting is supported only for
6145HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6146that pandoc will recognize, type `pandoc --list-highlight-languages`.
6148The color scheme can be selected using the `--highlight-style` option.
6149The default color scheme is `pygments`, which imitates the default color
6150scheme used by the Python library pygments (though pygments is not actually
6151used to do the highlighting). To see a list of highlight styles,
6152type `pandoc --list-highlight-styles`.
6154If you are not satisfied with the predefined styles, you can
6155use `--print-highlight-style` to generate a JSON `.theme` file which
6156can be modified and used as the argument to `--highlight-style`. To
6157get a JSON version of the `pygments` style, for example:
6159 pandoc --print-highlight-style pygments > my.theme
6161Then edit `my.theme` and use it like this:
6163 pandoc --highlight-style my.theme
6165If you are not satisfied with the built-in highlighting, or you
6166want highlight a language that isn't supported, you can use the
6167`--syntax-definition` option to load a [KDE-style XML syntax definition
6168file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6169Before writing your own, have a look at KDE's [repository of syntax
6170definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6172To disable highlighting, use the `--no-highlight` option.
6174[skylighting]: https://github.com/jgm/skylighting
6178Custom styles can be used in the docx and ICML formats.
6182By default, pandoc's docx and ICML output applies a predefined set of styles
6183for blocks such as paragraphs and block quotes, and uses largely default
6184formatting (italics, bold) for inlines. This will work for most
6185purposes, especially alongside a `reference.docx` file. However, if you
6186need to apply your own styles to blocks, or match a preexisting set of
6187styles, pandoc allows you to define custom styles for blocks and text
6188using `div`s and `span`s, respectively.
6190If you define a `div` or `span` with the attribute `custom-style`,
6191pandoc will apply your specified style to the contained elements (with
6192the exception of elements whose function depends on a style, like
6193headings, code blocks, block quotes, or links). So, for example, using
6194the `bracketed_spans` syntax,
6196 [Get out]{custom-style="Emphatically"}, he said.
6198would produce a docx file with "Get out" styled with character
6199style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6201 Dickinson starts the poem simply:
6203 ::: {custom-style="Poetry"}
6204 | A Bird came down the Walk---
6205 | He did not know I saw---
6208would style the two contained lines with the `Poetry` paragraph style.
6210For docx output, styles will be defined in the output file as inheriting
6211from normal text, if the styles are not yet in your reference.docx.
6212If they are already defined, pandoc will not alter the definition.
6214This feature allows for greatest customization in conjunction with
6215[pandoc filters]. If you want all paragraphs after block quotes to be
6216indented, you can write a filter to apply the styles necessary. If you
6217want all italics to be transformed to the `Emphasis` character style
6218(perhaps to change their color), you can write a filter which will
6219transform all italicized inlines to inlines within an `Emphasis`
6222For docx output, you don't need to enable any extensions for
6223custom styles to work.
6225[pandoc filters]: https://pandoc.org/filters.html
6229The docx reader, by default, only reads those styles that it can
6230convert into pandoc elements, either by direct conversion or
6231interpreting the derivation of the input document's styles.
6233By enabling the [`styles` extension](#ext-styles) in the docx reader
6234(`-f docx+styles`), you can produce output that maintains the styles
6235of the input document, using the `custom-style` class. Paragraph
6236styles are interpreted as divs, while character styles are interpreted
6239For example, using the `custom-style-reference.docx` file in the test
6240directory, we have the following different outputs:
6242Without the `+styles` extension:
6244 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6247 This is text with an *emphasized* text style. And this is text with a
6248 **strengthened** text style.
6250 > Here is a styled paragraph that inherits from Block Text.
6252And with the extension:
6254 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6256 ::: {custom-style="First Paragraph"}
6260 ::: {custom-style="Body Text"}
6261 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6262 And this is text with a [strengthened]{custom-style="Strengthened"}
6266 ::: {custom-style="My Block Style"}
6267 > Here is a styled paragraph that inherits from Block Text.
6270With these custom styles, you can use your input document as a
6271reference-doc while creating docx output (see below), and maintain the
6272same styles in your input and output files.
6276Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6277includes a Lua interpreter, so Lua need not be installed separately.)
6279To use a custom writer, simply specify the path to the Lua script
6280in place of the output format. For example:
6282 pandoc -t data/sample.lua
6284Creating a custom writer requires writing a Lua function for each
6285possible element in a pandoc document. To get a documented example
6286which you can modify according to your needs, do
6288 pandoc --print-default-data-file sample.lua
6290Note that custom writers have no default template. If you want
6291to use `--standalone` with a custom writer, you will need to
6292specify a template manually using `--template` or add a new
6293default template with the name
6294`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6295subdirectory of your user data directory (see [Templates]).
6297[Lua]: https://www.lua.org
6301If you use pandoc to convert user-contributed content in a web
6302application, here are some things to keep in mind:
63041. Although pandoc itself will not create or modify any files other
6305 than those you explicitly ask it create (with the exception
6306 of temporary files used in producing PDFs), a filter or custom
6307 writer could in principle do anything on your file system. Please
6308 audit filters and custom writers very carefully before using them.
63102. If your application uses pandoc as a Haskell library (rather than
6311 shelling out to the executable), it is possible to use it in a mode
6312 that fully isolates pandoc from your file system, by running the
6313 pandoc operations in the `PandocPure` monad. See the document
6314 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
63173. Pandoc's parsers can exhibit pathological performance on some
6318 corner cases. It is wise to put any pandoc operations under
6319 a timeout, to avoid DOS attacks that exploit these issues.
6320 If you are using the pandoc executable, you can add the
6321 command line options `+RTS -M512M -RTS` (for example) to limit
6322 the heap size to 512MB.
63244. The HTML generated by pandoc is not guaranteed to be safe.
6325 If `raw_html` is enabled for the Markdown input, users can
6326 inject arbitrary HTML. Even if `raw_html` is disabled,
6327 users can include dangerous content in attributes for
6328 headings, spans, and code blocks. To be safe, you should
6329 run all the generated HTML through an HTML sanitizer.
6333Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
6334under the [GPL], version 2 or greater. This software carries no
6335warranty of any kind. (See COPYRIGHT for full copyright and
6336warranty notices.) For a full list of contributors, see the file
6337AUTHORS.md in the pandoc source code.
6339[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6340[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