2title: Pandoc User's Guide
4date: September 29, 2019
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`]: http://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).
120Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
121following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
122[`weasyprint`] or [`prince`].
123To do this, specify an output file with a `.pdf` extension, as before,
124but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
125to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
127PDF output uses [variables for LaTeX] (with a LaTeX engine);
128[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
129(an HTML/CSS-to-PDF engine; `--css` also affects the output).
131To debug the PDF creation, it can be useful to look at the intermediate
132representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
133to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
135When using LaTeX, the following packages need to be available
136(they are included with all recent versions of [TeX Live]):
137[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
138[`ifxetex`], [`ifluatex`], [`listings`] (if the
139`--listings` option is used), [`fancyvrb`], [`longtable`],
140[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141contains images), [`hyperref`], [`xcolor`],
142[`ulem`], [`geometry`] (with the `geometry` variable set),
143[`setspace`] (with `linestretch`), and
144[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
145the PDF engine requires [`fontspec`]. `xelatex` uses
146[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
147`dir` variable set). If the `mathspec` variable is set,
148`xelatex` will use [`mathspec`] instead of [`unicode-math`].
149The [`upquote`] and [`microtype`] packages are used if
150available, and [`csquotes`] will be used for [typography]
151if the `csquotes` variable or metadata field is set to a
152true value. The [`natbib`], [`biblatex`], [`bibtex`], and
153[`biber`] packages can optionally be used for [citation
154rendering]. The following packages will be used to improve
155output quality if present, but pandoc does not require them to
156be present: [`upquote`] (for straight quotes in verbatim
157environments), [`microtype`] (for better spacing adjustments),
158[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
159better line breaks in URLs), [`bookmark`] (for better PDF
160bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
163[TeX Live]: http://www.tug.org/texlive/
164[`amsfonts`]: https://ctan.org/pkg/amsfonts
165[`amsmath`]: https://ctan.org/pkg/amsmath
166[`babel`]: https://ctan.org/pkg/babel
167[`biber`]: https://ctan.org/pkg/biber
168[`biblatex`]: https://ctan.org/pkg/biblatex
169[`bibtex`]: https://ctan.org/pkg/bibtex
170[`bidi`]: https://ctan.org/pkg/bidi
171[`bookmark`]: https://ctan.org/pkg/bookmark
172[`booktabs`]: https://ctan.org/pkg/booktabs
173[`csquotes`]: https://ctan.org/pkg/csquotes
174[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
175[`fontspec`]: https://ctan.org/pkg/fontspec
176[`footnote`]: https://ctan.org/pkg/footnote
177[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
178[`geometry`]: https://ctan.org/pkg/geometry
179[`graphicx`]: https://ctan.org/pkg/graphicx
180[`grffile`]: https://ctan.org/pkg/grffile
181[`hyperref`]: https://ctan.org/pkg/hyperref
182[`ifluatex`]: https://ctan.org/pkg/ifluatex
183[`ifxetex`]: https://ctan.org/pkg/ifxetex
184[`listings`]: https://ctan.org/pkg/listings
185[`lm`]: https://ctan.org/pkg/lm
186[`longtable`]: https://ctan.org/pkg/longtable
187[`mathspec`]: https://ctan.org/pkg/mathspec
188[`microtype`]: https://ctan.org/pkg/microtype
189[`natbib`]: https://ctan.org/pkg/natbib
190[`parskip`]: https://ctan.org/pkg/parskip
191[`polyglossia`]: https://ctan.org/pkg/polyglossia
192[`prince`]: https://www.princexml.com/
193[`setspace`]: https://ctan.org/pkg/setspace
194[`ulem`]: https://ctan.org/pkg/ulem
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
196[`upquote`]: https://ctan.org/pkg/upquote
197[`weasyprint`]: http://weasyprint.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
199[`xcolor`]: https://ctan.org/pkg/xcolor
200[`xecjk`]: https://ctan.org/pkg/xecjk
201[`xurl`]: https://ctan.org/pkg/xurl
205## Reading from the Web
207Instead of an input file, an absolute URI may be given. In this case
208pandoc will fetch the content using HTTP:
210 pandoc -f html -t markdown http://www.fsf.org
212It is possible to supply a custom User-Agent string or other
213header when requesting a document from a URL:
215 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
220## General options {.options}
222`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224: Specify input format. *FORMAT* can be:
227 - `commonmark` ([CommonMark] Markdown)
228 - `creole` ([Creole 1.0])
229 - `docbook` ([DocBook])
230 - `docx` ([Word docx])
231 - `dokuwiki` ([DokuWiki markup])
233 - `fb2` ([FictionBook2] e-book)
234 - `gfm` ([GitHub-Flavored Markdown]),
235 or the deprecated and less accurate `markdown_github`;
236 use [`markdown_github`](#markdown-variants) only
237 if you need extensions not supported in [`gfm`](#markdown-variants).
238 - `haddock` ([Haddock markup])
240 - `ipynb` ([Jupyter notebook])
241 - `jats` ([JATS] XML)
242 - `json` (JSON version of native AST)
244 - `markdown` ([Pandoc's Markdown])
245 - `markdown_mmd` ([MultiMarkdown])
246 - `markdown_phpextra` ([PHP Markdown Extra])
247 - `markdown_strict` (original unextended [Markdown])
248 - `mediawiki` ([MediaWiki markup])
251 - `native` (native Haskell)
254 - `org` ([Emacs Org mode])
255 - `rst` ([reStructuredText])
257 - `textile` ([Textile])
258 - `tikiwiki` ([TikiWiki markup])
259 - `twiki` ([TWiki markup])
260 - `vimwiki` ([Vimwiki])
263 Extensions can be individually enabled or disabled by
264 appending `+EXTENSION` or `-EXTENSION` to the format name.
265 See [Extensions] below, for a list of extensions and
266 their names. See `--list-input-formats` and `--list-extensions`,
269`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
271: Specify output format. *FORMAT* can be:
273 ::: {#output-formats}
274 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
275 - `beamer` ([LaTeX beamer][`beamer`] slide show)
276 - `commonmark` ([CommonMark] Markdown)
277 - `context` ([ConTeXt])
278 - `docbook` or `docbook4` ([DocBook] 4)
279 - `docbook5` (DocBook 5)
280 - `docx` ([Word docx])
281 - `dokuwiki` ([DokuWiki markup])
282 - `epub` or `epub3` ([EPUB] v3 book)
284 - `fb2` ([FictionBook2] e-book)
285 - `gfm` ([GitHub-Flavored Markdown]),
286 or the deprecated and less accurate `markdown_github`;
287 use [`markdown_github`](#markdown-variants) only
288 if you need extensions not supported in [`gfm`](#markdown-variants).
289 - `haddock` ([Haddock markup])
290 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
291 - `html4` ([XHTML] 1.0 Transitional)
292 - `icml` ([InDesign ICML])
293 - `ipynb` ([Jupyter notebook])
294 - `jats` ([JATS] XML)
295 - `jira` ([Jira] wiki markup)
296 - `json` (JSON version of native AST)
299 - `markdown` ([Pandoc's Markdown])
300 - `markdown_mmd` ([MultiMarkdown])
301 - `markdown_phpextra` ([PHP Markdown Extra])
302 - `markdown_strict` (original unextended [Markdown])
303 - `mediawiki` ([MediaWiki markup])
306 - `native` (native Haskell),
307 - `odt` ([OpenOffice text document][ODT])
309 - `opendocument` ([OpenDocument])
310 - `org` ([Emacs Org mode])
312 - `plain` (plain text),
313 - `pptx` ([PowerPoint] slide show)
314 - `rst` ([reStructuredText])
315 - `rtf` ([Rich Text Format])
316 - `texinfo` ([GNU Texinfo])
317 - `textile` ([Textile])
318 - `slideous` ([Slideous] HTML and JavaScript slide show)
319 - `slidy` ([Slidy] HTML and JavaScript slide show)
320 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
321 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
322 - `s5` ([S5] HTML and JavaScript slide show)
323 - `tei` ([TEI Simple])
324 - `xwiki` ([XWiki markup])
325 - `zimwiki` ([ZimWiki markup])
326 - the path of a custom lua writer, see [Custom writers] below
329 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
330 to *stdout* unless forced with `-o -`.
332 Extensions can be individually enabled or
333 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
334 name. See [Extensions] below, for a list of extensions and their
335 names. See `--list-output-formats` and `--list-extensions`, below.
337`-o` *FILE*, `--output=`*FILE*
339: Write output to *FILE* instead of *stdout*. If *FILE* is
340 `-`, output will go to *stdout*, even if a non-textual format
341 (`docx`, `odt`, `epub2`, `epub3`) is specified.
343`--data-dir=`*DIRECTORY*
345: Specify the user data directory to search for pandoc data files.
346 If this option is not specified, the default user data directory
347 will be used. On \*nix and macOS systems this will be the `pandoc`
348 subdirectory of the XDG data directory (by default,
349 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
350 environment variable). If that directory does not exist,
351 `$HOME/.pandoc` will be used (for backwards compatibility).
352 In Windows the default user data directory is
353 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
354 You can find the default user data directory on your system by
355 looking at the output of `pandoc --version`.
356 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
357 `slidy`, `slideous`, or `s5` directory
358 placed in this directory will override pandoc's normal defaults.
360`-d` *FILE*, `--defaults=`*FILE*
362: Specify a set of default option settings. *FILE* is a YAML
363 file whose fields correspond to command-line option
364 settings. All options for document conversion, including input
365 and output files, can be set using a defaults file. The file will
366 be searched for first in the working directory, and then in
367 the `defaults` subdirectory of the user data directory
368 (see `--data-dir`). The `.yaml` extension may be omitted.
369 See the section [Default files] for more information on the
370 file format. Settings from the defaults file may be
371 overridden or extended by subsequent options on the command
376: Generate a bash completion script. To enable bash completion
377 with pandoc, add this to your `.bashrc`:
379 eval "$(pandoc --bash-completion)"
383: Give verbose debugging output. Currently this only has an effect
388: Suppress warning messages.
392: Exit with error status if there are any warnings.
396: Write log messages in machine-readable JSON format to
397 *FILE*. All messages above DEBUG level will be written,
398 regardless of verbosity settings (`--verbose`, `--quiet`).
400`--list-input-formats`
402: List supported input formats, one per line.
404`--list-output-formats`
406: List supported output formats, one per line.
408`--list-extensions`[`=`*FORMAT*]
410: List supported extensions for *FORMAT*, one per line, preceded
411 by a `+` or `-` indicating whether it is enabled by default
412 in *FORMAT*. If *FORMAT* is not specified, defaults for
413 pandoc's Markdown are given.
415`--list-highlight-languages`
417: List supported languages for syntax highlighting, one per
420`--list-highlight-styles`
422: List supported styles for syntax highlighting, one per line.
423 See `--highlight-style`.
433[Markdown]: http://daringfireball.net/projects/markdown/
434[CommonMark]: http://commonmark.org
435[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
436[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
437[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
438[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
439[S5]: http://meyerweb.com/eric/tools/s5/
440[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
441[Slideous]: http://goessner.net/articles/slideous/
442[HTML]: http://www.w3.org/html/
443[HTML5]: http://www.w3.org/TR/html5/
444[polyglot markup]: https://www.w3.org/TR/html-polyglot/
445[XHTML]: http://www.w3.org/TR/xhtml1/
446[LaTeX]: http://latex-project.org
447[`beamer`]: https://ctan.org/pkg/beamer
448[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
449[ConTeXt]: http://www.contextgarden.net/
450[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
451[DocBook]: http://docbook.org
452[JATS]: https://jats.nlm.nih.gov
453[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
454[txt2tags]: http://txt2tags.org
455[EPUB]: http://idpf.org/epub
456[OPML]: http://dev.opml.org/spec2.html
457[OpenDocument]: http://opendocument.xml.org
458[ODT]: http://en.wikipedia.org/wiki/OpenDocument
459[Textile]: http://redcloth.org/textile
460[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
461[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
462[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
463[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
464[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
465[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
466[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
467[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
468[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
469[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
470[Haskell]: https://www.haskell.org
471[GNU Texinfo]: http://www.gnu.org/software/texinfo/
472[Emacs Org mode]: http://orgmode.org
473[AsciiDoc]: http://www.methods.co.nz/asciidoc/
474[AsciiDoctor]: https://asciidoctor.org/
475[DZSlides]: http://paulrouget.com/dzslides/
476[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
477[PDF]: https://www.adobe.com/pdf/
478[reveal.js]: http://lab.hakim.se/reveal-js/
479[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
480[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
481[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
482[TEI Simple]: https://github.com/TEIC/TEI-Simple
483[Muse]: https://amusewiki.org/library/manual
484[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
485[Vimwiki]: https://vimwiki.github.io
487## Reader options {.options}
489`--shift-heading-level-by=`*NUMBER*
491 Shift heading levels by a positive or negative integer.
492 For example, with `--shift-heading-level-by=-1`, level 2
493 headings become level 1 headings, and level 3 headings
494 become level 2 headings. Headings cannot have a level
495 less than 1, so a heading that would be shifted below level 1
496 becomes a regular paragraph. Exception: with a shift of -1,
497 a level-1 heading at the beginning of the document
498 replaces the metadata title. Conversely, with a shift
499 of +1, a nonempty metadata title becomes a level-1 heading at
500 the beginning of the document. `--shift-heading-level-by=-1`
501 is a good choice when converting HTML or Markdown documents that
502 use an initial level-1 heading for the document title and
503 level-2+ headings for sections.
505`--base-header-level=`*NUMBER*
507: *Deprecated. Use `--shift-heading-level-by` instead.*
508 Specify the base level for headings (defaults to 1).
510`--strip-empty-paragraphs`
512: *Deprecated. Use the `+empty_paragraphs` extension instead.*
513 Ignore paragraphs with no content. This option is useful
514 for converting word processing documents where users have
515 used empty paragraphs to create inter-paragraph space.
517`--indented-code-classes=`*CLASSES*
519: Specify classes to use for indented code blocks--for example,
520 `perl,numberLines` or `haskell`. Multiple classes may be separated
523`--default-image-extension=`*EXTENSION*
525: Specify a default extension to use when image paths/URLs have no
526 extension. This allows you to use the same source for formats that
527 require different kinds of images. Currently this option only affects
528 the Markdown and LaTeX readers.
532: Parse each file individually before combining for multifile
533 documents. This will allow footnotes in different files with the
534 same identifiers to work as expected. If this option is set,
535 footnotes and links will not work across files. Reading binary
536 files (docx, odt, epub) implies `--file-scope`.
538`-F` *PROGRAM*, `--filter=`*PROGRAM*
540: Specify an executable to be used as a filter transforming the
541 pandoc AST after the input is parsed and before the output is
542 written. The executable should read JSON from stdin and write
543 JSON to stdout. The JSON must be formatted like pandoc's own
544 JSON input and output. The name of the output format will be
545 passed to the filter as the first argument. Hence,
547 pandoc --filter ./caps.py -t latex
551 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
553 The latter form may be useful for debugging filters.
555 Filters may be written in any language. `Text.Pandoc.JSON`
556 exports `toJSONFilter` to facilitate writing filters in Haskell.
557 Those who would prefer to write filters in python can use the
558 module [`pandocfilters`], installable from PyPI. There are also
559 pandoc filter libraries in [PHP], [perl], and
560 [JavaScript/node.js].
562 In order of preference, pandoc will look for filters in
564 1. a specified full or relative path (executable or
567 2. `$DATADIR/filters` (executable or non-executable)
568 where `$DATADIR` is the user data directory (see
569 `--data-dir`, above).
571 3. `$PATH` (executable only)
573 Filters and lua-filters are applied in the order specified
576`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
578: Transform the document in a similar fashion as JSON filters (see
579 `--filter`), but use pandoc's build-in lua filtering system. The given
580 lua script is expected to return a list of lua filters which will be
581 applied in order. Each lua filter must contain element-transforming
582 functions indexed by the name of the AST element on which the filter
583 function should be applied.
585 The `pandoc` lua module provides helper functions for element
586 creation. It is always loaded into the script's lua environment.
588 The following is an example lua script for macro-expansion:
590 function expand_hello_world(inline)
591 if inline.c == '{{helloworld}}' then
592 return pandoc.Emph{ pandoc.Str "Hello, World" }
598 return {{Str = expand_hello_world}}
600 In order of preference, pandoc will look for lua filters in
602 1. a specified full or relative path (executable or
605 2. `$DATADIR/filters` (executable or non-executable)
606 where `$DATADIR` is the user data directory (see
607 `--data-dir`, above).
609`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
611: Set the metadata field *KEY* to the value *VAL*. A value specified
612 on the command line overrides a value specified in the document
613 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
614 Values will be parsed as YAML boolean or string values. If no value is
615 specified, the value will be treated as Boolean true. Like
616 `--variable`, `--metadata` causes template variables to be set.
617 But unlike `--variable`, `--metadata` affects the metadata of the
618 underlying document (which is accessible from filters and may be
619 printed in some output formats) and metadata values will be escaped
620 when inserted into the template.
622`--metadata-file=`*FILE*
624: Read metadata from the supplied YAML (or JSON) file. This
625 option can be used with every input format, but string scalars
626 in the YAML file will always be parsed as Markdown. Generally,
627 the input will be handled the same as in [YAML metadata
628 blocks][Extension: `yaml_metadata_block`]. This option can be
629 used repeatedly to include multiple metadata files; values in
630 files specified later on the command line will be preferred
631 over those specified in earlier files. Metadata values
632 specified inside the document, or by using `-M`, overwrite
633 values specified with this option.
635`-p`, `--preserve-tabs`
637: Preserve tabs instead of converting them to spaces (the default).
638 Note that this will only affect tabs in literal code spans and code
639 blocks; tabs in regular text will be treated as spaces.
643: Specify the number of spaces per tab (default is 4).
645`--track-changes=accept`|`reject`|`all`
647: Specifies what to do with insertions, deletions, and comments
648 produced by the MS Word "Track Changes" feature. `accept` (the
649 default), inserts all insertions, and ignores all
650 deletions. `reject` inserts all deletions and ignores
651 insertions. Both `accept` and `reject` ignore comments. `all` puts
652 in insertions, deletions, and comments, wrapped in spans with
653 `insertion`, `deletion`, `comment-start`, and `comment-end`
654 classes, respectively. The author and time of change is
655 included. `all` is useful for scripting: only accepting changes
656 from a certain reviewer, say, or before a certain date. If a
657 paragraph is inserted or deleted, `track-changes=all` produces a
658 span with the class `paragraph-insertion`/`paragraph-deletion`
659 before the affected paragraph break. This option only affects the
662`--extract-media=`*DIR*
664: Extract images and other media contained in or linked from
665 the source document to the path *DIR*, creating it if
666 necessary, and adjust the images references in the document
667 so they point to the extracted files. If the source format is
668 a binary container (docx, epub, or odt), the media is
669 extracted from the container and the original
670 filenames are used. Otherwise the media is read from the
671 file system or downloaded, and new filenames are constructed
672 based on SHA1 hashes of the contents.
674`--abbreviations=`*FILE*
676: Specifies a custom abbreviations file, with abbreviations
677 one to a line. If this option is not specified, pandoc will
678 read the data file `abbreviations` from the user data
679 directory or fall back on a system default. To see the
681 `pandoc --print-default-data-file=abbreviations`. The only
682 use pandoc makes of this list is in the Markdown reader.
683 Strings ending in a period that are found in this list will
684 be followed by a nonbreaking space, so that the period will
685 not produce sentence-ending space in formats like LaTeX.
687[`pandocfilters`]: https://github.com/jgm/pandocfilters
688[PHP]: https://github.com/vinai/pandocfilters-php
689[perl]: https://metacpan.org/pod/Pandoc::Filter
690[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
692## General writer options {.options}
696: Produce output with an appropriate header and footer (e.g. a
697 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
698 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
699 output. For `native` output, this option causes metadata to
700 be included; otherwise, metadata is suppressed.
702`--template=`*FILE*|*URL*
704: Use the specified file as a custom template for the generated document.
705 Implies `--standalone`. See [Templates], below, for a description
706 of template syntax. If no extension is specified, an extension
707 corresponding to the writer will be added, so that `--template=special`
708 looks for `special.html` for HTML output. If the template is not
709 found, pandoc will search for it in the `templates` subdirectory of
710 the user data directory (see `--data-dir`). If this option is not used,
711 a default template appropriate for the output format will be used (see
712 `-D/--print-default-template`).
714`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
716: Set the template variable *KEY* to the value *VAL* when rendering the
717 document in standalone mode. If no *VAL* is specified, the
718 key will be given the value `true`.
720`-D` *FORMAT*, `--print-default-template=`*FORMAT*
722: Print the system default template for an output *FORMAT*. (See `-t`
723 for a list of possible *FORMAT*s.) Templates in the user data
724 directory are ignored. This option may be used with
725 `-o`/`--output` to redirect output to a file, but
726 `-o`/`--output` must come before `--print-default-template`
729 Note that some of the default templates use partials, for
730 example `styles.html`. To print the partials, use
731 `--print-default-data-file`: for example,
732 `--print-default-data-file=templates/styles.html`.
734`--print-default-data-file=`*FILE*
736: Print a system default data file. Files in the user data directory
737 are ignored. This option may be used with `-o`/`--output` to
738 redirect output to a file, but `-o`/`--output` must come before
739 `--print-default-data-file` on the command line.
741`--eol=crlf`|`lf`|`native`
743: Manually specify line endings: `crlf` (Windows), `lf`
744 (macOS/Linux/UNIX), or `native` (line endings appropriate
745 to the OS on which pandoc is being run). The default is
750: Specify the default dpi (dots per inch) value for conversion
751 from pixels to inch/centimeters and vice versa. (Technically,
752 the correct term would be ppi: pixels per inch.) The default
753 is 96dpi. When images contain information about dpi
754 internally, the encoded value is used instead of the default
755 specified by this option.
757`--wrap=auto`|`none`|`preserve`
759: Determine how text is wrapped in the output (the source
760 code, not the rendered version). With `auto` (the default),
761 pandoc will attempt to wrap lines to the column width specified by
762 `--columns` (default 72). With `none`, pandoc will not wrap
763 lines at all. With `preserve`, pandoc will attempt to
764 preserve the wrapping from the source document (that is,
765 where there are nonsemantic newlines in the source, there
766 will be nonsemantic newlines in the output as well).
767 Automatic wrapping does not currently work in HTML output.
768 In `ipynb` output, this option affects wrapping of the
769 contents of markdown cells.
773: Specify length of lines in characters. This affects text wrapping
774 in the generated source code (see `--wrap`). It also affects
775 calculation of column widths for plain text tables (see [Tables] below).
777`--toc`, `--table-of-contents`
779: Include an automatically generated table of contents (or, in
780 the case of `latex`, `context`, `docx`, `odt`,
781 `opendocument`, `rst`, or `ms`, an instruction to create
782 one) in the output document. This option has no effect
783 unless `-s/--standalone` is used, and it has no effect
784 on `man`, `docbook4`, `docbook5`, or `jats` output.
786 Note that if you are producing a PDF via `ms`, the table
787 of contents will appear at the beginning of the
788 document, before the title. If you would prefer it to
789 be at the end of the document, use the option
790 `--pdf-engine-opt=--no-toc-relocation`.
792`--toc-depth=`*NUMBER*
794: Specify the number of section levels to include in the table
795 of contents. The default is 3 (which means that level-1, 2, and 3
796 headings will be listed in the contents).
800: Strip out HTML comments in the Markdown or Textile source,
801 rather than passing them on to Markdown, Textile or HTML
802 output as raw HTML. This does not apply to HTML comments
803 inside raw HTML blocks when the `markdown_in_html_blocks`
804 extension is not set.
808: Disables syntax highlighting for code blocks and inlines, even when
809 a language attribute is given.
811`--highlight-style=`*STYLE*|*FILE*
813: Specifies the coloring style to be used in highlighted source code.
814 Options are `pygments` (the default), `kate`, `monochrome`,
815 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
816 For more information on syntax highlighting in pandoc, see
817 [Syntax highlighting], below. See also
818 `--list-highlight-styles`.
820 Instead of a *STYLE* name, a JSON file with extension
821 `.theme` may be supplied. This will be parsed as a KDE
822 syntax highlighting theme and (if valid) used as the
825 To generate the JSON version of an existing style,
826 use `--print-highlight-style`.
828`--print-highlight-style=`*STYLE*|*FILE*
830: Prints a JSON version of a highlighting style, which can
831 be modified, saved with a `.theme` extension, and used
832 with `--highlight-style`. This option may be used with
833 `-o`/`--output` to redirect output to a file, but
834 `-o`/`--output` must come before `--print-highlight-style`
837`--syntax-definition=`*FILE*
839: Instructs pandoc to load a KDE XML syntax definition file,
840 which will be used for syntax highlighting of appropriately
841 marked code blocks. This can be used to add support for
842 new languages or to use altered syntax definitions for
843 existing languages. This option may be repeated to add
844 multiple syntax definitions.
846`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
848: Include contents of *FILE*, verbatim, at the end of the header.
849 This can be used, for example, to include special
850 CSS or JavaScript in HTML documents. This option can be used
851 repeatedly to include multiple files in the header. They will be
852 included in the order specified. Implies `--standalone`.
854`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
856: Include contents of *FILE*, verbatim, at the beginning of the
857 document body (e.g. after the `<body>` tag in HTML, or the
858 `\begin{document}` command in LaTeX). This can be used to include
859 navigation bars or banners in HTML documents. This option can be
860 used repeatedly to include multiple files. They will be included in
861 the order specified. Implies `--standalone`.
863`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
865: Include contents of *FILE*, verbatim, at the end of the document
866 body (before the `</body>` tag in HTML, or the
867 `\end{document}` command in LaTeX). This option can be used
868 repeatedly to include multiple files. They will be included in the
869 order specified. Implies `--standalone`.
871`--resource-path=`*SEARCHPATH*
873: List of paths to search for images and other resources.
874 The paths should be separated by `:` on Linux, UNIX, and
875 macOS systems, and by `;` on Windows. If `--resource-path`
876 is not specified, the default resource path is the working
877 directory. Note that, if `--resource-path` is specified,
878 the working directory must be explicitly listed or it
879 will not be searched. For example:
880 `--resource-path=.:test` will search the working directory
881 and the `test` subdirectory, in that order.
883 `--resource-path` only has an effect if (a) the output
884 format embeds images (for example, `docx`, `pdf`, or `html`
885 with `--self-contained`) or (b) it is used together with
888`--request-header=`*NAME*`:`*VAL*
890: Set the request header *NAME* to the value *VAL* when making
891 HTTP requests (for example, when a URL is given on the
892 command line, or when resources used in a document must be
893 downloaded). If you're behind a proxy, you also need to set
894 the environment variable `http_proxy` to `http://...`.
896## Options affecting specific writers {.options}
900: Produce a standalone HTML file with no external dependencies, using
901 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
902 images, and videos. Implies `--standalone`. The resulting file should be
903 "self-contained," in the sense that it needs no external files and no net
904 access to be displayed properly by a browser. This option works only with
905 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
906 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
907 and stylesheets at absolute URLs will be downloaded; those at relative
908 URLs will be sought relative to the working directory (if the first source
909 file is local) or relative to the base URL (if the first source
910 file is remote). Elements with the attribute
911 `data-external="1"` will be left alone; the documents they
912 link to will not be incorporated in the document.
913 Limitation: resources that are loaded dynamically through
914 JavaScript cannot be incorporated; as a result,
915 `--self-contained` does not work with `--mathjax`, and some
916 advanced features (e.g. zoom or speaker notes) may not work
917 in an offline "self-contained" `reveal.js` slide show.
921: Use `<q>` tags for quotes in HTML.
925: Use only ASCII characters in output. Currently supported for XML
926 and HTML formats (which use entities instead of UTF-8 when this
927 option is selected), CommonMark, gfm, and Markdown (which use
928 entities), roff ms (which use hexadecimal escapes), and to a
929 limited degree LaTeX (which uses standard commands for accented
930 characters when possible). roff man output uses ASCII by default.
934: Use reference-style links, rather than inline links, in writing Markdown
935 or reStructuredText. By default inline links are used. The
936 placement of link references is affected by the
937 `--reference-location` option.
939`--reference-location = block`|`section`|`document`
941: Specify whether footnotes (and references, if `reference-links` is
942 set) are placed at the end of the current (top-level) block, the
943 current section, or the document. The default is
944 `document`. Currently only affects the markdown writer.
948: Use ATX-style headings in Markdown output. The default is
949 to use setext-style headings for levels 1 to 2, and then ATX headings.
950 (Note: for `gfm` output, ATX headings are always used.)
951 This option also affects markdown cells in `ipynb` output.
953`--top-level-division=[default|section|chapter|part]`
955: Treat top-level headings as the given division type in LaTeX, ConTeXt,
956 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
957 all headings are shifted such that the top-level heading becomes the specified
958 type. The default behavior is to determine the best division type via
959 heuristics: unless other conditions apply, `section` is chosen. When the
960 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
961 `article` option is specified), `chapter` is implied as the setting for this
962 option. If `beamer` is the output format, specifying either `chapter` or
963 `part` will cause top-level headings to become `\part{..}`, while
964 second-level headings remain as their default type.
966`-N`, `--number-sections`
968: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
969 By default, sections are not numbered. Sections with class
970 `unnumbered` will never be numbered, even if `--number-sections`
973`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
975: Offset for section headings in HTML output (ignored in other
976 output formats). The first number is added to the section number for
977 top-level headings, the second for second-level headings, and so on.
978 So, for example, if you want the first top-level heading in your
979 document to be numbered "6", specify `--number-offset=5`.
980 If your document starts with a level-2 heading which you want to
981 be numbered "1.5", specify `--number-offset=1,4`.
982 Offsets are 0 by default. Implies `--number-sections`.
986: Use the [`listings`] package for LaTeX code blocks. The package
987 does not support multi-byte encoding for source code. To handle UTF-8
988 you would need to use a custom template. This issue is fully
989 documented here: [Encoding issue with the listings package].
993: Make list items in slide shows display incrementally (one by one).
994 The default is for lists to be displayed all at once.
996`--slide-level=`*NUMBER*
998: Specifies that headings with the specified level create
999 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1000 above this level in the hierarchy are used to divide the
1001 slide show into sections; headings below this level create
1002 subheads within a slide. Note that content that is
1003 not contained under slide-level headings will not appear in
1004 the slide show. The default is to set the slide level based
1005 on the contents of the document; see [Structuring the slide
1010: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1011 and attach identifiers to the enclosing `<section>` (or `<div>`)
1012 rather than the heading itself. See
1013 [Heading identifiers], below.
1015`--email-obfuscation=none`|`javascript`|`references`
1017: Specify a method for obfuscating `mailto:` links in HTML documents.
1018 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1019 them using JavaScript. `references` obfuscates them by printing their
1020 letters as decimal or hexadecimal character references. The default
1023`--id-prefix=`*STRING*
1025: Specify a prefix to be added to all identifiers and internal links
1026 in HTML and DocBook output, and to footnote numbers in Markdown
1027 and Haddock output. This is useful for preventing duplicate
1028 identifiers when generating fragments to be included in other pages.
1030`-T` *STRING*, `--title-prefix=`*STRING*
1032: Specify *STRING* as a prefix at the beginning of the title
1033 that appears in the HTML header (but not in the title as it
1034 appears at the beginning of the HTML body). Implies
1037`-c` *URL*, `--css=`*URL*
1039: Link to a CSS style sheet. This option can be used repeatedly to
1040 include multiple files. They will be included in the order specified.
1042 A stylesheet is required for generating EPUB. If none is
1043 provided using this option (or the `css` or `stylesheet`
1044 metadata fields), pandoc will look for a file `epub.css` in the
1045 user data directory (see `--data-dir`). If it is not
1046 found there, sensible defaults will be used.
1048`--reference-doc=`*FILE*
1050: Use the specified file as a style reference in producing a
1055 : For best results, the reference docx should be a modified
1056 version of a docx file produced using pandoc. The contents
1057 of the reference docx are ignored, but its stylesheets and
1058 document properties (including margins, page size, header,
1059 and footer) are used in the new docx. If no reference docx
1060 is specified on the command line, pandoc will look for a
1061 file `reference.docx` in the user data directory (see
1062 `--data-dir`). If this is not found either, sensible
1063 defaults will be used.
1065 To produce a custom `reference.docx`, first get a copy of
1066 the default `reference.docx`: `pandoc
1067 -o custom-reference.docx --print-default-data-file reference.docx`.
1068 Then open `custom-reference.docx` in Word, modify the
1069 styles as you wish, and save the file. For best
1070 results, do not make changes to this file other than
1071 modifying the styles used by pandoc:
1107 - Default Paragraph Font
1110 - Footnote Reference
1119 : For best results, the reference ODT should be a modified
1120 version of an ODT produced using pandoc. The contents of
1121 the reference ODT are ignored, but its stylesheets are used
1122 in the new ODT. If no reference ODT is specified on the
1123 command line, pandoc will look for a file `reference.odt` in
1124 the user data directory (see `--data-dir`). If this is not
1125 found either, sensible defaults will be used.
1127 To produce a custom `reference.odt`, first get a copy of
1128 the default `reference.odt`: `pandoc
1129 -o custom-reference.odt --print-default-data-file reference.odt`.
1130 Then open `custom-reference.odt` in LibreOffice, modify
1131 the styles as you wish, and save the file.
1135 : Templates included with Microsoft PowerPoint 2013 (either with
1136 `.pptx` or `.potx` extension) are known to work, as are most
1137 templates derived from these.
1139 The specific requirement is that the template should begin with
1140 the following first four layouts:
1143 2. Title and Content
1147 All templates included with a recent version of MS PowerPoint
1148 will fit these criteria. (You can click on `Layout` under the
1149 `Home` menu to check.)
1151 You can also modify the default `reference.pptx`: first run
1152 `pandoc -o custom-reference.pptx --print-default-data-file
1153 reference.pptx`, and then modify `custom-reference.pptx`
1154 in MS PowerPoint (pandoc will use the first four layout
1155 slides, as mentioned above).
1157`--epub-cover-image=`*FILE*
1159: Use the specified image as the EPUB cover. It is recommended
1160 that the image be less than 1000px in width and height. Note that
1161 in a Markdown source document you can also specify `cover-image`
1162 in a YAML metadata block (see [EPUB Metadata], below).
1164`--epub-metadata=`*FILE*
1166: Look in the specified XML file for metadata for the EPUB.
1167 The file should contain a series of [Dublin Core elements].
1170 <dc:rights>Creative Commons</dc:rights>
1171 <dc:language>es-AR</dc:language>
1173 By default, pandoc will include the following metadata elements:
1174 `<dc:title>` (from the document title), `<dc:creator>` (from the
1175 document authors), `<dc:date>` (from the document date, which should
1176 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1177 variable, or, if is not set, the locale), and `<dc:identifier
1178 id="BookId">` (a randomly generated UUID). Any of these may be
1179 overridden by elements in the metadata file.
1181 Note: if the source document is Markdown, a YAML metadata block
1182 in the document can be used instead. See below under
1185`--epub-embed-font=`*FILE*
1187: Embed the specified font in the EPUB. This option can be repeated
1188 to embed multiple fonts. Wildcards can also be used: for example,
1189 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1190 line, be sure to escape them or put the whole filename in single quotes,
1191 to prevent them from being interpreted by the shell. To use the
1192 embedded fonts, you will need to add declarations like the following
1193 to your CSS (see `--css`):
1196 font-family: DejaVuSans;
1198 font-weight: normal;
1199 src:url("DejaVuSans-Regular.ttf");
1202 font-family: DejaVuSans;
1205 src:url("DejaVuSans-Bold.ttf");
1208 font-family: DejaVuSans;
1210 font-weight: normal;
1211 src:url("DejaVuSans-Oblique.ttf");
1214 font-family: DejaVuSans;
1217 src:url("DejaVuSans-BoldOblique.ttf");
1219 body { font-family: "DejaVuSans"; }
1221`--epub-chapter-level=`*NUMBER*
1223: Specify the heading level at which to split the EPUB into separate
1224 "chapter" files. The default is to split into chapters at level-1
1225 headings. This option only affects the internal composition of the
1226 EPUB, not the way chapters and sections are displayed to users. Some
1227 readers may be slow if the chapter files are too large, so for large
1228 documents with few level-1 headings, one might want to use a chapter
1231`--epub-subdirectory=`*DIRNAME*
1233: Specify the subdirectory in the OCF container that is to hold
1234 the EPUB-specific contents. The default is `EPUB`. To put
1235 the EPUB contents in the top level, use an empty string.
1237`--ipynb-output=all|none|best`
1239: Determines how ipynb output cells are treated. `all` means
1240 that all of the data formats included in the original are
1241 preserved. `none` means that the contents of data cells
1242 are omitted. `best` causes pandoc to try to pick the
1243 richest data block in each output cell that is compatible
1244 with the output format. The default is `best`.
1246`--pdf-engine=`*PROGRAM*
1248: Use the specified engine when producing PDF output.
1249 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1250 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1251 and `pdfroff`. The default is `pdflatex`. If the engine is
1252 not in your PATH, the full path of the engine may be specified here.
1254`--pdf-engine-opt=`*STRING*
1256: Use the given string as a command-line argument to the `pdf-engine`.
1257 For example, to use a persistent directory `foo` for `latexmk`'s
1258 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1259 Note that no check for duplicate options is done.
1261[Dublin Core elements]: http://dublincore.org/documents/dces/
1262[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1263[Encoding issue with the listings package]:
1264 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1266## Citation rendering {.options}
1268`--bibliography=`*FILE*
1270: Set the `bibliography` field in the document's metadata to *FILE*,
1271 overriding any value set in the metadata, and process citations
1272 using `pandoc-citeproc`. (This is equivalent to
1273 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1274 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1275 used, making this equivalent to `--metadata bibliography=FILE`.
1276 If you supply this argument multiple times, each *FILE* will be added
1281: Set the `csl` field in the document's metadata to *FILE*,
1282 overriding any value set in the metadata. (This is equivalent to
1283 `--metadata csl=FILE`.)
1284 This option is only relevant with `pandoc-citeproc`.
1286`--citation-abbreviations=`*FILE*
1288: Set the `citation-abbreviations` field in the document's metadata to
1289 *FILE*, overriding any value set in the metadata. (This is equivalent to
1290 `--metadata citation-abbreviations=FILE`.)
1291 This option is only relevant with `pandoc-citeproc`.
1295: Use [`natbib`] for citations in LaTeX output. This option is not for use
1296 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1297 use in producing a LaTeX file that can be processed with [`bibtex`].
1301: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1302 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1303 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1305## Math rendering in HTML {.options}
1307The default is to render TeX math as far as possible using Unicode characters.
1308Formulas are put inside a `span` with `class="math"`, so that they may be styled
1309differently from the surrounding text if needed. However, this gives acceptable
1310results only for basic math, usually you will want to use `--mathjax` or another
1311of the following options.
1313`--mathjax`[`=`*URL*]
1315: Use [MathJax] to display embedded TeX math in HTML output.
1316 TeX math will be put between `\(...\)` (for inline math)
1317 or `\[...\]` (for display math) and wrapped in `<span>` tags
1318 with class `math`. Then the MathJax JavaScript will render it.
1319 The *URL* should point to the `MathJax.js` load script.
1320 If a *URL* is not provided, a link to the Cloudflare CDN will
1325: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1326 `html4` and `html5`). This is the default in `odt` output. Note that
1327 currently only Firefox and Safari (and select e-book readers) natively
1332: Convert TeX formulas to `<img>` tags that link to an external script
1333 that converts formulas to images. The formula will be URL-encoded
1334 and concatenated with the URL provided. For SVG images you can for
1335 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1336 If no URL is specified, the CodeCogs URL generating PNGs
1337 will be used (`https://latex.codecogs.com/png.latex?`).
1338 Note: the `--webtex` option will affect Markdown output
1339 as well as HTML, which is useful if you're targeting a
1340 version of Markdown without native math support.
1344: Use [KaTeX] to display embedded TeX math in HTML output.
1345 The *URL* is the base URL for the KaTeX library. That directory
1346 should contain a `katex.min.js` and a `katex.min.css` file.
1347 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1351: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1352 can then be processed by [GladTeX] to produce images of the typeset
1353 formulas and an HTML file with links to these images.
1354 So, the procedure is:
1356 pandoc -s --gladtex input.md -o myfile.htex
1357 gladtex -d myfile-images myfile.htex
1358 # produces myfile.html and images in myfile-images
1360[MathML]: http://www.w3.org/Math/
1361[MathJax]: https://www.mathjax.org
1362[KaTeX]: https://github.com/Khan/KaTeX
1363[GladTeX]: http://humenda.github.io/GladTeX/
1365## Options for wrapper scripts {.options}
1369: Print information about command-line arguments to *stdout*, then exit.
1370 This option is intended primarily for use in wrapper scripts.
1371 The first line of output contains the name of the output file specified
1372 with the `-o` option, or `-` (for *stdout*) if no output file was
1373 specified. The remaining lines contain the command-line arguments,
1374 one per line, in the order they appear. These do not include regular
1375 pandoc options and their arguments, but do include any options appearing
1376 after a `--` separator at the end of the line.
1380: Ignore command-line arguments (for use in wrapper scripts).
1381 Regular pandoc options are not ignored. Thus, for example,
1383 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1387 pandoc -o foo.html -s
1391If pandoc completes successfully, it will return exit code 0.
1392Nonzero exit codes have the following meanings:
1395----- ------------------------------------
1396 3 PandocFailOnWarningError
1398 5 PandocTemplateError
1400 21 PandocUnknownReaderError
1401 22 PandocUnknownWriterError
1402 23 PandocUnsupportedExtensionError
1403 31 PandocEpubSubdirectoryError
1405 47 PandocPDFProgramNotFoundError
1407 62 PandocShouldNeverHappenError
1410 65 PandocParsecError
1411 66 PandocMakePDFError
1412 67 PandocSyntaxMapError
1413 83 PandocFilterError
1415 92 PandocUTF8DecodingError
1416 93 PandocIpynbDecodingError
1417 97 PandocCouldNotFindDataFileError
1418 99 PandocResourceNotFound
1419----- ------------------------------------
1423The `--defaults` option may be used to specify a package
1424of options. Here is a sample defaults file demonstrating all of
1425the fields that may be used:
1429# reader: may be used instead of from:
1431# writer: may be used instead of to:
1433# leave blank for output to stdout:
1435# leave blank for input from stdin:
1442self-contained: false
1444# note that structured variables may be specified:
1451# metadata values specified here are parsed as literal
1452# string text, not markdown:
1459# or you may use metadata-file: with a single value
1461# Note that these take files, not their contents:
1462include-before-body: []
1463include-after-body: []
1464include-in-header: []
1467# filters will be assumed to be lua filters if they have
1468# the .lua extension, and json filters otherwise. But
1469# the filter type can also be specified explicitly, as shown:
1480# ERROR, WARNING, or INFO
1484# citeproc, natbib, or biblatex
1485cite-method: citeproc
1486# part, chapter, section, or default:
1487top-level-division: chapter
1493# you may also use pdf-engine-opt: with a single option
1494# pdf-engine-opt: "-shell-escape"
1496# auto, preserve, or none
1501extract-media: mediadir
1503table-of-contents: true
1505number-sections: false
1506# a list of offsets at each heading level
1507number-offset: [0,0,0,0,0,0]
1508# toc: may also be used instead of table-of-contents:
1509shift-heading-level-by: 1
1511identifier-prefix: foo
1513strip-empty-paragraphs: true
1514# lf, crlf, or native
1516strip-comments: false
1517indented-code-classes: []
1519default-image-extension: ".jpg"
1521# either a style name of a style definition file:
1522highlight-style: pygments
1525# or you may use syntax-definition: with a single value
1528reference-doc: myref.docx
1530# method is plain, webtex, gladtex, mathml, mathjax, katex
1531# you may specify a url with webtex, mathjax, katex
1534 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1535# none, references, or javascript
1536email-obfuscation: javascript
1544epub-subdirectory: EPUB
1545epub-metadata: meta.xml
1548epub-chapter-level: 1
1549epub-cover-image: cover.jpg
1551reference-links: true
1552# block, section, or document
1553reference-location: block
1556# accept, reject, or all
1557track-changes: accept
1566# A list of two-element lists
1568- ["User-Agent", "Mozilla/5.0"]
1570fail-if-warnings: false
1576Fields that are omitted will just have their regular
1577default values. So a defaults file can be as simple as
1584Default files can be placed in the `defaults` subdirectory of
1585the user data directory and used from any directory. For
1586example, one could create a file specifying defaults for writing
1587letters, save it as `letter.yaml` in the `defaults` subdirectory
1588of the user data directory, and then invoke these defaults
1589from any directory using `pandoc --defaults letter`
1590or `pandoc -dletter`.
1594When the `-s/--standalone` option is used, pandoc uses a template to
1595add header and footer material that is needed for a self-standing
1596document. To see the default template that is used, just type
1600where *FORMAT* is the name of the output format. A custom template
1601can be specified using the `--template` option. You can also override
1602the system default templates for a given output format *FORMAT*
1603by putting a file `templates/default.*FORMAT*` in the user data
1604directory (see `--data-dir`, above). *Exceptions:*
1606- For `odt` output, customize the `default.opendocument`
1608- For `pdf` output, customize the `default.latex` template
1609 (or the `default.context` template, if you use `-t context`,
1610 or the `default.ms` template, if you use `-t ms`, or the
1611 `default.html` template, if you use `-t html`).
1612- `docx` and `pptx` have no template (however, you can use
1613 `--reference-doc` to customize the output).
1615Templates contain *variables*, which allow for the inclusion of
1616arbitrary information at any point in the file. They may be set at the
1617command line using the `-V/--variable` option. If a variable is not set,
1618pandoc will look for the key in the document's metadata, which can be set
1619using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1620or with the `-M/--metadata` option. In addition, some variables
1621are given default values by pandoc. See [Variables] below for
1622a list of variables used in pandoc's default templates.
1624If you use custom templates, you may need to revise them as pandoc
1625changes. We recommend tracking the changes in the default templates,
1626and modifying your custom templates accordingly. An easy way to do this
1627is to fork the [pandoc-templates] repository and merge in
1628changes after each pandoc release.
1630 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1636Anything between the sequence `$--` and the end of the
1637line will be treated as a comment and omitted from the output.
1641To mark variables and control structures in the template,
1642either `$`...`$` or `${`...`}` may be used as delimiters.
1643The styles may also be mixed in the same template, but the
1644opening and closing delimiter must match in each case. The
1645opening delimiter may be followed by one or more spaces
1646or tabs, which will be ignored. The closing delimiter may
1647be followed by one or more spaces or tabs, which will be
1650To include a literal `$` in the document, use `$$`.
1652### Interpolated variables
1654A slot for an interpolated variable is a variable name surrounded
1655by matched delimiters. Variable names must begin with a letter
1656and can contain letters, numbers, `_`, `-`, and `.`. The
1657keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1658not be used as variable names. Examples:
1671Variable names with periods are used to get at structured
1672variable values. So, for example, `employee.salary` will return the
1673value of the `salary` field of the object that is the value of
1674the `employee` field.
1676- If the value of the variable is simple value, it will be
1677 rendered verbatim. (Note that no escaping is done;
1678 the assumption is that the calling program will escape
1679 the strings appropriately for the output format.)
1680- If the value is a list, the values will be concatenated.
1681- If the value is a map, the string `true` will be rendered.
1682- Every other value will be rendered as the empty string.
1686A conditional begins with `if(variable)` (enclosed in
1687matched delimiters) and ends with `endif` (enclosed in matched
1688delimiters). It may optionally contain an `else` (enclosed in
1689matched delimiters). The `if` section is used if
1690`variable` has a non-empty value, otherwise the `else`
1691section is used (if present). Examples:
1706${if(foo)}bar${endif}
1719The keyword `elseif` may be used to simplify complex nested
1734A for loop begins with `for(variable)` (enclosed in
1735matched delimiters) and ends with `endfor` (enclosed in matched
1738- If `variable` is an array, the material inside the loop will
1739 be evaluated repeatedly, with `variable` being set to each
1740 value of the array in turn, and concatenated.
1741- If the value of the associated variable is not an array or
1742 a map, a single iteration will be performed on its value.
1747$for(foo)$$foo$$sep$, $endfor$
1750 - $foo.last$, $foo.first$
1754 - ${ foo.bar.last }, ${ foo.bar.first }
1758You may optionally specify a separator between consecutive
1759values using `sep` (enclosed in matched delimiters). The
1760material between `sep` and the `endfor` is the separator.
1763${ for(foo) }${ foo }${ sep }, ${ endfor }
1766Instead of using `variable` inside the loop, the special
1767anaphoric keyword `it` may be used.
1771 - ${ it.last }, ${ it.first }
1777Partials (subtemplates stored in different files) may be
1778included using the syntax
1784Partials will be sought in the directory containing
1785the main template, and will be assumed to have the
1786same extension as the main template if they lack
1787an explicit extension. (If the partials are not
1788found here, they will also be sought in the `templates`
1789subdirectory of the user data directory.)
1791Partials may optionally be applied to variables using
1797${ articles:bibentry() }
1800If `articles` is an array, this will iterate over its
1801values, applying the partial `bibentry()` to each one. So the
1802second example above is equivalent to
1810Note that the anaphoric keyword `it` must be used when
1811iterating over partials. In the above examples,
1812the `bibentry` partial should contain `it.title`
1813(and so on) instead of `articles.title`.
1815Final newlines are omitted from included partials.
1817Partials may include other partials.
1819A separator between values of an array may be specified
1820in square brackets, immediately after the variable name
1826${articles:bibentry()[; ]$
1829The separator in this case is literal and (unlike with `sep`
1830in an explicit `for` loop) cannot contain interpolated
1831variables or other template directives.
1835To ensure that content is "nested," that is, subsequent lines
1836indented, use the `^` directive:
1839$item.number$ $^$$item.description$ ($item.price$)
1842In this example, if `item.description` has multiple lines,
1843they will all be indented to line up with the first line:
184600123 A fine bottle of 18-year old
1847 Oban whiskey. ($148)
1850To nest multiple lines to the same level, align them
1851with the `^` directive in the template. For example:
1854$item.number$ $^$$item.description$ ($item.price$)
1855 (Available til $item.sellby$.)
186100123 A fine bottle of 18-year old
1862 Oban whiskey. ($148)
1863 (Available til March 30, 2020.)
1866If a variable occurs by itself on a line, preceded by whitespace
1867and not followed by further text or directives on the same line,
1868and the variable's value contains multiple lines, it will be
1869nested automatically.
1873Normally, spaces in the template itself (as opposed to values of
1874the interpolated variables) are not breakable, but they can be
1875made breakable in part of the template by using the `~` keyword
1876(ended with another `~`).
1879$~$This long line may break if the document is rendered
1880with a short line length.$~$
1885A filter transforms the value of a variable. Filters are
1886specified using a slash (`/`) between the variable name and
1887the filter name. They may go anywhere a variable can go.
1895$for(metadata/pairs)$
1896- $it.key$: $it.value$
1900Filters may be chained:
1903$for(employees/pairs)$
1904$it.key/alpha/uppercase$. $it.name$
1908Some filters take parameters:
1911|----------------------|------------|
1913$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1915|----------------------|------------|
1918Currently the following filters are predefined:
1920- `pairs`: Converts a map or array to an array of maps,
1921 each with `key` and `value` fields. If the original
1922 value was an array, the `key` will be the array index,
1925- `uppercase`: Converts a textual value to uppercase,
1926 and has no effect on other values.
1928- `lowercase`: Converts a textual value to lowercase,
1929 and has no effect on other values.
1931- `length`: Returns the length of the value: number
1932 of characters for a textual value, number of elements
1935- `reverse`: Reverses a textual value or array,
1936 and has no effect on other values.
1938- `alpha`: Converts a textual value that can be
1939 read as an integer into a lowercase alphabetic
1940 character `a..z` (mod 26), and has no effect on
1941 other values. This can be used to get lettered
1942 enumeration from array indices. To get uppercase
1943 letters, chain with `uppercase`.
1945- `roman`: Converts a textual value that can be
1946 read as an integer into a lowercase roman numerial,
1947 and has no effect on other values. This can be used
1948 to get lettered enumeration from array indices. To
1949 get uppercase roman, chain with `uppercase`.
1951- `left n "leftborder" "rightborder"`: Renders a textual value
1952 in a block of width `n`, aligned to the left, with an optional
1953 left and right border. Has no effect on other values. This
1954 can be used to align material in tables. Widths are positive
1955 integers indicating the number of characters. Borders
1956 are strings inside double quotes; literal `"` and `\` characters
1957 must be backslash-escaped.
1959- `right n "leftborder" "rightborder"`: Renders a textual value
1960 in a block of width `n`, aligned to the right, and has no
1961 effect on other values.
1963- `center n "leftborder" "rightborder"`: Renders a textual
1964 value in a block of width `n`, aligned to the center, and has
1965 no effect on other values.
1970### Metadata variables
1972`title`, `author`, `date`
1973: allow identification of basic aspects of the document. Included
1974 in PDF metadata through LaTeX and ConTeXt. These can be set
1975 through a [pandoc title block][Extension: `pandoc_title_block`],
1976 which allows for multiple authors, or through a
1977 [YAML metadata block][Extension: `yaml_metadata_block`]:
1985 Note that if you just want to set PDF or HTML metadata, without
1986 including a title block in the document itself, you can
1987 set the `title-meta`, `author-meta`, and `date-meta`
1988 variables. (By default these are set automatically, based
1989 on `title`, `author`, and `date`.)
1992: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
1996: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2000: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2001 and AsciiDoc metadata; repeat as for `author`, above
2004: document subject, included in ODT, PDF, docx and pptx metadata
2007: document description, included in ODT, docx and pptx metadata. Some
2008 applications show this as `Comments` metadata.
2011: document category, included in docx and pptx metadata
2014any root-level string metadata, not included in ODT, docx
2015or pptx metadata is added as a *custom property*.
2016The following [YAML] metadata block for instance:
2019 title: 'This is the title'
2020 subtitle: "This is the subtitle"
2028 It consists of two paragraphs
2031will include `title`, `author` and `description` as standard document
2032properties and `subtitle` as a custom property when converting to docx,
2035### Language variables
2038: identifies the main language of the document using IETF language
2039 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2040 The [Language subtag lookup] tool can look up or verify these tags.
2041 This affects most formats, and controls hyphenation in PDF output
2042 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2044 Use native pandoc [Divs and Spans] with the `lang` attribute to
2045 switch the language:
2051 Text in the main document language (British English).
2054 > Cette citation est écrite en français canadien.
2057 More text in English. ['Zitat auf Deutsch.']{lang=de}
2060: the base script direction, either `rtl` (right-to-left)
2061 or `ltr` (left-to-right).
2063 For bidirectional documents, native pandoc `span`s and `div`s
2064 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2065 override the base direction in some output formats.
2066 This may not always be necessary if the final renderer
2067 (e.g. the browser, when generating HTML) supports the
2068 [Unicode Bidirectional Algorithm].
2070 When using LaTeX for bidirectional documents, only the `xelatex` engine
2071 is fully supported (use `--pdf-engine=xelatex`).
2073[BCP 47]: https://tools.ietf.org/html/bcp47
2074[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2075[Language subtag lookup]: https://r12a.github.io/app-subtags/
2077### Variables for HTML math
2080: when using [KaTeX](#option--katex), you can render display math equations
2081 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2083### Variables for HTML slides
2085These affect HTML output when [producing slide shows with pandoc].
2087All [reveal.js configuration options] are available as variables.
2088To turn off boolean flags that default to true in reveal.js, use `0`.
2091: base URL for reveal.js documents (defaults to `reveal.js`)
2094: base URL for S5 documents (defaults to `s5/default`)
2097: base URL for Slidy documents (defaults to
2098 `https://www.w3.org/Talks/Tools/Slidy2`)
2101: base URL for Slideous documents (defaults to `slideous`)
2103[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2105### Variables for Beamer slides
2107These variables change the appearance of PDF slides using [`beamer`].
2110: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2111 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2115: produce an article from Beamer slides
2118: add extra beamer option with `\setbeameroption{}`
2121: author affiliations: can be a list when there are multiple authors
2124: logo image for slides
2127: controls navigation symbols (default is `empty` for no navigation
2128 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2131: enables "title pages" for new sections (default is true)
2133`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2137: options for LaTeX beamer themes (a list).
2140: image for title slide
2142### Variables for PowerPoint
2144These variables control the visual aspects of a slide show that
2145are not easily controled via templates.
2148: font to use for code.
2150### Variables for LaTeX
2152Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2157: make `\paragraph` and `\subparagraph` (fourth- and
2158 fifth-level headings, or fifth- and sixth-level with book
2159 classes) free-standing rather than run-in; requires further
2160 formatting to distinguish from `\subsubsection` (third- or
2161 fourth-level headings). Instead of using this option,
2162 [KOMA-Script] can adjust headings more extensively:
2165 documentclass: scrartcl
2167 \RedeclareSectionCommand[
2168 beforeskip=-10pt plus -2pt minus -1pt,
2169 afterskip=1sp plus -1sp minus 1sp,
2170 font=\normalfont\itshape]{paragraph}
2171 \RedeclareSectionCommand[
2172 beforeskip=-10pt plus -2pt minus -1pt,
2173 afterskip=1sp plus -1sp minus 1sp,
2174 font=\normalfont\scshape,
2175 indent=0pt]{subparagraph}
2179: option for document class, e.g. `oneside`; repeat for multiple options:
2188: document class: usually one of the standard classes, [`article`], [`book`],
2189 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2190 and `scrreprt`, which default to smaller margins; or [`memoir`]
2193: option for [`geometry`] package, e.g. `margin=1in`;
2194 repeat for multiple options:
2204: option for [`hyperref`] package, e.g. `linktoc=all`;
2205 repeat for multiple options:
2211 - pdfpagemode=FullScreen
2215: uses document class settings for indentation (the default LaTeX template
2216 otherwise removes indentation and adds space between paragraphs)
2219: adjusts line spacing using the [`setspace`]
2220 package, e.g. `1.25`, `1.5`
2222`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2223: sets margins if `geometry` is not used (otherwise `geometry`
2227: control `\pagestyle{}`: the default article class
2228 supports `plain` (default), `empty` (no running heads or page numbers),
2229 and `headings` (section titles in running heads)
2232: paper size, e.g. `letter`, `a4`
2235: numbering depth for sections (with `--number-sections` option
2236 or `numbersections` variable)
2241: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2242 default is `T1` (see [LaTeX font encodings guide])
2245: font package for use with `pdflatex`:
2246 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2247 The default is [Latin Modern][`lm`].
2250: options for package used as `fontfamily`; repeat for multiple options.
2251 For example, to use the Libertine font with proportional lowercase
2252 (old-style) figures through the [`libertinus`] package:
2255 fontfamily: libertinus
2262: font size for body text. The standard classes allow 10pt, 11pt, and
2263 12pt. To use another size, set `documentclass` to one of
2264 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2266`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2267: font families for use with `xelatex` or
2268 `lualatex`: take the name of any system font, using the
2269 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2271`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2272: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2273 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2274 choices available through [`fontspec`]; repeat for multiple
2275 options. For example, to use the [TeX Gyre] version of
2276 Palatino with lowercase figures:
2279 mainfont: TeX Gyre Pagella
2282 - Numbers=Proportional
2286: options to pass to the microtype package
2291: add color to link text; automatically enabled if any of
2292 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2294`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2295: color for internal links, external links, citation links, linked
2296 URLs, and links in table of contents, respectively: uses options
2297 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2301: causes links to be printed as footnotes
2306: include list of figures, list of tables
2309: contents of acknowledgments footnote after document title
2312: include table of contents (can also be set using `--toc/--table-of-contents`)
2315: level of section to include in table of contents
2317#### BibLaTeX Bibliographies
2319These variables function when using BibLaTeX for [citation rendering].
2322: list of options for biblatex
2325: bibliography style, when used with `--natbib` and `--biblatex`.
2328: bibliography title, when used with `--natbib` and `--biblatex`.
2331: bibliography to use for resolving references
2334: list of options for natbib
2336[KOMA-Script]: https://ctan.org/pkg/koma-script
2337[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2338[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2339[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2340[`article`]: https://ctan.org/pkg/article
2341[`book`]: https://ctan.org/pkg/book
2342[`libertinus`]: https://ctan.org/pkg/libertinus
2343[`memoir`]: https://ctan.org/pkg/memoir
2344[`report`]: https://ctan.org/pkg/report
2346### Variables for ConTeXt
2348Pandoc uses these variables when [creating a PDF] with ConTeXt.
2351: font size for body text (e.g. `10pt`, `12pt`)
2353`headertext`, `footertext`
2354: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2355 repeat up to four times for different placement
2358: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2359 repeat for multiple options
2362: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2363 repeat for multiple options
2366: options for page margins and text arrangement (see [ConTeXt Layout]);
2367 repeat for multiple options
2369`linkcolor`, `contrastcolor`
2370: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2373: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2376: include list of figures, list of tables
2378`mainfont`, `sansfont`, `monofont`, `mathfont`
2379: font families: take the name of any system font (see [ConTeXt Font Switching])
2381`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2382: sets margins, if `layout` is not used (otherwise `layout`
2386: page number style and location (using [`setuppagenumbering`]);
2387 repeat for multiple options
2390: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2391 repeat for multiple options
2394: adds to the preamble the setup necessary to generate PDF/A of the type
2395 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2396 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2397 block), `1b:2005` will be used as default, for reasons of backwards
2398 compatibility. Using `--variable=pdfa` without specified value is not supported.
2399 To successfully generate PDF/A the required ICC color profiles have to
2400 be available and the content and all included files (such as images)
2401 have to be standard conforming. The ICC profiles and output intent
2402 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2403 See also [ConTeXt PDFA] for more details.
2406: when used in conjunction with `pdfa`, specifies the ICC profile to use
2407 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2408 used as default. May be repeated to include multiple profiles. Note that
2409 the profiles have to be available on the system. They can be obtained
2410 from [ConTeXt ICC Profiles].
2413: when used in conjunction with `pdfa`, specifies the output intent for
2414 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2415 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2418: include table of contents (can also be set using `--toc/--table-of-contents`)
2421: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2424: include all source documents as file attachments in the PDF file
2426[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2427[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2428[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2429[ConTeXt Color]: https://wiki.contextgarden.net/Color
2430[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2431[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2432[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2433[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2434[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2435[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2436[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2438### Variables for `wkhtmltopdf`
2440Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2441The `--css` option also affects the output.
2443`footer-html`, `header-html`
2444: add information to the header and footer
2446`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2447: set the page margins
2450: sets the PDF paper size
2452### Variables for man pages
2455: adjusts text to left (`l`), right (`r`), center (`c`),
2456 or both (`b`) margins
2459: footer in man pages
2462: header in man pages
2465: if `true` (the default), hyphenation will be used
2468: section number in man pages
2473: font family (e.g. `T` or `P`)
2476: paragraph indent (e.g. `2m`)
2479: line height (e.g. `12p`)
2482: point size (e.g. `10p`)
2484### Variables set automatically
2486Pandoc sets these variables automatically in response to [options] or
2487document contents; users can also modify them. These vary depending
2488on the output format, and include the following:
2494: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2495 included in all HTML based formats (dzslides, epub,
2496 html, html4, html5, revealjs, s5, slideous, slidy).
2497 The recognized formats for `date` are: `mm/dd/yyyy`,
2498 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2499 (e.g. either `02 Apr 2018` or `02 April 2018`),
2500 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2501 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2504: contents specified by `-H/--include-in-header` (may have multiple
2508: contents specified by `-B/--include-before-body` (may have
2512: contents specified by `-A/--include-after-body` (may have
2516: JSON representation of all of the document's metadata. Field
2517 values are transformed to the selected output format.
2520: non-null value if `-N/--number-sections` was specified
2522`sourcefile`, `outputfile`
2523: source and destination filenames, as given on the command line.
2524 `sourcefile` can also be a list if input comes from multiple files,
2525 or empty if input is from stdin. You can use the following snippet in
2526 your template to distinguish them:
2536 Similarly, `outputfile` can be `-` if output goes to the terminal.
2538 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2541: working directory from which pandoc is run.
2544: non-null value if `--toc/--table-of-contents` was specified
2547: title of table of contents (works only with EPUB,
2548 opendocument, odt, docx, pptx, beamer, LaTeX)
2550[pandoc-templates]: https://github.com/jgm/pandoc-templates
2554The behavior of some of the readers and writers can be adjusted by
2555enabling or disabling various extensions.
2557An extension can be enabled by adding `+EXTENSION`
2558to the format name and disabled by adding `-EXTENSION`. For example,
2559`--from markdown_strict+footnotes` is strict Markdown with footnotes
2560enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2561Markdown without footnotes or pipe tables.
2563The markdown reader and writer make by far the most use of extensions.
2564Extensions only used by them are therefore covered in the
2565section [Pandoc's Markdown] below (See [Markdown variants] for
2566`commonmark` and `gfm`.) In the following, extensions that also work
2567for other formats are covered.
2569Note that markdown extensions added to the `ipynb` format
2570affect Markdown cells in Jupyter notebooks (as do command-line
2571options like `--atx-headers`).
2575#### Extension: `smart` ####
2577Interpret straight quotes as curly quotes, `---` as em-dashes,
2578`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2579inserted after certain abbreviations, such as "Mr."
2581This extension can be enabled/disabled for the following formats:
2584: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2587: `markdown`, `latex`, `context`, `rst`
2589enabled by default in
2590: `markdown`, `latex`, `context` (both input and output)
2592Note: If you are *writing* Markdown, then the `smart` extension
2593has the reverse effect: what would have been curly quotes comes
2596In LaTeX, `smart` means to use the standard TeX ligatures
2597for quotation marks (` `` ` and ` '' ` for double quotes,
2598`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2599en-dash and `---` for em-dash). If `smart` is disabled,
2600then in reading LaTeX pandoc will parse these characters
2601literally. In writing LaTeX, enabling `smart` tells pandoc
2602to use the ligatures when possible; if `smart` is disabled
2603pandoc will use unicode quotation mark and dash characters.
2605## Headings and sections
2607#### Extension: `auto_identifiers` ####
2609A heading without an explicitly specified identifier will be
2610automatically assigned a unique identifier based on the heading text.
2612This extension can be enabled/disabled for the following formats:
2615: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2620enabled by default in
2623The default algorithm used to derive the identifier from the
2626 - Remove all formatting, links, etc.
2627 - Remove all footnotes.
2628 - Remove all non-alphanumeric characters,
2629 except underscores, hyphens, and periods.
2630 - Replace all spaces and newlines with hyphens.
2631 - Convert all alphabetic characters to lowercase.
2632 - Remove everything up to the first letter (identifiers may
2633 not begin with a number or punctuation mark).
2634 - If nothing is left after this, use the identifier `section`.
2639 ------------------------------- ----------------------------
2640 `Heading identifiers in HTML` `heading-identifiers-in-html`
2641 `Maître d'hôtel` `maître-dhôtel`
2642 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2643 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2644 `3. Applications` `applications`
2647These rules should, in most cases, allow one to determine the identifier
2648from the heading text. The exception is when several headings have the
2649same text; in this case, the first will get an identifier as described
2650above; the second will get the same identifier with `-1` appended; the
2651third with `-2`; and so on.
2653(However, a different algorithm is used if
2654`gfm_auto_identifiers` is enabled; see below.)
2656These identifiers are used to provide link targets in the table of
2657contents generated by the `--toc|--table-of-contents` option. They
2658also make it easy to provide links from one section of a document to
2659another. A link to this section, for example, might look like this:
2662 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2664Note, however, that this method of providing links to sections works
2665only in HTML, LaTeX, and ConTeXt formats.
2667If the `--section-divs` option is specified, then each section will
2668be wrapped in a `section` (or a `div`, if `html4` was specified),
2669and the identifier will be attached to the enclosing `<section>`
2670(or `<div>`) tag rather than the heading itself. This allows entire
2671sections to be manipulated using JavaScript or treated differently in
2674#### Extension: `ascii_identifiers` ####
2676Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2677Accents are stripped off of accented Latin letters, and non-Latin
2680#### Extension: `gfm_auto_identifiers` ####
2682Changes the algorithm used by `auto_identifiers` to conform to
2683GitHub's method. Spaces are converted to dashes (`-`),
2684uppercase characters to lowercase characters, and punctuation
2685characters other than `-` and `_` are removed.
2686Emojis are replaced by their names.
2690The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2691[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2692[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2693are described in the section about Pandoc's Markdown.
2695However, they can also be used with HTML input. This is handy for
2696reading web pages formatted using MathJax, for example.
2700The following extensions (especially how they affect Markdown
2701input/output) are also described in more detail in their respective
2702sections of [Pandoc's Markdown].
2704#### Extension: `raw_html` {#raw_html}
2706When converting from HTML, parse elements to raw HTML which are not
2707representable in pandoc's AST.
2708By default, this is disabled for HTML input.
2710#### Extension: `raw_tex` {#raw_tex}
2712Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2714This extension can be enabled/disabled for the following formats
2715(in addition to `markdown`):
2718: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2719 `\eqref` only), `ipynb`
2722: `textile`, `commonmark`
2724Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2725only raw TeX in markdown cells, but data with mime type
2726`text/html` in output cells. Since the `ipynb` reader attempts
2727to preserve the richest possible outputs when several options
2728are given, you will get best results if you disable `raw_html`
2729and `raw_tex` when converting to formats like `docx` which don't
2730allow raw `html` or `tex`.
2732#### Extension: `native_divs` {#native_divs}
2734This extension is enabled by default for HTML input. This means that
2735`div`s are parsed to pandoc native elements. (Alternatively, you
2736can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2738When converting HTML to Markdown, for example, you may want to drop all
2741 pandoc -f html-native_divs-native_spans -t markdown
2743#### Extension: `native_spans` {#native_spans}
2745Analogous to `native_divs` above.
2748## Literate Haskell support
2750#### Extension: `literate_haskell` ####
2752Treat the document as literate Haskell source.
2754This extension can be enabled/disabled for the following formats:
2757: `markdown`, `rst`, `latex`
2760: `markdown`, `rst`, `latex`, `html`
2762If you append `+lhs` (or `+literate_haskell`) to one of the formats
2763above, pandoc will treat the document as literate Haskell source.
2766 - In Markdown input, "bird track" sections will be parsed as Haskell
2767 code rather than block quotations. Text between `\begin{code}`
2768 and `\end{code}` will also be treated as Haskell code. For
2769 ATX-style headings the character '=' will be used instead of '#'.
2771 - In Markdown output, code blocks with classes `haskell` and `literate`
2772 will be rendered using bird tracks, and block quotations will be
2773 indented one space, so they will not be treated as Haskell code.
2774 In addition, headings will be rendered setext-style (with underlines)
2775 rather than ATX-style (with '#' characters). (This is because ghc
2776 treats '#' characters in column 1 as introducing line numbers.)
2778 - In restructured text input, "bird track" sections will be parsed
2781 - In restructured text output, code blocks with class `haskell` will
2782 be rendered using bird tracks.
2784 - In LaTeX input, text in `code` environments will be parsed as
2787 - In LaTeX output, code blocks with class `haskell` will be rendered
2788 inside `code` environments.
2790 - In HTML output, code blocks with class `haskell` will be rendered
2791 with class `literatehaskell` and bird tracks.
2795 pandoc -f markdown+lhs -t html
2797reads literate Haskell source formatted with Markdown conventions and writes
2798ordinary HTML (without bird tracks).
2800 pandoc -f markdown+lhs -t html+lhs
2802writes HTML with the Haskell code in bird tracks, so it can be copied
2803and pasted as literate Haskell source.
2805Note that GHC expects the bird tracks in the first column, so indented
2806literate code blocks (e.g. inside an itemized environment) will not be
2807picked up by the Haskell compiler.
2811#### Extension: `empty_paragraphs` ####
2813Allows empty paragraphs. By default empty paragraphs are
2816This extension can be enabled/disabled for the following formats:
2822: `docx`, `odt`, `opendocument`, `html`
2824#### Extension: `native_numbering` ####
2826Enables native numbering of figures and tables. Enumeration
2829This extension can be enabled/disabled for the following formats:
2832: `odt`, `opendocument`
2834#### Extension: `styles` #### {#ext-styles}
2836When converting from docx, read all docx styles as divs (for
2837paragraph styles) and spans (for character styles) regardless
2838of whether pandoc understands the meaning of these styles.
2839This can be used with [docx custom styles](#custom-styles).
2845#### Extension: `amuse` ####
2847In the `muse` input format, this enables Text::Amuse
2848extensions to Emacs Muse markup.
2850#### Extension: `citations` {#org-citations}
2852Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2855#### Extension: `ntb` ####
2857In the `context` output format this enables the use of [Natural Tables
2858(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2859[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2860Natural tables allow more fine-grained global customization but come
2861at a performance penalty compared to extreme tables.
2866Pandoc understands an extended and slightly revised version of
2867John Gruber's [Markdown] syntax. This document explains the syntax,
2868noting differences from standard Markdown. Except where noted, these
2869differences can be suppressed by using the `markdown_strict` format instead
2870of `markdown`. Extensions can be enabled or disabled to specify the
2871behavior more granularly. They are described in the following. See also
2872[Extensions] above, for extensions that work also on other formats.
2876Markdown is designed to be easy to write, and, even more importantly,
2879> A Markdown-formatted document should be publishable as-is, as plain
2880> text, without looking like it's been marked up with tags or formatting
2882> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2884This principle has guided pandoc's decisions in finding syntax for
2885tables, footnotes, and other extensions.
2887There is, however, one respect in which pandoc's aims are different
2888from the original aims of Markdown. Whereas Markdown was originally
2889designed with HTML generation in mind, pandoc is designed for multiple
2890output formats. Thus, while pandoc allows the embedding of raw HTML,
2891it discourages it, and provides other, non-HTMLish ways of representing
2892important document elements like definition lists, tables, mathematics, and
2897A paragraph is one or more lines of text followed by one or more blank lines.
2898Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2899If you need a hard line break, put two or more spaces at the end of a line.
2901#### Extension: `escaped_line_breaks` ####
2903A backslash followed by a newline is also a hard line break.
2904Note: in multiline and grid table cells, this is the only way
2905to create a hard line break, since trailing spaces in the cells
2910There are two kinds of headings: Setext and ATX.
2912### Setext-style headings ###
2914A setext-style heading is a line of text "underlined" with a row of `=` signs
2915(for a level-one heading) or `-` signs (for a level-two heading):
2923The heading text can contain inline formatting, such as emphasis (see
2924[Inline formatting], below).
2927### ATX-style headings ###
2929An ATX-style heading consists of one to six `#` signs and a line of
2930text, optionally followed by any number of `#` signs. The number of
2931`#` signs at the beginning of the line is the heading level:
2933 ## A level-two heading
2935 ### A level-three heading ###
2937As with setext-style headings, the heading text can contain formatting:
2939 # A level-one heading with a [link](/url) and *emphasis*
2941#### Extension: `blank_before_header` ####
2943Standard Markdown syntax does not require a blank line before a heading.
2944Pandoc does require this (except, of course, at the beginning of the
2945document). The reason for the requirement is that it is all too easy for a
2946`#` to end up at the beginning of a line by accident (perhaps through line
2947wrapping). Consider, for example:
2949 I like several of their flavors of ice cream:
2950 #22, for example, and #5.
2952#### Extension: `space_in_atx_header` ####
2954Many Markdown implementations do not require a space between the
2955opening `#`s of an ATX heading and the heading text, so that
2956`#5 bolt` and `#hashtag` count as headings. With this extension,
2957pandoc does require the space.
2959### Heading identifiers ###
2961See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2963#### Extension: `header_attributes` ####
2965Headings can be assigned attributes using this syntax at the end
2966of the line containing the heading text:
2968 {#identifier .class .class key=value key=value}
2970Thus, for example, the following headings will all be assigned the identifier
2975 ## My heading ## {#foo}
2977 My other heading {#foo}
2980(This syntax is compatible with [PHP Markdown Extra].)
2982Note that although this syntax allows assignment of classes and key/value
2983attributes, writers generally don't use all of this information. Identifiers,
2984classes, and key/value attributes are used in HTML and HTML-based formats such
2985as EPUB and slidy. Identifiers are used for labels and link anchors in the
2986LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
2988Headings with the class `unnumbered` will not be numbered, even if
2989`--number-sections` is specified. A single hyphen (`-`) in an attribute
2990context is equivalent to `.unnumbered`, and preferable in non-English
2997 # My heading {.unnumbered}
2999If the `unlisted` class is present in addition to `unnumbered`,
3000the heading will not be included in a table of contents.
3001(Currently this feature is only implemented for certain
3002formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3004#### Extension: `implicit_header_references` ####
3006Pandoc behaves as if reference links have been defined for each heading.
3007So, to link to a heading
3009 # Heading identifiers in HTML
3013 [Heading identifiers in HTML]
3017 [Heading identifiers in HTML][]
3021 [the section on heading identifiers][heading identifiers in
3024instead of giving the identifier explicitly:
3026 [Heading identifiers in HTML](#heading-identifiers-in-html)
3028If there are multiple headings with identical text, the corresponding
3029reference will link to the first one only, and you will need to use explicit
3030links to link to the others, as described above.
3032Like regular reference links, these references are case-insensitive.
3034Explicit link reference definitions always take priority over
3035implicit heading references. So, in the following example, the
3036link will point to `bar`, not to `#foo`:
3046Markdown uses email conventions for quoting blocks of text.
3047A block quotation is one or more paragraphs or other block elements
3048(such as lists or headings), with each line preceded by a `>` character
3049and an optional space. (The `>` need not start at the left margin, but
3050it should not be indented more than three spaces.)
3052 > This is a block quote. This
3053 > paragraph has two lines.
3055 > 1. This is a list inside a block quote.
3058A "lazy" form, which requires the `>` character only on the first
3059line of each block, is also allowed:
3061 > This is a block quote. This
3062 paragraph has two lines.
3064 > 1. This is a list inside a block quote.
3067Among the block elements that can be contained in a block quote are
3068other block quotes. That is, block quotes can be nested:
3070 > This is a block quote.
3072 > > A block quote within a block quote.
3074If the `>` character is followed by an optional space, that space
3075will be considered part of the block quote marker and not part of
3076the indentation of the contents. Thus, to put an indented code
3077block in a block quote, you need five spaces after the `>`:
3081#### Extension: `blank_before_blockquote` ####
3083Standard Markdown syntax does not require a blank line before a block
3084quote. Pandoc does require this (except, of course, at the beginning of the
3085document). The reason for the requirement is that it is all too easy for a
3086`>` to end up at the beginning of a line by accident (perhaps through line
3087wrapping). So, unless the `markdown_strict` format is used, the following does
3088not produce a nested block quote in pandoc:
3090 > This is a block quote.
3094## Verbatim (code) blocks
3096### Indented code blocks ###
3098A block of text indented four spaces (or one tab) is treated as verbatim
3099text: that is, special characters do not trigger special formatting,
3100and all spaces and line breaks are preserved. For example,
3103 moveShip(5 * gravity, DOWN);
3106The initial (four space or one tab) indentation is not considered part
3107of the verbatim text, and is removed in the output.
3109Note: blank lines in the verbatim text need not begin with four spaces.
3112### Fenced code blocks ###
3114#### Extension: `fenced_code_blocks` ####
3116In addition to standard indented code blocks, pandoc supports
3117*fenced* code blocks. These begin with a row of three or more
3118tildes (`~`) and end with a row of tildes that must be at least as long as
3119the starting row. Everything between these lines is treated as code. No
3120indentation is necessary:
3124 moveShip(5 * gravity, DOWN);
3128Like regular code blocks, fenced code blocks must be separated
3129from surrounding text by blank lines.
3131If the code itself contains a row of tildes or backticks, just use a longer
3132row of tildes or backticks at the start and end:
3136 code including tildes
3140#### Extension: `backtick_code_blocks` ####
3142Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3145#### Extension: `fenced_code_attributes` ####
3147Optionally, you may attach attributes to fenced or backtick code block using
3150 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3152 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3153 qsort (filter (>= x) xs)
3154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3156Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3157`startFrom` is an attribute with value `100`. Some output formats can use this
3158information to do syntax highlighting. Currently, the only output formats
3159that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3160highlighting is supported for your output format and language, then the code
3161block above will appear highlighted, with numbered lines. (To see which
3162languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3163the code block above will appear as follows:
3165 <pre id="mycode" class="haskell numberLines" startFrom="100">
3171The `numberLines` (or `number-lines`) class will cause the lines
3172of the code block to be numbered, starting with `1` or the value
3173of the `startFrom` attribute. The `lineAnchors` (or
3174`line-anchors`) class will cause the lines to be clickable
3175anchors in HTML output.
3177A shortcut form can also be used for specifying the language of
3184This is equivalent to:
3190If the `fenced_code_attributes` extension is disabled, but
3191input contains class attribute(s) for the code block, the first
3192class attribute will be printed after the opening fence as a bare
3195To prevent all highlighting, use the `--no-highlight` flag.
3196To set the highlighting style, use `--highlight-style`.
3197For more information on highlighting, see [Syntax highlighting],
3202#### Extension: `line_blocks` ####
3204A line block is a sequence of lines beginning with a vertical bar (`|`)
3205followed by a space. The division into lines will be preserved in
3206the output, as will any leading spaces; otherwise, the lines will
3207be formatted as Markdown. This is useful for verse and addresses:
3209 | The limerick packs laughs anatomical
3210 | In space that is quite economical.
3211 | But the good ones I've seen
3212 | So seldom are clean
3213 | And the clean ones so seldom are comical
3216 | Berkeley, CA 94718
3218The lines can be hard-wrapped if needed, but the continuation
3219line must begin with a space.
3221 | The Right Honorable Most Venerable and Righteous Samuel L.
3224 | Berkeley, CA 94718
3226This syntax is borrowed from [reStructuredText].
3232A bullet list is a list of bulleted list items. A bulleted list
3233item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3240This will produce a "compact" list. If you want a "loose" list, in which
3241each item is formatted as a paragraph, put spaces between the items:
3249The bullets need not be flush with the left margin; they may be
3250indented one, two, or three spaces. The bullet must be followed
3253List items look best if subsequent lines are flush with the first
3254line (after the bullet):
3260But Markdown also allows a "lazy" format:
3266### Block content in list items ###
3268A list item may contain multiple paragraphs and other block-level
3269content. However, subsequent paragraphs must be preceded by a blank line
3270and indented to line up with the first non-space content after
3277 * Second paragraph. With a code block, which must be indented
3282Exception: if the list marker is followed by an indented code
3283block, which must begin 5 spaces after the list marker, then
3284subsequent paragraphs must begin two columns after the last
3285character of the list marker:
3289 continuation paragraph
3291List items may include other lists. In this case the preceding blank
3292line is optional. The nested list must be indented to line up with
3293the first non-space character after the list marker of the
3294containing list item.
3306As noted above, Markdown allows you to write list items "lazily," instead of
3307indenting continuation lines. However, if there are multiple paragraphs or
3308other blocks in a list item, the first line of each must be indented.
3310 + A lazy, lazy, list
3313 + Another one; this looks
3316 Second paragraph of second
3319### Ordered lists ###
3321Ordered lists work just like bulleted lists, except that the items
3322begin with enumerators rather than bullets.
3324In standard Markdown, enumerators are decimal numbers followed
3325by a period and a space. The numbers themselves are ignored, so
3326there is no difference between this list:
3338#### Extension: `fancy_lists` ####
3340Unlike standard Markdown, pandoc allows ordered list items to be marked
3341with uppercase and lowercase letters and roman numerals, in addition to
3342Arabic numerals. List markers may be enclosed in parentheses or followed by a
3343single right-parentheses or period. They must be separated from the
3344text that follows by at least one space, and, if the list marker is a
3345capital letter with a period, by at least two spaces.[^2]
3347[^2]: The point of this rule is to ensure that normal paragraphs
3348 starting with people's initials, like
3350 B. Russell was an English philosopher.
3352 do not get treated as list items.
3354 This rule will not prevent
3358 from being interpreted as a list item. In this case, a backslash
3363The `fancy_lists` extension also allows '`#`' to be used as an
3364ordered list marker in place of a numeral:
3369#### Extension: `startnum` ####
3371Pandoc also pays attention to the type of list marker used, and to the
3372starting number, and both of these are preserved where possible in the
3373output format. Thus, the following yields a list with numbers followed
3374by a single parenthesis, starting with 9, and a sublist with lowercase
3384Pandoc will start a new list each time a different type of list
3385marker is used. So, the following will create three lists:
3392If default list markers are desired, use `#.`:
3398#### Extension: `task_lists` ####
3400Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3402 - [ ] an unchecked task list item
3405### Definition lists ###
3407#### Extension: `definition_lists` ####
3409Pandoc supports definition lists, using the syntax of
3410[PHP Markdown Extra] with some extensions.[^3]
3416 Term 2 with *inline markup*
3420 { some code, part of Definition 2 }
3422 Third paragraph of definition 2.
3424Each term must fit on one line, which may optionally be followed by
3425a blank line, and must be followed by one or more definitions.
3426A definition begins with a colon or tilde, which may be indented one
3429A term may have multiple definitions, and each definition may consist of one or
3430more block elements (paragraph, code block, list, etc.), each indented four
3431spaces or one tab stop. The body of the definition (including the first line,
3432aside from the colon or tilde) should be indented four spaces. However,
3433as with other Markdown lists, you can "lazily" omit indentation except
3434at the beginning of a paragraph or other block element:
3439 with lazy continuation.
3441 Second paragraph of the definition.
3443If you leave space before the definition (as in the example above),
3444the text of the definition will be treated as a paragraph. In some
3445output formats, this will mean greater spacing between term/definition
3446pairs. For a more compact definition list, omit the space before the
3456Note that space between items in a definition list is required.
3457(A variant that loosens this requirement, but disallows "lazy"
3458hard wrapping, can be activated with `compact_definition_lists`: see
3459[Non-pandoc extensions], below.)
3461[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3463### Numbered example lists ###
3465#### Extension: `example_lists` ####
3467The special list marker `@` can be used for sequentially numbered
3468examples. The first list item with a `@` marker will be numbered '1',
3469the next '2', and so on, throughout the document. The numbered examples
3470need not occur in a single list; each new list using `@` will take up
3471where the last stopped. So, for example:
3473 (@) My first example will be numbered (1).
3474 (@) My second example will be numbered (2).
3476 Explanation of examples.
3478 (@) My third example will be numbered (3).
3480Numbered examples can be labeled and referred to elsewhere in the
3483 (@good) This is a good example.
3485 As (@good) illustrates, ...
3487The label can be any string of alphanumeric characters, underscores,
3490Note: continuation paragraphs in example lists must always
3491be indented four spaces, regardless of the length of the
3492list marker. That is, example lists always behave as if the
3493`four_space_rule` extension is set. This is because example
3494labels tend to be long, and indenting content to the
3495first non-space character after the label would be awkward.
3497### Compact and loose lists ###
3499Pandoc behaves differently from `Markdown.pl` on some "edge
3500cases" involving lists. Consider this source:
3510Pandoc transforms this into a "compact list" (with no `<p>` tags around
3511"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3512"Second" and "Third" (but not "First"), because of the blank space
3513around "Third". Pandoc follows a simple rule: if the text is followed by
3514a blank line, it is treated as a paragraph. Since "Second" is followed
3515by a list, and not a blank line, it isn't treated as a paragraph. The
3516fact that the list is followed by a blank line is irrelevant. (Note:
3517Pandoc works this way even when the `markdown_strict` format is specified. This
3518behavior is consistent with the official Markdown syntax description,
3519even though it is different from that of `Markdown.pl`.)
3522### Ending a list ###
3524What if you want to put an indented code block after a list?
3531Trouble! Here pandoc (like other Markdown implementations) will treat
3532`{ my code block }` as the second paragraph of item two, and not as
3535To "cut off" the list after item two, you can insert some non-indented
3536content, like an HTML comment, which won't produce visible output in
3542 <!-- end of list -->
3546You can use the same trick if you want two consecutive lists instead
3561A line containing a row of three or more `*`, `-`, or `_` characters
3562(optionally separated by spaces) produces a horizontal rule:
3571Four kinds of tables may be used. The first three kinds presuppose the use of
3572a fixed-width font, such as Courier. The fourth kind can be used with
3573proportionally spaced fonts, as it does not require lining up columns.
3575#### Extension: `table_captions` ####
3577A caption may optionally be provided with all 4 kinds of tables (as
3578illustrated in the examples below). A caption is a paragraph beginning
3579with the string `Table:` (or just `:`), which will be stripped off.
3580It may appear either before or after the table.
3582#### Extension: `simple_tables` ####
3584Simple tables look like this:
3586 Right Left Center Default
3587 ------- ------ ---------- -------
3592 Table: Demonstration of simple table syntax.
3594The header and table rows must each fit on one line. Column
3595alignments are determined by the position of the header text relative
3596to the dashed line below it:[^4]
3598 - If the dashed line is flush with the header text on the right side
3599 but extends beyond it on the left, the column is right-aligned.
3600 - If the dashed line is flush with the header text on the left side
3601 but extends beyond it on the right, the column is left-aligned.
3602 - If the dashed line extends beyond the header text on both sides,
3603 the column is centered.
3604 - If the dashed line is flush with the header text on both sides,
3605 the default alignment is used (in most cases, this will be left).
3607[^4]: This scheme is due to Michel Fortin, who proposed it on the
3608 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3610The table must end with a blank line, or a line of dashes followed by
3613The column header row may be omitted, provided a dashed line is used
3614to end the table. For example:
3616 ------- ------ ---------- -------
3620 ------- ------ ---------- -------
3622When the header row is omitted, column alignments are determined on the basis
3623of the first line of the table body. So, in the tables above, the columns
3624would be right, left, center, and right aligned, respectively.
3626#### Extension: `multiline_tables` ####
3628Multiline tables allow header and table rows to span multiple lines
3629of text (but cells that span multiple columns or rows of the table are
3630not supported). Here is an example:
3632 -------------------------------------------------------------
3633 Centered Default Right Left
3634 Header Aligned Aligned Aligned
3635 ----------- ------- --------------- -------------------------
3636 First row 12.0 Example of a row that
3637 spans multiple lines.
3639 Second row 5.0 Here's another one. Note
3640 the blank line between
3642 -------------------------------------------------------------
3644 Table: Here's the caption. It, too, may span
3647These work like simple tables, but with the following differences:
3649 - They must begin with a row of dashes, before the header text
3650 (unless the header row is omitted).
3651 - They must end with a row of dashes, then a blank line.
3652 - The rows must be separated by blank lines.
3654In multiline tables, the table parser pays attention to the widths of
3655the columns, and the writers try to reproduce these relative widths in
3656the output. So, if you find that one of the columns is too narrow in the
3657output, try widening it in the Markdown source.
3659The header may be omitted in multiline tables as well as simple tables:
3661 ----------- ------- --------------- -------------------------
3662 First row 12.0 Example of a row that
3663 spans multiple lines.
3665 Second row 5.0 Here's another one. Note
3666 the blank line between
3668 ----------- ------- --------------- -------------------------
3670 : Here's a multiline table without a header.
3672It is possible for a multiline table to have just one row, but the row
3673should be followed by a blank line (and then the row of dashes that ends
3674the table), or the table may be interpreted as a simple table.
3676#### Extension: `grid_tables` ####
3678Grid tables look like this:
3680 : Sample grid table.
3682 +---------------+---------------+--------------------+
3683 | Fruit | Price | Advantages |
3684 +===============+===============+====================+
3685 | Bananas | $1.34 | - built-in wrapper |
3686 | | | - bright color |
3687 +---------------+---------------+--------------------+
3688 | Oranges | $2.10 | - cures scurvy |
3690 +---------------+---------------+--------------------+
3692The row of `=`s separates the header from the table body, and can be
3693omitted for a headerless table. The cells of grid tables may contain
3694arbitrary block elements (multiple paragraphs, code blocks, lists,
3695etc.). Cells that span multiple columns or rows are not
3696supported. Grid tables can be created easily using Emacs' table-mode
3697(`M-x table-insert`).
3699Alignments can be specified as with pipe tables, by putting
3700colons at the boundaries of the separator line after the
3703 +---------------+---------------+--------------------+
3704 | Right | Left | Centered |
3705 +==============:+:==============+:==================:+
3706 | Bananas | $1.34 | built-in wrapper |
3707 +---------------+---------------+--------------------+
3709For headerless tables, the colons go on the top line instead:
3711 +--------------:+:--------------+:------------------:+
3712 | Right | Left | Centered |
3713 +---------------+---------------+--------------------+
3715##### Grid Table Limitations #####
3717Pandoc does not support grid tables with row spans or column spans.
3718This means that neither variable numbers of columns across rows nor
3719variable numbers of rows across columns are supported by Pandoc.
3720All grid tables must have the same number of columns in each row,
3721and the same number of rows in each column. For example, the
3722Docutils [sample grid tables] will not render as expected with
3725[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3728#### Extension: `pipe_tables` ####
3730Pipe tables look like this:
3732 | Right | Left | Default | Center |
3733 |------:|:-----|---------|:------:|
3734 | 12 | 12 | 12 | 12 |
3735 | 123 | 123 | 123 | 123 |
3738 : Demonstration of pipe table syntax.
3740The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3741ending pipe characters are optional, but pipes are required between all
3742columns. The colons indicate column alignment as shown. The header
3743cannot be omitted. To simulate a headerless table, include a header
3746Since the pipes indicate column boundaries, columns need not be vertically
3747aligned, as they are in the above example. So, this is a perfectly
3748legal (though ugly) pipe table:
3756The cells of pipe tables cannot contain block elements like paragraphs
3757and lists, and cannot span multiple lines. If a pipe table contains a
3758row whose printable content is wider than the column width (see
3759`--columns`), then the table will take up the full text width and
3760the cell contents will wrap, with the relative cell widths determined
3761by the number of dashes in the line separating the table header from
3762the table body. (For example `---|-` would make the first column 3/4
3763and the second column 1/4 of the full text width.)
3764On the other hand, if no lines are wider than column width, then
3765cell contents will not be wrapped, and the cells will be sized
3768Note: pandoc also recognizes pipe tables of the following
3769form, as can be produced by Emacs' orgtbl-mode:
3776The difference is that `+` is used instead of `|`. Other orgtbl features
3777are not supported. In particular, to get non-default column alignment,
3778you'll need to add colons as above.
3780[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3784#### Extension: `pandoc_title_block` ####
3786If the file begins with a title block
3789 % author(s) (separated by semicolons)
3792it will be parsed as bibliographic information, not regular text. (It
3793will be used, for example, in the title of standalone LaTeX or HTML
3794output.) The block may contain just a title, a title and an author,
3795or all three elements. If you want to include an author but no
3796title, or a title and a date but no author, you need a blank line:
3805The title may occupy multiple lines, but continuation lines must
3806begin with leading space, thus:
3811If a document has multiple authors, the authors may be put on
3812separate lines with leading space, or separated by semicolons, or
3813both. So, all of the following are equivalent:
3818 % Author One; Author Two
3823The date must fit on one line.
3825All three metadata fields may contain standard inline formatting
3826(italics, links, footnotes, etc.).
3828Title blocks will always be parsed, but they will affect the output only
3829when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3830will appear twice: once in the document head -- this is the title that
3831will appear at the top of the window in a browser -- and once at the
3832beginning of the document body. The title in the document head can have
3833an optional prefix attached (`--title-prefix` or `-T` option). The title
3834in the body appears as an H1 element with class "title", so it can be
3835suppressed or reformatted with CSS. If a title prefix is specified with
3836`-T` and no title block appears in the document, the title prefix will
3837be used by itself as the HTML title.
3839The man page writer extracts a title, man page section number, and
3840other header and footer information from the title line. The title
3841is assumed to be the first word on the title line, which may optionally
3842end with a (single-digit) section number in parentheses. (There should
3843be no space between the title and the parentheses.) Anything after
3844this is assumed to be additional footer and header text. A single pipe
3845character (`|`) should be used to separate the footer text from the header
3850will yield a man page with the title `PANDOC` and section 1.
3852 % PANDOC(1) Pandoc User Manuals
3854will also have "Pandoc User Manuals" in the footer.
3856 % PANDOC(1) Pandoc User Manuals | Version 4.0
3858will also have "Version 4.0" in the header.
3860#### Extension: `yaml_metadata_block` ####
3862A [YAML] metadata block is a valid YAML object, delimited by a line of three
3863hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3864(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3865document, but if it is not at the beginning, it must be preceded by a blank
3866line. (Note that, because of the way pandoc concatenates input files when
3867several are provided, you may also keep the metadata in a separate YAML file
3868and pass it to pandoc as an argument, along with your Markdown files:
3870 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3872Just be sure that the YAML file begins with `---` and ends with `---` or
3873`...`.) Alternatively, you can use the `--metadata-file` option. Using
3874that approach however, you cannot reference content (like footnotes)
3875from the main markdown input document.
3877Metadata will be taken from the fields of the YAML object and added to any
3878existing document metadata. Metadata can contain lists and objects (nested
3879arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3880with names ending in an underscore will be ignored by pandoc. (They may be
3881given a role by external processors.) Field names must not be
3882interpretable as YAML numbers or boolean values (so, for
3883example, `yes`, `True`, and `15` cannot be used as field names).
3885A document may contain multiple metadata blocks. The metadata fields will
3886be combined through a *left-biased union*: if two metadata blocks attempt
3887to set the same field, the value from the first block will be taken.
3889When pandoc is used with `-t markdown` to create a Markdown document,
3890a YAML metadata block will be produced only if the `-s/--standalone`
3891option is used. All of the metadata will appear in a single block
3892at the beginning of the document.
3894Note that [YAML] escaping rules must be followed. Thus, for example,
3895if a title contains a colon, it must be quoted. The pipe character
3896(`|`) can be used to begin an indented block that will be interpreted
3897literally, without need for escaping. This form is necessary
3898when the field contains blank lines or block-level formatting:
3901 title: 'This is the title: it contains a colon'
3905 keywords: [nothing, nothingness]
3907 This is the abstract.
3909 It consists of two paragraphs.
3912Template variables will be set automatically from the metadata. Thus, for
3913example, in writing HTML, the variable `abstract` will be set to the HTML
3914equivalent of the Markdown in the `abstract` field:
3916 <p>This is the abstract.</p>
3917 <p>It consists of two paragraphs.</p>
3919Variables can contain arbitrary YAML structures, but the template must match
3920this structure. The `author` variable in the default templates expects a
3921simple list or string, but can be changed to support more complicated
3922structures. The following combination, for example, would add an affiliation
3923to the author if one is given:
3926 title: The document title
3929 affiliation: University of Somewhere
3931 affiliation: University of Nowhere
3934To use the structured authors in the example above, you would need a custom
3939 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3945Raw content to include in the document's header may be specified
3946using `header-includes`; however, it is important to mark up
3947this content as raw code for a particular output format, using
3948the [`raw_attribute` extension](#extension-raw_attribute)), or it
3949will be interpreted as markdown. For example:
3954 \let\oldsection\section
3955 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3960#### Extension: `all_symbols_escapable` ####
3962Except inside a code block or inline code, any punctuation or space
3963character preceded by a backslash will be treated literally, even if it
3964would normally indicate formatting. Thus, for example, if one writes
3974 <strong>hello</strong>
3976This rule is easier to remember than standard Markdown's rule,
3977which allows only the following characters to be backslash-escaped:
3981(However, if the `markdown_strict` format is used, the standard Markdown rule
3984A backslash-escaped space is parsed as a nonbreaking space. It will
3985appear in TeX output as `~` and in HTML and XML as `\ ` or
3988A backslash-escaped newline (i.e. a backslash occurring at the end of
3989a line) is parsed as a hard line break. It will appear in TeX output as
3990`\\` and in HTML as `<br />`. This is a nice alternative to
3991Markdown's "invisible" way of indicating hard line breaks using
3992two trailing spaces on a line.
3994Backslash escapes do not work in verbatim contexts.
4000To *emphasize* some text, surround it with `*`s or `_`, like this:
4002 This text is _emphasized with underscores_, and this
4003 is *emphasized with asterisks*.
4005Double `*` or `_` produces **strong emphasis**:
4007 This is **strong emphasis** and __with underscores__.
4009A `*` or `_` character surrounded by spaces, or backslash-escaped,
4010will not trigger emphasis:
4012 This is * not emphasized *, and \*neither is this\*.
4014#### Extension: `intraword_underscores` ####
4016Because `_` is sometimes used inside words and identifiers,
4017pandoc does not interpret a `_` surrounded by alphanumeric
4018characters as an emphasis marker. If you want to emphasize
4019just part of a word, use `*`:
4021 feas*ible*, not feas*able*.
4026#### Extension: `strikeout` ####
4028To strikeout a section of text with a horizontal line, begin and end it
4029with `~~`. Thus, for example,
4031 This ~~is deleted text.~~
4034### Superscripts and subscripts ###
4036#### Extension: `superscript`, `subscript` ####
4038Superscripts may be written by surrounding the superscripted text by `^`
4039characters; subscripts may be written by surrounding the subscripted
4040text by `~` characters. Thus, for example,
4042 H~2~O is a liquid. 2^10^ is 1024.
4044If the superscripted or subscripted text contains spaces, these spaces
4045must be escaped with backslashes. (This is to prevent accidental
4046superscripting and subscripting through the ordinary use of `~` and `^`.)
4047Thus, if you want the letter P with 'a cat' in subscripts, use
4048`P~a\ cat~`, not `P~a cat~`.
4053To make a short span of text verbatim, put it inside backticks:
4055 What is the difference between `>>=` and `>>`?
4057If the verbatim text includes a backtick, use double backticks:
4059 Here is a literal backtick `` ` ``.
4061(The spaces after the opening backticks and before the closing
4062backticks will be ignored.)
4064The general rule is that a verbatim span starts with a string
4065of consecutive backticks (optionally followed by a space)
4066and ends with a string of the same number of backticks (optionally
4067preceded by a space).
4069Note that backslash-escapes (and other Markdown constructs) do not
4070work in verbatim contexts:
4072 This is a backslash followed by an asterisk: `\*`.
4074#### Extension: `inline_code_attributes` ####
4076Attributes can be attached to verbatim text, just as with
4077[fenced code blocks]:
4083To write small caps, use the `smallcaps` class:
4085 [Small caps]{.smallcaps}
4087Or, without the `bracketed_spans` extension:
4089 <span class="smallcaps">Small caps</span>
4091For compatibility with other Markdown flavors, CSS is also supported:
4093 <span style="font-variant:small-caps;">Small caps</span>
4095This will work in all output formats that support small caps.
4100#### Extension: `tex_math_dollars` ####
4102Anything between two `$` characters will be treated as TeX math. The
4103opening `$` must have a non-space character immediately to its right,
4104while the closing `$` must have a non-space character immediately to its
4105left, and must not be followed immediately by a digit. Thus,
4106`$20,000 and $30,000` won't parse as math. If for some reason
4107you need to enclose text in literal `$` characters, backslash-escape
4108them and they won't be treated as math delimiters.
4110TeX math will be printed in all output formats. How it is rendered
4111depends on the output format:
4114 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4115 math) or `\[...\]` (for display math).
4117Markdown, Emacs Org mode, ConTeXt, ZimWiki
4118 ~ It will appear verbatim surrounded by `$...$` (for inline
4119 math) or `$$...$$` (for display math).
4122 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4125 ~ It will be rendered using an [interpreted text role `:math:`].
4128 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4129 surrounded by `latexmath:[$...$]` (for inline math) or
4130 `[latexmath]++++\[...\]+++` (for display math).
4131 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4132 (`$..$` and `\[..\]`) are omitted.
4135 ~ It will be rendered inside a `@math` command.
4137roff man, Jira markup
4138 ~ It will be rendered verbatim without `$`'s.
4141 ~ It will be rendered inside `<math>` tags.
4144 ~ It will be rendered inside `<span class="math">` tags.
4147 ~ It will be rendered, if possible, using Unicode characters,
4148 and will otherwise appear verbatim.
4151 ~ It will be rendered, if possible, using MathML.
4154 ~ If the `--mathml` flag is used, it will be rendered using MathML
4155 in an `inlineequation` or `informalequation` tag. Otherwise it
4156 will be rendered, if possible, using Unicode characters.
4159 ~ It will be rendered using OMML math markup.
4162 ~ If the `--webtex` option is used, formulas are rendered as images
4163 using CodeCogs or other compatible web service, downloaded
4164 and embedded in the e-book. Otherwise, they will appear verbatim.
4166HTML, Slidy, DZSlides, S5, EPUB
4167 ~ The way math is rendered in HTML will depend on the
4168 command-line options selected. Therefore see [Math rendering in HTML]
4171[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4175#### Extension: `raw_html` ####
4177Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4178(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4179literally). (Technically this is not an extension, since standard
4180Markdown allows it, but it has been made an extension so that it can
4181be disabled if desired.)
4183The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4184DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4185output, and suppressed in other formats.
4187For a more explicit way of including raw HTML in a Markdown
4188document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4190In the CommonMark format, if `raw_html` is enabled, superscripts,
4191subscripts, strikeouts and small capitals will be represented as HTML.
4192Otherwise, plain-text fallbacks will be used. Note that even if
4193`raw_html` is disabled, tables will be rendered with HTML syntax if
4194they cannot use pipe syntax.
4196#### Extension: `markdown_in_html_blocks` ####
4198Standard Markdown allows you to include HTML "blocks": blocks
4199of HTML between balanced tags that are separated from the surrounding text
4200with blank lines, and start and end at the left margin. Within
4201these blocks, everything is interpreted as HTML, not Markdown;
4202so (for example), `*` does not signify emphasis.
4204Pandoc behaves this way when the `markdown_strict` format is used; but
4205by default, pandoc interprets material between HTML block tags as Markdown.
4206Thus, for example, pandoc will turn
4211 <td>[a link](http://google.com)</td>
4219 <td><em>one</em></td>
4220 <td><a href="http://google.com">a link</a></td>
4224whereas `Markdown.pl` will preserve it as is.
4226There is one exception to this rule: text between `<script>` and
4227`<style>` tags is not interpreted as Markdown.
4229This departure from standard Markdown should make it easier to mix
4230Markdown with HTML block elements. For example, one can surround
4231a block of Markdown text with `<div>` tags without preventing it
4232from being interpreted as Markdown.
4234#### Extension: `native_divs` ####
4236Use native pandoc `Div` blocks for content inside `<div>` tags.
4237For the most part this should give the same output as
4238`markdown_in_html_blocks`, but it makes it easier to write pandoc
4239filters to manipulate groups of blocks.
4241#### Extension: `native_spans` ####
4243Use native pandoc `Span` blocks for content inside `<span>` tags.
4244For the most part this should give the same output as `raw_html`,
4245but it makes it easier to write pandoc filters to manipulate groups
4248#### Extension: `raw_tex` ####
4250In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4251included in a document. Inline TeX commands will be preserved and passed
4252unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4253LaTeX to include BibTeX citations:
4255 This result was proved in \cite{jones.1967}.
4257Note that in LaTeX environments, like
4259 \begin{tabular}{|l|l|}\hline
4260 Age & Frequency \\ \hline
4263 36--45 & 22 \\ \hline
4266the material between the begin and end tags will be interpreted as raw
4267LaTeX, not as Markdown.
4269For a more explicit and flexible way of including raw TeX in a
4270Markdown document, see the [`raw_attribute`
4271extension][Extension: `raw_attribute`].
4273Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4274Emacs Org mode, and ConTeXt.
4276### Generic raw attribute ###
4278#### Extension: `raw_attribute` ####
4280Inline spans and fenced code blocks with a special
4281kind of attribute will be parsed as raw content with the
4282designated format. For example, the following produces a raw
4289And the following produces a raw `html` inline element:
4291 This is `<a>html</a>`{=html}
4293This can be useful to insert raw xml into `docx` documents, e.g.
4299 <w:br w:type="page"/>
4304The format name should match the target format name (see
4305`-t/--to`, above, for a list, or use `pandoc
4306--list-output-formats`). Use `openxml` for `docx` output,
4307`opendocument` for `odt` output, `html5` for `epub3` output,
4308`html4` for `epub2` output, and `latex`, `beamer`,
4309`ms`, or `html5` for `pdf` output (depending on what you
4310use for `--pdf-engine`).
4312This extension presupposes that the relevant kind of
4313inline code or fenced code block is enabled. Thus, for
4314example, to use a raw attribute with a backtick code block,
4315`backtick_code_blocks` must be enabled.
4317The raw attribute cannot be combined with regular attributes.
4321#### Extension: `latex_macros` ####
4323When this extension is enabled, pandoc will parse LaTeX
4324macro definitions and apply the resulting macros to all LaTeX
4325math and raw LaTeX. So, for example, the following will work in
4326all output formats, not just LaTeX:
4328 \newcommand{\tuple}[1]{\langle #1 \rangle}
4332Note that LaTeX macros will not be applied if they occur
4333inside a raw span or block marked with the
4334[`raw_attribute` extension](#extension-raw_attribute).
4336When `latex_macros` is disabled, the raw LaTeX and math will
4337not have macros applied. This is usually a better approach when
4338you are targeting LaTeX or PDF.
4340Macro definitions in LaTeX will be passed through as raw LaTeX
4341only if `latex_macros` is not enabled. Macro definitions in
4342Markdown source (or other formats allowing `raw_tex`) will
4343be passed through regardless of whether `latex_macros` is
4348Markdown allows links to be specified in several ways.
4350### Automatic links ###
4352If you enclose a URL or email address in pointy brackets, it
4356 <sam@green.eggs.ham>
4360An inline link consists of the link text in square brackets,
4361followed by the URL in parentheses. (Optionally, the URL can
4362be followed by a link title, in quotes.)
4364 This is an [inline link](/url), and here's [one with
4365 a title](http://fsf.org "click here for a good time!").
4367There can be no space between the bracketed part and the parenthesized part.
4368The link text can contain formatting (such as emphasis), but the title cannot.
4370Email addresses in inline links are not autodetected, so they have to be
4371prefixed with `mailto`:
4373 [Write me!](mailto:sam@green.eggs.ham)
4375### Reference links ###
4377An *explicit* reference link has two parts, the link itself and the link
4378definition, which may occur elsewhere in the document (either
4379before or after the link).
4381The link consists of link text in square brackets, followed by a label in
4382square brackets. (There cannot be space between the two unless the
4383`spaced_reference_links` extension is enabled.) The link definition
4384consists of the bracketed label, followed by a colon and a space, followed by
4385the URL, and optionally (after a space) a link title either in quotes or in
4386parentheses. The label must not be parseable as a citation (assuming
4387the `citations` extension is enabled): citations take precedence over
4390Here are some examples:
4392 [my label 1]: /foo/bar.html "My title, optional"
4394 [my label 3]: http://fsf.org (The free software foundation)
4395 [my label 4]: /bar#special 'A title in single quotes'
4397The URL may optionally be surrounded by angle brackets:
4399 [my label 5]: <http://foo.bar.baz>
4401The title may go on the next line:
4403 [my label 3]: http://fsf.org
4404 "The free software foundation"
4406Note that link labels are not case sensitive. So, this will work:
4408 Here is [my link][FOO]
4412In an *implicit* reference link, the second pair of brackets is
4417 [my website]: http://foo.bar.baz
4419Note: In `Markdown.pl` and most other Markdown implementations,
4420reference link definitions cannot occur in nested constructions
4421such as list items or block quotes. Pandoc lifts this arbitrary
4422seeming restriction. So the following is fine in pandoc, though
4423not in most other implementations:
4429#### Extension: `shortcut_reference_links` ####
4431In a *shortcut* reference link, the second pair of brackets may
4436 [my website]: http://foo.bar.baz
4438### Internal links ###
4440To link to another section of the same document, use the automatically
4441generated identifier (see [Heading identifiers]). For example:
4443 See the [Introduction](#introduction).
4447 See the [Introduction].
4449 [Introduction]: #introduction
4451Internal links are currently supported for HTML formats (including
4452HTML slide shows and EPUB), LaTeX, and ConTeXt.
4456A link immediately preceded by a `!` will be treated as an image.
4457The link text will be used as the image's alt text:
4459 
4463 [movie reel]: movie.gif
4465#### Extension: `implicit_figures` ####
4467An image with nonempty alt text, occurring by itself in a
4468paragraph, will be rendered as a figure with a caption. The
4469image's alt text will be used as the caption.
4471 
4473How this is rendered depends on the output format. Some output
4474formats (e.g. RTF) do not yet support figures. In those
4475formats, you'll just get an image in a paragraph by itself, with
4478If you just want a regular inline image, just make sure it is not
4479the only thing in the paragraph. One way to do this is to insert a
4480nonbreaking space after the image:
4482 \
4484Note that in reveal.js slide shows, an image in a paragraph
4485by itself that has the `stretch` class will fill the screen,
4486and the caption and figure tags will be omitted.
4488#### Extension: `link_attributes` ####
4490Attributes can be set on links and images:
4492 An inline {#id .class width=30 height=20px}
4493 and a reference ![image][ref] with attributes.
4495 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4497(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4498and `.class` are used.)
4500For HTML and EPUB, all known HTML5 attributes except `width` and
4501`height` (but including `srcset` and `sizes`) are passed through
4502as is. Unknown attributes are passed through as custom
4503attributes, with `data-` prepended. The other writers ignore
4504attributes that are not specifically supported by their output format.
4506The `width` and `height` attributes on images are treated specially. When
4507used without a unit, the unit is assumed to be pixels. However, any of
4508the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4509and `%`. There must not be any spaces between the number and the unit.
4513{ width=50% }
4516- Dimensions are converted to inches for output in page-based formats like
4517 LaTeX. Dimensions are converted to pixels for output in HTML-like
4518 formats. Use the `--dpi` option to specify the number of pixels per
4519 inch. The default is 96dpi.
4520- The `%` unit is generally relative to some available space.
4521 For example the above example will render to the following.
4522 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4523 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4524 (If you're using a custom template, you need to configure `graphicx`
4525 as in the default template.)
4526 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4527- Some output formats have a notion of a class
4528 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4529 or a unique identifier (LaTeX `\caption`), or both (HTML).
4530- When no `width` or `height` attributes are specified, the fallback
4531 is to look at the image resolution and the dpi metadata embedded in
4536Using the `native_divs` and `native_spans` extensions
4537(see [above][Extension: `native_divs`]), HTML syntax can
4538be used as part of markdown to create native `Div` and `Span`
4539elements in the pandoc AST (as opposed to raw HTML).
4540However, there is also nicer syntax available:
4542#### Extension: `fenced_divs` ####
4544Allow special fenced syntax for native `Div` blocks. A Div
4545starts with a fence containing at least three consecutive
4546colons plus some attributes. The attributes may optionally
4547be followed by another string of consecutive colons.
4548The attribute syntax is exactly as in fenced code blocks (see
4549[Extension: `fenced_code_attributes`]). As with fenced
4550code blocks, one can use either attributes in curly braces
4551or a single unbraced word, which will be treated as a class
4552name. The Div ends with another line containing a string of at
4553least three consecutive colons. The fenced Div should be
4554separated by blank lines from preceding and following blocks.
4558 ::::: {#special .sidebar}
4559 Here is a paragraph.
4564Fenced divs can be nested. Opening fences are distinguished
4565because they *must* have attributes:
4571 This is a warning within a warning.
4575Fences without attributes are always closing fences. Unlike
4576with fenced code blocks, the number of colons in the closing
4577fence need not match the number in the opening fence. However,
4578it can be helpful for visual clarity to use fences of different
4579lengths to distinguish nested divs from their parents.
4582#### Extension: `bracketed_spans` ####
4584A bracketed sequence of inlines, as one would use to begin
4585a link, will be treated as a `Span` with attributes if it is
4586followed immediately by attributes:
4588 [This is *some text*]{.class key="val"}
4592#### Extension: `footnotes` ####
4594Pandoc's Markdown allows footnotes, using the following syntax:
4596 Here is a footnote reference,[^1] and another.[^longnote]
4598 [^1]: Here is the footnote.
4600 [^longnote]: Here's one with multiple blocks.
4602 Subsequent paragraphs are indented to show that they
4603 belong to the previous footnote.
4607 The whole paragraph can be indented, or just the first
4608 line. In this way, multi-paragraph footnotes work like
4609 multi-paragraph list items.
4611 This paragraph won't be part of the note, because it
4614The identifiers in footnote references may not contain spaces, tabs,
4615or newlines. These identifiers are used only to correlate the
4616footnote reference with the note itself; in the output, footnotes
4617will be numbered sequentially.
4619The footnotes themselves need not be placed at the end of the
4620document. They may appear anywhere except inside other block elements
4621(lists, block quotes, tables, etc.). Each footnote should be
4622separated from surrounding content (including other footnotes)
4625#### Extension: `inline_notes` ####
4627Inline footnotes are also allowed (though, unlike regular notes,
4628they cannot contain multiple paragraphs). The syntax is as follows:
4630 Here is an inline note.^[Inlines notes are easier to write, since
4631 you don't have to pick an identifier and move down to type the
4634Inline and regular footnotes may be mixed freely.
4638#### Extension: `citations` ####
4640Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4641citations and a bibliography in a number of styles. Basic usage is
4643 pandoc --filter pandoc-citeproc myinput.txt
4645In order to use this feature, you will need to specify a bibliography file
4646using the `bibliography` metadata field in a YAML metadata section, or
4647`--bibliography` command line argument. You can supply multiple `--bibliography`
4648arguments or set `bibliography` metadata field to YAML array, if you want to
4649use multiple bibliography files. The bibliography may have any of these
4652 Format File extension
4653 ------------ --------------
4666Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4667use `.bibtex` to force BibTeX.
4669Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4670can produce `.json` and `.yaml` files from any of the supported formats.
4672In-field markup: In BibTeX and BibLaTeX databases,
4673pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4674databases, pandoc Markdown; and in CSL JSON databases, an
4675[HTML-like markup][CSL markup specs]:
4683`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4692`<span class="nocase">...</span>`
4693: prevent a phrase from being capitalized as title case
4695`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4696and CSL YAML formats as far as possible.
4698As an alternative to specifying a bibliography file using `--bibliography`
4699or the YAML metadata field `bibliography`, you can include
4700the citation data directly in the `references` field of the
4701document's YAML metadata. The field should contain an array of
4702YAML-encoded references, for example:
4706 - type: article-journal
4718 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4720 title-short: Molecular structure of nucleic acids
4721 container-title: Nature
4725 DOI: 10.1038/171737a0
4726 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4730(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4731of the supported formats.)
4733Citations and references can be formatted using any style supported by the
4734[Citation Style Language], listed in the [Zotero Style Repository].
4735These files are specified using the `--csl` option or the `csl` metadata field.
4736By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4737format. The CSL project provides further information on [finding and editing styles].
4739To make your citations hyperlinks to the corresponding bibliography
4740entries, add `link-citations: true` to your YAML metadata.
4742Citations go inside square brackets and are separated by semicolons.
4743Each citation must have a key, composed of '@' + the citation
4744identifier from the database, and may optionally have a prefix,
4745a locator, and a suffix. The citation key must begin with a letter, digit,
4746or `_`, and may contain alphanumerics, `_`, and internal punctuation
4747characters (`:.#$%&-+?<>~/`). Here are some examples:
4749 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4751 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4753 Blah blah [@smith04; @doe99].
4755`pandoc-citeproc` detects locator terms in the [CSL locale files].
4756Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4757locale, locator terms can be written in either singular or plural forms,
4758as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4759`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4760`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4761`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4762`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4763`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4764locator term is used, "page" is assumed.
4766`pandoc-citeproc` will use heuristics to distinguish the locator
4767from the suffix. In complex cases, the locator can be enclosed
4768in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4770 [@smith{ii, A, D-Z}, with a suffix]
4771 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4773A minus sign (`-`) before the `@` will suppress mention of
4774the author in the citation. This can be useful when the
4775author is already mentioned in the text:
4777 Smith says blah [-@smith04].
4779You can also write an in-text citation, as follows:
4783 @smith04 [p. 33] says blah.
4785If the style calls for a list of works cited, it will be placed
4786in a div with id `refs`, if one exists:
4791Otherwise, it will be placed at the end of the document.
4792Generation of the bibliography can be suppressed by setting
4793`suppress-bibliography: true` in the YAML metadata.
4795If you wish the bibliography to have a section heading, you can
4796set `reference-section-title` in the metadata, or put the heading
4797at the beginning of the div with id `refs` (if you are using it)
4798or at the end of your document:
4804The bibliography will be inserted after this heading. Note that
4805the `unnumbered` class will be added to this heading, so that the
4806section will not be numbered.
4808If you want to include items in the bibliography without actually
4809citing them in the body text, you can define a dummy `nocite` metadata
4810field and put the citations there:
4819In this example, the document will contain a citation for `item3`
4820only, but the bibliography will contain entries for `item1`, `item2`, and
4823It is possible to create a bibliography with all the citations,
4824whether or not they appear in the document, by using a wildcard:
4831For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4832render the bibliography. In order to do so, specify bibliography
4833files as outlined above, and add `--natbib` or `--biblatex`
4834argument to `pandoc` invocation. Bear in mind that bibliography
4835files have to be in respective format (either BibTeX or
4838For more information, see the [pandoc-citeproc man page].
4840[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4841[Chicago Manual of Style]: http://chicagomanualofstyle.org
4842[Citation Style Language]: http://citationstyles.org
4843[Zotero Style Repository]: https://www.zotero.org/styles
4844[finding and editing styles]: https://citationstyles.org/authors/
4845[CSL locale files]: https://github.com/citation-style-language/locales
4846[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4848## Non-pandoc extensions
4850The following Markdown syntax extensions are not enabled by default
4851in pandoc, but may be enabled by adding `+EXTENSION` to the format
4852name, where `EXTENSION` is the name of the extension. Thus, for
4853example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4855#### Extension: `old_dashes` ####
4857Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4858`-` before a numeral is an en-dash, and `--` is an em-dash.
4859This option only has an effect if `smart` is enabled. It is
4860selected automatically for `textile` input.
4862#### Extension: `angle_brackets_escapable` ####
4864Allow `<` and `>` to be backslash-escaped, as they can be in
4865GitHub flavored Markdown but not original Markdown. This is
4866implied by pandoc's default `all_symbols_escapable`.
4868#### Extension: `lists_without_preceding_blankline` ####
4870Allow a list to occur right after a paragraph, with no intervening
4873#### Extension: `four_space_rule` ####
4875Selects the pandoc <= 2.0 behavior for parsing lists, so that
4876four spaces indent are needed for list item continuation
4879#### Extension: `spaced_reference_links` ####
4881Allow whitespace between the two components of a reference link,
4886#### Extension: `hard_line_breaks` ####
4888Causes all newlines within a paragraph to be interpreted as hard line
4889breaks instead of spaces.
4891#### Extension: `ignore_line_breaks` ####
4893Causes newlines within a paragraph to be ignored, rather than being
4894treated as spaces or as hard line breaks. This option is intended for
4895use with East Asian languages where spaces are not used between words,
4896but text is divided into lines for readability.
4898#### Extension: `east_asian_line_breaks` ####
4900Causes newlines within a paragraph to be ignored, rather than
4901being treated as spaces or as hard line breaks, when they occur
4902between two East Asian wide characters. This is a better choice
4903than `ignore_line_breaks` for texts that include a mix of East
4904Asian wide characters and other characters.
4906#### Extension: `emoji` ####
4908Parses textual emojis like `:smile:` as Unicode emoticons.
4910#### Extension: `tex_math_single_backslash` ####
4912Causes anything between `\(` and `\)` to be interpreted as inline
4913TeX math, and anything between `\[` and `\]` to be interpreted
4914as display TeX math. Note: a drawback of this extension is that
4915it precludes escaping `(` and `[`.
4917#### Extension: `tex_math_double_backslash` ####
4919Causes anything between `\\(` and `\\)` to be interpreted as inline
4920TeX math, and anything between `\\[` and `\\]` to be interpreted
4923#### Extension: `markdown_attribute` ####
4925By default, pandoc interprets material inside block-level tags as Markdown.
4926This extension changes the behavior so that Markdown is only parsed
4927inside block-level tags if the tags have the attribute `markdown=1`.
4929#### Extension: `mmd_title_block` ####
4931Enables a [MultiMarkdown] style title block at the top of
4932the document, for example:
4936 Date: September 1, 2008
4937 Comment: This is a sample mmd title block, with
4938 a field spanning multiple lines.
4940See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4941`yaml_metadata_block` is enabled, it will take precedence over
4944#### Extension: `abbreviations` ####
4946Parses PHP Markdown Extra abbreviation keys, like
4948 *[HTML]: Hypertext Markup Language
4950Note that the pandoc document model does not support
4951abbreviations, so if this extension is enabled, abbreviation keys are
4952simply skipped (as opposed to being parsed as paragraphs).
4954#### Extension: `autolink_bare_uris` ####
4956Makes all absolute URIs into links, even when not surrounded by
4957pointy braces `<...>`.
4959#### Extension: `mmd_link_attributes` ####
4961Parses multimarkdown style key-value attributes on link
4962and image references. This extension should not be confused with the
4963[`link_attributes`](#extension-link_attributes) extension.
4965 This is a reference ![image][ref] with multimarkdown attributes.
4967 [ref]: http://path.to/image "Image title" width=20px height=30px
4968 id=myId class="myClass1 myClass2"
4970#### Extension: `mmd_header_identifiers` ####
4972Parses multimarkdown style heading identifiers (in square brackets,
4973after the heading but before any trailing `#`s in an ATX heading).
4975#### Extension: `compact_definition_lists` ####
4977Activates the definition list syntax of pandoc 1.12.x and earlier.
4978This syntax differs from the one described above under [Definition lists]
4981 - No blank line is required between consecutive items of the
4983 - To get a "tight" or "compact" list, omit space between consecutive
4984 items; the space between a term and its definition does not affect
4986 - Lazy wrapping of paragraphs is not allowed: the entire definition must
4987 be indented four spaces.[^6]
4989[^6]: To see why laziness is incompatible with relaxing the requirement
4990 of a blank line between items, consider the following example:
4997 Is this a single list item with two definitions of "bar," the first of
4998 which is lazily wrapped, or two list items? To remove the ambiguity
4999 we must either disallow lazy wrapping or require a blank line between
5002#### Extension: `gutenberg` ####
5004Use [Project Gutenberg] conventions for `plain` output:
5005all-caps for strong emphasis, surround by underscores
5006for regular emphasis, add extra blank space around headings.
5008 [Project Gutenberg]: https://www.gutenberg.org
5012In addition to pandoc's extended Markdown, the following Markdown
5013variants are supported:
5015`markdown_phpextra` (PHP Markdown Extra)
5016: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5017 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5018 `header_attributes`, `link_attributes`, `abbreviations`,
5019 `shortcut_reference_links`, `spaced_reference_links`.
5021`markdown_github` (deprecated GitHub-Flavored Markdown)
5022: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5023 `gfm_auto_identifiers`, `backtick_code_blocks`,
5024 `autolink_bare_uris`, `space_in_atx_header`,
5025 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5026 `shortcut_reference_links`, `angle_brackets_escapable`,
5027 `lists_without_preceding_blankline`.
5029`markdown_mmd` (MultiMarkdown)
5030: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5031 `tex_math_double_backslash`, `intraword_underscores`,
5032 `mmd_title_block`, `footnotes`, `definition_lists`,
5033 `all_symbols_escapable`, `implicit_header_references`,
5034 `auto_identifiers`, `mmd_header_identifiers`,
5035 `shortcut_reference_links`, `implicit_figures`,
5036 `superscript`, `subscript`, `backtick_code_blocks`,
5037 `spaced_reference_links`, `raw_attribute`.
5039`markdown_strict` (Markdown.pl)
5040: `raw_html`, `shortcut_reference_links`,
5041 `spaced_reference_links`.
5043We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5044which is implemented as a set of extensions on `commonmark`).
5046Note, however, that `commonmark` and `gfm` have limited support
5047for extensions. Only those listed below (and `smart`,
5048`raw_tex`, and `hard_line_breaks`) will work. The extensions
5049can, however, all be individually disabled. Also, `raw_tex`
5050only affects `gfm` output, not input.
5052`gfm` (GitHub-Flavored Markdown)
5053: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5054 `gfm_auto_identifiers`, `backtick_code_blocks`,
5055 `autolink_bare_uris`, `space_in_atx_header`,
5056 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5057 `shortcut_reference_links`, `angle_brackets_escapable`,
5058 `lists_without_preceding_blankline`.
5061# Producing slide shows with pandoc
5063You can use pandoc to produce an HTML + JavaScript slide presentation
5064that can be viewed via a web browser. There are five ways to do this,
5065using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5066You can also produce a PDF slide show using LaTeX [`beamer`], or
5067slides shows in Microsoft [PowerPoint] format.
5069Here's the Markdown source for a simple slide show, `habits.txt`:
5096 
5103To produce an HTML/JavaScript slide show, simply type
5105 pandoc -t FORMAT -s habits.txt -o habits.html
5107where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5109For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5110`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5111assumed to be available at the relative path `s5/default` (for S5), `slideous`
5112(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5113`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5114`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5115above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5118With all HTML slide formats, the `--self-contained` option can be used to
5119produce a single file that contains all of the data necessary to display the
5120slide show, including linked scripts, stylesheets, images, and videos.
5122To produce a PDF slide show using beamer, type
5124 pandoc -t beamer habits.txt -o habits.pdf
5126Note that a reveal.js slide show can also be converted to a PDF
5127by printing it to a file from the browser.
5129To produce a Powerpoint slide show, type
5131 pandoc habits.txt -o habits.pptx
5133## Structuring the slide show
5135By default, the *slide level* is the highest heading level in
5136the hierarchy that is followed immediately by content, and not another
5137heading, somewhere in the document. In the example above, level-1 headings
5138are always followed by level-2 headings, which are followed by content,
5139so the slide level is 2. This default can be overridden using
5140the `--slide-level` option.
5142The document is carved up into slides according to the following
5145 * A horizontal rule always starts a new slide.
5147 * A heading at the slide level always starts a new slide.
5149 * Headings *below* the slide level in the hierarchy create
5150 headings *within* a slide.
5152 * Headings *above* the slide level in the hierarchy create
5153 "title slides," which just contain the section title
5154 and help to break the slide show into sections.
5155 Non-slide content under these headings will be included
5156 on the title slide (for HTML slide shows) or in a
5157 subsequent slide with the same title (for beamer).
5159 * A title page is constructed automatically from the document's title
5160 block, if present. (In the case of beamer, this can be disabled
5161 by commenting out some lines in the default template.)
5163These rules are designed to support many different styles of slide show. If
5164you don't care about structuring your slides into sections and subsections,
5165you can just use level-1 headings for all each slide. (In that case, level-1
5166will be the slide level.) But you can also structure the slide show into
5167sections, as in the example above.
5169Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5170layout will be produced, with level-1 headings building horizontally
5171and level-2 headings building vertically. It is not recommended that
5172you use deeper nesting of section levels with reveal.js.
5176By default, these writers produce lists that display "all at once."
5177If you want your lists to display incrementally (one item at a time),
5178use the `-i` option. If you want a particular list to depart from the
5179default, put it in a `div` block with class `incremental` or
5180`nonincremental`. So, for example, using the `fenced div` syntax, the
5181following would be incremental regardless of the document default:
5199While using `incremental` and `nonincremental` divs are the
5200recommended method of setting incremental lists on a per-case basis,
5201an older method is also supported: putting lists inside a blockquote
5202will depart from the document default (that is, it will display
5203incrementally without the `-i` option and all at once with the `-i`
5209Both methods allow incremental and nonincremental lists to be mixed
5210in a single document.
5212Note: Neither the `-i/--incremental` option nor any of the
5213methods described here currently works for PowerPoint output.
5217You can add "pauses" within a slide by including a paragraph containing
5218three dots, separated by spaces:
5220 # Slide with a pause
5222 content before the pause
5226 content after the pause
5228Note: this feature is not yet implemented for PowerPoint output.
5230## Styling the slides
5232You can change the style of HTML slides by putting customized CSS files
5233in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5234or `$DATADIR/slideous` (for Slideous),
5235where `$DATADIR` is the user data directory (see `--data-dir`, above).
5236The originals may be found in pandoc's system data directory (generally
5237`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5238files it does not find in the user data directory.
5240For dzslides, the CSS is included in the HTML file itself, and may
5243All [reveal.js configuration options] can be set through variables.
5244For example, themes can be used by setting the `theme` variable:
5248Or you can specify a custom stylesheet using the `--css` option.
5250To style beamer slides, you can specify a `theme`, `colortheme`,
5251`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5253 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5255Note that heading attributes will turn into slide attributes
5256(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5257to style individual slides. In beamer, the only heading attribute
5258that affects slides is the `allowframebreaks` class, which sets the
5259`allowframebreaks` option, causing multiple slides to be created
5260if the content overfills the frame. This is recommended especially for
5263 # References {.allowframebreaks}
5267Speaker notes are supported in reveal.js and PowerPoint (pptx)
5268output. You can add notes to your Markdown document thus:
5274 - It can contain Markdown
5279To show the notes window in reveal.js, press `s` while viewing the
5280presentation. Speaker notes in PowerPoint will be available, as usual,
5281in handouts and presenter view.
5283Notes are not yet supported for other slide formats, but the notes
5284will not appear on the slides themselves.
5288To put material in side by side columns, you can use a native
5289div container with class `columns`, containing two or more div
5290containers with class `column` and a `width` attribute:
5292 :::::::::::::: {.columns}
5293 ::: {.column width="40%"}
5296 ::: {.column width="60%"}
5301## Frame attributes in beamer
5303Sometimes it is necessary to add the LaTeX `[fragile]` option to
5304a frame in beamer (for example, when using the `minted` environment).
5305This can be forced by adding the `fragile` class to the heading
5306introducing the slide:
5308 # Fragile slide {.fragile}
5310All of the other frame attributes described in Section 8.1 of
5311the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5312`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5313`shrink`, `standout`, `noframenumbering`.
5315## Background in reveal.js and beamer
5317Background images can be added to self-contained reveal.js slideshows and
5318to beamer slideshows.
5320For the same image on every slide, use the configuration
5321option `background-image` either in the YAML metadata block
5322or as a command-line variable. (There are no other options in
5323beamer and the rest of this section concerns reveal.js slideshows.)
5325For reveal.js, you can instead use the reveal.js-native option
5326`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5327and `parallaxBackgroundVertical` the same way and must also set
5328`parallaxBackgroundSize` to have your values take effect.
5330To set an image for a particular reveal.js slide, add
5331`{data-background-image="/path/to/image"}`
5332to the first slide-level heading on the slide (which may even be empty).
5334In reveal.js's overview mode, the parallaxBackgroundImage will show up
5335only on the first slide.
5337Other reveal.js background settings also work on individual slides, including
5338`data-background-size`, `data-background-repeat`, `data-background-color`,
5339`data-transition`, and `data-transition-speed`.
5342documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5345For example in reveal.js:
5350parallaxBackgroundImage: /path/to/my/background_image.png
5355Slide 1 has background_image.png as its background.
5357## {data-background-image="/path/to/special_image.jpg"}
5359Slide 2 has a special image for its background, even though the heading has no content.
5362# Creating EPUBs with pandoc
5366EPUB metadata may be specified using the `--epub-metadata` option, but
5367if the source document is Markdown, it is better to use a [YAML metadata
5368block][Extension: `yaml_metadata_block`]. Here is an example:
5375 text: An investigation of metadata
5383 text: doi:10.234234.234/33
5385 rights: © 2007 John Smith, CC BY-NC
5390The following fields are recognized:
5393 ~ Either a string value or an object with fields `text` and
5394 `scheme`. Valid values for `scheme` are `ISBN-10`,
5395 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5396 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5397 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5400 ~ Either a string value, or an object with fields `file-as` and
5401 `type`, or a list of such objects. Valid values for `type` are
5402 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5405 ~ Either a string value, or an object with fields `role`, `file-as`,
5406 and `text`, or a list of such objects. Valid values for `role` are
5407 [MARC relators], but
5408 pandoc will attempt to translate the human-readable versions
5409 (like "author" and "editor") to the appropriate marc relators.
5412 ~ Same format as `creator`.
5415 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5416 Pandoc will attempt to convert other common date formats.
5418`lang` (or legacy: `language`)
5419 ~ A string value in [BCP 47] format. Pandoc will default to the local
5420 language if nothing is specified.
5423 ~ A string value or a list of such values.
5444 ~ A string value (path to cover image).
5446`css` (or legacy: `stylesheet`)
5447 ~ A string value (path to CSS stylesheet).
5449`page-progression-direction`
5450 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5451 attribute for the [`spine` element].
5454 ~ iBooks-specific metadata, with the following fields:
5456 - `version`: (string)
5457 - `specified-fonts`: `true`|`false` (default `false`)
5458 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5459 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5460 - `binding`: `true`|`false` (default `true`)
5461 - `scroll-axis`: `vertical`|`horizontal`|`default`
5463[MARC relators]: http://loc.gov/marc/relators/relaterm.html
5464[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5466## The `epub:type` attribute
5468For `epub3` output, you can mark up the heading that corresponds to an EPUB
5469chapter using the [`epub:type` attribute][epub-type]. For example, to set
5470the attribute to the value `prologue`, use this markdown:
5472 # My chapter {epub:type=prologue}
5474Which will result in:
5476 <body epub:type="frontmatter">
5477 <section epub:type="prologue">
5480Pandoc will output `<body epub:type="bodymatter">`, unless
5481you use one of the following values, in which case either
5482`frontmatter` or `backmatter` will be output.
5484`epub:type` of first section `epub:type` of body
5485---------------------------- ------------------
5488acknowledgments frontmatter
5489copyright-page frontmatter
5490dedication frontmatter
5494contributors frontmatter
5495other-credits frontmatter
5497revision-history frontmatter
5498titlepage frontmatter
5499halftitlepage frontmatter
5500seriespage frontmatter
5503seriespage frontmatter
5504titlepage frontmatter
5507bibliography backmatter
5510[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5514By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5515`<video>` or `<source>` element present in the generated EPUB,
5516and include it in the EPUB container, yielding a completely
5517self-contained EPUB. If you want to link to external media resources
5518instead, use raw HTML in your source and add `data-external="1"` to the tag
5519with the `src` attribute. For example:
5521 <audio controls="1">
5522 <source src="http://example.com/music/toccata.mp3"
5523 data-external="1" type="audio/mpeg">
5527# Creating Jupyter notebooks with pandoc
5529When creating a [Jupyter notebook], pandoc will try to infer the
5530notebook structure. Code blocks with the class `code` will be
5531taken as code cells, and intervening content will be taken as
5532Markdown cells. Attachments will automatically be created for
5533images in Markdown cells. Metadata will be taken from the
5534`jupyter` metadata field. For example:
5543 display_name: Python 2
5550 file_extension: ".py"
5551 mimetype: "text/x-python"
5553 nbconvert_exporter: "python"
5554 pygments_lexer: "ipython2"
5560**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5561bibendum felis dictum sodales.
5570from IPython.display import HTML
5573console.log("hello");
5581This image  will be
5582included as a cell attachment.
5585If you want to add cell attributes, group cells differently, or
5586add output to code cells, then you need to include divs to
5587indicate the structure. You can use either [fenced
5588divs][Extension: `fenced_divs`] or [native divs][Extension:
5589`native_divs`] for this. Here is an example:
5592:::::: {.cell .markdown}
5595**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5596bibendum felis dictum sodales.
5599:::::: {.cell .code execution_count=1}
5604::: {.output .stream .stdout}
5611:::::: {.cell .code execution_count=2}
5613from IPython.display import HTML
5616console.log("hello");
5622::: {.output .execute_result execution_count=2}
5625console.log("hello");
5634If you include raw HTML or TeX in an output cell, use the
5635[raw attribute][Extension: `fenced_attribute`], as shown
5636in the last cell of the example above. Although pandoc can
5637process "bare" raw HTML and TeX, the result is often
5638interspersed raw elements and normal textual elements, and
5639in an output cell pandoc expects a single, connected raw
5640block. To avoid using raw HTML or TeX except when
5641marked explicitly using raw attributes, we recommend
5642specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5643translating between Markdown and ipynb notebooks.
5645Note that options and extensions that affect reading and
5646writing of Markdown will also affect Markdown cells in ipynb
5647notebooks. For example, `--wrap=preserve` will preserve
5648soft line breaks in Markdown cells; `--atx-headers` will
5649cause ATX-style headings to be used; and `--preserve-tabs` will
5650prevent tabs from being turned to spaces.
5652# Syntax highlighting
5654Pandoc will automatically highlight syntax in [fenced code blocks] that
5655are marked with a language name. The Haskell library [skylighting] is
5656used for highlighting. Currently highlighting is supported only for
5657HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5658that pandoc will recognize, type `pandoc --list-highlight-languages`.
5660The color scheme can be selected using the `--highlight-style` option.
5661The default color scheme is `pygments`, which imitates the default color
5662scheme used by the Python library pygments (though pygments is not actually
5663used to do the highlighting). To see a list of highlight styles,
5664type `pandoc --list-highlight-styles`.
5666If you are not satisfied with the predefined styles, you can
5667use `--print-highlight-style` to generate a JSON `.theme` file which
5668can be modified and used as the argument to `--highlight-style`. To
5669get a JSON version of the `pygments` style, for example:
5671 pandoc --print-highlight-style pygments > my.theme
5673Then edit `my.theme` and use it like this:
5675 pandoc --highlight-style my.theme
5677If you are not satisfied with the built-in highlighting, or you
5678want highlight a language that isn't supported, you can use the
5679`--syntax-definition` option to load a [KDE-style XML syntax definition
5680file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5681Before writing your own, have a look at KDE's [repository of syntax
5682definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5684To disable highlighting, use the `--no-highlight` option.
5686[skylighting]: https://github.com/jgm/skylighting
5690Custom styles can be used in the docx and ICML formats.
5694By default, pandoc's docx and ICML output applies a predefined set of styles
5695for blocks such as paragraphs and block quotes, and uses largely default
5696formatting (italics, bold) for inlines. This will work for most
5697purposes, especially alongside a `reference.docx` file. However, if you
5698need to apply your own styles to blocks, or match a preexisting set of
5699styles, pandoc allows you to define custom styles for blocks and text
5700using `div`s and `span`s, respectively.
5702If you define a `div` or `span` with the attribute `custom-style`,
5703pandoc will apply your specified style to the contained elements (with
5704the exception of elements whose function depends on a style, like
5705headings, code blocks, block quotes, or links). So, for example, using
5706the `bracketed_spans` syntax,
5708 [Get out]{custom-style="Emphatically"}, he said.
5710would produce a docx file with "Get out" styled with character
5711style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5713 Dickinson starts the poem simply:
5715 ::: {custom-style="Poetry"}
5716 | A Bird came down the Walk---
5717 | He did not know I saw---
5720would style the two contained lines with the `Poetry` paragraph style.
5722For docx output, styles will be defined in the output file as inheriting
5723from normal text, if the styles are not yet in your reference.docx.
5724If they are already defined, pandoc will not alter the definition.
5726This feature allows for greatest customization in conjunction with
5727[pandoc filters]. If you want all paragraphs after block quotes to be
5728indented, you can write a filter to apply the styles necessary. If you
5729want all italics to be transformed to the `Emphasis` character style
5730(perhaps to change their color), you can write a filter which will
5731transform all italicized inlines to inlines within an `Emphasis`
5734For docx output, you don't need to enable any extensions for
5735custom styles to work.
5737[pandoc filters]: http://pandoc.org/filters.html
5741The docx reader, by default, only reads those styles that it can
5742convert into pandoc elements, either by direct conversion or
5743interpreting the derivation of the input document's styles.
5745By enabling the [`styles` extension](#ext-styles) in the docx reader
5746(`-f docx+styles`), you can produce output that maintains the styles
5747of the input document, using the `custom-style` class. Paragraph
5748styles are interpreted as divs, while character styles are interpreted
5751For example, using the `custom-style-reference.docx` file in the test
5752directory, we have the following different outputs:
5754Without the `+styles` extension:
5756 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5759 This is text with an *emphasized* text style. And this is text with a
5760 **strengthened** text style.
5762 > Here is a styled paragraph that inherits from Block Text.
5764And with the extension:
5766 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5768 ::: {custom-style="First Paragraph"}
5772 ::: {custom-style="Body Text"}
5773 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5774 And this is text with a [strengthened]{custom-style="Strengthened"}
5778 ::: {custom-style="My Block Style"}
5779 > Here is a styled paragraph that inherits from Block Text.
5782With these custom styles, you can use your input document as a
5783reference-doc while creating docx output (see below), and maintain the
5784same styles in your input and output files.
5788Pandoc can be extended with custom writers written in [lua]. (Pandoc
5789includes a lua interpreter, so lua need not be installed separately.)
5791To use a custom writer, simply specify the path to the lua script
5792in place of the output format. For example:
5794 pandoc -t data/sample.lua
5796Creating a custom writer requires writing a lua function for each
5797possible element in a pandoc document. To get a documented example
5798which you can modify according to your needs, do
5800 pandoc --print-default-data-file sample.lua
5802Note that custom writers have no default template. If you want
5803to use `--standalone` with a custom writer, you will need to
5804specify a template manually using `--template` or add a new
5805default template with the name
5806`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5807subdirectory of your user data directory (see [Templates]).
5809[lua]: http://www.lua.org
5813If you use pandoc to convert user-contributed content in a web
5814application, here are some things to keep in mind:
58161. Although pandoc itself will not create or modify any files other
5817 than those you explicitly ask it create (with the exception
5818 of temporary files used in producing PDFs), a filter or custom
5819 writer could in principle do anything on your file system. Please
5820 audit filters and custom writers very carefully before using them.
58222. If your application uses pandoc as a Haskell library (rather than
5823 shelling out to the executable), it is possible to use it in a mode
5824 that fully isolates pandoc from your file system, by running the
5825 pandoc operations in the `PandocPure` monad. See the document
5826 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
58293. Pandoc's parsers can exhibit pathological performance on some
5830 corner cases. It is wise to put any pandoc operations under
5831 a timeout, to avoid DOS attacks that exploit these issues.
5832 If you are using the pandoc executable, you can add the
5833 command line options `+RTS -M512M -RTS` (for example) to limit
5834 the heap size to 512MB.
58364. The HTML generated by pandoc is not guaranteed to be safe.
5837 If `raw_html` is enabled for the Markdown input, users can
5838 inject arbitrary HTML. Even if `raw_html` is disabled,
5839 users can include dangerous content in attributes for
5840 headings, spans, and code blocks. To be safe, you should
5841 run all the generated HTML through an HTML sanitizer.
5845Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5846under the [GPL], version 2 or greater. This software carries no
5847warranty of any kind. (See COPYRIGHT for full copyright and
5848warranty notices.) For a full list of contributors, see the file
5849AUTHORS.md in the pandoc source code.
5851[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5852[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