2title: Pandoc User's Guide
9`pandoc` [*options*] [*input-file*]...
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: 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`] (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. (By default, pandoc
638 converts tabs to spaces before parsing its input.) Note that this will
639 only affect tabs in literal code spans and code blocks. Tabs in regular
640 text are always treated as spaces.
644: Specify the number of spaces per tab (default is 4).
646`--track-changes=accept`|`reject`|`all`
648: Specifies what to do with insertions, deletions, and comments
649 produced by the MS Word "Track Changes" feature. `accept` (the
650 default), inserts all insertions, and ignores all
651 deletions. `reject` inserts all deletions and ignores
652 insertions. Both `accept` and `reject` ignore comments. `all` puts
653 in insertions, deletions, and comments, wrapped in spans with
654 `insertion`, `deletion`, `comment-start`, and `comment-end`
655 classes, respectively. The author and time of change is
656 included. `all` is useful for scripting: only accepting changes
657 from a certain reviewer, say, or before a certain date. If a
658 paragraph is inserted or deleted, `track-changes=all` produces a
659 span with the class `paragraph-insertion`/`paragraph-deletion`
660 before the affected paragraph break. This option only affects the
663`--extract-media=`*DIR*
665: Extract images and other media contained in or linked from
666 the source document to the path *DIR*, creating it if
667 necessary, and adjust the images references in the document
668 so they point to the extracted files. If the source format is
669 a binary container (docx, epub, or odt), the media is
670 extracted from the container and the original
671 filenames are used. Otherwise the media is read from the
672 file system or downloaded, and new filenames are constructed
673 based on SHA1 hashes of the contents.
675`--abbreviations=`*FILE*
677: Specifies a custom abbreviations file, with abbreviations
678 one to a line. If this option is not specified, pandoc will
679 read the data file `abbreviations` from the user data
680 directory or fall back on a system default. To see the
682 `pandoc --print-default-data-file=abbreviations`. The only
683 use pandoc makes of this list is in the Markdown reader.
684 Strings ending in a period that are found in this list will
685 be followed by a nonbreaking space, so that the period will
686 not produce sentence-ending space in formats like LaTeX.
688[`pandocfilters`]: https://github.com/jgm/pandocfilters
689[PHP]: https://github.com/vinai/pandocfilters-php
690[perl]: https://metacpan.org/pod/Pandoc::Filter
691[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
693## General writer options {.options}
697: Produce output with an appropriate header and footer (e.g. a
698 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
699 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
700 output. For `native` output, this option causes metadata to
701 be included; otherwise, metadata is suppressed.
703`--template=`*FILE*|*URL*
705: Use the specified file as a custom template for the generated document.
706 Implies `--standalone`. See [Templates], below, for a description
707 of template syntax. If no extension is specified, an extension
708 corresponding to the writer will be added, so that `--template=special`
709 looks for `special.html` for HTML output. If the template is not
710 found, pandoc will search for it in the `templates` subdirectory of
711 the user data directory (see `--data-dir`). If this option is not used,
712 a default template appropriate for the output format will be used (see
713 `-D/--print-default-template`).
715`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
717: Set the template variable *KEY* to the value *VAL* when rendering the
718 document in standalone mode. If no *VAL* is specified, the
719 key will be given the value `true`.
721`-D` *FORMAT*, `--print-default-template=`*FORMAT*
723: Print the system default template for an output *FORMAT*. (See `-t`
724 for a list of possible *FORMAT*s.) Templates in the user data
725 directory are ignored. This option may be used with
726 `-o`/`--output` to redirect output to a file, but
727 `-o`/`--output` must come before `--print-default-template`
730 Note that some of the default templates use partials, for
731 example `styles.html`. To print the partials, use
732 `--print-default-data-file`: for example,
733 `--print-default-data-file=templates/styles.html`.
735`--print-default-data-file=`*FILE*
737: Print a system default data file. Files in the user data directory
738 are ignored. This option may be used with `-o`/`--output` to
739 redirect output to a file, but `-o`/`--output` must come before
740 `--print-default-data-file` on the command line.
742`--eol=crlf`|`lf`|`native`
744: Manually specify line endings: `crlf` (Windows), `lf`
745 (macOS/Linux/UNIX), or `native` (line endings appropriate
746 to the OS on which pandoc is being run). The default is
751: Specify the default dpi (dots per inch) value for conversion
752 from pixels to inch/centimeters and vice versa. (Technically,
753 the correct term would be ppi: pixels per inch.) The default
754 is 96dpi. When images contain information about dpi
755 internally, the encoded value is used instead of the default
756 specified by this option.
758`--wrap=auto`|`none`|`preserve`
760: Determine how text is wrapped in the output (the source
761 code, not the rendered version). With `auto` (the default),
762 pandoc will attempt to wrap lines to the column width specified by
763 `--columns` (default 72). With `none`, pandoc will not wrap
764 lines at all. With `preserve`, pandoc will attempt to
765 preserve the wrapping from the source document (that is,
766 where there are nonsemantic newlines in the source, there
767 will be nonsemantic newlines in the output as well).
768 Automatic wrapping does not currently work in HTML output.
769 In `ipynb` output, this option affects wrapping of the
770 contents of markdown cells.
774: Specify length of lines in characters. This affects text wrapping
775 in the generated source code (see `--wrap`). It also affects
776 calculation of column widths for plain text tables (see [Tables] below).
778`--toc`, `--table-of-contents`
780: Include an automatically generated table of contents (or, in
781 the case of `latex`, `context`, `docx`, `odt`,
782 `opendocument`, `rst`, or `ms`, an instruction to create
783 one) in the output document. This option has no effect
784 unless `-s/--standalone` is used, and it has no effect
785 on `man`, `docbook4`, `docbook5`, or `jats` output.
787 Note that if you are producing a PDF via `ms`, the table
788 of contents will appear at the beginning of the
789 document, before the title. If you would prefer it to
790 be at the end of the document, use the option
791 `--pdf-engine-opt=--no-toc-relocation`.
793`--toc-depth=`*NUMBER*
795: Specify the number of section levels to include in the table
796 of contents. The default is 3 (which means that level-1, 2, and 3
797 headings will be listed in the contents).
801: Strip out HTML comments in the Markdown or Textile source,
802 rather than passing them on to Markdown, Textile or HTML
803 output as raw HTML. This does not apply to HTML comments
804 inside raw HTML blocks when the `markdown_in_html_blocks`
805 extension is not set.
809: Disables syntax highlighting for code blocks and inlines, even when
810 a language attribute is given.
812`--highlight-style=`*STYLE*|*FILE*
814: Specifies the coloring style to be used in highlighted source code.
815 Options are `pygments` (the default), `kate`, `monochrome`,
816 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
817 For more information on syntax highlighting in pandoc, see
818 [Syntax highlighting], below. See also
819 `--list-highlight-styles`.
821 Instead of a *STYLE* name, a JSON file with extension
822 `.theme` may be supplied. This will be parsed as a KDE
823 syntax highlighting theme and (if valid) used as the
826 To generate the JSON version of an existing style,
827 use `--print-highlight-style`.
829`--print-highlight-style=`*STYLE*|*FILE*
831: Prints a JSON version of a highlighting style, which can
832 be modified, saved with a `.theme` extension, and used
833 with `--highlight-style`. This option may be used with
834 `-o`/`--output` to redirect output to a file, but
835 `-o`/`--output` must come before `--print-highlight-style`
838`--syntax-definition=`*FILE*
840: Instructs pandoc to load a KDE XML syntax definition file,
841 which will be used for syntax highlighting of appropriately
842 marked code blocks. This can be used to add support for
843 new languages or to use altered syntax definitions for
844 existing languages. This option may be repeated to add
845 multiple syntax definitions.
847`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
849: Include contents of *FILE*, verbatim, at the end of the header.
850 This can be used, for example, to include special
851 CSS or JavaScript in HTML documents. This option can be used
852 repeatedly to include multiple files in the header. They will be
853 included in the order specified. Implies `--standalone`.
855`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
857: Include contents of *FILE*, verbatim, at the beginning of the
858 document body (e.g. after the `<body>` tag in HTML, or the
859 `\begin{document}` command in LaTeX). This can be used to include
860 navigation bars or banners in HTML documents. This option can be
861 used repeatedly to include multiple files. They will be included in
862 the order specified. Implies `--standalone`.
864`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
866: Include contents of *FILE*, verbatim, at the end of the document
867 body (before the `</body>` tag in HTML, or the
868 `\end{document}` command in LaTeX). This option can be used
869 repeatedly to include multiple files. They will be included in the
870 order specified. Implies `--standalone`.
872`--resource-path=`*SEARCHPATH*
874: List of paths to search for images and other resources.
875 The paths should be separated by `:` on Linux, UNIX, and
876 macOS systems, and by `;` on Windows. If `--resource-path`
877 is not specified, the default resource path is the working
878 directory. Note that, if `--resource-path` is specified,
879 the working directory must be explicitly listed or it
880 will not be searched. For example:
881 `--resource-path=.:test` will search the working directory
882 and the `test` subdirectory, in that order.
884 `--resource-path` only has an effect if (a) the output
885 format embeds images (for example, `docx`, `pdf`, or `html`
886 with `--self-contained`) or (b) it is used together with
889`--request-header=`*NAME*`:`*VAL*
891: Set the request header *NAME* to the value *VAL* when making
892 HTTP requests (for example, when a URL is given on the
893 command line, or when resources used in a document must be
894 downloaded). If you're behind a proxy, you also need to set
895 the environment variable `http_proxy` to `http://...`.
897## Options affecting specific writers {.options}
901: Produce a standalone HTML file with no external dependencies, using
902 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
903 images, and videos. Implies `--standalone`. The resulting file should be
904 "self-contained," in the sense that it needs no external files and no net
905 access to be displayed properly by a browser. This option works only with
906 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
907 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
908 and stylesheets at absolute URLs will be downloaded; those at relative
909 URLs will be sought relative to the working directory (if the first source
910 file is local) or relative to the base URL (if the first source
911 file is remote). Elements with the attribute
912 `data-external="1"` will be left alone; the documents they
913 link to will not be incorporated in the document.
914 Limitation: resources that are loaded dynamically through
915 JavaScript cannot be incorporated; as a result,
916 `--self-contained` does not work with `--mathjax`, and some
917 advanced features (e.g. zoom or speaker notes) may not work
918 in an offline "self-contained" `reveal.js` slide show.
922: Use `<q>` tags for quotes in HTML.
926: Use only ASCII characters in output. Currently supported for XML
927 and HTML formats (which use entities instead of UTF-8 when this
928 option is selected), CommonMark, gfm, and Markdown (which use
929 entities), roff ms (which use hexadecimal escapes), and to a
930 limited degree LaTeX (which uses standard commands for accented
931 characters when possible). roff man output uses ASCII by default.
935: Use reference-style links, rather than inline links, in writing Markdown
936 or reStructuredText. By default inline links are used. The
937 placement of link references is affected by the
938 `--reference-location` option.
940`--reference-location = block`|`section`|`document`
942: Specify whether footnotes (and references, if `reference-links` is
943 set) are placed at the end of the current (top-level) block, the
944 current section, or the document. The default is
945 `document`. Currently only affects the markdown writer.
949: Use ATX-style headings in Markdown output. The default is
950 to use setext-style headings for levels 1 to 2, and then ATX headings.
951 (Note: for `gfm` output, ATX headings are always used.)
952 This option also affects markdown cells in `ipynb` output.
954`--top-level-division=[default|section|chapter|part]`
956: Treat top-level headings as the given division type in LaTeX, ConTeXt,
957 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
958 all headings are shifted such that the top-level heading becomes the specified
959 type. The default behavior is to determine the best division type via
960 heuristics: unless other conditions apply, `section` is chosen. When the
961 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
962 `article` option is specified), `chapter` is implied as the setting for this
963 option. If `beamer` is the output format, specifying either `chapter` or
964 `part` will cause top-level headings to become `\part{..}`, while
965 second-level headings remain as their default type.
967`-N`, `--number-sections`
969: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
970 By default, sections are not numbered. Sections with class
971 `unnumbered` will never be numbered, even if `--number-sections`
974`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
976: Offset for section headings in HTML output (ignored in other
977 output formats). The first number is added to the section number for
978 top-level headings, the second for second-level headings, and so on.
979 So, for example, if you want the first top-level heading in your
980 document to be numbered "6", specify `--number-offset=5`.
981 If your document starts with a level-2 heading which you want to
982 be numbered "1.5", specify `--number-offset=1,4`.
983 Offsets are 0 by default. Implies `--number-sections`.
987: Use the [`listings`] package for LaTeX code blocks. The package
988 does not support multi-byte encoding for source code. To handle UTF-8
989 you would need to use a custom template. This issue is fully
990 documented here: [Encoding issue with the listings package].
994: Make list items in slide shows display incrementally (one by one).
995 The default is for lists to be displayed all at once.
997`--slide-level=`*NUMBER*
999: Specifies that headings with the specified level create
1000 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1001 above this level in the hierarchy are used to divide the
1002 slide show into sections; headings below this level create
1003 subheads within a slide. Note that content that is
1004 not contained under slide-level headings will not appear in
1005 the slide show. The default is to set the slide level based
1006 on the contents of the document; see [Structuring the slide
1011: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1012 and attach identifiers to the enclosing `<section>` (or `<div>`)
1013 rather than the heading itself. See
1014 [Heading identifiers], below.
1016`--email-obfuscation=none`|`javascript`|`references`
1018: Specify a method for obfuscating `mailto:` links in HTML documents.
1019 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1020 them using JavaScript. `references` obfuscates them by printing their
1021 letters as decimal or hexadecimal character references. The default
1024`--id-prefix=`*STRING*
1026: Specify a prefix to be added to all identifiers and internal links
1027 in HTML and DocBook output, and to footnote numbers in Markdown
1028 and Haddock output. This is useful for preventing duplicate
1029 identifiers when generating fragments to be included in other pages.
1031`-T` *STRING*, `--title-prefix=`*STRING*
1033: Specify *STRING* as a prefix at the beginning of the title
1034 that appears in the HTML header (but not in the title as it
1035 appears at the beginning of the HTML body). Implies `--standalone`.
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, use [] for no input:
1439# or you may use input-file: with a single value
1443self-contained: false
1445# note that structured variables may be specified:
1452# metadata values specified here are parsed as literal
1453# string text, not markdown:
1460# or you may use metadata-file: with a single value
1462# Note that these take files, not their contents:
1463include-before-body: []
1464include-after-body: []
1465include-in-header: []
1468# filters will be assumed to be lua filters if they have
1469# the .lua extension, and json filters otherwise. But
1470# the filter type can also be specified explicitly, as shown:
1481# ERROR, WARNING, or INFO
1485# citeproc, natbib, or biblatex
1486cite-method: citeproc
1487# part, chapter, section, or default:
1488top-level-division: chapter
1494# you may also use pdf-engine-opt: with a single option
1495# pdf-engine-opt: "-shell-escape"
1497# auto, preserve, or none
1502extract-media: mediadir
1504table-of-contents: true
1506number-sections: false
1507# a list of offsets at each heading level
1508number-offset: [0,0,0,0,0,0]
1509# toc: may also be used instead of table-of-contents:
1510shift-heading-level-by: 1
1512identifier-prefix: foo
1514strip-empty-paragraphs: true
1515# lf, crlf, or native
1517strip-comments: false
1518indented-code-classes: []
1520default-image-extension: ".jpg"
1522# either a style name of a style definition file:
1523highlight-style: pygments
1526# or you may use syntax-definition: with a single value
1529reference-doc: myref.docx
1531# method is plain, webtex, gladtex, mathml, mathjax, katex
1532# you may specify a url with webtex, mathjax, katex
1535 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1536# none, references, or javascript
1537email-obfuscation: javascript
1545epub-subdirectory: EPUB
1546epub-metadata: meta.xml
1549epub-chapter-level: 1
1550epub-cover-image: cover.jpg
1552reference-links: true
1553# block, section, or document
1554reference-location: block
1557# accept, reject, or all
1558track-changes: accept
1567# A list of two-element lists
1569- ["User-Agent", "Mozilla/5.0"]
1571fail-if-warnings: false
1577Fields that are omitted will just have their regular
1578default values. So a defaults file can be as simple as
1585Default files can be placed in the `defaults` subdirectory of
1586the user data directory and used from any directory. For
1587example, one could create a file specifying defaults for writing
1588letters, save it as `letter.yaml` in the `defaults` subdirectory
1589of the user data directory, and then invoke these defaults
1590from any directory using `pandoc --defaults letter`
1591or `pandoc -dletter`.
1593When multiple defaults are used, their contents will be combined.
1595Note that, where command-line arguments may be repeated
1596(`--metadata-file`, `--css`, `--include-in-header`,
1597`--include-before-body`, `--include-after-body`, `--variable`,
1598`--metadata`, `--syntax-definition`), the values specified on
1599the command line will combine with values specified in the
1600defaults file, rather than replacing them.
1604When the `-s/--standalone` option is used, pandoc uses a template to
1605add header and footer material that is needed for a self-standing
1606document. To see the default template that is used, just type
1610where *FORMAT* is the name of the output format. A custom template
1611can be specified using the `--template` option. You can also override
1612the system default templates for a given output format *FORMAT*
1613by putting a file `templates/default.*FORMAT*` in the user data
1614directory (see `--data-dir`, above). *Exceptions:*
1616- For `odt` output, customize the `default.opendocument`
1618- For `pdf` output, customize the `default.latex` template
1619 (or the `default.context` template, if you use `-t context`,
1620 or the `default.ms` template, if you use `-t ms`, or the
1621 `default.html` template, if you use `-t html`).
1622- `docx` and `pptx` have no template (however, you can use
1623 `--reference-doc` to customize the output).
1625Templates contain *variables*, which allow for the inclusion of
1626arbitrary information at any point in the file. They may be set at the
1627command line using the `-V/--variable` option. If a variable is not set,
1628pandoc will look for the key in the document's metadata, which can be set
1629using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1630or with the `-M/--metadata` option. In addition, some variables
1631are given default values by pandoc. See [Variables] below for
1632a list of variables used in pandoc's default templates.
1634If you use custom templates, you may need to revise them as pandoc
1635changes. We recommend tracking the changes in the default templates,
1636and modifying your custom templates accordingly. An easy way to do this
1637is to fork the [pandoc-templates] repository and merge in
1638changes after each pandoc release.
1640 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1646Anything between the sequence `$--` and the end of the
1647line will be treated as a comment and omitted from the output.
1651To mark variables and control structures in the template,
1652either `$`...`$` or `${`...`}` may be used as delimiters.
1653The styles may also be mixed in the same template, but the
1654opening and closing delimiter must match in each case. The
1655opening delimiter may be followed by one or more spaces
1656or tabs, which will be ignored. The closing delimiter may
1657be followed by one or more spaces or tabs, which will be
1660To include a literal `$` in the document, use `$$`.
1662### Interpolated variables
1664A slot for an interpolated variable is a variable name surrounded
1665by matched delimiters. Variable names must begin with a letter
1666and can contain letters, numbers, `_`, `-`, and `.`. The
1667keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1668not be used as variable names. Examples:
1681Variable names with periods are used to get at structured
1682variable values. So, for example, `employee.salary` will return the
1683value of the `salary` field of the object that is the value of
1684the `employee` field.
1686- If the value of the variable is simple value, it will be
1687 rendered verbatim. (Note that no escaping is done;
1688 the assumption is that the calling program will escape
1689 the strings appropriately for the output format.)
1690- If the value is a list, the values will be concatenated.
1691- If the value is a map, the string `true` will be rendered.
1692- Every other value will be rendered as the empty string.
1696A conditional begins with `if(variable)` (enclosed in
1697matched delimiters) and ends with `endif` (enclosed in matched
1698delimiters). It may optionally contain an `else` (enclosed in
1699matched delimiters). The `if` section is used if
1700`variable` has a non-empty value, otherwise the `else`
1701section is used (if present). Examples:
1716${if(foo)}bar${endif}
1729The keyword `elseif` may be used to simplify complex nested
1744A for loop begins with `for(variable)` (enclosed in
1745matched delimiters) and ends with `endfor` (enclosed in matched
1748- If `variable` is an array, the material inside the loop will
1749 be evaluated repeatedly, with `variable` being set to each
1750 value of the array in turn, and concatenated.
1751- If `variable` is a map, the material inside will be set to
1753- If the value of the associated variable is not an array or
1754 a map, a single iteration will be performed on its value.
1759$for(foo)$$foo$$sep$, $endfor$
1762 - $foo.last$, $foo.first$
1766 - ${ foo.bar.last }, ${ foo.bar.first }
1770$it.name$: $it.office$
1774You may optionally specify a separator between consecutive
1775values using `sep` (enclosed in matched delimiters). The
1776material between `sep` and the `endfor` is the separator.
1779${ for(foo) }${ foo }${ sep }, ${ endfor }
1782Instead of using `variable` inside the loop, the special
1783anaphoric keyword `it` may be used.
1787 - ${ it.last }, ${ it.first }
1793Partials (subtemplates stored in different files) may be
1794included using the syntax
1800Partials will be sought in the directory containing
1801the main template, and will be assumed to have the
1802same extension as the main template if they lack
1803an explicit extension. (If the partials are not
1804found here, they will also be sought in the `templates`
1805subdirectory of the user data directory.)
1807Partials may optionally be applied to variables using
1813${ articles:bibentry() }
1816If `articles` is an array, this will iterate over its
1817values, applying the partial `bibentry()` to each one. So the
1818second example above is equivalent to
1826Note that the anaphoric keyword `it` must be used when
1827iterating over partials. In the above examples,
1828the `bibentry` partial should contain `it.title`
1829(and so on) instead of `articles.title`.
1831Final newlines are omitted from included partials.
1833Partials may include other partials.
1835A separator between values of an array may be specified
1836in square brackets, immediately after the variable name
1842${articles:bibentry()[; ]$
1845The separator in this case is literal and (unlike with `sep`
1846in an explicit `for` loop) cannot contain interpolated
1847variables or other template directives.
1851To ensure that content is "nested," that is, subsequent lines
1852indented, use the `^` directive:
1855$item.number$ $^$$item.description$ ($item.price$)
1858In this example, if `item.description` has multiple lines,
1859they will all be indented to line up with the first line:
186200123 A fine bottle of 18-year old
1863 Oban whiskey. ($148)
1866To nest multiple lines to the same level, align them
1867with the `^` directive in the template. For example:
1870$item.number$ $^$$item.description$ ($item.price$)
1871 (Available til $item.sellby$.)
187700123 A fine bottle of 18-year old
1878 Oban whiskey. ($148)
1879 (Available til March 30, 2020.)
1882If a variable occurs by itself on a line, preceded by whitespace
1883and not followed by further text or directives on the same line,
1884and the variable's value contains multiple lines, it will be
1885nested automatically.
1889Normally, spaces in the template itself (as opposed to values of
1890the interpolated variables) are not breakable, but they can be
1891made breakable in part of the template by using the `~` keyword
1892(ended with another `~`).
1895$~$This long line may break if the document is rendered
1896with a short line length.$~$
1901A filter transforms the value of a variable or partial. Filters are
1902specified using a slash (`/`) between the variable name (or partial)
1903and the filter name. Example:
1910$for(metadata/pairs)$
1911- $it.key$: $it.value$
1914$employee:name()/uppercase$
1917Filters may be chained:
1920$for(employees/pairs)$
1921$it.key/alpha/uppercase$. $it.name$
1925Some filters take parameters:
1928|----------------------|------------|
1930$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1932|----------------------|------------|
1935Currently the following filters are predefined:
1937- `pairs`: Converts a map or array to an array of maps,
1938 each with `key` and `value` fields. If the original
1939 value was an array, the `key` will be the array index,
1942- `uppercase`: Converts text to uppercase.
1944- `lowercase`: Converts text to lowercase.
1946- `length`: Returns the length of the value: number
1947 of characters for a textual value, number of elements
1950- `reverse`: Reverses a textual value or array,
1951 and has no effect on other values.
1953- `chomp`: Removes trailing newlines (and breakable space).
1955- `nowrap`: Disables line wrapping on breakable spaces.
1957- `alpha`: Converts textual values that can be
1958 read as an integer into lowercase alphabetic
1959 characters `a..z` (mod 26). This can be used to get lettered
1960 enumeration from array indices. To get uppercase
1961 letters, chain with `uppercase`.
1963- `roman`: Converts textual values that can be
1964 read as an integer into lowercase roman numerials.
1965 This can be used to get lettered enumeration from array indices.
1966 To get uppercase roman, chain with `uppercase`.
1968- `left n "leftborder" "rightborder"`: Renders a textual value
1969 in a block of width `n`, aligned to the left, with an optional
1970 left and right border. Has no effect on other values. This
1971 can be used to align material in tables. Widths are positive
1972 integers indicating the number of characters. Borders
1973 are strings inside double quotes; literal `"` and `\` characters
1974 must be backslash-escaped.
1976- `right n "leftborder" "rightborder"`: Renders a textual value
1977 in a block of width `n`, aligned to the right, and has no
1978 effect on other values.
1980- `center n "leftborder" "rightborder"`: Renders a textual
1981 value in a block of width `n`, aligned to the center, and has
1982 no effect on other values.
1987### Metadata variables
1989`title`, `author`, `date`
1990: allow identification of basic aspects of the document. Included
1991 in PDF metadata through LaTeX and ConTeXt. These can be set
1992 through a [pandoc title block][Extension: `pandoc_title_block`],
1993 which allows for multiple authors, or through a
1994 [YAML metadata block][Extension: `yaml_metadata_block`]:
2002 Note that if you just want to set PDF or HTML metadata, without
2003 including a title block in the document itself, you can
2004 set the `title-meta`, `author-meta`, and `date-meta`
2005 variables. (By default these are set automatically, based
2006 on `title`, `author`, and `date`.)
2009: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2013: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2017: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2018 and AsciiDoc metadata; repeat as for `author`, above
2021: document subject, included in ODT, PDF, docx and pptx metadata
2024: document description, included in ODT, docx and pptx metadata. Some
2025 applications show this as `Comments` metadata.
2028: document category, included in docx and pptx metadata
2031any root-level string metadata, not included in ODT, docx
2032or pptx metadata is added as a *custom property*.
2033The following [YAML] metadata block for instance:
2036 title: 'This is the title'
2037 subtitle: "This is the subtitle"
2045 It consists of two paragraphs
2048will include `title`, `author` and `description` as standard document
2049properties and `subtitle` as a custom property when converting to docx,
2052### Language variables
2055: identifies the main language of the document using IETF language
2056 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2057 The [Language subtag lookup] tool can look up or verify these tags.
2058 This affects most formats, and controls hyphenation in PDF output
2059 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2061 Use native pandoc [Divs and Spans] with the `lang` attribute to
2062 switch the language:
2068 Text in the main document language (British English).
2071 > Cette citation est écrite en français canadien.
2074 More text in English. ['Zitat auf Deutsch.']{lang=de}
2077: the base script direction, either `rtl` (right-to-left)
2078 or `ltr` (left-to-right).
2080 For bidirectional documents, native pandoc `span`s and `div`s
2081 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2082 override the base direction in some output formats.
2083 This may not always be necessary if the final renderer
2084 (e.g. the browser, when generating HTML) supports the
2085 [Unicode Bidirectional Algorithm].
2087 When using LaTeX for bidirectional documents, only the `xelatex` engine
2088 is fully supported (use `--pdf-engine=xelatex`).
2090[BCP 47]: https://tools.ietf.org/html/bcp47
2091[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2092[Language subtag lookup]: https://r12a.github.io/app-subtags/
2094### Variables for HTML math
2097: when using [KaTeX](#option--katex), you can render display math equations
2098 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2100### Variables for HTML slides
2102These affect HTML output when [producing slide shows with pandoc].
2104All [reveal.js configuration options] are available as variables.
2105To turn off boolean flags that default to true in reveal.js, use `0`.
2108: base URL for reveal.js documents (defaults to `reveal.js`)
2111: base URL for S5 documents (defaults to `s5/default`)
2114: base URL for Slidy documents (defaults to
2115 `https://www.w3.org/Talks/Tools/Slidy2`)
2118: base URL for Slideous documents (defaults to `slideous`)
2120[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2122### Variables for Beamer slides
2124These variables change the appearance of PDF slides using [`beamer`].
2127: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2128 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2132: produce an article from Beamer slides
2135: add extra beamer option with `\setbeameroption{}`
2138: author affiliations: can be a list when there are multiple authors
2141: logo image for slides
2144: controls navigation symbols (default is `empty` for no navigation
2145 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2148: enables "title pages" for new sections (default is true)
2150`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2154: options for LaTeX beamer themes (a list).
2157: image for title slide
2159### Variables for PowerPoint
2161These variables control the visual aspects of a slide show that
2162are not easily controlled via templates.
2165: font to use for code.
2167### Variables for LaTeX
2169Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2174: make `\paragraph` and `\subparagraph` (fourth- and
2175 fifth-level headings, or fifth- and sixth-level with book
2176 classes) free-standing rather than run-in; requires further
2177 formatting to distinguish from `\subsubsection` (third- or
2178 fourth-level headings). Instead of using this option,
2179 [KOMA-Script] can adjust headings more extensively:
2182 documentclass: scrartcl
2184 \RedeclareSectionCommand[
2185 beforeskip=-10pt plus -2pt minus -1pt,
2186 afterskip=1sp plus -1sp minus 1sp,
2187 font=\normalfont\itshape]{paragraph}
2188 \RedeclareSectionCommand[
2189 beforeskip=-10pt plus -2pt minus -1pt,
2190 afterskip=1sp plus -1sp minus 1sp,
2191 font=\normalfont\scshape,
2192 indent=0pt]{subparagraph}
2196: option for document class, e.g. `oneside`; repeat for multiple options:
2205: document class: usually one of the standard classes, [`article`], [`book`],
2206 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2207 and `scrreprt`, which default to smaller margins; or [`memoir`]
2210: option for [`geometry`] package, e.g. `margin=1in`;
2211 repeat for multiple options:
2221: option for [`hyperref`] package, e.g. `linktoc=all`;
2222 repeat for multiple options:
2228 - pdfpagemode=FullScreen
2232: uses document class settings for indentation (the default LaTeX template
2233 otherwise removes indentation and adds space between paragraphs)
2236: adjusts line spacing using the [`setspace`]
2237 package, e.g. `1.25`, `1.5`
2239`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2240: sets margins if `geometry` is not used (otherwise `geometry`
2244: control `\pagestyle{}`: the default article class
2245 supports `plain` (default), `empty` (no running heads or page numbers),
2246 and `headings` (section titles in running heads)
2249: paper size, e.g. `letter`, `a4`
2252: numbering depth for sections (with `--number-sections` option
2253 or `numbersections` variable)
2258: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2259 default is `T1` (see [LaTeX font encodings guide])
2262: font package for use with `pdflatex`:
2263 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2264 The default is [Latin Modern][`lm`].
2267: options for package used as `fontfamily`; repeat for multiple options.
2268 For example, to use the Libertine font with proportional lowercase
2269 (old-style) figures through the [`libertinus`] package:
2272 fontfamily: libertinus
2279: font size for body text. The standard classes allow 10pt, 11pt, and
2280 12pt. To use another size, set `documentclass` to one of
2281 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2283`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2284: font families for use with `xelatex` or
2285 `lualatex`: take the name of any system font, using the
2286 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2288`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2289: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2290 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2291 choices available through [`fontspec`]; repeat for multiple
2292 options. For example, to use the [TeX Gyre] version of
2293 Palatino with lowercase figures:
2296 mainfont: TeX Gyre Pagella
2299 - Numbers=Proportional
2303: options to pass to the microtype package
2308: add color to link text; automatically enabled if any of
2309 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2311`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2312: color for internal links, external links, citation links, linked
2313 URLs, and links in table of contents, respectively: uses options
2314 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2318: causes links to be printed as footnotes
2323: include list of figures, list of tables
2326: contents of acknowledgments footnote after document title
2329: include table of contents (can also be set using `--toc/--table-of-contents`)
2332: level of section to include in table of contents
2334#### BibLaTeX Bibliographies
2336These variables function when using BibLaTeX for [citation rendering].
2339: list of options for biblatex
2342: bibliography style, when used with `--natbib` and `--biblatex`.
2345: bibliography title, when used with `--natbib` and `--biblatex`.
2348: bibliography to use for resolving references
2351: list of options for natbib
2353[KOMA-Script]: https://ctan.org/pkg/koma-script
2354[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2355[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2356[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2357[`article`]: https://ctan.org/pkg/article
2358[`book`]: https://ctan.org/pkg/book
2359[`libertinus`]: https://ctan.org/pkg/libertinus
2360[`memoir`]: https://ctan.org/pkg/memoir
2361[`report`]: https://ctan.org/pkg/report
2363### Variables for ConTeXt
2365Pandoc uses these variables when [creating a PDF] with ConTeXt.
2368: font size for body text (e.g. `10pt`, `12pt`)
2370`headertext`, `footertext`
2371: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2372 repeat up to four times for different placement
2375: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2376 repeat for multiple options
2379: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2380 repeat for multiple options
2383: options for page margins and text arrangement (see [ConTeXt Layout]);
2384 repeat for multiple options
2386`linkcolor`, `contrastcolor`
2387: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2390: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2393: include list of figures, list of tables
2395`mainfont`, `sansfont`, `monofont`, `mathfont`
2396: font families: take the name of any system font (see [ConTeXt Font Switching])
2398`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2399: sets margins, if `layout` is not used (otherwise `layout`
2403: page number style and location (using [`setuppagenumbering`]);
2404 repeat for multiple options
2407: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2408 repeat for multiple options
2411: adds to the preamble the setup necessary to generate PDF/A of the type
2412 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2413 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2414 block), `1b:2005` will be used as default, for reasons of backwards
2415 compatibility. Using `--variable=pdfa` without specified value is not supported.
2416 To successfully generate PDF/A the required ICC color profiles have to
2417 be available and the content and all included files (such as images)
2418 have to be standard conforming. The ICC profiles and output intent
2419 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2420 See also [ConTeXt PDFA] for more details.
2423: when used in conjunction with `pdfa`, specifies the ICC profile to use
2424 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2425 used as default. May be repeated to include multiple profiles. Note that
2426 the profiles have to be available on the system. They can be obtained
2427 from [ConTeXt ICC Profiles].
2430: when used in conjunction with `pdfa`, specifies the output intent for
2431 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2432 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2435: include table of contents (can also be set using `--toc/--table-of-contents`)
2438: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2441: include all source documents as file attachments in the PDF file
2443[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2444[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2445[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2446[ConTeXt Color]: https://wiki.contextgarden.net/Color
2447[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2448[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2449[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2450[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2451[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2452[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2453[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2455### Variables for `wkhtmltopdf`
2457Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2458The `--css` option also affects the output.
2460`footer-html`, `header-html`
2461: add information to the header and footer
2463`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2464: set the page margins
2467: sets the PDF paper size
2469### Variables for man pages
2472: adjusts text to left (`l`), right (`r`), center (`c`),
2473 or both (`b`) margins
2476: footer in man pages
2479: header in man pages
2482: if `true` (the default), hyphenation will be used
2485: section number in man pages
2490: font family (e.g. `T` or `P`)
2493: paragraph indent (e.g. `2m`)
2496: line height (e.g. `12p`)
2499: point size (e.g. `10p`)
2501### Variables set automatically
2503Pandoc sets these variables automatically in response to [options] or
2504document contents; users can also modify them. These vary depending
2505on the output format, and include the following:
2511: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2512 included in all HTML based formats (dzslides, epub,
2513 html, html4, html5, revealjs, s5, slideous, slidy).
2514 The recognized formats for `date` are: `mm/dd/yyyy`,
2515 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2516 (e.g. either `02 Apr 2018` or `02 April 2018`),
2517 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2518 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2521: contents specified by `-H/--include-in-header` (may have multiple
2525: contents specified by `-B/--include-before-body` (may have
2529: contents specified by `-A/--include-after-body` (may have
2533: JSON representation of all of the document's metadata. Field
2534 values are transformed to the selected output format.
2537: non-null value if `-N/--number-sections` was specified
2539`sourcefile`, `outputfile`
2540: source and destination filenames, as given on the command line.
2541 `sourcefile` can also be a list if input comes from multiple files,
2542 or empty if input is from stdin. You can use the following snippet in
2543 your template to distinguish them:
2553 Similarly, `outputfile` can be `-` if output goes to the terminal.
2555 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2558: working directory from which pandoc is run.
2561: non-null value if `--toc/--table-of-contents` was specified
2564: title of table of contents (works only with EPUB,
2565 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2567[pandoc-templates]: https://github.com/jgm/pandoc-templates
2571The behavior of some of the readers and writers can be adjusted by
2572enabling or disabling various extensions.
2574An extension can be enabled by adding `+EXTENSION`
2575to the format name and disabled by adding `-EXTENSION`. For example,
2576`--from markdown_strict+footnotes` is strict Markdown with footnotes
2577enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2578Markdown without footnotes or pipe tables.
2580The markdown reader and writer make by far the most use of extensions.
2581Extensions only used by them are therefore covered in the
2582section [Pandoc's Markdown] below (See [Markdown variants] for
2583`commonmark` and `gfm`.) In the following, extensions that also work
2584for other formats are covered.
2586Note that markdown extensions added to the `ipynb` format
2587affect Markdown cells in Jupyter notebooks (as do command-line
2588options like `--atx-headers`).
2592#### Extension: `smart` ####
2594Interpret straight quotes as curly quotes, `---` as em-dashes,
2595`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2596inserted after certain abbreviations, such as "Mr."
2598This extension can be enabled/disabled for the following formats:
2601: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2604: `markdown`, `latex`, `context`, `rst`
2606enabled by default in
2607: `markdown`, `latex`, `context` (both input and output)
2609Note: If you are *writing* Markdown, then the `smart` extension
2610has the reverse effect: what would have been curly quotes comes
2613In LaTeX, `smart` means to use the standard TeX ligatures
2614for quotation marks (` `` ` and ` '' ` for double quotes,
2615`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2616en-dash and `---` for em-dash). If `smart` is disabled,
2617then in reading LaTeX pandoc will parse these characters
2618literally. In writing LaTeX, enabling `smart` tells pandoc
2619to use the ligatures when possible; if `smart` is disabled
2620pandoc will use unicode quotation mark and dash characters.
2622## Headings and sections
2624#### Extension: `auto_identifiers` ####
2626A heading without an explicitly specified identifier will be
2627automatically assigned a unique identifier based on the heading text.
2629This extension can be enabled/disabled for the following formats:
2632: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2637enabled by default in
2640The default algorithm used to derive the identifier from the
2643 - Remove all formatting, links, etc.
2644 - Remove all footnotes.
2645 - Remove all non-alphanumeric characters,
2646 except underscores, hyphens, and periods.
2647 - Replace all spaces and newlines with hyphens.
2648 - Convert all alphabetic characters to lowercase.
2649 - Remove everything up to the first letter (identifiers may
2650 not begin with a number or punctuation mark).
2651 - If nothing is left after this, use the identifier `section`.
2656 ------------------------------- ----------------------------
2657 `Heading identifiers in HTML` `heading-identifiers-in-html`
2658 `Maître d'hôtel` `maître-dhôtel`
2659 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2660 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2661 `3. Applications` `applications`
2664These rules should, in most cases, allow one to determine the identifier
2665from the heading text. The exception is when several headings have the
2666same text; in this case, the first will get an identifier as described
2667above; the second will get the same identifier with `-1` appended; the
2668third with `-2`; and so on.
2670(However, a different algorithm is used if
2671`gfm_auto_identifiers` is enabled; see below.)
2673These identifiers are used to provide link targets in the table of
2674contents generated by the `--toc|--table-of-contents` option. They
2675also make it easy to provide links from one section of a document to
2676another. A link to this section, for example, might look like this:
2679 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2681Note, however, that this method of providing links to sections works
2682only in HTML, LaTeX, and ConTeXt formats.
2684If the `--section-divs` option is specified, then each section will
2685be wrapped in a `section` (or a `div`, if `html4` was specified),
2686and the identifier will be attached to the enclosing `<section>`
2687(or `<div>`) tag rather than the heading itself. This allows entire
2688sections to be manipulated using JavaScript or treated differently in
2691#### Extension: `ascii_identifiers` ####
2693Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2694Accents are stripped off of accented Latin letters, and non-Latin
2697#### Extension: `gfm_auto_identifiers` ####
2699Changes the algorithm used by `auto_identifiers` to conform to
2700GitHub's method. Spaces are converted to dashes (`-`),
2701uppercase characters to lowercase characters, and punctuation
2702characters other than `-` and `_` are removed.
2703Emojis are replaced by their names.
2707The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2708[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2709[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2710are described in the section about Pandoc's Markdown.
2712However, they can also be used with HTML input. This is handy for
2713reading web pages formatted using MathJax, for example.
2717The following extensions (especially how they affect Markdown
2718input/output) are also described in more detail in their respective
2719sections of [Pandoc's Markdown].
2721#### Extension: `raw_html` {#raw_html}
2723When converting from HTML, parse elements to raw HTML which are not
2724representable in pandoc's AST.
2725By default, this is disabled for HTML input.
2727#### Extension: `raw_tex` {#raw_tex}
2729Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2731This extension can be enabled/disabled for the following formats
2732(in addition to `markdown`):
2735: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2736 `\eqref` only), `ipynb`
2739: `textile`, `commonmark`
2741Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2742only raw TeX in markdown cells, but data with mime type
2743`text/html` in output cells. Since the `ipynb` reader attempts
2744to preserve the richest possible outputs when several options
2745are given, you will get best results if you disable `raw_html`
2746and `raw_tex` when converting to formats like `docx` which don't
2747allow raw `html` or `tex`.
2749#### Extension: `native_divs` {#native_divs}
2751This extension is enabled by default for HTML input. This means that
2752`div`s are parsed to pandoc native elements. (Alternatively, you
2753can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2755When converting HTML to Markdown, for example, you may want to drop all
2758 pandoc -f html-native_divs-native_spans -t markdown
2760#### Extension: `native_spans` {#native_spans}
2762Analogous to `native_divs` above.
2765## Literate Haskell support
2767#### Extension: `literate_haskell` ####
2769Treat the document as literate Haskell source.
2771This extension can be enabled/disabled for the following formats:
2774: `markdown`, `rst`, `latex`
2777: `markdown`, `rst`, `latex`, `html`
2779If you append `+lhs` (or `+literate_haskell`) to one of the formats
2780above, pandoc will treat the document as literate Haskell source.
2783 - In Markdown input, "bird track" sections will be parsed as Haskell
2784 code rather than block quotations. Text between `\begin{code}`
2785 and `\end{code}` will also be treated as Haskell code. For
2786 ATX-style headings the character '=' will be used instead of '#'.
2788 - In Markdown output, code blocks with classes `haskell` and `literate`
2789 will be rendered using bird tracks, and block quotations will be
2790 indented one space, so they will not be treated as Haskell code.
2791 In addition, headings will be rendered setext-style (with underlines)
2792 rather than ATX-style (with '#' characters). (This is because ghc
2793 treats '#' characters in column 1 as introducing line numbers.)
2795 - In restructured text input, "bird track" sections will be parsed
2798 - In restructured text output, code blocks with class `haskell` will
2799 be rendered using bird tracks.
2801 - In LaTeX input, text in `code` environments will be parsed as
2804 - In LaTeX output, code blocks with class `haskell` will be rendered
2805 inside `code` environments.
2807 - In HTML output, code blocks with class `haskell` will be rendered
2808 with class `literatehaskell` and bird tracks.
2812 pandoc -f markdown+lhs -t html
2814reads literate Haskell source formatted with Markdown conventions and writes
2815ordinary HTML (without bird tracks).
2817 pandoc -f markdown+lhs -t html+lhs
2819writes HTML with the Haskell code in bird tracks, so it can be copied
2820and pasted as literate Haskell source.
2822Note that GHC expects the bird tracks in the first column, so indented
2823literate code blocks (e.g. inside an itemized environment) will not be
2824picked up by the Haskell compiler.
2828#### Extension: `empty_paragraphs` ####
2830Allows empty paragraphs. By default empty paragraphs are
2833This extension can be enabled/disabled for the following formats:
2839: `docx`, `odt`, `opendocument`, `html`
2841#### Extension: `native_numbering` ####
2843Enables native numbering of figures and tables. Enumeration
2846This extension can be enabled/disabled for the following formats:
2849: `odt`, `opendocument`
2851#### Extension: `styles` #### {#ext-styles}
2853When converting from docx, read all docx styles as divs (for
2854paragraph styles) and spans (for character styles) regardless
2855of whether pandoc understands the meaning of these styles.
2856This can be used with [docx custom styles](#custom-styles).
2862#### Extension: `amuse` ####
2864In the `muse` input format, this enables Text::Amuse
2865extensions to Emacs Muse markup.
2867#### Extension: `citations` {#org-citations}
2869Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2872#### Extension: `ntb` ####
2874In the `context` output format this enables the use of [Natural Tables
2875(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2876[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2877Natural tables allow more fine-grained global customization but come
2878at a performance penalty compared to extreme tables.
2883Pandoc understands an extended and slightly revised version of
2884John Gruber's [Markdown] syntax. This document explains the syntax,
2885noting differences from standard Markdown. Except where noted, these
2886differences can be suppressed by using the `markdown_strict` format instead
2887of `markdown`. Extensions can be enabled or disabled to specify the
2888behavior more granularly. They are described in the following. See also
2889[Extensions] above, for extensions that work also on other formats.
2893Markdown is designed to be easy to write, and, even more importantly,
2896> A Markdown-formatted document should be publishable as-is, as plain
2897> text, without looking like it's been marked up with tags or formatting
2899> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2901This principle has guided pandoc's decisions in finding syntax for
2902tables, footnotes, and other extensions.
2904There is, however, one respect in which pandoc's aims are different
2905from the original aims of Markdown. Whereas Markdown was originally
2906designed with HTML generation in mind, pandoc is designed for multiple
2907output formats. Thus, while pandoc allows the embedding of raw HTML,
2908it discourages it, and provides other, non-HTMLish ways of representing
2909important document elements like definition lists, tables, mathematics, and
2914A paragraph is one or more lines of text followed by one or more blank lines.
2915Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2916If you need a hard line break, put two or more spaces at the end of a line.
2918#### Extension: `escaped_line_breaks` ####
2920A backslash followed by a newline is also a hard line break.
2921Note: in multiline and grid table cells, this is the only way
2922to create a hard line break, since trailing spaces in the cells
2927There are two kinds of headings: Setext and ATX.
2929### Setext-style headings ###
2931A setext-style heading is a line of text "underlined" with a row of `=` signs
2932(for a level-one heading) or `-` signs (for a level-two heading):
2940The heading text can contain inline formatting, such as emphasis (see
2941[Inline formatting], below).
2944### ATX-style headings ###
2946An ATX-style heading consists of one to six `#` signs and a line of
2947text, optionally followed by any number of `#` signs. The number of
2948`#` signs at the beginning of the line is the heading level:
2950 ## A level-two heading
2952 ### A level-three heading ###
2954As with setext-style headings, the heading text can contain formatting:
2956 # A level-one heading with a [link](/url) and *emphasis*
2958#### Extension: `blank_before_header` ####
2960Standard Markdown syntax does not require a blank line before a heading.
2961Pandoc does require this (except, of course, at the beginning of the
2962document). The reason for the requirement is that it is all too easy for a
2963`#` to end up at the beginning of a line by accident (perhaps through line
2964wrapping). Consider, for example:
2966 I like several of their flavors of ice cream:
2967 #22, for example, and #5.
2969#### Extension: `space_in_atx_header` ####
2971Many Markdown implementations do not require a space between the
2972opening `#`s of an ATX heading and the heading text, so that
2973`#5 bolt` and `#hashtag` count as headings. With this extension,
2974pandoc does require the space.
2976### Heading identifiers ###
2978See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2980#### Extension: `header_attributes` ####
2982Headings can be assigned attributes using this syntax at the end
2983of the line containing the heading text:
2985 {#identifier .class .class key=value key=value}
2987Thus, for example, the following headings will all be assigned the identifier
2992 ## My heading ## {#foo}
2994 My other heading {#foo}
2997(This syntax is compatible with [PHP Markdown Extra].)
2999Note that although this syntax allows assignment of classes and key/value
3000attributes, writers generally don't use all of this information. Identifiers,
3001classes, and key/value attributes are used in HTML and HTML-based formats such
3002as EPUB and slidy. Identifiers are used for labels and link anchors in the
3003LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3005Headings with the class `unnumbered` will not be numbered, even if
3006`--number-sections` is specified. A single hyphen (`-`) in an attribute
3007context is equivalent to `.unnumbered`, and preferable in non-English
3014 # My heading {.unnumbered}
3016If the `unlisted` class is present in addition to `unnumbered`,
3017the heading will not be included in a table of contents.
3018(Currently this feature is only implemented for certain
3019formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3021#### Extension: `implicit_header_references` ####
3023Pandoc behaves as if reference links have been defined for each heading.
3024So, to link to a heading
3026 # Heading identifiers in HTML
3030 [Heading identifiers in HTML]
3034 [Heading identifiers in HTML][]
3038 [the section on heading identifiers][heading identifiers in
3041instead of giving the identifier explicitly:
3043 [Heading identifiers in HTML](#heading-identifiers-in-html)
3045If there are multiple headings with identical text, the corresponding
3046reference will link to the first one only, and you will need to use explicit
3047links to link to the others, as described above.
3049Like regular reference links, these references are case-insensitive.
3051Explicit link reference definitions always take priority over
3052implicit heading references. So, in the following example, the
3053link will point to `bar`, not to `#foo`:
3063Markdown uses email conventions for quoting blocks of text.
3064A block quotation is one or more paragraphs or other block elements
3065(such as lists or headings), with each line preceded by a `>` character
3066and an optional space. (The `>` need not start at the left margin, but
3067it should not be indented more than three spaces.)
3069 > This is a block quote. This
3070 > paragraph has two lines.
3072 > 1. This is a list inside a block quote.
3075A "lazy" form, which requires the `>` character only on the first
3076line of each block, is also allowed:
3078 > This is a block quote. This
3079 paragraph has two lines.
3081 > 1. This is a list inside a block quote.
3084Among the block elements that can be contained in a block quote are
3085other block quotes. That is, block quotes can be nested:
3087 > This is a block quote.
3089 > > A block quote within a block quote.
3091If the `>` character is followed by an optional space, that space
3092will be considered part of the block quote marker and not part of
3093the indentation of the contents. Thus, to put an indented code
3094block in a block quote, you need five spaces after the `>`:
3098#### Extension: `blank_before_blockquote` ####
3100Standard Markdown syntax does not require a blank line before a block
3101quote. Pandoc does require this (except, of course, at the beginning of the
3102document). The reason for the requirement is that it is all too easy for a
3103`>` to end up at the beginning of a line by accident (perhaps through line
3104wrapping). So, unless the `markdown_strict` format is used, the following does
3105not produce a nested block quote in pandoc:
3107 > This is a block quote.
3111## Verbatim (code) blocks
3113### Indented code blocks ###
3115A block of text indented four spaces (or one tab) is treated as verbatim
3116text: that is, special characters do not trigger special formatting,
3117and all spaces and line breaks are preserved. For example,
3120 moveShip(5 * gravity, DOWN);
3123The initial (four space or one tab) indentation is not considered part
3124of the verbatim text, and is removed in the output.
3126Note: blank lines in the verbatim text need not begin with four spaces.
3129### Fenced code blocks ###
3131#### Extension: `fenced_code_blocks` ####
3133In addition to standard indented code blocks, pandoc supports
3134*fenced* code blocks. These begin with a row of three or more
3135tildes (`~`) and end with a row of tildes that must be at least as long as
3136the starting row. Everything between these lines is treated as code. No
3137indentation is necessary:
3141 moveShip(5 * gravity, DOWN);
3145Like regular code blocks, fenced code blocks must be separated
3146from surrounding text by blank lines.
3148If the code itself contains a row of tildes or backticks, just use a longer
3149row of tildes or backticks at the start and end:
3153 code including tildes
3157#### Extension: `backtick_code_blocks` ####
3159Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3162#### Extension: `fenced_code_attributes` ####
3164Optionally, you may attach attributes to fenced or backtick code block using
3167 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3169 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3170 qsort (filter (>= x) xs)
3171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3173Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3174`startFrom` is an attribute with value `100`. Some output formats can use this
3175information to do syntax highlighting. Currently, the only output formats
3176that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3177highlighting is supported for your output format and language, then the code
3178block above will appear highlighted, with numbered lines. (To see which
3179languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3180the code block above will appear as follows:
3182 <pre id="mycode" class="haskell numberLines" startFrom="100">
3188The `numberLines` (or `number-lines`) class will cause the lines
3189of the code block to be numbered, starting with `1` or the value
3190of the `startFrom` attribute. The `lineAnchors` (or
3191`line-anchors`) class will cause the lines to be clickable
3192anchors in HTML output.
3194A shortcut form can also be used for specifying the language of
3201This is equivalent to:
3207If the `fenced_code_attributes` extension is disabled, but
3208input contains class attribute(s) for the code block, the first
3209class attribute will be printed after the opening fence as a bare
3212To prevent all highlighting, use the `--no-highlight` flag.
3213To set the highlighting style, use `--highlight-style`.
3214For more information on highlighting, see [Syntax highlighting],
3219#### Extension: `line_blocks` ####
3221A line block is a sequence of lines beginning with a vertical bar (`|`)
3222followed by a space. The division into lines will be preserved in
3223the output, as will any leading spaces; otherwise, the lines will
3224be formatted as Markdown. This is useful for verse and addresses:
3226 | The limerick packs laughs anatomical
3227 | In space that is quite economical.
3228 | But the good ones I've seen
3229 | So seldom are clean
3230 | And the clean ones so seldom are comical
3233 | Berkeley, CA 94718
3235The lines can be hard-wrapped if needed, but the continuation
3236line must begin with a space.
3238 | The Right Honorable Most Venerable and Righteous Samuel L.
3241 | Berkeley, CA 94718
3243This syntax is borrowed from [reStructuredText].
3249A bullet list is a list of bulleted list items. A bulleted list
3250item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3257This will produce a "compact" list. If you want a "loose" list, in which
3258each item is formatted as a paragraph, put spaces between the items:
3266The bullets need not be flush with the left margin; they may be
3267indented one, two, or three spaces. The bullet must be followed
3270List items look best if subsequent lines are flush with the first
3271line (after the bullet):
3277But Markdown also allows a "lazy" format:
3283### Block content in list items ###
3285A list item may contain multiple paragraphs and other block-level
3286content. However, subsequent paragraphs must be preceded by a blank line
3287and indented to line up with the first non-space content after
3294 * Second paragraph. With a code block, which must be indented
3299Exception: if the list marker is followed by an indented code
3300block, which must begin 5 spaces after the list marker, then
3301subsequent paragraphs must begin two columns after the last
3302character of the list marker:
3306 continuation paragraph
3308List items may include other lists. In this case the preceding blank
3309line is optional. The nested list must be indented to line up with
3310the first non-space character after the list marker of the
3311containing list item.
3323As noted above, Markdown allows you to write list items "lazily," instead of
3324indenting continuation lines. However, if there are multiple paragraphs or
3325other blocks in a list item, the first line of each must be indented.
3327 + A lazy, lazy, list
3330 + Another one; this looks
3333 Second paragraph of second
3336### Ordered lists ###
3338Ordered lists work just like bulleted lists, except that the items
3339begin with enumerators rather than bullets.
3341In standard Markdown, enumerators are decimal numbers followed
3342by a period and a space. The numbers themselves are ignored, so
3343there is no difference between this list:
3355#### Extension: `fancy_lists` ####
3357Unlike standard Markdown, pandoc allows ordered list items to be marked
3358with uppercase and lowercase letters and roman numerals, in addition to
3359Arabic numerals. List markers may be enclosed in parentheses or followed by a
3360single right-parentheses or period. They must be separated from the
3361text that follows by at least one space, and, if the list marker is a
3362capital letter with a period, by at least two spaces.[^2]
3364[^2]: The point of this rule is to ensure that normal paragraphs
3365 starting with people's initials, like
3367 B. Russell was an English philosopher.
3369 do not get treated as list items.
3371 This rule will not prevent
3375 from being interpreted as a list item. In this case, a backslash
3380The `fancy_lists` extension also allows '`#`' to be used as an
3381ordered list marker in place of a numeral:
3386#### Extension: `startnum` ####
3388Pandoc also pays attention to the type of list marker used, and to the
3389starting number, and both of these are preserved where possible in the
3390output format. Thus, the following yields a list with numbers followed
3391by a single parenthesis, starting with 9, and a sublist with lowercase
3401Pandoc will start a new list each time a different type of list
3402marker is used. So, the following will create three lists:
3409If default list markers are desired, use `#.`:
3415#### Extension: `task_lists` ####
3417Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3419 - [ ] an unchecked task list item
3422### Definition lists ###
3424#### Extension: `definition_lists` ####
3426Pandoc supports definition lists, using the syntax of
3427[PHP Markdown Extra] with some extensions.[^3]
3433 Term 2 with *inline markup*
3437 { some code, part of Definition 2 }
3439 Third paragraph of definition 2.
3441Each term must fit on one line, which may optionally be followed by
3442a blank line, and must be followed by one or more definitions.
3443A definition begins with a colon or tilde, which may be indented one
3446A term may have multiple definitions, and each definition may consist of one or
3447more block elements (paragraph, code block, list, etc.), each indented four
3448spaces or one tab stop. The body of the definition (including the first line,
3449aside from the colon or tilde) should be indented four spaces. However,
3450as with other Markdown lists, you can "lazily" omit indentation except
3451at the beginning of a paragraph or other block element:
3456 with lazy continuation.
3458 Second paragraph of the definition.
3460If you leave space before the definition (as in the example above),
3461the text of the definition will be treated as a paragraph. In some
3462output formats, this will mean greater spacing between term/definition
3463pairs. For a more compact definition list, omit the space before the
3473Note that space between items in a definition list is required.
3474(A variant that loosens this requirement, but disallows "lazy"
3475hard wrapping, can be activated with `compact_definition_lists`: see
3476[Non-pandoc extensions], below.)
3478[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3480### Numbered example lists ###
3482#### Extension: `example_lists` ####
3484The special list marker `@` can be used for sequentially numbered
3485examples. The first list item with a `@` marker will be numbered '1',
3486the next '2', and so on, throughout the document. The numbered examples
3487need not occur in a single list; each new list using `@` will take up
3488where the last stopped. So, for example:
3490 (@) My first example will be numbered (1).
3491 (@) My second example will be numbered (2).
3493 Explanation of examples.
3495 (@) My third example will be numbered (3).
3497Numbered examples can be labeled and referred to elsewhere in the
3500 (@good) This is a good example.
3502 As (@good) illustrates, ...
3504The label can be any string of alphanumeric characters, underscores,
3507Note: continuation paragraphs in example lists must always
3508be indented four spaces, regardless of the length of the
3509list marker. That is, example lists always behave as if the
3510`four_space_rule` extension is set. This is because example
3511labels tend to be long, and indenting content to the
3512first non-space character after the label would be awkward.
3514### Compact and loose lists ###
3516Pandoc behaves differently from `Markdown.pl` on some "edge
3517cases" involving lists. Consider this source:
3527Pandoc transforms this into a "compact list" (with no `<p>` tags around
3528"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3529"Second" and "Third" (but not "First"), because of the blank space
3530around "Third". Pandoc follows a simple rule: if the text is followed by
3531a blank line, it is treated as a paragraph. Since "Second" is followed
3532by a list, and not a blank line, it isn't treated as a paragraph. The
3533fact that the list is followed by a blank line is irrelevant. (Note:
3534Pandoc works this way even when the `markdown_strict` format is specified. This
3535behavior is consistent with the official Markdown syntax description,
3536even though it is different from that of `Markdown.pl`.)
3539### Ending a list ###
3541What if you want to put an indented code block after a list?
3548Trouble! Here pandoc (like other Markdown implementations) will treat
3549`{ my code block }` as the second paragraph of item two, and not as
3552To "cut off" the list after item two, you can insert some non-indented
3553content, like an HTML comment, which won't produce visible output in
3559 <!-- end of list -->
3563You can use the same trick if you want two consecutive lists instead
3578A line containing a row of three or more `*`, `-`, or `_` characters
3579(optionally separated by spaces) produces a horizontal rule:
3588Four kinds of tables may be used. The first three kinds presuppose the use of
3589a fixed-width font, such as Courier. The fourth kind can be used with
3590proportionally spaced fonts, as it does not require lining up columns.
3592#### Extension: `table_captions` ####
3594A caption may optionally be provided with all 4 kinds of tables (as
3595illustrated in the examples below). A caption is a paragraph beginning
3596with the string `Table:` (or just `:`), which will be stripped off.
3597It may appear either before or after the table.
3599#### Extension: `simple_tables` ####
3601Simple tables look like this:
3603 Right Left Center Default
3604 ------- ------ ---------- -------
3609 Table: Demonstration of simple table syntax.
3611The header and table rows must each fit on one line. Column
3612alignments are determined by the position of the header text relative
3613to the dashed line below it:[^4]
3615 - If the dashed line is flush with the header text on the right side
3616 but extends beyond it on the left, the column is right-aligned.
3617 - If the dashed line is flush with the header text on the left side
3618 but extends beyond it on the right, the column is left-aligned.
3619 - If the dashed line extends beyond the header text on both sides,
3620 the column is centered.
3621 - If the dashed line is flush with the header text on both sides,
3622 the default alignment is used (in most cases, this will be left).
3624[^4]: This scheme is due to Michel Fortin, who proposed it on the
3625 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3627The table must end with a blank line, or a line of dashes followed by
3630The column header row may be omitted, provided a dashed line is used
3631to end the table. For example:
3633 ------- ------ ---------- -------
3637 ------- ------ ---------- -------
3639When the header row is omitted, column alignments are determined on the basis
3640of the first line of the table body. So, in the tables above, the columns
3641would be right, left, center, and right aligned, respectively.
3643#### Extension: `multiline_tables` ####
3645Multiline tables allow header and table rows to span multiple lines
3646of text (but cells that span multiple columns or rows of the table are
3647not supported). Here is an example:
3649 -------------------------------------------------------------
3650 Centered Default Right Left
3651 Header Aligned Aligned Aligned
3652 ----------- ------- --------------- -------------------------
3653 First row 12.0 Example of a row that
3654 spans multiple lines.
3656 Second row 5.0 Here's another one. Note
3657 the blank line between
3659 -------------------------------------------------------------
3661 Table: Here's the caption. It, too, may span
3664These work like simple tables, but with the following differences:
3666 - They must begin with a row of dashes, before the header text
3667 (unless the header row is omitted).
3668 - They must end with a row of dashes, then a blank line.
3669 - The rows must be separated by blank lines.
3671In multiline tables, the table parser pays attention to the widths of
3672the columns, and the writers try to reproduce these relative widths in
3673the output. So, if you find that one of the columns is too narrow in the
3674output, try widening it in the Markdown source.
3676The header may be omitted in multiline tables as well as simple tables:
3678 ----------- ------- --------------- -------------------------
3679 First row 12.0 Example of a row that
3680 spans multiple lines.
3682 Second row 5.0 Here's another one. Note
3683 the blank line between
3685 ----------- ------- --------------- -------------------------
3687 : Here's a multiline table without a header.
3689It is possible for a multiline table to have just one row, but the row
3690should be followed by a blank line (and then the row of dashes that ends
3691the table), or the table may be interpreted as a simple table.
3693#### Extension: `grid_tables` ####
3695Grid tables look like this:
3697 : Sample grid table.
3699 +---------------+---------------+--------------------+
3700 | Fruit | Price | Advantages |
3701 +===============+===============+====================+
3702 | Bananas | $1.34 | - built-in wrapper |
3703 | | | - bright color |
3704 +---------------+---------------+--------------------+
3705 | Oranges | $2.10 | - cures scurvy |
3707 +---------------+---------------+--------------------+
3709The row of `=`s separates the header from the table body, and can be
3710omitted for a headerless table. The cells of grid tables may contain
3711arbitrary block elements (multiple paragraphs, code blocks, lists,
3712etc.). Cells that span multiple columns or rows are not
3713supported. Grid tables can be created easily using Emacs' table-mode
3714(`M-x table-insert`).
3716Alignments can be specified as with pipe tables, by putting
3717colons at the boundaries of the separator line after the
3720 +---------------+---------------+--------------------+
3721 | Right | Left | Centered |
3722 +==============:+:==============+:==================:+
3723 | Bananas | $1.34 | built-in wrapper |
3724 +---------------+---------------+--------------------+
3726For headerless tables, the colons go on the top line instead:
3728 +--------------:+:--------------+:------------------:+
3729 | Right | Left | Centered |
3730 +---------------+---------------+--------------------+
3732##### Grid Table Limitations #####
3734Pandoc does not support grid tables with row spans or column spans.
3735This means that neither variable numbers of columns across rows nor
3736variable numbers of rows across columns are supported by Pandoc.
3737All grid tables must have the same number of columns in each row,
3738and the same number of rows in each column. For example, the
3739Docutils [sample grid tables] will not render as expected with
3742[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3745#### Extension: `pipe_tables` ####
3747Pipe tables look like this:
3749 | Right | Left | Default | Center |
3750 |------:|:-----|---------|:------:|
3751 | 12 | 12 | 12 | 12 |
3752 | 123 | 123 | 123 | 123 |
3755 : Demonstration of pipe table syntax.
3757The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3758ending pipe characters are optional, but pipes are required between all
3759columns. The colons indicate column alignment as shown. The header
3760cannot be omitted. To simulate a headerless table, include a header
3763Since the pipes indicate column boundaries, columns need not be vertically
3764aligned, as they are in the above example. So, this is a perfectly
3765legal (though ugly) pipe table:
3773The cells of pipe tables cannot contain block elements like paragraphs
3774and lists, and cannot span multiple lines. If a pipe table contains a
3775row whose printable content is wider than the column width (see
3776`--columns`), then the table will take up the full text width and
3777the cell contents will wrap, with the relative cell widths determined
3778by the number of dashes in the line separating the table header from
3779the table body. (For example `---|-` would make the first column 3/4
3780and the second column 1/4 of the full text width.)
3781On the other hand, if no lines are wider than column width, then
3782cell contents will not be wrapped, and the cells will be sized
3785Note: pandoc also recognizes pipe tables of the following
3786form, as can be produced by Emacs' orgtbl-mode:
3793The difference is that `+` is used instead of `|`. Other orgtbl features
3794are not supported. In particular, to get non-default column alignment,
3795you'll need to add colons as above.
3797[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3801#### Extension: `pandoc_title_block` ####
3803If the file begins with a title block
3806 % author(s) (separated by semicolons)
3809it will be parsed as bibliographic information, not regular text. (It
3810will be used, for example, in the title of standalone LaTeX or HTML
3811output.) The block may contain just a title, a title and an author,
3812or all three elements. If you want to include an author but no
3813title, or a title and a date but no author, you need a blank line:
3822The title may occupy multiple lines, but continuation lines must
3823begin with leading space, thus:
3828If a document has multiple authors, the authors may be put on
3829separate lines with leading space, or separated by semicolons, or
3830both. So, all of the following are equivalent:
3835 % Author One; Author Two
3840The date must fit on one line.
3842All three metadata fields may contain standard inline formatting
3843(italics, links, footnotes, etc.).
3845Title blocks will always be parsed, but they will affect the output only
3846when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3847will appear twice: once in the document head -- this is the title that
3848will appear at the top of the window in a browser -- and once at the
3849beginning of the document body. The title in the document head can have
3850an optional prefix attached (`--title-prefix` or `-T` option). The title
3851in the body appears as an H1 element with class "title", so it can be
3852suppressed or reformatted with CSS. If a title prefix is specified with
3853`-T` and no title block appears in the document, the title prefix will
3854be used by itself as the HTML title.
3856The man page writer extracts a title, man page section number, and
3857other header and footer information from the title line. The title
3858is assumed to be the first word on the title line, which may optionally
3859end with a (single-digit) section number in parentheses. (There should
3860be no space between the title and the parentheses.) Anything after
3861this is assumed to be additional footer and header text. A single pipe
3862character (`|`) should be used to separate the footer text from the header
3867will yield a man page with the title `PANDOC` and section 1.
3869 % PANDOC(1) Pandoc User Manuals
3871will also have "Pandoc User Manuals" in the footer.
3873 % PANDOC(1) Pandoc User Manuals | Version 4.0
3875will also have "Version 4.0" in the header.
3877#### Extension: `yaml_metadata_block` ####
3879A [YAML] metadata block is a valid YAML object, delimited by a line of three
3880hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3881(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3882document, but if it is not at the beginning, it must be preceded by a blank
3883line. (Note that, because of the way pandoc concatenates input files when
3884several are provided, you may also keep the metadata in a separate YAML file
3885and pass it to pandoc as an argument, along with your Markdown files:
3887 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3889Just be sure that the YAML file begins with `---` and ends with `---` or
3890`...`.) Alternatively, you can use the `--metadata-file` option. Using
3891that approach however, you cannot reference content (like footnotes)
3892from the main markdown input document.
3894Metadata will be taken from the fields of the YAML object and added to any
3895existing document metadata. Metadata can contain lists and objects (nested
3896arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3897with names ending in an underscore will be ignored by pandoc. (They may be
3898given a role by external processors.) Field names must not be
3899interpretable as YAML numbers or boolean values (so, for
3900example, `yes`, `True`, and `15` cannot be used as field names).
3902A document may contain multiple metadata blocks. If two
3903metadata blocks attempt to set the same field, the value from
3904the second block will be taken.
3906When pandoc is used with `-t markdown` to create a Markdown document,
3907a YAML metadata block will be produced only if the `-s/--standalone`
3908option is used. All of the metadata will appear in a single block
3909at the beginning of the document.
3911Note that [YAML] escaping rules must be followed. Thus, for example,
3912if a title contains a colon, it must be quoted. The pipe character
3913(`|`) can be used to begin an indented block that will be interpreted
3914literally, without need for escaping. This form is necessary
3915when the field contains blank lines or block-level formatting:
3918 title: 'This is the title: it contains a colon'
3922 keywords: [nothing, nothingness]
3924 This is the abstract.
3926 It consists of two paragraphs.
3929Template variables will be set automatically from the metadata. Thus, for
3930example, in writing HTML, the variable `abstract` will be set to the HTML
3931equivalent of the Markdown in the `abstract` field:
3933 <p>This is the abstract.</p>
3934 <p>It consists of two paragraphs.</p>
3936Variables can contain arbitrary YAML structures, but the template must match
3937this structure. The `author` variable in the default templates expects a
3938simple list or string, but can be changed to support more complicated
3939structures. The following combination, for example, would add an affiliation
3940to the author if one is given:
3943 title: The document title
3946 affiliation: University of Somewhere
3948 affiliation: University of Nowhere
3951To use the structured authors in the example above, you would need a custom
3956 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3962Raw content to include in the document's header may be specified
3963using `header-includes`; however, it is important to mark up
3964this content as raw code for a particular output format, using
3965the [`raw_attribute` extension](#extension-raw_attribute)), or it
3966will be interpreted as markdown. For example:
3971 \let\oldsection\section
3972 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3977#### Extension: `all_symbols_escapable` ####
3979Except inside a code block or inline code, any punctuation or space
3980character preceded by a backslash will be treated literally, even if it
3981would normally indicate formatting. Thus, for example, if one writes
3991 <strong>hello</strong>
3993This rule is easier to remember than standard Markdown's rule,
3994which allows only the following characters to be backslash-escaped:
3998(However, if the `markdown_strict` format is used, the standard Markdown rule
4001A backslash-escaped space is parsed as a nonbreaking space. It will
4002appear in TeX output as `~` and in HTML and XML as `\ ` or
4005A backslash-escaped newline (i.e. a backslash occurring at the end of
4006a line) is parsed as a hard line break. It will appear in TeX output as
4007`\\` and in HTML as `<br />`. This is a nice alternative to
4008Markdown's "invisible" way of indicating hard line breaks using
4009two trailing spaces on a line.
4011Backslash escapes do not work in verbatim contexts.
4017To *emphasize* some text, surround it with `*`s or `_`, like this:
4019 This text is _emphasized with underscores_, and this
4020 is *emphasized with asterisks*.
4022Double `*` or `_` produces **strong emphasis**:
4024 This is **strong emphasis** and __with underscores__.
4026A `*` or `_` character surrounded by spaces, or backslash-escaped,
4027will not trigger emphasis:
4029 This is * not emphasized *, and \*neither is this\*.
4031#### Extension: `intraword_underscores` ####
4033Because `_` is sometimes used inside words and identifiers,
4034pandoc does not interpret a `_` surrounded by alphanumeric
4035characters as an emphasis marker. If you want to emphasize
4036just part of a word, use `*`:
4038 feas*ible*, not feas*able*.
4043#### Extension: `strikeout` ####
4045To strikeout a section of text with a horizontal line, begin and end it
4046with `~~`. Thus, for example,
4048 This ~~is deleted text.~~
4051### Superscripts and subscripts ###
4053#### Extension: `superscript`, `subscript` ####
4055Superscripts may be written by surrounding the superscripted text by `^`
4056characters; subscripts may be written by surrounding the subscripted
4057text by `~` characters. Thus, for example,
4059 H~2~O is a liquid. 2^10^ is 1024.
4061The text between `^...^` or `~...~` may not contain spaces or
4062newlines. If the superscripted or subscripted text contains
4063spaces, these spaces must be escaped with backslashes. (This is
4064to prevent accidental superscripting and subscripting through
4065the ordinary use of `~` and `^`, and also bad interactions with
4066footnotes.) Thus, if you want the letter P with 'a cat' in
4067subscripts, use `P~a\ cat~`, not `P~a cat~`.
4071To make a short span of text verbatim, put it inside backticks:
4073 What is the difference between `>>=` and `>>`?
4075If the verbatim text includes a backtick, use double backticks:
4077 Here is a literal backtick `` ` ``.
4079(The spaces after the opening backticks and before the closing
4080backticks will be ignored.)
4082The general rule is that a verbatim span starts with a string
4083of consecutive backticks (optionally followed by a space)
4084and ends with a string of the same number of backticks (optionally
4085preceded by a space).
4087Note that backslash-escapes (and other Markdown constructs) do not
4088work in verbatim contexts:
4090 This is a backslash followed by an asterisk: `\*`.
4092#### Extension: `inline_code_attributes` ####
4094Attributes can be attached to verbatim text, just as with
4095[fenced code blocks]:
4101To write small caps, use the `smallcaps` class:
4103 [Small caps]{.smallcaps}
4105Or, without the `bracketed_spans` extension:
4107 <span class="smallcaps">Small caps</span>
4109For compatibility with other Markdown flavors, CSS is also supported:
4111 <span style="font-variant:small-caps;">Small caps</span>
4113This will work in all output formats that support small caps.
4118#### Extension: `tex_math_dollars` ####
4120Anything between two `$` characters will be treated as TeX math. The
4121opening `$` must have a non-space character immediately to its right,
4122while the closing `$` must have a non-space character immediately to its
4123left, and must not be followed immediately by a digit. Thus,
4124`$20,000 and $30,000` won't parse as math. If for some reason
4125you need to enclose text in literal `$` characters, backslash-escape
4126them and they won't be treated as math delimiters.
4128TeX math will be printed in all output formats. How it is rendered
4129depends on the output format:
4132 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4133 math) or `\[...\]` (for display math).
4135Markdown, Emacs Org mode, ConTeXt, ZimWiki
4136 ~ It will appear verbatim surrounded by `$...$` (for inline
4137 math) or `$$...$$` (for display math).
4140 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4143 ~ It will be rendered using an [interpreted text role `:math:`].
4146 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4147 surrounded by `latexmath:[$...$]` (for inline math) or
4148 `[latexmath]++++\[...\]+++` (for display math).
4149 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4150 (`$..$` and `\[..\]`) are omitted.
4153 ~ It will be rendered inside a `@math` command.
4155roff man, Jira markup
4156 ~ It will be rendered verbatim without `$`'s.
4159 ~ It will be rendered inside `<math>` tags.
4162 ~ It will be rendered inside `<span class="math">` tags.
4165 ~ It will be rendered, if possible, using Unicode characters,
4166 and will otherwise appear verbatim.
4169 ~ It will be rendered, if possible, using MathML.
4172 ~ If the `--mathml` flag is used, it will be rendered using MathML
4173 in an `inlineequation` or `informalequation` tag. Otherwise it
4174 will be rendered, if possible, using Unicode characters.
4177 ~ It will be rendered using OMML math markup.
4180 ~ If the `--webtex` option is used, formulas are rendered as images
4181 using CodeCogs or other compatible web service, downloaded
4182 and embedded in the e-book. Otherwise, they will appear verbatim.
4184HTML, Slidy, DZSlides, S5, EPUB
4185 ~ The way math is rendered in HTML will depend on the
4186 command-line options selected. Therefore see [Math rendering in HTML]
4189[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4193#### Extension: `raw_html` ####
4195Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4196(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4197literally). (Technically this is not an extension, since standard
4198Markdown allows it, but it has been made an extension so that it can
4199be disabled if desired.)
4201The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4202DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4203output, and suppressed in other formats.
4205For a more explicit way of including raw HTML in a Markdown
4206document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4208In the CommonMark format, if `raw_html` is enabled, superscripts,
4209subscripts, strikeouts and small capitals will be represented as HTML.
4210Otherwise, plain-text fallbacks will be used. Note that even if
4211`raw_html` is disabled, tables will be rendered with HTML syntax if
4212they cannot use pipe syntax.
4214#### Extension: `markdown_in_html_blocks` ####
4216Standard Markdown allows you to include HTML "blocks": blocks
4217of HTML between balanced tags that are separated from the surrounding text
4218with blank lines, and start and end at the left margin. Within
4219these blocks, everything is interpreted as HTML, not Markdown;
4220so (for example), `*` does not signify emphasis.
4222Pandoc behaves this way when the `markdown_strict` format is used; but
4223by default, pandoc interprets material between HTML block tags as Markdown.
4224Thus, for example, pandoc will turn
4229 <td>[a link](http://google.com)</td>
4237 <td><em>one</em></td>
4238 <td><a href="http://google.com">a link</a></td>
4242whereas `Markdown.pl` will preserve it as is.
4244There is one exception to this rule: text between `<script>` and
4245`<style>` tags is not interpreted as Markdown.
4247This departure from standard Markdown should make it easier to mix
4248Markdown with HTML block elements. For example, one can surround
4249a block of Markdown text with `<div>` tags without preventing it
4250from being interpreted as Markdown.
4252#### Extension: `native_divs` ####
4254Use native pandoc `Div` blocks for content inside `<div>` tags.
4255For the most part this should give the same output as
4256`markdown_in_html_blocks`, but it makes it easier to write pandoc
4257filters to manipulate groups of blocks.
4259#### Extension: `native_spans` ####
4261Use native pandoc `Span` blocks for content inside `<span>` tags.
4262For the most part this should give the same output as `raw_html`,
4263but it makes it easier to write pandoc filters to manipulate groups
4266#### Extension: `raw_tex` ####
4268In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4269included in a document. Inline TeX commands will be preserved and passed
4270unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4271LaTeX to include BibTeX citations:
4273 This result was proved in \cite{jones.1967}.
4275Note that in LaTeX environments, like
4277 \begin{tabular}{|l|l|}\hline
4278 Age & Frequency \\ \hline
4281 36--45 & 22 \\ \hline
4284the material between the begin and end tags will be interpreted as raw
4285LaTeX, not as Markdown.
4287For a more explicit and flexible way of including raw TeX in a
4288Markdown document, see the [`raw_attribute`
4289extension][Extension: `raw_attribute`].
4291Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4292Emacs Org mode, and ConTeXt.
4294### Generic raw attribute ###
4296#### Extension: `raw_attribute` ####
4298Inline spans and fenced code blocks with a special
4299kind of attribute will be parsed as raw content with the
4300designated format. For example, the following produces a raw
4307And the following produces a raw `html` inline element:
4309 This is `<a>html</a>`{=html}
4311This can be useful to insert raw xml into `docx` documents, e.g.
4317 <w:br w:type="page"/>
4322The format name should match the target format name (see
4323`-t/--to`, above, for a list, or use `pandoc
4324--list-output-formats`). Use `openxml` for `docx` output,
4325`opendocument` for `odt` output, `html5` for `epub3` output,
4326`html4` for `epub2` output, and `latex`, `beamer`,
4327`ms`, or `html5` for `pdf` output (depending on what you
4328use for `--pdf-engine`).
4330This extension presupposes that the relevant kind of
4331inline code or fenced code block is enabled. Thus, for
4332example, to use a raw attribute with a backtick code block,
4333`backtick_code_blocks` must be enabled.
4335The raw attribute cannot be combined with regular attributes.
4339#### Extension: `latex_macros` ####
4341When this extension is enabled, pandoc will parse LaTeX
4342macro definitions and apply the resulting macros to all LaTeX
4343math and raw LaTeX. So, for example, the following will work in
4344all output formats, not just LaTeX:
4346 \newcommand{\tuple}[1]{\langle #1 \rangle}
4350Note that LaTeX macros will not be applied if they occur
4351inside a raw span or block marked with the
4352[`raw_attribute` extension](#extension-raw_attribute).
4354When `latex_macros` is disabled, the raw LaTeX and math will
4355not have macros applied. This is usually a better approach when
4356you are targeting LaTeX or PDF.
4358Macro definitions in LaTeX will be passed through as raw LaTeX
4359only if `latex_macros` is not enabled. Macro definitions in
4360Markdown source (or other formats allowing `raw_tex`) will
4361be passed through regardless of whether `latex_macros` is
4366Markdown allows links to be specified in several ways.
4368### Automatic links ###
4370If you enclose a URL or email address in pointy brackets, it
4374 <sam@green.eggs.ham>
4378An inline link consists of the link text in square brackets,
4379followed by the URL in parentheses. (Optionally, the URL can
4380be followed by a link title, in quotes.)
4382 This is an [inline link](/url), and here's [one with
4383 a title](http://fsf.org "click here for a good time!").
4385There can be no space between the bracketed part and the parenthesized part.
4386The link text can contain formatting (such as emphasis), but the title cannot.
4388Email addresses in inline links are not autodetected, so they have to be
4389prefixed with `mailto`:
4391 [Write me!](mailto:sam@green.eggs.ham)
4393### Reference links ###
4395An *explicit* reference link has two parts, the link itself and the link
4396definition, which may occur elsewhere in the document (either
4397before or after the link).
4399The link consists of link text in square brackets, followed by a label in
4400square brackets. (There cannot be space between the two unless the
4401`spaced_reference_links` extension is enabled.) The link definition
4402consists of the bracketed label, followed by a colon and a space, followed by
4403the URL, and optionally (after a space) a link title either in quotes or in
4404parentheses. The label must not be parseable as a citation (assuming
4405the `citations` extension is enabled): citations take precedence over
4408Here are some examples:
4410 [my label 1]: /foo/bar.html "My title, optional"
4412 [my label 3]: http://fsf.org (The free software foundation)
4413 [my label 4]: /bar#special 'A title in single quotes'
4415The URL may optionally be surrounded by angle brackets:
4417 [my label 5]: <http://foo.bar.baz>
4419The title may go on the next line:
4421 [my label 3]: http://fsf.org
4422 "The free software foundation"
4424Note that link labels are not case sensitive. So, this will work:
4426 Here is [my link][FOO]
4430In an *implicit* reference link, the second pair of brackets is
4435 [my website]: http://foo.bar.baz
4437Note: In `Markdown.pl` and most other Markdown implementations,
4438reference link definitions cannot occur in nested constructions
4439such as list items or block quotes. Pandoc lifts this arbitrary
4440seeming restriction. So the following is fine in pandoc, though
4441not in most other implementations:
4447#### Extension: `shortcut_reference_links` ####
4449In a *shortcut* reference link, the second pair of brackets may
4454 [my website]: http://foo.bar.baz
4456### Internal links ###
4458To link to another section of the same document, use the automatically
4459generated identifier (see [Heading identifiers]). For example:
4461 See the [Introduction](#introduction).
4465 See the [Introduction].
4467 [Introduction]: #introduction
4469Internal links are currently supported for HTML formats (including
4470HTML slide shows and EPUB), LaTeX, and ConTeXt.
4474A link immediately preceded by a `!` will be treated as an image.
4475The link text will be used as the image's alt text:
4477 
4481 [movie reel]: movie.gif
4483#### Extension: `implicit_figures` ####
4485An image with nonempty alt text, occurring by itself in a
4486paragraph, will be rendered as a figure with a caption. The
4487image's alt text will be used as the caption.
4489 
4491How this is rendered depends on the output format. Some output
4492formats (e.g. RTF) do not yet support figures. In those
4493formats, you'll just get an image in a paragraph by itself, with
4496If you just want a regular inline image, just make sure it is not
4497the only thing in the paragraph. One way to do this is to insert a
4498nonbreaking space after the image:
4500 \
4502Note that in reveal.js slide shows, an image in a paragraph
4503by itself that has the `stretch` class will fill the screen,
4504and the caption and figure tags will be omitted.
4506#### Extension: `link_attributes` ####
4508Attributes can be set on links and images:
4510 An inline {#id .class width=30 height=20px}
4511 and a reference ![image][ref] with attributes.
4513 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4515(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4516and `.class` are used.)
4518For HTML and EPUB, all known HTML5 attributes except `width` and
4519`height` (but including `srcset` and `sizes`) are passed through
4520as is. Unknown attributes are passed through as custom
4521attributes, with `data-` prepended. The other writers ignore
4522attributes that are not specifically supported by their output format.
4524The `width` and `height` attributes on images are treated specially. When
4525used without a unit, the unit is assumed to be pixels. However, any of
4526the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4527and `%`. There must not be any spaces between the number and the unit.
4531{ width=50% }
4534- Dimensions are converted to inches for output in page-based formats like
4535 LaTeX. Dimensions are converted to pixels for output in HTML-like
4536 formats. Use the `--dpi` option to specify the number of pixels per
4537 inch. The default is 96dpi.
4538- The `%` unit is generally relative to some available space.
4539 For example the above example will render to the following.
4540 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4541 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4542 (If you're using a custom template, you need to configure `graphicx`
4543 as in the default template.)
4544 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4545- Some output formats have a notion of a class
4546 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4547 or a unique identifier (LaTeX `\caption`), or both (HTML).
4548- When no `width` or `height` attributes are specified, the fallback
4549 is to look at the image resolution and the dpi metadata embedded in
4554Using the `native_divs` and `native_spans` extensions
4555(see [above][Extension: `native_divs`]), HTML syntax can
4556be used as part of markdown to create native `Div` and `Span`
4557elements in the pandoc AST (as opposed to raw HTML).
4558However, there is also nicer syntax available:
4560#### Extension: `fenced_divs` ####
4562Allow special fenced syntax for native `Div` blocks. A Div
4563starts with a fence containing at least three consecutive
4564colons plus some attributes. The attributes may optionally
4565be followed by another string of consecutive colons.
4566The attribute syntax is exactly as in fenced code blocks (see
4567[Extension: `fenced_code_attributes`]). As with fenced
4568code blocks, one can use either attributes in curly braces
4569or a single unbraced word, which will be treated as a class
4570name. The Div ends with another line containing a string of at
4571least three consecutive colons. The fenced Div should be
4572separated by blank lines from preceding and following blocks.
4576 ::::: {#special .sidebar}
4577 Here is a paragraph.
4582Fenced divs can be nested. Opening fences are distinguished
4583because they *must* have attributes:
4589 This is a warning within a warning.
4593Fences without attributes are always closing fences. Unlike
4594with fenced code blocks, the number of colons in the closing
4595fence need not match the number in the opening fence. However,
4596it can be helpful for visual clarity to use fences of different
4597lengths to distinguish nested divs from their parents.
4600#### Extension: `bracketed_spans` ####
4602A bracketed sequence of inlines, as one would use to begin
4603a link, will be treated as a `Span` with attributes if it is
4604followed immediately by attributes:
4606 [This is *some text*]{.class key="val"}
4610#### Extension: `footnotes` ####
4612Pandoc's Markdown allows footnotes, using the following syntax:
4614 Here is a footnote reference,[^1] and another.[^longnote]
4616 [^1]: Here is the footnote.
4618 [^longnote]: Here's one with multiple blocks.
4620 Subsequent paragraphs are indented to show that they
4621 belong to the previous footnote.
4625 The whole paragraph can be indented, or just the first
4626 line. In this way, multi-paragraph footnotes work like
4627 multi-paragraph list items.
4629 This paragraph won't be part of the note, because it
4632The identifiers in footnote references may not contain spaces, tabs,
4633or newlines. These identifiers are used only to correlate the
4634footnote reference with the note itself; in the output, footnotes
4635will be numbered sequentially.
4637The footnotes themselves need not be placed at the end of the
4638document. They may appear anywhere except inside other block elements
4639(lists, block quotes, tables, etc.). Each footnote should be
4640separated from surrounding content (including other footnotes)
4643#### Extension: `inline_notes` ####
4645Inline footnotes are also allowed (though, unlike regular notes,
4646they cannot contain multiple paragraphs). The syntax is as follows:
4648 Here is an inline note.^[Inlines notes are easier to write, since
4649 you don't have to pick an identifier and move down to type the
4652Inline and regular footnotes may be mixed freely.
4656#### Extension: `citations` ####
4658Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4659citations and a bibliography in a number of styles. Basic usage is
4661 pandoc --filter pandoc-citeproc myinput.txt
4663In order to use this feature, you will need to specify a bibliography file
4664using the `bibliography` metadata field in a YAML metadata section, or
4665`--bibliography` command line argument. You can supply multiple `--bibliography`
4666arguments or set `bibliography` metadata field to YAML array, if you want to
4667use multiple bibliography files. The bibliography may have any of these
4670 Format File extension
4671 ------------ --------------
4684Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4685use `.bibtex` to force BibTeX.
4687Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4688can produce `.json` and `.yaml` files from any of the supported formats.
4690In-field markup: In BibTeX and BibLaTeX databases,
4691pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4692databases, pandoc Markdown; and in CSL JSON databases, an
4693[HTML-like markup][CSL markup specs]:
4701`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4710`<span class="nocase">...</span>`
4711: prevent a phrase from being capitalized as title case
4713`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4714and CSL YAML formats as far as possible.
4716As an alternative to specifying a bibliography file using `--bibliography`
4717or the YAML metadata field `bibliography`, you can include
4718the citation data directly in the `references` field of the
4719document's YAML metadata. The field should contain an array of
4720YAML-encoded references, for example:
4724 - type: article-journal
4736 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4738 title-short: Molecular structure of nucleic acids
4739 container-title: Nature
4743 DOI: 10.1038/171737a0
4744 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4748(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4749of the supported formats.)
4751Citations and references can be formatted using any style supported by the
4752[Citation Style Language], listed in the [Zotero Style Repository].
4753These files are specified using the `--csl` option or the `csl` metadata field.
4754By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4755format. The CSL project provides further information on [finding and editing styles].
4757To make your citations hyperlinks to the corresponding bibliography
4758entries, add `link-citations: true` to your YAML metadata.
4760Citations go inside square brackets and are separated by semicolons.
4761Each citation must have a key, composed of '@' + the citation
4762identifier from the database, and may optionally have a prefix,
4763a locator, and a suffix. The citation key must begin with a letter, digit,
4764or `_`, and may contain alphanumerics, `_`, and internal punctuation
4765characters (`:.#$%&-+?<>~/`). Here are some examples:
4767 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4769 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4771 Blah blah [@smith04; @doe99].
4773`pandoc-citeproc` detects locator terms in the [CSL locale files].
4774Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4775locale, locator terms can be written in either singular or plural forms,
4776as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4777`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4778`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4779`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4780`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4781`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4782locator term is used, "page" is assumed.
4784`pandoc-citeproc` will use heuristics to distinguish the locator
4785from the suffix. In complex cases, the locator can be enclosed
4786in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4788 [@smith{ii, A, D-Z}, with a suffix]
4789 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4791A minus sign (`-`) before the `@` will suppress mention of
4792the author in the citation. This can be useful when the
4793author is already mentioned in the text:
4795 Smith says blah [-@smith04].
4797You can also write an in-text citation, as follows:
4801 @smith04 [p. 33] says blah.
4803If the style calls for a list of works cited, it will be placed
4804in a div with id `refs`, if one exists:
4809Otherwise, it will be placed at the end of the document.
4810Generation of the bibliography can be suppressed by setting
4811`suppress-bibliography: true` in the YAML metadata.
4813If you wish the bibliography to have a section heading, you can
4814set `reference-section-title` in the metadata, or put the heading
4815at the beginning of the div with id `refs` (if you are using it)
4816or at the end of your document:
4822The bibliography will be inserted after this heading. Note that
4823the `unnumbered` class will be added to this heading, so that the
4824section will not be numbered.
4826If you want to include items in the bibliography without actually
4827citing them in the body text, you can define a dummy `nocite` metadata
4828field and put the citations there:
4837In this example, the document will contain a citation for `item3`
4838only, but the bibliography will contain entries for `item1`, `item2`, and
4841It is possible to create a bibliography with all the citations,
4842whether or not they appear in the document, by using a wildcard:
4849For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4850render the bibliography. In order to do so, specify bibliography
4851files as outlined above, and add `--natbib` or `--biblatex`
4852argument to `pandoc` invocation. Bear in mind that bibliography
4853files have to be in respective format (either BibTeX or
4856For more information, see the [pandoc-citeproc man page].
4858[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4859[Chicago Manual of Style]: http://chicagomanualofstyle.org
4860[Citation Style Language]: http://citationstyles.org
4861[Zotero Style Repository]: https://www.zotero.org/styles
4862[finding and editing styles]: https://citationstyles.org/authors/
4863[CSL locale files]: https://github.com/citation-style-language/locales
4864[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4866## Non-pandoc extensions
4868The following Markdown syntax extensions are not enabled by default
4869in pandoc, but may be enabled by adding `+EXTENSION` to the format
4870name, where `EXTENSION` is the name of the extension. Thus, for
4871example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4873#### Extension: `old_dashes` ####
4875Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4876`-` before a numeral is an en-dash, and `--` is an em-dash.
4877This option only has an effect if `smart` is enabled. It is
4878selected automatically for `textile` input.
4880#### Extension: `angle_brackets_escapable` ####
4882Allow `<` and `>` to be backslash-escaped, as they can be in
4883GitHub flavored Markdown but not original Markdown. This is
4884implied by pandoc's default `all_symbols_escapable`.
4886#### Extension: `lists_without_preceding_blankline` ####
4888Allow a list to occur right after a paragraph, with no intervening
4891#### Extension: `four_space_rule` ####
4893Selects the pandoc <= 2.0 behavior for parsing lists, so that
4894four spaces indent are needed for list item continuation
4897#### Extension: `spaced_reference_links` ####
4899Allow whitespace between the two components of a reference link,
4904#### Extension: `hard_line_breaks` ####
4906Causes all newlines within a paragraph to be interpreted as hard line
4907breaks instead of spaces.
4909#### Extension: `ignore_line_breaks` ####
4911Causes newlines within a paragraph to be ignored, rather than being
4912treated as spaces or as hard line breaks. This option is intended for
4913use with East Asian languages where spaces are not used between words,
4914but text is divided into lines for readability.
4916#### Extension: `east_asian_line_breaks` ####
4918Causes newlines within a paragraph to be ignored, rather than
4919being treated as spaces or as hard line breaks, when they occur
4920between two East Asian wide characters. This is a better choice
4921than `ignore_line_breaks` for texts that include a mix of East
4922Asian wide characters and other characters.
4924#### Extension: `emoji` ####
4926Parses textual emojis like `:smile:` as Unicode emoticons.
4928#### Extension: `tex_math_single_backslash` ####
4930Causes anything between `\(` and `\)` to be interpreted as inline
4931TeX math, and anything between `\[` and `\]` to be interpreted
4932as display TeX math. Note: a drawback of this extension is that
4933it precludes escaping `(` and `[`.
4935#### Extension: `tex_math_double_backslash` ####
4937Causes anything between `\\(` and `\\)` to be interpreted as inline
4938TeX math, and anything between `\\[` and `\\]` to be interpreted
4941#### Extension: `markdown_attribute` ####
4943By default, pandoc interprets material inside block-level tags as Markdown.
4944This extension changes the behavior so that Markdown is only parsed
4945inside block-level tags if the tags have the attribute `markdown=1`.
4947#### Extension: `mmd_title_block` ####
4949Enables a [MultiMarkdown] style title block at the top of
4950the document, for example:
4954 Date: September 1, 2008
4955 Comment: This is a sample mmd title block, with
4956 a field spanning multiple lines.
4958See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4959`yaml_metadata_block` is enabled, it will take precedence over
4962#### Extension: `abbreviations` ####
4964Parses PHP Markdown Extra abbreviation keys, like
4966 *[HTML]: Hypertext Markup Language
4968Note that the pandoc document model does not support
4969abbreviations, so if this extension is enabled, abbreviation keys are
4970simply skipped (as opposed to being parsed as paragraphs).
4972#### Extension: `autolink_bare_uris` ####
4974Makes all absolute URIs into links, even when not surrounded by
4975pointy braces `<...>`.
4977#### Extension: `mmd_link_attributes` ####
4979Parses multimarkdown style key-value attributes on link
4980and image references. This extension should not be confused with the
4981[`link_attributes`](#extension-link_attributes) extension.
4983 This is a reference ![image][ref] with multimarkdown attributes.
4985 [ref]: http://path.to/image "Image title" width=20px height=30px
4986 id=myId class="myClass1 myClass2"
4988#### Extension: `mmd_header_identifiers` ####
4990Parses multimarkdown style heading identifiers (in square brackets,
4991after the heading but before any trailing `#`s in an ATX heading).
4993#### Extension: `compact_definition_lists` ####
4995Activates the definition list syntax of pandoc 1.12.x and earlier.
4996This syntax differs from the one described above under [Definition lists]
4999 - No blank line is required between consecutive items of the
5001 - To get a "tight" or "compact" list, omit space between consecutive
5002 items; the space between a term and its definition does not affect
5004 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5005 be indented four spaces.[^6]
5007[^6]: To see why laziness is incompatible with relaxing the requirement
5008 of a blank line between items, consider the following example:
5015 Is this a single list item with two definitions of "bar," the first of
5016 which is lazily wrapped, or two list items? To remove the ambiguity
5017 we must either disallow lazy wrapping or require a blank line between
5020#### Extension: `gutenberg` ####
5022Use [Project Gutenberg] conventions for `plain` output:
5023all-caps for strong emphasis, surround by underscores
5024for regular emphasis, add extra blank space around headings.
5026 [Project Gutenberg]: https://www.gutenberg.org
5030In addition to pandoc's extended Markdown, the following Markdown
5031variants are supported:
5033`markdown_phpextra` (PHP Markdown Extra)
5034: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5035 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5036 `header_attributes`, `link_attributes`, `abbreviations`,
5037 `shortcut_reference_links`, `spaced_reference_links`.
5039`markdown_github` (deprecated GitHub-Flavored Markdown)
5040: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5041 `gfm_auto_identifiers`, `backtick_code_blocks`,
5042 `autolink_bare_uris`, `space_in_atx_header`,
5043 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5044 `shortcut_reference_links`, `angle_brackets_escapable`,
5045 `lists_without_preceding_blankline`.
5047`markdown_mmd` (MultiMarkdown)
5048: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5049 `tex_math_double_backslash`, `intraword_underscores`,
5050 `mmd_title_block`, `footnotes`, `definition_lists`,
5051 `all_symbols_escapable`, `implicit_header_references`,
5052 `auto_identifiers`, `mmd_header_identifiers`,
5053 `shortcut_reference_links`, `implicit_figures`,
5054 `superscript`, `subscript`, `backtick_code_blocks`,
5055 `spaced_reference_links`, `raw_attribute`.
5057`markdown_strict` (Markdown.pl)
5058: `raw_html`, `shortcut_reference_links`,
5059 `spaced_reference_links`.
5061We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5062which is implemented as a set of extensions on `commonmark`).
5064Note, however, that `commonmark` and `gfm` have limited support
5065for extensions. Only those listed below (and `smart`,
5066`raw_tex`, and `hard_line_breaks`) will work. The extensions
5067can, however, all be individually disabled. Also, `raw_tex`
5068only affects `gfm` output, not input.
5070`gfm` (GitHub-Flavored Markdown)
5071: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5072 `gfm_auto_identifiers`, `backtick_code_blocks`,
5073 `autolink_bare_uris`, `space_in_atx_header`,
5074 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5075 `shortcut_reference_links`, `angle_brackets_escapable`,
5076 `lists_without_preceding_blankline`.
5079# Producing slide shows with pandoc
5081You can use pandoc to produce an HTML + JavaScript slide presentation
5082that can be viewed via a web browser. There are five ways to do this,
5083using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5084You can also produce a PDF slide show using LaTeX [`beamer`], or
5085slides shows in Microsoft [PowerPoint] format.
5087Here's the Markdown source for a simple slide show, `habits.txt`:
5114 
5121To produce an HTML/JavaScript slide show, simply type
5123 pandoc -t FORMAT -s habits.txt -o habits.html
5125where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5127For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5128`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5129assumed to be available at the relative path `s5/default` (for S5), `slideous`
5130(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5131`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5132`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5133above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5136With all HTML slide formats, the `--self-contained` option can be used to
5137produce a single file that contains all of the data necessary to display the
5138slide show, including linked scripts, stylesheets, images, and videos.
5140To produce a PDF slide show using beamer, type
5142 pandoc -t beamer habits.txt -o habits.pdf
5144Note that a reveal.js slide show can also be converted to a PDF
5145by printing it to a file from the browser.
5147To produce a Powerpoint slide show, type
5149 pandoc habits.txt -o habits.pptx
5151## Structuring the slide show
5153By default, the *slide level* is the highest heading level in
5154the hierarchy that is followed immediately by content, and not another
5155heading, somewhere in the document. In the example above, level-1 headings
5156are always followed by level-2 headings, which are followed by content,
5157so the slide level is 2. This default can be overridden using
5158the `--slide-level` option.
5160The document is carved up into slides according to the following
5163 * A horizontal rule always starts a new slide.
5165 * A heading at the slide level always starts a new slide.
5167 * Headings *below* the slide level in the hierarchy create
5168 headings *within* a slide.
5170 * Headings *above* the slide level in the hierarchy create
5171 "title slides," which just contain the section title
5172 and help to break the slide show into sections.
5173 Non-slide content under these headings will be included
5174 on the title slide (for HTML slide shows) or in a
5175 subsequent slide with the same title (for beamer).
5177 * A title page is constructed automatically from the document's title
5178 block, if present. (In the case of beamer, this can be disabled
5179 by commenting out some lines in the default template.)
5181These rules are designed to support many different styles of slide show. If
5182you don't care about structuring your slides into sections and subsections,
5183you can just use level-1 headings for all each slide. (In that case, level-1
5184will be the slide level.) But you can also structure the slide show into
5185sections, as in the example above.
5187Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5188layout will be produced, with level-1 headings building horizontally
5189and level-2 headings building vertically. It is not recommended that
5190you use deeper nesting of section levels with reveal.js.
5194By default, these writers produce lists that display "all at once."
5195If you want your lists to display incrementally (one item at a time),
5196use the `-i` option. If you want a particular list to depart from the
5197default, put it in a `div` block with class `incremental` or
5198`nonincremental`. So, for example, using the `fenced div` syntax, the
5199following would be incremental regardless of the document default:
5217While using `incremental` and `nonincremental` divs are the
5218recommended method of setting incremental lists on a per-case basis,
5219an older method is also supported: putting lists inside a blockquote
5220will depart from the document default (that is, it will display
5221incrementally without the `-i` option and all at once with the `-i`
5227Both methods allow incremental and nonincremental lists to be mixed
5228in a single document.
5230Note: Neither the `-i/--incremental` option nor any of the
5231methods described here currently works for PowerPoint output.
5235You can add "pauses" within a slide by including a paragraph containing
5236three dots, separated by spaces:
5238 # Slide with a pause
5240 content before the pause
5244 content after the pause
5246Note: this feature is not yet implemented for PowerPoint output.
5248## Styling the slides
5250You can change the style of HTML slides by putting customized CSS files
5251in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5252or `$DATADIR/slideous` (for Slideous),
5253where `$DATADIR` is the user data directory (see `--data-dir`, above).
5254The originals may be found in pandoc's system data directory (generally
5255`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5256files it does not find in the user data directory.
5258For dzslides, the CSS is included in the HTML file itself, and may
5261All [reveal.js configuration options] can be set through variables.
5262For example, themes can be used by setting the `theme` variable:
5266Or you can specify a custom stylesheet using the `--css` option.
5268To style beamer slides, you can specify a `theme`, `colortheme`,
5269`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5271 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5273Note that heading attributes will turn into slide attributes
5274(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5275to style individual slides. In beamer, the only heading attribute
5276that affects slides is the `allowframebreaks` class, which sets the
5277`allowframebreaks` option, causing multiple slides to be created
5278if the content overfills the frame. This is recommended especially for
5281 # References {.allowframebreaks}
5285Speaker notes are supported in reveal.js and PowerPoint (pptx)
5286output. You can add notes to your Markdown document thus:
5292 - It can contain Markdown
5297To show the notes window in reveal.js, press `s` while viewing the
5298presentation. Speaker notes in PowerPoint will be available, as usual,
5299in handouts and presenter view.
5301Notes are not yet supported for other slide formats, but the notes
5302will not appear on the slides themselves.
5306To put material in side by side columns, you can use a native
5307div container with class `columns`, containing two or more div
5308containers with class `column` and a `width` attribute:
5310 :::::::::::::: {.columns}
5311 ::: {.column width="40%"}
5314 ::: {.column width="60%"}
5319## Frame attributes in beamer
5321Sometimes it is necessary to add the LaTeX `[fragile]` option to
5322a frame in beamer (for example, when using the `minted` environment).
5323This can be forced by adding the `fragile` class to the heading
5324introducing the slide:
5326 # Fragile slide {.fragile}
5328All of the other frame attributes described in Section 8.1 of
5329the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5330`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5331`shrink`, `standout`, `noframenumbering`.
5333## Background in reveal.js and beamer
5335Background images can be added to self-contained reveal.js slideshows and
5336to beamer slideshows.
5338For the same image on every slide, use the configuration
5339option `background-image` either in the YAML metadata block
5340or as a command-line variable. (There are no other options in
5341beamer and the rest of this section concerns reveal.js slideshows.)
5343For reveal.js, you can instead use the reveal.js-native option
5344`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5345and `parallaxBackgroundVertical` the same way and must also set
5346`parallaxBackgroundSize` to have your values take effect.
5348To set an image for a particular reveal.js slide, add
5349`{data-background-image="/path/to/image"}`
5350to the first slide-level heading on the slide (which may even be empty).
5352In reveal.js's overview mode, the parallaxBackgroundImage will show up
5353only on the first slide.
5355Other reveal.js background settings also work on individual slides, including
5356`data-background-size`, `data-background-repeat`, `data-background-color`,
5357`data-transition`, and `data-transition-speed`.
5360documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5363For example in reveal.js:
5368parallaxBackgroundImage: /path/to/my/background_image.png
5373Slide 1 has background_image.png as its background.
5375## {data-background-image="/path/to/special_image.jpg"}
5377Slide 2 has a special image for its background, even though the heading has no content.
5380# Creating EPUBs with pandoc
5384EPUB metadata may be specified using the `--epub-metadata` option, but
5385if the source document is Markdown, it is better to use a [YAML metadata
5386block][Extension: `yaml_metadata_block`]. Here is an example:
5393 text: An investigation of metadata
5401 text: doi:10.234234.234/33
5403 rights: © 2007 John Smith, CC BY-NC
5408The following fields are recognized:
5411 ~ Either a string value or an object with fields `text` and
5412 `scheme`. Valid values for `scheme` are `ISBN-10`,
5413 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5414 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5415 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5418 ~ Either a string value, or an object with fields `file-as` and
5419 `type`, or a list of such objects. Valid values for `type` are
5420 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5423 ~ Either a string value, or an object with fields `role`, `file-as`,
5424 and `text`, or a list of such objects. Valid values for `role` are
5425 [MARC relators], but
5426 pandoc will attempt to translate the human-readable versions
5427 (like "author" and "editor") to the appropriate marc relators.
5430 ~ Same format as `creator`.
5433 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5434 Pandoc will attempt to convert other common date formats.
5436`lang` (or legacy: `language`)
5437 ~ A string value in [BCP 47] format. Pandoc will default to the local
5438 language if nothing is specified.
5441 ~ A string value or a list of such values.
5462 ~ A string value (path to cover image).
5464`css` (or legacy: `stylesheet`)
5465 ~ A string value (path to CSS stylesheet).
5467`page-progression-direction`
5468 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5469 attribute for the [`spine` element].
5472 ~ iBooks-specific metadata, with the following fields:
5474 - `version`: (string)
5475 - `specified-fonts`: `true`|`false` (default `false`)
5476 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5477 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5478 - `binding`: `true`|`false` (default `true`)
5479 - `scroll-axis`: `vertical`|`horizontal`|`default`
5481[MARC relators]: http://loc.gov/marc/relators/relaterm.html
5482[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5484## The `epub:type` attribute
5486For `epub3` output, you can mark up the heading that corresponds to an EPUB
5487chapter using the [`epub:type` attribute][epub-type]. For example, to set
5488the attribute to the value `prologue`, use this markdown:
5490 # My chapter {epub:type=prologue}
5492Which will result in:
5494 <body epub:type="frontmatter">
5495 <section epub:type="prologue">
5498Pandoc will output `<body epub:type="bodymatter">`, unless
5499you use one of the following values, in which case either
5500`frontmatter` or `backmatter` will be output.
5502`epub:type` of first section `epub:type` of body
5503---------------------------- ------------------
5506acknowledgments frontmatter
5507copyright-page frontmatter
5508dedication frontmatter
5512contributors frontmatter
5513other-credits frontmatter
5515revision-history frontmatter
5516titlepage frontmatter
5517halftitlepage frontmatter
5518seriespage frontmatter
5521seriespage frontmatter
5522titlepage frontmatter
5525bibliography backmatter
5528[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5532By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5533`<video>` or `<source>` element present in the generated EPUB,
5534and include it in the EPUB container, yielding a completely
5535self-contained EPUB. If you want to link to external media resources
5536instead, use raw HTML in your source and add `data-external="1"` to the tag
5537with the `src` attribute. For example:
5539 <audio controls="1">
5540 <source src="http://example.com/music/toccata.mp3"
5541 data-external="1" type="audio/mpeg">
5545# Creating Jupyter notebooks with pandoc
5547When creating a [Jupyter notebook], pandoc will try to infer the
5548notebook structure. Code blocks with the class `code` will be
5549taken as code cells, and intervening content will be taken as
5550Markdown cells. Attachments will automatically be created for
5551images in Markdown cells. Metadata will be taken from the
5552`jupyter` metadata field. For example:
5561 display_name: Python 2
5568 file_extension: ".py"
5569 mimetype: "text/x-python"
5571 nbconvert_exporter: "python"
5572 pygments_lexer: "ipython2"
5578**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5579bibendum felis dictum sodales.
5588from IPython.display import HTML
5591console.log("hello");
5599This image  will be
5600included as a cell attachment.
5603If you want to add cell attributes, group cells differently, or
5604add output to code cells, then you need to include divs to
5605indicate the structure. You can use either [fenced
5606divs][Extension: `fenced_divs`] or [native divs][Extension:
5607`native_divs`] for this. Here is an example:
5610:::::: {.cell .markdown}
5613**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5614bibendum felis dictum sodales.
5617:::::: {.cell .code execution_count=1}
5622::: {.output .stream .stdout}
5629:::::: {.cell .code execution_count=2}
5631from IPython.display import HTML
5634console.log("hello");
5640::: {.output .execute_result execution_count=2}
5643console.log("hello");
5652If you include raw HTML or TeX in an output cell, use the
5653[raw attribute][Extension: `fenced_attribute`], as shown
5654in the last cell of the example above. Although pandoc can
5655process "bare" raw HTML and TeX, the result is often
5656interspersed raw elements and normal textual elements, and
5657in an output cell pandoc expects a single, connected raw
5658block. To avoid using raw HTML or TeX except when
5659marked explicitly using raw attributes, we recommend
5660specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5661translating between Markdown and ipynb notebooks.
5663Note that options and extensions that affect reading and
5664writing of Markdown will also affect Markdown cells in ipynb
5665notebooks. For example, `--wrap=preserve` will preserve
5666soft line breaks in Markdown cells; `--atx-headers` will
5667cause ATX-style headings to be used; and `--preserve-tabs` will
5668prevent tabs from being turned to spaces.
5670# Syntax highlighting
5672Pandoc will automatically highlight syntax in [fenced code blocks] that
5673are marked with a language name. The Haskell library [skylighting] is
5674used for highlighting. Currently highlighting is supported only for
5675HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5676that pandoc will recognize, type `pandoc --list-highlight-languages`.
5678The color scheme can be selected using the `--highlight-style` option.
5679The default color scheme is `pygments`, which imitates the default color
5680scheme used by the Python library pygments (though pygments is not actually
5681used to do the highlighting). To see a list of highlight styles,
5682type `pandoc --list-highlight-styles`.
5684If you are not satisfied with the predefined styles, you can
5685use `--print-highlight-style` to generate a JSON `.theme` file which
5686can be modified and used as the argument to `--highlight-style`. To
5687get a JSON version of the `pygments` style, for example:
5689 pandoc --print-highlight-style pygments > my.theme
5691Then edit `my.theme` and use it like this:
5693 pandoc --highlight-style my.theme
5695If you are not satisfied with the built-in highlighting, or you
5696want highlight a language that isn't supported, you can use the
5697`--syntax-definition` option to load a [KDE-style XML syntax definition
5698file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5699Before writing your own, have a look at KDE's [repository of syntax
5700definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5702To disable highlighting, use the `--no-highlight` option.
5704[skylighting]: https://github.com/jgm/skylighting
5708Custom styles can be used in the docx and ICML formats.
5712By default, pandoc's docx and ICML output applies a predefined set of styles
5713for blocks such as paragraphs and block quotes, and uses largely default
5714formatting (italics, bold) for inlines. This will work for most
5715purposes, especially alongside a `reference.docx` file. However, if you
5716need to apply your own styles to blocks, or match a preexisting set of
5717styles, pandoc allows you to define custom styles for blocks and text
5718using `div`s and `span`s, respectively.
5720If you define a `div` or `span` with the attribute `custom-style`,
5721pandoc will apply your specified style to the contained elements (with
5722the exception of elements whose function depends on a style, like
5723headings, code blocks, block quotes, or links). So, for example, using
5724the `bracketed_spans` syntax,
5726 [Get out]{custom-style="Emphatically"}, he said.
5728would produce a docx file with "Get out" styled with character
5729style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5731 Dickinson starts the poem simply:
5733 ::: {custom-style="Poetry"}
5734 | A Bird came down the Walk---
5735 | He did not know I saw---
5738would style the two contained lines with the `Poetry` paragraph style.
5740For docx output, styles will be defined in the output file as inheriting
5741from normal text, if the styles are not yet in your reference.docx.
5742If they are already defined, pandoc will not alter the definition.
5744This feature allows for greatest customization in conjunction with
5745[pandoc filters]. If you want all paragraphs after block quotes to be
5746indented, you can write a filter to apply the styles necessary. If you
5747want all italics to be transformed to the `Emphasis` character style
5748(perhaps to change their color), you can write a filter which will
5749transform all italicized inlines to inlines within an `Emphasis`
5752For docx output, you don't need to enable any extensions for
5753custom styles to work.
5755[pandoc filters]: http://pandoc.org/filters.html
5759The docx reader, by default, only reads those styles that it can
5760convert into pandoc elements, either by direct conversion or
5761interpreting the derivation of the input document's styles.
5763By enabling the [`styles` extension](#ext-styles) in the docx reader
5764(`-f docx+styles`), you can produce output that maintains the styles
5765of the input document, using the `custom-style` class. Paragraph
5766styles are interpreted as divs, while character styles are interpreted
5769For example, using the `custom-style-reference.docx` file in the test
5770directory, we have the following different outputs:
5772Without the `+styles` extension:
5774 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5777 This is text with an *emphasized* text style. And this is text with a
5778 **strengthened** text style.
5780 > Here is a styled paragraph that inherits from Block Text.
5782And with the extension:
5784 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5786 ::: {custom-style="First Paragraph"}
5790 ::: {custom-style="Body Text"}
5791 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5792 And this is text with a [strengthened]{custom-style="Strengthened"}
5796 ::: {custom-style="My Block Style"}
5797 > Here is a styled paragraph that inherits from Block Text.
5800With these custom styles, you can use your input document as a
5801reference-doc while creating docx output (see below), and maintain the
5802same styles in your input and output files.
5806Pandoc can be extended with custom writers written in [lua]. (Pandoc
5807includes a lua interpreter, so lua need not be installed separately.)
5809To use a custom writer, simply specify the path to the lua script
5810in place of the output format. For example:
5812 pandoc -t data/sample.lua
5814Creating a custom writer requires writing a lua function for each
5815possible element in a pandoc document. To get a documented example
5816which you can modify according to your needs, do
5818 pandoc --print-default-data-file sample.lua
5820Note that custom writers have no default template. If you want
5821to use `--standalone` with a custom writer, you will need to
5822specify a template manually using `--template` or add a new
5823default template with the name
5824`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5825subdirectory of your user data directory (see [Templates]).
5827[lua]: http://www.lua.org
5831If you use pandoc to convert user-contributed content in a web
5832application, here are some things to keep in mind:
58341. Although pandoc itself will not create or modify any files other
5835 than those you explicitly ask it create (with the exception
5836 of temporary files used in producing PDFs), a filter or custom
5837 writer could in principle do anything on your file system. Please
5838 audit filters and custom writers very carefully before using them.
58402. If your application uses pandoc as a Haskell library (rather than
5841 shelling out to the executable), it is possible to use it in a mode
5842 that fully isolates pandoc from your file system, by running the
5843 pandoc operations in the `PandocPure` monad. See the document
5844 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
58473. Pandoc's parsers can exhibit pathological performance on some
5848 corner cases. It is wise to put any pandoc operations under
5849 a timeout, to avoid DOS attacks that exploit these issues.
5850 If you are using the pandoc executable, you can add the
5851 command line options `+RTS -M512M -RTS` (for example) to limit
5852 the heap size to 512MB.
58544. The HTML generated by pandoc is not guaranteed to be safe.
5855 If `raw_html` is enabled for the Markdown input, users can
5856 inject arbitrary HTML. Even if `raw_html` is disabled,
5857 users can include dangerous content in attributes for
5858 headings, spans, and code blocks. To be safe, you should
5859 run all the generated HTML through an HTML sanitizer.
5863Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5864under the [GPL], version 2 or greater. This software carries no
5865warranty of any kind. (See COPYRIGHT for full copyright and
5866warranty notices.) For a full list of contributors, see the file
5867AUTHORS.md in the pandoc source code.
5869[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5870[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