2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: https://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`ifxetex`], [`ifluatex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `xelatex` uses
147[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
148`dir` variable set). If the `mathspec` variable is set,
149`xelatex` will use [`mathspec`] instead of [`unicode-math`].
150The [`upquote`] and [`microtype`] packages are used if
151available, and [`csquotes`] will be used for [typography]
152if the `csquotes` variable or metadata field is set to a
153true value. The [`natbib`], [`biblatex`], [`bibtex`], and
154[`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`ifluatex`]: https://ctan.org/pkg/ifluatex
184[`ifxetex`]: https://ctan.org/pkg/ifxetex
185[`listings`]: https://ctan.org/pkg/listings
186[`lm`]: https://ctan.org/pkg/lm
187[`longtable`]: https://ctan.org/pkg/longtable
188[`mathspec`]: https://ctan.org/pkg/mathspec
189[`microtype`]: https://ctan.org/pkg/microtype
190[`natbib`]: https://ctan.org/pkg/natbib
191[`parskip`]: https://ctan.org/pkg/parskip
192[`polyglossia`]: https://ctan.org/pkg/polyglossia
193[`prince`]: https://www.princexml.com/
194[`setspace`]: https://ctan.org/pkg/setspace
195[`ulem`]: https://ctan.org/pkg/ulem
196[`unicode-math`]: https://ctan.org/pkg/unicode-math
197[`upquote`]: https://ctan.org/pkg/upquote
198[`weasyprint`]: https://weasyprint.org
199[`wkhtmltopdf`]: https://wkhtmltopdf.org
200[`xcolor`]: https://ctan.org/pkg/xcolor
201[`xecjk`]: https://ctan.org/pkg/xecjk
202[`xurl`]: https://ctan.org/pkg/xurl
206## Reading from the Web
208Instead of an input file, an absolute URI may be given. In this case
209pandoc will fetch the content using HTTP:
211 pandoc -f html -t markdown https://www.fsf.org
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
221## General options {.options}
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
225: Specify input format. *FORMAT* can be:
228 - `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 - `commonmark` ([CommonMark] Markdown)
284 - `commonmark_x` ([CommonMark] Markdown with extensions)
285 - `context` ([ConTeXt])
286 - `csljson` ([CSL JSON] bibliography)
287 - `docbook` or `docbook4` ([DocBook] 4)
288 - `docbook5` (DocBook 5)
289 - `docx` ([Word docx])
290 - `dokuwiki` ([DokuWiki markup])
291 - `epub` or `epub3` ([EPUB] v3 book)
293 - `fb2` ([FictionBook2] e-book)
294 - `gfm` ([GitHub-Flavored Markdown]),
295 or the deprecated and less accurate `markdown_github`;
296 use [`markdown_github`](#markdown-variants) only
297 if you need extensions not supported in [`gfm`](#markdown-variants).
298 - `haddock` ([Haddock markup])
299 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
300 - `html4` ([XHTML] 1.0 Transitional)
301 - `icml` ([InDesign ICML])
302 - `ipynb` ([Jupyter notebook])
303 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
304 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
305 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
306 - `jats` (alias for `jats_archiving`)
307 - `jira` ([Jira]/Confluence wiki markup)
308 - `json` (JSON version of native AST)
311 - `markdown` ([Pandoc's Markdown])
312 - `markdown_mmd` ([MultiMarkdown])
313 - `markdown_phpextra` ([PHP Markdown Extra])
314 - `markdown_strict` (original unextended [Markdown])
315 - `mediawiki` ([MediaWiki markup])
318 - `native` (native Haskell),
319 - `odt` ([OpenOffice text document][ODT])
321 - `opendocument` ([OpenDocument])
322 - `org` ([Emacs Org mode])
324 - `plain` (plain text),
325 - `pptx` ([PowerPoint] slide show)
326 - `rst` ([reStructuredText])
327 - `rtf` ([Rich Text Format])
328 - `texinfo` ([GNU Texinfo])
329 - `textile` ([Textile])
330 - `slideous` ([Slideous] HTML and JavaScript slide show)
331 - `slidy` ([Slidy] HTML and JavaScript slide show)
332 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
333 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
334 - `s5` ([S5] HTML and JavaScript slide show)
335 - `tei` ([TEI Simple])
336 - `xwiki` ([XWiki markup])
337 - `zimwiki` ([ZimWiki markup])
338 - the path of a custom Lua writer, see [Custom writers] below
341 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
342 to *stdout* unless forced with `-o -`.
344 Extensions can be individually enabled or
345 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
346 name. See [Extensions] below, for a list of extensions and their
347 names. See `--list-output-formats` and `--list-extensions`, below.
349`-o` *FILE*, `--output=`*FILE*
351: Write output to *FILE* instead of *stdout*. If *FILE* is
352 `-`, output will go to *stdout*, even if a non-textual format
353 (`docx`, `odt`, `epub2`, `epub3`) is specified.
355`--data-dir=`*DIRECTORY*
357: Specify the user data directory to search for pandoc data files.
358 If this option is not specified, the default user data directory
359 will be used. On \*nix and macOS systems this will be the `pandoc`
360 subdirectory of the XDG data directory (by default,
361 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
362 environment variable). If that directory does not exist,
363 `$HOME/.pandoc` will be used (for backwards compatibility).
364 In Windows the default user data directory is
365 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
366 You can find the default user data directory on your system by
367 looking at the output of `pandoc --version`.
368 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
369 `slidy`, `slideous`, or `s5` directory
370 placed in this directory will override pandoc's normal defaults.
372`-d` *FILE*, `--defaults=`*FILE*
374: Specify a set of default option settings. *FILE* is a YAML
375 file whose fields correspond to command-line option
376 settings. All options for document conversion, including input
377 and output files, can be set using a defaults file. The file will
378 be searched for first in the working directory, and then in
379 the `defaults` subdirectory of the user data directory
380 (see `--data-dir`). The `.yaml` extension may be omitted.
381 See the section [Default files] for more information on the
382 file format. Settings from the defaults file may be
383 overridden or extended by subsequent options on the command
388: Generate a bash completion script. To enable bash completion
389 with pandoc, add this to your `.bashrc`:
391 eval "$(pandoc --bash-completion)"
395: Give verbose debugging output.
399: Suppress warning messages.
403: Exit with error status if there are any warnings.
407: Write log messages in machine-readable JSON format to
408 *FILE*. All messages above DEBUG level will be written,
409 regardless of verbosity settings (`--verbose`, `--quiet`).
411`--list-input-formats`
413: List supported input formats, one per line.
415`--list-output-formats`
417: List supported output formats, one per line.
419`--list-extensions`[`=`*FORMAT*]
421: List supported extensions for *FORMAT*, one per line, preceded
422 by a `+` or `-` indicating whether it is enabled by default
423 in *FORMAT*. If *FORMAT* is not specified, defaults for
424 pandoc's Markdown are given.
426`--list-highlight-languages`
428: List supported languages for syntax highlighting, one per
431`--list-highlight-styles`
433: List supported styles for syntax highlighting, one per line.
434 See `--highlight-style`.
444[Markdown]: https://daringfireball.net/projects/markdown/
445[CommonMark]: https://commonmark.org
446[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
447[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
448[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
449[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
450[S5]: https://meyerweb.com/eric/tools/s5/
451[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
452[Slideous]: https://goessner.net/articles/slideous/
453[HTML]: https://www.w3.org/html/
454[HTML5]: https://html.spec.whatwg.org/
455[polyglot markup]: https://www.w3.org/TR/html-polyglot/
456[XHTML]: https://www.w3.org/TR/xhtml1/
457[LaTeX]: https://www.latex-project.org/
458[`beamer`]: https://ctan.org/pkg/beamer
459[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
460[ConTeXt]: https://www.contextgarden.net/
461[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
462[DocBook]: https://docbook.org
463[JATS]: https://jats.nlm.nih.gov
464[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
465[txt2tags]: https://txt2tags.org
466[EPUB]: http://idpf.org/epub
467[OPML]: http://dev.opml.org/spec2.html
468[OpenDocument]: http://opendocument.xml.org
469[ODT]: https://en.wikipedia.org/wiki/OpenDocument
470[Textile]: https://www.promptworks.com/textile
471[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
472[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
473[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
474[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
475[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
476[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
477[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
478[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
479[CSV]: https://tools.ietf.org/html/rfc4180
480[roff man]: https://man.cx/groff_man(7)
481[roff ms]: https://man.cx/groff_ms(7)
482[Haskell]: https://www.haskell.org
483[GNU Texinfo]: https://www.gnu.org/software/texinfo/
484[Emacs Org mode]: https://orgmode.org
485[AsciiDoc]: https://www.methods.co.nz/asciidoc/
486[AsciiDoctor]: https://asciidoctor.org/
487[DZSlides]: http://paulrouget.com/dzslides/
488[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
489[PDF]: https://www.adobe.com/pdf/
490[reveal.js]: https://revealjs.com/
491[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
492[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
493[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
494[TEI Simple]: https://github.com/TEIC/TEI-Simple
495[Muse]: https://amusewiki.org/library/manual
496[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
497[Vimwiki]: https://vimwiki.github.io
498[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
499[BibTeX]: https://ctan.org/pkg/bibtex
500[BibLaTeX]: https://ctan.org/pkg/biblatex
502## Reader options {.options}
504`--shift-heading-level-by=`*NUMBER*
506: Shift heading levels by a positive or negative integer.
507 For example, with `--shift-heading-level-by=-1`, level 2
508 headings become level 1 headings, and level 3 headings
509 become level 2 headings. Headings cannot have a level
510 less than 1, so a heading that would be shifted below level 1
511 becomes a regular paragraph. Exception: with a shift of -N,
512 a level-N heading at the beginning of the document
513 replaces the metadata title. `--shift-heading-level-by=-1`
514 is a good choice when converting HTML or Markdown documents that
515 use an initial level-1 heading for the document title and
516 level-2+ headings for sections. `--shift-heading-level-by=1`
517 may be a good choice for converting Markdown documents that
518 use level-1 headings for sections to HTML, since pandoc uses
519 a level-1 heading to render the document title.
521`--base-header-level=`*NUMBER*
523: *Deprecated. Use `--shift-heading-level-by`=X instead,
524 where X = NUMBER - 1.* Specify the base level for headings
527`--strip-empty-paragraphs`
529: *Deprecated. Use the `+empty_paragraphs` extension instead.*
530 Ignore paragraphs with no content. This option is useful
531 for converting word processing documents where users have
532 used empty paragraphs to create inter-paragraph space.
534`--indented-code-classes=`*CLASSES*
536: Specify classes to use for indented code blocks--for example,
537 `perl,numberLines` or `haskell`. Multiple classes may be separated
540`--default-image-extension=`*EXTENSION*
542: Specify a default extension to use when image paths/URLs have no
543 extension. This allows you to use the same source for formats that
544 require different kinds of images. Currently this option only affects
545 the Markdown and LaTeX readers.
549: Parse each file individually before combining for multifile
550 documents. This will allow footnotes in different files with the
551 same identifiers to work as expected. If this option is set,
552 footnotes and links will not work across files. Reading binary
553 files (docx, odt, epub) implies `--file-scope`.
555`-F` *PROGRAM*, `--filter=`*PROGRAM*
557: Specify an executable to be used as a filter transforming the
558 pandoc AST after the input is parsed and before the output is
559 written. The executable should read JSON from stdin and write
560 JSON to stdout. The JSON must be formatted like pandoc's own
561 JSON input and output. The name of the output format will be
562 passed to the filter as the first argument. Hence,
564 pandoc --filter ./caps.py -t latex
568 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
570 The latter form may be useful for debugging filters.
572 Filters may be written in any language. `Text.Pandoc.JSON`
573 exports `toJSONFilter` to facilitate writing filters in Haskell.
574 Those who would prefer to write filters in python can use the
575 module [`pandocfilters`], installable from PyPI. There are also
576 pandoc filter libraries in [PHP], [perl], and
577 [JavaScript/node.js].
579 In order of preference, pandoc will look for filters in
581 1. a specified full or relative path (executable or
584 2. `$DATADIR/filters` (executable or non-executable)
585 where `$DATADIR` is the user data directory (see
586 `--data-dir`, above).
588 3. `$PATH` (executable only)
590 Filters and Lua-filters are applied in the order specified
593`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
595: Transform the document in a similar fashion as JSON filters (see
596 `--filter`), but use pandoc's build-in Lua filtering system. The given
597 Lua script is expected to return a list of Lua filters which will be
598 applied in order. Each Lua filter must contain element-transforming
599 functions indexed by the name of the AST element on which the filter
600 function should be applied.
602 The `pandoc` Lua module provides helper functions for element
603 creation. It is always loaded into the script's Lua environment.
605 The following is an example Lua script for macro-expansion:
607 function expand_hello_world(inline)
608 if inline.c == '{{helloworld}}' then
609 return pandoc.Emph{ pandoc.Str "Hello, World" }
615 return {{Str = expand_hello_world}}
617 In order of preference, pandoc will look for Lua filters in
619 1. a specified full or relative path (executable or
622 2. `$DATADIR/filters` (executable or non-executable)
623 where `$DATADIR` is the user data directory (see
624 `--data-dir`, above).
626`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
628: Set the metadata field *KEY* to the value *VAL*. A value specified
629 on the command line overrides a value specified in the document
630 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
631 Values will be parsed as YAML boolean or string values. If no value is
632 specified, the value will be treated as Boolean true. Like
633 `--variable`, `--metadata` causes template variables to be set.
634 But unlike `--variable`, `--metadata` affects the metadata of the
635 underlying document (which is accessible from filters and may be
636 printed in some output formats) and metadata values will be escaped
637 when inserted into the template.
639`--metadata-file=`*FILE*
641: Read metadata from the supplied YAML (or JSON) file. This
642 option can be used with every input format, but string scalars
643 in the YAML file will always be parsed as Markdown. Generally,
644 the input will be handled the same as in [YAML metadata
645 blocks][Extension: `yaml_metadata_block`]. This option can be
646 used repeatedly to include multiple metadata files; values in
647 files specified later on the command line will be preferred
648 over those specified in earlier files. Metadata values
649 specified inside the document, or by using `-M`, overwrite
650 values specified with this option.
652`-p`, `--preserve-tabs`
654: Preserve tabs instead of converting them to spaces. (By default, pandoc
655 converts tabs to spaces before parsing its input.) Note that this will
656 only affect tabs in literal code spans and code blocks. Tabs in regular
657 text are always treated as spaces.
661: Specify the number of spaces per tab (default is 4).
663`--track-changes=accept`|`reject`|`all`
665: Specifies what to do with insertions, deletions, and comments
666 produced by the MS Word "Track Changes" feature. `accept` (the
667 default), inserts all insertions, and ignores all
668 deletions. `reject` inserts all deletions and ignores
669 insertions. Both `accept` and `reject` ignore comments. `all` puts
670 in insertions, deletions, and comments, wrapped in spans with
671 `insertion`, `deletion`, `comment-start`, and `comment-end`
672 classes, respectively. The author and time of change is
673 included. `all` is useful for scripting: only accepting changes
674 from a certain reviewer, say, or before a certain date. If a
675 paragraph is inserted or deleted, `track-changes=all` produces a
676 span with the class `paragraph-insertion`/`paragraph-deletion`
677 before the affected paragraph break. This option only affects the
680`--extract-media=`*DIR*
682: Extract images and other media contained in or linked from
683 the source document to the path *DIR*, creating it if
684 necessary, and adjust the images references in the document
685 so they point to the extracted files. If the source format is
686 a binary container (docx, epub, or odt), the media is
687 extracted from the container and the original
688 filenames are used. Otherwise the media is read from the
689 file system or downloaded, and new filenames are constructed
690 based on SHA1 hashes of the contents.
692`--abbreviations=`*FILE*
694: Specifies a custom abbreviations file, with abbreviations
695 one to a line. If this option is not specified, pandoc will
696 read the data file `abbreviations` from the user data
697 directory or fall back on a system default. To see the
699 `pandoc --print-default-data-file=abbreviations`. The only
700 use pandoc makes of this list is in the Markdown reader.
701 Strings ending in a period that are found in this list will
702 be followed by a nonbreaking space, so that the period will
703 not produce sentence-ending space in formats like LaTeX.
705[`pandocfilters`]: https://github.com/jgm/pandocfilters
706[PHP]: https://github.com/vinai/pandocfilters-php
707[perl]: https://metacpan.org/pod/Pandoc::Filter
708[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
710## General writer options {.options}
714: Produce output with an appropriate header and footer (e.g. a
715 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
716 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
717 output. For `native` output, this option causes metadata to
718 be included; otherwise, metadata is suppressed.
720`--template=`*FILE*|*URL*
722: Use the specified file as a custom template for the generated document.
723 Implies `--standalone`. See [Templates], below, for a description
724 of template syntax. If no extension is specified, an extension
725 corresponding to the writer will be added, so that `--template=special`
726 looks for `special.html` for HTML output. If the template is not
727 found, pandoc will search for it in the `templates` subdirectory of
728 the user data directory (see `--data-dir`). If this option is not used,
729 a default template appropriate for the output format will be used (see
730 `-D/--print-default-template`).
732`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
734: Set the template variable *KEY* to the value *VAL* when rendering the
735 document in standalone mode. If no *VAL* is specified, the
736 key will be given the value `true`.
738`-D` *FORMAT*, `--print-default-template=`*FORMAT*
740: Print the system default template for an output *FORMAT*. (See `-t`
741 for a list of possible *FORMAT*s.) Templates in the user data
742 directory are ignored. This option may be used with
743 `-o`/`--output` to redirect output to a file, but
744 `-o`/`--output` must come before `--print-default-template`
747 Note that some of the default templates use partials, for
748 example `styles.html`. To print the partials, use
749 `--print-default-data-file`: for example,
750 `--print-default-data-file=templates/styles.html`.
752`--print-default-data-file=`*FILE*
754: Print a system default data file. Files in the user data directory
755 are ignored. This option may be used with `-o`/`--output` to
756 redirect output to a file, but `-o`/`--output` must come before
757 `--print-default-data-file` on the command line.
759`--eol=crlf`|`lf`|`native`
761: Manually specify line endings: `crlf` (Windows), `lf`
762 (macOS/Linux/UNIX), or `native` (line endings appropriate
763 to the OS on which pandoc is being run). The default is
768: Specify the default dpi (dots per inch) value for conversion
769 from pixels to inch/centimeters and vice versa. (Technically,
770 the correct term would be ppi: pixels per inch.) The default
771 is 96dpi. When images contain information about dpi
772 internally, the encoded value is used instead of the default
773 specified by this option.
775`--wrap=auto`|`none`|`preserve`
777: Determine how text is wrapped in the output (the source
778 code, not the rendered version). With `auto` (the default),
779 pandoc will attempt to wrap lines to the column width specified by
780 `--columns` (default 72). With `none`, pandoc will not wrap
781 lines at all. With `preserve`, pandoc will attempt to
782 preserve the wrapping from the source document (that is,
783 where there are nonsemantic newlines in the source, there
784 will be nonsemantic newlines in the output as well).
785 Automatic wrapping does not currently work in HTML output.
786 In `ipynb` output, this option affects wrapping of the
787 contents of markdown cells.
791: Specify length of lines in characters. This affects text wrapping
792 in the generated source code (see `--wrap`). It also affects
793 calculation of column widths for plain text tables (see [Tables] below).
795`--toc`, `--table-of-contents`
797: Include an automatically generated table of contents (or, in
798 the case of `latex`, `context`, `docx`, `odt`,
799 `opendocument`, `rst`, or `ms`, an instruction to create
800 one) in the output document. This option has no effect
801 unless `-s/--standalone` is used, and it has no effect
802 on `man`, `docbook4`, `docbook5`, or `jats` output.
804 Note that if you are producing a PDF via `ms`, the table
805 of contents will appear at the beginning of the
806 document, before the title. If you would prefer it to
807 be at the end of the document, use the option
808 `--pdf-engine-opt=--no-toc-relocation`.
810`--toc-depth=`*NUMBER*
812: Specify the number of section levels to include in the table
813 of contents. The default is 3 (which means that level-1, 2, and 3
814 headings will be listed in the contents).
818: Strip out HTML comments in the Markdown or Textile source,
819 rather than passing them on to Markdown, Textile or HTML
820 output as raw HTML. This does not apply to HTML comments
821 inside raw HTML blocks when the `markdown_in_html_blocks`
822 extension is not set.
826: Disables syntax highlighting for code blocks and inlines, even when
827 a language attribute is given.
829`--highlight-style=`*STYLE*|*FILE*
831: Specifies the coloring style to be used in highlighted source code.
832 Options are `pygments` (the default), `kate`, `monochrome`,
833 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
834 For more information on syntax highlighting in pandoc, see
835 [Syntax highlighting], below. See also
836 `--list-highlight-styles`.
838 Instead of a *STYLE* name, a JSON file with extension
839 `.theme` may be supplied. This will be parsed as a KDE
840 syntax highlighting theme and (if valid) used as the
843 To generate the JSON version of an existing style,
844 use `--print-highlight-style`.
846`--print-highlight-style=`*STYLE*|*FILE*
848: Prints a JSON version of a highlighting style, which can
849 be modified, saved with a `.theme` extension, and used
850 with `--highlight-style`. This option may be used with
851 `-o`/`--output` to redirect output to a file, but
852 `-o`/`--output` must come before `--print-highlight-style`
855`--syntax-definition=`*FILE*
857: Instructs pandoc to load a KDE XML syntax definition file,
858 which will be used for syntax highlighting of appropriately
859 marked code blocks. This can be used to add support for
860 new languages or to use altered syntax definitions for
861 existing languages. This option may be repeated to add
862 multiple syntax definitions.
864`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
866: Include contents of *FILE*, verbatim, at the end of the header.
867 This can be used, for example, to include special
868 CSS or JavaScript in HTML documents. This option can be used
869 repeatedly to include multiple files in the header. They will be
870 included in the order specified. Implies `--standalone`.
872`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
874: Include contents of *FILE*, verbatim, at the beginning of the
875 document body (e.g. after the `<body>` tag in HTML, or the
876 `\begin{document}` command in LaTeX). This can be used to include
877 navigation bars or banners in HTML documents. This option can be
878 used repeatedly to include multiple files. They will be included in
879 the order specified. Implies `--standalone`.
881`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
883: Include contents of *FILE*, verbatim, at the end of the document
884 body (before the `</body>` tag in HTML, or the
885 `\end{document}` command in LaTeX). This option can be used
886 repeatedly to include multiple files. They will be included in the
887 order specified. Implies `--standalone`.
889`--resource-path=`*SEARCHPATH*
891: List of paths to search for images and other resources.
892 The paths should be separated by `:` on Linux, UNIX, and
893 macOS systems, and by `;` on Windows. If `--resource-path`
894 is not specified, the default resource path is the working
895 directory. Note that, if `--resource-path` is specified,
896 the working directory must be explicitly listed or it
897 will not be searched. For example:
898 `--resource-path=.:test` will search the working directory
899 and the `test` subdirectory, in that order.
901 `--resource-path` only has an effect if (a) the output
902 format embeds images (for example, `docx`, `pdf`, or `html`
903 with `--self-contained`) or (b) it is used together with
906`--request-header=`*NAME*`:`*VAL*
908: Set the request header *NAME* to the value *VAL* when making
909 HTTP requests (for example, when a URL is given on the
910 command line, or when resources used in a document must be
911 downloaded). If you're behind a proxy, you also need to set
912 the environment variable `http_proxy` to `http://...`.
914`--no-check-certificate`
916: Disable the certificate verification to allow access to
917 unsecure HTTP resources (for example when the certificate
918 is no longer valid or self signed).
920## Options affecting specific writers {.options}
924: Produce a standalone HTML file with no external dependencies, using
925 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
926 images, and videos. Implies `--standalone`. The resulting file should be
927 "self-contained," in the sense that it needs no external files and no net
928 access to be displayed properly by a browser. This option works only with
929 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
930 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
931 and stylesheets at absolute URLs will be downloaded; those at relative
932 URLs will be sought relative to the working directory (if the first source
933 file is local) or relative to the base URL (if the first source
934 file is remote). Elements with the attribute
935 `data-external="1"` will be left alone; the documents they
936 link to will not be incorporated in the document.
937 Limitation: resources that are loaded dynamically through
938 JavaScript cannot be incorporated; as a result,
939 `--self-contained` does not work with `--mathjax`, and some
940 advanced features (e.g. zoom or speaker notes) may not work
941 in an offline "self-contained" `reveal.js` slide show.
945: Use `<q>` tags for quotes in HTML.
949: Use only ASCII characters in output. Currently supported for XML
950 and HTML formats (which use entities instead of UTF-8 when this
951 option is selected), CommonMark, gfm, and Markdown (which use
952 entities), roff ms (which use hexadecimal escapes), and to a
953 limited degree LaTeX (which uses standard commands for accented
954 characters when possible). roff man output uses ASCII by default.
958: Use reference-style links, rather than inline links, in writing Markdown
959 or reStructuredText. By default inline links are used. The
960 placement of link references is affected by the
961 `--reference-location` option.
963`--reference-location = block`|`section`|`document`
965: Specify whether footnotes (and references, if `reference-links` is
966 set) are placed at the end of the current (top-level) block, the
967 current section, or the document. The default is
968 `document`. Currently only affects the markdown writer.
972: Use ATX-style headings in Markdown output. The default is
973 to use setext-style headings for levels 1 to 2, and then ATX headings.
974 (Note: for `gfm` output, ATX headings are always used.)
975 This option also affects markdown cells in `ipynb` output.
977`--top-level-division=[default|section|chapter|part]`
979: Treat top-level headings as the given division type in LaTeX, ConTeXt,
980 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
981 all headings are shifted such that the top-level heading becomes the specified
982 type. The default behavior is to determine the best division type via
983 heuristics: unless other conditions apply, `section` is chosen. When the
984 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
985 `article` option is specified), `chapter` is implied as the setting for this
986 option. If `beamer` is the output format, specifying either `chapter` or
987 `part` will cause top-level headings to become `\part{..}`, while
988 second-level headings remain as their default type.
990`-N`, `--number-sections`
992: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
993 By default, sections are not numbered. Sections with class
994 `unnumbered` will never be numbered, even if `--number-sections`
997`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
999: Offset for section headings in HTML output (ignored in other
1000 output formats). The first number is added to the section number for
1001 top-level headings, the second for second-level headings, and so on.
1002 So, for example, if you want the first top-level heading in your
1003 document to be numbered "6", specify `--number-offset=5`.
1004 If your document starts with a level-2 heading which you want to
1005 be numbered "1.5", specify `--number-offset=1,4`.
1006 Offsets are 0 by default. Implies `--number-sections`.
1010: Use the [`listings`] package for LaTeX code blocks. The package
1011 does not support multi-byte encoding for source code. To handle UTF-8
1012 you would need to use a custom template. This issue is fully
1013 documented here: [Encoding issue with the listings package].
1015`-i`, `--incremental`
1017: Make list items in slide shows display incrementally (one by one).
1018 The default is for lists to be displayed all at once.
1020`--slide-level=`*NUMBER*
1022: Specifies that headings with the specified level create
1023 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1024 above this level in the hierarchy are used to divide the
1025 slide show into sections; headings below this level create
1026 subheads within a slide. Note that content that is
1027 not contained under slide-level headings will not appear in
1028 the slide show. The default is to set the slide level based
1029 on the contents of the document; see [Structuring the slide
1034: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1035 and attach identifiers to the enclosing `<section>` (or `<div>`)
1036 rather than the heading itself. See
1037 [Heading identifiers], below.
1039`--email-obfuscation=none`|`javascript`|`references`
1041: Specify a method for obfuscating `mailto:` links in HTML documents.
1042 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1043 them using JavaScript. `references` obfuscates them by printing their
1044 letters as decimal or hexadecimal character references. The default
1047`--id-prefix=`*STRING*
1049: Specify a prefix to be added to all identifiers and internal links
1050 in HTML and DocBook output, and to footnote numbers in Markdown
1051 and Haddock output. This is useful for preventing duplicate
1052 identifiers when generating fragments to be included in other pages.
1054`-T` *STRING*, `--title-prefix=`*STRING*
1056: Specify *STRING* as a prefix at the beginning of the title
1057 that appears in the HTML header (but not in the title as it
1058 appears at the beginning of the HTML body). Implies `--standalone`.
1060`-c` *URL*, `--css=`*URL*
1062: Link to a CSS style sheet. This option can be used repeatedly to
1063 include multiple files. They will be included in the order specified.
1065 A stylesheet is required for generating EPUB. If none is
1066 provided using this option (or the `css` or `stylesheet`
1067 metadata fields), pandoc will look for a file `epub.css` in the
1068 user data directory (see `--data-dir`). If it is not
1069 found there, sensible defaults will be used.
1071`--reference-doc=`*FILE*
1073: Use the specified file as a style reference in producing a
1078 : For best results, the reference docx should be a modified
1079 version of a docx file produced using pandoc. The contents
1080 of the reference docx are ignored, but its stylesheets and
1081 document properties (including margins, page size, header,
1082 and footer) are used in the new docx. If no reference docx
1083 is specified on the command line, pandoc will look for a
1084 file `reference.docx` in the user data directory (see
1085 `--data-dir`). If this is not found either, sensible
1086 defaults will be used.
1088 To produce a custom `reference.docx`, first get a copy of
1089 the default `reference.docx`: `pandoc
1090 -o custom-reference.docx --print-default-data-file reference.docx`.
1091 Then open `custom-reference.docx` in Word, modify the
1092 styles as you wish, and save the file. For best
1093 results, do not make changes to this file other than
1094 modifying the styles used by pandoc:
1130 - Default Paragraph Font
1133 - Footnote Reference
1143 : For best results, the reference ODT should be a modified
1144 version of an ODT produced using pandoc. The contents of
1145 the reference ODT are ignored, but its stylesheets are used
1146 in the new ODT. If no reference ODT is specified on the
1147 command line, pandoc will look for a file `reference.odt` in
1148 the user data directory (see `--data-dir`). If this is not
1149 found either, sensible defaults will be used.
1151 To produce a custom `reference.odt`, first get a copy of
1152 the default `reference.odt`: `pandoc
1153 -o custom-reference.odt --print-default-data-file reference.odt`.
1154 Then open `custom-reference.odt` in LibreOffice, modify
1155 the styles as you wish, and save the file.
1159 : Templates included with Microsoft PowerPoint 2013 (either with
1160 `.pptx` or `.potx` extension) are known to work, as are most
1161 templates derived from these.
1163 The specific requirement is that the template should begin with
1164 the following first four layouts:
1167 2. Title and Content
1171 All templates included with a recent version of MS PowerPoint
1172 will fit these criteria. (You can click on `Layout` under the
1173 `Home` menu to check.)
1175 You can also modify the default `reference.pptx`: first run
1176 `pandoc -o custom-reference.pptx --print-default-data-file
1177 reference.pptx`, and then modify `custom-reference.pptx`
1178 in MS PowerPoint (pandoc will use the first four layout
1179 slides, as mentioned above).
1181`--epub-cover-image=`*FILE*
1183: Use the specified image as the EPUB cover. It is recommended
1184 that the image be less than 1000px in width and height. Note that
1185 in a Markdown source document you can also specify `cover-image`
1186 in a YAML metadata block (see [EPUB Metadata], below).
1188`--epub-metadata=`*FILE*
1190: Look in the specified XML file for metadata for the EPUB.
1191 The file should contain a series of [Dublin Core elements].
1194 <dc:rights>Creative Commons</dc:rights>
1195 <dc:language>es-AR</dc:language>
1197 By default, pandoc will include the following metadata elements:
1198 `<dc:title>` (from the document title), `<dc:creator>` (from the
1199 document authors), `<dc:date>` (from the document date, which should
1200 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1201 variable, or, if is not set, the locale), and `<dc:identifier
1202 id="BookId">` (a randomly generated UUID). Any of these may be
1203 overridden by elements in the metadata file.
1205 Note: if the source document is Markdown, a YAML metadata block
1206 in the document can be used instead. See below under
1209`--epub-embed-font=`*FILE*
1211: Embed the specified font in the EPUB. This option can be repeated
1212 to embed multiple fonts. Wildcards can also be used: for example,
1213 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1214 line, be sure to escape them or put the whole filename in single quotes,
1215 to prevent them from being interpreted by the shell. To use the
1216 embedded fonts, you will need to add declarations like the following
1217 to your CSS (see `--css`):
1220 font-family: DejaVuSans;
1222 font-weight: normal;
1223 src:url("DejaVuSans-Regular.ttf");
1226 font-family: DejaVuSans;
1229 src:url("DejaVuSans-Bold.ttf");
1232 font-family: DejaVuSans;
1234 font-weight: normal;
1235 src:url("DejaVuSans-Oblique.ttf");
1238 font-family: DejaVuSans;
1241 src:url("DejaVuSans-BoldOblique.ttf");
1243 body { font-family: "DejaVuSans"; }
1245`--epub-chapter-level=`*NUMBER*
1247: Specify the heading level at which to split the EPUB into separate
1248 "chapter" files. The default is to split into chapters at level-1
1249 headings. This option only affects the internal composition of the
1250 EPUB, not the way chapters and sections are displayed to users. Some
1251 readers may be slow if the chapter files are too large, so for large
1252 documents with few level-1 headings, one might want to use a chapter
1255`--epub-subdirectory=`*DIRNAME*
1257: Specify the subdirectory in the OCF container that is to hold
1258 the EPUB-specific contents. The default is `EPUB`. To put
1259 the EPUB contents in the top level, use an empty string.
1261`--ipynb-output=all|none|best`
1263: Determines how ipynb output cells are treated. `all` means
1264 that all of the data formats included in the original are
1265 preserved. `none` means that the contents of data cells
1266 are omitted. `best` causes pandoc to try to pick the
1267 richest data block in each output cell that is compatible
1268 with the output format. The default is `best`.
1270`--pdf-engine=`*PROGRAM*
1272: Use the specified engine when producing PDF output.
1273 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1274 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1275 and `pdfroff`. If the engine is not in your PATH, the full
1276 path of the engine may be specified here. If this option
1277 is not specified, pandoc uses the following defaults
1278 depending on the output format specified using `-t/--to`:
1280 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1281 `tectonic`, `latexmk`)
1282 - `-t context`: `context`
1283 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1284 see [print-css.rocks](https://print-css.rocks) for a good
1285 introduction to PDF generation from HTML/CSS.)
1286 - `-t ms`: `pdfroff`
1288`--pdf-engine-opt=`*STRING*
1290: Use the given string as a command-line argument to the `pdf-engine`.
1291 For example, to use a persistent directory `foo` for `latexmk`'s
1292 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1293 Note that no check for duplicate options is done.
1295[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1296[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1297[Encoding issue with the listings package]:
1298 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1300## Citation rendering {.options}
1304: Process the citations in the file, replacing them with
1305 rendered citations and adding a bibliography.
1306 Citation processing will not take place unless bibliographic
1307 data is supplied, either through an external file specified
1308 using the `--bibliography` option or the `bibliography`
1309 field in metadata, or via a `references` section in metadata
1310 containing a list of citations in CSL YAML format with
1311 Markdown formatting. The style is controlled by a [CSL]
1312 stylesheet specified using the `--csl` option or the `csl`
1313 field in metadata. (If no stylesheet is specified,
1314 the `chicago-author-date` style will be used by default.)
1315 The citation processing transformation may be applied before
1316 or after filters or Lua filters (see `--filter`,
1317 `--lua-filter`): these transformations are applied in the
1318 order they appear on the command line. For more
1319 information, see the section on [Citations].
1321`--bibliography=`*FILE*
1323: Set the `bibliography` field in the document's metadata to *FILE*,
1324 overriding any value set in the metadata. If you supply
1325 this argument multiple times, each *FILE* will be added to
1330: Set the `csl` field in the document's metadata to *FILE*,
1331 overriding any value set in the metadata. (This is equivalent to
1332 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1333 fetched via HTTP. If *FILE* is not found relative to the
1334 working directory, it will be sought in the resource path
1335 and finally in the `csl` subdirectory of the
1336 pandoc user data directory.
1338`--citation-abbreviations=`*FILE*
1340: Set the `citation-abbreviations` field in the document's metadata to
1341 *FILE*, overriding any value set in the metadata. (This is equivalent to
1342 `--metadata citation-abbreviations=FILE`.)
1343 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1344 found relative to the working directory, it will be sought
1345 in the resource path and finally in the `csl` subdirectory
1346 of the pandoc user data directory.
1350: Use [`natbib`] for citations in LaTeX output. This option is not for use
1351 with the `--citeproc` option or with PDF output. It is intended for
1352 use in producing a LaTeX file that can be processed with [`bibtex`].
1356: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1357 with the `--citeproc` option or with PDF output. It is intended for
1358 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1360## Math rendering in HTML {.options}
1362The default is to render TeX math as far as possible using Unicode characters.
1363Formulas are put inside a `span` with `class="math"`, so that they may be styled
1364differently from the surrounding text if needed. However, this gives acceptable
1365results only for basic math, usually you will want to use `--mathjax` or another
1366of the following options.
1368`--mathjax`[`=`*URL*]
1370: Use [MathJax] to display embedded TeX math in HTML output.
1371 TeX math will be put between `\(...\)` (for inline math)
1372 or `\[...\]` (for display math) and wrapped in `<span>` tags
1373 with class `math`. Then the MathJax JavaScript will render it.
1374 The *URL* should point to the `MathJax.js` load script.
1375 If a *URL* is not provided, a link to the Cloudflare CDN will
1380: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1381 `html4` and `html5`). This is the default in `odt` output. Note that
1382 currently only Firefox and Safari (and select e-book readers) natively
1387: Convert TeX formulas to `<img>` tags that link to an external script
1388 that converts formulas to images. The formula will be URL-encoded
1389 and concatenated with the URL provided. For SVG images you can for
1390 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1391 If no URL is specified, the CodeCogs URL generating PNGs
1392 will be used (`https://latex.codecogs.com/png.latex?`).
1393 Note: the `--webtex` option will affect Markdown output
1394 as well as HTML, which is useful if you're targeting a
1395 version of Markdown without native math support.
1399: Use [KaTeX] to display embedded TeX math in HTML output.
1400 The *URL* is the base URL for the KaTeX library. That directory
1401 should contain a `katex.min.js` and a `katex.min.css` file.
1402 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1406: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1407 can then be processed by [GladTeX] to produce images of the typeset
1408 formulas and an HTML file with links to these images.
1409 So, the procedure is:
1411 pandoc -s --gladtex input.md -o myfile.htex
1412 gladtex -d myfile-images myfile.htex
1413 # produces myfile.html and images in myfile-images
1415[MathML]: https://www.w3.org/Math/
1416[MathJax]: https://www.mathjax.org
1417[KaTeX]: https://github.com/Khan/KaTeX
1418[GladTeX]: https://humenda.github.io/GladTeX/
1420## Options for wrapper scripts {.options}
1424: Print information about command-line arguments to *stdout*, then exit.
1425 This option is intended primarily for use in wrapper scripts.
1426 The first line of output contains the name of the output file specified
1427 with the `-o` option, or `-` (for *stdout*) if no output file was
1428 specified. The remaining lines contain the command-line arguments,
1429 one per line, in the order they appear. These do not include regular
1430 pandoc options and their arguments, but do include any options appearing
1431 after a `--` separator at the end of the line.
1435: Ignore command-line arguments (for use in wrapper scripts).
1436 Regular pandoc options are not ignored. Thus, for example,
1438 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1442 pandoc -o foo.html -s
1446If pandoc completes successfully, it will return exit code 0.
1447Nonzero exit codes have the following meanings:
1450----- ------------------------------------
1451 3 PandocFailOnWarningError
1453 5 PandocTemplateError
1455 21 PandocUnknownReaderError
1456 22 PandocUnknownWriterError
1457 23 PandocUnsupportedExtensionError
1458 24 PandocCiteprocError
1459 31 PandocEpubSubdirectoryError
1461 47 PandocPDFProgramNotFoundError
1463 62 PandocShouldNeverHappenError
1466 65 PandocParsecError
1467 66 PandocMakePDFError
1468 67 PandocSyntaxMapError
1469 83 PandocFilterError
1471 92 PandocUTF8DecodingError
1472 93 PandocIpynbDecodingError
1473 97 PandocCouldNotFindDataFileError
1474 99 PandocResourceNotFound
1475----- ------------------------------------
1479The `--defaults` option may be used to specify a package
1480of options. Here is a sample defaults file demonstrating all of
1481the fields that may be used:
1485# reader: may be used instead of from:
1487# writer: may be used instead of to:
1489# leave blank for output to stdout:
1491# leave blank for input from stdin, use [] for no input:
1495# or you may use input-file: with a single value
1499self-contained: false
1501# note that structured variables may be specified:
1508# metadata values specified here are parsed as literal
1509# string text, not markdown:
1516# or you may use metadata-file: with a single value
1518# Note that these take files, not their contents:
1519include-before-body: []
1520include-after-body: []
1521include-in-header: []
1524# filters will be assumed to be Lua filters if they have
1525# the .lua extension, and json filters otherwise. But
1526# the filter type can also be specified explicitly, as shown:
1536# ERROR, WARNING, or INFO
1540# citeproc, natbib, or biblatex
1541cite-method: citeproc
1542# part, chapter, section, or default:
1543top-level-division: chapter
1549# you may also use pdf-engine-opt: with a single option
1550# pdf-engine-opt: "-shell-escape"
1552# auto, preserve, or none
1557extract-media: mediadir
1559table-of-contents: true
1561number-sections: false
1562# a list of offsets at each heading level
1563number-offset: [0,0,0,0,0,0]
1564# toc: may also be used instead of table-of-contents:
1565shift-heading-level-by: 1
1567identifier-prefix: foo
1569strip-empty-paragraphs: true
1570# lf, crlf, or native
1572strip-comments: false
1573indented-code-classes: []
1575default-image-extension: ".jpg"
1577# either a style name of a style definition file:
1578highlight-style: pygments
1581# or you may use syntax-definition: with a single value
1584reference-doc: myref.docx
1586# method is plain, webtex, gladtex, mathml, mathjax, katex
1587# you may specify a url with webtex, mathjax, katex
1590 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1591# none, references, or javascript
1592email-obfuscation: javascript
1600epub-subdirectory: EPUB
1601epub-metadata: meta.xml
1604epub-chapter-level: 1
1605epub-cover-image: cover.jpg
1607reference-links: true
1608# block, section, or document
1609reference-location: block
1612# accept, reject, or all
1613track-changes: accept
1622# A list of two-element lists
1624- ["User-Agent", "Mozilla/5.0"]
1626fail-if-warnings: false
1632Fields that are omitted will just have their regular
1633default values. So a defaults file can be as simple as
1640Default files can be placed in the `defaults` subdirectory of
1641the user data directory and used from any directory. For
1642example, one could create a file specifying defaults for writing
1643letters, save it as `letter.yaml` in the `defaults` subdirectory
1644of the user data directory, and then invoke these defaults
1645from any directory using `pandoc --defaults letter`
1646or `pandoc -dletter`.
1648When multiple defaults are used, their contents will be combined.
1650Note that, where command-line arguments may be repeated
1651(`--metadata-file`, `--css`, `--include-in-header`,
1652`--include-before-body`, `--include-after-body`, `--variable`,
1653`--metadata`, `--syntax-definition`), the values specified on
1654the command line will combine with values specified in the
1655defaults file, rather than replacing them.
1659When the `-s/--standalone` option is used, pandoc uses a template to
1660add header and footer material that is needed for a self-standing
1661document. To see the default template that is used, just type
1665where *FORMAT* is the name of the output format. A custom template
1666can be specified using the `--template` option. You can also override
1667the system default templates for a given output format *FORMAT*
1668by putting a file `templates/default.*FORMAT*` in the user data
1669directory (see `--data-dir`, above). *Exceptions:*
1671- For `odt` output, customize the `default.opendocument`
1673- For `pdf` output, customize the `default.latex` template
1674 (or the `default.context` template, if you use `-t context`,
1675 or the `default.ms` template, if you use `-t ms`, or the
1676 `default.html` template, if you use `-t html`).
1677- `docx` and `pptx` have no template (however, you can use
1678 `--reference-doc` to customize the output).
1680Templates contain *variables*, which allow for the inclusion of
1681arbitrary information at any point in the file. They may be set at the
1682command line using the `-V/--variable` option. If a variable is not set,
1683pandoc will look for the key in the document's metadata, which can be set
1684using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1685or with the `-M/--metadata` option. In addition, some variables
1686are given default values by pandoc. See [Variables] below for
1687a list of variables used in pandoc's default templates.
1689If you use custom templates, you may need to revise them as pandoc
1690changes. We recommend tracking the changes in the default templates,
1691and modifying your custom templates accordingly. An easy way to do this
1692is to fork the [pandoc-templates] repository and merge in
1693changes after each pandoc release.
1695 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1701Anything between the sequence `$--` and the end of the
1702line will be treated as a comment and omitted from the output.
1706To mark variables and control structures in the template,
1707either `$`...`$` or `${`...`}` may be used as delimiters.
1708The styles may also be mixed in the same template, but the
1709opening and closing delimiter must match in each case. The
1710opening delimiter may be followed by one or more spaces
1711or tabs, which will be ignored. The closing delimiter may
1712be followed by one or more spaces or tabs, which will be
1715To include a literal `$` in the document, use `$$`.
1717### Interpolated variables
1719A slot for an interpolated variable is a variable name surrounded
1720by matched delimiters. Variable names must begin with a letter
1721and can contain letters, numbers, `_`, `-`, and `.`. The
1722keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1723not be used as variable names. Examples:
1736Variable names with periods are used to get at structured
1737variable values. So, for example, `employee.salary` will return the
1738value of the `salary` field of the object that is the value of
1739the `employee` field.
1741- If the value of the variable is simple value, it will be
1742 rendered verbatim. (Note that no escaping is done;
1743 the assumption is that the calling program will escape
1744 the strings appropriately for the output format.)
1745- If the value is a list, the values will be concatenated.
1746- If the value is a map, the string `true` will be rendered.
1747- Every other value will be rendered as the empty string.
1751A conditional begins with `if(variable)` (enclosed in
1752matched delimiters) and ends with `endif` (enclosed in matched
1753delimiters). It may optionally contain an `else` (enclosed in
1754matched delimiters). The `if` section is used if
1755`variable` has a non-empty value, otherwise the `else`
1756section is used (if present). Examples:
1771${if(foo)}bar${endif}
1784The keyword `elseif` may be used to simplify complex nested
1799A for loop begins with `for(variable)` (enclosed in
1800matched delimiters) and ends with `endfor` (enclosed in matched
1803- If `variable` is an array, the material inside the loop will
1804 be evaluated repeatedly, with `variable` being set to each
1805 value of the array in turn, and concatenated.
1806- If `variable` is a map, the material inside will be set to
1808- If the value of the associated variable is not an array or
1809 a map, a single iteration will be performed on its value.
1814$for(foo)$$foo$$sep$, $endfor$
1817 - $foo.last$, $foo.first$
1821 - ${ foo.bar.last }, ${ foo.bar.first }
1825$it.name$: $it.office$
1829You may optionally specify a separator between consecutive
1830values using `sep` (enclosed in matched delimiters). The
1831material between `sep` and the `endfor` is the separator.
1834${ for(foo) }${ foo }${ sep }, ${ endfor }
1837Instead of using `variable` inside the loop, the special
1838anaphoric keyword `it` may be used.
1842 - ${ it.last }, ${ it.first }
1848Partials (subtemplates stored in different files) may be
1849included by using the name of the partial, followed
1850by `()`, for example:
1856Partials will be sought in the directory containing
1857the main template. The file name will be assumed to
1858have the same extension as the main template if it
1859lacks an extension. When calling the partial, the
1860full name including file extension can also be used:
1866(If a partial is not found in the directory of the
1867template, it will also be sought in the `templates`
1868subdirectory of the user data directory.)
1870Partials may optionally be applied to variables using
1876${ articles:bibentry() }
1879If `articles` is an array, this will iterate over its
1880values, applying the partial `bibentry()` to each one. So the
1881second example above is equivalent to
1889Note that the anaphoric keyword `it` must be used when
1890iterating over partials. In the above examples,
1891the `bibentry` partial should contain `it.title`
1892(and so on) instead of `articles.title`.
1894Final newlines are omitted from included partials.
1896Partials may include other partials.
1898A separator between values of an array may be specified
1899in square brackets, immediately after the variable name
1905${articles:bibentry()[; ]$
1908The separator in this case is literal and (unlike with `sep`
1909in an explicit `for` loop) cannot contain interpolated
1910variables or other template directives.
1914To ensure that content is "nested," that is, subsequent lines
1915indented, use the `^` directive:
1918$item.number$ $^$$item.description$ ($item.price$)
1921In this example, if `item.description` has multiple lines,
1922they will all be indented to line up with the first line:
192500123 A fine bottle of 18-year old
1926 Oban whiskey. ($148)
1929To nest multiple lines to the same level, align them
1930with the `^` directive in the template. For example:
1933$item.number$ $^$$item.description$ ($item.price$)
1934 (Available til $item.sellby$.)
194000123 A fine bottle of 18-year old
1941 Oban whiskey. ($148)
1942 (Available til March 30, 2020.)
1945If a variable occurs by itself on a line, preceded by whitespace
1946and not followed by further text or directives on the same line,
1947and the variable's value contains multiple lines, it will be
1948nested automatically.
1952Normally, spaces in the template itself (as opposed to values of
1953the interpolated variables) are not breakable, but they can be
1954made breakable in part of the template by using the `~` keyword
1955(ended with another `~`).
1958$~$This long line may break if the document is rendered
1959with a short line length.$~$
1964A pipe transforms the value of a variable or partial. Pipes are
1965specified using a slash (`/`) between the variable name (or partial)
1966and the pipe name. Example:
1973$for(metadata/pairs)$
1974- $it.key$: $it.value$
1977$employee:name()/uppercase$
1980Pipes may be chained:
1983$for(employees/pairs)$
1984$it.key/alpha/uppercase$. $it.name$
1988Some pipes take parameters:
1991|----------------------|------------|
1993$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1995|----------------------|------------|
1998Currently the following pipes are predefined:
2000- `pairs`: Converts a map or array to an array of maps,
2001 each with `key` and `value` fields. If the original
2002 value was an array, the `key` will be the array index,
2005- `uppercase`: Converts text to uppercase.
2007- `lowercase`: Converts text to lowercase.
2009- `length`: Returns the length of the value: number
2010 of characters for a textual value, number of elements
2013- `reverse`: Reverses a textual value or array,
2014 and has no effect on other values.
2016- `first`: Returns the first value of an array, if
2017 applied to a non-empty array; otherwise returns
2020- `last`: Returns the last value of an array, if
2021 applied to a non-empty array; otherwise returns
2024- `rest`: Returns all but the first value of an array, if
2025 applied to a non-empty array; otherwise returns
2028- `allbutlast`: Returns all but the last value of an array, if
2029 applied to a non-empty array; otherwise returns
2032- `chomp`: Removes trailing newlines (and breakable space).
2034- `nowrap`: Disables line wrapping on breakable spaces.
2036- `alpha`: Converts textual values that can be
2037 read as an integer into lowercase alphabetic
2038 characters `a..z` (mod 26). This can be used to get lettered
2039 enumeration from array indices. To get uppercase
2040 letters, chain with `uppercase`.
2042- `roman`: Converts textual values that can be
2043 read as an integer into lowercase roman numerials.
2044 This can be used to get lettered enumeration from array indices.
2045 To get uppercase roman, chain with `uppercase`.
2047- `left n "leftborder" "rightborder"`: Renders a textual value
2048 in a block of width `n`, aligned to the left, with an optional
2049 left and right border. Has no effect on other values. This
2050 can be used to align material in tables. Widths are positive
2051 integers indicating the number of characters. Borders
2052 are strings inside double quotes; literal `"` and `\` characters
2053 must be backslash-escaped.
2055- `right n "leftborder" "rightborder"`: Renders a textual value
2056 in a block of width `n`, aligned to the right, and has no
2057 effect on other values.
2059- `center n "leftborder" "rightborder"`: Renders a textual
2060 value in a block of width `n`, aligned to the center, and has
2061 no effect on other values.
2066### Metadata variables
2068`title`, `author`, `date`
2069: allow identification of basic aspects of the document. Included
2070 in PDF metadata through LaTeX and ConTeXt. These can be set
2071 through a [pandoc title block][Extension: `pandoc_title_block`],
2072 which allows for multiple authors, or through a
2073 [YAML metadata block][Extension: `yaml_metadata_block`]:
2081 Note that if you just want to set PDF or HTML metadata, without
2082 including a title block in the document itself, you can
2083 set the `title-meta`, `author-meta`, and `date-meta`
2084 variables. (By default these are set automatically, based
2085 on `title`, `author`, and `date`.)
2088: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2092: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2096: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2097 and AsciiDoc metadata; repeat as for `author`, above
2100: document subject, included in ODT, PDF, docx and pptx metadata
2103: document description, included in ODT, docx and pptx metadata. Some
2104 applications show this as `Comments` metadata.
2107: document category, included in docx and pptx metadata
2110any root-level string metadata, not included in ODT, docx
2111or pptx metadata is added as a *custom property*.
2112The following [YAML] metadata block for instance:
2115 title: 'This is the title'
2116 subtitle: "This is the subtitle"
2124 It consists of two paragraphs
2127will include `title`, `author` and `description` as standard document
2128properties and `subtitle` as a custom property when converting to docx,
2131### Language variables
2134: identifies the main language of the document using IETF language
2135 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2136 The [Language subtag lookup] tool can look up or verify these tags.
2137 This affects most formats, and controls hyphenation in PDF output
2138 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2140 Use native pandoc [Divs and Spans] with the `lang` attribute to
2141 switch the language:
2147 Text in the main document language (British English).
2150 > Cette citation est écrite en français canadien.
2153 More text in English. ['Zitat auf Deutsch.']{lang=de}
2156: the base script direction, either `rtl` (right-to-left)
2157 or `ltr` (left-to-right).
2159 For bidirectional documents, native pandoc `span`s and `div`s
2160 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2161 override the base direction in some output formats.
2162 This may not always be necessary if the final renderer
2163 (e.g. the browser, when generating HTML) supports the
2164 [Unicode Bidirectional Algorithm].
2166 When using LaTeX for bidirectional documents, only the `xelatex` engine
2167 is fully supported (use `--pdf-engine=xelatex`).
2169[BCP 47]: https://tools.ietf.org/html/bcp47
2170[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2171[Language subtag lookup]: https://r12a.github.io/app-subtags/
2173### Variables for HTML
2176: Enables inclusion of most of the CSS in the `styles.html`
2177 [partial](#partials) (have a look with
2178 `pandoc --print-default-data-file=templates/styles.html`).
2179 Unless you use [`--css`](#option--css), this variable
2180 is set to `true` by default. You can disable it with
2181 e.g. `pandoc -M document-css=false`.
2184: sets the CSS `font-family` property on the `html` element.
2187: sets the base CSS `font-size`, which you'd usually set
2188 to e.g. `20px`, but it also accepts `pt`
2189 (12pt = 16px in most browsers).
2192: sets the CSS `color` property on the `html` element.
2195: sets the CSS `color` property on all links.
2198: sets the CSS `font-family` property on `code` elements.
2201: sets the CSS `line-height` property on the `html` element,
2202 which is preferred to be unitless.
2205: sets the CSS `background-color` property on the `html` element.
2207`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2208: sets the corresponding CSS `padding` properties on the `body` element.
2210### Variables for HTML math
2213: when using [KaTeX](#option--katex), you can render display math equations
2214 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2216### Variables for HTML slides
2218These affect HTML output when [producing slide shows with pandoc].
2220All [reveal.js configuration options] are available as variables.
2221To turn off boolean flags that default to true in reveal.js, use `0`.
2224: base URL for reveal.js documents (defaults to
2225 `https://unpkg.com/reveal.js@^4/`)
2228: base URL for S5 documents (defaults to `s5/default`)
2231: base URL for Slidy documents (defaults to
2232 `https://www.w3.org/Talks/Tools/Slidy2`)
2235: base URL for Slideous documents (defaults to `slideous`)
2237`title-slide-attributes`
2238: additional attributes for the title slide of reveal.js slide shows.
2239 See [background in reveal.js and beamer] for an example.
2241[reveal.js configuration options]: https://revealjs.com/config/
2243### Variables for Beamer slides
2245These variables change the appearance of PDF slides using [`beamer`].
2248: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2249 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2253: produce an article from Beamer slides
2256: add extra beamer option with `\setbeameroption{}`
2259: author affiliations: can be a list when there are multiple authors
2262: logo image for slides
2265: controls navigation symbols (default is `empty` for no navigation
2266 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2269: enables "title pages" for new sections (default is true)
2271`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2275: options for LaTeX beamer themes (a list).
2278: image for title slide
2280### Variables for PowerPoint
2282These variables control the visual aspects of a slide show that
2283are not easily controlled via templates.
2286: font to use for code.
2288### Variables for LaTeX
2290Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2295: make `\paragraph` and `\subparagraph` (fourth- and
2296 fifth-level headings, or fifth- and sixth-level with book
2297 classes) free-standing rather than run-in; requires further
2298 formatting to distinguish from `\subsubsection` (third- or
2299 fourth-level headings). Instead of using this option,
2300 [KOMA-Script] can adjust headings more extensively:
2303 documentclass: scrartcl
2305 \RedeclareSectionCommand[
2306 beforeskip=-10pt plus -2pt minus -1pt,
2307 afterskip=1sp plus -1sp minus 1sp,
2308 font=\normalfont\itshape]{paragraph}
2309 \RedeclareSectionCommand[
2310 beforeskip=-10pt plus -2pt minus -1pt,
2311 afterskip=1sp plus -1sp minus 1sp,
2312 font=\normalfont\scshape,
2313 indent=0pt]{subparagraph}
2317: option for document class, e.g. `oneside`; repeat for multiple options:
2326: document class: usually one of the standard classes, [`article`], [`book`],
2327 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2328 and `scrreprt`, which default to smaller margins; or [`memoir`]
2331: option for [`geometry`] package, e.g. `margin=1in`;
2332 repeat for multiple options:
2342: option for [`hyperref`] package, e.g. `linktoc=all`;
2343 repeat for multiple options:
2349 - pdfpagemode=FullScreen
2353: uses document class settings for indentation (the default LaTeX template
2354 otherwise removes indentation and adds space between paragraphs)
2357: adjusts line spacing using the [`setspace`]
2358 package, e.g. `1.25`, `1.5`
2360`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2361: sets margins if `geometry` is not used (otherwise `geometry`
2365: control `\pagestyle{}`: the default article class
2366 supports `plain` (default), `empty` (no running heads or page numbers),
2367 and `headings` (section titles in running heads)
2370: paper size, e.g. `letter`, `a4`
2373: numbering depth for sections (with `--number-sections` option
2374 or `numbersections` variable)
2379: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2380 default is `T1` (see [LaTeX font encodings guide])
2383: font package for use with `pdflatex`:
2384 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2385 The default is [Latin Modern][`lm`].
2388: options for package used as `fontfamily`; repeat for multiple options.
2389 For example, to use the Libertine font with proportional lowercase
2390 (old-style) figures through the [`libertinus`] package:
2393 fontfamily: libertinus
2400: font size for body text. The standard classes allow 10pt, 11pt, and
2401 12pt. To use another size, set `documentclass` to one of
2402 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2404`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2405: font families for use with `xelatex` or
2406 `lualatex`: take the name of any system font, using the
2407 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2409`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2410: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2411 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2412 choices available through [`fontspec`]; repeat for multiple
2413 options. For example, to use the [TeX Gyre] version of
2414 Palatino with lowercase figures:
2417 mainfont: TeX Gyre Pagella
2420 - Numbers=Proportional
2424: options to pass to the microtype package
2429: add color to link text; automatically enabled if any of
2430 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2432`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2433: color for internal links, external links, citation links, linked
2434 URLs, and links in table of contents, respectively: uses options
2435 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2439: causes links to be printed as footnotes
2444: include list of figures, list of tables
2447: contents of acknowledgments footnote after document title
2450: include table of contents (can also be set using `--toc/--table-of-contents`)
2453: level of section to include in table of contents
2455#### BibLaTeX Bibliographies
2457These variables function when using BibLaTeX for [citation rendering].
2460: list of options for biblatex
2463: bibliography style, when used with `--natbib` and `--biblatex`.
2466: bibliography title, when used with `--natbib` and `--biblatex`.
2469: bibliography to use for resolving references
2472: list of options for natbib
2474[KOMA-Script]: https://ctan.org/pkg/koma-script
2475[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2476[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2477[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2478[`article`]: https://ctan.org/pkg/article
2479[`book`]: https://ctan.org/pkg/book
2480[`libertinus`]: https://ctan.org/pkg/libertinus
2481[`memoir`]: https://ctan.org/pkg/memoir
2482[`report`]: https://ctan.org/pkg/report
2484### Variables for ConTeXt
2486Pandoc uses these variables when [creating a PDF] with ConTeXt.
2489: font size for body text (e.g. `10pt`, `12pt`)
2491`headertext`, `footertext`
2492: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2493 repeat up to four times for different placement
2496: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2497 repeat for multiple options
2500: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2501 repeat for multiple options
2504: options for page margins and text arrangement (see [ConTeXt Layout]);
2505 repeat for multiple options
2507`linkcolor`, `contrastcolor`
2508: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2511: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2514: include list of figures, list of tables
2516`mainfont`, `sansfont`, `monofont`, `mathfont`
2517: font families: take the name of any system font (see [ConTeXt Font Switching])
2519`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2520: sets margins, if `layout` is not used (otherwise `layout`
2524: page number style and location (using [`setuppagenumbering`]);
2525 repeat for multiple options
2528: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2529 repeat for multiple options
2532: adds to the preamble the setup necessary to generate PDF/A of the type
2533 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2534 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2535 block), `1b:2005` will be used as default, for reasons of backwards
2536 compatibility. Using `--variable=pdfa` without specified value is not supported.
2537 To successfully generate PDF/A the required ICC color profiles have to
2538 be available and the content and all included files (such as images)
2539 have to be standard conforming. The ICC profiles and output intent
2540 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2541 See also [ConTeXt PDFA] for more details.
2544: when used in conjunction with `pdfa`, specifies the ICC profile to use
2545 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2546 used as default. May be repeated to include multiple profiles. Note that
2547 the profiles have to be available on the system. They can be obtained
2548 from [ConTeXt ICC Profiles].
2551: when used in conjunction with `pdfa`, specifies the output intent for
2552 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2553 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2556: include table of contents (can also be set using `--toc/--table-of-contents`)
2559: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2562: include all source documents as file attachments in the PDF file
2564[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2565[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2566[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2567[ConTeXt Color]: https://wiki.contextgarden.net/Color
2568[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2569[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2570[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2571[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2572[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2573[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2574[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2576### Variables for `wkhtmltopdf`
2578Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2579The `--css` option also affects the output.
2581`footer-html`, `header-html`
2582: add information to the header and footer
2584`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2585: set the page margins
2588: sets the PDF paper size
2590### Variables for man pages
2593: adjusts text to left (`l`), right (`r`), center (`c`),
2594 or both (`b`) margins
2597: footer in man pages
2600: header in man pages
2603: if `true` (the default), hyphenation will be used
2606: section number in man pages
2611: font family (e.g. `T` or `P`)
2614: paragraph indent (e.g. `2m`)
2617: line height (e.g. `12p`)
2620: point size (e.g. `10p`)
2622### Variables set automatically
2624Pandoc sets these variables automatically in response to [options] or
2625document contents; users can also modify them. These vary depending
2626on the output format, and include the following:
2632: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2633 included in all HTML based formats (dzslides, epub,
2634 html, html4, html5, revealjs, s5, slideous, slidy).
2635 The recognized formats for `date` are: `mm/dd/yyyy`,
2636 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2637 (e.g. either `02 Apr 2018` or `02 April 2018`),
2638 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2639 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2642: contents specified by `-H/--include-in-header` (may have multiple
2646: contents specified by `-B/--include-before-body` (may have
2650: contents specified by `-A/--include-after-body` (may have
2654: JSON representation of all of the document's metadata. Field
2655 values are transformed to the selected output format.
2658: non-null value if `-N/--number-sections` was specified
2660`sourcefile`, `outputfile`
2661: source and destination filenames, as given on the command line.
2662 `sourcefile` can also be a list if input comes from multiple files,
2663 or empty if input is from stdin. You can use the following snippet in
2664 your template to distinguish them:
2674 Similarly, `outputfile` can be `-` if output goes to the terminal.
2676 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2679: working directory from which pandoc is run.
2682: non-null value if `--toc/--table-of-contents` was specified
2685: title of table of contents (works only with EPUB,
2686 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2688[pandoc-templates]: https://github.com/jgm/pandoc-templates
2692The behavior of some of the readers and writers can be adjusted by
2693enabling or disabling various extensions.
2695An extension can be enabled by adding `+EXTENSION`
2696to the format name and disabled by adding `-EXTENSION`. For example,
2697`--from markdown_strict+footnotes` is strict Markdown with footnotes
2698enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2699Markdown without footnotes or pipe tables.
2701The markdown reader and writer make by far the most use of extensions.
2702Extensions only used by them are therefore covered in the
2703section [Pandoc's Markdown] below (See [Markdown variants] for
2704`commonmark` and `gfm`.) In the following, extensions that also work
2705for other formats are covered.
2707Note that markdown extensions added to the `ipynb` format
2708affect Markdown cells in Jupyter notebooks (as do command-line
2709options like `--atx-headers`).
2713#### Extension: `smart` ####
2715Interpret straight quotes as curly quotes, `---` as em-dashes,
2716`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2717inserted after certain abbreviations, such as "Mr."
2719This extension can be enabled/disabled for the following formats:
2722: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2725: `markdown`, `latex`, `context`, `rst`
2727enabled by default in
2728: `markdown`, `latex`, `context` (both input and output)
2730Note: If you are *writing* Markdown, then the `smart` extension
2731has the reverse effect: what would have been curly quotes comes
2734In LaTeX, `smart` means to use the standard TeX ligatures
2735for quotation marks (` `` ` and ` '' ` for double quotes,
2736`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2737en-dash and `---` for em-dash). If `smart` is disabled,
2738then in reading LaTeX pandoc will parse these characters
2739literally. In writing LaTeX, enabling `smart` tells pandoc
2740to use the ligatures when possible; if `smart` is disabled
2741pandoc will use unicode quotation mark and dash characters.
2743## Headings and sections
2745#### Extension: `auto_identifiers` ####
2747A heading without an explicitly specified identifier will be
2748automatically assigned a unique identifier based on the heading text.
2750This extension can be enabled/disabled for the following formats:
2753: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2758enabled by default in
2761The default algorithm used to derive the identifier from the
2764 - Remove all formatting, links, etc.
2765 - Remove all footnotes.
2766 - Remove all non-alphanumeric characters,
2767 except underscores, hyphens, and periods.
2768 - Replace all spaces and newlines with hyphens.
2769 - Convert all alphabetic characters to lowercase.
2770 - Remove everything up to the first letter (identifiers may
2771 not begin with a number or punctuation mark).
2772 - If nothing is left after this, use the identifier `section`.
2777 ------------------------------- ----------------------------
2778 `Heading identifiers in HTML` `heading-identifiers-in-html`
2779 `Maître d'hôtel` `maître-dhôtel`
2780 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2781 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2782 `3. Applications` `applications`
2785These rules should, in most cases, allow one to determine the identifier
2786from the heading text. The exception is when several headings have the
2787same text; in this case, the first will get an identifier as described
2788above; the second will get the same identifier with `-1` appended; the
2789third with `-2`; and so on.
2791(However, a different algorithm is used if
2792`gfm_auto_identifiers` is enabled; see below.)
2794These identifiers are used to provide link targets in the table of
2795contents generated by the `--toc|--table-of-contents` option. They
2796also make it easy to provide links from one section of a document to
2797another. A link to this section, for example, might look like this:
2800 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2802Note, however, that this method of providing links to sections works
2803only in HTML, LaTeX, and ConTeXt formats.
2805If the `--section-divs` option is specified, then each section will
2806be wrapped in a `section` (or a `div`, if `html4` was specified),
2807and the identifier will be attached to the enclosing `<section>`
2808(or `<div>`) tag rather than the heading itself. This allows entire
2809sections to be manipulated using JavaScript or treated differently in
2812#### Extension: `ascii_identifiers` ####
2814Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2815Accents are stripped off of accented Latin letters, and non-Latin
2818#### Extension: `gfm_auto_identifiers` ####
2820Changes the algorithm used by `auto_identifiers` to conform to
2821GitHub's method. Spaces are converted to dashes (`-`),
2822uppercase characters to lowercase characters, and punctuation
2823characters other than `-` and `_` are removed.
2824Emojis are replaced by their names.
2828The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2829[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2830[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2831are described in the section about Pandoc's Markdown.
2833However, they can also be used with HTML input. This is handy for
2834reading web pages formatted using MathJax, for example.
2838The following extensions are described in more detail in
2839their respective sections of [Pandoc's Markdown]:
2841- [`raw_html`](#extension-raw_html) allows HTML elements which
2842 are not representable in pandoc's AST to be parsed as raw HTML.
2843 By default, this is disabled for HTML input.
2845- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2846 to be included in a document. This extension can be enabled/disabled
2847 for the following formats (in addition to `markdown`):
2850 : `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2851 `\eqref` only), `ipynb`
2854 : `textile`, `commonmark`
2856 Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2857 only raw TeX in markdown cells, but data with mime type
2858 `text/html` in output cells. Since the `ipynb` reader attempts
2859 to preserve the richest possible outputs when several options
2860 are given, you will get best results if you disable `raw_html`
2861 and `raw_tex` when converting to formats like `docx` which don't
2862 allow raw `html` or `tex`.
2864- [`native_divs`](#extension-native_divs) causes HTML `div`
2865 elements to be parsed as native pandoc Div blocks.
2866 If you want them to be parsed as raw HTML, use
2867 `-f html-native_divs+raw_html`.
2869- [`native_spans`](#extension-native_spans) causes HTML `span`
2870 elements to be parsed as native pandoc Span inlines.
2871 If you want them to be parsed as raw HTML, use
2872 `-f html-native_spans+raw_html`. If you want to drop all
2873 `div`s and `span`s when converting HTML to Markdown, you
2874 can use `pandoc -f html-native_divs-native_spans -t markdown`.
2876## Literate Haskell support
2878#### Extension: `literate_haskell` ####
2880Treat the document as literate Haskell source.
2882This extension can be enabled/disabled for the following formats:
2885: `markdown`, `rst`, `latex`
2888: `markdown`, `rst`, `latex`, `html`
2890If you append `+lhs` (or `+literate_haskell`) to one of the formats
2891above, pandoc will treat the document as literate Haskell source.
2894 - In Markdown input, "bird track" sections will be parsed as Haskell
2895 code rather than block quotations. Text between `\begin{code}`
2896 and `\end{code}` will also be treated as Haskell code. For
2897 ATX-style headings the character '=' will be used instead of '#'.
2899 - In Markdown output, code blocks with classes `haskell` and `literate`
2900 will be rendered using bird tracks, and block quotations will be
2901 indented one space, so they will not be treated as Haskell code.
2902 In addition, headings will be rendered setext-style (with underlines)
2903 rather than ATX-style (with '#' characters). (This is because ghc
2904 treats '#' characters in column 1 as introducing line numbers.)
2906 - In restructured text input, "bird track" sections will be parsed
2909 - In restructured text output, code blocks with class `haskell` will
2910 be rendered using bird tracks.
2912 - In LaTeX input, text in `code` environments will be parsed as
2915 - In LaTeX output, code blocks with class `haskell` will be rendered
2916 inside `code` environments.
2918 - In HTML output, code blocks with class `haskell` will be rendered
2919 with class `literatehaskell` and bird tracks.
2923 pandoc -f markdown+lhs -t html
2925reads literate Haskell source formatted with Markdown conventions and writes
2926ordinary HTML (without bird tracks).
2928 pandoc -f markdown+lhs -t html+lhs
2930writes HTML with the Haskell code in bird tracks, so it can be copied
2931and pasted as literate Haskell source.
2933Note that GHC expects the bird tracks in the first column, so indented
2934literate code blocks (e.g. inside an itemized environment) will not be
2935picked up by the Haskell compiler.
2939#### Extension: `empty_paragraphs` ####
2941Allows empty paragraphs. By default empty paragraphs are
2944This extension can be enabled/disabled for the following formats:
2950: `docx`, `odt`, `opendocument`, `html`
2952#### Extension: `native_numbering` ####
2954Enables native numbering of figures and tables. Enumeration
2957This extension can be enabled/disabled for the following formats:
2960: `odt`, `opendocument`
2962#### Extension: `styles` #### {#ext-styles}
2964When converting from docx, read all docx styles as divs (for
2965paragraph styles) and spans (for character styles) regardless
2966of whether pandoc understands the meaning of these styles.
2967This can be used with [docx custom styles](#custom-styles).
2973#### Extension: `amuse` ####
2975In the `muse` input format, this enables Text::Amuse
2976extensions to Emacs Muse markup.
2978#### Extension: `raw_markdown` ####
2980In the `ipynb` input format, this causes Markdown cells
2981to be included as raw Markdown blocks (allowing lossless
2982round-tripping) rather than being parsed. Use this only
2983when you are targetting `ipynb` or a markdown-based
2986#### Extension: `citations` {#org-citations}
2988Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2991#### Extension: `ntb` ####
2993In the `context` output format this enables the use of [Natural Tables
2994(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2995[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2996Natural tables allow more fine-grained global customization but come
2997at a performance penalty compared to extreme tables.
3002Pandoc understands an extended and slightly revised version of
3003John Gruber's [Markdown] syntax. This document explains the syntax,
3004noting differences from standard Markdown. Except where noted, these
3005differences can be suppressed by using the `markdown_strict` format instead
3006of `markdown`. Extensions can be enabled or disabled to specify the
3007behavior more granularly. They are described in the following. See also
3008[Extensions] above, for extensions that work also on other formats.
3012Markdown is designed to be easy to write, and, even more importantly,
3015> A Markdown-formatted document should be publishable as-is, as plain
3016> text, without looking like it's been marked up with tags or formatting
3018> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3020This principle has guided pandoc's decisions in finding syntax for
3021tables, footnotes, and other extensions.
3023There is, however, one respect in which pandoc's aims are different
3024from the original aims of Markdown. Whereas Markdown was originally
3025designed with HTML generation in mind, pandoc is designed for multiple
3026output formats. Thus, while pandoc allows the embedding of raw HTML,
3027it discourages it, and provides other, non-HTMLish ways of representing
3028important document elements like definition lists, tables, mathematics, and
3033A paragraph is one or more lines of text followed by one or more blank lines.
3034Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3035If you need a hard line break, put two or more spaces at the end of a line.
3037#### Extension: `escaped_line_breaks` ####
3039A backslash followed by a newline is also a hard line break.
3040Note: in multiline and grid table cells, this is the only way
3041to create a hard line break, since trailing spaces in the cells
3046There are two kinds of headings: Setext and ATX.
3048### Setext-style headings ###
3050A setext-style heading is a line of text "underlined" with a row of `=` signs
3051(for a level-one heading) or `-` signs (for a level-two heading):
3059The heading text can contain inline formatting, such as emphasis (see
3060[Inline formatting], below).
3063### ATX-style headings ###
3065An ATX-style heading consists of one to six `#` signs and a line of
3066text, optionally followed by any number of `#` signs. The number of
3067`#` signs at the beginning of the line is the heading level:
3069 ## A level-two heading
3071 ### A level-three heading ###
3073As with setext-style headings, the heading text can contain formatting:
3075 # A level-one heading with a [link](/url) and *emphasis*
3077#### Extension: `blank_before_header` ####
3079Standard Markdown syntax does not require a blank line before a heading.
3080Pandoc does require this (except, of course, at the beginning of the
3081document). The reason for the requirement is that it is all too easy for a
3082`#` to end up at the beginning of a line by accident (perhaps through line
3083wrapping). Consider, for example:
3085 I like several of their flavors of ice cream:
3086 #22, for example, and #5.
3088#### Extension: `space_in_atx_header` ####
3090Many Markdown implementations do not require a space between the
3091opening `#`s of an ATX heading and the heading text, so that
3092`#5 bolt` and `#hashtag` count as headings. With this extension,
3093pandoc does require the space.
3095### Heading identifiers ###
3097See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3099#### Extension: `header_attributes` ####
3101Headings can be assigned attributes using this syntax at the end
3102of the line containing the heading text:
3104 {#identifier .class .class key=value key=value}
3106Thus, for example, the following headings will all be assigned the identifier
3111 ## My heading ## {#foo}
3113 My other heading {#foo}
3116(This syntax is compatible with [PHP Markdown Extra].)
3118Note that although this syntax allows assignment of classes and key/value
3119attributes, writers generally don't use all of this information. Identifiers,
3120classes, and key/value attributes are used in HTML and HTML-based formats such
3121as EPUB and slidy. Identifiers are used for labels and link anchors in the
3122LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3124Headings with the class `unnumbered` will not be numbered, even if
3125`--number-sections` is specified. A single hyphen (`-`) in an attribute
3126context is equivalent to `.unnumbered`, and preferable in non-English
3133 # My heading {.unnumbered}
3135If the `unlisted` class is present in addition to `unnumbered`,
3136the heading will not be included in a table of contents.
3137(Currently this feature is only implemented for certain
3138formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3140#### Extension: `implicit_header_references` ####
3142Pandoc behaves as if reference links have been defined for each heading.
3143So, to link to a heading
3145 # Heading identifiers in HTML
3149 [Heading identifiers in HTML]
3153 [Heading identifiers in HTML][]
3157 [the section on heading identifiers][heading identifiers in
3160instead of giving the identifier explicitly:
3162 [Heading identifiers in HTML](#heading-identifiers-in-html)
3164If there are multiple headings with identical text, the corresponding
3165reference will link to the first one only, and you will need to use explicit
3166links to link to the others, as described above.
3168Like regular reference links, these references are case-insensitive.
3170Explicit link reference definitions always take priority over
3171implicit heading references. So, in the following example, the
3172link will point to `bar`, not to `#foo`:
3182Markdown uses email conventions for quoting blocks of text.
3183A block quotation is one or more paragraphs or other block elements
3184(such as lists or headings), with each line preceded by a `>` character
3185and an optional space. (The `>` need not start at the left margin, but
3186it should not be indented more than three spaces.)
3188 > This is a block quote. This
3189 > paragraph has two lines.
3191 > 1. This is a list inside a block quote.
3194A "lazy" form, which requires the `>` character only on the first
3195line of each block, is also allowed:
3197 > This is a block quote. This
3198 paragraph has two lines.
3200 > 1. This is a list inside a block quote.
3203Among the block elements that can be contained in a block quote are
3204other block quotes. That is, block quotes can be nested:
3206 > This is a block quote.
3208 > > A block quote within a block quote.
3210If the `>` character is followed by an optional space, that space
3211will be considered part of the block quote marker and not part of
3212the indentation of the contents. Thus, to put an indented code
3213block in a block quote, you need five spaces after the `>`:
3217#### Extension: `blank_before_blockquote` ####
3219Standard Markdown syntax does not require a blank line before a block
3220quote. Pandoc does require this (except, of course, at the beginning of the
3221document). The reason for the requirement is that it is all too easy for a
3222`>` to end up at the beginning of a line by accident (perhaps through line
3223wrapping). So, unless the `markdown_strict` format is used, the following does
3224not produce a nested block quote in pandoc:
3226 > This is a block quote.
3230## Verbatim (code) blocks
3232### Indented code blocks ###
3234A block of text indented four spaces (or one tab) is treated as verbatim
3235text: that is, special characters do not trigger special formatting,
3236and all spaces and line breaks are preserved. For example,
3239 moveShip(5 * gravity, DOWN);
3242The initial (four space or one tab) indentation is not considered part
3243of the verbatim text, and is removed in the output.
3245Note: blank lines in the verbatim text need not begin with four spaces.
3248### Fenced code blocks ###
3250#### Extension: `fenced_code_blocks` ####
3252In addition to standard indented code blocks, pandoc supports
3253*fenced* code blocks. These begin with a row of three or more
3254tildes (`~`) and end with a row of tildes that must be at least as long as
3255the starting row. Everything between these lines is treated as code. No
3256indentation is necessary:
3260 moveShip(5 * gravity, DOWN);
3264Like regular code blocks, fenced code blocks must be separated
3265from surrounding text by blank lines.
3267If the code itself contains a row of tildes or backticks, just use a longer
3268row of tildes or backticks at the start and end:
3272 code including tildes
3276#### Extension: `backtick_code_blocks` ####
3278Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3281#### Extension: `fenced_code_attributes` ####
3283Optionally, you may attach attributes to fenced or backtick code block using
3286 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3288 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3289 qsort (filter (>= x) xs)
3290 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3292Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3293`startFrom` is an attribute with value `100`. Some output formats can use this
3294information to do syntax highlighting. Currently, the only output formats
3295that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3296highlighting is supported for your output format and language, then the code
3297block above will appear highlighted, with numbered lines. (To see which
3298languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3299the code block above will appear as follows:
3301 <pre id="mycode" class="haskell numberLines" startFrom="100">
3307The `numberLines` (or `number-lines`) class will cause the lines
3308of the code block to be numbered, starting with `1` or the value
3309of the `startFrom` attribute. The `lineAnchors` (or
3310`line-anchors`) class will cause the lines to be clickable
3311anchors in HTML output.
3313A shortcut form can also be used for specifying the language of
3320This is equivalent to:
3326If the `fenced_code_attributes` extension is disabled, but
3327input contains class attribute(s) for the code block, the first
3328class attribute will be printed after the opening fence as a bare
3331To prevent all highlighting, use the `--no-highlight` flag.
3332To set the highlighting style, use `--highlight-style`.
3333For more information on highlighting, see [Syntax highlighting],
3338#### Extension: `line_blocks` ####
3340A line block is a sequence of lines beginning with a vertical bar (`|`)
3341followed by a space. The division into lines will be preserved in
3342the output, as will any leading spaces; otherwise, the lines will
3343be formatted as Markdown. This is useful for verse and addresses:
3345 | The limerick packs laughs anatomical
3346 | In space that is quite economical.
3347 | But the good ones I've seen
3348 | So seldom are clean
3349 | And the clean ones so seldom are comical
3352 | Berkeley, CA 94718
3354The lines can be hard-wrapped if needed, but the continuation
3355line must begin with a space.
3357 | The Right Honorable Most Venerable and Righteous Samuel L.
3360 | Berkeley, CA 94718
3362This syntax is borrowed from [reStructuredText].
3368A bullet list is a list of bulleted list items. A bulleted list
3369item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3376This will produce a "compact" list. If you want a "loose" list, in which
3377each item is formatted as a paragraph, put spaces between the items:
3385The bullets need not be flush with the left margin; they may be
3386indented one, two, or three spaces. The bullet must be followed
3389List items look best if subsequent lines are flush with the first
3390line (after the bullet):
3396But Markdown also allows a "lazy" format:
3402### Block content in list items ###
3404A list item may contain multiple paragraphs and other block-level
3405content. However, subsequent paragraphs must be preceded by a blank line
3406and indented to line up with the first non-space content after
3413 * Second paragraph. With a code block, which must be indented
3418Exception: if the list marker is followed by an indented code
3419block, which must begin 5 spaces after the list marker, then
3420subsequent paragraphs must begin two columns after the last
3421character of the list marker:
3425 continuation paragraph
3427List items may include other lists. In this case the preceding blank
3428line is optional. The nested list must be indented to line up with
3429the first non-space character after the list marker of the
3430containing list item.
3442As noted above, Markdown allows you to write list items "lazily," instead of
3443indenting continuation lines. However, if there are multiple paragraphs or
3444other blocks in a list item, the first line of each must be indented.
3446 + A lazy, lazy, list
3449 + Another one; this looks
3452 Second paragraph of second
3455### Ordered lists ###
3457Ordered lists work just like bulleted lists, except that the items
3458begin with enumerators rather than bullets.
3460In standard Markdown, enumerators are decimal numbers followed
3461by a period and a space. The numbers themselves are ignored, so
3462there is no difference between this list:
3474#### Extension: `fancy_lists` ####
3476Unlike standard Markdown, pandoc allows ordered list items to be marked
3477with uppercase and lowercase letters and roman numerals, in addition to
3478Arabic numerals. List markers may be enclosed in parentheses or followed by a
3479single right-parentheses or period. They must be separated from the
3480text that follows by at least one space, and, if the list marker is a
3481capital letter with a period, by at least two spaces.[^2]
3483[^2]: The point of this rule is to ensure that normal paragraphs
3484 starting with people's initials, like
3486 B. Russell was an English philosopher.
3488 do not get treated as list items.
3490 This rule will not prevent
3494 from being interpreted as a list item. In this case, a backslash
3499The `fancy_lists` extension also allows '`#`' to be used as an
3500ordered list marker in place of a numeral:
3505#### Extension: `startnum` ####
3507Pandoc also pays attention to the type of list marker used, and to the
3508starting number, and both of these are preserved where possible in the
3509output format. Thus, the following yields a list with numbers followed
3510by a single parenthesis, starting with 9, and a sublist with lowercase
3520Pandoc will start a new list each time a different type of list
3521marker is used. So, the following will create three lists:
3528If default list markers are desired, use `#.`:
3534#### Extension: `task_lists` ####
3536Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3538 - [ ] an unchecked task list item
3541### Definition lists ###
3543#### Extension: `definition_lists` ####
3545Pandoc supports definition lists, using the syntax of
3546[PHP Markdown Extra] with some extensions.[^3]
3552 Term 2 with *inline markup*
3556 { some code, part of Definition 2 }
3558 Third paragraph of definition 2.
3560Each term must fit on one line, which may optionally be followed by
3561a blank line, and must be followed by one or more definitions.
3562A definition begins with a colon or tilde, which may be indented one
3565A term may have multiple definitions, and each definition may consist of one or
3566more block elements (paragraph, code block, list, etc.), each indented four
3567spaces or one tab stop. The body of the definition (including the first line,
3568aside from the colon or tilde) should be indented four spaces. However,
3569as with other Markdown lists, you can "lazily" omit indentation except
3570at the beginning of a paragraph or other block element:
3575 with lazy continuation.
3577 Second paragraph of the definition.
3579If you leave space before the definition (as in the example above),
3580the text of the definition will be treated as a paragraph. In some
3581output formats, this will mean greater spacing between term/definition
3582pairs. For a more compact definition list, omit the space before the
3592Note that space between items in a definition list is required.
3593(A variant that loosens this requirement, but disallows "lazy"
3594hard wrapping, can be activated with `compact_definition_lists`: see
3595[Non-pandoc extensions], below.)
3597[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3599### Numbered example lists ###
3601#### Extension: `example_lists` ####
3603The special list marker `@` can be used for sequentially numbered
3604examples. The first list item with a `@` marker will be numbered '1',
3605the next '2', and so on, throughout the document. The numbered examples
3606need not occur in a single list; each new list using `@` will take up
3607where the last stopped. So, for example:
3609 (@) My first example will be numbered (1).
3610 (@) My second example will be numbered (2).
3612 Explanation of examples.
3614 (@) My third example will be numbered (3).
3616Numbered examples can be labeled and referred to elsewhere in the
3619 (@good) This is a good example.
3621 As (@good) illustrates, ...
3623The label can be any string of alphanumeric characters, underscores,
3626Note: continuation paragraphs in example lists must always
3627be indented four spaces, regardless of the length of the
3628list marker. That is, example lists always behave as if the
3629`four_space_rule` extension is set. This is because example
3630labels tend to be long, and indenting content to the
3631first non-space character after the label would be awkward.
3634### Ending a list ###
3636What if you want to put an indented code block after a list?
3643Trouble! Here pandoc (like other Markdown implementations) will treat
3644`{ my code block }` as the second paragraph of item two, and not as
3647To "cut off" the list after item two, you can insert some non-indented
3648content, like an HTML comment, which won't produce visible output in
3654 <!-- end of list -->
3658You can use the same trick if you want two consecutive lists instead
3673A line containing a row of three or more `*`, `-`, or `_` characters
3674(optionally separated by spaces) produces a horizontal rule:
3683Four kinds of tables may be used. The first three kinds presuppose the use of
3684a fixed-width font, such as Courier. The fourth kind can be used with
3685proportionally spaced fonts, as it does not require lining up columns.
3687#### Extension: `table_captions` ####
3689A caption may optionally be provided with all 4 kinds of tables (as
3690illustrated in the examples below). A caption is a paragraph beginning
3691with the string `Table:` (or just `:`), which will be stripped off.
3692It may appear either before or after the table.
3694#### Extension: `simple_tables` ####
3696Simple tables look like this:
3698 Right Left Center Default
3699 ------- ------ ---------- -------
3704 Table: Demonstration of simple table syntax.
3706The header and table rows must each fit on one line. Column
3707alignments are determined by the position of the header text relative
3708to the dashed line below it:[^4]
3710 - If the dashed line is flush with the header text on the right side
3711 but extends beyond it on the left, the column is right-aligned.
3712 - If the dashed line is flush with the header text on the left side
3713 but extends beyond it on the right, the column is left-aligned.
3714 - If the dashed line extends beyond the header text on both sides,
3715 the column is centered.
3716 - If the dashed line is flush with the header text on both sides,
3717 the default alignment is used (in most cases, this will be left).
3719[^4]: This scheme is due to Michel Fortin, who proposed it on the
3720 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3722The table must end with a blank line, or a line of dashes followed by
3725The column header row may be omitted, provided a dashed line is used
3726to end the table. For example:
3728 ------- ------ ---------- -------
3732 ------- ------ ---------- -------
3734When the header row is omitted, column alignments are determined on the basis
3735of the first line of the table body. So, in the tables above, the columns
3736would be right, left, center, and right aligned, respectively.
3738#### Extension: `multiline_tables` ####
3740Multiline tables allow header and table rows to span multiple lines
3741of text (but cells that span multiple columns or rows of the table are
3742not supported). Here is an example:
3744 -------------------------------------------------------------
3745 Centered Default Right Left
3746 Header Aligned Aligned Aligned
3747 ----------- ------- --------------- -------------------------
3748 First row 12.0 Example of a row that
3749 spans multiple lines.
3751 Second row 5.0 Here's another one. Note
3752 the blank line between
3754 -------------------------------------------------------------
3756 Table: Here's the caption. It, too, may span
3759These work like simple tables, but with the following differences:
3761 - They must begin with a row of dashes, before the header text
3762 (unless the header row is omitted).
3763 - They must end with a row of dashes, then a blank line.
3764 - The rows must be separated by blank lines.
3766In multiline tables, the table parser pays attention to the widths of
3767the columns, and the writers try to reproduce these relative widths in
3768the output. So, if you find that one of the columns is too narrow in the
3769output, try widening it in the Markdown source.
3771The header may be omitted in multiline tables as well as simple tables:
3773 ----------- ------- --------------- -------------------------
3774 First row 12.0 Example of a row that
3775 spans multiple lines.
3777 Second row 5.0 Here's another one. Note
3778 the blank line between
3780 ----------- ------- --------------- -------------------------
3782 : Here's a multiline table without a header.
3784It is possible for a multiline table to have just one row, but the row
3785should be followed by a blank line (and then the row of dashes that ends
3786the table), or the table may be interpreted as a simple table.
3788#### Extension: `grid_tables` ####
3790Grid tables look like this:
3792 : Sample grid table.
3794 +---------------+---------------+--------------------+
3795 | Fruit | Price | Advantages |
3796 +===============+===============+====================+
3797 | Bananas | $1.34 | - built-in wrapper |
3798 | | | - bright color |
3799 +---------------+---------------+--------------------+
3800 | Oranges | $2.10 | - cures scurvy |
3802 +---------------+---------------+--------------------+
3804The row of `=`s separates the header from the table body, and can be
3805omitted for a headerless table. The cells of grid tables may contain
3806arbitrary block elements (multiple paragraphs, code blocks, lists,
3807etc.). Cells that span multiple columns or rows are not
3808supported. Grid tables can be created easily using Emacs' table-mode
3809(`M-x table-insert`).
3811Alignments can be specified as with pipe tables, by putting
3812colons at the boundaries of the separator line after the
3815 +---------------+---------------+--------------------+
3816 | Right | Left | Centered |
3817 +==============:+:==============+:==================:+
3818 | Bananas | $1.34 | built-in wrapper |
3819 +---------------+---------------+--------------------+
3821For headerless tables, the colons go on the top line instead:
3823 +--------------:+:--------------+:------------------:+
3824 | Right | Left | Centered |
3825 +---------------+---------------+--------------------+
3827##### Grid Table Limitations #####
3829Pandoc does not support grid tables with row spans or column spans.
3830This means that neither variable numbers of columns across rows nor
3831variable numbers of rows across columns are supported by Pandoc.
3832All grid tables must have the same number of columns in each row,
3833and the same number of rows in each column. For example, the
3834Docutils [sample grid tables] will not render as expected with
3837[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3840#### Extension: `pipe_tables` ####
3842Pipe tables look like this:
3844 | Right | Left | Default | Center |
3845 |------:|:-----|---------|:------:|
3846 | 12 | 12 | 12 | 12 |
3847 | 123 | 123 | 123 | 123 |
3850 : Demonstration of pipe table syntax.
3852The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3853ending pipe characters are optional, but pipes are required between all
3854columns. The colons indicate column alignment as shown. The header
3855cannot be omitted. To simulate a headerless table, include a header
3858Since the pipes indicate column boundaries, columns need not be vertically
3859aligned, as they are in the above example. So, this is a perfectly
3860legal (though ugly) pipe table:
3868The cells of pipe tables cannot contain block elements like paragraphs
3869and lists, and cannot span multiple lines. If a pipe table contains a
3870row whose Markdown content is wider than the column width (see
3871`--columns`), then the table will take up the full text width and
3872the cell contents will wrap, with the relative cell widths determined
3873by the number of dashes in the line separating the table header from
3874the table body. (For example `---|-` would make the first column 3/4
3875and the second column 1/4 of the full text width.)
3876On the other hand, if no lines are wider than column width, then
3877cell contents will not be wrapped, and the cells will be sized
3880Note: pandoc also recognizes pipe tables of the following
3881form, as can be produced by Emacs' orgtbl-mode:
3888The difference is that `+` is used instead of `|`. Other orgtbl features
3889are not supported. In particular, to get non-default column alignment,
3890you'll need to add colons as above.
3892[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3896#### Extension: `pandoc_title_block` ####
3898If the file begins with a title block
3901 % author(s) (separated by semicolons)
3904it will be parsed as bibliographic information, not regular text. (It
3905will be used, for example, in the title of standalone LaTeX or HTML
3906output.) The block may contain just a title, a title and an author,
3907or all three elements. If you want to include an author but no
3908title, or a title and a date but no author, you need a blank line:
3921The title may occupy multiple lines, but continuation lines must
3922begin with leading space, thus:
3929If a document has multiple authors, the authors may be put on
3930separate lines with leading space, or separated by semicolons, or
3931both. So, all of the following are equivalent:
3939% Author One; Author Two
3947The date must fit on one line.
3949All three metadata fields may contain standard inline formatting
3950(italics, links, footnotes, etc.).
3952Title blocks will always be parsed, but they will affect the output only
3953when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3954will appear twice: once in the document head -- this is the title that
3955will appear at the top of the window in a browser -- and once at the
3956beginning of the document body. The title in the document head can have
3957an optional prefix attached (`--title-prefix` or `-T` option). The title
3958in the body appears as an H1 element with class "title", so it can be
3959suppressed or reformatted with CSS. If a title prefix is specified with
3960`-T` and no title block appears in the document, the title prefix will
3961be used by itself as the HTML title.
3963The man page writer extracts a title, man page section number, and
3964other header and footer information from the title line. The title
3965is assumed to be the first word on the title line, which may optionally
3966end with a (single-digit) section number in parentheses. (There should
3967be no space between the title and the parentheses.) Anything after
3968this is assumed to be additional footer and header text. A single pipe
3969character (`|`) should be used to separate the footer text from the header
3974will yield a man page with the title `PANDOC` and section 1.
3976 % PANDOC(1) Pandoc User Manuals
3978will also have "Pandoc User Manuals" in the footer.
3980 % PANDOC(1) Pandoc User Manuals | Version 4.0
3982will also have "Version 4.0" in the header.
3984#### Extension: `yaml_metadata_block` ####
3986A [YAML] metadata block is a valid YAML object, delimited by a line of three
3987hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3988(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3989document, but if it is not at the beginning, it must be preceded by a blank
3990line. (Note that, because of the way pandoc concatenates input files when
3991several are provided, you may also keep the metadata in a separate YAML file
3992and pass it to pandoc as an argument, along with your Markdown files:
3994 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3996Just be sure that the YAML file begins with `---` and ends with `---` or
3997`...`.) Alternatively, you can use the `--metadata-file` option. Using
3998that approach however, you cannot reference content (like footnotes)
3999from the main markdown input document.
4001Metadata will be taken from the fields of the YAML object and added to any
4002existing document metadata. Metadata can contain lists and objects (nested
4003arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4004with names ending in an underscore will be ignored by pandoc. (They may be
4005given a role by external processors.) Field names must not be
4006interpretable as YAML numbers or boolean values (so, for
4007example, `yes`, `True`, and `15` cannot be used as field names).
4009A document may contain multiple metadata blocks. If two
4010metadata blocks attempt to set the same field, the value from
4011the second block will be taken.
4013When pandoc is used with `-t markdown` to create a Markdown document,
4014a YAML metadata block will be produced only if the `-s/--standalone`
4015option is used. All of the metadata will appear in a single block
4016at the beginning of the document.
4018Note that [YAML] escaping rules must be followed. Thus, for example,
4019if a title contains a colon, it must be quoted. The pipe character
4020(`|`) can be used to begin an indented block that will be interpreted
4021literally, without need for escaping. This form is necessary
4022when the field contains blank lines or block-level formatting:
4025 title: 'This is the title: it contains a colon'
4029 keywords: [nothing, nothingness]
4031 This is the abstract.
4033 It consists of two paragraphs.
4036Template variables will be set automatically from the metadata. Thus, for
4037example, in writing HTML, the variable `abstract` will be set to the HTML
4038equivalent of the Markdown in the `abstract` field:
4040 <p>This is the abstract.</p>
4041 <p>It consists of two paragraphs.</p>
4043Variables can contain arbitrary YAML structures, but the template must match
4044this structure. The `author` variable in the default templates expects a
4045simple list or string, but can be changed to support more complicated
4046structures. The following combination, for example, would add an affiliation
4047to the author if one is given:
4050 title: The document title
4053 affiliation: University of Somewhere
4055 affiliation: University of Nowhere
4058To use the structured authors in the example above, you would need a custom
4063 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4069Raw content to include in the document's header may be specified
4070using `header-includes`; however, it is important to mark up
4071this content as raw code for a particular output format, using
4072the [`raw_attribute` extension](#extension-raw_attribute)), or it
4073will be interpreted as markdown. For example:
4078 \let\oldsection\section
4079 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4084#### Extension: `all_symbols_escapable` ####
4086Except inside a code block or inline code, any punctuation or space
4087character preceded by a backslash will be treated literally, even if it
4088would normally indicate formatting. Thus, for example, if one writes
4098 <strong>hello</strong>
4100This rule is easier to remember than standard Markdown's rule,
4101which allows only the following characters to be backslash-escaped:
4105(However, if the `markdown_strict` format is used, the standard Markdown rule
4108A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4109it will appear as `~`. In HTML and XML output, it will appear as a
4110literal unicode nonbreaking space character (note that it will thus
4111actually look "invisible" in the generated HTML source; you can still
4112use the `--ascii` command-line option to make it appear as an explicit
4115A backslash-escaped newline (i.e. a backslash occurring at the end of
4116a line) is parsed as a hard line break. It will appear in TeX output as
4117`\\` and in HTML as `<br />`. This is a nice alternative to
4118Markdown's "invisible" way of indicating hard line breaks using
4119two trailing spaces on a line.
4121Backslash escapes do not work in verbatim contexts.
4127To *emphasize* some text, surround it with `*`s or `_`, like this:
4129 This text is _emphasized with underscores_, and this
4130 is *emphasized with asterisks*.
4132Double `*` or `_` produces **strong emphasis**:
4134 This is **strong emphasis** and __with underscores__.
4136A `*` or `_` character surrounded by spaces, or backslash-escaped,
4137will not trigger emphasis:
4139 This is * not emphasized *, and \*neither is this\*.
4141#### Extension: `intraword_underscores` ####
4143Because `_` is sometimes used inside words and identifiers,
4144pandoc does not interpret a `_` surrounded by alphanumeric
4145characters as an emphasis marker. If you want to emphasize
4146just part of a word, use `*`:
4148 feas*ible*, not feas*able*.
4153#### Extension: `strikeout` ####
4155To strikeout a section of text with a horizontal line, begin and end it
4156with `~~`. Thus, for example,
4158 This ~~is deleted text.~~
4161### Superscripts and subscripts ###
4163#### Extension: `superscript`, `subscript` ####
4165Superscripts may be written by surrounding the superscripted text by `^`
4166characters; subscripts may be written by surrounding the subscripted
4167text by `~` characters. Thus, for example,
4169 H~2~O is a liquid. 2^10^ is 1024.
4171The text between `^...^` or `~...~` may not contain spaces or
4172newlines. If the superscripted or subscripted text contains
4173spaces, these spaces must be escaped with backslashes. (This is
4174to prevent accidental superscripting and subscripting through
4175the ordinary use of `~` and `^`, and also bad interactions with
4176footnotes.) Thus, if you want the letter P with 'a cat' in
4177subscripts, use `P~a\ cat~`, not `P~a cat~`.
4181To make a short span of text verbatim, put it inside backticks:
4183 What is the difference between `>>=` and `>>`?
4185If the verbatim text includes a backtick, use double backticks:
4187 Here is a literal backtick `` ` ``.
4189(The spaces after the opening backticks and before the closing
4190backticks will be ignored.)
4192The general rule is that a verbatim span starts with a string
4193of consecutive backticks (optionally followed by a space)
4194and ends with a string of the same number of backticks (optionally
4195preceded by a space).
4197Note that backslash-escapes (and other Markdown constructs) do not
4198work in verbatim contexts:
4200 This is a backslash followed by an asterisk: `\*`.
4202#### Extension: `inline_code_attributes` ####
4204Attributes can be attached to verbatim text, just as with
4205[fenced code blocks]:
4211To write small caps, use the `smallcaps` class:
4213 [Small caps]{.smallcaps}
4215Or, without the `bracketed_spans` extension:
4217 <span class="smallcaps">Small caps</span>
4219For compatibility with other Markdown flavors, CSS is also supported:
4221 <span style="font-variant:small-caps;">Small caps</span>
4223This will work in all output formats that support small caps.
4228#### Extension: `tex_math_dollars` ####
4230Anything between two `$` characters will be treated as TeX math. The
4231opening `$` must have a non-space character immediately to its right,
4232while the closing `$` must have a non-space character immediately to its
4233left, and must not be followed immediately by a digit. Thus,
4234`$20,000 and $30,000` won't parse as math. If for some reason
4235you need to enclose text in literal `$` characters, backslash-escape
4236them and they won't be treated as math delimiters.
4238For display math, use `$$` delimiters. (In this case, the delimiters
4239may be separated from the formula by whitespace.)
4241TeX math will be printed in all output formats. How it is rendered
4242depends on the output format:
4245 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4246 math) or `\[...\]` (for display math).
4248Markdown, Emacs Org mode, ConTeXt, ZimWiki
4249 ~ It will appear verbatim surrounded by `$...$` (for inline
4250 math) or `$$...$$` (for display math).
4253 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4256 ~ It will be rendered using an [interpreted text role `:math:`].
4259 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4260 surrounded by `latexmath:[$...$]` (for inline math) or
4261 `[latexmath]++++\[...\]+++` (for display math).
4262 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4263 (`$..$` and `\[..\]`) are omitted.
4266 ~ It will be rendered inside a `@math` command.
4268roff man, Jira markup
4269 ~ It will be rendered verbatim without `$`'s.
4272 ~ It will be rendered inside `<math>` tags.
4275 ~ It will be rendered inside `<span class="math">` tags.
4278 ~ It will be rendered, if possible, using Unicode characters,
4279 and will otherwise appear verbatim.
4282 ~ It will be rendered, if possible, using MathML.
4285 ~ If the `--mathml` flag is used, it will be rendered using MathML
4286 in an `inlineequation` or `informalequation` tag. Otherwise it
4287 will be rendered, if possible, using Unicode characters.
4290 ~ It will be rendered using OMML math markup.
4293 ~ If the `--webtex` option is used, formulas are rendered as images
4294 using CodeCogs or other compatible web service, downloaded
4295 and embedded in the e-book. Otherwise, they will appear verbatim.
4297HTML, Slidy, DZSlides, S5, EPUB
4298 ~ The way math is rendered in HTML will depend on the
4299 command-line options selected. Therefore see [Math rendering in HTML]
4302[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4306#### Extension: `raw_html` ####
4308Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4309(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4310literally). (Technically this is not an extension, since standard
4311Markdown allows it, but it has been made an extension so that it can
4312be disabled if desired.)
4314The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4315DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4316output, and suppressed in other formats.
4318For a more explicit way of including raw HTML in a Markdown
4319document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4321In the CommonMark format, if `raw_html` is enabled, superscripts,
4322subscripts, strikeouts and small capitals will be represented as HTML.
4323Otherwise, plain-text fallbacks will be used. Note that even if
4324`raw_html` is disabled, tables will be rendered with HTML syntax if
4325they cannot use pipe syntax.
4327#### Extension: `markdown_in_html_blocks` ####
4329Standard Markdown allows you to include HTML "blocks": blocks
4330of HTML between balanced tags that are separated from the surrounding text
4331with blank lines, and start and end at the left margin. Within
4332these blocks, everything is interpreted as HTML, not Markdown;
4333so (for example), `*` does not signify emphasis.
4335Pandoc behaves this way when the `markdown_strict` format is used; but
4336by default, pandoc interprets material between HTML block tags as Markdown.
4337Thus, for example, pandoc will turn
4342 <td>[a link](https://google.com)</td>
4350 <td><em>one</em></td>
4351 <td><a href="https://google.com">a link</a></td>
4355whereas `Markdown.pl` will preserve it as is.
4357There is one exception to this rule: text between `<script>` and
4358`<style>` tags is not interpreted as Markdown.
4360This departure from standard Markdown should make it easier to mix
4361Markdown with HTML block elements. For example, one can surround
4362a block of Markdown text with `<div>` tags without preventing it
4363from being interpreted as Markdown.
4365#### Extension: `native_divs` ####
4367Use native pandoc `Div` blocks for content inside `<div>` tags.
4368For the most part this should give the same output as
4369`markdown_in_html_blocks`, but it makes it easier to write pandoc
4370filters to manipulate groups of blocks.
4372#### Extension: `native_spans` ####
4374Use native pandoc `Span` blocks for content inside `<span>` tags.
4375For the most part this should give the same output as `raw_html`,
4376but it makes it easier to write pandoc filters to manipulate groups
4379#### Extension: `raw_tex` ####
4381In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4382included in a document. Inline TeX commands will be preserved and passed
4383unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4384LaTeX to include BibTeX citations:
4386 This result was proved in \cite{jones.1967}.
4388Note that in LaTeX environments, like
4390 \begin{tabular}{|l|l|}\hline
4391 Age & Frequency \\ \hline
4394 36--45 & 22 \\ \hline
4397the material between the begin and end tags will be interpreted as raw
4398LaTeX, not as Markdown.
4400For a more explicit and flexible way of including raw TeX in a
4401Markdown document, see the [`raw_attribute`
4402extension][Extension: `raw_attribute`].
4404Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4405Emacs Org mode, and ConTeXt.
4407### Generic raw attribute ###
4409#### Extension: `raw_attribute` ####
4411Inline spans and fenced code blocks with a special
4412kind of attribute will be parsed as raw content with the
4413designated format. For example, the following produces a raw
4420And the following produces a raw `html` inline element:
4422 This is `<a>html</a>`{=html}
4424This can be useful to insert raw xml into `docx` documents, e.g.
4430 <w:br w:type="page"/>
4435The format name should match the target format name (see
4436`-t/--to`, above, for a list, or use `pandoc
4437--list-output-formats`). Use `openxml` for `docx` output,
4438`opendocument` for `odt` output, `html5` for `epub3` output,
4439`html4` for `epub2` output, and `latex`, `beamer`,
4440`ms`, or `html5` for `pdf` output (depending on what you
4441use for `--pdf-engine`).
4443This extension presupposes that the relevant kind of
4444inline code or fenced code block is enabled. Thus, for
4445example, to use a raw attribute with a backtick code block,
4446`backtick_code_blocks` must be enabled.
4448The raw attribute cannot be combined with regular attributes.
4452#### Extension: `latex_macros` ####
4454When this extension is enabled, pandoc will parse LaTeX
4455macro definitions and apply the resulting macros to all LaTeX
4456math and raw LaTeX. So, for example, the following will work in
4457all output formats, not just LaTeX:
4459 \newcommand{\tuple}[1]{\langle #1 \rangle}
4463Note that LaTeX macros will not be applied if they occur
4464inside a raw span or block marked with the
4465[`raw_attribute` extension](#extension-raw_attribute).
4467When `latex_macros` is disabled, the raw LaTeX and math will
4468not have macros applied. This is usually a better approach when
4469you are targeting LaTeX or PDF.
4471Macro definitions in LaTeX will be passed through as raw LaTeX
4472only if `latex_macros` is not enabled. Macro definitions in
4473Markdown source (or other formats allowing `raw_tex`) will
4474be passed through regardless of whether `latex_macros` is
4479Markdown allows links to be specified in several ways.
4481### Automatic links ###
4483If you enclose a URL or email address in pointy brackets, it
4486 <https://google.com>
4487 <sam@green.eggs.ham>
4491An inline link consists of the link text in square brackets,
4492followed by the URL in parentheses. (Optionally, the URL can
4493be followed by a link title, in quotes.)
4495 This is an [inline link](/url), and here's [one with
4496 a title](https://fsf.org "click here for a good time!").
4498There can be no space between the bracketed part and the parenthesized part.
4499The link text can contain formatting (such as emphasis), but the title cannot.
4501Email addresses in inline links are not autodetected, so they have to be
4502prefixed with `mailto`:
4504 [Write me!](mailto:sam@green.eggs.ham)
4506### Reference links ###
4508An *explicit* reference link has two parts, the link itself and the link
4509definition, which may occur elsewhere in the document (either
4510before or after the link).
4512The link consists of link text in square brackets, followed by a label in
4513square brackets. (There cannot be space between the two unless the
4514`spaced_reference_links` extension is enabled.) The link definition
4515consists of the bracketed label, followed by a colon and a space, followed by
4516the URL, and optionally (after a space) a link title either in quotes or in
4517parentheses. The label must not be parseable as a citation (assuming
4518the `citations` extension is enabled): citations take precedence over
4521Here are some examples:
4523 [my label 1]: /foo/bar.html "My title, optional"
4525 [my label 3]: https://fsf.org (The free software foundation)
4526 [my label 4]: /bar#special 'A title in single quotes'
4528The URL may optionally be surrounded by angle brackets:
4530 [my label 5]: <http://foo.bar.baz>
4532The title may go on the next line:
4534 [my label 3]: https://fsf.org
4535 "The free software foundation"
4537Note that link labels are not case sensitive. So, this will work:
4539 Here is [my link][FOO]
4543In an *implicit* reference link, the second pair of brackets is
4548 [my website]: http://foo.bar.baz
4550Note: In `Markdown.pl` and most other Markdown implementations,
4551reference link definitions cannot occur in nested constructions
4552such as list items or block quotes. Pandoc lifts this arbitrary
4553seeming restriction. So the following is fine in pandoc, though
4554not in most other implementations:
4560#### Extension: `shortcut_reference_links` ####
4562In a *shortcut* reference link, the second pair of brackets may
4567 [my website]: http://foo.bar.baz
4569### Internal links ###
4571To link to another section of the same document, use the automatically
4572generated identifier (see [Heading identifiers]). For example:
4574 See the [Introduction](#introduction).
4578 See the [Introduction].
4580 [Introduction]: #introduction
4582Internal links are currently supported for HTML formats (including
4583HTML slide shows and EPUB), LaTeX, and ConTeXt.
4587A link immediately preceded by a `!` will be treated as an image.
4588The link text will be used as the image's alt text:
4590 
4594 [movie reel]: movie.gif
4596#### Extension: `implicit_figures` ####
4598An image with nonempty alt text, occurring by itself in a
4599paragraph, will be rendered as a figure with a caption. The
4600image's alt text will be used as the caption.
4602 
4604How this is rendered depends on the output format. Some output
4605formats (e.g. RTF) do not yet support figures. In those
4606formats, you'll just get an image in a paragraph by itself, with
4609If you just want a regular inline image, just make sure it is not
4610the only thing in the paragraph. One way to do this is to insert a
4611nonbreaking space after the image:
4613 \
4615Note that in reveal.js slide shows, an image in a paragraph
4616by itself that has the `stretch` class will fill the screen,
4617and the caption and figure tags will be omitted.
4619#### Extension: `link_attributes` ####
4621Attributes can be set on links and images:
4623 An inline {#id .class width=30 height=20px}
4624 and a reference ![image][ref] with attributes.
4626 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4628(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4629and `.class` are used.)
4631For HTML and EPUB, all known HTML5 attributes except `width` and
4632`height` (but including `srcset` and `sizes`) are passed through
4633as is. Unknown attributes are passed through as custom
4634attributes, with `data-` prepended. The other writers ignore
4635attributes that are not specifically supported by their output format.
4637The `width` and `height` attributes on images are treated specially. When
4638used without a unit, the unit is assumed to be pixels. However, any of
4639the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4640and `%`. There must not be any spaces between the number and the unit.
4644{ width=50% }
4647- Dimensions may be converted to a form that is compatible with
4648 the output format (for example, dimensions given in pixels will
4649 be converted to inches when converting HTML to LaTeX). Conversion
4650 between pixels and physical measurements is affected by the
4651 `--dpi` option (by default, 96 dpi is assumed, unless the image
4652 itself contains dpi information).
4653- The `%` unit is generally relative to some available space.
4654 For example the above example will render to the following.
4655 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4656 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4657 (If you're using a custom template, you need to configure `graphicx`
4658 as in the default template.)
4659 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4660- Some output formats have a notion of a class
4661 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4662 or a unique identifier (LaTeX `\caption`), or both (HTML).
4663- When no `width` or `height` attributes are specified, the fallback
4664 is to look at the image resolution and the dpi metadata embedded in
4669Using the `native_divs` and `native_spans` extensions
4670(see [above][Extension: `native_divs`]), HTML syntax can
4671be used as part of markdown to create native `Div` and `Span`
4672elements in the pandoc AST (as opposed to raw HTML).
4673However, there is also nicer syntax available:
4675#### Extension: `fenced_divs` ####
4677Allow special fenced syntax for native `Div` blocks. A Div
4678starts with a fence containing at least three consecutive
4679colons plus some attributes. The attributes may optionally
4680be followed by another string of consecutive colons.
4681The attribute syntax is exactly as in fenced code blocks (see
4682[Extension: `fenced_code_attributes`]). As with fenced
4683code blocks, one can use either attributes in curly braces
4684or a single unbraced word, which will be treated as a class
4685name. The Div ends with another line containing a string of at
4686least three consecutive colons. The fenced Div should be
4687separated by blank lines from preceding and following blocks.
4691 ::::: {#special .sidebar}
4692 Here is a paragraph.
4697Fenced divs can be nested. Opening fences are distinguished
4698because they *must* have attributes:
4704 This is a warning within a warning.
4708Fences without attributes are always closing fences. Unlike
4709with fenced code blocks, the number of colons in the closing
4710fence need not match the number in the opening fence. However,
4711it can be helpful for visual clarity to use fences of different
4712lengths to distinguish nested divs from their parents.
4715#### Extension: `bracketed_spans` ####
4717A bracketed sequence of inlines, as one would use to begin
4718a link, will be treated as a `Span` with attributes if it is
4719followed immediately by attributes:
4721 [This is *some text*]{.class key="val"}
4725#### Extension: `footnotes` ####
4727Pandoc's Markdown allows footnotes, using the following syntax:
4729 Here is a footnote reference,[^1] and another.[^longnote]
4731 [^1]: Here is the footnote.
4733 [^longnote]: Here's one with multiple blocks.
4735 Subsequent paragraphs are indented to show that they
4736 belong to the previous footnote.
4740 The whole paragraph can be indented, or just the first
4741 line. In this way, multi-paragraph footnotes work like
4742 multi-paragraph list items.
4744 This paragraph won't be part of the note, because it
4747The identifiers in footnote references may not contain spaces, tabs,
4748or newlines. These identifiers are used only to correlate the
4749footnote reference with the note itself; in the output, footnotes
4750will be numbered sequentially.
4752The footnotes themselves need not be placed at the end of the
4753document. They may appear anywhere except inside other block elements
4754(lists, block quotes, tables, etc.). Each footnote should be
4755separated from surrounding content (including other footnotes)
4758#### Extension: `inline_notes` ####
4760Inline footnotes are also allowed (though, unlike regular notes,
4761they cannot contain multiple paragraphs). The syntax is as follows:
4763 Here is an inline note.^[Inlines notes are easier to write, since
4764 you don't have to pick an identifier and move down to type the
4767Inline and regular footnotes may be mixed freely.
4771#### Extension: `citations` ####
4773Markdown citations go inside square brackets and are separated
4774by semicolons. Each citation must have a key, composed of '@' +
4775the citation identifier from the database, and may optionally
4776have a prefix, a locator, and a suffix. The citation key must
4777begin with a letter, digit, or `_`, and may contain
4778alphanumerics, `_`, and internal punctuation characters
4779(`:.#$%&-+?<>~/`). Here are some examples:
4781 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4783 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4785 Blah blah [@smith04; @doe99].
4787`pandoc` detects locator terms in the [CSL locale files].
4788Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4789locale, locator terms can be written in either singular or plural forms,
4790as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4791`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4792`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4793`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4794`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4795`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4796locator term is used, "page" is assumed.
4798`pandoc` will use heuristics to distinguish the locator
4799from the suffix. In complex cases, the locator can be enclosed
4802 [@smith{ii, A, D-Z}, with a suffix]
4803 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4805A minus sign (`-`) before the `@` will suppress mention of
4806the author in the citation. This can be useful when the
4807author is already mentioned in the text:
4809 Smith says blah [-@smith04].
4811You can also write an in-text citation, as follows:
4815 @smith04 [p. 33] says blah.
4818[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4819[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4820[Chicago Manual of Style]: https://chicagomanualofstyle.org
4821[Citation Style Language]: https://citationstyles.org
4822[Zotero Style Repository]: https://www.zotero.org/styles
4823[finding and editing styles]: https://citationstyles.org/authors/
4824[CSL locale files]: https://github.com/citation-style-language/locales
4826## Non-pandoc extensions
4828The following Markdown syntax extensions are not enabled by default
4829in pandoc, but may be enabled by adding `+EXTENSION` to the format
4830name, where `EXTENSION` is the name of the extension. Thus, for
4831example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4833#### Extension: `attributes` ####
4835Allows attributes to be attached to any inline or block-level
4836element. The syntax for the attributes is the same as that
4837used in [`header_attributes`][Extension: `header_attributes`].
4839- Attributes that occur immediately after an inline
4840 element affect that element. If they follow a space, then they
4841 belong to the space. (Hence, this option subsumes
4842 `inline_code_attributes` and `link_attributes`.)
4843- Attributes that occur immediately before a block
4844 element, on a line by themselves, affect that
4846- Consecutive attribute specifiers may be used,
4847 either for blocks or for inlines. Their attributes
4849- Attributes that occur at the end of the text of
4850 a Setext or ATX heading (separated by whitespace
4851 from the text) affect the heading element. (Hence, this
4852 option subsumes `header_attributes`.)
4853- Attributes that occur after the opening fence
4854 in a fenced code block affect the code block element. (Hence,
4855 this option subsumes `fenced_code_attributes`.)
4856- Attributes that occur at the end of a reference
4857 link definition affect links that refer to that
4860Note that pandoc's AST does not currently allow attributes
4861to be attached to arbitrary elements. Hence a Span or Div
4862container will be added if needed.
4864#### Extension: `old_dashes` ####
4866Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4867`-` before a numeral is an en-dash, and `--` is an em-dash.
4868This option only has an effect if `smart` is enabled. It is
4869selected automatically for `textile` input.
4871#### Extension: `angle_brackets_escapable` ####
4873Allow `<` and `>` to be backslash-escaped, as they can be in
4874GitHub flavored Markdown but not original Markdown. This is
4875implied by pandoc's default `all_symbols_escapable`.
4877#### Extension: `lists_without_preceding_blankline` ####
4879Allow a list to occur right after a paragraph, with no intervening
4882#### Extension: `four_space_rule` ####
4884Selects the pandoc <= 2.0 behavior for parsing lists, so that
4885four spaces indent are needed for list item continuation
4888#### Extension: `spaced_reference_links` ####
4890Allow whitespace between the two components of a reference link,
4895#### Extension: `hard_line_breaks` ####
4897Causes all newlines within a paragraph to be interpreted as hard line
4898breaks instead of spaces.
4900#### Extension: `ignore_line_breaks` ####
4902Causes newlines within a paragraph to be ignored, rather than being
4903treated as spaces or as hard line breaks. This option is intended for
4904use with East Asian languages where spaces are not used between words,
4905but text is divided into lines for readability.
4907#### Extension: `east_asian_line_breaks` ####
4909Causes newlines within a paragraph to be ignored, rather than
4910being treated as spaces or as hard line breaks, when they occur
4911between two East Asian wide characters. This is a better choice
4912than `ignore_line_breaks` for texts that include a mix of East
4913Asian wide characters and other characters.
4915#### Extension: `emoji` ####
4917Parses textual emojis like `:smile:` as Unicode emoticons.
4919#### Extension: `tex_math_single_backslash` ####
4921Causes anything between `\(` and `\)` to be interpreted as inline
4922TeX math, and anything between `\[` and `\]` to be interpreted
4923as display TeX math. Note: a drawback of this extension is that
4924it precludes escaping `(` and `[`.
4926#### Extension: `tex_math_double_backslash` ####
4928Causes anything between `\\(` and `\\)` to be interpreted as inline
4929TeX math, and anything between `\\[` and `\\]` to be interpreted
4932#### Extension: `markdown_attribute` ####
4934By default, pandoc interprets material inside block-level tags as Markdown.
4935This extension changes the behavior so that Markdown is only parsed
4936inside block-level tags if the tags have the attribute `markdown=1`.
4938#### Extension: `mmd_title_block` ####
4940Enables a [MultiMarkdown] style title block at the top of
4941the document, for example:
4945 Date: September 1, 2008
4946 Comment: This is a sample mmd title block, with
4947 a field spanning multiple lines.
4949See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4950`yaml_metadata_block` is enabled, it will take precedence over
4953#### Extension: `abbreviations` ####
4955Parses PHP Markdown Extra abbreviation keys, like
4957 *[HTML]: Hypertext Markup Language
4959Note that the pandoc document model does not support
4960abbreviations, so if this extension is enabled, abbreviation keys are
4961simply skipped (as opposed to being parsed as paragraphs).
4963#### Extension: `autolink_bare_uris` ####
4965Makes all absolute URIs into links, even when not surrounded by
4966pointy braces `<...>`.
4968#### Extension: `mmd_link_attributes` ####
4970Parses multimarkdown style key-value attributes on link
4971and image references. This extension should not be confused with the
4972[`link_attributes`](#extension-link_attributes) extension.
4974 This is a reference ![image][ref] with multimarkdown attributes.
4976 [ref]: https://path.to/image "Image title" width=20px height=30px
4977 id=myId class="myClass1 myClass2"
4979#### Extension: `mmd_header_identifiers` ####
4981Parses multimarkdown style heading identifiers (in square brackets,
4982after the heading but before any trailing `#`s in an ATX heading).
4984#### Extension: `compact_definition_lists` ####
4986Activates the definition list syntax of pandoc 1.12.x and earlier.
4987This syntax differs from the one described above under [Definition lists]
4990 - No blank line is required between consecutive items of the
4992 - To get a "tight" or "compact" list, omit space between consecutive
4993 items; the space between a term and its definition does not affect
4995 - Lazy wrapping of paragraphs is not allowed: the entire definition must
4996 be indented four spaces.[^6]
4998[^6]: To see why laziness is incompatible with relaxing the requirement
4999 of a blank line between items, consider the following example:
5006 Is this a single list item with two definitions of "bar," the first of
5007 which is lazily wrapped, or two list items? To remove the ambiguity
5008 we must either disallow lazy wrapping or require a blank line between
5011#### Extension: `gutenberg` ####
5013Use [Project Gutenberg] conventions for `plain` output:
5014all-caps for strong emphasis, surround by underscores
5015for regular emphasis, add extra blank space around headings.
5017 [Project Gutenberg]: https://www.gutenberg.org
5021In addition to pandoc's extended Markdown, the following Markdown
5022variants are supported:
5024- `markdown_phpextra` (PHP Markdown Extra)
5025- `markdown_github` (deprecated GitHub-Flavored Markdown)
5026- `markdown_mmd` (MultiMarkdown)
5027- `markdown_strict` (Markdown.pl)
5028- `commonmark` (CommonMark)
5029- `gfm` (Github-Flavored Markdown)
5030- `commonmark_x` (CommonMark with many pandoc extensions)
5032To see which extensions are supported for a given format,
5033and which are enabled by default, you can use the command
5035 pandoc --list-extensions=FORMAT
5037where `FORMAT` is replaced with the name of the format.
5039Note that the list of extensions for `commonmark`,
5040`gfm`, and `commonmark_x` are defined relative to default
5041commonmark. So, for example, `backtick_code_blocks`
5042does not appear as an extension, since it is enabled by
5043default and cannot be disabled.
5047When the `--citeproc` option is used, pandoc can automatically generate
5048citations and a bibliography in a number of styles. Basic usage is
5050 pandoc --citeproc myinput.txt
5052To use this feature, you will need to have
5054- a document containing citations (see [Extension: `citations`]);
5055- a source of bibliographic data: either an external bibliography
5056 file or a list of `references` in the document's YAML metadata
5057- optionally, a [CSL] citation style.
5059## Specifying bibliographic data
5061You can specify an external bibliography using the
5062`bibliography` metadata field in a YAML metadata section or the
5063`--bibliography` command line argument. If you want to use
5064multiple bibliography files, you can supply multiple
5065`--bibliography` arguments or set `bibliography` metadata field
5066to YAML array. A bibliography may have any of these formats:
5068 Format File extension
5069 ------------ --------------
5075Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5076use the extension `.bibtex` to force interpretation as BibTeX.
5078In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5079inside fields such as `title`; in CSL YAML databases, pandoc
5080Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5089`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5098`<span class="nocase">...</span>`
5099: prevent a phrase from being capitalized as title case
5101As an alternative to specifying a bibliography file using
5102`--bibliography` or the YAML metadata field `bibliography`, you
5103can include the citation data directly in the `references` field
5104of the document's YAML metadata. The field should contain an
5105array of YAML-encoded references, for example:
5109 - type: article-journal
5121 title: 'Molecular structure of nucleic acids: a structure for
5122 deoxyribose nucleic acid'
5123 title-short: Molecular structure of nucleic acids
5124 container-title: Nature
5128 DOI: 10.1038/171737a0
5129 URL: https://www.nature.com/articles/171737a0
5133Note that `pandoc` can be used to produce such a YAML metadata
5134section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5136 pandoc chem.bib -s -t markdown
5137 pandoc chem.json -s -t markdown
5140### Capitalization in titles
5142If you are using a bibtex or biblatex bibliography, then observe
5145 - English titles should be in title case. Non-English titles should
5146 be in sentence case, and the `langid` field in biblatex should be
5147 set to the relevant language. (The following values are treated
5148 as English: `american`, `british`, `canadian`, `english`,
5149 `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5151 - As is standard with bibtex/biblatex, proper names should be
5152 protected with curly braces so that they won't be lowercased
5153 in styles that call for sentence case. For example:
5155 title = {My Dinner with {Andre}}
5157 - In addition, words that should remain lowercase (or camelCase)
5158 should be protected:
5160 title = {Spin Wave Dispersion on the {nm} Scale}
5162 Though this is not necessary in bibtex/biblatex, it is necessary
5163 with citeproc, which stores titles internally in sentence case,
5164 and converts to title case in styles that require it. Here we
5165 protect "nm" so that it doesn't get converted to "Nm" at this stage.
5167If you are using a CSL bibliography (either JSON or YAML), then observe
5170 - All titles should be in sentence case.
5172 - Use the `language` field for non-English titles to prevent their
5173 conversion to title case in styles that call for this. (Conversion
5174 happens only if `language` begins with `en` or is left empty.)
5176 - Protect words that should not be converted to title case using
5179 Spin wave dispersion on the <span class="nocase">nm</span> scale
5181### Conference Papers, Published vs. Unpublished
5183For a formally published conference paper, use the biblatex entry type
5184`inproceedings` (which will be mapped to CSL `paper-conference`).
5186For an unpublished manuscript, use the biblatex entry type
5187`unpublished` without an `eventtitle` field (this entry type
5188will be mapped to CSL `manuscript`).
5190For a talk, an unpublished conference paper, or a poster
5191presentation, use the biblatex entry type `unpublished` with an
5192`eventtitle` field (this entry type will be mapped to CSL
5193`speech`). Use the biblatex `type` field to indicate the type,
5194e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5195too, though `eventdate` will not be rendered by most CSL styles.
5196Note that `venue` is for the event's venue, unlike `location`
5197which describes the publisher's location; do not use the latter
5198for an unpublished conference paper.
5201## Specifying a citation style
5203Citations and references can be formatted using any style supported by the
5204[Citation Style Language], listed in the [Zotero Style Repository].
5205These files are specified using the `--csl` option or the `csl`
5206(or `citation-style`) metadata field. By default, pandoc will
5207use the [Chicago Manual of Style] author-date format. (You can
5208override this default by copying a CSL style of your choice
5209to `default.csl` in your user data directory.)
5210The CSL project provides further information on [finding and
5213The `--citation-abbreviations` option (or the
5214`citation-abbreviations` metadata field) may be used to
5215specify a JSON file containing abbreviations of journals
5216that should be used in formatted bibliographies when
5217`form="short"` is specified. The format of the file
5218can be illustrated with an example:
5222 "container-title": {
5223 "Lloyd's Law Reports": "Lloyd's Rep",
5224 "Estates Gazette": "EG",
5225 "Scots Law Times": "SLT"
5230## Raw content in a style
5232To include raw content in a prefix, suffix, delimiter, or term,
5233surround it with these tags indicating the format:
5235 {{jats}}<ref>{{/jats}}
5237Without the tags, the string will be interpreted as a string
5238and escaped in the output, rather than being passed through raw.
5240This feature allows stylesheets to be customized to give
5241different output for different output formats. However,
5242stylesheets customized in this way will not be useable
5243by other CSL implementations.
5247## Placement of the bibliography
5249If the style calls for a list of works cited, it will be placed
5250in a div with id `refs`, if one exists:
5255Otherwise, it will be placed at the end of the document.
5256Generation of the bibliography can be suppressed by setting
5257`suppress-bibliography: true` in the YAML metadata.
5259If you wish the bibliography to have a section heading, you can
5260set `reference-section-title` in the metadata, or put the heading
5261at the beginning of the div with id `refs` (if you are using it)
5262or at the end of your document:
5268The bibliography will be inserted after this heading. Note that
5269the `unnumbered` class will be added to this heading, so that the
5270section will not be numbered.
5272## Including uncited items in the bibliography
5274If you want to include items in the bibliography without actually
5275citing them in the body text, you can define a dummy `nocite` metadata
5276field and put the citations there:
5285In this example, the document will contain a citation for `item3`
5286only, but the bibliography will contain entries for `item1`, `item2`, and
5289It is possible to create a bibliography with all the citations,
5290whether or not they appear in the document, by using a wildcard:
5297For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5298render the bibliography. In order to do so, specify bibliography
5299files as outlined above, and add `--natbib` or `--biblatex`
5300argument to `pandoc` invocation. Bear in mind that bibliography
5301files have to be in either BibTeX (for `--natbib`)
5302or BibLaTeX (for `--biblatex`) format.
5304## Other relevant metadata fields
5306A few other metadata fields affect bibliography formatting:
5309: If true, citations will be
5310 hyperlinked to the corresponding bibliography entries
5311 (for author-date and numerical styles only).
5314: The `lang` field will affect how the style is localized,
5315 for example in the translation of labels and the use
5316 of quotation marks. (For backwards compatibility,
5317 `locale` may be used instead of `lang`, but this use
5320`notes-after-punctuation`
5321: If true (the default), pandoc will put footnote citations
5322 after following punctuation. For example, if the source
5323 contains `blah blah [@jones99].`, the result will look like
5324 `blah blah.[^1]`, with the note moved after the period and
5325 the space collapsed. If false, the space will still be
5326 collapsed, but the footnote will not be moved after the
5338You can use pandoc to produce an HTML + JavaScript slide presentation
5339that can be viewed via a web browser. There are five ways to do this,
5340using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5341You can also produce a PDF slide show using LaTeX [`beamer`], or
5342slides shows in Microsoft [PowerPoint] format.
5344Here's the Markdown source for a simple slide show, `habits.txt`:
5371 
5378To produce an HTML/JavaScript slide show, simply type
5380 pandoc -t FORMAT -s habits.txt -o habits.html
5382where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5384For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5385`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5386assumed to be available at the relative path `s5/default` (for S5), `slideous`
5387(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5388`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5389`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5390above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5393With all HTML slide formats, the `--self-contained` option can be used to
5394produce a single file that contains all of the data necessary to display the
5395slide show, including linked scripts, stylesheets, images, and videos.
5397To produce a PDF slide show using beamer, type
5399 pandoc -t beamer habits.txt -o habits.pdf
5401Note that a reveal.js slide show can also be converted to a PDF
5402by printing it to a file from the browser.
5404To produce a Powerpoint slide show, type
5406 pandoc habits.txt -o habits.pptx
5408## Structuring the slide show
5410By default, the *slide level* is the highest heading level in
5411the hierarchy that is followed immediately by content, and not another
5412heading, somewhere in the document. In the example above, level-1 headings
5413are always followed by level-2 headings, which are followed by content,
5414so the slide level is 2. This default can be overridden using
5415the `--slide-level` option.
5417The document is carved up into slides according to the following
5420 * A horizontal rule always starts a new slide.
5422 * A heading at the slide level always starts a new slide.
5424 * Headings *below* the slide level in the hierarchy create
5425 headings *within* a slide.
5427 * Headings *above* the slide level in the hierarchy create
5428 "title slides," which just contain the section title
5429 and help to break the slide show into sections.
5430 Non-slide content under these headings will be included
5431 on the title slide (for HTML slide shows) or in a
5432 subsequent slide with the same title (for beamer).
5434 * A title page is constructed automatically from the document's title
5435 block, if present. (In the case of beamer, this can be disabled
5436 by commenting out some lines in the default template.)
5438These rules are designed to support many different styles of slide show. If
5439you don't care about structuring your slides into sections and subsections,
5440you can just use level-1 headings for all each slide. (In that case, level-1
5441will be the slide level.) But you can also structure the slide show into
5442sections, as in the example above.
5444Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5445layout will be produced, with level-1 headings building horizontally
5446and level-2 headings building vertically. It is not recommended that
5447you use deeper nesting of section levels with reveal.js.
5451By default, these writers produce lists that display "all at once."
5452If you want your lists to display incrementally (one item at a time),
5453use the `-i` option. If you want a particular list to depart from the
5454default, put it in a `div` block with class `incremental` or
5455`nonincremental`. So, for example, using the `fenced div` syntax, the
5456following would be incremental regardless of the document default:
5474While using `incremental` and `nonincremental` divs are the
5475recommended method of setting incremental lists on a per-case basis,
5476an older method is also supported: putting lists inside a blockquote
5477will depart from the document default (that is, it will display
5478incrementally without the `-i` option and all at once with the `-i`
5484Both methods allow incremental and nonincremental lists to be mixed
5485in a single document.
5487Note: Neither the `-i/--incremental` option nor any of the
5488methods described here currently works for PowerPoint output.
5492You can add "pauses" within a slide by including a paragraph containing
5493three dots, separated by spaces:
5495 # Slide with a pause
5497 content before the pause
5501 content after the pause
5503Note: this feature is not yet implemented for PowerPoint output.
5505## Styling the slides
5507You can change the style of HTML slides by putting customized CSS files
5508in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5509or `$DATADIR/slideous` (for Slideous),
5510where `$DATADIR` is the user data directory (see `--data-dir`, above).
5511The originals may be found in pandoc's system data directory (generally
5512`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5513files it does not find in the user data directory.
5515For dzslides, the CSS is included in the HTML file itself, and may
5518All [reveal.js configuration options] can be set through variables.
5519For example, themes can be used by setting the `theme` variable:
5523Or you can specify a custom stylesheet using the `--css` option.
5525To style beamer slides, you can specify a `theme`, `colortheme`,
5526`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5528 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5530Note that heading attributes will turn into slide attributes
5531(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5532to style individual slides. In beamer, the only heading attribute
5533that affects slides is the `allowframebreaks` class, which sets the
5534`allowframebreaks` option, causing multiple slides to be created
5535if the content overfills the frame. This is recommended especially for
5538 # References {.allowframebreaks}
5542Speaker notes are supported in reveal.js and PowerPoint (pptx)
5543output. You can add notes to your Markdown document thus:
5549 - It can contain Markdown
5554To show the notes window in reveal.js, press `s` while viewing the
5555presentation. Speaker notes in PowerPoint will be available, as usual,
5556in handouts and presenter view.
5558Notes are not yet supported for other slide formats, but the notes
5559will not appear on the slides themselves.
5563To put material in side by side columns, you can use a native
5564div container with class `columns`, containing two or more div
5565containers with class `column` and a `width` attribute:
5567 :::::::::::::: {.columns}
5568 ::: {.column width="40%"}
5571 ::: {.column width="60%"}
5576### Additional columns attributes in beamer
5578The div containers with classes `columns` and `column` can optionally have
5579an `align` attribute.
5580The class `columns` can optionally have a `totalwidth` attribute or an
5581`onlytextwidth` class.
5583 :::::::::::::: {.columns align=center totalwidth=8em}
5584 ::: {.column width="40%"}
5587 ::: {.column width="60%" align=bottom}
5592The `align` attributes on `columns` and `column` can be used with the
5593values `top`, `top-baseline`, `center` and `bottom` to vertically align
5594the columns. It defaults to `top` in `columns`.
5596The `totalwidth` attribute limits the width of the columns to the given value.
5598 :::::::::::::: {.columns align=top .onlytextwidth}
5599 ::: {.column width="40%" align=center}
5602 ::: {.column width="60%"}
5607The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5609See Section 12.7 of the [Beamer User's Guide] for more details.
5611## Frame attributes in beamer
5613Sometimes it is necessary to add the LaTeX `[fragile]` option to
5614a frame in beamer (for example, when using the `minted` environment).
5615This can be forced by adding the `fragile` class to the heading
5616introducing the slide:
5618 # Fragile slide {.fragile}
5620All of the other frame attributes described in Section 8.1 of
5621the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5622`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5623`shrink`, `standout`, `noframenumbering`.
5625## Background in reveal.js and beamer
5627Background images can be added to self-contained reveal.js slideshows and
5628to beamer slideshows.
5630For the same image on every slide, use the configuration
5631option `background-image` either in the YAML metadata block
5632or as a command-line variable. (There are no other options in
5633beamer and the rest of this section concerns reveal.js slideshows.)
5635For reveal.js, you can instead use the reveal.js-native option
5636`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5637and `parallaxBackgroundVertical` the same way and must also set
5638`parallaxBackgroundSize` to have your values take effect.
5640To set an image for a particular reveal.js slide, add
5641`{data-background-image="/path/to/image"}`
5642to the first slide-level heading on the slide (which may even be empty).
5644In reveal.js's overview mode, the parallaxBackgroundImage will show up
5645only on the first slide.
5647Other reveal.js background settings also work on individual slides, including
5648`data-background-size`, `data-background-repeat`, `data-background-color`,
5649`data-transition`, and `data-transition-speed`.
5651To add a background image to the automatically generated title slide, use the
5652`title-slide-attributes` variable in the YAML metadata block. It must contain
5653a map of attribute names and values.
5655See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5658For example in reveal.js:
5663parallaxBackgroundImage: /path/to/my/background_image.png
5664title-slide-attributes:
5665 data-background-image: /path/to/title_image.png
5666 data-background-size: contain
5671Slide 1 has background_image.png as its background.
5673## {data-background-image="/path/to/special_image.jpg"}
5675Slide 2 has a special image for its background, even though the heading has no content.
5682EPUB metadata may be specified using the `--epub-metadata` option, but
5683if the source document is Markdown, it is better to use a [YAML metadata
5684block][Extension: `yaml_metadata_block`]. Here is an example:
5691 text: An investigation of metadata
5699 text: doi:10.234234.234/33
5701 rights: © 2007 John Smith, CC BY-NC
5706The following fields are recognized:
5709 ~ Either a string value or an object with fields `text` and
5710 `scheme`. Valid values for `scheme` are `ISBN-10`,
5711 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5712 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5713 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5716 ~ Either a string value, or an object with fields `file-as` and
5717 `type`, or a list of such objects. Valid values for `type` are
5718 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5721 ~ Either a string value, or an object with fields `role`, `file-as`,
5722 and `text`, or a list of such objects. Valid values for `role` are
5723 [MARC relators], but
5724 pandoc will attempt to translate the human-readable versions
5725 (like "author" and "editor") to the appropriate marc relators.
5728 ~ Same format as `creator`.
5731 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5732 Pandoc will attempt to convert other common date formats.
5734`lang` (or legacy: `language`)
5735 ~ A string value in [BCP 47] format. Pandoc will default to the local
5736 language if nothing is specified.
5739 ~ A string value or a list of such values.
5760 ~ A string value (path to cover image).
5762`css` (or legacy: `stylesheet`)
5763 ~ A string value (path to CSS stylesheet).
5765`page-progression-direction`
5766 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5767 attribute for the [`spine` element].
5770 ~ iBooks-specific metadata, with the following fields:
5772 - `version`: (string)
5773 - `specified-fonts`: `true`|`false` (default `false`)
5774 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5775 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5776 - `binding`: `true`|`false` (default `true`)
5777 - `scroll-axis`: `vertical`|`horizontal`|`default`
5779[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5780[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5782## The `epub:type` attribute
5784For `epub3` output, you can mark up the heading that corresponds to an EPUB
5785chapter using the [`epub:type` attribute][epub-type]. For example, to set
5786the attribute to the value `prologue`, use this markdown:
5788 # My chapter {epub:type=prologue}
5790Which will result in:
5792 <body epub:type="frontmatter">
5793 <section epub:type="prologue">
5796Pandoc will output `<body epub:type="bodymatter">`, unless
5797you use one of the following values, in which case either
5798`frontmatter` or `backmatter` will be output.
5800`epub:type` of first section `epub:type` of body
5801---------------------------- ------------------
5804acknowledgments frontmatter
5805copyright-page frontmatter
5806dedication frontmatter
5810contributors frontmatter
5811other-credits frontmatter
5813revision-history frontmatter
5814titlepage frontmatter
5815halftitlepage frontmatter
5816seriespage frontmatter
5821bibliography backmatter
5824[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5828By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5829`<video>` or `<source>` element present in the generated EPUB,
5830and include it in the EPUB container, yielding a completely
5831self-contained EPUB. If you want to link to external media resources
5832instead, use raw HTML in your source and add `data-external="1"` to the tag
5833with the `src` attribute. For example:
5835 <audio controls="1">
5836 <source src="https://example.com/music/toccata.mp3"
5837 data-external="1" type="audio/mpeg">
5843When creating a [Jupyter notebook], pandoc will try to infer the
5844notebook structure. Code blocks with the class `code` will be
5845taken as code cells, and intervening content will be taken as
5846Markdown cells. Attachments will automatically be created for
5847images in Markdown cells. Metadata will be taken from the
5848`jupyter` metadata field. For example:
5857 display_name: Python 2
5864 file_extension: ".py"
5865 mimetype: "text/x-python"
5867 nbconvert_exporter: "python"
5868 pygments_lexer: "ipython2"
5874**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5875bibendum felis dictum sodales.
5884from IPython.display import HTML
5887console.log("hello");
5895This image  will be
5896included as a cell attachment.
5899If you want to add cell attributes, group cells differently, or
5900add output to code cells, then you need to include divs to
5901indicate the structure. You can use either [fenced
5902divs][Extension: `fenced_divs`] or [native divs][Extension:
5903`native_divs`] for this. Here is an example:
5906:::::: {.cell .markdown}
5909**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5910bibendum felis dictum sodales.
5913:::::: {.cell .code execution_count=1}
5918::: {.output .stream .stdout}
5925:::::: {.cell .code execution_count=2}
5927from IPython.display import HTML
5930console.log("hello");
5936::: {.output .execute_result execution_count=2}
5939console.log("hello");
5948If you include raw HTML or TeX in an output cell, use the
5949[raw attribute][Extension: `fenced_attribute`], as shown
5950in the last cell of the example above. Although pandoc can
5951process "bare" raw HTML and TeX, the result is often
5952interspersed raw elements and normal textual elements, and
5953in an output cell pandoc expects a single, connected raw
5954block. To avoid using raw HTML or TeX except when
5955marked explicitly using raw attributes, we recommend
5956specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5957translating between Markdown and ipynb notebooks.
5959Note that options and extensions that affect reading and
5960writing of Markdown will also affect Markdown cells in ipynb
5961notebooks. For example, `--wrap=preserve` will preserve
5962soft line breaks in Markdown cells; `--atx-headers` will
5963cause ATX-style headings to be used; and `--preserve-tabs` will
5964prevent tabs from being turned to spaces.
5966# Syntax highlighting
5968Pandoc will automatically highlight syntax in [fenced code blocks] that
5969are marked with a language name. The Haskell library [skylighting] is
5970used for highlighting. Currently highlighting is supported only for
5971HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5972that pandoc will recognize, type `pandoc --list-highlight-languages`.
5974The color scheme can be selected using the `--highlight-style` option.
5975The default color scheme is `pygments`, which imitates the default color
5976scheme used by the Python library pygments (though pygments is not actually
5977used to do the highlighting). To see a list of highlight styles,
5978type `pandoc --list-highlight-styles`.
5980If you are not satisfied with the predefined styles, you can
5981use `--print-highlight-style` to generate a JSON `.theme` file which
5982can be modified and used as the argument to `--highlight-style`. To
5983get a JSON version of the `pygments` style, for example:
5985 pandoc --print-highlight-style pygments > my.theme
5987Then edit `my.theme` and use it like this:
5989 pandoc --highlight-style my.theme
5991If you are not satisfied with the built-in highlighting, or you
5992want highlight a language that isn't supported, you can use the
5993`--syntax-definition` option to load a [KDE-style XML syntax definition
5994file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5995Before writing your own, have a look at KDE's [repository of syntax
5996definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5998To disable highlighting, use the `--no-highlight` option.
6000[skylighting]: https://github.com/jgm/skylighting
6004Custom styles can be used in the docx and ICML formats.
6008By default, pandoc's docx and ICML output applies a predefined set of styles
6009for blocks such as paragraphs and block quotes, and uses largely default
6010formatting (italics, bold) for inlines. This will work for most
6011purposes, especially alongside a `reference.docx` file. However, if you
6012need to apply your own styles to blocks, or match a preexisting set of
6013styles, pandoc allows you to define custom styles for blocks and text
6014using `div`s and `span`s, respectively.
6016If you define a `div` or `span` with the attribute `custom-style`,
6017pandoc will apply your specified style to the contained elements (with
6018the exception of elements whose function depends on a style, like
6019headings, code blocks, block quotes, or links). So, for example, using
6020the `bracketed_spans` syntax,
6022 [Get out]{custom-style="Emphatically"}, he said.
6024would produce a docx file with "Get out" styled with character
6025style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6027 Dickinson starts the poem simply:
6029 ::: {custom-style="Poetry"}
6030 | A Bird came down the Walk---
6031 | He did not know I saw---
6034would style the two contained lines with the `Poetry` paragraph style.
6036For docx output, styles will be defined in the output file as inheriting
6037from normal text, if the styles are not yet in your reference.docx.
6038If they are already defined, pandoc will not alter the definition.
6040This feature allows for greatest customization in conjunction with
6041[pandoc filters]. If you want all paragraphs after block quotes to be
6042indented, you can write a filter to apply the styles necessary. If you
6043want all italics to be transformed to the `Emphasis` character style
6044(perhaps to change their color), you can write a filter which will
6045transform all italicized inlines to inlines within an `Emphasis`
6048For docx output, you don't need to enable any extensions for
6049custom styles to work.
6051[pandoc filters]: https://pandoc.org/filters.html
6055The docx reader, by default, only reads those styles that it can
6056convert into pandoc elements, either by direct conversion or
6057interpreting the derivation of the input document's styles.
6059By enabling the [`styles` extension](#ext-styles) in the docx reader
6060(`-f docx+styles`), you can produce output that maintains the styles
6061of the input document, using the `custom-style` class. Paragraph
6062styles are interpreted as divs, while character styles are interpreted
6065For example, using the `custom-style-reference.docx` file in the test
6066directory, we have the following different outputs:
6068Without the `+styles` extension:
6070 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6073 This is text with an *emphasized* text style. And this is text with a
6074 **strengthened** text style.
6076 > Here is a styled paragraph that inherits from Block Text.
6078And with the extension:
6080 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6082 ::: {custom-style="First Paragraph"}
6086 ::: {custom-style="Body Text"}
6087 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6088 And this is text with a [strengthened]{custom-style="Strengthened"}
6092 ::: {custom-style="My Block Style"}
6093 > Here is a styled paragraph that inherits from Block Text.
6096With these custom styles, you can use your input document as a
6097reference-doc while creating docx output (see below), and maintain the
6098same styles in your input and output files.
6102Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6103includes a Lua interpreter, so Lua need not be installed separately.)
6105To use a custom writer, simply specify the path to the Lua script
6106in place of the output format. For example:
6108 pandoc -t data/sample.lua
6110Creating a custom writer requires writing a Lua function for each
6111possible element in a pandoc document. To get a documented example
6112which you can modify according to your needs, do
6114 pandoc --print-default-data-file sample.lua
6116Note that custom writers have no default template. If you want
6117to use `--standalone` with a custom writer, you will need to
6118specify a template manually using `--template` or add a new
6119default template with the name
6120`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6121subdirectory of your user data directory (see [Templates]).
6123[Lua]: https://www.lua.org
6127If you use pandoc to convert user-contributed content in a web
6128application, here are some things to keep in mind:
61301. Although pandoc itself will not create or modify any files other
6131 than those you explicitly ask it create (with the exception
6132 of temporary files used in producing PDFs), a filter or custom
6133 writer could in principle do anything on your file system. Please
6134 audit filters and custom writers very carefully before using them.
61362. If your application uses pandoc as a Haskell library (rather than
6137 shelling out to the executable), it is possible to use it in a mode
6138 that fully isolates pandoc from your file system, by running the
6139 pandoc operations in the `PandocPure` monad. See the document
6140 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
61433. Pandoc's parsers can exhibit pathological performance on some
6144 corner cases. It is wise to put any pandoc operations under
6145 a timeout, to avoid DOS attacks that exploit these issues.
6146 If you are using the pandoc executable, you can add the
6147 command line options `+RTS -M512M -RTS` (for example) to limit
6148 the heap size to 512MB.
61504. The HTML generated by pandoc is not guaranteed to be safe.
6151 If `raw_html` is enabled for the Markdown input, users can
6152 inject arbitrary HTML. Even if `raw_html` is disabled,
6153 users can include dangerous content in attributes for
6154 headings, spans, and code blocks. To be safe, you should
6155 run all the generated HTML through an HTML sanitizer.
6159Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6160under the [GPL], version 2 or greater. This software carries no
6161warranty of any kind. (See COPYRIGHT for full copyright and
6162warranty notices.) For a full list of contributors, see the file
6163AUTHORS.md in the pandoc source code.
6165[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6166[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