8`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.
46If no *input-files* are specified, input is read from *stdin*.
47Output goes to *stdout* by default. For output to a file,
50 pandoc -o output.html input.txt
52By default, pandoc produces a document fragment. To produce a standalone
53document (e.g. a valid HTML file including `<head>` and `<body>`),
54use the `-s` or `--standalone` flag:
56 pandoc -s -o output.html input.txt
58For more information on how standalone documents are produced, see
61If multiple input files are given, `pandoc` will concatenate them all (with
62blank lines between them) before parsing. (Use `--file-scope` to parse files
68The format of the input and output can be specified explicitly using
69command-line options. The input format can be specified using the
70`-f/--from` option, the output format using the `-t/--to` option.
71Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
73 pandoc -f markdown -t latex hello.txt
75To convert `hello.html` from HTML to Markdown:
77 pandoc -f html -t markdown hello.html
79Supported input and output formats are listed below under [Options]
80(see `-f` for input formats and `-t` for output formats). You
81can also use `pandoc --list-input-formats` and
82`pandoc --list-output-formats` to print lists of supported
85If the input or output format is not specified explicitly, `pandoc`
86will attempt to guess it from the extensions of the filenames.
89 pandoc -o hello.tex hello.txt
91will convert `hello.txt` from Markdown to LaTeX. If no output file
92is specified (so that output goes to *stdout*), or if the output file's
93extension is unknown, the output format will default to HTML.
94If no input file is specified (so that input comes from *stdin*), or
95if the input files' extensions are unknown, the input format will
96be assumed to be Markdown.
101Pandoc uses the UTF-8 character encoding for both input and output.
102If your local character encoding is not UTF-8, you
103should pipe input and output through [`iconv`]:
105 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
107Note that in some output formats (such as HTML, LaTeX, ConTeXt,
108RTF, OPML, DocBook, and Texinfo), information about
109the character encoding is included in the document header, which
110will only be included if you use the `-s/--standalone` option.
112[`iconv`]: http://www.gnu.org/software/libiconv/
117To produce a PDF, specify an output file with a `.pdf` extension:
119 pandoc test.txt -o test.pdf
121By default, pandoc will use LaTeX to create the PDF, which requires
122that a LaTeX engine be installed (see `--pdf-engine` below).
124Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126[`weasyprint`] or [`prince`].
127To do this, specify an output file with a `.pdf` extension, as before,
128but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
131PDF output uses [variables for LaTeX] (with a LaTeX engine);
132[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
133(an HTML/CSS-to-PDF engine; `--css` also affects the output).
135To debug the PDF creation, it can be useful to look at the intermediate
136representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
137to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
139When using LaTeX, the following packages need to be available
140(they are included with all recent versions of [TeX Live]):
141[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
142[`ifxetex`], [`ifluatex`], [`listings`] (if the
143`--listings` option is used), [`fancyvrb`], [`longtable`],
144[`booktabs`], [`graphicx`] and [`grffile`] (if the document
145contains images), [`hyperref`], [`xcolor`],
146[`ulem`], [`geometry`] (with the `geometry` variable set),
147[`setspace`] (with `linestretch`), and
148[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
149the PDF engine requires [`fontspec`]. `xelatex` uses
150[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
151`dir` variable set). If the `mathspec` variable is set,
152`xelatex` will use [`mathspec`] instead of [`unicode-math`].
153The [`upquote`] and [`microtype`] packages are used if
154available, and [`csquotes`] will be used for [typography]
155if `\usepackage{csquotes}` is present in the template or
156included via `/H/--include-in-header`. The [`natbib`],
157[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
158be used for [citation rendering]. The following packages
159will be used to improve output quality if present, but
160pandoc does not require them to be present:
161[`upquote`] (for straight quotes in verbatim environments),
162[`microtype`] (for better spacing adjustments),
163[`parskip`] (for better inter-paragraph spaces),
164[`xurl`] (for better line breaks in URLs),
165[`bookmark`] (for better PDF bookmarks),
166and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
168[TeX Live]: http://www.tug.org/texlive/
169[`amsfonts`]: https://ctan.org/pkg/amsfonts
170[`amsmath`]: https://ctan.org/pkg/amsmath
171[`babel`]: https://ctan.org/pkg/babel
172[`biber`]: https://ctan.org/pkg/biber
173[`biblatex`]: https://ctan.org/pkg/biblatex
174[`bibtex`]: https://ctan.org/pkg/bibtex
175[`bidi`]: https://ctan.org/pkg/bidi
176[`bookmark`]: https://ctan.org/pkg/bookmark
177[`booktabs`]: https://ctan.org/pkg/booktabs
178[`csquotes`]: https://ctan.org/pkg/csquotes
179[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
180[`fontspec`]: https://ctan.org/pkg/fontspec
181[`footnote`]: https://ctan.org/pkg/footnote
182[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
183[`geometry`]: https://ctan.org/pkg/geometry
184[`graphicx`]: https://ctan.org/pkg/graphicx
185[`grffile`]: https://ctan.org/pkg/grffile
186[`hyperref`]: https://ctan.org/pkg/hyperref
187[`ifluatex`]: https://ctan.org/pkg/ifluatex
188[`ifxetex`]: https://ctan.org/pkg/ifxetex
189[`listings`]: https://ctan.org/pkg/listings
190[`lm`]: https://ctan.org/pkg/lm
191[`longtable`]: https://ctan.org/pkg/longtable
192[`mathspec`]: https://ctan.org/pkg/mathspec
193[`microtype`]: https://ctan.org/pkg/microtype
194[`natbib`]: https://ctan.org/pkg/natbib
195[`parskip`]: https://ctan.org/pkg/parskip
196[`polyglossia`]: https://ctan.org/pkg/polyglossia
197[`prince`]: https://www.princexml.com/
198[`setspace`]: https://ctan.org/pkg/setspace
199[`ulem`]: https://ctan.org/pkg/ulem
200[`unicode-math`]: https://ctan.org/pkg/unicode-math
201[`upquote`]: https://ctan.org/pkg/upquote
202[`weasyprint`]: http://weasyprint.org
203[`wkhtmltopdf`]: https://wkhtmltopdf.org
204[`xcolor`]: https://ctan.org/pkg/xcolor
205[`xecjk`]: https://ctan.org/pkg/xecjk
206[`xurl`]: https://ctan.org/pkg/xurl
213Instead of an input file, an absolute URI may be given. In this case
214pandoc will fetch the content using HTTP:
216 pandoc -f html -t markdown http://www.fsf.org
218It is possible to supply a custom User-Agent string or other
219header when requesting a document from a URL:
221 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
227General options {.options}
230`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
232: Specify input format. *FORMAT* can be:
235 - `commonmark` ([CommonMark] Markdown)
236 - `creole` ([Creole 1.0])
237 - `docbook` ([DocBook])
238 - `docx` ([Word docx])
239 - `dokuwiki` ([DokuWiki markup])
241 - `fb2` ([FictionBook2] e-book)
242 - `gfm` ([GitHub-Flavored Markdown]),
243 or the deprecated and less accurate `markdown_github`;
244 use [`markdown_github`](#markdown-variants) only
245 if you need extensions not supported in [`gfm`](#markdown-variants).
246 - `haddock` ([Haddock markup])
248 - `ipynb` ([Jupyter notebook])
249 - `jats` ([JATS] XML)
250 - `json` (JSON version of native AST)
252 - `markdown` ([Pandoc's Markdown])
253 - `markdown_mmd` ([MultiMarkdown])
254 - `markdown_phpextra` ([PHP Markdown Extra])
255 - `markdown_strict` (original unextended [Markdown])
256 - `mediawiki` ([MediaWiki markup])
259 - `native` (native Haskell)
262 - `org` ([Emacs Org mode])
263 - `rst` ([reStructuredText])
265 - `textile` ([Textile])
266 - `tikiwiki` ([TikiWiki markup])
267 - `twiki` ([TWiki markup])
268 - `vimwiki` ([Vimwiki])
271 Extensions can be individually enabled or disabled by
272 appending `+EXTENSION` or `-EXTENSION` to the format name.
273 See [Extensions] below, for a list of extensions and
274 their names. See `--list-input-formats` and `--list-extensions`,
277`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
279: Specify output format. *FORMAT* can be:
281 ::: {#output-formats}
282 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283 - `beamer` ([LaTeX beamer][`beamer`] slide show)
284 - `commonmark` ([CommonMark] Markdown)
285 - `context` ([ConTeXt])
286 - `docbook` or `docbook4` ([DocBook] 4)
287 - `docbook5` (DocBook 5)
288 - `docx` ([Word docx])
289 - `dokuwiki` ([DokuWiki markup])
290 - `epub` or `epub3` ([EPUB] v3 book)
292 - `fb2` ([FictionBook2] e-book)
293 - `gfm` ([GitHub-Flavored Markdown]),
294 or the deprecated and less accurate `markdown_github`;
295 use [`markdown_github`](#markdown-variants) only
296 if you need extensions not supported in [`gfm`](#markdown-variants).
297 - `haddock` ([Haddock markup])
298 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
299 - `html4` ([XHTML] 1.0 Transitional)
300 - `icml` ([InDesign ICML])
301 - `ipynb` ([Jupyter notebook])
302 - `jats` ([JATS] XML)
303 - `json` (JSON version of native AST)
306 - `markdown` ([Pandoc's Markdown])
307 - `markdown_mmd` ([MultiMarkdown])
308 - `markdown_phpextra` ([PHP Markdown Extra])
309 - `markdown_strict` (original unextended [Markdown])
310 - `mediawiki` ([MediaWiki markup])
313 - `native` (native Haskell),
314 - `odt` ([OpenOffice text document][ODT])
316 - `opendocument` ([OpenDocument])
317 - `org` ([Emacs Org mode])
318 - `plain` (plain text),
319 - `pptx` ([PowerPoint] slide show)
320 - `rst` ([reStructuredText])
321 - `rtf` ([Rich Text Format])
322 - `texinfo` ([GNU Texinfo])
323 - `textile` ([Textile])
324 - `slideous` ([Slideous] HTML and JavaScript slide show)
325 - `slidy` ([Slidy] HTML and JavaScript slide show)
326 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
327 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
328 - `s5` ([S5] HTML and JavaScript slide show)
329 - `tei` ([TEI Simple])
330 - `xwiki` ([XWiki markup])
331 - `zimwiki` ([ZimWiki markup])
332 - the path of a custom lua writer, see [Custom writers] below
335 Note that `odt`, `docx`, and `epub` output will not be directed
336 to *stdout* unless forced with `-o -`.
338 Extensions can be individually enabled or
339 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
340 name. See [Extensions] below, for a list of extensions and their
341 names. See `--list-output-formats` and `--list-extensions`, below.
343`-o` *FILE*, `--output=`*FILE*
345: Write output to *FILE* instead of *stdout*. If *FILE* is
346 `-`, output will go to *stdout*, even if a non-textual format
347 (`docx`, `odt`, `epub2`, `epub3`) is specified.
349`--data-dir=`*DIRECTORY*
351: Specify the user data directory to search for pandoc data files.
352 If this option is not specified, the default user data directory
353 will be used. On \*nix and macOS systems this will be the `pandoc`
354 subdirectory of the XDG data directory (by default,
355 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
356 environment variable). If that directory does not exist,
357 `$HOME/.pandoc` will be used (for backwards compatibility).
358 In Windows the default user data directory is
359 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
360 You can find the default user data directory on your system by
361 looking at the output of `pandoc --version`.
362 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
363 `slidy`, `slideous`, or `s5` directory
364 placed in this directory will override pandoc's normal defaults.
368: Generate a bash completion script. To enable bash completion
369 with pandoc, add this to your `.bashrc`:
371 eval "$(pandoc --bash-completion)"
375: Give verbose debugging output. Currently this only has an effect
380: Suppress warning messages.
384: Exit with error status if there are any warnings.
388: Write log messages in machine-readable JSON format to
389 *FILE*. All messages above DEBUG level will be written,
390 regardless of verbosity settings (`--verbose`, `--quiet`).
392`--list-input-formats`
394: List supported input formats, one per line.
396`--list-output-formats`
398: List supported output formats, one per line.
400`--list-extensions`[`=`*FORMAT*]
402: List supported extensions, one per line, preceded
403 by a `+` or `-` indicating whether it is enabled by default
404 in *FORMAT*. If *FORMAT* is not specified, defaults for
405 pandoc's Markdown are given.
407`--list-highlight-languages`
409: List supported languages for syntax highlighting, one per
412`--list-highlight-styles`
414: List supported styles for syntax highlighting, one per line.
415 See `--highlight-style`.
425[Markdown]: http://daringfireball.net/projects/markdown/
426[CommonMark]: http://commonmark.org
427[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
428[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
429[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
430[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
431[S5]: http://meyerweb.com/eric/tools/s5/
432[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
433[Slideous]: http://goessner.net/articles/slideous/
434[HTML]: http://www.w3.org/html/
435[HTML5]: http://www.w3.org/TR/html5/
436[polyglot markup]: https://www.w3.org/TR/html-polyglot/
437[XHTML]: http://www.w3.org/TR/xhtml1/
438[LaTeX]: http://latex-project.org
439[`beamer`]: https://ctan.org/pkg/beamer
440[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
441[ConTeXt]: http://www.contextgarden.net/
442[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
443[DocBook]: http://docbook.org
444[JATS]: https://jats.nlm.nih.gov
445[txt2tags]: http://txt2tags.org
446[EPUB]: http://idpf.org/epub
447[OPML]: http://dev.opml.org/spec2.html
448[OpenDocument]: http://opendocument.xml.org
449[ODT]: http://en.wikipedia.org/wiki/OpenDocument
450[Textile]: http://redcloth.org/textile
451[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
452[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
453[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
454[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
455[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
456[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
457[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
458[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
459[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
460[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
461[Haskell]: https://www.haskell.org
462[GNU Texinfo]: http://www.gnu.org/software/texinfo/
463[Emacs Org mode]: http://orgmode.org
464[AsciiDoc]: http://www.methods.co.nz/asciidoc/
465[AsciiDoctor]: https://asciidoctor.org/
466[DZSlides]: http://paulrouget.com/dzslides/
467[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
468[PDF]: https://www.adobe.com/pdf/
469[reveal.js]: http://lab.hakim.se/reveal-js/
470[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
471[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
472[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
473[TEI Simple]: https://github.com/TEIC/TEI-Simple
474[Muse]: https://amusewiki.org/library/manual
475[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
476[Vimwiki]: https://vimwiki.github.io
478Reader options {.options}
481`--base-header-level=`*NUMBER*
483: Specify the base level for headings (defaults to 1).
485`--strip-empty-paragraphs`
487: *Deprecated. Use the `+empty_paragraphs` extension instead.*
488 Ignore paragraphs with no content. This option is useful
489 for converting word processing documents where users have
490 used empty paragraphs to create inter-paragraph space.
492`--indented-code-classes=`*CLASSES*
494: Specify classes to use for indented code blocks--for example,
495 `perl,numberLines` or `haskell`. Multiple classes may be separated
498`--default-image-extension=`*EXTENSION*
500: Specify a default extension to use when image paths/URLs have no
501 extension. This allows you to use the same source for formats that
502 require different kinds of images. Currently this option only affects
503 the Markdown and LaTeX readers.
507: Parse each file individually before combining for multifile
508 documents. This will allow footnotes in different files with the
509 same identifiers to work as expected. If this option is set,
510 footnotes and links will not work across files. Reading binary
511 files (docx, odt, epub) implies `--file-scope`.
513`-F` *PROGRAM*, `--filter=`*PROGRAM*
515: Specify an executable to be used as a filter transforming the
516 pandoc AST after the input is parsed and before the output is
517 written. The executable should read JSON from stdin and write
518 JSON to stdout. The JSON must be formatted like pandoc's own
519 JSON input and output. The name of the output format will be
520 passed to the filter as the first argument. Hence,
522 pandoc --filter ./caps.py -t latex
526 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
528 The latter form may be useful for debugging filters.
530 Filters may be written in any language. `Text.Pandoc.JSON`
531 exports `toJSONFilter` to facilitate writing filters in Haskell.
532 Those who would prefer to write filters in python can use the
533 module [`pandocfilters`], installable from PyPI. There are also
534 pandoc filter libraries in [PHP], [perl], and
535 [JavaScript/node.js].
537 In order of preference, pandoc will look for filters in
539 1. a specified full or relative path (executable or
542 2. `$DATADIR/filters` (executable or non-executable)
543 where `$DATADIR` is the user data directory (see
544 `--data-dir`, above).
546 3. `$PATH` (executable only)
548 Filters and lua-filters are applied in the order specified
551`--lua-filter=`*SCRIPT*
553: Transform the document in a similar fashion as JSON filters (see
554 `--filter`), but use pandoc's build-in lua filtering system. The given
555 lua script is expected to return a list of lua filters which will be
556 applied in order. Each lua filter must contain element-transforming
557 functions indexed by the name of the AST element on which the filter
558 function should be applied.
560 The `pandoc` lua module provides helper functions for element
561 creation. It is always loaded into the script's lua environment.
563 The following is an example lua script for macro-expansion:
565 function expand_hello_world(inline)
566 if inline.c == '{{helloworld}}' then
567 return pandoc.Emph{ pandoc.Str "Hello, World" }
573 return {{Str = expand_hello_world}}
575 In order of preference, pandoc will look for lua filters in
577 1. a specified full or relative path (executable or
580 2. `$DATADIR/filters` (executable or non-executable)
581 where `$DATADIR` is the user data directory (see
582 `--data-dir`, above).
584`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
586: Set the metadata field *KEY* to the value *VAL*. A value specified
587 on the command line overrides a value specified in the document
588 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
589 Values will be parsed as YAML boolean or string values. If no value is
590 specified, the value will be treated as Boolean true. Like
591 `--variable`, `--metadata` causes template variables to be set.
592 But unlike `--variable`, `--metadata` affects the metadata of the
593 underlying document (which is accessible from filters and may be
594 printed in some output formats) and metadata values will be escaped
595 when inserted into the template.
597`--metadata-file=`*FILE*
599: Read metadata from the supplied YAML (or JSON) file.
600 This option can be used with every input format, but string
601 scalars in the YAML file will always be parsed as Markdown.
602 Generally, the input will be handled the same as in
603 [YAML metadata blocks][Extension: `yaml_metadata_block`].
604 Metadata values specified inside the document, or by using `-M`,
605 overwrite values specified with this option.
607`-p`, `--preserve-tabs`
609: Preserve tabs instead of converting them to spaces (the default).
610 Note that this will only affect tabs in literal code spans and code
611 blocks; tabs in regular text will be treated as spaces.
615: Specify the number of spaces per tab (default is 4).
617`--track-changes=accept`|`reject`|`all`
619: Specifies what to do with insertions, deletions, and comments
620 produced by the MS Word "Track Changes" feature. `accept` (the
621 default), inserts all insertions, and ignores all
622 deletions. `reject` inserts all deletions and ignores
623 insertions. Both `accept` and `reject` ignore comments. `all` puts
624 in insertions, deletions, and comments, wrapped in spans with
625 `insertion`, `deletion`, `comment-start`, and `comment-end`
626 classes, respectively. The author and time of change is
627 included. `all` is useful for scripting: only accepting changes
628 from a certain reviewer, say, or before a certain date. If a
629 paragraph is inserted or deleted, `track-changes=all` produces a
630 span with the class `paragraph-insertion`/`paragraph-deletion`
631 before the affected paragraph break. This option only affects the
634`--extract-media=`*DIR*
636: Extract images and other media contained in or linked from
637 the source document to the path *DIR*, creating it if
638 necessary, and adjust the images references in the document
639 so they point to the extracted files. If the source format is
640 a binary container (docx, epub, or odt), the media is
641 extracted from the container and the original
642 filenames are used. Otherwise the media is read from the
643 file system or downloaded, and new filenames are constructed
644 based on SHA1 hashes of the contents.
646`--abbreviations=`*FILE*
648: Specifies a custom abbreviations file, with abbreviations
649 one to a line. If this option is not specified, pandoc will
650 read the data file `abbreviations` from the user data
651 directory or fall back on a system default. To see the
653 `pandoc --print-default-data-file=abbreviations`. The only
654 use pandoc makes of this list is in the Markdown reader.
655 Strings ending in a period that are found in this list will
656 be followed by a nonbreaking space, so that the period will
657 not produce sentence-ending space in formats like LaTeX.
659[`pandocfilters`]: https://github.com/jgm/pandocfilters
660[PHP]: https://github.com/vinai/pandocfilters-php
661[perl]: https://metacpan.org/pod/Pandoc::Filter
662[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
664General writer options {.options}
665----------------------
669: Produce output with an appropriate header and footer (e.g. a
670 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
671 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
672 output. For `native` output, this option causes metadata to
673 be included; otherwise, metadata is suppressed.
675`--template=`*FILE*|*URL*
677: Use the specified file as a custom template for the generated document.
678 Implies `--standalone`. See [Templates], below, for a description
679 of template syntax. If no extension is specified, an extension
680 corresponding to the writer will be added, so that `--template=special`
681 looks for `special.html` for HTML output. If the template is not
682 found, pandoc will search for it in the `templates` subdirectory of
683 the user data directory (see `--data-dir`). If this option is not used,
684 a default template appropriate for the output format will be used (see
685 `-D/--print-default-template`).
687`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
689: Set the template variable *KEY* to the value *VAL* when rendering the
690 document in standalone mode. This is generally only useful when the
691 `--template` option is used to specify a custom template, since
692 pandoc automatically sets the variables used in the default
693 templates. If no *VAL* is specified, the key will be given the
696`-D` *FORMAT*, `--print-default-template=`*FORMAT*
698: Print the system default template for an output *FORMAT*. (See `-t`
699 for a list of possible *FORMAT*s.) Templates in the user data
700 directory are ignored. This option may be used with
701 `-o`/`--output` to redirect output to a file, but
702 `-o`/`--output` must come before `--print-default-template`
705`--print-default-data-file=`*FILE*
707: Print a system default data file. Files in the user data directory
708 are ignored. This option may be used with `-o`/`--output` to
709 redirect output to a file, but `-o`/`--output` must come before
710 `--print-default-data-file` on the command line.
712`--eol=crlf`|`lf`|`native`
714: Manually specify line endings: `crlf` (Windows), `lf`
715 (macOS/Linux/UNIX), or `native` (line endings appropriate
716 to the OS on which pandoc is being run). The default is
721: Specify the dpi (dots per inch) value for conversion from pixels
722 to inch/centimeters and vice versa. The default is 96dpi.
723 Technically, the correct term would be ppi (pixels per inch).
725`--wrap=auto`|`none`|`preserve`
727: Determine how text is wrapped in the output (the source
728 code, not the rendered version). With `auto` (the default),
729 pandoc will attempt to wrap lines to the column width specified by
730 `--columns` (default 72). With `none`, pandoc will not wrap
731 lines at all. With `preserve`, pandoc will attempt to
732 preserve the wrapping from the source document (that is,
733 where there are nonsemantic newlines in the source, there
734 will be nonsemantic newlines in the output as well).
735 Automatic wrapping does not currently work in HTML output.
736 In `ipynb` output, this option affects wrapping of the
737 contents of markdown cells.
741: Specify length of lines in characters. This affects text wrapping
742 in the generated source code (see `--wrap`). It also affects
743 calculation of column widths for plain text tables (see [Tables] below).
745`--toc`, `--table-of-contents`
747: Include an automatically generated table of contents (or, in
748 the case of `latex`, `context`, `docx`, `odt`,
749 `opendocument`, `rst`, or `ms`, an instruction to create
750 one) in the output document. This option has no effect
751 unless `-s/--standalone` is used, and it has no effect
752 on `man`, `docbook4`, `docbook5`, or `jats` output.
754`--toc-depth=`*NUMBER*
756: Specify the number of section levels to include in the table
757 of contents. The default is 3 (which means that level-1, 2, and 3
758 headings will be listed in the contents).
762: Strip out HTML comments in the Markdown or Textile source,
763 rather than passing them on to Markdown, Textile or HTML
764 output as raw HTML. This does not apply to HTML comments
765 inside raw HTML blocks when the `markdown_in_html_blocks`
766 extension is not set.
770: Disables syntax highlighting for code blocks and inlines, even when
771 a language attribute is given.
773`--highlight-style=`*STYLE*|*FILE*
775: Specifies the coloring style to be used in highlighted source code.
776 Options are `pygments` (the default), `kate`, `monochrome`,
777 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
778 For more information on syntax highlighting in pandoc, see
779 [Syntax highlighting], below. See also
780 `--list-highlight-styles`.
782 Instead of a *STYLE* name, a JSON file with extension
783 `.theme` may be supplied. This will be parsed as a KDE
784 syntax highlighting theme and (if valid) used as the
787 To generate the JSON version of an existing style,
788 use `--print-highlight-style`.
790`--print-highlight-style=`*STYLE*|*FILE*
792: Prints a JSON version of a highlighting style, which can
793 be modified, saved with a `.theme` extension, and used
794 with `--highlight-style`. This option may be used with
795 `-o`/`--output` to redirect output to a file, but
796 `-o`/`--output` must come before `--print-highlight-style`
799`--syntax-definition=`*FILE*
801: Instructs pandoc to load a KDE XML syntax definition file,
802 which will be used for syntax highlighting of appropriately
803 marked code blocks. This can be used to add support for
804 new languages or to use altered syntax definitions for
807`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
809: Include contents of *FILE*, verbatim, at the end of the header.
810 This can be used, for example, to include special
811 CSS or JavaScript in HTML documents. This option can be used
812 repeatedly to include multiple files in the header. They will be
813 included in the order specified. Implies `--standalone`.
815`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
817: Include contents of *FILE*, verbatim, at the beginning of the
818 document body (e.g. after the `<body>` tag in HTML, or the
819 `\begin{document}` command in LaTeX). This can be used to include
820 navigation bars or banners in HTML documents. This option can be
821 used repeatedly to include multiple files. They will be included in
822 the order specified. Implies `--standalone`.
824`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
826: Include contents of *FILE*, verbatim, at the end of the document
827 body (before the `</body>` tag in HTML, or the
828 `\end{document}` command in LaTeX). This option can be used
829 repeatedly to include multiple files. They will be included in the
830 order specified. Implies `--standalone`.
832`--resource-path=`*SEARCHPATH*
834: List of paths to search for images and other resources.
835 The paths should be separated by `:` on Linux, UNIX, and
836 macOS systems, and by `;` on Windows. If `--resource-path`
837 is not specified, the default resource path is the working
838 directory. Note that, if `--resource-path` is specified,
839 the working directory must be explicitly listed or it
840 will not be searched. For example:
841 `--resource-path=.:test` will search the working directory
842 and the `test` subdirectory, in that order.
844 `--resource-path` only has an effect if (a) the output
845 format embeds images (for example, `docx`, `pdf`, or `html`
846 with `--self-contained`) or (b) it is used together with
849`--request-header=`*NAME*`:`*VAL*
851: Set the request header *NAME* to the value *VAL* when making
852 HTTP requests (for example, when a URL is given on the
853 command line, or when resources used in a document must be
854 downloaded). If you're behind a proxy, you also need to set
855 the environment variable `http_proxy` to `http://...`.
857Options affecting specific writers {.options}
858----------------------------------
862: Produce a standalone HTML file with no external dependencies, using
863 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
864 images, and videos. Implies `--standalone`. The resulting file should be
865 "self-contained," in the sense that it needs no external files and no net
866 access to be displayed properly by a browser. This option works only with
867 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
868 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
869 and stylesheets at absolute URLs will be downloaded; those at relative
870 URLs will be sought relative to the working directory (if the first source
871 file is local) or relative to the base URL (if the first source
872 file is remote). Elements with the attribute
873 `data-external="1"` will be left alone; the documents they
874 link to will not be incorporated in the document.
875 Limitation: resources that are loaded dynamically through
876 JavaScript cannot be incorporated; as a result,
877 `--self-contained` does not work with `--mathjax`, and some
878 advanced features (e.g. zoom or speaker notes) may not work
879 in an offline "self-contained" `reveal.js` slide show.
883: Use `<q>` tags for quotes in HTML.
887: Use only ASCII characters in output. Currently supported for XML
888 and HTML formats (which use entities instead of UTF-8 when this
889 option is selected), CommonMark, gfm, and Markdown (which use
890 entities), roff ms (which use hexadecimal escapes), and to a
891 limited degree LaTeX (which uses standard commands for accented
892 characters when possible). roff man output uses ASCII by default.
896: Use reference-style links, rather than inline links, in writing Markdown
897 or reStructuredText. By default inline links are used. The
898 placement of link references is affected by the
899 `--reference-location` option.
901`--reference-location = block`|`section`|`document`
903: Specify whether footnotes (and references, if `reference-links` is
904 set) are placed at the end of the current (top-level) block, the
905 current section, or the document. The default is
906 `document`. Currently only affects the markdown writer.
910: Use ATX-style headings in Markdown output. The default is
911 to use setext-style headings for levels 1 to 2, and then ATX headings.
912 (Note: for `gfm` output, ATX headings are always used.)
913 This option also affects markdown cells in `ipynb` output.
915`--top-level-division=[default|section|chapter|part]`
917: Treat top-level headings as the given division type in LaTeX, ConTeXt,
918 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
919 all headings are shifted such that the top-level heading becomes the specified
920 type. The default behavior is to determine the best division type via
921 heuristics: unless other conditions apply, `section` is chosen. When the
922 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
923 `article` option is specified), `chapter` is implied as the setting for this
924 option. If `beamer` is the output format, specifying either `chapter` or
925 `part` will cause top-level headings to become `\part{..}`, while
926 second-level headings remain as their default type.
928`-N`, `--number-sections`
930: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
931 By default, sections are not numbered. Sections with class
932 `unnumbered` will never be numbered, even if `--number-sections`
935`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
937: Offset for section headings in HTML output (ignored in other
938 output formats). The first number is added to the section number for
939 top-level headings, the second for second-level headings, and so on.
940 So, for example, if you want the first top-level heading in your
941 document to be numbered "6", specify `--number-offset=5`.
942 If your document starts with a level-2 heading which you want to
943 be numbered "1.5", specify `--number-offset=1,4`.
944 Offsets are 0 by default. Implies `--number-sections`.
948: Use the [`listings`] package for LaTeX code blocks. The package
949 does not support multi-byte encoding for source code. To handle UTF-8
950 you would need to use a custom template. This issue is fully
951 documented here: [Encoding issue with the listings package].
955: Make list items in slide shows display incrementally (one by one).
956 The default is for lists to be displayed all at once.
958`--slide-level=`*NUMBER*
960: Specifies that headings with the specified level create
961 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
962 above this level in the hierarchy are used to divide the
963 slide show into sections; headings below this level create
964 subheads within a slide. Note that content that is
965 not contained under slide-level headings will not appear in
966 the slide show. The default is to set the slide level based
967 on the contents of the document; see [Structuring the slide
972: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
973 and attach identifiers to the enclosing `<section>` (or `<div>`)
974 rather than the heading itself. See
975 [Heading identifiers], below.
977`--email-obfuscation=none`|`javascript`|`references`
979: Specify a method for obfuscating `mailto:` links in HTML documents.
980 `none` leaves `mailto:` links as they are. `javascript` obfuscates
981 them using JavaScript. `references` obfuscates them by printing their
982 letters as decimal or hexadecimal character references. The default
985`--id-prefix=`*STRING*
987: Specify a prefix to be added to all identifiers and internal links
988 in HTML and DocBook output, and to footnote numbers in Markdown
989 and Haddock output. This is useful for preventing duplicate
990 identifiers when generating fragments to be included in other pages.
992`-T` *STRING*, `--title-prefix=`*STRING*
994: Specify *STRING* as a prefix at the beginning of the title
995 that appears in the HTML header (but not in the title as it
996 appears at the beginning of the HTML body). Implies
999`-c` *URL*, `--css=`*URL*
1001: Link to a CSS style sheet. This option can be used repeatedly to
1002 include multiple files. They will be included in the order specified.
1004 A stylesheet is required for generating EPUB. If none is
1005 provided using this option (or the `css` or `stylesheet`
1006 metadata fields), pandoc will look for a file `epub.css` in the
1007 user data directory (see `--data-dir`). If it is not
1008 found there, sensible defaults will be used.
1010`--reference-doc=`*FILE*
1012: Use the specified file as a style reference in producing a
1017 : For best results, the reference docx should be a modified
1018 version of a docx file produced using pandoc. The contents
1019 of the reference docx are ignored, but its stylesheets and
1020 document properties (including margins, page size, header,
1021 and footer) are used in the new docx. If no reference docx
1022 is specified on the command line, pandoc will look for a
1023 file `reference.docx` in the user data directory (see
1024 `--data-dir`). If this is not found either, sensible
1025 defaults will be used.
1027 To produce a custom `reference.docx`, first get a copy of
1028 the default `reference.docx`: `pandoc
1029 -o custom-reference.docx --print-default-data-file reference.docx`.
1030 Then open `custom-reference.docx` in Word, modify the
1031 styles as you wish, and save the file. For best
1032 results, do not make changes to this file other than
1033 modifying the styles used by pandoc:
1069 - Default Paragraph Font
1072 - Footnote Reference
1081 : For best results, the reference ODT should be a modified
1082 version of an ODT produced using pandoc. The contents of
1083 the reference ODT are ignored, but its stylesheets are used
1084 in the new ODT. If no reference ODT is specified on the
1085 command line, pandoc will look for a file `reference.odt` in
1086 the user data directory (see `--data-dir`). If this is not
1087 found either, sensible defaults will be used.
1089 To produce a custom `reference.odt`, first get a copy of
1090 the default `reference.odt`: `pandoc
1091 -o custom-reference.odt --print-default-data-file reference.odt`.
1092 Then open `custom-reference.odt` in LibreOffice, modify
1093 the styles as you wish, and save the file.
1097 : Templates included with Microsoft PowerPoint 2013 (either with
1098 `.pptx` or `.potx` extension) are known to work, as are most
1099 templates derived from these.
1101 The specific requirement is that the template should begin with
1102 the following first four layouts:
1105 2. Title and Content
1109 All templates included with a recent version of MS PowerPoint
1110 will fit these criteria. (You can click on `Layout` under the
1111 `Home` menu to check.)
1113 You can also modify the default `reference.pptx`: first run
1114 `pandoc -o custom-reference.pptx --print-default-data-file
1115 reference.pptx`, and then modify `custom-reference.pptx`
1116 in MS PowerPoint (pandoc will use the first four layout
1117 slides, as mentioned above).
1119`--epub-cover-image=`*FILE*
1121: Use the specified image as the EPUB cover. It is recommended
1122 that the image be less than 1000px in width and height. Note that
1123 in a Markdown source document you can also specify `cover-image`
1124 in a YAML metadata block (see [EPUB Metadata], below).
1126`--epub-metadata=`*FILE*
1128: Look in the specified XML file for metadata for the EPUB.
1129 The file should contain a series of [Dublin Core elements].
1132 <dc:rights>Creative Commons</dc:rights>
1133 <dc:language>es-AR</dc:language>
1135 By default, pandoc will include the following metadata elements:
1136 `<dc:title>` (from the document title), `<dc:creator>` (from the
1137 document authors), `<dc:date>` (from the document date, which should
1138 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1139 variable, or, if is not set, the locale), and `<dc:identifier
1140 id="BookId">` (a randomly generated UUID). Any of these may be
1141 overridden by elements in the metadata file.
1143 Note: if the source document is Markdown, a YAML metadata block
1144 in the document can be used instead. See below under
1147`--epub-embed-font=`*FILE*
1149: Embed the specified font in the EPUB. This option can be repeated
1150 to embed multiple fonts. Wildcards can also be used: for example,
1151 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1152 line, be sure to escape them or put the whole filename in single quotes,
1153 to prevent them from being interpreted by the shell. To use the
1154 embedded fonts, you will need to add declarations like the following
1155 to your CSS (see `--css`):
1158 font-family: DejaVuSans;
1160 font-weight: normal;
1161 src:url("DejaVuSans-Regular.ttf");
1164 font-family: DejaVuSans;
1167 src:url("DejaVuSans-Bold.ttf");
1170 font-family: DejaVuSans;
1172 font-weight: normal;
1173 src:url("DejaVuSans-Oblique.ttf");
1176 font-family: DejaVuSans;
1179 src:url("DejaVuSans-BoldOblique.ttf");
1181 body { font-family: "DejaVuSans"; }
1183`--epub-chapter-level=`*NUMBER*
1185: Specify the heading level at which to split the EPUB into separate
1186 "chapter" files. The default is to split into chapters at level-1
1187 headings. This option only affects the internal composition of the
1188 EPUB, not the way chapters and sections are displayed to users. Some
1189 readers may be slow if the chapter files are too large, so for large
1190 documents with few level-1 headings, one might want to use a chapter
1193`--epub-subdirectory=`*DIRNAME*
1195: Specify the subdirectory in the OCF container that is to hold
1196 the EPUB-specific contents. The default is `EPUB`. To put
1197 the EPUB contents in the top level, use an empty string.
1199`--ipynb-output=all|none|best`
1201: Determines how ipynb output cells are treated. `all` means
1202 that all of the data formats included in the original are
1203 preserved. `none` means that the contents of data cells
1204 are omitted. `best` causes pandoc to try to pick the
1205 richest data block in each output cell that is compatible
1206 with the output format. The default is `best`.
1208`--pdf-engine=`*PROGRAM*
1210: Use the specified engine when producing PDF output.
1211 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1212 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1213 and `pdfroff`. The default is `pdflatex`. If the engine is
1214 not in your PATH, the full path of the engine may be specified here.
1216`--pdf-engine-opt=`*STRING*
1218: Use the given string as a command-line argument to the `pdf-engine`.
1219 For example, to use a persistent directory `foo` for `latexmk`'s
1220 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1221 Note that no check for duplicate options is done.
1223[Dublin Core elements]: http://dublincore.org/documents/dces/
1224[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1225[Encoding issue with the listings package]:
1226 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1228Citation rendering {.options}
1231`--bibliography=`*FILE*
1233: Set the `bibliography` field in the document's metadata to *FILE*,
1234 overriding any value set in the metadata, and process citations
1235 using `pandoc-citeproc`. (This is equivalent to
1236 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1237 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1238 used, making this equivalent to `--metadata bibliography=FILE`.
1239 If you supply this argument multiple times, each *FILE* will be added
1244: Set the `csl` field in the document's metadata to *FILE*,
1245 overriding any value set in the metadata. (This is equivalent to
1246 `--metadata csl=FILE`.)
1247 This option is only relevant with `pandoc-citeproc`.
1249`--citation-abbreviations=`*FILE*
1251: Set the `citation-abbreviations` field in the document's metadata to
1252 *FILE*, overriding any value set in the metadata. (This is equivalent to
1253 `--metadata citation-abbreviations=FILE`.)
1254 This option is only relevant with `pandoc-citeproc`.
1258: Use [`natbib`] for citations in LaTeX output. This option is not for use
1259 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1260 use in producing a LaTeX file that can be processed with [`bibtex`].
1264: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1265 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1266 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1268Math rendering in HTML {.options}
1269----------------------
1271The default is to render TeX math as far as possible using Unicode characters.
1272Formulas are put inside a `span` with `class="math"`, so that they may be styled
1273differently from the surrounding text if needed. However, this gives acceptable
1274results only for basic math, usually you will want to use `--mathjax` or another
1275of the following options.
1277`--mathjax`[`=`*URL*]
1279: Use [MathJax] to display embedded TeX math in HTML output.
1280 TeX math will be put between `\(...\)` (for inline math)
1281 or `\[...\]` (for display math) and wrapped in `<span>` tags
1282 with class `math`. Then the MathJax JavaScript will render it.
1283 The *URL* should point to the `MathJax.js` load script.
1284 If a *URL* is not provided, a link to the Cloudflare CDN will
1289: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1290 `html4` and `html5`). This is the default in `odt` output. Note that
1291 currently only Firefox and Safari (and select e-book readers) natively
1296: Convert TeX formulas to `<img>` tags that link to an external script
1297 that converts formulas to images. The formula will be URL-encoded
1298 and concatenated with the URL provided. For SVG images you can for
1299 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1300 If no URL is specified, the CodeCogs URL generating PNGs
1301 will be used (`https://latex.codecogs.com/png.latex?`).
1302 Note: the `--webtex` option will affect Markdown output
1303 as well as HTML, which is useful if you're targeting a
1304 version of Markdown without native math support.
1308: Use [KaTeX] to display embedded TeX math in HTML output.
1309 The *URL* is the base URL for the KaTeX library. That directory
1310 should contain a `katex.min.js` and a `katex.min.css` file.
1311 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1315: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1316 can then be processed by [GladTeX] to produce images of the typeset
1317 formulas and an HTML file with links to these images.
1318 So, the procedure is:
1320 pandoc -s --gladtex input.md -o myfile.htex
1321 gladtex -d myfile-images myfile.htex
1322 # produces myfile.html and images in myfile-images
1324[MathML]: http://www.w3.org/Math/
1325[MathJax]: https://www.mathjax.org
1326[KaTeX]: https://github.com/Khan/KaTeX
1327[GladTeX]: http://humenda.github.io/GladTeX/
1329Options for wrapper scripts {.options}
1330---------------------------
1334: Print information about command-line arguments to *stdout*, then exit.
1335 This option is intended primarily for use in wrapper scripts.
1336 The first line of output contains the name of the output file specified
1337 with the `-o` option, or `-` (for *stdout*) if no output file was
1338 specified. The remaining lines contain the command-line arguments,
1339 one per line, in the order they appear. These do not include regular
1340 pandoc options and their arguments, but do include any options appearing
1341 after a `--` separator at the end of the line.
1345: Ignore command-line arguments (for use in wrapper scripts).
1346 Regular pandoc options are not ignored. Thus, for example,
1348 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1352 pandoc -o foo.html -s
1357When the `-s/--standalone` option is used, pandoc uses a template to
1358add header and footer material that is needed for a self-standing
1359document. To see the default template that is used, just type
1363where *FORMAT* is the name of the output format. A custom template
1364can be specified using the `--template` option. You can also override
1365the system default templates for a given output format *FORMAT*
1366by putting a file `templates/default.*FORMAT*` in the user data
1367directory (see `--data-dir`, above). *Exceptions:*
1369- For `odt` output, customize the `default.opendocument`
1371- For `pdf` output, customize the `default.latex` template
1372 (or the `default.context` template, if you use `-t context`,
1373 or the `default.ms` template, if you use `-t ms`, or the
1374 `default.html` template, if you use `-t html`).
1375- `docx` and `pptx` have no template (however, you can use
1376 `--reference-doc` to customize the output).
1378Templates contain *variables*, which allow for the inclusion of
1379arbitrary information at any point in the file. They may be set at the
1380command line using the `-V/--variable` option. If a variable is not set,
1381pandoc will look for the key in the document's metadata – which can be set
1382using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1383or with the `-M/--metadata` option.
1388`title`, `author`, `date`
1389: allow identification of basic aspects of the document. Included
1390 in PDF metadata through LaTeX and ConTeXt. These can be set
1391 through a [pandoc title block][Extension: `pandoc_title_block`],
1392 which allows for multiple authors, or through a YAML metadata block:
1401: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
1405: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
1409: list of keywords to be included in HTML, PDF, ODT, pptx, docx
1410 and AsciiDoc metadata; repeat as for `author`, above
1413: document subject, included in ODT, PDF, docx and pptx metadata
1416: document description, included in ODT, docx and pptx metadata. Some
1417 applications show this as `Comments` metadata.
1420: document category, included in docx and pptx metadata
1423any root-level string metadata, not included in ODT, docx
1424or pptx metadata is added as a *custom property*.
1425The following YAML metadata block for instance:
1428 title: 'This is the title'
1429 subtitle: "This is the subtitle"
1437 It consists of two paragraphs
1440will include `title`, `author` and `description` as standard document
1441properties and `subtitle` as a custom property when converting to docx,
1448: identifies the main language of the document using IETF language
1449 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
1450 The [Language subtag lookup] tool can look up or verify these tags.
1451 This affects most formats, and controls hyphenation in PDF output
1452 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
1454 Use native pandoc [Divs and Spans] with the `lang` attribute to
1455 switch the language:
1461 Text in the main document language (British English).
1464 > Cette citation est écrite en français canadien.
1467 More text in English. ['Zitat auf Deutsch.']{lang=de}
1470: the base script direction, either `rtl` (right-to-left)
1471 or `ltr` (left-to-right).
1473 For bidirectional documents, native pandoc `span`s and `div`s
1474 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1475 override the base direction in some output formats.
1476 This may not always be necessary if the final renderer
1477 (e.g. the browser, when generating HTML) supports the
1478 [Unicode Bidirectional Algorithm].
1480 When using LaTeX for bidirectional documents, only the `xelatex` engine
1481 is fully supported (use `--pdf-engine=xelatex`).
1483[BCP 47]: https://tools.ietf.org/html/bcp47
1484[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1485[Language subtag lookup]: https://r12a.github.io/app-subtags/
1487Variables for HTML slides
1488-------------------------
1490These affect HTML output when [producing slide shows with pandoc].
1491All [reveal.js configuration options] are available as variables.
1494: base URL for reveal.js documents (defaults to `reveal.js`)
1497: base URL for S5 documents (defaults to `s5/default`)
1500: base URL for Slidy documents (defaults to
1501 `https://www.w3.org/Talks/Tools/Slidy2`)
1504: base URL for Slideous documents (defaults to `slideous`)
1506[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1508Variables for Beamer slides
1509---------------------------
1511These variables change the appearance of PDF slides using [`beamer`].
1514: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
1515 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
1519: produce an article from Beamer slides
1522: add extra beamer option with `\setbeameroption{}`
1525: author affiliations: can be a list when there are multiple authors
1528: logo image for slides
1531: controls navigation symbols (default is `empty` for no navigation
1532 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
1535: enables "title pages" for new sections (default is true)
1537`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1541: options for LaTeX beamer themes (a list).
1544: image for title slide
1549Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1554: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or
1555 fifth- and sixth-level with book classes) free-standing rather than run-in;
1556 requires further formatting to distinguish from `\subsubsection` (third- or
1557 fourth-level headings). Instead of using this option, [KOMA-Script] can adjust
1558 headings more extensively:
1561 documentclass: scrartcl
1563 \RedeclareSectionCommand[
1564 beforeskip=-10pt plus -2pt minus -1pt,
1565 afterskip=1sp plus -1sp minus 1sp,
1566 font=\normalfont\itshape]{paragraph}
1567 \RedeclareSectionCommand[
1568 beforeskip=-10pt plus -2pt minus -1pt,
1569 afterskip=1sp plus -1sp minus 1sp,
1570 font=\normalfont\scshape,
1571 indent=0pt]{subparagraph}
1575: option for document class, e.g. `oneside`; repeat for multiple options:
1584: document class: usually one of the standard classes, [`article`], [`book`],
1585 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
1586 and `scrreprt`, which default to smaller margins; or [`memoir`]
1589: option for [`geometry`] package, e.g. `margin=1in`;
1590 repeat for multiple options:
1600: uses document class settings for indentation (the default LaTeX template
1601 otherwise removes indentation and adds space between paragraphs)
1604: adjusts line spacing using the [`setspace`]
1605 package, e.g. `1.25`, `1.5`
1607`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1608: sets margins if `geometry` is not used (otherwise `geometry`
1612: control `\pagestyle{}`: the default article class
1613 supports `plain` (default), `empty` (no running heads or page numbers),
1614 and `headings` (section titles in running heads)
1617: paper size, e.g. `letter`, `a4`
1620: numbering depth for sections (with `--number-sections` option
1621 or `numbersections` variable)
1626: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1627 default is `T1` (see [LaTeX font encodings guide])
1630: font package for use with `pdflatex`:
1631 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1632 The default is [Latin Modern][`lm`].
1635: options for package used as `fontfamily`; repeat for multiple options.
1636 For example, to use the Libertine font with proportional lowercase
1637 (old-style) figures through the [`libertinus`] package:
1640 fontfamily: libertinus
1647: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1648 To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1649 such as `scrartcl` or `scrbook`.
1651`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1652: font families for use with `xelatex` or
1653 `lualatex`: take the name of any system font, using the
1654 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
1656`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1657: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1658 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1659 available through [`fontspec`]; repeat for multiple options. For example,
1660 to use the [TeX Gyre] version of Palatino with lowercase figures:
1663 mainfont: TeX Gyre Pagella
1666 - Numbers=Proportional
1670: options to pass to the microtype package
1675: add color to link text; automatically enabled if any of
1676 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
1678`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1679: color for internal links, external links, citation links, linked
1680 URLs, and links in table of contents, respectively: uses options
1681 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1685: causes links to be printed as footnotes
1690: include list of figures, list of tables
1693: contents of acknowledgments footnote after document title
1696: include table of contents (can also be set using `--toc/--table-of-contents`)
1699: level of section to include in table of contents
1701### BibLaTeX Bibliographies
1703These variables function when using BibLaTeX for [citation rendering].
1706: list of options for biblatex
1709: bibliography style, when used with `--natbib` and `--biblatex`.
1712: bibliography title, when used with `--natbib` and `--biblatex`.
1715: bibliography to use for resolving references
1718: list of options for natbib
1720[KOMA-Script]: https://ctan.org/pkg/koma-script
1721[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1722[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
1723[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
1724[`article`]: https://ctan.org/pkg/article
1725[`book`]: https://ctan.org/pkg/book
1726[`libertinus`]: https://ctan.org/pkg/libertinus
1727[`memoir`]: https://ctan.org/pkg/memoir
1728[`report`]: https://ctan.org/pkg/report
1730Variables for ConTeXt
1731---------------------
1733Pandoc uses these variables when [creating a PDF] with ConTeXt.
1736: font size for body text (e.g. `10pt`, `12pt`)
1738`headertext`, `footertext`
1739: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1740 repeat up to four times for different placement
1743: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1744 repeat for multiple options
1747: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1748 repeat for multiple options
1751: options for page margins and text arrangement (see [ConTeXt Layout]);
1752 repeat for multiple options
1754`linkcolor`, `contrastcolor`
1755: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1758: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1761: include list of figures, list of tables
1763`mainfont`, `sansfont`, `monofont`, `mathfont`
1764: font families: take the name of any system font (see [ConTeXt Font Switching])
1766`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1767: sets margins, if `layout` is not used (otherwise `layout`
1771: page number style and location (using [`setuppagenumbering`]);
1772 repeat for multiple options
1775: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1776 repeat for multiple options
1779: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1780 To successfully generate PDF/A the required ICC color profiles have to
1781 be available and the content and all included files (such as images)
1782 have to be standard conforming. The ICC profiles can be obtained
1783 from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1787: include table of contents (can also be set using `--toc/--table-of-contents`)
1790: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1792[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1793[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
1794[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
1795[ConTeXt Color]: https://wiki.contextgarden.net/Color
1796[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
1797[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
1798[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
1799[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
1800[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
1801[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1802[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
1804Variables for `wkhtmltopdf`
1805---------------------------
1807Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
1808The `--css` option also affects the output.
1810`footer-html`, `header-html`
1811: add information to the header and footer
1813`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1814: set the page margins
1817: sets the PDF paper size
1819Variables for man pages
1820-----------------------
1823: adjusts text to left (`l`), right (`r`), center (`c`),
1824 or both (`b`) margins
1827: footer in man pages
1830: header in man pages
1833: if `true` (the default), hyphenation will be used
1836: section number in man pages
1842: font family (e.g. `T` or `P`)
1845: paragraph indent (e.g. `2m`)
1848: line height (e.g. `12p`)
1851: point size (e.g. `10p`)
1856Pandoc sets these variables automatically in response to [options] or
1857document contents; users can also modify them. These vary depending
1858on the output format, and include the following:
1864: the `date` variable converted to ISO 8601 YYYY-MM-DD,
1865 included in all HTML based formats (dzslides, epub,
1866 html, html4, html5, revealjs, s5, slideous, slidy).
1867 The recognized formats for `date` are: `mm/dd/yyyy`,
1868 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
1869 (e.g. either `02 Apr 2018` or `02 April 2018`),
1870 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
1871 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
1874: contents specified by `-H/--include-in-header` (may have multiple
1878: contents specified by `-B/--include-before-body` (may have
1882: contents specified by `-A/--include-after-body` (may have
1886: JSON representation of all of the document's metadata. Field
1887 values are transformed to the selected output format.
1890: non-null value if `-N/--number-sections` was specified
1892`sourcefile`, `outputfile`
1893: source and destination filenames, as given on the command line.
1894 `sourcefile` can also be a list if input comes from multiple files, or empty
1895 if input is from stdin. You can use the following snippet in your template
1896 to distinguish them:
1906 Similarly, `outputfile` can be `-` if output goes to the terminal.
1909: non-null value if `--toc/--table-of-contents` was specified
1912: title of table of contents (works only with EPUB,
1913 opendocument, odt, docx, pptx, beamer, LaTeX)
1915Using variables in templates
1916----------------------------
1918Variable names are sequences of alphanumerics, `-`, and `_`,
1919starting with a letter. A variable name surrounded by `$` signs
1920will be replaced by its value. For example, the string `$title$` in
1922 <title>$title$</title>
1924will be replaced by the document title.
1926To write a literal `$` in a template, use `$$`.
1928Templates may contain conditionals. The syntax is as follows:
1936This will include `X` in the template if `variable` has a truthy
1937value; otherwise it will include `Y`. Here a truthy value is any
1940- a string that is not entirely white space,
1941- a non-empty array where the first value is truthy,
1942- any number (including zero),
1944- the boolean `true` (to specify the boolean `true`
1945 value using YAML metadata or the `--metadata` flag,
1946 use `true`, `True`, or `TRUE`; with the `--variable`
1947 flag, simply omit a value for the variable, e.g.
1948 `--variable draft`).
1950`X` and `Y` are placeholders for any valid template text,
1951and may include interpolated variables or other conditionals.
1952The `$else$` section may be omitted.
1954When variables can have multiple values (for example, `author` in
1955a multi-author document), you can use the `$for$` keyword:
1958 <meta name="author" content="$author$" />
1961You can optionally specify a separator to be used between
1964 $for(author)$$author$$sep$, $endfor$
1966Note that the separator needs to be specified immediately before the `$endfor`
1969A dot can be used to select a field of a variable that takes
1970an object as its value. So, for example:
1972 $author.name$ ($author.affiliation$)
1974The value of a variable will be indented to the same level as the variable.
1976If you use custom templates, you may need to revise them as pandoc
1977changes. We recommend tracking the changes in the default templates,
1978and modifying your custom templates accordingly. An easy way to do this
1979is to fork the [pandoc-templates] repository and merge in changes after each
1982Templates may contain comments: anything on a line after `$--`
1983will be treated as a comment and ignored.
1985[pandoc-templates]: https://github.com/jgm/pandoc-templates
1990The behavior of some of the readers and writers can be adjusted by
1991enabling or disabling various extensions.
1993An extension can be enabled by adding `+EXTENSION`
1994to the format name and disabled by adding `-EXTENSION`. For example,
1995`--from markdown_strict+footnotes` is strict Markdown with footnotes
1996enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
1997Markdown without footnotes or pipe tables.
1999The markdown reader and writer make by far the most use of extensions.
2000Extensions only used by them are therefore covered in the
2001section [Pandoc's Markdown] below (See [Markdown variants] for
2002`commonmark` and `gfm`.) In the following, extensions that also work
2003for other formats are covered.
2005Note that markdown extensions added to the `ipynb` format
2006affect Markdown cells in Jupyter notebooks (as do command-line
2007options like `--atx-headers`).
2012#### Extension: `smart` ####
2014Interpret straight quotes as curly quotes, `---` as em-dashes,
2015`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2016inserted after certain abbreviations, such as "Mr."
2018This extension can be enabled/disabled for the following formats:
2021: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2024: `markdown`, `latex`, `context`, `rst`
2026enabled by default in
2027: `markdown`, `latex`, `context` (both input and output)
2029Note: If you are *writing* Markdown, then the `smart` extension
2030has the reverse effect: what would have been curly quotes comes
2033In LaTeX, `smart` means to use the standard TeX ligatures
2034for quotation marks (` `` ` and ` '' ` for double quotes,
2035`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2036en-dash and `---` for em-dash). If `smart` is disabled,
2037then in reading LaTeX pandoc will parse these characters
2038literally. In writing LaTeX, enabling `smart` tells pandoc
2039to use the ligatures when possible; if `smart` is disabled
2040pandoc will use unicode quotation mark and dash characters.
2042Headings and sections
2043---------------------
2045#### Extension: `auto_identifiers` ####
2047A heading without an explicitly specified identifier will be
2048automatically assigned a unique identifier based on the heading text.
2050This extension can be enabled/disabled for the following formats:
2053: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2058enabled by default in
2061The default algorithm used to derive the identifier from the
2064 - Remove all formatting, links, etc.
2065 - Remove all footnotes.
2066 - Remove all non-alphanumeric characters,
2067 except underscores, hyphens, and periods.
2068 - Replace all spaces and newlines with hyphens.
2069 - Convert all alphabetic characters to lowercase.
2070 - Remove everything up to the first letter (identifiers may
2071 not begin with a number or punctuation mark).
2072 - If nothing is left after this, use the identifier `section`.
2077 ------------------------------- ----------------------------
2078 `Heading identifiers in HTML` `heading-identifiers-in-html`
2079 `Maître d'hôtel` `maître-dhôtel`
2080 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2081 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2082 `3. Applications` `applications`
2085These rules should, in most cases, allow one to determine the identifier
2086from the heading text. The exception is when several headings have the
2087same text; in this case, the first will get an identifier as described
2088above; the second will get the same identifier with `-1` appended; the
2089third with `-2`; and so on.
2091(However, a different algorithm is used if
2092`gfm_auto_identifiers` is enabled; see below.)
2094These identifiers are used to provide link targets in the table of
2095contents generated by the `--toc|--table-of-contents` option. They
2096also make it easy to provide links from one section of a document to
2097another. A link to this section, for example, might look like this:
2100 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2102Note, however, that this method of providing links to sections works
2103only in HTML, LaTeX, and ConTeXt formats.
2105If the `--section-divs` option is specified, then each section will
2106be wrapped in a `section` (or a `div`, if `html4` was specified),
2107and the identifier will be attached to the enclosing `<section>`
2108(or `<div>`) tag rather than the heading itself. This allows entire
2109sections to be manipulated using JavaScript or treated differently in
2112#### Extension: `ascii_identifiers` ####
2114Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2115Accents are stripped off of accented Latin letters, and non-Latin
2118#### Extension: `gfm_auto_identifiers` ####
2120Changes the algorithm used by `auto_identifiers` to conform to
2121GitHub's method. Spaces are converted to dashes (`-`),
2122uppercase characters to lowercase characters, and punctuation
2123characters other than `-` and `_` are removed.
2128The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2129[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2130[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2131are described in the section about Pandoc's Markdown.
2133However, they can also be used with HTML input. This is handy for
2134reading web pages formatted using MathJax, for example.
2139The following extensions (especially how they affect Markdown
2140input/output) are also described in more detail in their respective
2141sections of [Pandoc's Markdown].
2143#### Extension: `raw_html` {#raw_html}
2145When converting from HTML, parse elements to raw HTML which are not
2146representable in pandoc's AST.
2147By default, this is disabled for HTML input.
2149#### Extension: `raw_tex` {#raw_tex}
2151Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2153This extension can be enabled/disabled for the following formats
2154(in addition to `markdown`):
2157: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2158 `\eqref` only), `ipynb`
2161: `textile`, `commonmark`
2163Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2164only raw TeX in markdown cells, but data with mime type
2165`text/html` in output cells. Since the `ipynb` reader attempts
2166to preserve the richest possible outputs when several options
2167are given, you will get best results if you disable `raw_html`
2168and `raw_tex` when converting to formats like `docx` which don't
2169allow raw `html` or `tex`.
2171#### Extension: `native_divs` {#native_divs}
2173This extension is enabled by default for HTML input. This means that
2174`div`s are parsed to pandoc native elements. (Alternatively, you
2175can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2177When converting HTML to Markdown, for example, you may want to drop all
2180 pandoc -f html-native_divs-native_spans -t markdown
2182#### Extension: `native_spans` {#native_spans}
2184Analogous to `native_divs` above.
2187Literate Haskell support
2188------------------------
2190#### Extension: `literate_haskell` ####
2192Treat the document as literate Haskell source.
2194This extension can be enabled/disabled for the following formats:
2197: `markdown`, `rst`, `latex`
2200: `markdown`, `rst`, `latex`, `html`
2202If you append `+lhs` (or `+literate_haskell`) to one of the formats
2203above, pandoc will treat the document as literate Haskell source.
2206 - In Markdown input, "bird track" sections will be parsed as Haskell
2207 code rather than block quotations. Text between `\begin{code}`
2208 and `\end{code}` will also be treated as Haskell code. For
2209 ATX-style headings the character '=' will be used instead of '#'.
2211 - In Markdown output, code blocks with classes `haskell` and `literate`
2212 will be rendered using bird tracks, and block quotations will be
2213 indented one space, so they will not be treated as Haskell code.
2214 In addition, headings will be rendered setext-style (with underlines)
2215 rather than ATX-style (with '#' characters). (This is because ghc
2216 treats '#' characters in column 1 as introducing line numbers.)
2218 - In restructured text input, "bird track" sections will be parsed
2221 - In restructured text output, code blocks with class `haskell` will
2222 be rendered using bird tracks.
2224 - In LaTeX input, text in `code` environments will be parsed as
2227 - In LaTeX output, code blocks with class `haskell` will be rendered
2228 inside `code` environments.
2230 - In HTML output, code blocks with class `haskell` will be rendered
2231 with class `literatehaskell` and bird tracks.
2235 pandoc -f markdown+lhs -t html
2237reads literate Haskell source formatted with Markdown conventions and writes
2238ordinary HTML (without bird tracks).
2240 pandoc -f markdown+lhs -t html+lhs
2242writes HTML with the Haskell code in bird tracks, so it can be copied
2243and pasted as literate Haskell source.
2245Note that GHC expects the bird tracks in the first column, so indented
2246literate code blocks (e.g. inside an itemized environment) will not be
2247picked up by the Haskell compiler.
2252#### Extension: `empty_paragraphs` ####
2254Allows empty paragraphs. By default empty paragraphs are
2257This extension can be enabled/disabled for the following formats:
2263: `docx`, `odt`, `opendocument`, `html`
2265#### Extension: `styles` #### {#ext-styles}
2267When converting from docx, read all docx styles as divs (for
2268paragraph styles) and spans (for character styles) regardless
2269of whether pandoc understands the meaning of these styles.
2270This can be used with [docx custom styles](#custom-styles).
2276#### Extension: `amuse` ####
2278In the `muse` input format, this enables Text::Amuse
2279extensions to Emacs Muse markup.
2281#### Extension: `citations` {#org-citations}
2283Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2286#### Extension: `ntb` ####
2288In the `context` output format this enables the use of [Natural Tables
2289(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2290[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2291Natural tables allow more fine-grained global customization but come
2292at a performance penalty compared to extreme tables.
2298Pandoc understands an extended and slightly revised version of
2299John Gruber's [Markdown] syntax. This document explains the syntax,
2300noting differences from standard Markdown. Except where noted, these
2301differences can be suppressed by using the `markdown_strict` format instead
2302of `markdown`. Extensions can be enabled or disabled to specify the
2303behavior more granularly. They are described in the following. See also
2304[Extensions] above, for extensions that work also on other formats.
2309Markdown is designed to be easy to write, and, even more importantly,
2312> A Markdown-formatted document should be publishable as-is, as plain
2313> text, without looking like it's been marked up with tags or formatting
2315> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2317This principle has guided pandoc's decisions in finding syntax for
2318tables, footnotes, and other extensions.
2320There is, however, one respect in which pandoc's aims are different
2321from the original aims of Markdown. Whereas Markdown was originally
2322designed with HTML generation in mind, pandoc is designed for multiple
2323output formats. Thus, while pandoc allows the embedding of raw HTML,
2324it discourages it, and provides other, non-HTMLish ways of representing
2325important document elements like definition lists, tables, mathematics, and
2331A paragraph is one or more lines of text followed by one or more blank lines.
2332Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2333If you need a hard line break, put two or more spaces at the end of a line.
2335#### Extension: `escaped_line_breaks` ####
2337A backslash followed by a newline is also a hard line break.
2338Note: in multiline and grid table cells, this is the only way
2339to create a hard line break, since trailing spaces in the cells
2345There are two kinds of headings: Setext and ATX.
2347### Setext-style headings ###
2349A setext-style heading is a line of text "underlined" with a row of `=` signs
2350(for a level-one heading) or `-` signs (for a level-two heading):
2358The heading text can contain inline formatting, such as emphasis (see
2359[Inline formatting], below).
2362### ATX-style headings ###
2364An ATX-style heading consists of one to six `#` signs and a line of
2365text, optionally followed by any number of `#` signs. The number of
2366`#` signs at the beginning of the line is the heading level:
2368 ## A level-two heading
2370 ### A level-three heading ###
2372As with setext-style headings, the heading text can contain formatting:
2374 # A level-one heading with a [link](/url) and *emphasis*
2376#### Extension: `blank_before_header` ####
2378Standard Markdown syntax does not require a blank line before a heading.
2379Pandoc does require this (except, of course, at the beginning of the
2380document). The reason for the requirement is that it is all too easy for a
2381`#` to end up at the beginning of a line by accident (perhaps through line
2382wrapping). Consider, for example:
2384 I like several of their flavors of ice cream:
2385 #22, for example, and #5.
2387#### Extension: `space_in_atx_header` ####
2389Many Markdown implementations do not require a space between the
2390opening `#`s of an ATX heading and the heading text, so that
2391`#5 bolt` and `#hashtag` count as headings. With this extension,
2392pandoc does require the space.
2394### Heading identifiers ###
2396See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2398#### Extension: `header_attributes` ####
2400Headings can be assigned attributes using this syntax at the end
2401of the line containing the heading text:
2403 {#identifier .class .class key=value key=value}
2405Thus, for example, the following headings will all be assigned the identifier
2410 ## My heading ## {#foo}
2412 My other heading {#foo}
2415(This syntax is compatible with [PHP Markdown Extra].)
2417Note that although this syntax allows assignment of classes and key/value
2418attributes, writers generally don't use all of this information. Identifiers,
2419classes, and key/value attributes are used in HTML and HTML-based formats such
2420as EPUB and slidy. Identifiers are used for labels and link anchors in the
2421LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2423Headings with the class `unnumbered` will not be numbered, even if
2424`--number-sections` is specified. A single hyphen (`-`) in an attribute
2425context is equivalent to `.unnumbered`, and preferable in non-English
2432 # My heading {.unnumbered}
2434#### Extension: `implicit_header_references` ####
2436Pandoc behaves as if reference links have been defined for each heading.
2437So, to link to a heading
2439 # Heading identifiers in HTML
2443 [Heading identifiers in HTML]
2447 [Heading identifiers in HTML][]
2451 [the section on heading identifiers][heading identifiers in
2454instead of giving the identifier explicitly:
2456 [Heading identifiers in HTML](#heading-identifiers-in-html)
2458If there are multiple headings with identical text, the corresponding
2459reference will link to the first one only, and you will need to use explicit
2460links to link to the others, as described above.
2462Like regular reference links, these references are case-insensitive.
2464Explicit link reference definitions always take priority over
2465implicit heading references. So, in the following example, the
2466link will point to `bar`, not to `#foo`:
2477Markdown uses email conventions for quoting blocks of text.
2478A block quotation is one or more paragraphs or other block elements
2479(such as lists or headings), with each line preceded by a `>` character
2480and an optional space. (The `>` need not start at the left margin, but
2481it should not be indented more than three spaces.)
2483 > This is a block quote. This
2484 > paragraph has two lines.
2486 > 1. This is a list inside a block quote.
2489A "lazy" form, which requires the `>` character only on the first
2490line of each block, is also allowed:
2492 > This is a block quote. This
2493 paragraph has two lines.
2495 > 1. This is a list inside a block quote.
2498Among the block elements that can be contained in a block quote are
2499other block quotes. That is, block quotes can be nested:
2501 > This is a block quote.
2503 > > A block quote within a block quote.
2505If the `>` character is followed by an optional space, that space
2506will be considered part of the block quote marker and not part of
2507the indentation of the contents. Thus, to put an indented code
2508block in a block quote, you need five spaces after the `>`:
2512#### Extension: `blank_before_blockquote` ####
2514Standard Markdown syntax does not require a blank line before a block
2515quote. Pandoc does require this (except, of course, at the beginning of the
2516document). The reason for the requirement is that it is all too easy for a
2517`>` to end up at the beginning of a line by accident (perhaps through line
2518wrapping). So, unless the `markdown_strict` format is used, the following does
2519not produce a nested block quote in pandoc:
2521 > This is a block quote.
2525Verbatim (code) blocks
2526----------------------
2528### Indented code blocks ###
2530A block of text indented four spaces (or one tab) is treated as verbatim
2531text: that is, special characters do not trigger special formatting,
2532and all spaces and line breaks are preserved. For example,
2535 moveShip(5 * gravity, DOWN);
2538The initial (four space or one tab) indentation is not considered part
2539of the verbatim text, and is removed in the output.
2541Note: blank lines in the verbatim text need not begin with four spaces.
2544### Fenced code blocks ###
2546#### Extension: `fenced_code_blocks` ####
2548In addition to standard indented code blocks, pandoc supports
2549*fenced* code blocks. These begin with a row of three or more
2550tildes (`~`) and end with a row of tildes that must be at least as long as
2551the starting row. Everything between these lines is treated as code. No
2552indentation is necessary:
2556 moveShip(5 * gravity, DOWN);
2560Like regular code blocks, fenced code blocks must be separated
2561from surrounding text by blank lines.
2563If the code itself contains a row of tildes or backticks, just use a longer
2564row of tildes or backticks at the start and end:
2568 code including tildes
2572#### Extension: `backtick_code_blocks` ####
2574Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
2577#### Extension: `fenced_code_attributes` ####
2579Optionally, you may attach attributes to fenced or backtick code block using
2582 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
2584 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
2585 qsort (filter (>= x) xs)
2586 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2588Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2589`startFrom` is an attribute with value `100`. Some output formats can use this
2590information to do syntax highlighting. Currently, the only output formats
2591that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2592highlighting is supported for your output format and language, then the code
2593block above will appear highlighted, with numbered lines. (To see which
2594languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2595the code block above will appear as follows:
2597 <pre id="mycode" class="haskell numberLines" startFrom="100">
2603The `numberLines` (or `number-lines`) class will cause the lines
2604of the code block to be numbered, starting with `1` or the value
2605of the `startFrom` attribute. The `lineAnchors` (or
2606`line-anchors`) class will cause the lines to be clickable
2607anchors in HTML output.
2609A shortcut form can also be used for specifying the language of
2616This is equivalent to:
2622If the `fenced_code_attributes` extension is disabled, but
2623input contains class attribute(s) for the code block, the first
2624class attribute will be printed after the opening fence as a bare
2627To prevent all highlighting, use the `--no-highlight` flag.
2628To set the highlighting style, use `--highlight-style`.
2629For more information on highlighting, see [Syntax highlighting],
2635#### Extension: `line_blocks` ####
2637A line block is a sequence of lines beginning with a vertical bar (`|`)
2638followed by a space. The division into lines will be preserved in
2639the output, as will any leading spaces; otherwise, the lines will
2640be formatted as Markdown. This is useful for verse and addresses:
2642 | The limerick packs laughs anatomical
2643 | In space that is quite economical.
2644 | But the good ones I've seen
2645 | So seldom are clean
2646 | And the clean ones so seldom are comical
2649 | Berkeley, CA 94718
2651The lines can be hard-wrapped if needed, but the continuation
2652line must begin with a space.
2654 | The Right Honorable Most Venerable and Righteous Samuel L.
2657 | Berkeley, CA 94718
2659This syntax is borrowed from [reStructuredText].
2666A bullet list is a list of bulleted list items. A bulleted list
2667item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2674This will produce a "compact" list. If you want a "loose" list, in which
2675each item is formatted as a paragraph, put spaces between the items:
2683The bullets need not be flush with the left margin; they may be
2684indented one, two, or three spaces. The bullet must be followed
2687List items look best if subsequent lines are flush with the first
2688line (after the bullet):
2694But Markdown also allows a "lazy" format:
2700### Block content in list items ###
2702A list item may contain multiple paragraphs and other block-level
2703content. However, subsequent paragraphs must be preceded by a blank line
2704and indented to line up with the first non-space content after
2711 * Second paragraph. With a code block, which must be indented
2716Exception: if the list marker is followed by an indented code
2717block, which must begin 5 spaces after the list marker, then
2718subsequent paragraphs must begin two columns after the last
2719character of the list marker:
2723 continuation paragraph
2725List items may include other lists. In this case the preceding blank
2726line is optional. The nested list must be indented to line up with
2727the first non-space character after the list marker of the
2728containing list item.
2740As noted above, Markdown allows you to write list items "lazily," instead of
2741indenting continuation lines. However, if there are multiple paragraphs or
2742other blocks in a list item, the first line of each must be indented.
2744 + A lazy, lazy, list
2747 + Another one; this looks
2750 Second paragraph of second
2753### Ordered lists ###
2755Ordered lists work just like bulleted lists, except that the items
2756begin with enumerators rather than bullets.
2758In standard Markdown, enumerators are decimal numbers followed
2759by a period and a space. The numbers themselves are ignored, so
2760there is no difference between this list:
2772#### Extension: `fancy_lists` ####
2774Unlike standard Markdown, pandoc allows ordered list items to be marked
2775with uppercase and lowercase letters and roman numerals, in addition to
2776Arabic numerals. List markers may be enclosed in parentheses or followed by a
2777single right-parentheses or period. They must be separated from the
2778text that follows by at least one space, and, if the list marker is a
2779capital letter with a period, by at least two spaces.[^2]
2781[^2]: The point of this rule is to ensure that normal paragraphs
2782 starting with people's initials, like
2784 B. Russell was an English philosopher.
2786 do not get treated as list items.
2788 This rule will not prevent
2792 from being interpreted as a list item. In this case, a backslash
2797The `fancy_lists` extension also allows '`#`' to be used as an
2798ordered list marker in place of a numeral:
2803#### Extension: `startnum` ####
2805Pandoc also pays attention to the type of list marker used, and to the
2806starting number, and both of these are preserved where possible in the
2807output format. Thus, the following yields a list with numbers followed
2808by a single parenthesis, starting with 9, and a sublist with lowercase
2818Pandoc will start a new list each time a different type of list
2819marker is used. So, the following will create three lists:
2826If default list markers are desired, use `#.`:
2832#### Extension: `task_lists` ####
2834Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
2836 - [ ] an unchecked task list item
2839### Definition lists ###
2841#### Extension: `definition_lists` ####
2843Pandoc supports definition lists, using the syntax of
2844[PHP Markdown Extra] with some extensions.[^3]
2850 Term 2 with *inline markup*
2854 { some code, part of Definition 2 }
2856 Third paragraph of definition 2.
2858Each term must fit on one line, which may optionally be followed by
2859a blank line, and must be followed by one or more definitions.
2860A definition begins with a colon or tilde, which may be indented one
2863A term may have multiple definitions, and each definition may consist of one or
2864more block elements (paragraph, code block, list, etc.), each indented four
2865spaces or one tab stop. The body of the definition (including the first line,
2866aside from the colon or tilde) should be indented four spaces. However,
2867as with other Markdown lists, you can "lazily" omit indentation except
2868at the beginning of a paragraph or other block element:
2873 with lazy continuation.
2875 Second paragraph of the definition.
2877If you leave space before the definition (as in the example above),
2878the text of the definition will be treated as a paragraph. In some
2879output formats, this will mean greater spacing between term/definition
2880pairs. For a more compact definition list, omit the space before the
2890Note that space between items in a definition list is required.
2891(A variant that loosens this requirement, but disallows "lazy"
2892hard wrapping, can be activated with `compact_definition_lists`: see
2893[Non-pandoc extensions], below.)
2895[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2897### Numbered example lists ###
2899#### Extension: `example_lists` ####
2901The special list marker `@` can be used for sequentially numbered
2902examples. The first list item with a `@` marker will be numbered '1',
2903the next '2', and so on, throughout the document. The numbered examples
2904need not occur in a single list; each new list using `@` will take up
2905where the last stopped. So, for example:
2907 (@) My first example will be numbered (1).
2908 (@) My second example will be numbered (2).
2910 Explanation of examples.
2912 (@) My third example will be numbered (3).
2914Numbered examples can be labeled and referred to elsewhere in the
2917 (@good) This is a good example.
2919 As (@good) illustrates, ...
2921The label can be any string of alphanumeric characters, underscores,
2924Note: continuation paragraphs in example lists must always
2925be indented four spaces, regardless of the length of the
2926list marker. That is, example lists always behave as if the
2927`four_space_rule` extension is set. This is because example
2928labels tend to be long, and indenting content to the
2929first non-space character after the label would be awkward.
2931### Compact and loose lists ###
2933Pandoc behaves differently from `Markdown.pl` on some "edge
2934cases" involving lists. Consider this source:
2944Pandoc transforms this into a "compact list" (with no `<p>` tags around
2945"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2946"Second" and "Third" (but not "First"), because of the blank space
2947around "Third". Pandoc follows a simple rule: if the text is followed by
2948a blank line, it is treated as a paragraph. Since "Second" is followed
2949by a list, and not a blank line, it isn't treated as a paragraph. The
2950fact that the list is followed by a blank line is irrelevant. (Note:
2951Pandoc works this way even when the `markdown_strict` format is specified. This
2952behavior is consistent with the official Markdown syntax description,
2953even though it is different from that of `Markdown.pl`.)
2956### Ending a list ###
2958What if you want to put an indented code block after a list?
2965Trouble! Here pandoc (like other Markdown implementations) will treat
2966`{ my code block }` as the second paragraph of item two, and not as
2969To "cut off" the list after item two, you can insert some non-indented
2970content, like an HTML comment, which won't produce visible output in
2976 <!-- end of list -->
2980You can use the same trick if you want two consecutive lists instead
2996A line containing a row of three or more `*`, `-`, or `_` characters
2997(optionally separated by spaces) produces a horizontal rule:
3007Four kinds of tables may be used. The first three kinds presuppose the use of
3008a fixed-width font, such as Courier. The fourth kind can be used with
3009proportionally spaced fonts, as it does not require lining up columns.
3011#### Extension: `table_captions` ####
3013A caption may optionally be provided with all 4 kinds of tables (as
3014illustrated in the examples below). A caption is a paragraph beginning
3015with the string `Table:` (or just `:`), which will be stripped off.
3016It may appear either before or after the table.
3018#### Extension: `simple_tables` ####
3020Simple tables look like this:
3022 Right Left Center Default
3023 ------- ------ ---------- -------
3028 Table: Demonstration of simple table syntax.
3030The header and table rows must each fit on one line. Column
3031alignments are determined by the position of the header text relative
3032to the dashed line below it:[^4]
3034 - If the dashed line is flush with the header text on the right side
3035 but extends beyond it on the left, the column is right-aligned.
3036 - If the dashed line is flush with the header text on the left side
3037 but extends beyond it on the right, the column is left-aligned.
3038 - If the dashed line extends beyond the header text on both sides,
3039 the column is centered.
3040 - If the dashed line is flush with the header text on both sides,
3041 the default alignment is used (in most cases, this will be left).
3043[^4]: This scheme is due to Michel Fortin, who proposed it on the
3044 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3046The table must end with a blank line, or a line of dashes followed by
3049The column header row may be omitted, provided a dashed line is used
3050to end the table. For example:
3052 ------- ------ ---------- -------
3056 ------- ------ ---------- -------
3058When the header row is omitted, column alignments are determined on the basis
3059of the first line of the table body. So, in the tables above, the columns
3060would be right, left, center, and right aligned, respectively.
3062#### Extension: `multiline_tables` ####
3064Multiline tables allow header and table rows to span multiple lines
3065of text (but cells that span multiple columns or rows of the table are
3066not supported). Here is an example:
3068 -------------------------------------------------------------
3069 Centered Default Right Left
3070 Header Aligned Aligned Aligned
3071 ----------- ------- --------------- -------------------------
3072 First row 12.0 Example of a row that
3073 spans multiple lines.
3075 Second row 5.0 Here's another one. Note
3076 the blank line between
3078 -------------------------------------------------------------
3080 Table: Here's the caption. It, too, may span
3083These work like simple tables, but with the following differences:
3085 - They must begin with a row of dashes, before the header text
3086 (unless the header row is omitted).
3087 - They must end with a row of dashes, then a blank line.
3088 - The rows must be separated by blank lines.
3090In multiline tables, the table parser pays attention to the widths of
3091the columns, and the writers try to reproduce these relative widths in
3092the output. So, if you find that one of the columns is too narrow in the
3093output, try widening it in the Markdown source.
3095The header may be omitted in multiline tables as well as simple tables:
3097 ----------- ------- --------------- -------------------------
3098 First row 12.0 Example of a row that
3099 spans multiple lines.
3101 Second row 5.0 Here's another one. Note
3102 the blank line between
3104 ----------- ------- --------------- -------------------------
3106 : Here's a multiline table without a header.
3108It is possible for a multiline table to have just one row, but the row
3109should be followed by a blank line (and then the row of dashes that ends
3110the table), or the table may be interpreted as a simple table.
3112#### Extension: `grid_tables` ####
3114Grid tables look like this:
3116 : Sample grid table.
3118 +---------------+---------------+--------------------+
3119 | Fruit | Price | Advantages |
3120 +===============+===============+====================+
3121 | Bananas | $1.34 | - built-in wrapper |
3122 | | | - bright color |
3123 +---------------+---------------+--------------------+
3124 | Oranges | $2.10 | - cures scurvy |
3126 +---------------+---------------+--------------------+
3128The row of `=`s separates the header from the table body, and can be
3129omitted for a headerless table. The cells of grid tables may contain
3130arbitrary block elements (multiple paragraphs, code blocks, lists,
3131etc.). Cells that span multiple columns or rows are not
3132supported. Grid tables can be created easily using [Emacs table mode].
3134[Emacs table mode]: http://table.sourceforge.net/
3136Alignments can be specified as with pipe tables, by putting
3137colons at the boundaries of the separator line after the
3140 +---------------+---------------+--------------------+
3141 | Right | Left | Centered |
3142 +==============:+:==============+:==================:+
3143 | Bananas | $1.34 | built-in wrapper |
3144 +---------------+---------------+--------------------+
3146For headerless tables, the colons go on the top line instead:
3148 +--------------:+:--------------+:------------------:+
3149 | Right | Left | Centered |
3150 +---------------+---------------+--------------------+
3152##### Grid Table Limitations #####
3154Pandoc does not support grid tables with row spans or column spans.
3155This means that neither variable numbers of columns across rows nor
3156variable numbers of rows across columns are supported by Pandoc.
3157All grid tables must have the same number of columns in each row,
3158and the same number of rows in each column. For example, the
3159Docutils [sample grid tables] will not render as expected with
3162[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3165#### Extension: `pipe_tables` ####
3167Pipe tables look like this:
3169 | Right | Left | Default | Center |
3170 |------:|:-----|---------|:------:|
3171 | 12 | 12 | 12 | 12 |
3172 | 123 | 123 | 123 | 123 |
3175 : Demonstration of pipe table syntax.
3177The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3178ending pipe characters are optional, but pipes are required between all
3179columns. The colons indicate column alignment as shown. The header
3180cannot be omitted. To simulate a headerless table, include a header
3183Since the pipes indicate column boundaries, columns need not be vertically
3184aligned, as they are in the above example. So, this is a perfectly
3185legal (though ugly) pipe table:
3193The cells of pipe tables cannot contain block elements like paragraphs
3194and lists, and cannot span multiple lines. If a pipe table contains a
3195row whose printable content is wider than the column width (see
3196`--columns`), then the table will take up the full text width and
3197the cell contents will wrap, with the relative cell widths determined
3198by the number of dashes in the line separating the table header from
3199the table body. (For example `---|-` would make the first column 3/4
3200and the second column 1/4 of the full text width.)
3201On the other hand, if no lines are wider than column width, then
3202cell contents will not be wrapped, and the cells will be sized
3205Note: pandoc also recognizes pipe tables of the following
3206form, as can be produced by Emacs' orgtbl-mode:
3213The difference is that `+` is used instead of `|`. Other orgtbl features
3214are not supported. In particular, to get non-default column alignment,
3215you'll need to add colons as above.
3217[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3222#### Extension: `pandoc_title_block` ####
3224If the file begins with a title block
3227 % author(s) (separated by semicolons)
3230it will be parsed as bibliographic information, not regular text. (It
3231will be used, for example, in the title of standalone LaTeX or HTML
3232output.) The block may contain just a title, a title and an author,
3233or all three elements. If you want to include an author but no
3234title, or a title and a date but no author, you need a blank line:
3243The title may occupy multiple lines, but continuation lines must
3244begin with leading space, thus:
3249If a document has multiple authors, the authors may be put on
3250separate lines with leading space, or separated by semicolons, or
3251both. So, all of the following are equivalent:
3256 % Author One; Author Two
3261The date must fit on one line.
3263All three metadata fields may contain standard inline formatting
3264(italics, links, footnotes, etc.).
3266Title blocks will always be parsed, but they will affect the output only
3267when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3268will appear twice: once in the document head -- this is the title that
3269will appear at the top of the window in a browser -- and once at the
3270beginning of the document body. The title in the document head can have
3271an optional prefix attached (`--title-prefix` or `-T` option). The title
3272in the body appears as an H1 element with class "title", so it can be
3273suppressed or reformatted with CSS. If a title prefix is specified with
3274`-T` and no title block appears in the document, the title prefix will
3275be used by itself as the HTML title.
3277The man page writer extracts a title, man page section number, and
3278other header and footer information from the title line. The title
3279is assumed to be the first word on the title line, which may optionally
3280end with a (single-digit) section number in parentheses. (There should
3281be no space between the title and the parentheses.) Anything after
3282this is assumed to be additional footer and header text. A single pipe
3283character (`|`) should be used to separate the footer text from the header
3288will yield a man page with the title `PANDOC` and section 1.
3290 % PANDOC(1) Pandoc User Manuals
3292will also have "Pandoc User Manuals" in the footer.
3294 % PANDOC(1) Pandoc User Manuals | Version 4.0
3296will also have "Version 4.0" in the header.
3298#### Extension: `yaml_metadata_block` ####
3300A YAML metadata block is a valid YAML object, delimited by a line of three
3301hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3302(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3303document, but if it is not at the beginning, it must be preceded by a blank
3304line. (Note that, because of the way pandoc concatenates input files when
3305several are provided, you may also keep the metadata in a separate YAML file
3306and pass it to pandoc as an argument, along with your Markdown files:
3308 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3310Just be sure that the YAML file begins with `---` and ends with `---` or
3311`...`.) Alternatively, you can use the `--metadata-file` option. Using
3312that approach however, you cannot reference content (like footnotes)
3313from the main markdown input document.
3315Metadata will be taken from the fields of the YAML object and added to any
3316existing document metadata. Metadata can contain lists and objects (nested
3317arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3318with names ending in an underscore will be ignored by pandoc. (They may be
3319given a role by external processors.) Field names must not be
3320interpretable as YAML numbers or boolean values (so, for
3321example, `yes`, `True`, and `15` cannot be used as field names).
3323A document may contain multiple metadata blocks. The metadata fields will
3324be combined through a *left-biased union*: if two metadata blocks attempt
3325to set the same field, the value from the first block will be taken.
3327When pandoc is used with `-t markdown` to create a Markdown document,
3328a YAML metadata block will be produced only if the `-s/--standalone`
3329option is used. All of the metadata will appear in a single block
3330at the beginning of the document.
3332Note that YAML escaping rules must be followed. Thus, for example,
3333if a title contains a colon, it must be quoted. The pipe character
3334(`|`) can be used to begin an indented block that will be interpreted
3335literally, without need for escaping. This form is necessary
3336when the field contains blank lines or block-level formatting:
3339 title: 'This is the title: it contains a colon'
3343 keywords: [nothing, nothingness]
3345 This is the abstract.
3347 It consists of two paragraphs.
3350Template variables will be set automatically from the metadata. Thus, for
3351example, in writing HTML, the variable `abstract` will be set to the HTML
3352equivalent of the Markdown in the `abstract` field:
3354 <p>This is the abstract.</p>
3355 <p>It consists of two paragraphs.</p>
3357Variables can contain arbitrary YAML structures, but the template must match
3358this structure. The `author` variable in the default templates expects a
3359simple list or string, but can be changed to support more complicated
3360structures. The following combination, for example, would add an affiliation
3361to the author if one is given:
3364 title: The document title
3367 affiliation: University of Somewhere
3369 affiliation: University of Nowhere
3372To use the structured authors in the example above, you would need a custom
3377 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3383Raw content to include in the document's header may be specified
3384using `header-includes`; however, it is important to mark up
3385this content as raw code for a particular output format, using
3386the [`raw_attribute` extension](#extension-raw_attribute)), or it
3387will be interpreted as markdown. For example:
3392 \let\oldsection\section
3393 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3399#### Extension: `all_symbols_escapable` ####
3401Except inside a code block or inline code, any punctuation or space
3402character preceded by a backslash will be treated literally, even if it
3403would normally indicate formatting. Thus, for example, if one writes
3413 <strong>hello</strong>
3415This rule is easier to remember than standard Markdown's rule,
3416which allows only the following characters to be backslash-escaped:
3420(However, if the `markdown_strict` format is used, the standard Markdown rule
3423A backslash-escaped space is parsed as a nonbreaking space. It will
3424appear in TeX output as `~` and in HTML and XML as `\ ` or
3427A backslash-escaped newline (i.e. a backslash occurring at the end of
3428a line) is parsed as a hard line break. It will appear in TeX output as
3429`\\` and in HTML as `<br />`. This is a nice alternative to
3430Markdown's "invisible" way of indicating hard line breaks using
3431two trailing spaces on a line.
3433Backslash escapes do not work in verbatim contexts.
3440To *emphasize* some text, surround it with `*`s or `_`, like this:
3442 This text is _emphasized with underscores_, and this
3443 is *emphasized with asterisks*.
3445Double `*` or `_` produces **strong emphasis**:
3447 This is **strong emphasis** and __with underscores__.
3449A `*` or `_` character surrounded by spaces, or backslash-escaped,
3450will not trigger emphasis:
3452 This is * not emphasized *, and \*neither is this\*.
3454#### Extension: `intraword_underscores` ####
3456Because `_` is sometimes used inside words and identifiers,
3457pandoc does not interpret a `_` surrounded by alphanumeric
3458characters as an emphasis marker. If you want to emphasize
3459just part of a word, use `*`:
3461 feas*ible*, not feas*able*.
3466#### Extension: `strikeout` ####
3468To strikeout a section of text with a horizontal line, begin and end it
3469with `~~`. Thus, for example,
3471 This ~~is deleted text.~~
3474### Superscripts and subscripts ###
3476#### Extension: `superscript`, `subscript` ####
3478Superscripts may be written by surrounding the superscripted text by `^`
3479characters; subscripts may be written by surrounding the subscripted
3480text by `~` characters. Thus, for example,
3482 H~2~O is a liquid. 2^10^ is 1024.
3484If the superscripted or subscripted text contains spaces, these spaces
3485must be escaped with backslashes. (This is to prevent accidental
3486superscripting and subscripting through the ordinary use of `~` and `^`.)
3487Thus, if you want the letter P with 'a cat' in subscripts, use
3488`P~a\ cat~`, not `P~a cat~`.
3493To make a short span of text verbatim, put it inside backticks:
3495 What is the difference between `>>=` and `>>`?
3497If the verbatim text includes a backtick, use double backticks:
3499 Here is a literal backtick `` ` ``.
3501(The spaces after the opening backticks and before the closing
3502backticks will be ignored.)
3504The general rule is that a verbatim span starts with a string
3505of consecutive backticks (optionally followed by a space)
3506and ends with a string of the same number of backticks (optionally
3507preceded by a space).
3509Note that backslash-escapes (and other Markdown constructs) do not
3510work in verbatim contexts:
3512 This is a backslash followed by an asterisk: `\*`.
3514#### Extension: `inline_code_attributes` ####
3516Attributes can be attached to verbatim text, just as with
3517[fenced code blocks]:
3523To write small caps, use the `smallcaps` class:
3525 [Small caps]{.smallcaps}
3527Or, without the `bracketed_spans` extension:
3529 <span class="smallcaps">Small caps</span>
3531For compatibility with other Markdown flavors, CSS is also supported:
3533 <span style="font-variant:small-caps;">Small caps</span>
3535This will work in all output formats that support small caps.
3541#### Extension: `tex_math_dollars` ####
3543Anything between two `$` characters will be treated as TeX math. The
3544opening `$` must have a non-space character immediately to its right,
3545while the closing `$` must have a non-space character immediately to its
3546left, and must not be followed immediately by a digit. Thus,
3547`$20,000 and $30,000` won't parse as math. If for some reason
3548you need to enclose text in literal `$` characters, backslash-escape
3549them and they won't be treated as math delimiters.
3551TeX math will be printed in all output formats. How it is rendered
3552depends on the output format:
3555 ~ It will appear verbatim surrounded by `\(...\)` (for inline
3556 math) or `\[...\]` (for display math).
3558Markdown, Emacs Org mode, ConTeXt, ZimWiki
3559 ~ It will appear verbatim surrounded by `$...$` (for inline
3560 math) or `$$...$$` (for display math).
3563 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
3566 ~ It will be rendered using an [interpreted text role `:math:`].
3569 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
3570 surrounded by `latexmath:[$...$]` (for inline math) or
3571 `[latexmath]++++\[...\]+++` (for display math).
3572 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
3573 (`$..$` and `\[..\]`) are omitted.
3576 ~ It will be rendered inside a `@math` command.
3579 ~ It will be rendered verbatim without `$`'s.
3582 ~ It will be rendered inside `<math>` tags.
3585 ~ It will be rendered inside `<span class="math">` tags.
3588 ~ It will be rendered, if possible, using Unicode characters,
3589 and will otherwise appear verbatim.
3592 ~ It will be rendered, if possible, using MathML.
3595 ~ If the `--mathml` flag is used, it will be rendered using MathML
3596 in an `inlineequation` or `informalequation` tag. Otherwise it
3597 will be rendered, if possible, using Unicode characters.
3600 ~ It will be rendered using OMML math markup.
3603 ~ If the `--webtex` option is used, formulas are rendered as images
3604 using CodeCogs or other compatible web service, downloaded
3605 and embedded in the e-book. Otherwise, they will appear verbatim.
3607HTML, Slidy, DZSlides, S5, EPUB
3608 ~ The way math is rendered in HTML will depend on the
3609 command-line options selected. Therefore see [Math rendering in HTML]
3612[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3617#### Extension: `raw_html` ####
3619Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
3620(except verbatim contexts, where `<`, `>`, and `&` are interpreted
3621literally). (Technically this is not an extension, since standard
3622Markdown allows it, but it has been made an extension so that it can
3623be disabled if desired.)
3625The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3626DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3627output, and suppressed in other formats.
3629For a more explicit way of including raw HTML in a Markdown
3630document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
3632In the CommonMark format, if `raw_html` is enabled, superscripts,
3633subscripts, strikeouts and small capitals will be represented as HTML.
3634Otherwise, plain-text fallbacks will be used. Note that even if
3635`raw_html` is disabled, tables will be rendered with HTML syntax if
3636they cannot use pipe syntax.
3638#### Extension: `markdown_in_html_blocks` ####
3640Standard Markdown allows you to include HTML "blocks": blocks
3641of HTML between balanced tags that are separated from the surrounding text
3642with blank lines, and start and end at the left margin. Within
3643these blocks, everything is interpreted as HTML, not Markdown;
3644so (for example), `*` does not signify emphasis.
3646Pandoc behaves this way when the `markdown_strict` format is used; but
3647by default, pandoc interprets material between HTML block tags as Markdown.
3648Thus, for example, pandoc will turn
3653 <td>[a link](http://google.com)</td>
3661 <td><em>one</em></td>
3662 <td><a href="http://google.com">a link</a></td>
3666whereas `Markdown.pl` will preserve it as is.
3668There is one exception to this rule: text between `<script>` and
3669`<style>` tags is not interpreted as Markdown.
3671This departure from standard Markdown should make it easier to mix
3672Markdown with HTML block elements. For example, one can surround
3673a block of Markdown text with `<div>` tags without preventing it
3674from being interpreted as Markdown.
3676#### Extension: `native_divs` ####
3678Use native pandoc `Div` blocks for content inside `<div>` tags.
3679For the most part this should give the same output as
3680`markdown_in_html_blocks`, but it makes it easier to write pandoc
3681filters to manipulate groups of blocks.
3683#### Extension: `native_spans` ####
3685Use native pandoc `Span` blocks for content inside `<span>` tags.
3686For the most part this should give the same output as `raw_html`,
3687but it makes it easier to write pandoc filters to manipulate groups
3690#### Extension: `raw_tex` ####
3692In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3693included in a document. Inline TeX commands will be preserved and passed
3694unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3695LaTeX to include BibTeX citations:
3697 This result was proved in \cite{jones.1967}.
3699Note that in LaTeX environments, like
3701 \begin{tabular}{|l|l|}\hline
3702 Age & Frequency \\ \hline
3705 36--45 & 22 \\ \hline
3708the material between the begin and end tags will be interpreted as raw
3709LaTeX, not as Markdown.
3711For a more explicit and flexible way of including raw TeX in a
3712Markdown document, see the [`raw_attribute`
3713extension][Extension: `raw_attribute`].
3715Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3716Emacs Org mode, and ConTeXt.
3718### Generic raw attribute ###
3720#### Extension: `raw_attribute` ####
3722Inline spans and fenced code blocks with a special
3723kind of attribute will be parsed as raw content with the
3724designated format. For example, the following produces a raw
3731And the following produces a raw `html` inline element:
3733 This is `<a>html</a>`{=html}
3735This can be useful to insert raw xml into `docx` documents, e.g.
3741 <w:br w:type="page"/>
3746The format name should match the target format name (see
3747`-t/--to`, above, for a list, or use `pandoc
3748--list-output-formats`). Use `openxml` for `docx` output,
3749`opendocument` for `odt` output, `html5` for `epub3` output,
3750`html4` for `epub2` output, and `latex`, `beamer`,
3751`ms`, or `html5` for `pdf` output (depending on what you
3752use for `--pdf-engine`).
3754This extension presupposes that the relevant kind of
3755inline code or fenced code block is enabled. Thus, for
3756example, to use a raw attribute with a backtick code block,
3757`backtick_code_blocks` must be enabled.
3759The raw attribute cannot be combined with regular attributes.
3764#### Extension: `latex_macros` ####
3766When this extension is enabled, pandoc will parse LaTeX
3767macro definitions and apply the resulting macros to all LaTeX
3768math and raw LaTeX. So, for example, the following will work in
3769all output formats, not just LaTeX:
3771 \newcommand{\tuple}[1]{\langle #1 \rangle}
3775Note that LaTeX macros will not be applied if they occur
3776inside inside a raw span or block marked with the
3777[`raw_attribute` extension](#extension-raw_attribute).
3779When `latex_macros` is disabled, the raw LaTeX and math will
3780not have macros applied. This is usually a better approach when
3781you are targeting LaTeX or PDF.
3783Whether or not `latex_macros` is enabled, the macro definitions
3784will still be passed through as raw LaTeX.
3789Markdown allows links to be specified in several ways.
3791### Automatic links ###
3793If you enclose a URL or email address in pointy brackets, it
3797 <sam@green.eggs.ham>
3801An inline link consists of the link text in square brackets,
3802followed by the URL in parentheses. (Optionally, the URL can
3803be followed by a link title, in quotes.)
3805 This is an [inline link](/url), and here's [one with
3806 a title](http://fsf.org "click here for a good time!").
3808There can be no space between the bracketed part and the parenthesized part.
3809The link text can contain formatting (such as emphasis), but the title cannot.
3811Email addresses in inline links are not autodetected, so they have to be
3812prefixed with `mailto`:
3814 [Write me!](mailto:sam@green.eggs.ham)
3816### Reference links ###
3818An *explicit* reference link has two parts, the link itself and the link
3819definition, which may occur elsewhere in the document (either
3820before or after the link).
3822The link consists of link text in square brackets, followed by a label in
3823square brackets. (There cannot be space between the two unless the
3824`spaced_reference_links` extension is enabled.) The link definition
3825consists of the bracketed label, followed by a colon and a space, followed by
3826the URL, and optionally (after a space) a link title either in quotes or in
3827parentheses. The label must not be parseable as a citation (assuming
3828the `citations` extension is enabled): citations take precedence over
3831Here are some examples:
3833 [my label 1]: /foo/bar.html "My title, optional"
3835 [my label 3]: http://fsf.org (The free software foundation)
3836 [my label 4]: /bar#special 'A title in single quotes'
3838The URL may optionally be surrounded by angle brackets:
3840 [my label 5]: <http://foo.bar.baz>
3842The title may go on the next line:
3844 [my label 3]: http://fsf.org
3845 "The free software foundation"
3847Note that link labels are not case sensitive. So, this will work:
3849 Here is [my link][FOO]
3853In an *implicit* reference link, the second pair of brackets is
3858 [my website]: http://foo.bar.baz
3860Note: In `Markdown.pl` and most other Markdown implementations,
3861reference link definitions cannot occur in nested constructions
3862such as list items or block quotes. Pandoc lifts this arbitrary
3863seeming restriction. So the following is fine in pandoc, though
3864not in most other implementations:
3870#### Extension: `shortcut_reference_links` ####
3872In a *shortcut* reference link, the second pair of brackets may
3877 [my website]: http://foo.bar.baz
3879### Internal links ###
3881To link to another section of the same document, use the automatically
3882generated identifier (see [Heading identifiers]). For example:
3884 See the [Introduction](#introduction).
3888 See the [Introduction].
3890 [Introduction]: #introduction
3892Internal links are currently supported for HTML formats (including
3893HTML slide shows and EPUB), LaTeX, and ConTeXt.
3898A link immediately preceded by a `!` will be treated as an image.
3899The link text will be used as the image's alt text:
3901 
3905 [movie reel]: movie.gif
3907#### Extension: `implicit_figures` ####
3909An image with nonempty alt text, occurring by itself in a
3910paragraph, will be rendered as a figure with a caption. The
3911image's alt text will be used as the caption.
3913 
3915How this is rendered depends on the output format. Some output
3916formats (e.g. RTF) do not yet support figures. In those
3917formats, you'll just get an image in a paragraph by itself, with
3920If you just want a regular inline image, just make sure it is not
3921the only thing in the paragraph. One way to do this is to insert a
3922nonbreaking space after the image:
3924 \
3926Note that in reveal.js slide shows, an image in a paragraph
3927by itself that has the `stretch` class will fill the screen,
3928and the caption and figure tags will be omitted.
3930#### Extension: `link_attributes` ####
3932Attributes can be set on links and images:
3934 An inline {#id .class width=30 height=20px}
3935 and a reference ![image][ref] with attributes.
3937 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3939(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3940and `.class` are used.)
3942For HTML and EPUB, all attributes except `width` and `height` (but
3943including `srcset` and `sizes`) are passed through as is. The other
3944writers ignore attributes that are not supported by their output
3947The `width` and `height` attributes on images are treated specially. When
3948used without a unit, the unit is assumed to be pixels. However, any of
3949the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3950and `%`. There must not be any spaces between the number and the unit.
3954{ width=50% }
3957- Dimensions are converted to inches for output in page-based formats like
3958 LaTeX. Dimensions are converted to pixels for output in HTML-like
3959 formats. Use the `--dpi` option to specify the number of pixels per
3960 inch. The default is 96dpi.
3961- The `%` unit is generally relative to some available space.
3962 For example the above example will render to the following.
3963 - HTML: `<img href="file.jpg" style="width: 50%;" />`
3964 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
3965 (If you're using a custom template, you need to configure `graphicx`
3966 as in the default template.)
3967 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3968- Some output formats have a notion of a class
3969 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3970 or a unique identifier (LaTeX `\caption`), or both (HTML).
3971- When no `width` or `height` attributes are specified, the fallback
3972 is to look at the image resolution and the dpi metadata embedded in
3978Using the `native_divs` and `native_spans` extensions
3979(see [above][Extension: `native_divs`]), HTML syntax can
3980be used as part of markdown to create native `Div` and `Span`
3981elements in the pandoc AST (as opposed to raw HTML).
3982However, there is also nicer syntax available:
3984#### Extension: `fenced_divs` ####
3986Allow special fenced syntax for native `Div` blocks. A Div
3987starts with a fence containing at least three consecutive
3988colons plus some attributes. The attributes may optionally
3989be followed by another string of consecutive colons.
3990The attribute syntax is exactly as in fenced code blocks (see
3991[Extension: `fenced_code_attributes`]). As with fenced
3992code blocks, one can use either attributes in curly braces
3993or a single unbraced word, which will be treated as a class
3994name. The Div ends with another line containing a string of at
3995least three consecutive colons. The fenced Div should be
3996separated by blank lines from preceding and following blocks.
4000 ::::: {#special .sidebar}
4001 Here is a paragraph.
4006Fenced divs can be nested. Opening fences are distinguished
4007because they *must* have attributes:
4013 This is a warning within a warning.
4017Fences without attributes are always closing fences. Unlike
4018with fenced code blocks, the number of colons in the closing
4019fence need not match the number in the opening fence. However,
4020it can be helpful for visual clarity to use fences of different
4021lengths to distinguish nested divs from their parents.
4024#### Extension: `bracketed_spans` ####
4026A bracketed sequence of inlines, as one would use to begin
4027a link, will be treated as a `Span` with attributes if it is
4028followed immediately by attributes:
4030 [This is *some text*]{.class key="val"}
4035#### Extension: `footnotes` ####
4037Pandoc's Markdown allows footnotes, using the following syntax:
4039 Here is a footnote reference,[^1] and another.[^longnote]
4041 [^1]: Here is the footnote.
4043 [^longnote]: Here's one with multiple blocks.
4045 Subsequent paragraphs are indented to show that they
4046 belong to the previous footnote.
4050 The whole paragraph can be indented, or just the first
4051 line. In this way, multi-paragraph footnotes work like
4052 multi-paragraph list items.
4054 This paragraph won't be part of the note, because it
4057The identifiers in footnote references may not contain spaces, tabs,
4058or newlines. These identifiers are used only to correlate the
4059footnote reference with the note itself; in the output, footnotes
4060will be numbered sequentially.
4062The footnotes themselves need not be placed at the end of the
4063document. They may appear anywhere except inside other block elements
4064(lists, block quotes, tables, etc.). Each footnote should be
4065separated from surrounding content (including other footnotes)
4068#### Extension: `inline_notes` ####
4070Inline footnotes are also allowed (though, unlike regular notes,
4071they cannot contain multiple paragraphs). The syntax is as follows:
4073 Here is an inline note.^[Inlines notes are easier to write, since
4074 you don't have to pick an identifier and move down to type the
4077Inline and regular footnotes may be mixed freely.
4082#### Extension: `citations` ####
4084Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4085citations and a bibliography in a number of styles. Basic usage is
4087 pandoc --filter pandoc-citeproc myinput.txt
4089In order to use this feature, you will need to specify a bibliography file
4090using the `bibliography` metadata field in a YAML metadata section, or
4091`--bibliography` command line argument. You can supply multiple `--bibliography`
4092arguments or set `bibliography` metadata field to YAML array, if you want to
4093use multiple bibliography files. The bibliography may have any of these
4096 Format File extension
4097 ------------ --------------
4110Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4111use `.bibtex` to force BibTeX.
4113Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4114can produce `.json` and `.yaml` files from any of the supported formats.
4116In-field markup: In BibTeX and BibLaTeX databases,
4117pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4118databases, pandoc Markdown; and in CSL JSON databases, an
4119[HTML-like markup][CSL markup specs]:
4127`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4136`<span class="nocase">...</span>`
4137: prevent a phrase from being capitalized as title case
4139`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4140and CSL YAML formats as far as possible.
4142As an alternative to specifying a bibliography file using `--bibliography`
4143or the YAML metadata field `bibliography`, you can include
4144the citation data directly in the `references` field of the
4145document's YAML metadata. The field should contain an array of
4146YAML-encoded references, for example:
4150 - type: article-journal
4162 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4164 title-short: Molecular structure of nucleic acids
4165 container-title: Nature
4169 DOI: 10.1038/171737a0
4170 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4174(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4175of the supported formats.)
4177Citations and references can be formatted using any style supported by the
4178[Citation Style Language], listed in the [Zotero Style Repository].
4179These files are specified using the `--csl` option or the `csl` metadata field.
4180By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4181format. The CSL project provides further information on [finding and editing styles].
4183To make your citations hyperlinks to the corresponding bibliography
4184entries, add `link-citations: true` to your YAML metadata.
4186Citations go inside square brackets and are separated by semicolons.
4187Each citation must have a key, composed of '@' + the citation
4188identifier from the database, and may optionally have a prefix,
4189a locator, and a suffix. The citation key must begin with a letter, digit,
4190or `_`, and may contain alphanumerics, `_`, and internal punctuation
4191characters (`:.#$%&-+?<>~/`). Here are some examples:
4193 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4195 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4197 Blah blah [@smith04; @doe99].
4199`pandoc-citeproc` detects locator terms in the [CSL locale files].
4200Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4201locale, locator terms can be written in either singular or plural forms,
4202as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4203`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4204`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4205`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4206`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4207`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4208locator term is used, "page" is assumed.
4210`pandoc-citeproc` will use heuristics to distinguish the locator
4211from the suffix. In complex cases, the locator can be enclosed
4212in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4214 [@smith{ii, A, D-Z}, with a suffix]
4215 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4217A minus sign (`-`) before the `@` will suppress mention of
4218the author in the citation. This can be useful when the
4219author is already mentioned in the text:
4221 Smith says blah [-@smith04].
4223You can also write an in-text citation, as follows:
4227 @smith04 [p. 33] says blah.
4229If the style calls for a list of works cited, it will be placed
4230in a div with id `refs`, if one exists:
4235Otherwise, it will be placed at the end of the document.
4236Generation of the bibliography can be suppressed by setting
4237`suppress-bibliography: true` in the YAML metadata.
4239If you wish the bibliography to have a section heading, you can
4240set `reference-section-title` in the metadata, or put the heading
4241at the beginning of the div with id `refs` (if you are using it)
4242or at the end of your document:
4248The bibliography will be inserted after this heading. Note that
4249the `unnumbered` class will be added to this heading, so that the
4250section will not be numbered.
4252If you want to include items in the bibliography without actually
4253citing them in the body text, you can define a dummy `nocite` metadata
4254field and put the citations there:
4263In this example, the document will contain a citation for `item3`
4264only, but the bibliography will contain entries for `item1`, `item2`, and
4267It is possible to create a bibliography with all the citations,
4268whether or not they appear in the document, by using a wildcard:
4275For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4276render the bibliography. In order to do so, specify bibliography
4277files as outlined above, and add `--natbib` or `--biblatex`
4278argument to `pandoc` invocation. Bear in mind that bibliography
4279files have to be in respective format (either BibTeX or
4282For more information, see the [pandoc-citeproc man page].
4284[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4285[Chicago Manual of Style]: http://chicagomanualofstyle.org
4286[Citation Style Language]: http://citationstyles.org
4287[Zotero Style Repository]: https://www.zotero.org/styles
4288[finding and editing styles]: https://citationstyles.org/authors/
4289[CSL locale files]: https://github.com/citation-style-language/locales
4290[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4292Non-pandoc extensions
4293---------------------
4295The following Markdown syntax extensions are not enabled by default
4296in pandoc, but may be enabled by adding `+EXTENSION` to the format
4297name, where `EXTENSION` is the name of the extension. Thus, for
4298example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4300#### Extension: `old_dashes` ####
4302Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4303`-` before a numeral is an en-dash, and `--` is an em-dash.
4304This option only has an effect if `smart` is enabled. It is
4305selected automatically for `textile` input.
4307#### Extension: `angle_brackets_escapable` ####
4309Allow `<` and `>` to be backslash-escaped, as they can be in
4310GitHub flavored Markdown but not original Markdown. This is
4311implied by pandoc's default `all_symbols_escapable`.
4313#### Extension: `lists_without_preceding_blankline` ####
4315Allow a list to occur right after a paragraph, with no intervening
4318#### Extension: `four_space_rule` ####
4320Selects the pandoc <= 2.0 behavior for parsing lists, so that
4321four spaces indent are needed for list item continuation
4324#### Extension: `spaced_reference_links` ####
4326Allow whitespace between the two components of a reference link,
4331#### Extension: `hard_line_breaks` ####
4333Causes all newlines within a paragraph to be interpreted as hard line
4334breaks instead of spaces.
4336#### Extension: `ignore_line_breaks` ####
4338Causes newlines within a paragraph to be ignored, rather than being
4339treated as spaces or as hard line breaks. This option is intended for
4340use with East Asian languages where spaces are not used between words,
4341but text is divided into lines for readability.
4343#### Extension: `east_asian_line_breaks` ####
4345Causes newlines within a paragraph to be ignored, rather than
4346being treated as spaces or as hard line breaks, when they occur
4347between two East Asian wide characters. This is a better choice
4348than `ignore_line_breaks` for texts that include a mix of East
4349Asian wide characters and other characters.
4351#### Extension: `emoji` ####
4353Parses textual emojis like `:smile:` as Unicode emoticons.
4355#### Extension: `tex_math_single_backslash` ####
4357Causes anything between `\(` and `\)` to be interpreted as inline
4358TeX math, and anything between `\[` and `\]` to be interpreted
4359as display TeX math. Note: a drawback of this extension is that
4360it precludes escaping `(` and `[`.
4362#### Extension: `tex_math_double_backslash` ####
4364Causes anything between `\\(` and `\\)` to be interpreted as inline
4365TeX math, and anything between `\\[` and `\\]` to be interpreted
4368#### Extension: `markdown_attribute` ####
4370By default, pandoc interprets material inside block-level tags as Markdown.
4371This extension changes the behavior so that Markdown is only parsed
4372inside block-level tags if the tags have the attribute `markdown=1`.
4374#### Extension: `mmd_title_block` ####
4376Enables a [MultiMarkdown] style title block at the top of
4377the document, for example:
4381 Date: September 1, 2008
4382 Comment: This is a sample mmd title block, with
4383 a field spanning multiple lines.
4385See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4386`yaml_metadata_block` is enabled, it will take precedence over
4389#### Extension: `abbreviations` ####
4391Parses PHP Markdown Extra abbreviation keys, like
4393 *[HTML]: Hypertext Markup Language
4395Note that the pandoc document model does not support
4396abbreviations, so if this extension is enabled, abbreviation keys are
4397simply skipped (as opposed to being parsed as paragraphs).
4399#### Extension: `autolink_bare_uris` ####
4401Makes all absolute URIs into links, even when not surrounded by
4402pointy braces `<...>`.
4404#### Extension: `mmd_link_attributes` ####
4406Parses multimarkdown style key-value attributes on link
4407and image references. This extension should not be confused with the
4408[`link_attributes`](#extension-link_attributes) extension.
4410 This is a reference ![image][ref] with multimarkdown attributes.
4412 [ref]: http://path.to/image "Image title" width=20px height=30px
4413 id=myId class="myClass1 myClass2"
4415#### Extension: `mmd_header_identifiers` ####
4417Parses multimarkdown style heading identifiers (in square brackets,
4418after the heading but before any trailing `#`s in an ATX heading).
4420#### Extension: `compact_definition_lists` ####
4422Activates the definition list syntax of pandoc 1.12.x and earlier.
4423This syntax differs from the one described above under [Definition lists]
4426 - No blank line is required between consecutive items of the
4428 - To get a "tight" or "compact" list, omit space between consecutive
4429 items; the space between a term and its definition does not affect
4431 - Lazy wrapping of paragraphs is not allowed: the entire definition must
4432 be indented four spaces.[^6]
4434[^6]: To see why laziness is incompatible with relaxing the requirement
4435 of a blank line between items, consider the following example:
4442 Is this a single list item with two definitions of "bar," the first of
4443 which is lazily wrapped, or two list items? To remove the ambiguity
4444 we must either disallow lazy wrapping or require a blank line between
4450In addition to pandoc's extended Markdown, the following Markdown
4451variants are supported:
4453`markdown_phpextra` (PHP Markdown Extra)
4454: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4455 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4456 `header_attributes`, `link_attributes`, `abbreviations`,
4457 `shortcut_reference_links`, `spaced_reference_links`.
4459`markdown_github` (deprecated GitHub-Flavored Markdown)
4460: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4461 `gfm_auto_identifiers`, `backtick_code_blocks`,
4462 `autolink_bare_uris`, `space_in_atx_header`,
4463 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4464 `shortcut_reference_links`, `angle_brackets_escapable`,
4465 `lists_without_preceding_blankline`.
4467`markdown_mmd` (MultiMarkdown)
4468: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4469 `tex_math_double_backslash`, `intraword_underscores`,
4470 `mmd_title_block`, `footnotes`, `definition_lists`,
4471 `all_symbols_escapable`, `implicit_header_references`,
4472 `auto_identifiers`, `mmd_header_identifiers`,
4473 `shortcut_reference_links`, `implicit_figures`,
4474 `superscript`, `subscript`, `backtick_code_blocks`,
4475 `spaced_reference_links`, `raw_attribute`.
4477`markdown_strict` (Markdown.pl)
4478: `raw_html`, `shortcut_reference_links`,
4479 `spaced_reference_links`.
4481We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4482which is implemented as a set of extensions on `commonmark`).
4484Note, however, that `commonmark` and `gfm` have limited support
4485for extensions. Only those listed below (and `smart`,
4486`raw_tex`, and `hard_line_breaks`) will work. The extensions
4487can, however, all be individually disabled. Also, `raw_tex`
4488only affects `gfm` output, not input.
4490`gfm` (GitHub-Flavored Markdown)
4491: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4492 `gfm_auto_identifiers`, `backtick_code_blocks`,
4493 `autolink_bare_uris`, `space_in_atx_header`,
4494 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4495 `shortcut_reference_links`, `angle_brackets_escapable`,
4496 `lists_without_preceding_blankline`.
4499Producing slide shows with pandoc
4500=================================
4502You can use pandoc to produce an HTML + JavaScript slide presentation
4503that can be viewed via a web browser. There are five ways to do this,
4504using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
4505You can also produce a PDF slide show using LaTeX [`beamer`], or
4506slides shows in Microsoft [PowerPoint] format.
4508Here's the Markdown source for a simple slide show, `habits.txt`:
4535 
4542To produce an HTML/JavaScript slide show, simply type
4544 pandoc -t FORMAT -s habits.txt -o habits.html
4546where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
4548For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4549`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4550assumed to be available at the relative path `s5/default` (for S5), `slideous`
4551(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4552`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4553`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4554above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4557With all HTML slide formats, the `--self-contained` option can be used to
4558produce a single file that contains all of the data necessary to display the
4559slide show, including linked scripts, stylesheets, images, and videos.
4561To produce a PDF slide show using beamer, type
4563 pandoc -t beamer habits.txt -o habits.pdf
4565Note that a reveal.js slide show can also be converted to a PDF
4566by printing it to a file from the browser.
4568To produce a Powerpoint slide show, type
4570 pandoc habits.txt -o habits.pptx
4572Structuring the slide show
4573--------------------------
4575By default, the *slide level* is the highest heading level in
4576the hierarchy that is followed immediately by content, and not another
4577heading, somewhere in the document. In the example above, level-1 headings
4578are always followed by level-2 headings, which are followed by content,
4579so the slide level is 2. This default can be overridden using
4580the `--slide-level` option.
4582The document is carved up into slides according to the following
4585 * A horizontal rule always starts a new slide.
4587 * A heading at the slide level always starts a new slide.
4589 * Headings *below* the slide level in the hierarchy create
4590 headings *within* a slide.
4592 * Headings *above* the slide level in the hierarchy create
4593 "title slides," which just contain the section title
4594 and help to break the slide show into sections.
4595 Non-slide content under these headings will be included
4596 on the title slide (for HTML slide shows) or in a
4597 subsequent slide with the same title (for beamer).
4599 * A title page is constructed automatically from the document's title
4600 block, if present. (In the case of beamer, this can be disabled
4601 by commenting out some lines in the default template.)
4603These rules are designed to support many different styles of slide show. If
4604you don't care about structuring your slides into sections and subsections,
4605you can just use level-1 headings for all each slide. (In that case, level-1
4606will be the slide level.) But you can also structure the slide show into
4607sections, as in the example above.
4609Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4610layout will be produced, with level-1 headings building horizontally
4611and level-2 headings building vertically. It is not recommended that
4612you use deeper nesting of section levels with reveal.js.
4617By default, these writers produce lists that display "all at once."
4618If you want your lists to display incrementally (one item at a time),
4619use the `-i` option. If you want a particular list to depart from the
4620default, put it in a `div` block with class `incremental` or
4621`nonincremental`. So, for example, using the `fenced div` syntax, the
4622following would be incremental regardless of the document default:
4640While using `incremental` and `nonincremental` divs are the
4641recommended method of setting incremental lists on a per-case basis,
4642an older method is also supported: putting lists inside a blockquote
4643will depart from the document default (that is, it will display
4644incrementally without the `-i` option and all at once with the `-i`
4650Both methods allow incremental and nonincremental lists to be mixed
4651in a single document.
4656You can add "pauses" within a slide by including a paragraph containing
4657three dots, separated by spaces:
4659 # Slide with a pause
4661 content before the pause
4665 content after the pause
4670You can change the style of HTML slides by putting customized CSS files
4671in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
4672or `$DATADIR/slideous` (for Slideous),
4673where `$DATADIR` is the user data directory (see `--data-dir`, above).
4674The originals may be found in pandoc's system data directory (generally
4675`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
4676files it does not find in the user data directory.
4678For dzslides, the CSS is included in the HTML file itself, and may
4681All [reveal.js configuration options] can be set through variables.
4682For example, themes can be used by setting the `theme` variable:
4686Or you can specify a custom stylesheet using the `--css` option.
4688To style beamer slides, you can specify a `theme`, `colortheme`,
4689`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
4691 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4693Note that heading attributes will turn into slide attributes
4694(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4695to style individual slides. In beamer, the only heading attribute
4696that affects slides is the `allowframebreaks` class, which sets the
4697`allowframebreaks` option, causing multiple slides to be created
4698if the content overfills the frame. This is recommended especially for
4701 # References {.allowframebreaks}
4706Speaker notes are supported in reveal.js and PowerPoint (pptx)
4707output. You can add notes to your Markdown document thus:
4713 - It can contain Markdown
4718To show the notes window in reveal.js, press `s` while viewing the
4719presentation. Speaker notes in PowerPoint will be available, as usual,
4720in handouts and presenter view.
4722Notes are not yet supported for other slide formats, but the notes
4723will not appear on the slides themselves.
4728To put material in side by side columns, you can use a native
4729div container with class `columns`, containing two or more div
4730containers with class `column` and a `width` attribute:
4732 :::::::::::::: {.columns}
4733 ::: {.column width="40%"}
4736 ::: {.column width="60%"}
4741Frame attributes in beamer
4742--------------------------
4744Sometimes it is necessary to add the LaTeX `[fragile]` option to
4745a frame in beamer (for example, when using the `minted` environment).
4746This can be forced by adding the `fragile` class to the heading
4747introducing the slide:
4749 # Fragile slide {.fragile}
4751All of the other frame attributes described in Section 8.1 of
4752the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4753`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4754`shrink`, `standout`, `noframenumbering`.
4756Background in reveal.js and beamer
4757----------------------------------
4759Background images can be added to self-contained reveal.js slideshows and
4760to beamer slideshows.
4762For the same image on every slide, use the configuration
4763option `background-image` either in the YAML metadata block
4764or as a command-line variable. (There are no other options in
4765beamer and the rest of this section concerns reveal.js slideshows.)
4767For reveal.js, you can instead use the reveal.js-native option
4768`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4769and `parallaxBackgroundVertical` the same way and must also set
4770`parallaxBackgroundSize` to have your values take effect.
4772To set an image for a particular reveal.js slide, add
4773`{data-background-image="/path/to/image"}`
4774to the first slide-level heading on the slide (which may even be empty).
4776In reveal.js's overview mode, the parallaxBackgroundImage will show up
4777only on the first slide.
4779Other reveal.js background settings also work on individual slides, including
4780`data-background-size`, `data-background-repeat`, `data-background-color`,
4781`data-transition`, and `data-transition-speed`.
4784documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4787For example in reveal.js:
4792parallaxBackgroundImage: /path/to/my/background_image.png
4797Slide 1 has background_image.png as its background.
4799## {data-background-image="/path/to/special_image.jpg"}
4801Slide 2 has a special image for its background, even though the heading has no content.
4804Creating EPUBs with pandoc
4805==========================
4810EPUB metadata may be specified using the `--epub-metadata` option, but
4811if the source document is Markdown, it is better to use a [YAML metadata
4812block][Extension: `yaml_metadata_block`]. Here is an example:
4819 text: An investigation of metadata
4827 text: doi:10.234234.234/33
4829 rights: © 2007 John Smith, CC BY-NC
4834The following fields are recognized:
4837 ~ Either a string value or an object with fields `text` and
4838 `scheme`. Valid values for `scheme` are `ISBN-10`,
4839 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
4840 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
4841 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
4844 ~ Either a string value, or an object with fields `file-as` and
4845 `type`, or a list of such objects. Valid values for `type` are
4846 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
4849 ~ Either a string value, or an object with fields `role`, `file-as`,
4850 and `text`, or a list of such objects. Valid values for `role` are
4851 [MARC relators], but
4852 pandoc will attempt to translate the human-readable versions
4853 (like "author" and "editor") to the appropriate marc relators.
4856 ~ Same format as `creator`.
4859 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
4860 Pandoc will attempt to convert other common date formats.
4862`lang` (or legacy: `language`)
4863 ~ A string value in [BCP 47] format. Pandoc will default to the local
4864 language if nothing is specified.
4867 ~ A string value or a list of such values.
4888 ~ A string value (path to cover image).
4890`css` (or legacy: `stylesheet`)
4891 ~ A string value (path to CSS stylesheet).
4893`page-progression-direction`
4894 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
4895 attribute for the [`spine` element].
4898 ~ iBooks-specific metadata, with the following fields:
4900 - `version`: (string)
4901 - `specified-fonts`: `true`|`false` (default `false`)
4902 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
4903 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
4904 - `binding`: `true`|`false` (default `true`)
4905 - `scroll-axis`: `vertical`|`horizontal`|`default`
4907[MARC relators]: http://loc.gov/marc/relators/relaterm.html
4908[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4910The `epub:type` attribute
4911-------------------------
4913For `epub3` output, you can mark up the heading that corresponds to an EPUB
4914chapter using the [`epub:type` attribute][epub-type]. For example, to set
4915the attribute to the value `prologue`, use this markdown:
4917 # My chapter {epub:type=prologue}
4919Which will result in:
4921 <body epub:type="frontmatter">
4922 <section epub:type="prologue">
4925Pandoc will output `<body epub:type="bodymatter">`, unless
4926you use one of the following values, in which case either
4927`frontmatter` or `backmatter` will be output.
4929`epub:type` of first section `epub:type` of body
4930---------------------------- ------------------
4933acknowledgments frontmatter
4934copyright-page frontmatter
4935dedication frontmatter
4937halftitle, frontmatter
4938introduction frontmatter
4940seriespage frontmatter
4941titlepage frontmatter
4945conclusion backmatter
4948[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
4953By default, pandoc will download media referenced from any `<img>`, `<audio>`,
4954`<video>` or `<source>` element present in the generated EPUB,
4955and include it in the EPUB container, yielding a completely
4956self-contained EPUB. If you want to link to external media resources
4957instead, use raw HTML in your source and add `data-external="1"` to the tag
4958with the `src` attribute. For example:
4960 <audio controls="1">
4961 <source src="http://example.com/music/toccata.mp3"
4962 data-external="1" type="audio/mpeg">
4966Creating Jupyter notebooks with pandoc
4967======================================
4969When creating a [Jupyter notebook], pandoc will try to infer the
4970notebook structure. Code blocks with the class `code` will be
4971taken as code cells, and intervening content will be taken as
4972Markdown cells. Attachments will automatically be created for
4973images in Markdown cells. Metadata will be taken from the
4974`jupyter` metadata field. For example:
4983 display_name: Python 2
4990 file_extension: ".py"
4991 mimetype: "text/x-python"
4993 nbconvert_exporter: "python"
4994 pygments_lexer: "ipython2"
5000**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5001bibendum felis dictum sodales.
5010from IPython.display import HTML
5013console.log("hello");
5021This image  will be
5022included as a cell attachment.
5025If you want to add cell attributes, group cells differently, or
5026add output to code cells, then you need to include divs to
5027indicate the structure. You can use either [fenced
5028divs][Extension: `fenced_divs`] or [native divs][Extension:
5029`native_divs`] for this. Here is an example:
5032:::::: {.cell .markdown}
5035**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5036bibendum felis dictum sodales.
5039:::::: {.cell .code execution_count=1}
5044::: {.output .stream .stdout}
5051:::::: {.cell .code execution_count=2}
5053from IPython.display import HTML
5056console.log("hello");
5062::: {.output .execute_result execution_count=2}
5065console.log("hello");
5074If you include raw HTML or TeX in an output cell, use the
5075[raw attribute][Extension: `fenced_attribute`], as shown
5076in the last cell of the example above. Although pandoc can
5077process "bare" raw HTML and TeX, the result is often
5078interspersed raw elements and normal textual elements, and
5079in an output cell pandoc expects a single, connected raw
5080block. To avoid using raw HTML or TeX except when
5081marked explicitly using raw attributes, we recommend
5082specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5083translating between Markdown and ipynb notebooks.
5085Note that options and extensions that affect reading and
5086writing of Markdown will also affect Markdown cells in ipynb
5087notebooks. For example, `--wrap=preserve` will preserve
5088soft line breaks in Markdown cells; `--atx-headers` will
5089cause ATX-style headings to be used; and `--preserve-tabs` will
5090prevent tabs from being turned to spaces.
5095Pandoc will automatically highlight syntax in [fenced code blocks] that
5096are marked with a language name. The Haskell library [skylighting] is
5097used for highlighting. Currently highlighting is supported only for
5098HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5099that pandoc will recognize, type `pandoc --list-highlight-languages`.
5101The color scheme can be selected using the `--highlight-style` option.
5102The default color scheme is `pygments`, which imitates the default color
5103scheme used by the Python library pygments (though pygments is not actually
5104used to do the highlighting). To see a list of highlight styles,
5105type `pandoc --list-highlight-styles`.
5107If you are not satisfied with the predefined styles, you can
5108use `--print-highlight-style` to generate a JSON `.theme` file which
5109can be modified and used as the argument to `--highlight-style`. To
5110get a JSON version of the `pygments` style, for example:
5112 pandoc --print-highlight-style pygments > my.theme
5114Then edit `my.theme` and use it like this:
5116 pandoc --highlight-style my.theme
5118If you are not satisfied with the built-in highlighting, or you
5119want highlight a language that isn't supported, you can use the
5120`--syntax-definition` option to load a [KDE-style XML syntax definition
5121file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5122Before writing your own, have a look at KDE's [repository of syntax
5123definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5125To disable highlighting, use the `--no-highlight` option.
5127[skylighting]: https://github.com/jgm/skylighting
5132Custom styles can be used in the docx and ICML formats.
5137By default, pandoc's docx and ICML output applies a predefined set of styles
5138for blocks such as paragraphs and block quotes, and uses largely default
5139formatting (italics, bold) for inlines. This will work for most
5140purposes, especially alongside a `reference.docx` file. However, if you
5141need to apply your own styles to blocks, or match a preexisting set of
5142styles, pandoc allows you to define custom styles for blocks and text
5143using `div`s and `span`s, respectively.
5145If you define a `div` or `span` with the attribute `custom-style`,
5146pandoc will apply your specified style to the contained elements. So,
5147for example using the `bracketed_spans` syntax,
5149 [Get out]{custom-style="Emphatically"}, he said.
5151would produce a docx file with "Get out" styled with character
5152style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5154 Dickinson starts the poem simply:
5156 ::: {custom-style="Poetry"}
5157 | A Bird came down the Walk---
5158 | He did not know I saw---
5161would style the two contained lines with the `Poetry` paragraph style.
5163For docx output, styles will be defined in the output file as inheriting
5164from normal text, if the styles are not yet in your reference.docx.
5165If they are already defined, pandoc will not alter the definition.
5167This feature allows for greatest customization in conjunction with
5168[pandoc filters]. If you want all paragraphs after block quotes to be
5169indented, you can write a filter to apply the styles necessary. If you
5170want all italics to be transformed to the `Emphasis` character style
5171(perhaps to change their color), you can write a filter which will
5172transform all italicized inlines to inlines within an `Emphasis`
5175For docx output, you don't need to enable any extensions for
5176custom styles to work.
5178[pandoc filters]: http://pandoc.org/filters.html
5183The docx reader, by default, only reads those styles that it can
5184convert into pandoc elements, either by direct conversion or
5185interpreting the derivation of the input document's styles.
5187By enabling the [`styles` extension](#ext-styles) in the docx reader
5188(`-f docx+styles`), you can produce output that maintains the styles
5189of the input document, using the `custom-style` class. Paragraph
5190styles are interpreted as divs, while character styles are interpreted
5193For example, using the `custom-style-reference.docx` file in the test
5194directory, we have the following different outputs:
5196Without the `+styles` extension:
5198 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5201 This is text with an *emphasized* text style. And this is text with a
5202 **strengthened** text style.
5204 > Here is a styled paragraph that inherits from Block Text.
5206And with the extension:
5208 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5210 ::: {custom-style="FirstParagraph"}
5214 ::: {custom-style="BodyText"}
5215 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5216 And this is text with a [strengthened]{custom-style="Strengthened"}
5220 ::: {custom-style="MyBlockStyle"}
5221 > Here is a styled paragraph that inherits from Block Text.
5224With these custom styles, you can use your input document as a
5225reference-doc while creating docx output (see below), and maintain the
5226same styles in your input and output files.
5231Pandoc can be extended with custom writers written in [lua]. (Pandoc
5232includes a lua interpreter, so lua need not be installed separately.)
5234To use a custom writer, simply specify the path to the lua script
5235in place of the output format. For example:
5237 pandoc -t data/sample.lua
5239Creating a custom writer requires writing a lua function for each
5240possible element in a pandoc document. To get a documented example
5241which you can modify according to your needs, do
5243 pandoc --print-default-data-file sample.lua
5245[lua]: http://www.lua.org
5250If you use pandoc to convert user-contributed content in a web
5251application, here are some things to keep in mind:
52531. Although pandoc itself will not create or modify any files other
5254 than those you explicitly ask it create (with the exception
5255 of temporary files used in producing PDFs), a filter or custom
5256 writer could in principle do anything on your file system. Please
5257 audit filters and custom writers very carefully before using them.
52592. If your application uses pandoc as a Haskell library (rather than
5260 shelling out to the executable), it is possible to use it in a mode
5261 that fully isolates pandoc from your file system, by running the
5262 pandoc operations in the `PandocPure` monad. See the document
5263 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
52663. Pandoc's parsers can exhibit pathological performance on some
5267 corner cases. It is wise to put any pandoc operations under
5268 a timeout, to avoid DOS attacks that exploit these issues.
5269 If you are using the pandoc executable, you can add the
5270 command line options `+RTS -M512M -RTS` (for example) to limit
5271 the heap size to 512MB.
52734. The HTML generated by pandoc is not guaranteed to be safe.
5274 If `raw_html` is enabled for the Markdown input, users can
5275 inject arbitrary HTML. Even if `raw_html` is disabled,
5276 users can include dangerous content in attributes for
5277 headings, spans, and code blocks. To be safe, you should
5278 run all the generated HTML through an HTML sanitizer.
5283Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5284under the [GPL], version 2 or greater. This software carries no
5285warranty of any kind. (See COPYRIGHT for full copyright and
5286warranty notices.) For a full list of contributors, see the file
5287AUTHORS.md in the pandoc source code.
5289[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
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