2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: https://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`iftex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `lualatex` uses
147[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149`mathspec` variable is set, `xelatex` will use [`mathspec`]
150instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151packages are used if available, and [`csquotes`] will be used
152for [typography] if the `csquotes` variable or metadata field is
153set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`iftex`]: https://ctan.org/pkg/iftex
184[`listings`]: https://ctan.org/pkg/listings
185[`lm`]: https://ctan.org/pkg/lm
186[`longtable`]: https://ctan.org/pkg/longtable
187[`mathspec`]: https://ctan.org/pkg/mathspec
188[`microtype`]: https://ctan.org/pkg/microtype
189[`natbib`]: https://ctan.org/pkg/natbib
190[`parskip`]: https://ctan.org/pkg/parskip
191[`polyglossia`]: https://ctan.org/pkg/polyglossia
192[`prince`]: https://www.princexml.com/
193[`setspace`]: https://ctan.org/pkg/setspace
194[`ulem`]: https://ctan.org/pkg/ulem
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
196[`upquote`]: https://ctan.org/pkg/upquote
197[`weasyprint`]: https://weasyprint.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
199[`xcolor`]: https://ctan.org/pkg/xcolor
200[`xecjk`]: https://ctan.org/pkg/xecjk
201[`xurl`]: https://ctan.org/pkg/xurl
202[`selnolig`]: https://ctan.org/pkg/selnolig
206## Reading from the Web
208Instead of an input file, an absolute URI may be given. In this case
209pandoc will fetch the content using HTTP:
211 pandoc -f html -t markdown https://www.fsf.org
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
221## General options {.options}
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
225: Specify input format. *FORMAT* can be:
228 - `bibtex` ([BibTeX] bibliography)
229 - `biblatex` ([BibLaTeX] bibliography)
230 - `commonmark` ([CommonMark] Markdown)
231 - `commonmark_x` ([CommonMark] Markdown with extensions)
232 - `creole` ([Creole 1.0])
233 - `csljson` ([CSL JSON] bibliography)
234 - `csv` ([CSV] table)
235 - `docbook` ([DocBook])
236 - `docx` ([Word docx])
237 - `dokuwiki` ([DokuWiki markup])
239 - `fb2` ([FictionBook2] e-book)
240 - `gfm` ([GitHub-Flavored Markdown]),
241 or the deprecated and less accurate `markdown_github`;
242 use [`markdown_github`](#markdown-variants) only
243 if you need extensions not supported in [`gfm`](#markdown-variants).
244 - `haddock` ([Haddock markup])
246 - `ipynb` ([Jupyter notebook])
247 - `jats` ([JATS] XML)
248 - `jira` ([Jira]/Confluence wiki markup)
249 - `json` (JSON version of native AST)
251 - `markdown` ([Pandoc's Markdown])
252 - `markdown_mmd` ([MultiMarkdown])
253 - `markdown_phpextra` ([PHP Markdown Extra])
254 - `markdown_strict` (original unextended [Markdown])
255 - `mediawiki` ([MediaWiki markup])
258 - `native` (native Haskell)
261 - `org` ([Emacs Org mode])
262 - `rst` ([reStructuredText])
264 - `textile` ([Textile])
265 - `tikiwiki` ([TikiWiki markup])
266 - `twiki` ([TWiki markup])
267 - `vimwiki` ([Vimwiki])
270 Extensions can be individually enabled or disabled by
271 appending `+EXTENSION` or `-EXTENSION` to the format name.
272 See [Extensions] below, for a list of extensions and
273 their names. See `--list-input-formats` and `--list-extensions`,
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
278: Specify output format. *FORMAT* can be:
280 ::: {#output-formats}
281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283 - `bibtex` ([BibTeX] bibliography)
284 - `biblatex` ([BibLaTeX] bibliography)
285 - `commonmark` ([CommonMark] Markdown)
286 - `commonmark_x` ([CommonMark] Markdown with extensions)
287 - `context` ([ConTeXt])
288 - `csljson` ([CSL JSON] bibliography)
289 - `docbook` or `docbook4` ([DocBook] 4)
290 - `docbook5` (DocBook 5)
291 - `docx` ([Word docx])
292 - `dokuwiki` ([DokuWiki markup])
293 - `epub` or `epub3` ([EPUB] v3 book)
295 - `fb2` ([FictionBook2] e-book)
296 - `gfm` ([GitHub-Flavored Markdown]),
297 or the deprecated and less accurate `markdown_github`;
298 use [`markdown_github`](#markdown-variants) only
299 if you need extensions not supported in [`gfm`](#markdown-variants).
300 - `haddock` ([Haddock markup])
301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302 - `html4` ([XHTML] 1.0 Transitional)
303 - `icml` ([InDesign ICML])
304 - `ipynb` ([Jupyter notebook])
305 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308 - `jats` (alias for `jats_archiving`)
309 - `jira` ([Jira]/Confluence wiki markup)
310 - `json` (JSON version of native AST)
313 - `markdown` ([Pandoc's Markdown])
314 - `markdown_mmd` ([MultiMarkdown])
315 - `markdown_phpextra` ([PHP Markdown Extra])
316 - `markdown_strict` (original unextended [Markdown])
317 - `mediawiki` ([MediaWiki markup])
320 - `native` (native Haskell),
321 - `odt` ([OpenOffice text document][ODT])
323 - `opendocument` ([OpenDocument])
324 - `org` ([Emacs Org mode])
326 - `plain` (plain text),
327 - `pptx` ([PowerPoint] slide show)
328 - `rst` ([reStructuredText])
329 - `rtf` ([Rich Text Format])
330 - `texinfo` ([GNU Texinfo])
331 - `textile` ([Textile])
332 - `slideous` ([Slideous] HTML and JavaScript slide show)
333 - `slidy` ([Slidy] HTML and JavaScript slide show)
334 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336 - `s5` ([S5] HTML and JavaScript slide show)
337 - `tei` ([TEI Simple])
338 - `xwiki` ([XWiki markup])
339 - `zimwiki` ([ZimWiki markup])
340 - the path of a custom Lua writer, see [Custom writers] below
343 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344 to *stdout* unless forced with `-o -`.
346 Extensions can be individually enabled or
347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348 name. See [Extensions] below, for a list of extensions and their
349 names. See `--list-output-formats` and `--list-extensions`, below.
351`-o` *FILE*, `--output=`*FILE*
353: Write output to *FILE* instead of *stdout*. If *FILE* is
354 `-`, output will go to *stdout*, even if a non-textual format
355 (`docx`, `odt`, `epub2`, `epub3`) is specified.
357`--data-dir=`*DIRECTORY*
359: Specify the user data directory to search for pandoc data files.
360 If this option is not specified, the default user data directory
361 will be used. On \*nix and macOS systems this will be the `pandoc`
362 subdirectory of the XDG data directory (by default,
363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364 environment variable). If that directory does not exist,
365 `$HOME/.pandoc` will be used (for backwards compatibility).
366 In Windows the default user data directory is
367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
368 You can find the default user data directory on your system by
369 looking at the output of `pandoc --version`.
370 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371 `slidy`, `slideous`, or `s5` directory
372 placed in this directory will override pandoc's normal defaults.
374`-d` *FILE*, `--defaults=`*FILE*
376: Specify a set of default option settings. *FILE* is a YAML
377 file whose fields correspond to command-line option
378 settings. All options for document conversion, including input
379 and output files, can be set using a defaults file. The file will
380 be searched for first in the working directory, and then in
381 the `defaults` subdirectory of the user data directory
382 (see `--data-dir`). The `.yaml` extension may be omitted.
383 See the section [Default files] for more information on the
384 file format. Settings from the defaults file may be
385 overridden or extended by subsequent options on the command
390: Generate a bash completion script. To enable bash completion
391 with pandoc, add this to your `.bashrc`:
393 eval "$(pandoc --bash-completion)"
397: Give verbose debugging output.
401: Suppress warning messages.
405: Exit with error status if there are any warnings.
409: Write log messages in machine-readable JSON format to
410 *FILE*. All messages above DEBUG level will be written,
411 regardless of verbosity settings (`--verbose`, `--quiet`).
413`--list-input-formats`
415: List supported input formats, one per line.
417`--list-output-formats`
419: List supported output formats, one per line.
421`--list-extensions`[`=`*FORMAT*]
423: List supported extensions for *FORMAT*, one per line, preceded
424 by a `+` or `-` indicating whether it is enabled by default
425 in *FORMAT*. If *FORMAT* is not specified, defaults for
426 pandoc's Markdown are given.
428`--list-highlight-languages`
430: List supported languages for syntax highlighting, one per
433`--list-highlight-styles`
435: List supported styles for syntax highlighting, one per line.
436 See `--highlight-style`.
446[Markdown]: https://daringfireball.net/projects/markdown/
447[CommonMark]: https://commonmark.org
448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452[S5]: https://meyerweb.com/eric/tools/s5/
453[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454[Slideous]: https://goessner.net/articles/slideous/
455[HTML]: https://www.w3.org/html/
456[HTML5]: https://html.spec.whatwg.org/
457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458[XHTML]: https://www.w3.org/TR/xhtml1/
459[LaTeX]: https://www.latex-project.org/
460[`beamer`]: https://ctan.org/pkg/beamer
461[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462[ConTeXt]: https://www.contextgarden.net/
463[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464[DocBook]: https://docbook.org
465[JATS]: https://jats.nlm.nih.gov
466[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467[txt2tags]: https://txt2tags.org
468[EPUB]: http://idpf.org/epub
469[OPML]: http://dev.opml.org/spec2.html
470[OpenDocument]: http://opendocument.xml.org
471[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472[Textile]: https://www.promptworks.com/textile
473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481[CSV]: https://tools.ietf.org/html/rfc4180
482[roff man]: https://man.cx/groff_man(7)
483[roff ms]: https://man.cx/groff_ms(7)
484[Haskell]: https://www.haskell.org
485[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486[Emacs Org mode]: https://orgmode.org
487[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488[AsciiDoctor]: https://asciidoctor.org/
489[DZSlides]: http://paulrouget.com/dzslides/
490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491[PDF]: https://www.adobe.com/pdf/
492[reveal.js]: https://revealjs.com/
493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496[TEI Simple]: https://github.com/TEIC/TEI-Simple
497[Muse]: https://amusewiki.org/library/manual
498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499[Vimwiki]: https://vimwiki.github.io
500[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501[BibTeX]: https://ctan.org/pkg/bibtex
502[BibLaTeX]: https://ctan.org/pkg/biblatex
504## Reader options {.options}
506`--shift-heading-level-by=`*NUMBER*
508: Shift heading levels by a positive or negative integer.
509 For example, with `--shift-heading-level-by=-1`, level 2
510 headings become level 1 headings, and level 3 headings
511 become level 2 headings. Headings cannot have a level
512 less than 1, so a heading that would be shifted below level 1
513 becomes a regular paragraph. Exception: with a shift of -N,
514 a level-N heading at the beginning of the document
515 replaces the metadata title. `--shift-heading-level-by=-1`
516 is a good choice when converting HTML or Markdown documents that
517 use an initial level-1 heading for the document title and
518 level-2+ headings for sections. `--shift-heading-level-by=1`
519 may be a good choice for converting Markdown documents that
520 use level-1 headings for sections to HTML, since pandoc uses
521 a level-1 heading to render the document title.
523`--base-header-level=`*NUMBER*
525: *Deprecated. Use `--shift-heading-level-by`=X instead,
526 where X = NUMBER - 1.* Specify the base level for headings
529`--strip-empty-paragraphs`
531: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532 Ignore paragraphs with no content. This option is useful
533 for converting word processing documents where users have
534 used empty paragraphs to create inter-paragraph space.
536`--indented-code-classes=`*CLASSES*
538: Specify classes to use for indented code blocks--for example,
539 `perl,numberLines` or `haskell`. Multiple classes may be separated
542`--default-image-extension=`*EXTENSION*
544: Specify a default extension to use when image paths/URLs have no
545 extension. This allows you to use the same source for formats that
546 require different kinds of images. Currently this option only affects
547 the Markdown and LaTeX readers.
551: Parse each file individually before combining for multifile
552 documents. This will allow footnotes in different files with the
553 same identifiers to work as expected. If this option is set,
554 footnotes and links will not work across files. Reading binary
555 files (docx, odt, epub) implies `--file-scope`.
557`-F` *PROGRAM*, `--filter=`*PROGRAM*
559: Specify an executable to be used as a filter transforming the
560 pandoc AST after the input is parsed and before the output is
561 written. The executable should read JSON from stdin and write
562 JSON to stdout. The JSON must be formatted like pandoc's own
563 JSON input and output. The name of the output format will be
564 passed to the filter as the first argument. Hence,
566 pandoc --filter ./caps.py -t latex
570 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
572 The latter form may be useful for debugging filters.
574 Filters may be written in any language. `Text.Pandoc.JSON`
575 exports `toJSONFilter` to facilitate writing filters in Haskell.
576 Those who would prefer to write filters in python can use the
577 module [`pandocfilters`], installable from PyPI. There are also
578 pandoc filter libraries in [PHP], [perl], and
579 [JavaScript/node.js].
581 In order of preference, pandoc will look for filters in
583 1. a specified full or relative path (executable or
586 2. `$DATADIR/filters` (executable or non-executable)
587 where `$DATADIR` is the user data directory (see
588 `--data-dir`, above).
590 3. `$PATH` (executable only)
592 Filters, Lua-filters, and citeproc processing are applied in
593 the order specified on the command line.
595`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
597: Transform the document in a similar fashion as JSON filters (see
598 `--filter`), but use pandoc's built-in Lua filtering system. The given
599 Lua script is expected to return a list of Lua filters which will be
600 applied in order. Each Lua filter must contain element-transforming
601 functions indexed by the name of the AST element on which the filter
602 function should be applied.
604 The `pandoc` Lua module provides helper functions for element
605 creation. It is always loaded into the script's Lua environment.
607 See the [Lua filters documentation] for further details.
609 In order of preference, pandoc will look for Lua filters in
611 1. a specified full or relative path
613 2. `$DATADIR/filters` where `$DATADIR` is the user data
614 directory (see `--data-dir`, above).
616 Filters, Lua filters, and citeproc processing are applied in
617 the order specified on the command line.
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
621: Set the metadata field *KEY* to the value *VAL*. A value specified
622 on the command line overrides a value specified in the document
623 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
624 Values will be parsed as YAML boolean or string values. If no value is
625 specified, the value will be treated as Boolean true. Like
626 `--variable`, `--metadata` causes template variables to be set.
627 But unlike `--variable`, `--metadata` affects the metadata of the
628 underlying document (which is accessible from filters and may be
629 printed in some output formats) and metadata values will be escaped
630 when inserted into the template.
632`--metadata-file=`*FILE*
634: Read metadata from the supplied YAML (or JSON) file. This
635 option can be used with every input format, but string scalars
636 in the YAML file will always be parsed as Markdown. Generally,
637 the input will be handled the same as in [YAML metadata
638 blocks][Extension: `yaml_metadata_block`]. This option can be
639 used repeatedly to include multiple metadata files; values in
640 files specified later on the command line will be preferred
641 over those specified in earlier files. Metadata values
642 specified inside the document, or by using `-M`, overwrite
643 values specified with this option.
645`-p`, `--preserve-tabs`
647: Preserve tabs instead of converting them to spaces. (By default, pandoc
648 converts tabs to spaces before parsing its input.) Note that this will
649 only affect tabs in literal code spans and code blocks. Tabs in regular
650 text are always treated as spaces.
654: Specify the number of spaces per tab (default is 4).
656`--track-changes=accept`|`reject`|`all`
658: Specifies what to do with insertions, deletions, and comments
659 produced by the MS Word "Track Changes" feature. `accept` (the
660 default) processes all the insertions and deletions.
661 `reject` ignores them. Both `accept` and `reject` ignore comments.
662 `all` includes all insertions, deletions, and comments, wrapped
663 in spans with `insertion`, `deletion`, `comment-start`, and
664 `comment-end` classes, respectively. The author and time of
665 change is included. `all` is useful for scripting: only
666 accepting changes from a certain reviewer, say, or before a
667 certain date. If a paragraph is inserted or deleted,
668 `track-changes=all` produces a span with the class
669 `paragraph-insertion`/`paragraph-deletion` before the
670 affected paragraph break. This option only affects the docx
673`--extract-media=`*DIR*
675: Extract images and other media contained in or linked from
676 the source document to the path *DIR*, creating it if
677 necessary, and adjust the images references in the document
678 so they point to the extracted files. If the source format is
679 a binary container (docx, epub, or odt), the media is
680 extracted from the container and the original
681 filenames are used. Otherwise the media is read from the
682 file system or downloaded, and new filenames are constructed
683 based on SHA1 hashes of the contents.
685`--abbreviations=`*FILE*
687: Specifies a custom abbreviations file, with abbreviations
688 one to a line. If this option is not specified, pandoc will
689 read the data file `abbreviations` from the user data
690 directory or fall back on a system default. To see the
692 `pandoc --print-default-data-file=abbreviations`. The only
693 use pandoc makes of this list is in the Markdown reader.
694 Strings ending in a period that are found in this list will
695 be followed by a nonbreaking space, so that the period will
696 not produce sentence-ending space in formats like LaTeX.
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
699[PHP]: https://github.com/vinai/pandocfilters-php
700[perl]: https://metacpan.org/pod/Pandoc::Filter
701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702[Lua filters documentation]: https://pandoc.org/lua-filters.html
704## General writer options {.options}
708: Produce output with an appropriate header and footer (e.g. a
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711 output. For `native` output, this option causes metadata to
712 be included; otherwise, metadata is suppressed.
714`--template=`*FILE*|*URL*
716: Use the specified file as a custom template for the generated document.
717 Implies `--standalone`. See [Templates], below, for a description
718 of template syntax. If no extension is specified, an extension
719 corresponding to the writer will be added, so that `--template=special`
720 looks for `special.html` for HTML output. If the template is not
721 found, pandoc will search for it in the `templates` subdirectory of
722 the user data directory (see `--data-dir`). If this option is not used,
723 a default template appropriate for the output format will be used (see
724 `-D/--print-default-template`).
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
728: Set the template variable *KEY* to the value *VAL* when rendering the
729 document in standalone mode. If no *VAL* is specified, the
730 key will be given the value `true`.
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
734: Print the system default template for an output *FORMAT*. (See `-t`
735 for a list of possible *FORMAT*s.) Templates in the user data
736 directory are ignored. This option may be used with
737 `-o`/`--output` to redirect output to a file, but
738 `-o`/`--output` must come before `--print-default-template`
741 Note that some of the default templates use partials, for
742 example `styles.html`. To print the partials, use
743 `--print-default-data-file`: for example,
744 `--print-default-data-file=templates/styles.html`.
746`--print-default-data-file=`*FILE*
748: Print a system default data file. Files in the user data directory
749 are ignored. This option may be used with `-o`/`--output` to
750 redirect output to a file, but `-o`/`--output` must come before
751 `--print-default-data-file` on the command line.
753`--eol=crlf`|`lf`|`native`
755: Manually specify line endings: `crlf` (Windows), `lf`
756 (macOS/Linux/UNIX), or `native` (line endings appropriate
757 to the OS on which pandoc is being run). The default is
762: Specify the default dpi (dots per inch) value for conversion
763 from pixels to inch/centimeters and vice versa. (Technically,
764 the correct term would be ppi: pixels per inch.) The default
765 is 96dpi. When images contain information about dpi
766 internally, the encoded value is used instead of the default
767 specified by this option.
769`--wrap=auto`|`none`|`preserve`
771: Determine how text is wrapped in the output (the source
772 code, not the rendered version). With `auto` (the default),
773 pandoc will attempt to wrap lines to the column width specified by
774 `--columns` (default 72). With `none`, pandoc will not wrap
775 lines at all. With `preserve`, pandoc will attempt to
776 preserve the wrapping from the source document (that is,
777 where there are nonsemantic newlines in the source, there
778 will be nonsemantic newlines in the output as well).
779 Automatic wrapping does not currently work in HTML output.
780 In `ipynb` output, this option affects wrapping of the
781 contents of markdown cells.
785: Specify length of lines in characters. This affects text wrapping
786 in the generated source code (see `--wrap`). It also affects
787 calculation of column widths for plain text tables (see [Tables] below).
789`--toc`, `--table-of-contents`
791: Include an automatically generated table of contents (or, in
792 the case of `latex`, `context`, `docx`, `odt`,
793 `opendocument`, `rst`, or `ms`, an instruction to create
794 one) in the output document. This option has no effect
795 unless `-s/--standalone` is used, and it has no effect
796 on `man`, `docbook4`, `docbook5`, or `jats` output.
798 Note that if you are producing a PDF via `ms`, the table
799 of contents will appear at the beginning of the
800 document, before the title. If you would prefer it to
801 be at the end of the document, use the option
802 `--pdf-engine-opt=--no-toc-relocation`.
804`--toc-depth=`*NUMBER*
806: Specify the number of section levels to include in the table
807 of contents. The default is 3 (which means that level-1, 2, and 3
808 headings will be listed in the contents).
812: Strip out HTML comments in the Markdown or Textile source,
813 rather than passing them on to Markdown, Textile or HTML
814 output as raw HTML. This does not apply to HTML comments
815 inside raw HTML blocks when the `markdown_in_html_blocks`
816 extension is not set.
820: Disables syntax highlighting for code blocks and inlines, even when
821 a language attribute is given.
823`--highlight-style=`*STYLE*|*FILE*
825: Specifies the coloring style to be used in highlighted source code.
826 Options are `pygments` (the default), `kate`, `monochrome`,
827 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
828 For more information on syntax highlighting in pandoc, see
829 [Syntax highlighting], below. See also
830 `--list-highlight-styles`.
832 Instead of a *STYLE* name, a JSON file with extension
833 `.theme` may be supplied. This will be parsed as a KDE
834 syntax highlighting theme and (if valid) used as the
837 To generate the JSON version of an existing style,
838 use `--print-highlight-style`.
840`--print-highlight-style=`*STYLE*|*FILE*
842: Prints a JSON version of a highlighting style, which can
843 be modified, saved with a `.theme` extension, and used
844 with `--highlight-style`. This option may be used with
845 `-o`/`--output` to redirect output to a file, but
846 `-o`/`--output` must come before `--print-highlight-style`
849`--syntax-definition=`*FILE*
851: Instructs pandoc to load a KDE XML syntax definition file,
852 which will be used for syntax highlighting of appropriately
853 marked code blocks. This can be used to add support for
854 new languages or to use altered syntax definitions for
855 existing languages. This option may be repeated to add
856 multiple syntax definitions.
858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
860: Include contents of *FILE*, verbatim, at the end of the header.
861 This can be used, for example, to include special
862 CSS or JavaScript in HTML documents. This option can be used
863 repeatedly to include multiple files in the header. They will be
864 included in the order specified. Implies `--standalone`.
866`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
868: Include contents of *FILE*, verbatim, at the beginning of the
869 document body (e.g. after the `<body>` tag in HTML, or the
870 `\begin{document}` command in LaTeX). This can be used to include
871 navigation bars or banners in HTML documents. This option can be
872 used repeatedly to include multiple files. They will be included in
873 the order specified. Implies `--standalone`.
875`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
877: Include contents of *FILE*, verbatim, at the end of the document
878 body (before the `</body>` tag in HTML, or the
879 `\end{document}` command in LaTeX). This option can be used
880 repeatedly to include multiple files. They will be included in the
881 order specified. Implies `--standalone`.
883`--resource-path=`*SEARCHPATH*
885: List of paths to search for images and other resources.
886 The paths should be separated by `:` on Linux, UNIX, and
887 macOS systems, and by `;` on Windows. If `--resource-path`
888 is not specified, the default resource path is the working
889 directory. Note that, if `--resource-path` is specified,
890 the working directory must be explicitly listed or it
891 will not be searched. For example:
892 `--resource-path=.:test` will search the working directory
893 and the `test` subdirectory, in that order.
895`--request-header=`*NAME*`:`*VAL*
897: Set the request header *NAME* to the value *VAL* when making
898 HTTP requests (for example, when a URL is given on the
899 command line, or when resources used in a document must be
900 downloaded). If you're behind a proxy, you also need to set
901 the environment variable `http_proxy` to `http://...`.
903`--no-check-certificate`
905: Disable the certificate verification to allow access to
906 unsecure HTTP resources (for example when the certificate
907 is no longer valid or self signed).
909## Options affecting specific writers {.options}
913: Produce a standalone HTML file with no external dependencies, using
914 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
915 images, and videos. Implies `--standalone`. The resulting file should be
916 "self-contained," in the sense that it needs no external files and no net
917 access to be displayed properly by a browser. This option works only with
918 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
919 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
920 and stylesheets at absolute URLs will be downloaded; those at relative
921 URLs will be sought relative to the working directory (if the first source
922 file is local) or relative to the base URL (if the first source
923 file is remote). Elements with the attribute
924 `data-external="1"` will be left alone; the documents they
925 link to will not be incorporated in the document.
926 Limitation: resources that are loaded dynamically through
927 JavaScript cannot be incorporated; as a result,
928 `--self-contained` does not work with `--mathjax`, and some
929 advanced features (e.g. zoom or speaker notes) may not work
930 in an offline "self-contained" `reveal.js` slide show.
934: Use `<q>` tags for quotes in HTML. (This option only has an
935 effect if the `smart` extension is enabled for the input
940: Use only ASCII characters in output. Currently supported for XML
941 and HTML formats (which use entities instead of UTF-8 when this
942 option is selected), CommonMark, gfm, and Markdown (which use
943 entities), roff ms (which use hexadecimal escapes), and to a
944 limited degree LaTeX (which uses standard commands for accented
945 characters when possible). roff man output uses ASCII by default.
949: Use reference-style links, rather than inline links, in writing Markdown
950 or reStructuredText. By default inline links are used. The
951 placement of link references is affected by the
952 `--reference-location` option.
954`--reference-location=block`|`section`|`document`
956: Specify whether footnotes (and references, if `reference-links` is
957 set) are placed at the end of the current (top-level) block, the
958 current section, or the document. The default is
959 `document`. Currently only affects the markdown writer.
961`--markdown-headings=setext`|`atx`
963: Specify whether to use ATX-style (`#`-prefixed) or
964 Setext-style (underlined) headings for level 1 and 2
965 headings in Markdown output. (The default is `atx`.)
966 ATX-style headings are always used for levels 3+.
967 This option also affects Markdown cells in `ipynb` output.
971: *Deprecated synonym for `--markdown-headings=atx`.*
973`--top-level-division=default`|`section`|`chapter`|`part`
975: Treat top-level headings as the given division type in
976 LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
977 order is part, chapter, then section; all headings are
978 shifted such that the top-level heading becomes the
979 specified type. The default behavior is to determine the
980 best division type via heuristics: unless other conditions
981 apply, `section` is chosen. When the `documentclass`
982 variable is set to `report`, `book`, or `memoir` (unless the
983 `article` option is specified), `chapter` is implied as the
984 setting for this option. If `beamer` is the output format,
985 specifying either `chapter` or `part` will cause top-level
986 headings to become `\part{..}`, while second-level headings
987 remain as their default type.
989`-N`, `--number-sections`
991: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
992 output. By default, sections are not numbered. Sections with class
993 `unnumbered` will never be numbered, even if `--number-sections`
996`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
998: Offset for section headings in HTML output (ignored in other
999 output formats). The first number is added to the section number for
1000 top-level headings, the second for second-level headings, and so on.
1001 So, for example, if you want the first top-level heading in your
1002 document to be numbered "6", specify `--number-offset=5`.
1003 If your document starts with a level-2 heading which you want to
1004 be numbered "1.5", specify `--number-offset=1,4`.
1005 Offsets are 0 by default. Implies `--number-sections`.
1009: Use the [`listings`] package for LaTeX code blocks. The package
1010 does not support multi-byte encoding for source code. To handle UTF-8
1011 you would need to use a custom template. This issue is fully
1012 documented here: [Encoding issue with the listings package].
1014`-i`, `--incremental`
1016: Make list items in slide shows display incrementally (one by one).
1017 The default is for lists to be displayed all at once.
1019`--slide-level=`*NUMBER*
1021: Specifies that headings with the specified level create
1022 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1023 above this level in the hierarchy are used to divide the
1024 slide show into sections; headings below this level create
1025 subheads within a slide. Note that content that is
1026 not contained under slide-level headings will not appear in
1027 the slide show. The default is to set the slide level based
1028 on the contents of the document; see [Structuring the slide
1033: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1034 and attach identifiers to the enclosing `<section>` (or `<div>`)
1035 rather than the heading itself. See
1036 [Heading identifiers], below.
1038`--email-obfuscation=none`|`javascript`|`references`
1040: Specify a method for obfuscating `mailto:` links in HTML documents.
1041 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1042 them using JavaScript. `references` obfuscates them by printing their
1043 letters as decimal or hexadecimal character references. The default
1046`--id-prefix=`*STRING*
1048: Specify a prefix to be added to all identifiers and internal links
1049 in HTML and DocBook output, and to footnote numbers in Markdown
1050 and Haddock output. This is useful for preventing duplicate
1051 identifiers when generating fragments to be included in other pages.
1053`-T` *STRING*, `--title-prefix=`*STRING*
1055: Specify *STRING* as a prefix at the beginning of the title
1056 that appears in the HTML header (but not in the title as it
1057 appears at the beginning of the HTML body). Implies `--standalone`.
1059`-c` *URL*, `--css=`*URL*
1061: Link to a CSS style sheet. This option can be used repeatedly to
1062 include multiple files. They will be included in the order specified.
1064 A stylesheet is required for generating EPUB. If none is
1065 provided using this option (or the `css` or `stylesheet`
1066 metadata fields), pandoc will look for a file `epub.css` in the
1067 user data directory (see `--data-dir`). If it is not
1068 found there, sensible defaults will be used.
1070`--reference-doc=`*FILE*
1072: Use the specified file as a style reference in producing a
1077 : For best results, the reference docx should be a modified
1078 version of a docx file produced using pandoc. The contents
1079 of the reference docx are ignored, but its stylesheets and
1080 document properties (including margins, page size, header,
1081 and footer) are used in the new docx. If no reference docx
1082 is specified on the command line, pandoc will look for a
1083 file `reference.docx` in the user data directory (see
1084 `--data-dir`). If this is not found either, sensible
1085 defaults will be used.
1087 To produce a custom `reference.docx`, first get a copy of
1088 the default `reference.docx`: `pandoc
1089 -o custom-reference.docx --print-default-data-file reference.docx`.
1090 Then open `custom-reference.docx` in Word, modify the
1091 styles as you wish, and save the file. For best
1092 results, do not make changes to this file other than
1093 modifying the styles used by pandoc:
1129 - Default Paragraph Font
1132 - Footnote Reference
1142 : For best results, the reference ODT should be a modified
1143 version of an ODT produced using pandoc. The contents of
1144 the reference ODT are ignored, but its stylesheets are used
1145 in the new ODT. If no reference ODT is specified on the
1146 command line, pandoc will look for a file `reference.odt` in
1147 the user data directory (see `--data-dir`). If this is not
1148 found either, sensible defaults will be used.
1150 To produce a custom `reference.odt`, first get a copy of
1151 the default `reference.odt`: `pandoc
1152 -o custom-reference.odt --print-default-data-file reference.odt`.
1153 Then open `custom-reference.odt` in LibreOffice, modify
1154 the styles as you wish, and save the file.
1158 : Templates included with Microsoft PowerPoint 2013 (either with
1159 `.pptx` or `.potx` extension) are known to work, as are most
1160 templates derived from these.
1162 The specific requirement is that the template should begin with
1163 the following first four layouts:
1166 2. Title and Content
1170 All templates included with a recent version of MS PowerPoint
1171 will fit these criteria. (You can click on `Layout` under the
1172 `Home` menu to check.)
1174 You can also modify the default `reference.pptx`: first run
1175 `pandoc -o custom-reference.pptx --print-default-data-file
1176 reference.pptx`, and then modify `custom-reference.pptx`
1177 in MS PowerPoint (pandoc will use the first four layout
1178 slides, as mentioned above).
1180`--epub-cover-image=`*FILE*
1182: Use the specified image as the EPUB cover. It is recommended
1183 that the image be less than 1000px in width and height. Note that
1184 in a Markdown source document you can also specify `cover-image`
1185 in a YAML metadata block (see [EPUB Metadata], below).
1187`--epub-metadata=`*FILE*
1189: Look in the specified XML file for metadata for the EPUB.
1190 The file should contain a series of [Dublin Core elements].
1193 <dc:rights>Creative Commons</dc:rights>
1194 <dc:language>es-AR</dc:language>
1196 By default, pandoc will include the following metadata elements:
1197 `<dc:title>` (from the document title), `<dc:creator>` (from the
1198 document authors), `<dc:date>` (from the document date, which should
1199 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1200 variable, or, if is not set, the locale), and `<dc:identifier
1201 id="BookId">` (a randomly generated UUID). Any of these may be
1202 overridden by elements in the metadata file.
1204 Note: if the source document is Markdown, a YAML metadata block
1205 in the document can be used instead. See below under
1208`--epub-embed-font=`*FILE*
1210: Embed the specified font in the EPUB. This option can be repeated
1211 to embed multiple fonts. Wildcards can also be used: for example,
1212 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1213 line, be sure to escape them or put the whole filename in single quotes,
1214 to prevent them from being interpreted by the shell. To use the
1215 embedded fonts, you will need to add declarations like the following
1216 to your CSS (see `--css`):
1219 font-family: DejaVuSans;
1221 font-weight: normal;
1222 src:url("DejaVuSans-Regular.ttf");
1225 font-family: DejaVuSans;
1228 src:url("DejaVuSans-Bold.ttf");
1231 font-family: DejaVuSans;
1233 font-weight: normal;
1234 src:url("DejaVuSans-Oblique.ttf");
1237 font-family: DejaVuSans;
1240 src:url("DejaVuSans-BoldOblique.ttf");
1242 body { font-family: "DejaVuSans"; }
1244`--epub-chapter-level=`*NUMBER*
1246: Specify the heading level at which to split the EPUB into separate
1247 "chapter" files. The default is to split into chapters at level-1
1248 headings. This option only affects the internal composition of the
1249 EPUB, not the way chapters and sections are displayed to users. Some
1250 readers may be slow if the chapter files are too large, so for large
1251 documents with few level-1 headings, one might want to use a chapter
1254`--epub-subdirectory=`*DIRNAME*
1256: Specify the subdirectory in the OCF container that is to hold
1257 the EPUB-specific contents. The default is `EPUB`. To put
1258 the EPUB contents in the top level, use an empty string.
1260`--ipynb-output=all|none|best`
1262: Determines how ipynb output cells are treated. `all` means
1263 that all of the data formats included in the original are
1264 preserved. `none` means that the contents of data cells
1265 are omitted. `best` causes pandoc to try to pick the
1266 richest data block in each output cell that is compatible
1267 with the output format. The default is `best`.
1269`--pdf-engine=`*PROGRAM*
1271: Use the specified engine when producing PDF output.
1272 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1273 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1274 and `pdfroff`. If the engine is not in your PATH, the full
1275 path of the engine may be specified here. If this option
1276 is not specified, pandoc uses the following defaults
1277 depending on the output format specified using `-t/--to`:
1279 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1280 `tectonic`, `latexmk`)
1281 - `-t context`: `context`
1282 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1283 see [print-css.rocks](https://print-css.rocks) for a good
1284 introduction to PDF generation from HTML/CSS.)
1285 - `-t ms`: `pdfroff`
1287`--pdf-engine-opt=`*STRING*
1289: Use the given string as a command-line argument to the `pdf-engine`.
1290 For example, to use a persistent directory `foo` for `latexmk`'s
1291 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1292 Note that no check for duplicate options is done.
1294[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1295[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1296[Encoding issue with the listings package]:
1297 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1299## Citation rendering {.options}
1303: Process the citations in the file, replacing them with
1304 rendered citations and adding a bibliography.
1305 Citation processing will not take place unless bibliographic
1306 data is supplied, either through an external file specified
1307 using the `--bibliography` option or the `bibliography`
1308 field in metadata, or via a `references` section in metadata
1309 containing a list of citations in CSL YAML format with
1310 Markdown formatting. The style is controlled by a [CSL]
1311 stylesheet specified using the `--csl` option or the `csl`
1312 field in metadata. (If no stylesheet is specified,
1313 the `chicago-author-date` style will be used by default.)
1314 The citation processing transformation may be applied before
1315 or after filters or Lua filters (see `--filter`,
1316 `--lua-filter`): these transformations are applied in the
1317 order they appear on the command line. For more
1318 information, see the section on [Citations].
1320`--bibliography=`*FILE*
1322: Set the `bibliography` field in the document's metadata to *FILE*,
1323 overriding any value set in the metadata. If you supply
1324 this argument multiple times, each *FILE* will be added to
1325 bibliography. If *FILE* is a URL, it will be fetched
1326 via HTTP. If *FILE* is not found relative to the
1327 working directory, it will be sought in the resource path
1328 (see `--resource-path`).
1332: Set the `csl` field in the document's metadata to *FILE*,
1333 overriding any value set in the metadata. (This is equivalent to
1334 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1335 fetched via HTTP. If *FILE* is not found relative to the
1336 working directory, it will be sought in the resource path
1337 (see `--resource-path`) and finally in the `csl`
1338 subdirectory of the pandoc user data directory.
1340`--citation-abbreviations=`*FILE*
1342: Set the `citation-abbreviations` field in the document's metadata to
1343 *FILE*, overriding any value set in the metadata. (This is equivalent to
1344 `--metadata citation-abbreviations=FILE`.)
1345 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1346 found relative to the working directory, it will be sought
1347 in the resource path (see `--resource-path`) and finally in
1348 the `csl` subdirectory of the pandoc user data directory.
1352: Use [`natbib`] for citations in LaTeX output. This option
1353 is not for use with the `--citeproc` option or with PDF
1354 output. It is intended for use in producing a LaTeX file
1355 that can be processed with [`bibtex`].
1359: Use [`biblatex`] for citations in LaTeX output. This option
1360 is not for use with the `--citeproc` option or with PDF
1361 output. It is intended for use in producing a LaTeX file
1362 that can be processed with [`bibtex`] or [`biber`].
1364## Math rendering in HTML {.options}
1366The default is to render TeX math as far as possible using
1367Unicode characters. Formulas are put inside a `span` with
1368`class="math"`, so that they may be styled differently from the
1369surrounding text if needed. However, this gives acceptable
1370results only for basic math, usually you will want to use
1371`--mathjax` or another of the following options.
1373`--mathjax`[`=`*URL*]
1375: Use [MathJax] to display embedded TeX math in HTML output.
1376 TeX math will be put between `\(...\)` (for inline math)
1377 or `\[...\]` (for display math) and wrapped in `<span>` tags
1378 with class `math`. Then the MathJax JavaScript will render it.
1379 The *URL* should point to the `MathJax.js` load script.
1380 If a *URL* is not provided, a link to the Cloudflare CDN will
1385: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1386 `docbook5`, `jats`, `html4` and `html5`). This is the
1387 default in `odt` output. Note that currently only Firefox
1388 and Safari (and select e-book readers) natively support
1393: Convert TeX formulas to `<img>` tags that link to an external script
1394 that converts formulas to images. The formula will be URL-encoded
1395 and concatenated with the URL provided. For SVG images you can for
1396 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1397 If no URL is specified, the CodeCogs URL generating PNGs
1398 will be used (`https://latex.codecogs.com/png.latex?`).
1399 Note: the `--webtex` option will affect Markdown output
1400 as well as HTML, which is useful if you're targeting a
1401 version of Markdown without native math support.
1405: Use [KaTeX] to display embedded TeX math in HTML output.
1406 The *URL* is the base URL for the KaTeX library. That directory
1407 should contain a `katex.min.js` and a `katex.min.css` file.
1408 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1412: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1413 can then be processed by [GladTeX] to produce images of the typeset
1414 formulas and an HTML file with links to these images.
1415 So, the procedure is:
1417 pandoc -s --gladtex input.md -o myfile.htex
1418 gladtex -d myfile-images myfile.htex
1419 # produces myfile.html and images in myfile-images
1421[MathML]: https://www.w3.org/Math/
1422[MathJax]: https://www.mathjax.org
1423[KaTeX]: https://github.com/Khan/KaTeX
1424[GladTeX]: https://humenda.github.io/GladTeX/
1426## Options for wrapper scripts {.options}
1430: Print information about command-line arguments to *stdout*, then exit.
1431 This option is intended primarily for use in wrapper scripts.
1432 The first line of output contains the name of the output file specified
1433 with the `-o` option, or `-` (for *stdout*) if no output file was
1434 specified. The remaining lines contain the command-line arguments,
1435 one per line, in the order they appear. These do not include regular
1436 pandoc options and their arguments, but do include any options appearing
1437 after a `--` separator at the end of the line.
1441: Ignore command-line arguments (for use in wrapper scripts).
1442 Regular pandoc options are not ignored. Thus, for example,
1444 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1448 pandoc -o foo.html -s
1452If pandoc completes successfully, it will return exit code 0.
1453Nonzero exit codes have the following meanings:
1456----- ------------------------------------
1457 3 PandocFailOnWarningError
1459 5 PandocTemplateError
1461 21 PandocUnknownReaderError
1462 22 PandocUnknownWriterError
1463 23 PandocUnsupportedExtensionError
1464 24 PandocCiteprocError
1465 31 PandocEpubSubdirectoryError
1468 47 PandocPDFProgramNotFoundError
1470 62 PandocShouldNeverHappenError
1473 65 PandocParsecError
1474 66 PandocMakePDFError
1475 67 PandocSyntaxMapError
1476 83 PandocFilterError
1478 92 PandocUTF8DecodingError
1479 93 PandocIpynbDecodingError
1480 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. This only affects LaTeX
1572# output. If you want to use citeproc to format citations,
1573# you should also set 'citeproc: true' (see above).
1574cite-method: citeproc
1576# part, chapter, section, or default:
1577top-level-division: chapter
1583# you may also use pdf-engine-opt: with a single option
1584# pdf-engine-opt: "-shell-escape"
1586# auto, preserve, or none
1591extract-media: mediadir
1593table-of-contents: true
1595number-sections: false
1596# a list of offsets at each heading level
1597number-offset: [0,0,0,0,0,0]
1598# toc: may also be used instead of table-of-contents:
1599shift-heading-level-by: 1
1601identifier-prefix: foo
1603strip-empty-paragraphs: true
1604# lf, crlf, or native
1606strip-comments: false
1607indented-code-classes: []
1609default-image-extension: ".jpg"
1611# either a style name of a style definition file:
1612highlight-style: pygments
1615# or you may use syntax-definition: with a single value
1618reference-doc: myref.docx
1620# method is plain, webtex, gladtex, mathml, mathjax, katex
1621# you may specify a url with webtex, mathjax, katex
1624 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1625# none, references, or javascript
1626email-obfuscation: javascript
1634epub-subdirectory: EPUB
1635epub-metadata: meta.xml
1638epub-chapter-level: 1
1639epub-cover-image: cover.jpg
1641reference-links: true
1642# block, section, or document
1643reference-location: block
1644markdown-headings: setext
1646# accept, reject, or all
1647track-changes: accept
1656# A list of two-element lists
1658- ["User-Agent", "Mozilla/5.0"]
1660fail-if-warnings: false
1666Fields that are omitted will just have their regular
1667default values. So a defaults file can be as simple as
1674Default files can be placed in the `defaults` subdirectory of
1675the user data directory and used from any directory. For
1676example, one could create a file specifying defaults for writing
1677letters, save it as `letter.yaml` in the `defaults` subdirectory
1678of the user data directory, and then invoke these defaults
1679from any directory using `pandoc --defaults letter`
1680or `pandoc -dletter`.
1682When multiple defaults are used, their contents will be combined.
1684Note that, where command-line arguments may be repeated
1685(`--metadata-file`, `--css`, `--include-in-header`,
1686`--include-before-body`, `--include-after-body`, `--variable`,
1687`--metadata`, `--syntax-definition`), the values specified on
1688the command line will combine with values specified in the
1689defaults file, rather than replacing them.
1693When the `-s/--standalone` option is used, pandoc uses a template to
1694add header and footer material that is needed for a self-standing
1695document. To see the default template that is used, just type
1699where *FORMAT* is the name of the output format. A custom template
1700can be specified using the `--template` option. You can also override
1701the system default templates for a given output format *FORMAT*
1702by putting a file `templates/default.*FORMAT*` in the user data
1703directory (see `--data-dir`, above). *Exceptions:*
1705- For `odt` output, customize the `default.opendocument`
1707- For `pdf` output, customize the `default.latex` template
1708 (or the `default.context` template, if you use `-t context`,
1709 or the `default.ms` template, if you use `-t ms`, or the
1710 `default.html` template, if you use `-t html`).
1711- `docx` and `pptx` have no template (however, you can use
1712 `--reference-doc` to customize the output).
1714Templates contain *variables*, which allow for the inclusion of
1715arbitrary information at any point in the file. They may be set at the
1716command line using the `-V/--variable` option. If a variable is not set,
1717pandoc will look for the key in the document's metadata, which can be set
1718using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1719or with the `-M/--metadata` option. In addition, some variables
1720are given default values by pandoc. See [Variables] below for
1721a list of variables used in pandoc's default templates.
1723If you use custom templates, you may need to revise them as pandoc
1724changes. We recommend tracking the changes in the default templates,
1725and modifying your custom templates accordingly. An easy way to do this
1726is to fork the [pandoc-templates] repository and merge in
1727changes after each pandoc release.
1729 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1735Anything between the sequence `$--` and the end of the
1736line will be treated as a comment and omitted from the output.
1740To mark variables and control structures in the template,
1741either `$`...`$` or `${`...`}` may be used as delimiters.
1742The styles may also be mixed in the same template, but the
1743opening and closing delimiter must match in each case. The
1744opening delimiter may be followed by one or more spaces
1745or tabs, which will be ignored. The closing delimiter may
1746be followed by one or more spaces or tabs, which will be
1749To include a literal `$` in the document, use `$$`.
1751### Interpolated variables
1753A slot for an interpolated variable is a variable name surrounded
1754by matched delimiters. Variable names must begin with a letter
1755and can contain letters, numbers, `_`, `-`, and `.`. The
1756keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1757not be used as variable names. Examples:
1770Variable names with periods are used to get at structured
1771variable values. So, for example, `employee.salary` will return the
1772value of the `salary` field of the object that is the value of
1773the `employee` field.
1775- If the value of the variable is simple value, it will be
1776 rendered verbatim. (Note that no escaping is done;
1777 the assumption is that the calling program will escape
1778 the strings appropriately for the output format.)
1779- If the value is a list, the values will be concatenated.
1780- If the value is a map, the string `true` will be rendered.
1781- Every other value will be rendered as the empty string.
1785A conditional begins with `if(variable)` (enclosed in
1786matched delimiters) and ends with `endif` (enclosed in matched
1787delimiters). It may optionally contain an `else` (enclosed in
1788matched delimiters). The `if` section is used if
1789`variable` has a non-empty value, otherwise the `else`
1790section is used (if present). Examples:
1805${if(foo)}bar${endif}
1818The keyword `elseif` may be used to simplify complex nested
1833A for loop begins with `for(variable)` (enclosed in
1834matched delimiters) and ends with `endfor` (enclosed in matched
1837- If `variable` is an array, the material inside the loop will
1838 be evaluated repeatedly, with `variable` being set to each
1839 value of the array in turn, and concatenated.
1840- If `variable` is a map, the material inside will be set to
1842- If the value of the associated variable is not an array or
1843 a map, a single iteration will be performed on its value.
1848$for(foo)$$foo$$sep$, $endfor$
1851 - $foo.last$, $foo.first$
1855 - ${ foo.bar.last }, ${ foo.bar.first }
1859$it.name$: $it.office$
1863You may optionally specify a separator between consecutive
1864values using `sep` (enclosed in matched delimiters). The
1865material between `sep` and the `endfor` is the separator.
1868${ for(foo) }${ foo }${ sep }, ${ endfor }
1871Instead of using `variable` inside the loop, the special
1872anaphoric keyword `it` may be used.
1876 - ${ it.last }, ${ it.first }
1882Partials (subtemplates stored in different files) may be
1883included by using the name of the partial, followed
1884by `()`, for example:
1890Partials will be sought in the directory containing
1891the main template. The file name will be assumed to
1892have the same extension as the main template if it
1893lacks an extension. When calling the partial, the
1894full name including file extension can also be used:
1900(If a partial is not found in the directory of the
1901template and the template path is given as a relative
1902path, it will also be sought in the `templates`
1903subdirectory of the user data directory.)
1905Partials may optionally be applied to variables using
1911${ articles:bibentry() }
1914If `articles` is an array, this will iterate over its
1915values, applying the partial `bibentry()` to each one. So the
1916second example above is equivalent to
1924Note that the anaphoric keyword `it` must be used when
1925iterating over partials. In the above examples,
1926the `bibentry` partial should contain `it.title`
1927(and so on) instead of `articles.title`.
1929Final newlines are omitted from included partials.
1931Partials may include other partials.
1933A separator between values of an array may be specified
1934in square brackets, immediately after the variable name
1940${articles:bibentry()[; ]$
1943The separator in this case is literal and (unlike with `sep`
1944in an explicit `for` loop) cannot contain interpolated
1945variables or other template directives.
1949To ensure that content is "nested," that is, subsequent lines
1950indented, use the `^` directive:
1953$item.number$ $^$$item.description$ ($item.price$)
1956In this example, if `item.description` has multiple lines,
1957they will all be indented to line up with the first line:
196000123 A fine bottle of 18-year old
1961 Oban whiskey. ($148)
1964To nest multiple lines to the same level, align them
1965with the `^` directive in the template. For example:
1968$item.number$ $^$$item.description$ ($item.price$)
1969 (Available til $item.sellby$.)
197500123 A fine bottle of 18-year old
1976 Oban whiskey. ($148)
1977 (Available til March 30, 2020.)
1980If a variable occurs by itself on a line, preceded by whitespace
1981and not followed by further text or directives on the same line,
1982and the variable's value contains multiple lines, it will be
1983nested automatically.
1987Normally, spaces in the template itself (as opposed to values of
1988the interpolated variables) are not breakable, but they can be
1989made breakable in part of the template by using the `~` keyword
1990(ended with another `~`).
1993$~$This long line may break if the document is rendered
1994with a short line length.$~$
1999A pipe transforms the value of a variable or partial. Pipes are
2000specified using a slash (`/`) between the variable name (or partial)
2001and the pipe name. Example:
2008$for(metadata/pairs)$
2009- $it.key$: $it.value$
2012$employee:name()/uppercase$
2015Pipes may be chained:
2018$for(employees/pairs)$
2019$it.key/alpha/uppercase$. $it.name$
2023Some pipes take parameters:
2026|----------------------|------------|
2028$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2030|----------------------|------------|
2033Currently the following pipes are predefined:
2035- `pairs`: Converts a map or array to an array of maps,
2036 each with `key` and `value` fields. If the original
2037 value was an array, the `key` will be the array index,
2040- `uppercase`: Converts text to uppercase.
2042- `lowercase`: Converts text to lowercase.
2044- `length`: Returns the length of the value: number
2045 of characters for a textual value, number of elements
2048- `reverse`: Reverses a textual value or array,
2049 and has no effect on other values.
2051- `first`: Returns the first value of an array, if
2052 applied to a non-empty array; otherwise returns
2055- `last`: Returns the last value of an array, if
2056 applied to a non-empty array; otherwise returns
2059- `rest`: Returns all but the first value of an array, if
2060 applied to a non-empty array; otherwise returns
2063- `allbutlast`: Returns all but the last value of an array, if
2064 applied to a non-empty array; otherwise returns
2067- `chomp`: Removes trailing newlines (and breakable space).
2069- `nowrap`: Disables line wrapping on breakable spaces.
2071- `alpha`: Converts textual values that can be
2072 read as an integer into lowercase alphabetic
2073 characters `a..z` (mod 26). This can be used to get lettered
2074 enumeration from array indices. To get uppercase
2075 letters, chain with `uppercase`.
2077- `roman`: Converts textual values that can be
2078 read as an integer into lowercase roman numerials.
2079 This can be used to get lettered enumeration from array indices.
2080 To get uppercase roman, chain with `uppercase`.
2082- `left n "leftborder" "rightborder"`: Renders a textual value
2083 in a block of width `n`, aligned to the left, with an optional
2084 left and right border. Has no effect on other values. This
2085 can be used to align material in tables. Widths are positive
2086 integers indicating the number of characters. Borders
2087 are strings inside double quotes; literal `"` and `\` characters
2088 must be backslash-escaped.
2090- `right n "leftborder" "rightborder"`: Renders a textual value
2091 in a block of width `n`, aligned to the right, and has no
2092 effect on other values.
2094- `center n "leftborder" "rightborder"`: Renders a textual
2095 value in a block of width `n`, aligned to the center, and has
2096 no effect on other values.
2101### Metadata variables
2103`title`, `author`, `date`
2104: allow identification of basic aspects of the document. Included
2105 in PDF metadata through LaTeX and ConTeXt. These can be set
2106 through a [pandoc title block][Extension: `pandoc_title_block`],
2107 which allows for multiple authors, or through a
2108 [YAML metadata block][Extension: `yaml_metadata_block`]:
2116 Note that if you just want to set PDF or HTML metadata, without
2117 including a title block in the document itself, you can
2118 set the `title-meta`, `author-meta`, and `date-meta`
2119 variables. (By default these are set automatically, based
2120 on `title`, `author`, and `date`.) The page title in HTML
2121 is set by `pagetitle`, which is equal to `title` by default.
2124: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2128: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2132: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2133 and AsciiDoc metadata; repeat as for `author`, above
2136: document subject, included in ODT, PDF, docx and pptx metadata
2139: document description, included in ODT, docx and pptx metadata. Some
2140 applications show this as `Comments` metadata.
2143: document category, included in docx and pptx metadata
2146any root-level string metadata, not included in ODT, docx
2147or pptx metadata is added as a *custom property*.
2148The following [YAML] metadata block for instance:
2151 title: 'This is the title'
2152 subtitle: "This is the subtitle"
2160 It consists of two paragraphs
2163will include `title`, `author` and `description` as standard document
2164properties and `subtitle` as a custom property when converting to docx,
2167### Language variables
2170: identifies the main language of the document using IETF language
2171 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2172 The [Language subtag lookup] tool can look up or verify these tags.
2173 This affects most formats, and controls hyphenation in PDF output
2174 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2176 Use native pandoc [Divs and Spans] with the `lang` attribute to
2177 switch the language:
2183 Text in the main document language (British English).
2186 > Cette citation est écrite en français canadien.
2189 More text in English. ['Zitat auf Deutsch.']{lang=de}
2192: the base script direction, either `rtl` (right-to-left)
2193 or `ltr` (left-to-right).
2195 For bidirectional documents, native pandoc `span`s and
2196 `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2197 be used to override the base direction in some output
2198 formats. This may not always be necessary if the final
2199 renderer (e.g. the browser, when generating HTML) supports
2200 the [Unicode Bidirectional Algorithm].
2202 When using LaTeX for bidirectional documents, only the
2203 `xelatex` engine is fully supported (use
2204 `--pdf-engine=xelatex`).
2206[BCP 47]: https://tools.ietf.org/html/bcp47
2207[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2208[Language subtag lookup]: https://r12a.github.io/app-subtags/
2210### Variables for HTML
2213: Enables inclusion of most of the [CSS] in the `styles.html`
2214 [partial](#partials) (have a look with
2215 `pandoc --print-default-data-file=templates/styles.html`).
2216 Unless you use [`--css`](#option--css), this variable
2217 is set to `true` by default. You can disable it with
2218 e.g. `pandoc -M document-css=false`.
2221: sets the CSS `font-family` property on the `html` element.
2224: sets the base CSS `font-size`, which you'd usually set
2225 to e.g. `20px`, but it also accepts `pt`
2226 (12pt = 16px in most browsers).
2229: sets the CSS `color` property on the `html` element.
2232: sets the CSS `color` property on all links.
2235: sets the CSS `font-family` property on `code` elements.
2237`monobackgroundcolor`
2238: sets the CSS `background-color` property on `code` elements
2239 and adds extra padding.
2242: sets the CSS `line-height` property on the `html` element,
2243 which is preferred to be unitless.
2246: sets the CSS `background-color` property on the `html` element.
2248`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2249: sets the corresponding CSS `padding` properties on the `body` element.
2251To override or extend some [CSS] for just one document, include for example:
2260 background-color: #f0f0f0;
2263 padding: 0.5em 2em 0.5em 0.5em;
2266 border-bottom: none;
2271[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2273### Variables for HTML math
2276: when using [KaTeX](#option--katex), you can render display
2277math equations flush left using [YAML metadata](#layout) or with
2278`-M classoption=fleqn`.
2280### Variables for HTML slides
2282These affect HTML output when [producing slide shows with pandoc].
2284All [reveal.js configuration options] are available as variables.
2285To turn off boolean flags that default to true in reveal.js, use `0`.
2288: base URL for reveal.js documents (defaults to
2289 `https://unpkg.com/reveal.js@^4/`)
2292: base URL for S5 documents (defaults to `s5/default`)
2295: base URL for Slidy documents (defaults to
2296 `https://www.w3.org/Talks/Tools/Slidy2`)
2299: base URL for Slideous documents (defaults to `slideous`)
2301`title-slide-attributes`
2302: additional attributes for the title slide of reveal.js slide shows.
2303 See [background in reveal.js and beamer] for an example.
2305[reveal.js configuration options]: https://revealjs.com/config/
2307### Variables for Beamer slides
2309These variables change the appearance of PDF slides using [`beamer`].
2312: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2313 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2317: produce an article from Beamer slides
2320: add extra beamer option with `\setbeameroption{}`
2323: author affiliations: can be a list when there are multiple authors
2326: logo image for slides
2329: controls navigation symbols (default is `empty` for no navigation
2330 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2333: enables "title pages" for new sections (default is true)
2335`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2339: options for LaTeX beamer themes (a list).
2342: image for title slide
2344### Variables for PowerPoint
2346These variables control the visual aspects of a slide show that
2347are not easily controlled via templates.
2350: font to use for code.
2352### Variables for LaTeX
2354Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2359: make `\paragraph` and `\subparagraph` (fourth- and
2360 fifth-level headings, or fifth- and sixth-level with book
2361 classes) free-standing rather than run-in; requires further
2362 formatting to distinguish from `\subsubsection` (third- or
2363 fourth-level headings). Instead of using this option,
2364 [KOMA-Script] can adjust headings more extensively:
2367 documentclass: scrartcl
2369 \RedeclareSectionCommand[
2370 beforeskip=-10pt plus -2pt minus -1pt,
2371 afterskip=1sp plus -1sp minus 1sp,
2372 font=\normalfont\itshape]{paragraph}
2373 \RedeclareSectionCommand[
2374 beforeskip=-10pt plus -2pt minus -1pt,
2375 afterskip=1sp plus -1sp minus 1sp,
2376 font=\normalfont\scshape,
2377 indent=0pt]{subparagraph}
2381: option for document class, e.g. `oneside`; repeat for multiple options:
2390: document class: usually one of the standard classes,
2391 [`article`], [`book`], and [`report`]; the [KOMA-Script]
2392 equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2393 default to smaller margins; or [`memoir`]
2396: option for [`geometry`] package, e.g. `margin=1in`;
2397 repeat for multiple options:
2407: option for [`hyperref`] package, e.g. `linktoc=all`;
2408 repeat for multiple options:
2414 - pdfpagemode=FullScreen
2418: if true, pandoc will use document class settings for
2419 indentation (the default LaTeX template otherwise removes
2420 indentation and adds space between paragraphs)
2423: adjusts line spacing using the [`setspace`]
2424 package, e.g. `1.25`, `1.5`
2426`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2427: sets margins if `geometry` is not used (otherwise `geometry`
2431: control `\pagestyle{}`: the default article class
2432 supports `plain` (default), `empty` (no running heads or page numbers),
2433 and `headings` (section titles in running heads)
2436: paper size, e.g. `letter`, `a4`
2439: numbering depth for sections (with `--number-sections` option
2440 or `numbersections` variable)
2445: allows font encoding to be specified through `fontenc` package (with
2446 `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2449: font package for use with `pdflatex`:
2450 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2451 The default is [Latin Modern][`lm`].
2454: options for package used as `fontfamily`; repeat for multiple options.
2455 For example, to use the Libertine font with proportional lowercase
2456 (old-style) figures through the [`libertinus`] package:
2459 fontfamily: libertinus
2466: font size for body text. The standard classes allow 10pt, 11pt, and
2467 12pt. To use another size, set `documentclass` to one of
2468 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2470`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2471: font families for use with `xelatex` or
2472 `lualatex`: take the name of any system font, using the
2473 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2475`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2476: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2477 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2478 choices available through [`fontspec`]; repeat for multiple
2479 options. For example, to use the [TeX Gyre] version of
2480 Palatino with lowercase figures:
2483 mainfont: TeX Gyre Pagella
2486 - Numbers=Proportional
2490: options to pass to the microtype package
2495: add color to link text; automatically enabled if any of
2496 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2498`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2499: color for internal links, external links, citation links, linked
2500 URLs, and links in table of contents, respectively: uses options
2501 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2505: causes links to be printed as footnotes
2510: include list of figures, list of tables
2513: contents of acknowledgments footnote after document title
2516: include table of contents (can also be set using
2517 `--toc/--table-of-contents`)
2520: level of section to include in table of contents
2522#### BibLaTeX Bibliographies
2524These variables function when using BibLaTeX for [citation rendering].
2527: list of options for biblatex
2530: bibliography style, when used with `--natbib` and `--biblatex`.
2533: bibliography title, when used with `--natbib` and `--biblatex`.
2536: bibliography to use for resolving references
2539: list of options for natbib
2541[KOMA-Script]: https://ctan.org/pkg/koma-script
2542[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2543[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2544[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2545[`article`]: https://ctan.org/pkg/article
2546[`book`]: https://ctan.org/pkg/book
2547[`libertinus`]: https://ctan.org/pkg/libertinus
2548[`memoir`]: https://ctan.org/pkg/memoir
2549[`report`]: https://ctan.org/pkg/report
2551### Variables for ConTeXt
2553Pandoc uses these variables when [creating a PDF] with ConTeXt.
2556: font size for body text (e.g. `10pt`, `12pt`)
2558`headertext`, `footertext`
2559: text to be placed in running header or footer (see [ConTeXt Headers and
2560 Footers]); repeat up to four times for different placement
2563: controls indentation of paragraphs, e.g. `yes,small,next` (see
2564 [ConTeXt Indentation]); repeat for multiple options
2567: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2568 repeat for multiple options
2571: options for page margins and text arrangement (see [ConTeXt Layout]);
2572 repeat for multiple options
2574`linkcolor`, `contrastcolor`
2575: color for links outside and inside a page, e.g. `red`, `blue` (see
2579: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2580 `type`, `cap`, `small`
2583: include list of figures, list of tables
2585`mainfont`, `sansfont`, `monofont`, `mathfont`
2586: font families: take the name of any system font (see
2587 [ConTeXt Font Switching])
2589`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2590: sets margins, if `layout` is not used (otherwise `layout`
2594: page number style and location (using [`setuppagenumbering`]);
2595 repeat for multiple options
2598: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2599 repeat for multiple options
2602: adds to the preamble the setup necessary to generate PDF/A
2603 of the type specified, e.g. `1a:2005`, `2a`. If no type is
2604 specified (i.e. the value is set to True, by e.g.
2605 `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2606 `1b:2005` will be used as default, for reasons of backwards
2607 compatibility. Using `--variable=pdfa` without specified value
2608 is not supported. To successfully generate PDF/A the required
2609 ICC color profiles have to be available and the content and all
2610 included files (such as images) have to be standard conforming.
2611 The ICC profiles and output intent may be specified using the
2612 variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2613 PDFA] for more details.
2616: when used in conjunction with `pdfa`, specifies the ICC profile to use
2617 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2618 used as default. May be repeated to include multiple profiles. Note that
2619 the profiles have to be available on the system. They can be obtained
2620 from [ConTeXt ICC Profiles].
2623: when used in conjunction with `pdfa`, specifies the output intent for
2624 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2625 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2628: include table of contents (can also be set using
2629 `--toc/--table-of-contents`)
2632: spacing between paragraphs, e.g. `none`, `small` (using
2633 [`setupwhitespace`])
2636: include all source documents as file attachments in the PDF file
2638[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2639[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2640[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2641[ConTeXt Color]: https://wiki.contextgarden.net/Color
2642[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2643[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2644[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2645[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2646[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2647[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2648[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2650### Variables for `wkhtmltopdf`
2652Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2653The `--css` option also affects the output.
2655`footer-html`, `header-html`
2656: add information to the header and footer
2658`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2659: set the page margins
2662: sets the PDF paper size
2664### Variables for man pages
2667: adjusts text to left (`l`), right (`r`), center (`c`),
2668 or both (`b`) margins
2671: footer in man pages
2674: header in man pages
2677: if `true` (the default), hyphenation will be used
2680: section number in man pages
2685: font family (e.g. `T` or `P`)
2688: paragraph indent (e.g. `2m`)
2691: line height (e.g. `12p`)
2694: point size (e.g. `10p`)
2696### Variables set automatically
2698Pandoc sets these variables automatically in response to [options] or
2699document contents; users can also modify them. These vary depending
2700on the output format, and include the following:
2706: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2707 included in all HTML based formats (dzslides, epub,
2708 html, html4, html5, revealjs, s5, slideous, slidy).
2709 The recognized formats for `date` are: `mm/dd/yyyy`,
2710 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2711 (e.g. either `02 Apr 2018` or `02 April 2018`),
2712 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2713 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2716: contents specified by `-H/--include-in-header` (may have multiple
2720: contents specified by `-B/--include-before-body` (may have
2724: contents specified by `-A/--include-after-body` (may have
2728: JSON representation of all of the document's metadata. Field
2729 values are transformed to the selected output format.
2732: non-null value if `-N/--number-sections` was specified
2734`sourcefile`, `outputfile`
2735: source and destination filenames, as given on the command line.
2736 `sourcefile` can also be a list if input comes from multiple files,
2737 or empty if input is from stdin. You can use the following snippet in
2738 your template to distinguish them:
2748 Similarly, `outputfile` can be `-` if output goes to the terminal.
2750 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2753: working directory from which pandoc is run.
2756: non-null value if `--toc/--table-of-contents` was specified
2759: title of table of contents (works only with EPUB,
2760 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2762[pandoc-templates]: https://github.com/jgm/pandoc-templates
2766The behavior of some of the readers and writers can be adjusted by
2767enabling or disabling various extensions.
2769An extension can be enabled by adding `+EXTENSION`
2770to the format name and disabled by adding `-EXTENSION`. For example,
2771`--from markdown_strict+footnotes` is strict Markdown with footnotes
2772enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2773Markdown without footnotes or pipe tables.
2775The markdown reader and writer make by far the most use of extensions.
2776Extensions only used by them are therefore covered in the
2777section [Pandoc's Markdown] below (See [Markdown variants] for
2778`commonmark` and `gfm`.) In the following, extensions that also work
2779for other formats are covered.
2781Note that markdown extensions added to the `ipynb` format
2782affect Markdown cells in Jupyter notebooks (as do command-line
2783options like `--atx-headers`).
2787#### Extension: `smart` ####
2789Interpret straight quotes as curly quotes, `---` as em-dashes,
2790`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2791inserted after certain abbreviations, such as "Mr."
2793This extension can be enabled/disabled for the following formats:
2796: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2799: `markdown`, `latex`, `context`, `rst`
2801enabled by default in
2802: `markdown`, `latex`, `context` (both input and output)
2804Note: If you are *writing* Markdown, then the `smart` extension
2805has the reverse effect: what would have been curly quotes comes
2808In LaTeX, `smart` means to use the standard TeX ligatures
2809for quotation marks (` `` ` and ` '' ` for double quotes,
2810`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2811en-dash and `---` for em-dash). If `smart` is disabled,
2812then in reading LaTeX pandoc will parse these characters
2813literally. In writing LaTeX, enabling `smart` tells pandoc
2814to use the ligatures when possible; if `smart` is disabled
2815pandoc will use unicode quotation mark and dash characters.
2817## Headings and sections
2819#### Extension: `auto_identifiers` ####
2821A heading without an explicitly specified identifier will be
2822automatically assigned a unique identifier based on the heading text.
2824This extension can be enabled/disabled for the following formats:
2827: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2832enabled by default in
2835The default algorithm used to derive the identifier from the
2838 - Remove all formatting, links, etc.
2839 - Remove all footnotes.
2840 - Remove all non-alphanumeric characters,
2841 except underscores, hyphens, and periods.
2842 - Replace all spaces and newlines with hyphens.
2843 - Convert all alphabetic characters to lowercase.
2844 - Remove everything up to the first letter (identifiers may
2845 not begin with a number or punctuation mark).
2846 - If nothing is left after this, use the identifier `section`.
2851 ------------------------------- ----------------------------
2852 `Heading identifiers in HTML` `heading-identifiers-in-html`
2853 `Maître d'hôtel` `maître-dhôtel`
2854 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2855 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2856 `3. Applications` `applications`
2859These rules should, in most cases, allow one to determine the identifier
2860from the heading text. The exception is when several headings have the
2861same text; in this case, the first will get an identifier as described
2862above; the second will get the same identifier with `-1` appended; the
2863third with `-2`; and so on.
2865(However, a different algorithm is used if
2866`gfm_auto_identifiers` is enabled; see below.)
2868These identifiers are used to provide link targets in the table of
2869contents generated by the `--toc|--table-of-contents` option. They
2870also make it easy to provide links from one section of a document to
2871another. A link to this section, for example, might look like this:
2874 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2876Note, however, that this method of providing links to sections works
2877only in HTML, LaTeX, and ConTeXt formats.
2879If the `--section-divs` option is specified, then each section will
2880be wrapped in a `section` (or a `div`, if `html4` was specified),
2881and the identifier will be attached to the enclosing `<section>`
2882(or `<div>`) tag rather than the heading itself. This allows entire
2883sections to be manipulated using JavaScript or treated differently in
2886#### Extension: `ascii_identifiers` ####
2888Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2889Accents are stripped off of accented Latin letters, and non-Latin
2892#### Extension: `gfm_auto_identifiers` ####
2894Changes the algorithm used by `auto_identifiers` to conform to
2895GitHub's method. Spaces are converted to dashes (`-`),
2896uppercase characters to lowercase characters, and punctuation
2897characters other than `-` and `_` are removed.
2898Emojis are replaced by their names.
2902The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2903[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2904[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2905are described in the section about Pandoc's Markdown.
2907However, they can also be used with HTML input. This is handy for
2908reading web pages formatted using MathJax, for example.
2912The following extensions are described in more detail in
2913their respective sections of [Pandoc's Markdown]:
2915- [`raw_html`](#extension-raw_html) allows HTML elements which
2916 are not representable in pandoc's AST to be parsed as raw HTML.
2917 By default, this is disabled for HTML input.
2919- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2920 to be included in a document. This extension can be enabled/disabled
2921 for the following formats (in addition to `markdown`):
2924 : `latex`, `textile`, `html` (environments, `\ref`, and
2925 `\eqref` only), `ipynb`
2928 : `textile`, `commonmark`
2930 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2931 only raw TeX in markdown cells, but data with mime type
2932 `text/html` in output cells. Since the `ipynb` reader attempts
2933 to preserve the richest possible outputs when several options
2934 are given, you will get best results if you disable `raw_html`
2935 and `raw_tex` when converting to formats like `docx` which don't
2936 allow raw `html` or `tex`.
2938- [`native_divs`](#extension-native_divs) causes HTML `div`
2939 elements to be parsed as native pandoc Div blocks.
2940 If you want them to be parsed as raw HTML, use
2941 `-f html-native_divs+raw_html`.
2943- [`native_spans`](#extension-native_spans) causes HTML `span`
2944 elements to be parsed as native pandoc Span inlines.
2945 If you want them to be parsed as raw HTML, use
2946 `-f html-native_spans+raw_html`. If you want to drop all
2947 `div`s and `span`s when converting HTML to Markdown, you
2948 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2950## Literate Haskell support
2952#### Extension: `literate_haskell` ####
2954Treat the document as literate Haskell source.
2956This extension can be enabled/disabled for the following formats:
2959: `markdown`, `rst`, `latex`
2962: `markdown`, `rst`, `latex`, `html`
2964If you append `+lhs` (or `+literate_haskell`) to one of the formats
2965above, pandoc will treat the document as literate Haskell source.
2968 - In Markdown input, "bird track" sections will be parsed as Haskell
2969 code rather than block quotations. Text between `\begin{code}`
2970 and `\end{code}` will also be treated as Haskell code. For
2971 ATX-style headings the character '=' will be used instead of '#'.
2973 - In Markdown output, code blocks with classes `haskell` and `literate`
2974 will be rendered using bird tracks, and block quotations will be
2975 indented one space, so they will not be treated as Haskell code.
2976 In addition, headings will be rendered setext-style (with underlines)
2977 rather than ATX-style (with '#' characters). (This is because ghc
2978 treats '#' characters in column 1 as introducing line numbers.)
2980 - In restructured text input, "bird track" sections will be parsed
2983 - In restructured text output, code blocks with class `haskell` will
2984 be rendered using bird tracks.
2986 - In LaTeX input, text in `code` environments will be parsed as
2989 - In LaTeX output, code blocks with class `haskell` will be rendered
2990 inside `code` environments.
2992 - In HTML output, code blocks with class `haskell` will be rendered
2993 with class `literatehaskell` and bird tracks.
2997 pandoc -f markdown+lhs -t html
2999reads literate Haskell source formatted with Markdown conventions and writes
3000ordinary HTML (without bird tracks).
3002 pandoc -f markdown+lhs -t html+lhs
3004writes HTML with the Haskell code in bird tracks, so it can be copied
3005and pasted as literate Haskell source.
3007Note that GHC expects the bird tracks in the first column, so indented
3008literate code blocks (e.g. inside an itemized environment) will not be
3009picked up by the Haskell compiler.
3013#### Extension: `empty_paragraphs` ####
3015Allows empty paragraphs. By default empty paragraphs are
3018This extension can be enabled/disabled for the following formats:
3024: `docx`, `odt`, `opendocument`, `html`
3026#### Extension: `native_numbering` ####
3028Enables native numbering of figures and tables. Enumeration
3031This extension can be enabled/disabled for the following formats:
3034: `odt`, `opendocument`
3036#### Extension: `xrefs_name` ####
3038Links to headings, figures and tables inside the document are
3039substituted with cross-references that will use the name or caption
3040of the referenced item. The original link text is replaced once
3041the generated document is refreshed. This extension can be combined
3042with `xrefs_number` in which case numbers will appear before the
3045Text in cross-references is only made consistent with the referenced
3046item once the document has been refreshed.
3048This extension can be enabled/disabled for the following formats:
3051: `odt`, `opendocument`
3053#### Extension: `xrefs_number` ####
3055Links to headings, figures and tables inside the document are
3056substituted with cross-references that will use the number
3057of the referenced item. The original link text is discarded.
3058This extension can be combined with `xrefs_name` in which case
3059the name or caption numbers will appear after the number.
3061For the `xrefs_number` to be useful heading numbers must be enabled
3062in the generated document, also table and figure captions must be enabled
3063using for example the `native_numbering` extension.
3065Numbers in cross-references are only visible in the final document once
3066it has been refreshed.
3068This extension can be enabled/disabled for the following formats:
3071: `odt`, `opendocument`
3073#### Extension: `styles` #### {#ext-styles}
3075When converting from docx, read all docx styles as divs (for
3076paragraph styles) and spans (for character styles) regardless
3077of whether pandoc understands the meaning of these styles.
3078This can be used with [docx custom styles](#custom-styles).
3084#### Extension: `amuse` ####
3086In the `muse` input format, this enables Text::Amuse
3087extensions to Emacs Muse markup.
3089#### Extension: `raw_markdown` ####
3091In the `ipynb` input format, this causes Markdown cells
3092to be included as raw Markdown blocks (allowing lossless
3093round-tripping) rather than being parsed. Use this only
3094when you are targeting `ipynb` or a markdown-based
3097#### Extension: `citations` {#org-citations}
3099Some aspects of [Pandoc's Markdown citation syntax](#citations)
3100are also accepted in `org` input.
3102#### Extension: `element_citations` ####
3104In the `jats` output formats, this causes reference items to
3105be replaced with `<element-citation>` elements. These
3106elements are not influenced by CSL styles, but all information
3107on the item is included in tags.
3109#### Extension: `ntb` ####
3111In the `context` output format this enables the use of [Natural Tables
3112(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3113[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3114Natural tables allow more fine-grained global customization but come
3115at a performance penalty compared to extreme tables.
3120Pandoc understands an extended and slightly revised version of
3121John Gruber's [Markdown] syntax. This document explains the syntax,
3122noting differences from standard Markdown. Except where noted, these
3123differences can be suppressed by using the `markdown_strict` format instead
3124of `markdown`. Extensions can be enabled or disabled to specify the
3125behavior more granularly. They are described in the following. See also
3126[Extensions] above, for extensions that work also on other formats.
3130Markdown is designed to be easy to write, and, even more importantly,
3133> A Markdown-formatted document should be publishable as-is, as plain
3134> text, without looking like it's been marked up with tags or formatting
3136> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3138This principle has guided pandoc's decisions in finding syntax for
3139tables, footnotes, and other extensions.
3141There is, however, one respect in which pandoc's aims are different
3142from the original aims of Markdown. Whereas Markdown was originally
3143designed with HTML generation in mind, pandoc is designed for multiple
3144output formats. Thus, while pandoc allows the embedding of raw HTML,
3145it discourages it, and provides other, non-HTMLish ways of representing
3146important document elements like definition lists, tables, mathematics, and
3151A paragraph is one or more lines of text followed by one or more blank lines.
3152Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3153If you need a hard line break, put two or more spaces at the end of a line.
3155#### Extension: `escaped_line_breaks` ####
3157A backslash followed by a newline is also a hard line break.
3158Note: in multiline and grid table cells, this is the only way
3159to create a hard line break, since trailing spaces in the cells
3164There are two kinds of headings: Setext and ATX.
3166### Setext-style headings ###
3168A setext-style heading is a line of text "underlined" with a row of `=` signs
3169(for a level-one heading) or `-` signs (for a level-two heading):
3177The heading text can contain inline formatting, such as emphasis (see
3178[Inline formatting], below).
3181### ATX-style headings ###
3183An ATX-style heading consists of one to six `#` signs and a line of
3184text, optionally followed by any number of `#` signs. The number of
3185`#` signs at the beginning of the line is the heading level:
3187 ## A level-two heading
3189 ### A level-three heading ###
3191As with setext-style headings, the heading text can contain formatting:
3193 # A level-one heading with a [link](/url) and *emphasis*
3195#### Extension: `blank_before_header` ####
3197Standard Markdown syntax does not require a blank line before a heading.
3198Pandoc does require this (except, of course, at the beginning of the
3199document). The reason for the requirement is that it is all too easy for a
3200`#` to end up at the beginning of a line by accident (perhaps through line
3201wrapping). Consider, for example:
3203 I like several of their flavors of ice cream:
3204 #22, for example, and #5.
3206#### Extension: `space_in_atx_header` ####
3208Many Markdown implementations do not require a space between the
3209opening `#`s of an ATX heading and the heading text, so that
3210`#5 bolt` and `#hashtag` count as headings. With this extension,
3211pandoc does require the space.
3213### Heading identifiers ###
3215See also the [`auto_identifiers`
3216extension](#extension-auto_identifiers) above.
3218#### Extension: `header_attributes` ####
3220Headings can be assigned attributes using this syntax at the end
3221of the line containing the heading text:
3223 {#identifier .class .class key=value key=value}
3225Thus, for example, the following headings will all be assigned the identifier
3230 ## My heading ## {#foo}
3232 My other heading {#foo}
3235(This syntax is compatible with [PHP Markdown Extra].)
3237Note that although this syntax allows assignment of classes and key/value
3238attributes, writers generally don't use all of this information. Identifiers,
3239classes, and key/value attributes are used in HTML and HTML-based formats such
3240as EPUB and slidy. Identifiers are used for labels and link anchors in the
3241LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3243Headings with the class `unnumbered` will not be numbered, even if
3244`--number-sections` is specified. A single hyphen (`-`) in an attribute
3245context is equivalent to `.unnumbered`, and preferable in non-English
3252 # My heading {.unnumbered}
3254If the `unlisted` class is present in addition to `unnumbered`,
3255the heading will not be included in a table of contents.
3256(Currently this feature is only implemented for certain
3257formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3259#### Extension: `implicit_header_references` ####
3261Pandoc behaves as if reference links have been defined for each heading.
3262So, to link to a heading
3264 # Heading identifiers in HTML
3268 [Heading identifiers in HTML]
3272 [Heading identifiers in HTML][]
3276 [the section on heading identifiers][heading identifiers in
3279instead of giving the identifier explicitly:
3281 [Heading identifiers in HTML](#heading-identifiers-in-html)
3283If there are multiple headings with identical text, the corresponding
3284reference will link to the first one only, and you will need to use explicit
3285links to link to the others, as described above.
3287Like regular reference links, these references are case-insensitive.
3289Explicit link reference definitions always take priority over
3290implicit heading references. So, in the following example, the
3291link will point to `bar`, not to `#foo`:
3301Markdown uses email conventions for quoting blocks of text.
3302A block quotation is one or more paragraphs or other block elements
3303(such as lists or headings), with each line preceded by a `>` character
3304and an optional space. (The `>` need not start at the left margin, but
3305it should not be indented more than three spaces.)
3307 > This is a block quote. This
3308 > paragraph has two lines.
3310 > 1. This is a list inside a block quote.
3313A "lazy" form, which requires the `>` character only on the first
3314line of each block, is also allowed:
3316 > This is a block quote. This
3317 paragraph has two lines.
3319 > 1. This is a list inside a block quote.
3322Among the block elements that can be contained in a block quote are
3323other block quotes. That is, block quotes can be nested:
3325 > This is a block quote.
3327 > > A block quote within a block quote.
3329If the `>` character is followed by an optional space, that space
3330will be considered part of the block quote marker and not part of
3331the indentation of the contents. Thus, to put an indented code
3332block in a block quote, you need five spaces after the `>`:
3336#### Extension: `blank_before_blockquote` ####
3338Standard Markdown syntax does not require a blank line before a
3339block quote. Pandoc does require this (except, of course, at
3340the beginning of the document). The reason for the requirement
3341is that it is all too easy for a `>` to end up at the beginning
3342of a line by accident (perhaps through line wrapping). So,
3343unless the `markdown_strict` format is used, the following does
3344not produce a nested block quote in pandoc:
3346 > This is a block quote.
3350## Verbatim (code) blocks
3352### Indented code blocks ###
3354A block of text indented four spaces (or one tab) is treated as verbatim
3355text: that is, special characters do not trigger special formatting,
3356and all spaces and line breaks are preserved. For example,
3359 moveShip(5 * gravity, DOWN);
3362The initial (four space or one tab) indentation is not considered part
3363of the verbatim text, and is removed in the output.
3365Note: blank lines in the verbatim text need not begin with four spaces.
3368### Fenced code blocks ###
3370#### Extension: `fenced_code_blocks` ####
3372In addition to standard indented code blocks, pandoc supports
3373*fenced* code blocks. These begin with a row of three or more
3374tildes (`~`) and end with a row of tildes that must be at least as long as
3375the starting row. Everything between these lines is treated as code. No
3376indentation is necessary:
3380 moveShip(5 * gravity, DOWN);
3384Like regular code blocks, fenced code blocks must be separated
3385from surrounding text by blank lines.
3387If the code itself contains a row of tildes or backticks, just use a longer
3388row of tildes or backticks at the start and end:
3392 code including tildes
3396#### Extension: `backtick_code_blocks` ####
3398Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3401#### Extension: `fenced_code_attributes` ####
3403Optionally, you may attach attributes to fenced or backtick code block using
3406 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3408 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3409 qsort (filter (>= x) xs)
3410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3412Here `mycode` is an identifier, `haskell` and `numberLines` are
3413classes, and `startFrom` is an attribute with value `100`. Some
3414output formats can use this information to do syntax
3415highlighting. Currently, the only output formats that uses this
3416information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3417highlighting is supported for your output format and language,
3418then the code block above will appear highlighted, with numbered
3419lines. (To see which languages are supported, type `pandoc
3420--list-highlight-languages`.) Otherwise, the code block above
3421will appear as follows:
3423 <pre id="mycode" class="haskell numberLines" startFrom="100">
3429The `numberLines` (or `number-lines`) class will cause the lines
3430of the code block to be numbered, starting with `1` or the value
3431of the `startFrom` attribute. The `lineAnchors` (or
3432`line-anchors`) class will cause the lines to be clickable
3433anchors in HTML output.
3435A shortcut form can also be used for specifying the language of
3442This is equivalent to:
3448If the `fenced_code_attributes` extension is disabled, but
3449input contains class attribute(s) for the code block, the first
3450class attribute will be printed after the opening fence as a bare
3453To prevent all highlighting, use the `--no-highlight` flag.
3454To set the highlighting style, use `--highlight-style`.
3455For more information on highlighting, see [Syntax highlighting],
3460#### Extension: `line_blocks` ####
3462A line block is a sequence of lines beginning with a vertical bar (`|`)
3463followed by a space. The division into lines will be preserved in
3464the output, as will any leading spaces; otherwise, the lines will
3465be formatted as Markdown. This is useful for verse and addresses:
3467 | The limerick packs laughs anatomical
3468 | In space that is quite economical.
3469 | But the good ones I've seen
3470 | So seldom are clean
3471 | And the clean ones so seldom are comical
3474 | Berkeley, CA 94718
3476The lines can be hard-wrapped if needed, but the continuation
3477line must begin with a space.
3479 | The Right Honorable Most Venerable and Righteous Samuel L.
3482 | Berkeley, CA 94718
3484This syntax is borrowed from [reStructuredText].
3490A bullet list is a list of bulleted list items. A bulleted list
3491item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3498This will produce a "compact" list. If you want a "loose" list, in which
3499each item is formatted as a paragraph, put spaces between the items:
3507The bullets need not be flush with the left margin; they may be
3508indented one, two, or three spaces. The bullet must be followed
3511List items look best if subsequent lines are flush with the first
3512line (after the bullet):
3518But Markdown also allows a "lazy" format:
3524### Block content in list items ###
3526A list item may contain multiple paragraphs and other block-level
3527content. However, subsequent paragraphs must be preceded by a blank line
3528and indented to line up with the first non-space content after
3535 * Second paragraph. With a code block, which must be indented
3540Exception: if the list marker is followed by an indented code
3541block, which must begin 5 spaces after the list marker, then
3542subsequent paragraphs must begin two columns after the last
3543character of the list marker:
3547 continuation paragraph
3549List items may include other lists. In this case the preceding blank
3550line is optional. The nested list must be indented to line up with
3551the first non-space character after the list marker of the
3552containing list item.
3564As noted above, Markdown allows you to write list items "lazily," instead of
3565indenting continuation lines. However, if there are multiple paragraphs or
3566other blocks in a list item, the first line of each must be indented.
3568 + A lazy, lazy, list
3571 + Another one; this looks
3574 Second paragraph of second
3577### Ordered lists ###
3579Ordered lists work just like bulleted lists, except that the items
3580begin with enumerators rather than bullets.
3582In standard Markdown, enumerators are decimal numbers followed
3583by a period and a space. The numbers themselves are ignored, so
3584there is no difference between this list:
3596#### Extension: `fancy_lists` ####
3598Unlike standard Markdown, pandoc allows ordered list items to be marked
3599with uppercase and lowercase letters and roman numerals, in addition to
3600Arabic numerals. List markers may be enclosed in parentheses or followed by a
3601single right-parentheses or period. They must be separated from the
3602text that follows by at least one space, and, if the list marker is a
3603capital letter with a period, by at least two spaces.[^2]
3605[^2]: The point of this rule is to ensure that normal paragraphs
3606 starting with people's initials, like
3608 B. Russell was an English philosopher.
3610 do not get treated as list items.
3612 This rule will not prevent
3616 from being interpreted as a list item. In this case, a backslash
3621The `fancy_lists` extension also allows '`#`' to be used as an
3622ordered list marker in place of a numeral:
3627#### Extension: `startnum` ####
3629Pandoc also pays attention to the type of list marker used, and to the
3630starting number, and both of these are preserved where possible in the
3631output format. Thus, the following yields a list with numbers followed
3632by a single parenthesis, starting with 9, and a sublist with lowercase
3642Pandoc will start a new list each time a different type of list
3643marker is used. So, the following will create three lists:
3650If default list markers are desired, use `#.`:
3656#### Extension: `task_lists` ####
3658Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3660 - [ ] an unchecked task list item
3663### Definition lists ###
3665#### Extension: `definition_lists` ####
3667Pandoc supports definition lists, using the syntax of
3668[PHP Markdown Extra] with some extensions.[^3]
3674 Term 2 with *inline markup*
3678 { some code, part of Definition 2 }
3680 Third paragraph of definition 2.
3682Each term must fit on one line, which may optionally be followed by
3683a blank line, and must be followed by one or more definitions.
3684A definition begins with a colon or tilde, which may be indented one
3687A term may have multiple definitions, and each definition may
3688consist of one or more block elements (paragraph, code block,
3689list, etc.), each indented four spaces or one tab stop. The
3690body of the definition (including the first line, aside from the
3691colon or tilde) should be indented four spaces. However, as with
3692other Markdown lists, you can "lazily" omit indentation except
3693at the beginning of a paragraph or other block element:
3698 with lazy continuation.
3700 Second paragraph of the definition.
3702If you leave space before the definition (as in the example above),
3703the text of the definition will be treated as a paragraph. In some
3704output formats, this will mean greater spacing between term/definition
3705pairs. For a more compact definition list, omit the space before the
3715Note that space between items in a definition list is required.
3716(A variant that loosens this requirement, but disallows "lazy"
3717hard wrapping, can be activated with `compact_definition_lists`: see
3718[Non-pandoc extensions], below.)
3720[^3]: I have been influenced by the suggestions of [David
3721 Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3723### Numbered example lists ###
3725#### Extension: `example_lists` ####
3727The special list marker `@` can be used for sequentially numbered
3728examples. The first list item with a `@` marker will be numbered '1',
3729the next '2', and so on, throughout the document. The numbered examples
3730need not occur in a single list; each new list using `@` will take up
3731where the last stopped. So, for example:
3733 (@) My first example will be numbered (1).
3734 (@) My second example will be numbered (2).
3736 Explanation of examples.
3738 (@) My third example will be numbered (3).
3740Numbered examples can be labeled and referred to elsewhere in the
3743 (@good) This is a good example.
3745 As (@good) illustrates, ...
3747The label can be any string of alphanumeric characters, underscores,
3750Note: continuation paragraphs in example lists must always
3751be indented four spaces, regardless of the length of the
3752list marker. That is, example lists always behave as if the
3753`four_space_rule` extension is set. This is because example
3754labels tend to be long, and indenting content to the
3755first non-space character after the label would be awkward.
3758### Ending a list ###
3760What if you want to put an indented code block after a list?
3767Trouble! Here pandoc (like other Markdown implementations) will treat
3768`{ my code block }` as the second paragraph of item two, and not as
3771To "cut off" the list after item two, you can insert some non-indented
3772content, like an HTML comment, which won't produce visible output in
3778 <!-- end of list -->
3782You can use the same trick if you want two consecutive lists instead
3797A line containing a row of three or more `*`, `-`, or `_` characters
3798(optionally separated by spaces) produces a horizontal rule:
3807Four kinds of tables may be used. The first three kinds presuppose the use of
3808a fixed-width font, such as Courier. The fourth kind can be used with
3809proportionally spaced fonts, as it does not require lining up columns.
3811#### Extension: `table_captions` ####
3813A caption may optionally be provided with all 4 kinds of tables (as
3814illustrated in the examples below). A caption is a paragraph beginning
3815with the string `Table:` (or just `:`), which will be stripped off.
3816It may appear either before or after the table.
3818#### Extension: `simple_tables` ####
3820Simple tables look like this:
3822 Right Left Center Default
3823 ------- ------ ---------- -------
3828 Table: Demonstration of simple table syntax.
3830The header and table rows must each fit on one line. Column
3831alignments are determined by the position of the header text relative
3832to the dashed line below it:[^4]
3834 - If the dashed line is flush with the header text on the right side
3835 but extends beyond it on the left, the column is right-aligned.
3836 - If the dashed line is flush with the header text on the left side
3837 but extends beyond it on the right, the column is left-aligned.
3838 - If the dashed line extends beyond the header text on both sides,
3839 the column is centered.
3840 - If the dashed line is flush with the header text on both sides,
3841 the default alignment is used (in most cases, this will be left).
3843[^4]: This scheme is due to Michel Fortin, who proposed it on the
3844 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3846The table must end with a blank line, or a line of dashes followed by
3849The column header row may be omitted, provided a dashed line is used
3850to end the table. For example:
3852 ------- ------ ---------- -------
3856 ------- ------ ---------- -------
3858When the header row is omitted, column alignments are determined on the basis
3859of the first line of the table body. So, in the tables above, the columns
3860would be right, left, center, and right aligned, respectively.
3862#### Extension: `multiline_tables` ####
3864Multiline tables allow header and table rows to span multiple lines
3865of text (but cells that span multiple columns or rows of the table are
3866not supported). Here is an example:
3868 -------------------------------------------------------------
3869 Centered Default Right Left
3870 Header Aligned Aligned Aligned
3871 ----------- ------- --------------- -------------------------
3872 First row 12.0 Example of a row that
3873 spans multiple lines.
3875 Second row 5.0 Here's another one. Note
3876 the blank line between
3878 -------------------------------------------------------------
3880 Table: Here's the caption. It, too, may span
3883These work like simple tables, but with the following differences:
3885 - They must begin with a row of dashes, before the header text
3886 (unless the header row is omitted).
3887 - They must end with a row of dashes, then a blank line.
3888 - The rows must be separated by blank lines.
3890In multiline tables, the table parser pays attention to the widths of
3891the columns, and the writers try to reproduce these relative widths in
3892the output. So, if you find that one of the columns is too narrow in the
3893output, try widening it in the Markdown source.
3895The header may be omitted in multiline tables as well as simple tables:
3897 ----------- ------- --------------- -------------------------
3898 First row 12.0 Example of a row that
3899 spans multiple lines.
3901 Second row 5.0 Here's another one. Note
3902 the blank line between
3904 ----------- ------- --------------- -------------------------
3906 : Here's a multiline table without a header.
3908It is possible for a multiline table to have just one row, but the row
3909should be followed by a blank line (and then the row of dashes that ends
3910the table), or the table may be interpreted as a simple table.
3912#### Extension: `grid_tables` ####
3914Grid tables look like this:
3916 : Sample grid table.
3918 +---------------+---------------+--------------------+
3919 | Fruit | Price | Advantages |
3920 +===============+===============+====================+
3921 | Bananas | $1.34 | - built-in wrapper |
3922 | | | - bright color |
3923 +---------------+---------------+--------------------+
3924 | Oranges | $2.10 | - cures scurvy |
3926 +---------------+---------------+--------------------+
3928The row of `=`s separates the header from the table body, and can be
3929omitted for a headerless table. The cells of grid tables may contain
3930arbitrary block elements (multiple paragraphs, code blocks, lists,
3931etc.). Cells that span multiple columns or rows are not
3932supported. Grid tables can be created easily using Emacs' table-mode
3933(`M-x table-insert`).
3935Alignments can be specified as with pipe tables, by putting
3936colons at the boundaries of the separator line after the
3939 +---------------+---------------+--------------------+
3940 | Right | Left | Centered |
3941 +==============:+:==============+:==================:+
3942 | Bananas | $1.34 | built-in wrapper |
3943 +---------------+---------------+--------------------+
3945For headerless tables, the colons go on the top line instead:
3947 +--------------:+:--------------+:------------------:+
3948 | Right | Left | Centered |
3949 +---------------+---------------+--------------------+
3951##### Grid Table Limitations #####
3953Pandoc does not support grid tables with row spans or column spans.
3954This means that neither variable numbers of columns across rows nor
3955variable numbers of rows across columns are supported by Pandoc.
3956All grid tables must have the same number of columns in each row,
3957and the same number of rows in each column. For example, the
3958Docutils [sample grid tables] will not render as expected with
3961[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3964#### Extension: `pipe_tables` ####
3966Pipe tables look like this:
3968 | Right | Left | Default | Center |
3969 |------:|:-----|---------|:------:|
3970 | 12 | 12 | 12 | 12 |
3971 | 123 | 123 | 123 | 123 |
3974 : Demonstration of pipe table syntax.
3976The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3977ending pipe characters are optional, but pipes are required between all
3978columns. The colons indicate column alignment as shown. The header
3979cannot be omitted. To simulate a headerless table, include a header
3982Since the pipes indicate column boundaries, columns need not be vertically
3983aligned, as they are in the above example. So, this is a perfectly
3984legal (though ugly) pipe table:
3992The cells of pipe tables cannot contain block elements like paragraphs
3993and lists, and cannot span multiple lines. If a pipe table contains a
3994row whose Markdown content is wider than the column width (see
3995`--columns`), then the table will take up the full text width and
3996the cell contents will wrap, with the relative cell widths determined
3997by the number of dashes in the line separating the table header from
3998the table body. (For example `---|-` would make the first column 3/4
3999and the second column 1/4 of the full text width.)
4000On the other hand, if no lines are wider than column width, then
4001cell contents will not be wrapped, and the cells will be sized
4004Note: pandoc also recognizes pipe tables of the following
4005form, as can be produced by Emacs' orgtbl-mode:
4012The difference is that `+` is used instead of `|`. Other orgtbl features
4013are not supported. In particular, to get non-default column alignment,
4014you'll need to add colons as above.
4016[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4020#### Extension: `pandoc_title_block` ####
4022If the file begins with a title block
4025 % author(s) (separated by semicolons)
4028it will be parsed as bibliographic information, not regular text. (It
4029will be used, for example, in the title of standalone LaTeX or HTML
4030output.) The block may contain just a title, a title and an author,
4031or all three elements. If you want to include an author but no
4032title, or a title and a date but no author, you need a blank line:
4045The title may occupy multiple lines, but continuation lines must
4046begin with leading space, thus:
4053If a document has multiple authors, the authors may be put on
4054separate lines with leading space, or separated by semicolons, or
4055both. So, all of the following are equivalent:
4063% Author One; Author Two
4071The date must fit on one line.
4073All three metadata fields may contain standard inline formatting
4074(italics, links, footnotes, etc.).
4076Title blocks will always be parsed, but they will affect the output only
4077when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4078will appear twice: once in the document head -- this is the title that
4079will appear at the top of the window in a browser -- and once at the
4080beginning of the document body. The title in the document head can have
4081an optional prefix attached (`--title-prefix` or `-T` option). The title
4082in the body appears as an H1 element with class "title", so it can be
4083suppressed or reformatted with CSS. If a title prefix is specified with
4084`-T` and no title block appears in the document, the title prefix will
4085be used by itself as the HTML title.
4087The man page writer extracts a title, man page section number, and
4088other header and footer information from the title line. The title
4089is assumed to be the first word on the title line, which may optionally
4090end with a (single-digit) section number in parentheses. (There should
4091be no space between the title and the parentheses.) Anything after
4092this is assumed to be additional footer and header text. A single pipe
4093character (`|`) should be used to separate the footer text from the header
4098will yield a man page with the title `PANDOC` and section 1.
4100 % PANDOC(1) Pandoc User Manuals
4102will also have "Pandoc User Manuals" in the footer.
4104 % PANDOC(1) Pandoc User Manuals | Version 4.0
4106will also have "Version 4.0" in the header.
4108#### Extension: `yaml_metadata_block` ####
4110A [YAML] metadata block is a valid YAML object, delimited by a line of three
4111hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4112(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4113document, but if it is not at the beginning, it must be preceded by a blank
4114line. (Note that, because of the way pandoc concatenates input files when
4115several are provided, you may also keep the metadata in a separate YAML file
4116and pass it to pandoc as an argument, along with your Markdown files:
4118 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4120Just be sure that the YAML file begins with `---` and ends with `---` or
4121`...`.) Alternatively, you can use the `--metadata-file` option. Using
4122that approach however, you cannot reference content (like footnotes)
4123from the main markdown input document.
4125Metadata will be taken from the fields of the YAML object and added to any
4126existing document metadata. Metadata can contain lists and objects (nested
4127arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4128with names ending in an underscore will be ignored by pandoc. (They may be
4129given a role by external processors.) Field names must not be
4130interpretable as YAML numbers or boolean values (so, for
4131example, `yes`, `True`, and `15` cannot be used as field names).
4133A document may contain multiple metadata blocks. If two
4134metadata blocks attempt to set the same field, the value from
4135the second block will be taken.
4137When pandoc is used with `-t markdown` to create a Markdown document,
4138a YAML metadata block will be produced only if the `-s/--standalone`
4139option is used. All of the metadata will appear in a single block
4140at the beginning of the document.
4142Note that [YAML] escaping rules must be followed. Thus, for example,
4143if a title contains a colon, it must be quoted. The pipe character
4144(`|`) can be used to begin an indented block that will be interpreted
4145literally, without need for escaping. This form is necessary
4146when the field contains blank lines or block-level formatting:
4149 title: 'This is the title: it contains a colon'
4153 keywords: [nothing, nothingness]
4155 This is the abstract.
4157 It consists of two paragraphs.
4160Template variables will be set automatically from the metadata. Thus, for
4161example, in writing HTML, the variable `abstract` will be set to the HTML
4162equivalent of the Markdown in the `abstract` field:
4164 <p>This is the abstract.</p>
4165 <p>It consists of two paragraphs.</p>
4167Variables can contain arbitrary YAML structures, but the template must match
4168this structure. The `author` variable in the default templates expects a
4169simple list or string, but can be changed to support more complicated
4170structures. The following combination, for example, would add an affiliation
4171to the author if one is given:
4174 title: The document title
4177 affiliation: University of Somewhere
4179 affiliation: University of Nowhere
4182To use the structured authors in the example above, you would need a custom
4187 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4193Raw content to include in the document's header may be specified
4194using `header-includes`; however, it is important to mark up
4195this content as raw code for a particular output format, using
4196the [`raw_attribute` extension](#extension-raw_attribute)), or it
4197will be interpreted as markdown. For example:
4202 \let\oldsection\section
4203 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4208#### Extension: `all_symbols_escapable` ####
4210Except inside a code block or inline code, any punctuation or space
4211character preceded by a backslash will be treated literally, even if it
4212would normally indicate formatting. Thus, for example, if one writes
4222 <strong>hello</strong>
4224This rule is easier to remember than standard Markdown's rule,
4225which allows only the following characters to be backslash-escaped:
4229(However, if the `markdown_strict` format is used, the standard Markdown rule
4232A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4233it will appear as `~`. In HTML and XML output, it will appear as a
4234literal unicode nonbreaking space character (note that it will thus
4235actually look "invisible" in the generated HTML source; you can still
4236use the `--ascii` command-line option to make it appear as an explicit
4239A backslash-escaped newline (i.e. a backslash occurring at the end of
4240a line) is parsed as a hard line break. It will appear in TeX output as
4241`\\` and in HTML as `<br />`. This is a nice alternative to
4242Markdown's "invisible" way of indicating hard line breaks using
4243two trailing spaces on a line.
4245Backslash escapes do not work in verbatim contexts.
4251To *emphasize* some text, surround it with `*`s or `_`, like this:
4253 This text is _emphasized with underscores_, and this
4254 is *emphasized with asterisks*.
4256Double `*` or `_` produces **strong emphasis**:
4258 This is **strong emphasis** and __with underscores__.
4260A `*` or `_` character surrounded by spaces, or backslash-escaped,
4261will not trigger emphasis:
4263 This is * not emphasized *, and \*neither is this\*.
4265#### Extension: `intraword_underscores` ####
4267Because `_` is sometimes used inside words and identifiers,
4268pandoc does not interpret a `_` surrounded by alphanumeric
4269characters as an emphasis marker. If you want to emphasize
4270just part of a word, use `*`:
4272 feas*ible*, not feas*able*.
4277#### Extension: `strikeout` ####
4279To strikeout a section of text with a horizontal line, begin and end it
4280with `~~`. Thus, for example,
4282 This ~~is deleted text.~~
4285### Superscripts and subscripts ###
4287#### Extension: `superscript`, `subscript` ####
4289Superscripts may be written by surrounding the superscripted text by `^`
4290characters; subscripts may be written by surrounding the subscripted
4291text by `~` characters. Thus, for example,
4293 H~2~O is a liquid. 2^10^ is 1024.
4295The text between `^...^` or `~...~` may not contain spaces or
4296newlines. If the superscripted or subscripted text contains
4297spaces, these spaces must be escaped with backslashes. (This is
4298to prevent accidental superscripting and subscripting through
4299the ordinary use of `~` and `^`, and also bad interactions with
4300footnotes.) Thus, if you want the letter P with 'a cat' in
4301subscripts, use `P~a\ cat~`, not `P~a cat~`.
4305To make a short span of text verbatim, put it inside backticks:
4307 What is the difference between `>>=` and `>>`?
4309If the verbatim text includes a backtick, use double backticks:
4311 Here is a literal backtick `` ` ``.
4313(The spaces after the opening backticks and before the closing
4314backticks will be ignored.)
4316The general rule is that a verbatim span starts with a string
4317of consecutive backticks (optionally followed by a space)
4318and ends with a string of the same number of backticks (optionally
4319preceded by a space).
4321Note that backslash-escapes (and other Markdown constructs) do not
4322work in verbatim contexts:
4324 This is a backslash followed by an asterisk: `\*`.
4326#### Extension: `inline_code_attributes` ####
4328Attributes can be attached to verbatim text, just as with
4329[fenced code blocks]:
4335To write small caps, use the `smallcaps` class:
4337 [Small caps]{.smallcaps}
4339Or, without the `bracketed_spans` extension:
4341 <span class="smallcaps">Small caps</span>
4343For compatibility with other Markdown flavors, CSS is also supported:
4345 <span style="font-variant:small-caps;">Small caps</span>
4347This will work in all output formats that support small caps.
4352#### Extension: `tex_math_dollars` ####
4354Anything between two `$` characters will be treated as TeX math. The
4355opening `$` must have a non-space character immediately to its right,
4356while the closing `$` must have a non-space character immediately to its
4357left, and must not be followed immediately by a digit. Thus,
4358`$20,000 and $30,000` won't parse as math. If for some reason
4359you need to enclose text in literal `$` characters, backslash-escape
4360them and they won't be treated as math delimiters.
4362For display math, use `$$` delimiters. (In this case, the delimiters
4363may be separated from the formula by whitespace.)
4365TeX math will be printed in all output formats. How it is rendered
4366depends on the output format:
4369 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4370 math) or `\[...\]` (for display math).
4372Markdown, Emacs Org mode, ConTeXt, ZimWiki
4373 ~ It will appear verbatim surrounded by `$...$` (for inline
4374 math) or `$$...$$` (for display math).
4377 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4380 ~ It will be rendered using an [interpreted text role `:math:`].
4383 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4384 surrounded by `latexmath:[$...$]` (for inline math) or
4385 `[latexmath]++++\[...\]+++` (for display math).
4386 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4387 (`$..$` and `\[..\]`) are omitted.
4390 ~ It will be rendered inside a `@math` command.
4392roff man, Jira markup
4393 ~ It will be rendered verbatim without `$`'s.
4396 ~ It will be rendered inside `<math>` tags.
4399 ~ It will be rendered inside `<span class="math">` tags.
4402 ~ It will be rendered, if possible, using Unicode characters,
4403 and will otherwise appear verbatim.
4406 ~ It will be rendered, if possible, using MathML.
4409 ~ If the `--mathml` flag is used, it will be rendered using MathML
4410 in an `inlineequation` or `informalequation` tag. Otherwise it
4411 will be rendered, if possible, using Unicode characters.
4414 ~ It will be rendered using OMML math markup.
4417 ~ If the `--webtex` option is used, formulas are rendered as images
4418 using CodeCogs or other compatible web service, downloaded
4419 and embedded in the e-book. Otherwise, they will appear verbatim.
4421HTML, Slidy, DZSlides, S5, EPUB
4422 ~ The way math is rendered in HTML will depend on the
4423 command-line options selected. Therefore see [Math rendering in HTML]
4426[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4430#### Extension: `raw_html` ####
4432Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4433(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4434literally). (Technically this is not an extension, since standard
4435Markdown allows it, but it has been made an extension so that it can
4436be disabled if desired.)
4438The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4439DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4440output, and suppressed in other formats.
4442For a more explicit way of including raw HTML in a Markdown
4443document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4445In the CommonMark format, if `raw_html` is enabled, superscripts,
4446subscripts, strikeouts and small capitals will be represented as HTML.
4447Otherwise, plain-text fallbacks will be used. Note that even if
4448`raw_html` is disabled, tables will be rendered with HTML syntax if
4449they cannot use pipe syntax.
4451#### Extension: `markdown_in_html_blocks` ####
4453Standard Markdown allows you to include HTML "blocks": blocks
4454of HTML between balanced tags that are separated from the surrounding text
4455with blank lines, and start and end at the left margin. Within
4456these blocks, everything is interpreted as HTML, not Markdown;
4457so (for example), `*` does not signify emphasis.
4459Pandoc behaves this way when the `markdown_strict` format is used; but
4460by default, pandoc interprets material between HTML block tags as Markdown.
4461Thus, for example, pandoc will turn
4466 <td>[a link](https://google.com)</td>
4474 <td><em>one</em></td>
4475 <td><a href="https://google.com">a link</a></td>
4479whereas `Markdown.pl` will preserve it as is.
4481There is one exception to this rule: text between `<script>`,
4482`<style>`, and `<textarea>` tags is not interpreted as Markdown.
4484This departure from standard Markdown should make it easier to mix
4485Markdown with HTML block elements. For example, one can surround
4486a block of Markdown text with `<div>` tags without preventing it
4487from being interpreted as Markdown.
4489#### Extension: `native_divs` ####
4491Use native pandoc `Div` blocks for content inside `<div>` tags.
4492For the most part this should give the same output as
4493`markdown_in_html_blocks`, but it makes it easier to write pandoc
4494filters to manipulate groups of blocks.
4496#### Extension: `native_spans` ####
4498Use native pandoc `Span` blocks for content inside `<span>` tags.
4499For the most part this should give the same output as `raw_html`,
4500but it makes it easier to write pandoc filters to manipulate groups
4503#### Extension: `raw_tex` ####
4505In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4506included in a document. Inline TeX commands will be preserved and passed
4507unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4508LaTeX to include BibTeX citations:
4510 This result was proved in \cite{jones.1967}.
4512Note that in LaTeX environments, like
4514 \begin{tabular}{|l|l|}\hline
4515 Age & Frequency \\ \hline
4518 36--45 & 22 \\ \hline
4521the material between the begin and end tags will be interpreted as raw
4522LaTeX, not as Markdown.
4524For a more explicit and flexible way of including raw TeX in a
4525Markdown document, see the [`raw_attribute`
4526extension][Extension: `raw_attribute`].
4528Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4529Emacs Org mode, and ConTeXt.
4531### Generic raw attribute ###
4533#### Extension: `raw_attribute` ####
4535Inline spans and fenced code blocks with a special
4536kind of attribute will be parsed as raw content with the
4537designated format. For example, the following produces a raw
4544And the following produces a raw `html` inline element:
4546 This is `<a>html</a>`{=html}
4548This can be useful to insert raw xml into `docx` documents, e.g.
4554 <w:br w:type="page"/>
4559The format name should match the target format name (see
4560`-t/--to`, above, for a list, or use `pandoc
4561--list-output-formats`). Use `openxml` for `docx` output,
4562`opendocument` for `odt` output, `html5` for `epub3` output,
4563`html4` for `epub2` output, and `latex`, `beamer`,
4564`ms`, or `html5` for `pdf` output (depending on what you
4565use for `--pdf-engine`).
4567This extension presupposes that the relevant kind of
4568inline code or fenced code block is enabled. Thus, for
4569example, to use a raw attribute with a backtick code block,
4570`backtick_code_blocks` must be enabled.
4572The raw attribute cannot be combined with regular attributes.
4576#### Extension: `latex_macros` ####
4578When this extension is enabled, pandoc will parse LaTeX
4579macro definitions and apply the resulting macros to all LaTeX
4580math and raw LaTeX. So, for example, the following will work in
4581all output formats, not just LaTeX:
4583 \newcommand{\tuple}[1]{\langle #1 \rangle}
4587Note that LaTeX macros will not be applied if they occur
4588inside a raw span or block marked with the
4589[`raw_attribute` extension](#extension-raw_attribute).
4591When `latex_macros` is disabled, the raw LaTeX and math will
4592not have macros applied. This is usually a better approach when
4593you are targeting LaTeX or PDF.
4595Macro definitions in LaTeX will be passed through as raw LaTeX
4596only if `latex_macros` is not enabled. Macro definitions in
4597Markdown source (or other formats allowing `raw_tex`) will
4598be passed through regardless of whether `latex_macros` is
4603Markdown allows links to be specified in several ways.
4605### Automatic links ###
4607If you enclose a URL or email address in pointy brackets, it
4610 <https://google.com>
4611 <sam@green.eggs.ham>
4615An inline link consists of the link text in square brackets,
4616followed by the URL in parentheses. (Optionally, the URL can
4617be followed by a link title, in quotes.)
4619 This is an [inline link](/url), and here's [one with
4620 a title](https://fsf.org "click here for a good time!").
4622There can be no space between the bracketed part and the parenthesized part.
4623The link text can contain formatting (such as emphasis), but the title cannot.
4625Email addresses in inline links are not autodetected, so they have to be
4626prefixed with `mailto`:
4628 [Write me!](mailto:sam@green.eggs.ham)
4630### Reference links ###
4632An *explicit* reference link has two parts, the link itself and the link
4633definition, which may occur elsewhere in the document (either
4634before or after the link).
4636The link consists of link text in square brackets, followed by a label in
4637square brackets. (There cannot be space between the two unless the
4638`spaced_reference_links` extension is enabled.) The link definition
4639consists of the bracketed label, followed by a colon and a space, followed by
4640the URL, and optionally (after a space) a link title either in quotes or in
4641parentheses. The label must not be parseable as a citation (assuming
4642the `citations` extension is enabled): citations take precedence over
4645Here are some examples:
4647 [my label 1]: /foo/bar.html "My title, optional"
4649 [my label 3]: https://fsf.org (The free software foundation)
4650 [my label 4]: /bar#special 'A title in single quotes'
4652The URL may optionally be surrounded by angle brackets:
4654 [my label 5]: <http://foo.bar.baz>
4656The title may go on the next line:
4658 [my label 3]: https://fsf.org
4659 "The free software foundation"
4661Note that link labels are not case sensitive. So, this will work:
4663 Here is [my link][FOO]
4667In an *implicit* reference link, the second pair of brackets is
4672 [my website]: http://foo.bar.baz
4674Note: In `Markdown.pl` and most other Markdown implementations,
4675reference link definitions cannot occur in nested constructions
4676such as list items or block quotes. Pandoc lifts this arbitrary
4677seeming restriction. So the following is fine in pandoc, though
4678not in most other implementations:
4684#### Extension: `shortcut_reference_links` ####
4686In a *shortcut* reference link, the second pair of brackets may
4691 [my website]: http://foo.bar.baz
4693### Internal links ###
4695To link to another section of the same document, use the automatically
4696generated identifier (see [Heading identifiers]). For example:
4698 See the [Introduction](#introduction).
4702 See the [Introduction].
4704 [Introduction]: #introduction
4706Internal links are currently supported for HTML formats (including
4707HTML slide shows and EPUB), LaTeX, and ConTeXt.
4711A link immediately preceded by a `!` will be treated as an image.
4712The link text will be used as the image's alt text:
4714 
4718 [movie reel]: movie.gif
4720#### Extension: `implicit_figures` ####
4722An image with nonempty alt text, occurring by itself in a
4723paragraph, will be rendered as a figure with a caption. The
4724image's alt text will be used as the caption.
4726 
4728How this is rendered depends on the output format. Some output
4729formats (e.g. RTF) do not yet support figures. In those
4730formats, you'll just get an image in a paragraph by itself, with
4733If you just want a regular inline image, just make sure it is not
4734the only thing in the paragraph. One way to do this is to insert a
4735nonbreaking space after the image:
4737 \
4739Note that in reveal.js slide shows, an image in a paragraph
4740by itself that has the `stretch` class will fill the screen,
4741and the caption and figure tags will be omitted.
4743#### Extension: `link_attributes` ####
4745Attributes can be set on links and images:
4747 An inline {#id .class width=30 height=20px}
4748 and a reference ![image][ref] with attributes.
4750 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4752(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4753and `.class` are used.)
4755For HTML and EPUB, all known HTML5 attributes except `width` and
4756`height` (but including `srcset` and `sizes`) are passed through
4757as is. Unknown attributes are passed through as custom
4758attributes, with `data-` prepended. The other writers ignore
4759attributes that are not specifically supported by their output format.
4761The `width` and `height` attributes on images are treated specially. When
4762used without a unit, the unit is assumed to be pixels. However, any of
4763the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4764and `%`. There must not be any spaces between the number and the unit.
4768{ width=50% }
4771- Dimensions may be converted to a form that is compatible with
4772 the output format (for example, dimensions given in pixels will
4773 be converted to inches when converting HTML to LaTeX). Conversion
4774 between pixels and physical measurements is affected by the
4775 `--dpi` option (by default, 96 dpi is assumed, unless the image
4776 itself contains dpi information).
4777- The `%` unit is generally relative to some available space.
4778 For example the above example will render to the following.
4779 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4780 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4781 (If you're using a custom template, you need to configure `graphicx`
4782 as in the default template.)
4783 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4784- Some output formats have a notion of a class
4785 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4786 or a unique identifier (LaTeX `\caption`), or both (HTML).
4787- When no `width` or `height` attributes are specified, the fallback
4788 is to look at the image resolution and the dpi metadata embedded in
4793Using the `native_divs` and `native_spans` extensions
4794(see [above][Extension: `native_divs`]), HTML syntax can
4795be used as part of markdown to create native `Div` and `Span`
4796elements in the pandoc AST (as opposed to raw HTML).
4797However, there is also nicer syntax available:
4799#### Extension: `fenced_divs` ####
4801Allow special fenced syntax for native `Div` blocks. A Div
4802starts with a fence containing at least three consecutive
4803colons plus some attributes. The attributes may optionally
4804be followed by another string of consecutive colons.
4805The attribute syntax is exactly as in fenced code blocks (see
4806[Extension: `fenced_code_attributes`]). As with fenced
4807code blocks, one can use either attributes in curly braces
4808or a single unbraced word, which will be treated as a class
4809name. The Div ends with another line containing a string of at
4810least three consecutive colons. The fenced Div should be
4811separated by blank lines from preceding and following blocks.
4815 ::::: {#special .sidebar}
4816 Here is a paragraph.
4821Fenced divs can be nested. Opening fences are distinguished
4822because they *must* have attributes:
4828 This is a warning within a warning.
4832Fences without attributes are always closing fences. Unlike
4833with fenced code blocks, the number of colons in the closing
4834fence need not match the number in the opening fence. However,
4835it can be helpful for visual clarity to use fences of different
4836lengths to distinguish nested divs from their parents.
4839#### Extension: `bracketed_spans` ####
4841A bracketed sequence of inlines, as one would use to begin
4842a link, will be treated as a `Span` with attributes if it is
4843followed immediately by attributes:
4845 [This is *some text*]{.class key="val"}
4849#### Extension: `footnotes` ####
4851Pandoc's Markdown allows footnotes, using the following syntax:
4853 Here is a footnote reference,[^1] and another.[^longnote]
4855 [^1]: Here is the footnote.
4857 [^longnote]: Here's one with multiple blocks.
4859 Subsequent paragraphs are indented to show that they
4860 belong to the previous footnote.
4864 The whole paragraph can be indented, or just the first
4865 line. In this way, multi-paragraph footnotes work like
4866 multi-paragraph list items.
4868 This paragraph won't be part of the note, because it
4871The identifiers in footnote references may not contain spaces, tabs,
4872or newlines. These identifiers are used only to correlate the
4873footnote reference with the note itself; in the output, footnotes
4874will be numbered sequentially.
4876The footnotes themselves need not be placed at the end of the
4877document. They may appear anywhere except inside other block elements
4878(lists, block quotes, tables, etc.). Each footnote should be
4879separated from surrounding content (including other footnotes)
4882#### Extension: `inline_notes` ####
4884Inline footnotes are also allowed (though, unlike regular notes,
4885they cannot contain multiple paragraphs). The syntax is as follows:
4887 Here is an inline note.^[Inlines notes are easier to write, since
4888 you don't have to pick an identifier and move down to type the
4891Inline and regular footnotes may be mixed freely.
4895#### Extension: `citations` ####
4897Markdown citations go inside square brackets and are separated
4898by semicolons. Each citation must have a key, composed of '@' +
4899the citation identifier from the database, and may optionally
4900have a prefix, a locator, and a suffix. The citation key must
4901begin with a letter, digit, or `_`, and may contain
4902alphanumerics, `_`, and internal punctuation characters
4903(`:.#$%&-+?<>~/`). Here are some examples:
4905 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4907 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4909 Blah blah [@smith04; @doe99].
4911`pandoc` detects locator terms in the [CSL locale files].
4912Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4913locale, locator terms can be written in either singular or plural forms,
4914as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4915`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4916`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4917`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4918`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4919`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4920locator term is used, "page" is assumed.
4922`pandoc` will use heuristics to distinguish the locator
4923from the suffix. In complex cases, the locator can be enclosed
4926 [@smith{ii, A, D-Z}, with a suffix]
4927 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4929A minus sign (`-`) before the `@` will suppress mention of
4930the author in the citation. This can be useful when the
4931author is already mentioned in the text:
4933 Smith says blah [-@smith04].
4935You can also write an in-text citation, as follows:
4939 @smith04 [p. 33] says blah.
4942[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4943[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4944[Chicago Manual of Style]: https://chicagomanualofstyle.org
4945[Citation Style Language]: https://citationstyles.org
4946[Zotero Style Repository]: https://www.zotero.org/styles
4947[finding and editing styles]: https://citationstyles.org/authors/
4948[CSL locale files]: https://github.com/citation-style-language/locales
4950## Non-pandoc extensions
4952The following Markdown syntax extensions are not enabled by default
4953in pandoc, but may be enabled by adding `+EXTENSION` to the format
4954name, where `EXTENSION` is the name of the extension. Thus, for
4955example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4957#### Extension: `attributes` ####
4959Allows attributes to be attached to any inline or block-level
4960element. The syntax for the attributes is the same as that
4961used in [`header_attributes`][Extension: `header_attributes`].
4963- Attributes that occur immediately after an inline
4964 element affect that element. If they follow a space, then they
4965 belong to the space. (Hence, this option subsumes
4966 `inline_code_attributes` and `link_attributes`.)
4967- Attributes that occur immediately before a block
4968 element, on a line by themselves, affect that
4970- Consecutive attribute specifiers may be used,
4971 either for blocks or for inlines. Their attributes
4973- Attributes that occur at the end of the text of
4974 a Setext or ATX heading (separated by whitespace
4975 from the text) affect the heading element. (Hence, this
4976 option subsumes `header_attributes`.)
4977- Attributes that occur after the opening fence
4978 in a fenced code block affect the code block element. (Hence,
4979 this option subsumes `fenced_code_attributes`.)
4980- Attributes that occur at the end of a reference
4981 link definition affect links that refer to that
4984Note that pandoc's AST does not currently allow attributes
4985to be attached to arbitrary elements. Hence a Span or Div
4986container will be added if needed.
4988#### Extension: `old_dashes` ####
4990Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4991`-` before a numeral is an en-dash, and `--` is an em-dash.
4992This option only has an effect if `smart` is enabled. It is
4993selected automatically for `textile` input.
4995#### Extension: `angle_brackets_escapable` ####
4997Allow `<` and `>` to be backslash-escaped, as they can be in
4998GitHub flavored Markdown but not original Markdown. This is
4999implied by pandoc's default `all_symbols_escapable`.
5001#### Extension: `lists_without_preceding_blankline` ####
5003Allow a list to occur right after a paragraph, with no intervening
5006#### Extension: `four_space_rule` ####
5008Selects the pandoc <= 2.0 behavior for parsing lists, so that
5009four spaces indent are needed for list item continuation
5012#### Extension: `spaced_reference_links` ####
5014Allow whitespace between the two components of a reference link,
5019#### Extension: `hard_line_breaks` ####
5021Causes all newlines within a paragraph to be interpreted as hard line
5022breaks instead of spaces.
5024#### Extension: `ignore_line_breaks` ####
5026Causes newlines within a paragraph to be ignored, rather than being
5027treated as spaces or as hard line breaks. This option is intended for
5028use with East Asian languages where spaces are not used between words,
5029but text is divided into lines for readability.
5031#### Extension: `east_asian_line_breaks` ####
5033Causes newlines within a paragraph to be ignored, rather than
5034being treated as spaces or as hard line breaks, when they occur
5035between two East Asian wide characters. This is a better choice
5036than `ignore_line_breaks` for texts that include a mix of East
5037Asian wide characters and other characters.
5039#### Extension: `emoji` ####
5041Parses textual emojis like `:smile:` as Unicode emoticons.
5043#### Extension: `tex_math_single_backslash` ####
5045Causes anything between `\(` and `\)` to be interpreted as inline
5046TeX math, and anything between `\[` and `\]` to be interpreted
5047as display TeX math. Note: a drawback of this extension is that
5048it precludes escaping `(` and `[`.
5050#### Extension: `tex_math_double_backslash` ####
5052Causes anything between `\\(` and `\\)` to be interpreted as inline
5053TeX math, and anything between `\\[` and `\\]` to be interpreted
5056#### Extension: `markdown_attribute` ####
5058By default, pandoc interprets material inside block-level tags as Markdown.
5059This extension changes the behavior so that Markdown is only parsed
5060inside block-level tags if the tags have the attribute `markdown=1`.
5062#### Extension: `mmd_title_block` ####
5064Enables a [MultiMarkdown] style title block at the top of
5065the document, for example:
5069 Date: September 1, 2008
5070 Comment: This is a sample mmd title block, with
5071 a field spanning multiple lines.
5073See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5074`yaml_metadata_block` is enabled, it will take precedence over
5077#### Extension: `abbreviations` ####
5079Parses PHP Markdown Extra abbreviation keys, like
5081 *[HTML]: Hypertext Markup Language
5083Note that the pandoc document model does not support
5084abbreviations, so if this extension is enabled, abbreviation keys are
5085simply skipped (as opposed to being parsed as paragraphs).
5087#### Extension: `autolink_bare_uris` ####
5089Makes all absolute URIs into links, even when not surrounded by
5090pointy braces `<...>`.
5092#### Extension: `mmd_link_attributes` ####
5094Parses multimarkdown style key-value attributes on link
5095and image references. This extension should not be confused with the
5096[`link_attributes`](#extension-link_attributes) extension.
5098 This is a reference ![image][ref] with multimarkdown attributes.
5100 [ref]: https://path.to/image "Image title" width=20px height=30px
5101 id=myId class="myClass1 myClass2"
5103#### Extension: `mmd_header_identifiers` ####
5105Parses multimarkdown style heading identifiers (in square brackets,
5106after the heading but before any trailing `#`s in an ATX heading).
5108#### Extension: `compact_definition_lists` ####
5110Activates the definition list syntax of pandoc 1.12.x and earlier.
5111This syntax differs from the one described above under [Definition lists]
5114 - No blank line is required between consecutive items of the
5116 - To get a "tight" or "compact" list, omit space between consecutive
5117 items; the space between a term and its definition does not affect
5119 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5120 be indented four spaces.[^6]
5122[^6]: To see why laziness is incompatible with relaxing the requirement
5123 of a blank line between items, consider the following example:
5130 Is this a single list item with two definitions of "bar," the first of
5131 which is lazily wrapped, or two list items? To remove the ambiguity
5132 we must either disallow lazy wrapping or require a blank line between
5135#### Extension: `gutenberg` ####
5137Use [Project Gutenberg] conventions for `plain` output:
5138all-caps for strong emphasis, surround by underscores
5139for regular emphasis, add extra blank space around headings.
5141 [Project Gutenberg]: https://www.gutenberg.org
5143#### Extension: `sourcepos` ####
5145Include source position attributes when parsing `commonmark`.
5146For elements that accept attributes, a `data-pos` attribute
5147is added; other elements are placed in a surrounding
5148Div or Span elemnet with a `data-pos` attribute.
5152In addition to pandoc's extended Markdown, the following Markdown
5153variants are supported:
5155- `markdown_phpextra` (PHP Markdown Extra)
5156- `markdown_github` (deprecated GitHub-Flavored Markdown)
5157- `markdown_mmd` (MultiMarkdown)
5158- `markdown_strict` (Markdown.pl)
5159- `commonmark` (CommonMark)
5160- `gfm` (Github-Flavored Markdown)
5161- `commonmark_x` (CommonMark with many pandoc extensions)
5163To see which extensions are supported for a given format,
5164and which are enabled by default, you can use the command
5166 pandoc --list-extensions=FORMAT
5168where `FORMAT` is replaced with the name of the format.
5170Note that the list of extensions for `commonmark`,
5171`gfm`, and `commonmark_x` are defined relative to default
5172commonmark. So, for example, `backtick_code_blocks`
5173does not appear as an extension, since it is enabled by
5174default and cannot be disabled.
5178When the `--citeproc` option is used, pandoc can automatically generate
5179citations and a bibliography in a number of styles. Basic usage is
5181 pandoc --citeproc myinput.txt
5183To use this feature, you will need to have
5185- a document containing citations (see [Extension: `citations`]);
5186- a source of bibliographic data: either an external bibliography
5187 file or a list of `references` in the document's YAML metadata
5188- optionally, a [CSL] citation style.
5190## Specifying bibliographic data
5192You can specify an external bibliography using the
5193`bibliography` metadata field in a YAML metadata section or the
5194`--bibliography` command line argument. If you want to use
5195multiple bibliography files, you can supply multiple
5196`--bibliography` arguments or set `bibliography` metadata field
5197to YAML array. A bibliography may have any of these formats:
5199 Format File extension
5200 ------------ --------------
5206Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5207use the extension `.bibtex` to force interpretation as BibTeX.
5209In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5210inside fields such as `title`; in CSL YAML databases, pandoc
5211Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5220`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5229`<span class="nocase">...</span>`
5230: prevent a phrase from being capitalized as title case
5232As an alternative to specifying a bibliography file using
5233`--bibliography` or the YAML metadata field `bibliography`, you
5234can include the citation data directly in the `references` field
5235of the document's YAML metadata. The field should contain an
5236array of YAML-encoded references, for example:
5240 - type: article-journal
5252 title: 'Molecular structure of nucleic acids: a structure for
5253 deoxyribose nucleic acid'
5254 title-short: Molecular structure of nucleic acids
5255 container-title: Nature
5259 DOI: 10.1038/171737a0
5260 URL: https://www.nature.com/articles/171737a0
5264If both an external bibliography and inline (YAML metadata)
5265references are provided, both will be used. In case of
5266conflicting `id`s, the inline references will take precedence.
5268Note that `pandoc` can be used to produce such a YAML metadata
5269section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5271 pandoc chem.bib -s -f biblatex -t markdown
5272 pandoc chem.json -s -f csljson -t markdown
5274Indeed, `pandoc` can convert between any of these
5277 pandoc chem.bib -s -f biblatex -t csljson
5278 pandoc chem.yaml -s -f markdown -t biblatex
5280Running pandoc on a bibliography file with the `--citeproc`
5281option will create a formatted bibliography in the format
5284 pandoc chem.bib -s --citeproc -o chem.html
5285 pandoc chem.bib -s --citeproc -o chem.pdf
5287### Capitalization in titles
5289If you are using a bibtex or biblatex bibliography, then observe
5292 - English titles should be in title case. Non-English titles should
5293 be in sentence case, and the `langid` field in biblatex should be
5294 set to the relevant language. (The following values are treated
5295 as English: `american`, `british`, `canadian`, `english`,
5296 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5298 - As is standard with bibtex/biblatex, proper names should be
5299 protected with curly braces so that they won't be lowercased
5300 in styles that call for sentence case. For example:
5302 title = {My Dinner with {Andre}}
5304 - In addition, words that should remain lowercase (or camelCase)
5305 should be protected:
5307 title = {Spin Wave Dispersion on the {nm} Scale}
5309 Though this is not necessary in bibtex/biblatex, it is necessary
5310 with citeproc, which stores titles internally in sentence case,
5311 and converts to title case in styles that require it. Here we
5312 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5314If you are using a CSL bibliography (either JSON or YAML), then observe
5317 - All titles should be in sentence case.
5319 - Use the `language` field for non-English titles to prevent their
5320 conversion to title case in styles that call for this. (Conversion
5321 happens only if `language` begins with `en` or is left empty.)
5323 - Protect words that should not be converted to title case using
5326 Spin wave dispersion on the <span class="nocase">nm</span> scale
5328### Conference Papers, Published vs. Unpublished
5330For a formally published conference paper, use the biblatex entry type
5331`inproceedings` (which will be mapped to CSL `paper-conference`).
5333For an unpublished manuscript, use the biblatex entry type
5334`unpublished` without an `eventtitle` field (this entry type
5335will be mapped to CSL `manuscript`).
5337For a talk, an unpublished conference paper, or a poster
5338presentation, use the biblatex entry type `unpublished` with an
5339`eventtitle` field (this entry type will be mapped to CSL
5340`speech`). Use the biblatex `type` field to indicate the type,
5341e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5342too, though `eventdate` will not be rendered by most CSL styles.
5343Note that `venue` is for the event's venue, unlike `location`
5344which describes the publisher's location; do not use the latter
5345for an unpublished conference paper.
5348## Specifying a citation style
5350Citations and references can be formatted using any style supported by the
5351[Citation Style Language], listed in the [Zotero Style Repository].
5352These files are specified using the `--csl` option or the `csl`
5353(or `citation-style`) metadata field. By default, pandoc will
5354use the [Chicago Manual of Style] author-date format. (You can
5355override this default by copying a CSL style of your choice
5356to `default.csl` in your user data directory.)
5357The CSL project provides further information on [finding and
5360The `--citation-abbreviations` option (or the
5361`citation-abbreviations` metadata field) may be used to specify
5362a JSON file containing abbreviations of journals that should be
5363used in formatted bibliographies when `form="short"` is
5364specified. The format of the file can be illustrated with an
5369 "container-title": {
5370 "Lloyd's Law Reports": "Lloyd's Rep",
5371 "Estates Gazette": "EG",
5372 "Scots Law Times": "SLT"
5378## Citations in note styles
5380Pandoc's citation processing is designed to allow you to
5381move between author-date, numerical, and note styles without
5382modifying the markdown source. When you're using a note
5383style, avoid inserting footnotes manually. Instead, insert
5384citations just as you would in an author-date style---for
5387 Blah blah [@foo, p. 33].
5389The footnote will be created automatically. Pandoc will take
5390care of removing the space and moving the note before or
5391after the period, depending on the setting of
5392`notes-after-punctuation`, as described below in [Other relevant
5395In some cases you may need to put a citation inside a regular
5396footnote. Normal citations in footnotes (such as `[@foo, p.
539733]`) will be rendered in parentheses. In-text citations (such
5398as `@foo [p. 33]`) will be rendered without parentheses. (A
5399comma will be added if appropriate.) Thus:
5401 [^1]: Some studies [@foo; @bar, p. 33] show that
5402 frubulicious zoosnaps are quantical. For a survey
5403 of the literature, see @baz [chap. 1].
5405## Raw content in a style
5407To include raw content in a prefix, suffix, delimiter, or term,
5408surround it with these tags indicating the format:
5410 {{jats}}<ref>{{/jats}}
5412Without the tags, the string will be interpreted as a string
5413and escaped in the output, rather than being passed through raw.
5415This feature allows stylesheets to be customized to give
5416different output for different output formats. However,
5417stylesheets customized in this way will not be usable
5418by other CSL implementations.
5422## Placement of the bibliography
5424If the style calls for a list of works cited, it will be placed
5425in a div with id `refs`, if one exists:
5430Otherwise, it will be placed at the end of the document.
5431Generation of the bibliography can be suppressed by setting
5432`suppress-bibliography: true` in the YAML metadata.
5434If you wish the bibliography to have a section heading, you can
5435set `reference-section-title` in the metadata, or put the heading
5436at the beginning of the div with id `refs` (if you are using it)
5437or at the end of your document:
5443The bibliography will be inserted after this heading. Note that
5444the `unnumbered` class will be added to this heading, so that the
5445section will not be numbered.
5447## Including uncited items in the bibliography
5449If you want to include items in the bibliography without actually
5450citing them in the body text, you can define a dummy `nocite` metadata
5451field and put the citations there:
5460In this example, the document will contain a citation for `item3`
5461only, but the bibliography will contain entries for `item1`, `item2`, and
5464It is possible to create a bibliography with all the citations,
5465whether or not they appear in the document, by using a wildcard:
5472For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5473render the bibliography. In order to do so, specify bibliography
5474files as outlined above, and add `--natbib` or `--biblatex`
5475argument to `pandoc` invocation. Bear in mind that bibliography
5476files have to be in either BibTeX (for `--natbib`)
5477or BibLaTeX (for `--biblatex`) format.
5479## Other relevant metadata fields
5481A few other metadata fields affect bibliography formatting:
5484: If true, citations will be
5485 hyperlinked to the corresponding bibliography entries
5486 (for author-date and numerical styles only).
5489: The `lang` field will affect how the style is localized,
5490 for example in the translation of labels and the use
5491 of quotation marks. (For backwards compatibility,
5492 `locale` may be used instead of `lang`, but this use
5495`notes-after-punctuation`
5496: If true (the default), pandoc will put footnote citations
5497 after following punctuation. For example, if the source
5498 contains `blah blah [@jones99].`, the result will look like
5499 `blah blah.[^1]`, with the note moved after the period and
5500 the space collapsed. If false, the space will still be
5501 collapsed, but the footnote will not be moved after the
5513You can use pandoc to produce an HTML + JavaScript slide presentation
5514that can be viewed via a web browser. There are five ways to do this,
5515using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5516You can also produce a PDF slide show using LaTeX [`beamer`], or
5517slides shows in Microsoft [PowerPoint] format.
5519Here's the Markdown source for a simple slide show, `habits.txt`:
5546 
5553To produce an HTML/JavaScript slide show, simply type
5555 pandoc -t FORMAT -s habits.txt -o habits.html
5557where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5559For Slidy, Slideous, reveal.js, and S5, the file produced by
5560pandoc with the `-s/--standalone` option embeds a link to
5561JavaScript and CSS files, which are assumed to be available at
5562the relative path `s5/default` (for S5), `slideous` (for
5563Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5564at `w3.org` (for Slidy). (These paths can be changed by setting
5565the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5566variables; see [Variables for HTML slides], above.) For
5567DZSlides, the (relatively short) JavaScript and CSS are included
5568in the file by default.
5570With all HTML slide formats, the `--self-contained` option can
5571be used to produce a single file that contains all of the data
5572necessary to display the slide show, including linked scripts,
5573stylesheets, images, and videos.
5575To produce a PDF slide show using beamer, type
5577 pandoc -t beamer habits.txt -o habits.pdf
5579Note that a reveal.js slide show can also be converted to a PDF
5580by printing it to a file from the browser.
5582To produce a Powerpoint slide show, type
5584 pandoc habits.txt -o habits.pptx
5586## Structuring the slide show
5588By default, the *slide level* is the highest heading level in
5589the hierarchy that is followed immediately by content, and not another
5590heading, somewhere in the document. In the example above, level-1 headings
5591are always followed by level-2 headings, which are followed by content,
5592so the slide level is 2. This default can be overridden using
5593the `--slide-level` option.
5595The document is carved up into slides according to the following
5598 * A horizontal rule always starts a new slide.
5600 * A heading at the slide level always starts a new slide.
5602 * Headings *below* the slide level in the hierarchy create
5603 headings *within* a slide.
5605 * Headings *above* the slide level in the hierarchy create
5606 "title slides," which just contain the section title
5607 and help to break the slide show into sections.
5608 Non-slide content under these headings will be included
5609 on the title slide (for HTML slide shows) or in a
5610 subsequent slide with the same title (for beamer).
5612 * A title page is constructed automatically from the document's title
5613 block, if present. (In the case of beamer, this can be disabled
5614 by commenting out some lines in the default template.)
5616These rules are designed to support many different styles of slide show. If
5617you don't care about structuring your slides into sections and subsections,
5618you can just use level-1 headings for all each slide. (In that case, level-1
5619will be the slide level.) But you can also structure the slide show into
5620sections, as in the example above.
5622Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5623layout will be produced, with level-1 headings building horizontally
5624and level-2 headings building vertically. It is not recommended that
5625you use deeper nesting of section levels with reveal.js.
5629By default, these writers produce lists that display "all at once."
5630If you want your lists to display incrementally (one item at a time),
5631use the `-i` option. If you want a particular list to depart from the
5632default, put it in a `div` block with class `incremental` or
5633`nonincremental`. So, for example, using the `fenced div` syntax, the
5634following would be incremental regardless of the document default:
5652While using `incremental` and `nonincremental` divs are the
5653recommended method of setting incremental lists on a per-case basis,
5654an older method is also supported: putting lists inside a blockquote
5655will depart from the document default (that is, it will display
5656incrementally without the `-i` option and all at once with the `-i`
5662Both methods allow incremental and nonincremental lists to be mixed
5663in a single document.
5665Note: Neither the `-i/--incremental` option nor any of the
5666methods described here currently works for PowerPoint output.
5670You can add "pauses" within a slide by including a paragraph containing
5671three dots, separated by spaces:
5673 # Slide with a pause
5675 content before the pause
5679 content after the pause
5681Note: this feature is not yet implemented for PowerPoint output.
5683## Styling the slides
5685You can change the style of HTML slides by putting customized CSS files
5686in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5687or `$DATADIR/slideous` (for Slideous),
5688where `$DATADIR` is the user data directory (see `--data-dir`, above).
5689The originals may be found in pandoc's system data directory (generally
5690`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5691files it does not find in the user data directory.
5693For dzslides, the CSS is included in the HTML file itself, and may
5696All [reveal.js configuration options] can be set through variables.
5697For example, themes can be used by setting the `theme` variable:
5701Or you can specify a custom stylesheet using the `--css` option.
5703To style beamer slides, you can specify a `theme`, `colortheme`,
5704`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5706 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5708Note that heading attributes will turn into slide attributes
5709(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5710to style individual slides. In beamer, the only heading attribute
5711that affects slides is the `allowframebreaks` class, which sets the
5712`allowframebreaks` option, causing multiple slides to be created
5713if the content overfills the frame. This is recommended especially for
5716 # References {.allowframebreaks}
5720Speaker notes are supported in reveal.js and PowerPoint (pptx)
5721output. You can add notes to your Markdown document thus:
5727 - It can contain Markdown
5732To show the notes window in reveal.js, press `s` while viewing the
5733presentation. Speaker notes in PowerPoint will be available, as usual,
5734in handouts and presenter view.
5736Notes are not yet supported for other slide formats, but the notes
5737will not appear on the slides themselves.
5741To put material in side by side columns, you can use a native
5742div container with class `columns`, containing two or more div
5743containers with class `column` and a `width` attribute:
5745 :::::::::::::: {.columns}
5746 ::: {.column width="40%"}
5749 ::: {.column width="60%"}
5754### Additional columns attributes in beamer
5756The div containers with classes `columns` and `column` can optionally have
5757an `align` attribute.
5758The class `columns` can optionally have a `totalwidth` attribute or an
5759`onlytextwidth` class.
5761 :::::::::::::: {.columns align=center totalwidth=8em}
5762 ::: {.column width="40%"}
5765 ::: {.column width="60%" align=bottom}
5770The `align` attributes on `columns` and `column` can be used with the
5771values `top`, `top-baseline`, `center` and `bottom` to vertically align
5772the columns. It defaults to `top` in `columns`.
5774The `totalwidth` attribute limits the width of the columns to the given value.
5776 :::::::::::::: {.columns align=top .onlytextwidth}
5777 ::: {.column width="40%" align=center}
5780 ::: {.column width="60%"}
5785The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5787See Section 12.7 of the [Beamer User's Guide] for more details.
5789## Frame attributes in beamer
5791Sometimes it is necessary to add the LaTeX `[fragile]` option to
5792a frame in beamer (for example, when using the `minted` environment).
5793This can be forced by adding the `fragile` class to the heading
5794introducing the slide:
5796 # Fragile slide {.fragile}
5798All of the other frame attributes described in Section 8.1 of
5799the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5800`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5801`shrink`, `standout`, `noframenumbering`.
5803## Background in reveal.js and beamer
5805Background images can be added to self-contained reveal.js slideshows and
5806to beamer slideshows.
5808For the same image on every slide, use the configuration
5809option `background-image` either in the YAML metadata block
5810or as a command-line variable. (There are no other options in
5811beamer and the rest of this section concerns reveal.js slideshows.)
5813For reveal.js, you can instead use the reveal.js-native option
5814`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5815and `parallaxBackgroundVertical` the same way and must also set
5816`parallaxBackgroundSize` to have your values take effect.
5818To set an image for a particular reveal.js slide, add
5819`{data-background-image="/path/to/image"}`
5820to the first slide-level heading on the slide (which may even be empty).
5822In reveal.js's overview mode, the parallaxBackgroundImage will show up
5823only on the first slide.
5825Other reveal.js background settings also work on individual slides, including
5826`data-background-size`, `data-background-repeat`, `data-background-color`,
5827`data-transition`, and `data-transition-speed`.
5829To add a background image to the automatically generated title slide, use the
5830`title-slide-attributes` variable in the YAML metadata block. It must contain
5831a map of attribute names and values.
5833See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5836For example in reveal.js:
5841parallaxBackgroundImage: /path/to/my/background_image.png
5842title-slide-attributes:
5843 data-background-image: /path/to/title_image.png
5844 data-background-size: contain
5849Slide 1 has background_image.png as its background.
5851## {data-background-image="/path/to/special_image.jpg"}
5853Slide 2 has a special image for its background, even though the heading has no content.
5860EPUB metadata may be specified using the `--epub-metadata` option, but
5861if the source document is Markdown, it is better to use a [YAML metadata
5862block][Extension: `yaml_metadata_block`]. Here is an example:
5869 text: An investigation of metadata
5877 text: doi:10.234234.234/33
5879 rights: © 2007 John Smith, CC BY-NC
5884The following fields are recognized:
5887 ~ Either a string value or an object with fields `text` and
5888 `scheme`. Valid values for `scheme` are `ISBN-10`,
5889 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5890 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5891 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5894 ~ Either a string value, or an object with fields `file-as` and
5895 `type`, or a list of such objects. Valid values for `type` are
5896 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5899 ~ Either a string value, or an object with fields `role`, `file-as`,
5900 and `text`, or a list of such objects. Valid values for `role` are
5901 [MARC relators], but
5902 pandoc will attempt to translate the human-readable versions
5903 (like "author" and "editor") to the appropriate marc relators.
5906 ~ Same format as `creator`.
5909 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5910 Pandoc will attempt to convert other common date formats.
5912`lang` (or legacy: `language`)
5913 ~ A string value in [BCP 47] format. Pandoc will default to the local
5914 language if nothing is specified.
5917 ~ A string value or a list of such values.
5937`belongs-to-collection`
5938 ~ A string value. identifies the name of a collection to which
5939 the EPUB Publication belongs.
5942 ~ The `group-position` field indicates the numeric position in which
5943 the EPUB Publication belongs relative to other works belonging to
5944 the same `belongs-to-collection` field.
5947 ~ A string value (path to cover image).
5949`css` (or legacy: `stylesheet`)
5950 ~ A string value (path to CSS stylesheet).
5952`page-progression-direction`
5953 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5954 attribute for the [`spine` element].
5957 ~ iBooks-specific metadata, with the following fields:
5959 - `version`: (string)
5960 - `specified-fonts`: `true`|`false` (default `false`)
5961 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5962 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5963 - `binding`: `true`|`false` (default `true`)
5964 - `scroll-axis`: `vertical`|`horizontal`|`default`
5966[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5967[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5969## The `epub:type` attribute
5971For `epub3` output, you can mark up the heading that corresponds to an EPUB
5972chapter using the [`epub:type` attribute][epub-type]. For example, to set
5973the attribute to the value `prologue`, use this markdown:
5975 # My chapter {epub:type=prologue}
5977Which will result in:
5979 <body epub:type="frontmatter">
5980 <section epub:type="prologue">
5983Pandoc will output `<body epub:type="bodymatter">`, unless
5984you use one of the following values, in which case either
5985`frontmatter` or `backmatter` will be output.
5987`epub:type` of first section `epub:type` of body
5988---------------------------- ------------------
5991acknowledgments frontmatter
5992copyright-page frontmatter
5993dedication frontmatter
5997contributors frontmatter
5998other-credits frontmatter
6000revision-history frontmatter
6001titlepage frontmatter
6002halftitlepage frontmatter
6003seriespage frontmatter
6008bibliography backmatter
6011[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6015By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6016`<video>` or `<source>` element present in the generated EPUB,
6017and include it in the EPUB container, yielding a completely
6018self-contained EPUB. If you want to link to external media resources
6019instead, use raw HTML in your source and add `data-external="1"` to the tag
6020with the `src` attribute. For example:
6022 <audio controls="1">
6023 <source src="https://example.com/music/toccata.mp3"
6024 data-external="1" type="audio/mpeg">
6030When creating a [Jupyter notebook], pandoc will try to infer the
6031notebook structure. Code blocks with the class `code` will be
6032taken as code cells, and intervening content will be taken as
6033Markdown cells. Attachments will automatically be created for
6034images in Markdown cells. Metadata will be taken from the
6035`jupyter` metadata field. For example:
6044 display_name: Python 2
6051 file_extension: ".py"
6052 mimetype: "text/x-python"
6054 nbconvert_exporter: "python"
6055 pygments_lexer: "ipython2"
6061**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6062bibendum felis dictum sodales.
6071from IPython.display import HTML
6074console.log("hello");
6082This image  will be
6083included as a cell attachment.
6086If you want to add cell attributes, group cells differently, or
6087add output to code cells, then you need to include divs to
6088indicate the structure. You can use either [fenced
6089divs][Extension: `fenced_divs`] or [native divs][Extension:
6090`native_divs`] for this. Here is an example:
6093:::::: {.cell .markdown}
6096**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6097bibendum felis dictum sodales.
6100:::::: {.cell .code execution_count=1}
6105::: {.output .stream .stdout}
6112:::::: {.cell .code execution_count=2}
6114from IPython.display import HTML
6117console.log("hello");
6123::: {.output .execute_result execution_count=2}
6126console.log("hello");
6135If you include raw HTML or TeX in an output cell, use the
6136[raw attribute][Extension: `fenced_attribute`], as shown
6137in the last cell of the example above. Although pandoc can
6138process "bare" raw HTML and TeX, the result is often
6139interspersed raw elements and normal textual elements, and
6140in an output cell pandoc expects a single, connected raw
6141block. To avoid using raw HTML or TeX except when
6142marked explicitly using raw attributes, we recommend
6143specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6144translating between Markdown and ipynb notebooks.
6146Note that options and extensions that affect reading and
6147writing of Markdown will also affect Markdown cells in ipynb
6148notebooks. For example, `--wrap=preserve` will preserve
6149soft line breaks in Markdown cells; `--atx-headers` will
6150cause ATX-style headings to be used; and `--preserve-tabs` will
6151prevent tabs from being turned to spaces.
6153# Syntax highlighting
6155Pandoc will automatically highlight syntax in [fenced code blocks] that
6156are marked with a language name. The Haskell library [skylighting] is
6157used for highlighting. Currently highlighting is supported only for
6158HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6159that pandoc will recognize, type `pandoc --list-highlight-languages`.
6161The color scheme can be selected using the `--highlight-style` option.
6162The default color scheme is `pygments`, which imitates the default color
6163scheme used by the Python library pygments (though pygments is not actually
6164used to do the highlighting). To see a list of highlight styles,
6165type `pandoc --list-highlight-styles`.
6167If you are not satisfied with the predefined styles, you can
6168use `--print-highlight-style` to generate a JSON `.theme` file which
6169can be modified and used as the argument to `--highlight-style`. To
6170get a JSON version of the `pygments` style, for example:
6172 pandoc --print-highlight-style pygments > my.theme
6174Then edit `my.theme` and use it like this:
6176 pandoc --highlight-style my.theme
6178If you are not satisfied with the built-in highlighting, or you
6179want highlight a language that isn't supported, you can use the
6180`--syntax-definition` option to load a [KDE-style XML syntax definition
6181file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6182Before writing your own, have a look at KDE's [repository of syntax
6183definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6185To disable highlighting, use the `--no-highlight` option.
6187[skylighting]: https://github.com/jgm/skylighting
6191Custom styles can be used in the docx and ICML formats.
6195By default, pandoc's docx and ICML output applies a predefined set of styles
6196for blocks such as paragraphs and block quotes, and uses largely default
6197formatting (italics, bold) for inlines. This will work for most
6198purposes, especially alongside a `reference.docx` file. However, if you
6199need to apply your own styles to blocks, or match a preexisting set of
6200styles, pandoc allows you to define custom styles for blocks and text
6201using `div`s and `span`s, respectively.
6203If you define a `div` or `span` with the attribute `custom-style`,
6204pandoc will apply your specified style to the contained elements (with
6205the exception of elements whose function depends on a style, like
6206headings, code blocks, block quotes, or links). So, for example, using
6207the `bracketed_spans` syntax,
6209 [Get out]{custom-style="Emphatically"}, he said.
6211would produce a docx file with "Get out" styled with character
6212style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6214 Dickinson starts the poem simply:
6216 ::: {custom-style="Poetry"}
6217 | A Bird came down the Walk---
6218 | He did not know I saw---
6221would style the two contained lines with the `Poetry` paragraph style.
6223For docx output, styles will be defined in the output file as inheriting
6224from normal text, if the styles are not yet in your reference.docx.
6225If they are already defined, pandoc will not alter the definition.
6227This feature allows for greatest customization in conjunction with
6228[pandoc filters]. If you want all paragraphs after block quotes to be
6229indented, you can write a filter to apply the styles necessary. If you
6230want all italics to be transformed to the `Emphasis` character style
6231(perhaps to change their color), you can write a filter which will
6232transform all italicized inlines to inlines within an `Emphasis`
6235For docx output, you don't need to enable any extensions for
6236custom styles to work.
6238[pandoc filters]: https://pandoc.org/filters.html
6242The docx reader, by default, only reads those styles that it can
6243convert into pandoc elements, either by direct conversion or
6244interpreting the derivation of the input document's styles.
6246By enabling the [`styles` extension](#ext-styles) in the docx reader
6247(`-f docx+styles`), you can produce output that maintains the styles
6248of the input document, using the `custom-style` class. Paragraph
6249styles are interpreted as divs, while character styles are interpreted
6252For example, using the `custom-style-reference.docx` file in the test
6253directory, we have the following different outputs:
6255Without the `+styles` extension:
6257 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6260 This is text with an *emphasized* text style. And this is text with a
6261 **strengthened** text style.
6263 > Here is a styled paragraph that inherits from Block Text.
6265And with the extension:
6267 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6269 ::: {custom-style="First Paragraph"}
6273 ::: {custom-style="Body Text"}
6274 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6275 And this is text with a [strengthened]{custom-style="Strengthened"}
6279 ::: {custom-style="My Block Style"}
6280 > Here is a styled paragraph that inherits from Block Text.
6283With these custom styles, you can use your input document as a
6284reference-doc while creating docx output (see below), and maintain the
6285same styles in your input and output files.
6289Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6290includes a Lua interpreter, so Lua need not be installed separately.)
6292To use a custom writer, simply specify the path to the Lua script
6293in place of the output format. For example:
6295 pandoc -t data/sample.lua
6297Creating a custom writer requires writing a Lua function for each
6298possible element in a pandoc document. To get a documented example
6299which you can modify according to your needs, do
6301 pandoc --print-default-data-file sample.lua
6303Note that custom writers have no default template. If you want
6304to use `--standalone` with a custom writer, you will need to
6305specify a template manually using `--template` or add a new
6306default template with the name
6307`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6308subdirectory of your user data directory (see [Templates]).
6310[Lua]: https://www.lua.org
6314If you use pandoc to convert user-contributed content in a web
6315application, here are some things to keep in mind:
63171. Although pandoc itself will not create or modify any files other
6318 than those you explicitly ask it create (with the exception
6319 of temporary files used in producing PDFs), a filter or custom
6320 writer could in principle do anything on your file system. Please
6321 audit filters and custom writers very carefully before using them.
63232. If your application uses pandoc as a Haskell library (rather than
6324 shelling out to the executable), it is possible to use it in a mode
6325 that fully isolates pandoc from your file system, by running the
6326 pandoc operations in the `PandocPure` monad. See the document
6327 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
63303. Pandoc's parsers can exhibit pathological performance on some
6331 corner cases. It is wise to put any pandoc operations under
6332 a timeout, to avoid DOS attacks that exploit these issues.
6333 If you are using the pandoc executable, you can add the
6334 command line options `+RTS -M512M -RTS` (for example) to limit
6335 the heap size to 512MB.
63374. The HTML generated by pandoc is not guaranteed to be safe.
6338 If `raw_html` is enabled for the Markdown input, users can
6339 inject arbitrary HTML. Even if `raw_html` is disabled,
6340 users can include dangerous content in attributes for
6341 headings, spans, and code blocks. To be safe, you should
6342 run all the generated HTML through an HTML sanitizer.
6346Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
6347under the [GPL], version 2 or greater. This software carries no
6348warranty of any kind. (See COPYRIGHT for full copyright and
6349warranty notices.) For a full list of contributors, see the file
6350AUTHORS.md in the pandoc source code.
6352[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6353[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