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. It can read
15[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
16and (subsets of) [Textile], [reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
17markup], [Haddock markup], [OPML], [Emacs Org mode], [DocBook],
18[txt2tags], [EPUB], [ODT] and [Word docx]; and it can write plain text,
19[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
20[reStructuredText], [XHTML], [HTML5], [LaTeX] (including
21[`beamer`] slide shows), [ConTeXt], [RTF], [OPML], [DocBook],
22[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup],
23[DokuWiki markup], [Haddock markup], [EPUB] (v2 or v3),
24[FictionBook2], [Textile], [groff man] pages, [Emacs Org mode],
25[AsciiDoc], [InDesign ICML], and [Slidy], [Slideous], [DZSlides],
26[reveal.js] or [S5] HTML slide shows. It can also produce [PDF] output
27on systems where LaTeX or ConTeXt is installed.
29Pandoc's enhanced version of Markdown includes syntax for [footnotes],
30[tables], flexible [ordered lists], [definition lists], [fenced code blocks],
31[superscripts and subscripts], [strikeout], [metadata blocks], automatic tables of
32contents, embedded LaTeX [math], [citations], and [Markdown inside HTML block
33elements][Extension: `markdown_in_html_blocks`]. (These enhancements, described below under
34[Pandoc's Markdown], can be disabled using the
35`markdown_strict` input or output format.)
37In contrast to most existing tools for converting Markdown to HTML, which
38use regex substitutions, pandoc has a modular design: it consists of a
39set of readers, which parse text in a given format and produce a native
40representation of the document, and a set of writers, which convert
41this native representation into a target format. Thus, adding an input
42or output format requires only adding a reader or writer.
44Because pandoc's intermediate representation of a document is less
45expressive than many of the formats it converts between, one should
46not expect perfect conversions between every format and every other.
47Pandoc attempts to preserve the structural elements of a document, but
48not formatting details such as margin size. And some document elements,
49such as complex tables, may not fit into pandoc's simple document
50model. While conversions from pandoc's Markdown to all formats aspire
51to be perfect, conversions from formats more expressive than pandoc's
52Markdown can be expected to be lossy.
54[Markdown]: http://daringfireball.net/projects/markdown/
55[CommonMark]: http://commonmark.org
56[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
57[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
58[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
59[S5]: http://meyerweb.com/eric/tools/s5/
60[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
61[Slideous]: http://goessner.net/articles/slideous/
62[HTML]: http://www.w3.org/html/
63[HTML5]: http://www.w3.org/TR/html5/
64[XHTML]: http://www.w3.org/TR/xhtml1/
65[LaTeX]: http://latex-project.org
66[`beamer`]: https://ctan.org/pkg/beamer
67[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
68[ConTeXt]: http://contextgarden.net/
69[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
70[DocBook]: http://docbook.org
71[txt2tags]: http://txt2tags.org
72[EPUB]: http://idpf.org/epub
73[OPML]: http://dev.opml.org/spec2.html
74[OpenDocument]: http://opendocument.xml.org
75[ODT]: http://en.wikipedia.org/wiki/OpenDocument
76[Textile]: http://redcloth.org/textile
77[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
78[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
79[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
80[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
81[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
82[Haskell]: https://www.haskell.org
83[GNU Texinfo]: http://www.gnu.org/software/texinfo/
84[Emacs Org mode]: http://orgmode.org
85[AsciiDoc]: http://www.methods.co.nz/asciidoc/
86[DZSlides]: http://paulrouget.com/dzslides/
87[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
88[PDF]: https://www.adobe.com/pdf/
89[reveal.js]: http://lab.hakim.se/reveal-js/
90[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
91[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
96If no *input-file* is specified, input is read from *stdin*.
97Otherwise, the *input-files* are concatenated (with a blank
98line between each) and used as input. Output goes to *stdout* by
99default (though output to *stdout* is disabled for the `odt`, `docx`,
100`epub`, and `epub3` output formats). For output to a file, use the
103 pandoc -o output.html input.txt
105By default, pandoc produces a document fragment, not a standalone
106document with a proper header and footer. To produce a standalone
107document, use the `-s` or `--standalone` flag:
109 pandoc -s -o output.html input.txt
111For more information on how standalone documents are produced, see
114Instead of a file, an absolute URI may be given. In this case
115pandoc will fetch the content using HTTP:
117 pandoc -f html -t markdown http://www.fsf.org
119If multiple input files are given, `pandoc` will concatenate them all (with
120blank lines between them) before parsing. This feature is disabled for
121 binary input formats such as `EPUB`, `odt`, and `docx`.
123The format of the input and output can be specified explicitly using
124command-line options. The input format can be specified using the
125`-r/--read` or `-f/--from` options, the output format using the
126`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
127Markdown to LaTeX, you could type:
129 pandoc -f markdown -t latex hello.txt
131To convert `hello.html` from HTML to Markdown:
133 pandoc -f html -t markdown hello.html
135Supported output formats are listed below under the `-t/--to` option.
136Supported input formats are listed below under the `-f/--from` option. Note
137that the `rst`, `textile`, `latex`, and `html` readers are not complete;
138there are some constructs that they do not parse.
140If the input or output format is not specified explicitly, `pandoc`
141will attempt to guess it from the extensions of
142the input and output filenames. Thus, for example,
144 pandoc -o hello.tex hello.txt
146will convert `hello.txt` from Markdown to LaTeX. If no output file
147is specified (so that output goes to *stdout*), or if the output file's
148extension is unknown, the output format will default to HTML.
149If no input file is specified (so that input comes from *stdin*), or
150if the input files' extensions are unknown, the input format will
151be assumed to be Markdown unless explicitly specified.
153Pandoc uses the UTF-8 character encoding for both input and output.
154If your local character encoding is not UTF-8, you
155should pipe input and output through [`iconv`]:
157 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
159Note that in some output formats (such as HTML, LaTeX, ConTeXt,
160RTF, OPML, DocBook, and Texinfo), information about
161the character encoding is included in the document header, which
162will only be included if you use the `-s/--standalone` option.
164[`iconv`]: http://www.gnu.org/software/libiconv/
169To produce a PDF, specify an output file with a `.pdf` extension.
170By default, pandoc will use LaTeX to convert it to PDF:
172 pandoc test.txt -o test.pdf
174Production of a PDF requires that a LaTeX engine be installed (see
175`--latex-engine`, below), and assumes that the following LaTeX packages
176are available: [`amsfonts`], [`amsmath`], [`lm`],
177[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
178`--listings` option is used), [`fancyvrb`], [`longtable`],
179[`booktabs`], [`url`], [`graphicx`] and [`grffile`] (if the
180document contains images), [`color`], [`hyperref`], [`ulem`],
181[`geometry`] (with the `geometry` variable set), [`setspace`] (with
182`linestretch`), and [`babel`] (with `lang`). The use of `xelatex` or
183`lualatex` as the LaTeX engine requires [`fontspec`]; `xelatex` uses
184[`mathspec`], [`polyglossia`] (with `lang`), [`xecjk`], and
185[`bidi`] (with the `dir` variable set). The [`upquote`] and
186[`microtype`] packages are used if available, and [`csquotes`] will
187be used for [smart punctuation] if added to the template. The
188[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
189optionally be used for [citation rendering]. These are included with
190all recent versions of [TeX Live].
192Alternatively, pandoc can use ConTeXt to create a PDF.
193To do this, specify an output file with a `.pdf` extension,
194as before, but add `-t context` to the command line.
196PDF output can be controlled using [variables for LaTeX]
197or [variables for ConTeXt].
199[`amsfonts`]: https://ctan.org/pkg/amsfonts
200[`amsmath`]: https://ctan.org/pkg/amsmath
201[`lm`]: https://ctan.org/pkg/lm
202[`ifxetex`]: https://ctan.org/pkg/ifxetex
203[`ifluatex`]: https://ctan.org/pkg/ifluatex
204[`eurosym`]: https://ctan.org/pkg/eurosym
205[`listings`]: https://ctan.org/pkg/listings
206[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
207[`longtable`]: https://ctan.org/pkg/longtable
208[`booktabs`]: https://ctan.org/pkg/booktabs
209[`url`]: https://ctan.org/pkg/url
210[`graphicx`]: https://ctan.org/pkg/graphicx
211[`grffile`]: https://ctan.org/pkg/grffile
212[`geometry`]: https://ctan.org/pkg/geometry
213[`setspace`]: https://ctan.org/pkg/setspace
214[`color`]: http://ctan.org/pkg/color
215[`xecjk`]: https://ctan.org/pkg/xecjk
216[`hyperref`]: https://ctan.org/pkg/hyperref
217[`ulem`]: https://ctan.org/pkg/ulem
218[`babel`]: https://ctan.org/pkg/babel
219[`bidi`]: https://ctan.org/pkg/bidi
220[`mathspec`]: https://ctan.org/pkg/mathspec
221[`polyglossia`]: https://ctan.org/pkg/polyglossia
222[`fontspec`]: https://ctan.org/pkg/fontspec
223[`upquote`]: https://ctan.org/pkg/upquote
224[`microtype`]: https://ctan.org/pkg/microtype
225[`csquotes`]: https://ctan.org/pkg/csquotes
226[`natbib`]: https://ctan.org/pkg/natbib
227[`biblatex`]: https://ctan.org/pkg/biblatex
228[`bibtex`]: https://ctan.org/pkg/bibtex
229[`biber`]: https://ctan.org/pkg/biber
230[TeX Live]: http://www.tug.org/texlive/
235A user who wants a drop-in replacement for `Markdown.pl` may create
236a symbolic link to the `pandoc` executable called `hsmarkdown`. When
237invoked under the name `hsmarkdown`, `pandoc` will behave as if
238invoked with `-f markdown_strict --email-obfuscation=references`,
239and all command-line options will be treated as regular arguments.
240This approach does not work under [Cygwin], due to problems with
241its simulation of symbolic links.
243[Cygwin]: https://cygwin.com
251`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
253: Specify input format. *FORMAT* can be `native` (native Haskell),
254 `json` (JSON version of native AST), `markdown` (pandoc's
255 extended Markdown), `markdown_strict` (original unextended
256 Markdown), `markdown_phpextra` (PHP Markdown Extra),
257 `markdown_github` (GitHub-Flavored Markdown),
258 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
259 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
260 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
261 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
262 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
263 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
264 input will be treated as literate Haskell source: see [Literate
265 Haskell support], below. Markdown
266 syntax extensions can be individually enabled or disabled by
267 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
268 example, `markdown_strict+footnotes+definition_lists` is strict
269 Markdown with footnotes and definition lists enabled, and
270 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
271 without pipe tables and with hard line breaks. See [Pandoc's
272 Markdown], below, for a list of extensions and
275`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
277: Specify output format. *FORMAT* can be `native` (native Haskell),
278 `json` (JSON version of native AST), `plain` (plain text),
279 `markdown` (pandoc's extended Markdown), `markdown_strict`
280 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
281 Extra), `markdown_github` (GitHub-Flavored
282 Markdown), `commonmark` (CommonMark Markdown), `rst`
283 (reStructuredText), `html` (XHTML), `html5` (HTML5), `latex`
284 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
285 `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
286 (DokuWiki markup), `textile` (Textile), `org` (Emacs Org mode),
287 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
288 `opendocument` (OpenDocument), `odt` (OpenOffice text document),
289 `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
290 format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
291 (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
292 ICML), `slidy` (Slidy HTML and javascript slide show), `slideous`
293 (Slideous HTML and javascript slide show), `dzslides` (DZSlides
294 HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 +
295 javascript slide show), `s5` (S5 HTML and javascript slide show),
296 or the path of a custom lua writer (see [Custom
297 writers], below). Note that `odt`, `epub`, and
298 `epub3` output will not be directed to *stdout*; an output
299 filename must be specified using the `-o/--output` option. If
300 `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
301 `html`, or `html5`, the output will be rendered as literate
302 Haskell source: see [Literate Haskell
303 support], below. Markdown syntax
304 extensions can be individually enabled or disabled by appending
305 `+EXTENSION` or `-EXTENSION` to the format name, as described
308`-o` *FILE*, `--output=`*FILE*
310: Write output to *FILE* instead of *stdout*. If *FILE* is
311 `-`, output will go to *stdout*. (Exception: if the output
312 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
314`--data-dir=`*DIRECTORY*
316: Specify the user data directory to search for pandoc data files.
317 If this option is not specified, the default user data directory
318 will be used. This is, in Unix:
324 C:\Documents And Settings\USERNAME\Application Data\pandoc
326 and in Windows Vista or later:
328 C:\Users\USERNAME\AppData\Roaming\pandoc
330 You can find the default user data directory on your system by
331 looking at the output of `pandoc --version`.
332 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
333 `slidy`, `slideous`, or `s5` directory
334 placed in this directory will override pandoc's normal defaults.
338: Generate a bash completion script. To enable bash completion
339 with pandoc, add this to your `.bashrc`:
341 eval "$(pandoc --bash-completion)"
345: Give verbose debugging output. Currently this only has an effect
361: Parse untranslatable HTML codes and LaTeX environments as raw HTML
362 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
363 input. Raw HTML can be printed in Markdown, reStructuredText, HTML,
364 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
365 can be printed in Markdown, reStructuredText, LaTeX, and ConTeXt output.
366 The default is for the readers to omit untranslatable HTML codes and
367 LaTeX environments. (The LaTeX reader does pass through untranslatable
368 LaTeX *commands*, even if `-R` is not specified.)
372: Produce typographically correct output, converting straight quotes
373 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
374 `...` to ellipses. Nonbreaking spaces are inserted after certain
375 abbreviations, such as "Mr." (Note: This option is selected automatically
376 when the output format is `latex` or `context`, unless `--no-tex-ligatures`
381: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
382 a numeral is an en-dash, and `--` is an em-dash. This option is selected
383 automatically for `textile` input.
385`--base-header-level=`*NUMBER*
387: Specify the base level for headers (defaults to 1).
389`--indented-code-classes=`*CLASSES*
391: Specify classes to use for indented code blocks--for example,
392 `perl,numberLines` or `haskell`. Multiple classes may be separated
395`--default-image-extension=`*EXTENSION*
397: Specify a default extension to use when image paths/URLs have no
398 extension. This allows you to use the same source for formats that
399 require different kinds of images. Currently this option only affects
400 the Markdown and LaTeX readers.
402`--filter=`*EXECUTABLE*
404: Specify an executable to be used as a filter transforming the
405 pandoc AST after the input is parsed and before the output is
406 written. The executable should read JSON from stdin and write
407 JSON to stdout. The JSON must be formatted like pandoc's own
408 JSON input and output. The name of the output format will be
409 passed to the filter as the first argument. Hence,
411 pandoc --filter ./caps.py -t latex
415 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
417 The latter form may be useful for debugging filters.
419 Filters may be written in any language. `Text.Pandoc.JSON`
420 exports `toJSONFilter` to facilitate writing filters in Haskell.
421 Those who would prefer to write filters in python can use the
422 module [`pandocfilters`], installable from PyPI. There are also
423 pandoc filter libraries in [PHP], [perl], and [javascript/node.js].
425 Note that the *EXECUTABLE* will be sought in the user's
426 `PATH`, and not in the working directory, if no directory is
427 provided. If you want to run a script in the working directory,
428 preface the filename with `./`.
430`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
432: Set the metadata field *KEY* to the value *VAL*. A value specified
433 on the command line overrides a value specified in the document.
434 Values will be parsed as YAML boolean or string values. If no value is
435 specified, the value will be treated as Boolean true. Like
436 `--variable`, `--metadata` causes template variables to be set.
437 But unlike `--variable`, `--metadata` affects the metadata of the
438 underlying document (which is accessible from filters and may be
439 printed in some output formats).
443: Normalize the document after reading: merge adjacent
444 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
446`-p`, `--preserve-tabs`
448: Preserve tabs instead of converting them to spaces (the default).
449 Note that this will only affect tabs in literal code spans and code
450 blocks; tabs in regular text will be treated as spaces.
454: Specify the number of spaces per tab (default is 4).
456`--track-changes=accept`|`reject`|`all`
458: Specifies what to do with insertions and deletions produced by the MS
459 Word "Track Changes" feature. `accept` (the default), inserts all
460 insertions, and ignores all deletions. `reject` inserts all
461 deletions and ignores insertions. `all` puts in both insertions
462 and deletions, wrapped in spans with `insertion` and `deletion`
463 classes, respectively. The author and time of change is
464 included. `all` is useful for scripting: only accepting changes
465 from a certain reviewer, say, or before a certain date. This
466 option only affects the docx reader.
468`--extract-media=`*DIR*
470: Extract images and other media contained in a docx or epub container
471 to the path *DIR*, creating it if necessary, and adjust the images
472 references in the document so they point to the extracted files.
473 This option only affects the docx and epub readers.
475[`pandocfilters`]: https://github.com/jgm/pandocfilters
476[PHP]: https://github.com/vinai/pandocfilters-php
477[perl]: https://metacpan.org/pod/Pandoc::Filter
478[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
480General writer options
481----------------------
485: Produce output with an appropriate header and footer (e.g. a
486 standalone HTML, LaTeX, or RTF file, not a fragment). This option
487 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
492: Use *FILE* as a custom template for the generated document. Implies
493 `--standalone`. See [Templates], below, for a description
494 of template syntax. If no extension is specified, an extension
495 corresponding to the writer will be added, so that `--template=special`
496 looks for `special.html` for HTML output. If the template is not
497 found, pandoc will search for it in the `templates` subdirectory of
498 the user data directory (see `--data-dir`). If this option is not used,
499 a default template appropriate for the output format will be used (see
500 `-D/--print-default-template`).
502`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
504: Set the template variable *KEY* to the value *VAL* when rendering the
505 document in standalone mode. This is generally only useful when the
506 `--template` option is used to specify a custom template, since
507 pandoc automatically sets the variables used in the default
508 templates. If no *VAL* is specified, the key will be given the
511`-D` *FORMAT*, `--print-default-template=`*FORMAT*
513: Print the system default template for an output *FORMAT*. (See `-t`
514 for a list of possible *FORMAT*s.) Templates in the user data
515 directory are ignored.
517`--print-default-data-file=`*FILE*
519: Print a system default data file. Files in the user data directory
524: Disable text wrapping in output. By default, text is wrapped
525 appropriately for the output format.
529: Specify length of lines in characters (for text wrapping).
531`--toc`, `--table-of-contents`
533: Include an automatically generated table of contents (or, in
534 the case of `latex`, `context`, and `rst`, an instruction to create
535 one) in the output document. This option has no effect on `man`,
536 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
538`--toc-depth=`*NUMBER*
540: Specify the number of section levels to include in the table
541 of contents. The default is 3 (which means that level 1, 2, and 3
542 headers will be listed in the contents).
546: Disables syntax highlighting for code blocks and inlines, even when
547 a language attribute is given.
549`--highlight-style=`*STYLE*
551: Specifies the coloring style to be used in highlighted source code.
552 Options are `pygments` (the default), `kate`, `monochrome`,
553 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
554 on syntax highlighting in pandoc, see [Syntax highlighting], below.
556`-H` *FILE*, `--include-in-header=`*FILE*
558: Include contents of *FILE*, verbatim, at the end of the header.
559 This can be used, for example, to include special
560 CSS or javascript in HTML documents. This option can be used
561 repeatedly to include multiple files in the header. They will be
562 included in the order specified. Implies `--standalone`.
564`-B` *FILE*, `--include-before-body=`*FILE*
566: Include contents of *FILE*, verbatim, at the beginning of the
567 document body (e.g. after the `<body>` tag in HTML, or the
568 `\begin{document}` command in LaTeX). This can be used to include
569 navigation bars or banners in HTML documents. This option can be
570 used repeatedly to include multiple files. They will be included in
571 the order specified. Implies `--standalone`.
573`-A` *FILE*, `--include-after-body=`*FILE*
575: Include contents of *FILE*, verbatim, at the end of the document
576 body (before the `</body>` tag in HTML, or the
577 `\end{document}` command in LaTeX). This option can be be used
578 repeatedly to include multiple files. They will be included in the
579 order specified. Implies `--standalone`.
581Options affecting specific writers
582----------------------------------
586: Produce a standalone HTML file with no external dependencies, using
587 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
588 images, and videos. The resulting file should be "self-contained,"
589 in the sense that it needs no external files and no net access to be
590 displayed properly by a browser. This option works only with HTML output
591 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
592 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
593 stylesheets at absolute URLs will be downloaded; those at relative URLs
594 will be sought relative to the working directory (if the first source
595 file is local) or relative to the base URL (if the first source
596 file is remote). `--self-contained` does not work with `--mathjax`.
600: Deprecated synonym for `--self-contained`.
604: Produce HTML5 instead of HTML4. This option has no effect for writers
605 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
609: Use `<q>` tags for quotes in HTML.
613: Use only ascii characters in output. Currently supported only
614 for HTML output (which uses numerical entities instead of
615 UTF-8 when this option is selected).
619: Use reference-style links, rather than inline links, in writing Markdown
620 or reStructuredText. By default inline links are used.
624: Use ATX-style headers in Markdown and asciidoc output. The default is
625 to use setext-style headers for levels 1-2, and then ATX headers.
629: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
630 output. When the LaTeX document class is set to `report`, `book`, or
631 `memoir`, this option is implied. If `beamer` is the output
632 format, top-level headers will become `\part{..}`.
634`-N`, `--number-sections`
636: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
637 By default, sections are not numbered. Sections with class
638 `unnumbered` will never be numbered, even if `--number-sections`
641`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
643: Offset for section headings in HTML output (ignored in other
644 output formats). The first number is added to the section number for
645 top-level headers, the second for second-level headers, and so on.
646 So, for example, if you want the first top-level header in your
647 document to be numbered "6", specify `--number-offset=5`.
648 If your document starts with a level-2 header which you want to
649 be numbered "1.5", specify `--number-offset=1,4`.
650 Offsets are 0 by default. Implies `--number-sections`.
654: Do not convert quotation marks, apostrophes, and dashes to
655 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
656 use literal unicode characters. This is needed for using advanced
657 OpenType features with `xelatex` and `lualatex`. Note: normally
658 `--smart` is selected automatically for LaTeX and ConTeXt
659 output, but it must be specified explicitly if `--no-tex-ligatures`
660 is selected. If you use literal curly quotes, dashes, and ellipses
661 in your source, then you may want to use `--no-tex-ligatures`
666: Use the [`listings`] package for LaTeX code blocks
670: Make list items in slide shows display incrementally (one by one).
671 The default is for lists to be displayed all at once.
673`--slide-level=`*NUMBER*
675: Specifies that headers with the specified level create
676 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
677 above this level in the hierarchy are used to divide the
678 slide show into sections; headers below this level create
679 subheads within a slide. The default is to set the slide level
680 based on the contents of the document; see
681 [Structuring the slide show].
685: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
686 and attach identifiers to the enclosing `<div>` (or `<section>`)
687 rather than the header itself. See
688 [Header identifiers], below.
690`--email-obfuscation=none`|`javascript`|`references`
692: Specify a method for obfuscating `mailto:` links in HTML documents.
693 `none` leaves `mailto:` links as they are. `javascript` obfuscates
694 them using javascript. `references` obfuscates them by printing their
695 letters as decimal or hexadecimal character references. The default
698`--id-prefix=`*STRING*
700: Specify a prefix to be added to all automatically generated identifiers
701 in HTML and DocBook output, and to footnote numbers in Markdown output.
702 This is useful for preventing duplicate identifiers when generating
703 fragments to be included in other pages.
705`-T` *STRING*, `--title-prefix=`*STRING*
707: Specify *STRING* as a prefix at the beginning of the title
708 that appears in the HTML header (but not in the title as it
709 appears at the beginning of the HTML body). Implies
712`-c` *URL*, `--css=`*URL*
714: Link to a CSS style sheet. This option can be be used repeatedly to
715 include multiple files. They will be included in the order specified.
717`--reference-odt=`*FILE*
719: Use the specified file as a style reference in producing an ODT.
720 For best results, the reference ODT should be a modified version
721 of an ODT produced using pandoc. The contents of the reference ODT
722 are ignored, but its stylesheets are used in the new ODT. If no
723 reference ODT is specified on the command line, pandoc will look
724 for a file `reference.odt` in the user data directory (see
725 `--data-dir`). If this is not found either, sensible defaults will be
728`--reference-docx=`*FILE*
730: Use the specified file as a style reference in producing a docx file.
731 For best results, the reference docx should be a modified version
732 of a docx file produced using pandoc. The contents of the reference docx
733 are ignored, but its stylesheets and document properties (including
734 margins, page size, header, and footer) are used in the new docx. If no
735 reference docx is specified on the command line, pandoc will look
736 for a file `reference.docx` in the user data directory (see
737 `--data-dir`). If this is not found either, sensible defaults will be
738 used. The following styles are used by pandoc: [paragraph]
739 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
740 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
741 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
742 Definition, Caption, Table Caption, Image Caption, Figure,
743 Figure With Caption, TOC Heading;
744 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
745 Footnote Reference, Hyperlink; [table] Normal Table.
747`--epub-stylesheet=`*FILE*
749: Use the specified CSS file to style the EPUB. If no stylesheet
750 is specified, pandoc will look for a file `epub.css` in the
751 user data directory (see `--data-dir`). If it is not
752 found there, sensible defaults will be used.
754`--epub-cover-image=`*FILE*
756: Use the specified image as the EPUB cover. It is recommended
757 that the image be less than 1000px in width and height. Note that
758 in a Markdown source document you can also specify `cover-image`
759 in a YAML metadata block (see [EPUB Metadata], below).
761`--epub-metadata=`*FILE*
763: Look in the specified XML file for metadata for the EPUB.
764 The file should contain a series of [Dublin Core elements].
767 <dc:rights>Creative Commons</dc:rights>
768 <dc:language>es-AR</dc:language>
770 By default, pandoc will include the following metadata elements:
771 `<dc:title>` (from the document title), `<dc:creator>` (from the
772 document authors), `<dc:date>` (from the document date, which should
773 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
774 variable, or, if is not set, the locale), and `<dc:identifier
775 id="BookId">` (a randomly generated UUID). Any of these may be
776 overridden by elements in the metadata file.
778 Note: if the source document is Markdown, a YAML metadata block
779 in the document can be used instead. See below under
782`--epub-embed-font=`*FILE*
784: Embed the specified font in the EPUB. This option can be repeated
785 to embed multiple fonts. Wildcards can also be used: for example,
786 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
787 line, be sure to escape them or put the whole filename in single quotes,
788 to prevent them from being interpreted by the shell. To use the
789 embedded fonts, you will need to add declarations like the following
790 to your CSS (see `--epub-stylesheet`):
793 font-family: DejaVuSans;
796 src:url("DejaVuSans-Regular.ttf");
799 font-family: DejaVuSans;
802 src:url("DejaVuSans-Bold.ttf");
805 font-family: DejaVuSans;
808 src:url("DejaVuSans-Oblique.ttf");
811 font-family: DejaVuSans;
814 src:url("DejaVuSans-BoldOblique.ttf");
816 body { font-family: "DejaVuSans"; }
818`--epub-chapter-level=`*NUMBER*
820: Specify the header level at which to split the EPUB into separate
821 "chapter" files. The default is to split into chapters at level 1
822 headers. This option only affects the internal composition of the
823 EPUB, not the way chapters and sections are displayed to users. Some
824 readers may be slow if the chapter files are too large, so for large
825 documents with few level 1 headers, one might want to use a chapter
828`--latex-engine=pdflatex`|`lualatex`|`xelatex`
830: Use the specified LaTeX engine when producing PDF output.
831 The default is `pdflatex`. If the engine is not in your PATH,
832 the full path of the engine may be specified here.
834`--latex-engine-opt=`*STRING*
836: Use the given string as a command-line argument to the `latex-engine`.
837 If used multiple times, the arguments are provided with spaces between
838 them. Note that no check for duplicate options is done.
840[Dublin Core elements]: http://dublincore.org/documents/dces/
841[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
846`--bibliography=`*FILE*
848: Set the `bibliography` field in the document's metadata to *FILE*,
849 overriding any value set in the metadata, and process citations
850 using `pandoc-citeproc`. (This is equivalent to
851 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
852 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
853 used, making this equivalent to `--metadata bibliography=FILE`.
854 If you supply this argument multiple times, each *FILE* will be added
859: Set the `csl` field in the document's metadata to *FILE*,
860 overriding any value set in the metadata. (This is equivalent to
861 `--metadata csl=FILE`.)
862 This option is only relevant with `pandoc-citeproc`.
864`--citation-abbreviations=`*FILE*
866: Set the `citation-abbreviations` field in the document's metadata to
867 *FILE*, overriding any value set in the metadata. (This is equivalent to
868 `--metadata citation-abbreviations=FILE`.)
869 This option is only relevant with `pandoc-citeproc`.
873: Use [`natbib`] for citations in LaTeX output. This option is not for use
874 with the `pandoc-citeproc` filter or with PDF output. It is intended for
875 use in producing a LaTeX file that can be processed with [`bibtex`].
879: Use [`biblatex`] for citations in LaTeX output. This option is not for use
880 with the `pandoc-citeproc` filter or with PDF output. It is intended for
881 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
883Math rendering in HTML
884----------------------
886`-m` [*URL*], `--latexmathml`[`=`*URL*]
888: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
889 To insert a link to a local copy of the `LaTeXMathML.js` script,
890 provide a *URL*. If no *URL* is provided, the contents of the
891 script will be inserted directly into the HTML header, preserving
892 portability at the price of efficiency. If you plan to use math on
893 several pages, it is much better to link to a copy of the script,
898: Convert TeX math to [MathML] (in `docbook` as well as `html` and `html5`).
899 In standalone `html` output, a small javascript (or a link to such a
900 script if a *URL* is supplied) will be inserted that allows the MathML to
901 be viewed on some browsers.
905: Use [jsMath] to display embedded TeX math in HTML output.
906 The *URL* should point to the jsMath load script (e.g.
907 `jsMath/easy/load.js`); if provided, it will be linked to in
908 the header of standalone HTML documents. If a *URL* is not provided,
909 no link to the jsMath load script will be inserted; it is then
910 up to the author to provide such a link in the HTML template.
914: Use [MathJax] to display embedded TeX math in HTML output.
915 The *URL* should point to the `MathJax.js` load script.
916 If a *URL* is not provided, a link to the MathJax CDN will
921: Enclose TeX math in `<eq>` tags in HTML output. These can then
922 be processed by [gladTeX] to produce links to images of the typeset
927: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
928 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
932: Render TeX formulas using an external script that converts TeX
933 formulas to images. The formula will be concatenated with the URL
934 provided. If *URL* is not specified, the Google Chart API will be used.
938: Use [KaTeX] to display embedded TeX math in HTML output.
939 The *URL* should point to the `katex.js` load script. If a *URL* is
940 not provided, a link to the KaTeX CDN will be inserted.
942`--katex-stylesheet=`*URL*
944: The *URL* should point to the `katex.css` stylesheet. If this option is
945 not specified, a link to the KaTeX CDN will be inserted. Note that this
946 option does not imply `--katex`.
948[MathML]: http://www.w3.org/Math/
949[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
950[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
951[MathJax]: https://www.mathjax.org
952[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
953[mimeTeX]: http://www.forkosh.com/mimetex.html
954[KaTeX]: https://github.com/Khan/KaTeX
956Options for wrapper scripts
957---------------------------
961: Print information about command-line arguments to *stdout*, then exit.
962 This option is intended primarily for use in wrapper scripts.
963 The first line of output contains the name of the output file specified
964 with the `-o` option, or `-` (for *stdout*) if no output file was
965 specified. The remaining lines contain the command-line arguments,
966 one per line, in the order they appear. These do not include regular
967 pandoc options and their arguments, but do include any options appearing
968 after a `--` separator at the end of the line.
972: Ignore command-line arguments (for use in wrapper scripts).
973 Regular pandoc options are not ignored. Thus, for example,
975 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
979 pandoc -o foo.html -s
984When the `-s/--standalone` option is used, pandoc uses a template to
985add header and footer material that is needed for a self-standing
986document. To see the default template that is used, just type
990where *FORMAT* is the name of the output format. A custom template
991can be specified using the `--template` option. You can also override
992the system default templates for a given output format *FORMAT*
993by putting a file `templates/default.*FORMAT*` in the user data
994directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
995customize the `default.opendocument` template. For `pdf` output,
996customize the `default.latex` template.
998Templates contain *variables*, which allow for the inclusion of
999arbitrary information at any point in the file. Variables may be set
1000within the document using [YAML metadata blocks][Extension:
1001`yaml_metadata_block`]. They may also be set at the
1002command line using the `-V/--variable` option: variables set in this
1003way override metadata fields with the same name.
1005Variables set by pandoc
1006-----------------------
1008Some variables are set automatically by pandoc. These vary somewhat
1009depending on the output format, but include metadata fields as well as the following:
1011`title`, `author`, `date`
1012: allow identification of basic aspects of the document.
1013 Included in PDF metadata through LaTeX and ConTeXt.
1014 These can be set through a [pandoc title block][Extension: `pandoc_title_block`],
1015 which allows for multiple authors, or through a YAML metadata block:
1024: document subtitle; also used as subject in PDF metadata
1027: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1030: list of keywords to be included in HTML, PDF, and AsciiDoc metadata; may be repeated as for `author`, above
1033: contents specified by `-H/--include-in-header` (may have multiple
1037: non-null value if `--toc/--table-of-contents` was specified
1040: title of table of contents (works only with EPUB and docx)
1043: contents specified by `-B/--include-before-body` (may have
1047: contents specified by `-A/--include-after-body` (may have
1057: identifies the main language of the document,
1058 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1059 For some output formats, pandoc will convert it to an appropriate
1060 format stored in the additional variables `babel-lang`,
1061 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1063 Native pandoc `span`s and `div`s with the lang attribute
1064 (value in BCP 47) can be used to switch the language in
1068: a list of other languages used in the document
1069 in the YAML metadata, according to [BCP 47]. For example:
1070 `otherlangs: [en-GB, fr]`.
1071 This is automatically generated from the `lang` attributes
1072 in all `span`s and `div`s but can be overriden.
1073 Currently only used by LaTeX through the generated
1074 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1075 The LaTeX writer outputs polyglossia commands in the text but
1076 the `babel-newcommands` variable contains mappings for them
1077 to the corresponding babel.
1080: the base direction of the document, either `rtl` (right-to-left)
1081 or `ltr` (left-to-right).
1083 For bidirectional documents, native pandoc `span`s and `div`s
1084 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1085 override the base direction in some output formats.
1086 This may not always be necessary if the final renderer
1087 (e.g. the browser, when generating HTML) supports the
1088 [Unicode Bidirectional Algorithm].
1090 When using LaTeX for bidirectional documents, only the `xelatex` engine
1091 is fully supported (use `--latex-engine=xelatex`).
1093[BCP 47]: https://tools.ietf.org/html/bcp47
1094[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1099Variables are available for [producing slide shows with pandoc],
1100including all [reveal.js configuration options].
1103: base URL for Slidy documents (defaults to
1104 `http://www.w3.org/Talks/Tools/Slidy2`)
1107: base URL for Slideous documents (defaults to `slideous`)
1110: base URL for S5 documents (defaults to `s5/default`)
1113: base URL for reveal.js documents (defaults to `reveal.js`)
1115`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1116: themes for LaTeX [`beamer`] documents
1118[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1123LaTeX variables are used when [creating a PDF].
1126: font size for body text (e.g. `10pt`, `12pt`)
1129: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1132: option for document class, e.g. `oneside`; may be repeated
1133 for multiple options
1136: option for [`geometry`] package, e.g. `margin=1in`;
1137 may be repeated for multiple options
1140: adjusts line spacing using the [`setspace`]
1141 package, e.g. `1.25`, `1.5`
1144: font package for use with `pdflatex`:
1145 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1146 The default is [Latin Modern][`lm`].
1149: options for package used as `fontfamily`: e.g. `osf,sc` with
1150 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1151 figures and true small caps; may be repeated for multiple options
1153`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1154: font families for use with `xelatex` or
1155 `lualatex`: take the name of any system font, using the
1156 [`fontspec`] package. Note that if `CJKmainfont` is used,
1157 the [`xecjk`] package must be available.
1159`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1160: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1161 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1162 available through [`fontspec`], such as the OpenType features
1163 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1166: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1167 default is `T1` (see guide to [LaTeX font encodings])
1169`linkcolor`, `toccolor`, `urlcolor`, `citecolor`
1170: color for internal links, links in table of contents, external links,
1171 and citation links, using options available through
1172 [`color`] package, e.g. `red`, `green`, `magenta`, `cyan`, `blue`, `black`
1175: enables `hidelinks` option for [`hyperref`], disabling link color
1178: causes links to be printed as footnotes
1181: uses document class settings for indentation (the default LaTeX template
1182 otherwise removes indentation and adds space between paragraphs)
1185: disables default behavior of LaTeX template that redefines (sub)paragraphs
1186 as sections, changing the appearance of nested headings in some classes
1189: include table of contents (can also be set using `--toc/--table-of-contents`)
1192: level of section to include in table of contents
1195: include list of figures, list of tables
1198: bibliography to use for resolving references
1201: bibliography style, when used with `--natbib`
1203[`article`]: https://ctan.org/pkg/article
1204[`report`]: https://ctan.org/pkg/report
1205[`book`]: https://ctan.org/pkg/book
1206[`memoir`]: https://ctan.org/pkg/memoir
1207[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1208[`mathpazo`]: https://ctan.org/pkg/mathpazo
1209[LaTeX font encodings]: https://ctan.org/pkg/encguide
1211Variables for ConTeXt
1212---------------------
1215: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1216 may be repeated for multiple options
1219: options for page margins and text arrangement (see [ConTeXt Layout]);
1220 may be repeated for multiple options
1223: font size for body text (e.g. `10pt`, `12pt`)
1225`mainfont`, `sansfont`, `monofont`, `mathfont`
1226: font families: take the name of any system font (see [ConTeXt Font Switching])
1229: color for links, e.g. `red`, `blue` (see [ConTeXt Color])
1232: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1233 may be repeated for multiple options
1236: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1239: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1240 may be repeated for multiple options
1242`headertext`, `footertext`
1243: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1244 may be repeated up to four times for different placement
1247: page number style and location (using [`setuppagenumbering`]);
1248 may be repeated for multiple options
1251: include table of contents (can also be set using `--toc/--table-of-contents`)
1254: include list of figures, list of tables
1256[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1257[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1258[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1259[ConTeXt Color]: http://wiki.contextgarden.net/Color
1260[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1261[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1262[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1263[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1264[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1266Variables for man pages
1267-----------------------
1270: section number in man pages
1273: header in man pages
1276: footer in man pages
1279: adjusts text to left (`l`), right (`r`), center (`c`),
1280 or both (`b`) margins
1283: if `true` (the default), hyphenation will be used
1285Using variables in templates
1286----------------------------
1288Variable names are sequences of alphanumerics, `-`, and `_`,
1289starting with a letter. A variable name surrounded by `$` signs
1290will be replaced by its value. For example, the string `$title$` in
1292 <title>$title$</title>
1294will be replaced by the document title.
1296To write a literal `$` in a template, use `$$`.
1298Templates may contain conditionals. The syntax is as follows:
1306This will include `X` in the template if `variable` has a non-null
1307value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1308any valid template text, and may include interpolated variables or other
1309conditionals. The `$else$` section may be omitted.
1311When variables can have multiple values (for example, `author` in
1312a multi-author document), you can use the `$for$` keyword:
1315 <meta name="author" content="$author$" />
1318You can optionally specify a separator to be used between
1321 $for(author)$$author$$sep$, $endfor$
1323A dot can be used to select a field of a variable that takes
1324an object as its value. So, for example:
1326 $author.name$ ($author.affiliation$)
1328If you use custom templates, you may need to revise them as pandoc
1329changes. We recommend tracking the changes in the default templates,
1330and modifying your custom templates accordingly. An easy way to do this
1331is to fork the [pandoc-templates] repository and merge in changes after each
1334[pandoc-templates]: https://github.com/jgm/pandoc-templates
1339Pandoc understands an extended and slightly revised version of
1340John Gruber's [Markdown] syntax. This document explains the syntax,
1341noting differences from standard Markdown. Except where noted, these
1342differences can be suppressed by using the `markdown_strict` format instead
1343of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1344to the format name and disabled by adding `-EXTENSION`. For example,
1345`markdown_strict+footnotes` is strict Markdown with footnotes
1346enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1347Markdown without footnotes or pipe tables.
1352Markdown is designed to be easy to write, and, even more importantly,
1355> A Markdown-formatted document should be publishable as-is, as plain
1356> text, without looking like it's been marked up with tags or formatting
1358> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1360This principle has guided pandoc's decisions in finding syntax for
1361tables, footnotes, and other extensions.
1363There is, however, one respect in which pandoc's aims are different
1364from the original aims of Markdown. Whereas Markdown was originally
1365designed with HTML generation in mind, pandoc is designed for multiple
1366output formats. Thus, while pandoc allows the embedding of raw HTML,
1367it discourages it, and provides other, non-HTMLish ways of representing
1368important document elements like definition lists, tables, mathematics, and
1374A paragraph is one or more lines of text followed by one or more blank lines.
1375Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1376If you need a hard line break, put two or more spaces at the end of a line.
1378#### Extension: `escaped_line_breaks` ####
1380A backslash followed by a newline is also a hard line break.
1381Note: in multiline and grid table cells, this is the only way
1382to create a hard line break, since trailing spaces in the cells
1388There are two kinds of headers: Setext and ATX.
1390### Setext-style headers ###
1392A setext-style header is a line of text "underlined" with a row of `=` signs
1393(for a level one header) or `-` signs (for a level two header):
1401The header text can contain inline formatting, such as emphasis (see
1402[Inline formatting], below).
1405### ATX-style headers ###
1407An ATX-style header consists of one to six `#` signs and a line of
1408text, optionally followed by any number of `#` signs. The number of
1409`#` signs at the beginning of the line is the header level:
1411 ## A level-two header
1413 ### A level-three header ###
1415As with setext-style headers, the header text can contain formatting:
1417 # A level-one header with a [link](/url) and *emphasis*
1419#### Extension: `blank_before_header` ####
1421Standard Markdown syntax does not require a blank line before a header.
1422Pandoc does require this (except, of course, at the beginning of the
1423document). The reason for the requirement is that it is all too easy for a
1424`#` to end up at the beginning of a line by accident (perhaps through line
1425wrapping). Consider, for example:
1427 I like several of their flavors of ice cream:
1428 #22, for example, and #5.
1431### Header identifiers ###
1433#### Extension: `header_attributes` ####
1435Headers can be assigned attributes using this syntax at the end
1436of the line containing the header text:
1438 {#identifier .class .class key=value key=value}
1440Thus, for example, the following headers will all be assigned the identifier
1445 ## My header ## {#foo}
1447 My other header {#foo}
1450(This syntax is compatible with [PHP Markdown Extra].)
1452Note that although this syntax allows assignment of classes and key/value
1453attributes, writers generally don't use all of this information. Identifiers,
1454classes, and key/value attributes are used in HTML and HTML-based formats such
1455as EPUB and slidy. Identifiers are used for labels and link anchors in the
1456LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1458Headers with the class `unnumbered` will not be numbered, even if
1459`--number-sections` is specified. A single hyphen (`-`) in an attribute
1460context is equivalent to `.unnumbered`, and preferable in non-English
1467 # My header {.unnumbered}
1469#### Extension: `auto_identifiers` ####
1471A header without an explicitly specified identifier will be
1472automatically assigned a unique identifier based on the header text.
1473To derive the identifier from the header text,
1475 - Remove all formatting, links, etc.
1476 - Remove all footnotes.
1477 - Remove all punctuation, except underscores, hyphens, and periods.
1478 - Replace all spaces and newlines with hyphens.
1479 - Convert all alphabetic characters to lowercase.
1480 - Remove everything up to the first letter (identifiers may
1481 not begin with a number or punctuation mark).
1482 - If nothing is left after this, use the identifier `section`.
1487 ------------------------------- ----------------------------
1488 `Header identifiers in HTML` `header-identifiers-in-html`
1489 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1490 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1491 `3. Applications` `applications`
1494These rules should, in most cases, allow one to determine the identifier
1495from the header text. The exception is when several headers have the
1496same text; in this case, the first will get an identifier as described
1497above; the second will get the same identifier with `-1` appended; the
1498third with `-2`; and so on.
1500These identifiers are used to provide link targets in the table of
1501contents generated by the `--toc|--table-of-contents` option. They
1502also make it easy to provide links from one section of a document to
1503another. A link to this section, for example, might look like this:
1506 [header identifiers](#header-identifiers-in-html-latex-and-context).
1508Note, however, that this method of providing links to sections works
1509only in HTML, LaTeX, and ConTeXt formats.
1511If the `--section-divs` option is specified, then each section will
1512be wrapped in a `div` (or a `section`, if `--html5` was specified),
1513and the identifier will be attached to the enclosing `<div>`
1514(or `<section>`) tag rather than the header itself. This allows entire
1515sections to be manipulated using javascript or treated differently in
1518#### Extension: `implicit_header_references` ####
1520Pandoc behaves as if reference links have been defined for each header.
1523 [header identifiers](#header-identifiers-in-html)
1527 [header identifiers]
1531 [header identifiers][]
1535 [the section on header identifiers][header identifiers]
1537If there are multiple headers with identical text, the corresponding
1538reference will link to the first one only, and you will need to use explicit
1539links to link to the others, as described above.
1541Like regular reference links, these references are case-insensitive.
1543Explicit link reference definitions always take priority over
1544implicit header references. So, in the following example, the
1545link will point to `bar`, not to `#foo`:
1556Markdown uses email conventions for quoting blocks of text.
1557A block quotation is one or more paragraphs or other block elements
1558(such as lists or headers), with each line preceded by a `>` character
1559and an optional space. (The `>` need not start at the left margin, but
1560it should not be indented more than three spaces.)
1562 > This is a block quote. This
1563 > paragraph has two lines.
1565 > 1. This is a list inside a block quote.
1568A "lazy" form, which requires the `>` character only on the first
1569line of each block, is also allowed:
1571 > This is a block quote. This
1572 paragraph has two lines.
1574 > 1. This is a list inside a block quote.
1577Among the block elements that can be contained in a block quote are
1578other block quotes. That is, block quotes can be nested:
1580 > This is a block quote.
1582 > > A block quote within a block quote.
1584If the `>` character is followed by an optional space, that space
1585will be considered part of the block quote marker and not part of
1586the indentation of the contents. Thus, to put an indented code
1587block in a block quote, you need five spaces after the `>`:
1591#### Extension: `blank_before_blockquote` ####
1593Standard Markdown syntax does not require a blank line before a block
1594quote. Pandoc does require this (except, of course, at the beginning of the
1595document). The reason for the requirement is that it is all too easy for a
1596`>` to end up at the beginning of a line by accident (perhaps through line
1597wrapping). So, unless the `markdown_strict` format is used, the following does
1598not produce a nested block quote in pandoc:
1600 > This is a block quote.
1604Verbatim (code) blocks
1605----------------------
1607### Indented code blocks ###
1609A block of text indented four spaces (or one tab) is treated as verbatim
1610text: that is, special characters do not trigger special formatting,
1611and all spaces and line breaks are preserved. For example,
1614 moveShip(5 * gravity, DOWN);
1617The initial (four space or one tab) indentation is not considered part
1618of the verbatim text, and is removed in the output.
1620Note: blank lines in the verbatim text need not begin with four spaces.
1623### Fenced code blocks ###
1625#### Extension: `fenced_code_blocks` ####
1627In addition to standard indented code blocks, pandoc supports
1628*fenced* code blocks. These begin with a row of three or more
1629tildes (`~`) and end with a row of tildes that must be at least as long as
1630the starting row. Everything between these lines is treated as code. No
1631indentation is necessary:
1635 moveShip(5 * gravity, DOWN);
1639Like regular code blocks, fenced code blocks must be separated
1640from surrounding text by blank lines.
1642If the code itself contains a row of tildes or backticks, just use a longer
1643row of tildes or backticks at the start and end:
1647 code including tildes
1651#### Extension: `backtick_code_blocks` ####
1653Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1656#### Extension: `fenced_code_attributes` ####
1658Optionally, you may attach attributes to fenced or backtick code block using
1661 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1663 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1664 qsort (filter (>= x) xs)
1665 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1667Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1668`startFrom` is an attribute with value `100`. Some output formats can use this
1669information to do syntax highlighting. Currently, the only output formats
1670that uses this information are HTML and LaTeX. If highlighting is supported
1671for your output format and language, then the code block above will appear
1672highlighted, with numbered lines. (To see which languages are supported, do
1673`pandoc --version`.) Otherwise, the code block above will appear as follows:
1675 <pre id="mycode" class="haskell numberLines" startFrom="100">
1681A shortcut form can also be used for specifying the language of
1688This is equivalent to:
1694If the `fenced_code_attributes` extension is disabled, but
1695input contains class attribute(s) for the codeblock, the first
1696class attribute will be printed after the opening fence as a bare
1699To prevent all highlighting, use the `--no-highlight` flag.
1700To set the highlighting style, use `--highlight-style`.
1701For more information on highlighting, see [Syntax highlighting],
1707#### Extension: `line_blocks` ####
1709A line block is a sequence of lines beginning with a vertical bar (`|`)
1710followed by a space. The division into lines will be preserved in
1711the output, as will any leading spaces; otherwise, the lines will
1712be formatted as Markdown. This is useful for verse and addresses:
1714 | The limerick packs laughs anatomical
1715 | In space that is quite economical.
1716 | But the good ones I've seen
1717 | So seldom are clean
1718 | And the clean ones so seldom are comical
1721 | Berkeley, CA 94718
1723The lines can be hard-wrapped if needed, but the continuation
1724line must begin with a space.
1726 | The Right Honorable Most Venerable and Righteous Samuel L.
1729 | Berkeley, CA 94718
1731This syntax is borrowed from [reStructuredText].
1738A bullet list is a list of bulleted list items. A bulleted list
1739item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1746This will produce a "compact" list. If you want a "loose" list, in which
1747each item is formatted as a paragraph, put spaces between the items:
1755The bullets need not be flush with the left margin; they may be
1756indented one, two, or three spaces. The bullet must be followed
1759List items look best if subsequent lines are flush with the first
1760line (after the bullet):
1766But Markdown also allows a "lazy" format:
1772### The four-space rule ###
1774A list item may contain multiple paragraphs and other block-level
1775content. However, subsequent paragraphs must be preceded by a blank line
1776and indented four spaces or a tab. The list will look better if the first
1777paragraph is aligned with the rest:
1783 * Second paragraph. With a code block, which must be indented
1788List items may include other lists. In this case the preceding blank
1789line is optional. The nested list must be indented four spaces or
1802As noted above, Markdown allows you to write list items "lazily," instead of
1803indenting continuation lines. However, if there are multiple paragraphs or
1804other blocks in a list item, the first line of each must be indented.
1806 + A lazy, lazy, list
1809 + Another one; this looks
1812 Second paragraph of second
1815**Note:** Although the four-space rule for continuation paragraphs
1816comes from the official [Markdown syntax guide], the reference implementation,
1817`Markdown.pl`, does not follow it. So pandoc will give different results than
1818`Markdown.pl` when authors have indented continuation paragraphs fewer than
1821The [Markdown syntax guide] is not explicit whether the four-space
1822rule applies to *all* block-level content in a list item; it only
1823mentions paragraphs and code blocks. But it implies that the rule
1824applies to all block-level content (including nested lists), and
1825pandoc interprets it that way.
1827 [Markdown syntax guide]:
1828 http://daringfireball.net/projects/markdown/syntax#list
1830### Ordered lists ###
1832Ordered lists work just like bulleted lists, except that the items
1833begin with enumerators rather than bullets.
1835In standard Markdown, enumerators are decimal numbers followed
1836by a period and a space. The numbers themselves are ignored, so
1837there is no difference between this list:
1849#### Extension: `fancy_lists` ####
1851Unlike standard Markdown, pandoc allows ordered list items to be marked
1852with uppercase and lowercase letters and roman numerals, in addition to
1853arabic numerals. List markers may be enclosed in parentheses or followed by a
1854single right-parentheses or period. They must be separated from the
1855text that follows by at least one space, and, if the list marker is a
1856capital letter with a period, by at least two spaces.[^2]
1858[^2]: The point of this rule is to ensure that normal paragraphs
1859 starting with people's initials, like
1861 B. Russell was an English philosopher.
1863 do not get treated as list items.
1865 This rule will not prevent
1869 from being interpreted as a list item. In this case, a backslash
1874The `fancy_lists` extension also allows '`#`' to be used as an
1875ordered list marker in place of a numeral:
1880#### Extension: `startnum` ####
1882Pandoc also pays attention to the type of list marker used, and to the
1883starting number, and both of these are preserved where possible in the
1884output format. Thus, the following yields a list with numbers followed
1885by a single parenthesis, starting with 9, and a sublist with lowercase
1895Pandoc will start a new list each time a different type of list
1896marker is used. So, the following will create three lists:
1903If default list markers are desired, use `#.`:
1910### Definition lists ###
1912#### Extension: `definition_lists` ####
1914Pandoc supports definition lists, using the syntax of
1915[PHP Markdown Extra] with some extensions.[^3]
1921 Term 2 with *inline markup*
1925 { some code, part of Definition 2 }
1927 Third paragraph of definition 2.
1929Each term must fit on one line, which may optionally be followed by
1930a blank line, and must be followed by one or more definitions.
1931A definition begins with a colon or tilde, which may be indented one
1934A term may have multiple definitions, and each definition may consist of one or
1935more block elements (paragraph, code block, list, etc.), each indented four
1936spaces or one tab stop. The body of the definition (including the first line,
1937aside from the colon or tilde) should be indented four spaces. However,
1938as with other Markdown lists, you can "lazily" omit indentation except
1939at the beginning of a paragraph or other block element:
1944 with lazy continuation.
1946 Second paragraph of the definition.
1948If you leave space before the definition (as in the example above),
1949the text of the definition will be treated as a paragraph. In some
1950output formats, this will mean greater spacing between term/definition
1951pairs. For a more compact definition list, omit the space before the
1961Note that space between items in a definition list is required.
1962(A variant that loosens this requirement, but disallows "lazy"
1963hard wrapping, can be activated with `compact_definition_lists`: see
1964[Non-pandoc extensions], below.)
1966[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1968### Numbered example lists ###
1970#### Extension: `example_lists` ####
1972The special list marker `@` can be used for sequentially numbered
1973examples. The first list item with a `@` marker will be numbered '1',
1974the next '2', and so on, throughout the document. The numbered examples
1975need not occur in a single list; each new list using `@` will take up
1976where the last stopped. So, for example:
1978 (@) My first example will be numbered (1).
1979 (@) My second example will be numbered (2).
1981 Explanation of examples.
1983 (@) My third example will be numbered (3).
1985Numbered examples can be labeled and referred to elsewhere in the
1988 (@good) This is a good example.
1990 As (@good) illustrates, ...
1992The label can be any string of alphanumeric characters, underscores,
1996### Compact and loose lists ###
1998Pandoc behaves differently from `Markdown.pl` on some "edge
1999cases" involving lists. Consider this source:
2009Pandoc transforms this into a "compact list" (with no `<p>` tags around
2010"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2011"Second" and "Third" (but not "First"), because of the blank space
2012around "Third". Pandoc follows a simple rule: if the text is followed by
2013a blank line, it is treated as a paragraph. Since "Second" is followed
2014by a list, and not a blank line, it isn't treated as a paragraph. The
2015fact that the list is followed by a blank line is irrelevant. (Note:
2016Pandoc works this way even when the `markdown_strict` format is specified. This
2017behavior is consistent with the official Markdown syntax description,
2018even though it is different from that of `Markdown.pl`.)
2021### Ending a list ###
2023What if you want to put an indented code block after a list?
2030Trouble! Here pandoc (like other Markdown implementations) will treat
2031`{ my code block }` as the second paragraph of item two, and not as
2034To "cut off" the list after item two, you can insert some non-indented
2035content, like an HTML comment, which won't produce visible output in
2041 <!-- end of list -->
2045You can use the same trick if you want two consecutive lists instead
2061A line containing a row of three or more `*`, `-`, or `_` characters
2062(optionally separated by spaces) produces a horizontal rule:
2072Four kinds of tables may be used. The first three kinds presuppose the use of
2073a fixed-width font, such as Courier. The fourth kind can be used with
2074proportionally spaced fonts, as it does not require lining up columns.
2076#### Extension: `table_captions` ####
2078A caption may optionally be provided with all 4 kinds of tables (as
2079illustrated in the examples below). A caption is a paragraph beginning
2080with the string `Table:` (or just `:`), which will be stripped off.
2081It may appear either before or after the table.
2083#### Extension: `simple_tables` ####
2085Simple tables look like this:
2087 Right Left Center Default
2088 ------- ------ ---------- -------
2093 Table: Demonstration of simple table syntax.
2095The headers and table rows must each fit on one line. Column
2096alignments are determined by the position of the header text relative
2097to the dashed line below it:[^4]
2099 - If the dashed line is flush with the header text on the right side
2100 but extends beyond it on the left, the column is right-aligned.
2101 - If the dashed line is flush with the header text on the left side
2102 but extends beyond it on the right, the column is left-aligned.
2103 - If the dashed line extends beyond the header text on both sides,
2104 the column is centered.
2105 - If the dashed line is flush with the header text on both sides,
2106 the default alignment is used (in most cases, this will be left).
2108[^4]: This scheme is due to Michel Fortin, who proposed it on the
2109 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2111The table must end with a blank line, or a line of dashes followed by
2114The column headers may be omitted, provided a dashed line is used
2115to end the table. For example:
2117 ------- ------ ---------- -------
2121 ------- ------ ---------- -------
2123When headers are omitted, column alignments are determined on the basis
2124of the first line of the table body. So, in the tables above, the columns
2125would be right, left, center, and right aligned, respectively.
2127#### Extension: `multiline_tables` ####
2129Multiline tables allow headers and table rows to span multiple lines
2130of text (but cells that span multiple columns or rows of the table are
2131not supported). Here is an example:
2133 -------------------------------------------------------------
2134 Centered Default Right Left
2135 Header Aligned Aligned Aligned
2136 ----------- ------- --------------- -------------------------
2137 First row 12.0 Example of a row that
2138 spans multiple lines.
2140 Second row 5.0 Here's another one. Note
2141 the blank line between
2143 -------------------------------------------------------------
2145 Table: Here's the caption. It, too, may span
2148These work like simple tables, but with the following differences:
2150 - They must begin with a row of dashes, before the header text
2151 (unless the headers are omitted).
2152 - They must end with a row of dashes, then a blank line.
2153 - The rows must be separated by blank lines.
2155In multiline tables, the table parser pays attention to the widths of
2156the columns, and the writers try to reproduce these relative widths in
2157the output. So, if you find that one of the columns is too narrow in the
2158output, try widening it in the Markdown source.
2160Headers may be omitted in multiline tables as well as simple tables:
2162 ----------- ------- --------------- -------------------------
2163 First row 12.0 Example of a row that
2164 spans multiple lines.
2166 Second row 5.0 Here's another one. Note
2167 the blank line between
2169 ----------- ------- --------------- -------------------------
2171 : Here's a multiline table without headers.
2173It is possible for a multiline table to have just one row, but the row
2174should be followed by a blank line (and then the row of dashes that ends
2175the table), or the table may be interpreted as a simple table.
2177#### Extension: `grid_tables` ####
2179Grid tables look like this:
2181 : Sample grid table.
2183 +---------------+---------------+--------------------+
2184 | Fruit | Price | Advantages |
2185 +===============+===============+====================+
2186 | Bananas | $1.34 | - built-in wrapper |
2187 | | | - bright color |
2188 +---------------+---------------+--------------------+
2189 | Oranges | $2.10 | - cures scurvy |
2191 +---------------+---------------+--------------------+
2193The row of `=`s separates the header from the table body, and can be
2194omitted for a headerless table. The cells of grid tables may contain
2195arbitrary block elements (multiple paragraphs, code blocks, lists,
2196etc.). Alignments are not supported, nor are cells that span multiple
2197columns or rows. Grid tables can be created easily using [Emacs table mode].
2199[Emacs table mode]: http://table.sourceforge.net/
2201#### Extension: `pipe_tables` ####
2203Pipe tables look like this:
2205 | Right | Left | Default | Center |
2206 |------:|:-----|---------|:------:|
2207 | 12 | 12 | 12 | 12 |
2208 | 123 | 123 | 123 | 123 |
2211 : Demonstration of pipe table syntax.
2213The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2214ending pipe characters are optional, but pipes are required between all
2215columns. The colons indicate column alignment as shown. The header
2216cannot be omitted. To simulate a headerless table, include a header
2219Since the pipes indicate column boundaries, columns need not be vertically
2220aligned, as they are in the above example. So, this is a perfectly
2221legal (though ugly) pipe table:
2229The cells of pipe tables cannot contain block elements like paragraphs
2230and lists, and cannot span multiple lines. Note also that in LaTeX/PDF
2231output, the cells produced by pipe tables will not wrap, since there
2232is no information available about relative widths. If you want content
2233to wrap within cells, use multiline or grid tables.
2235Note: pandoc also recognizes pipe tables of the following
2236form, as can be produced by Emacs' orgtbl-mode:
2243The difference is that `+` is used instead of `|`. Other orgtbl features
2244are not supported. In particular, to get non-default column alignment,
2245you'll need to add colons as above.
2247[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2252#### Extension: `pandoc_title_block` ####
2254If the file begins with a title block
2257 % author(s) (separated by semicolons)
2260it will be parsed as bibliographic information, not regular text. (It
2261will be used, for example, in the title of standalone LaTeX or HTML
2262output.) The block may contain just a title, a title and an author,
2263or all three elements. If you want to include an author but no
2264title, or a title and a date but no author, you need a blank line:
2273The title may occupy multiple lines, but continuation lines must
2274begin with leading space, thus:
2279If a document has multiple authors, the authors may be put on
2280separate lines with leading space, or separated by semicolons, or
2281both. So, all of the following are equivalent:
2286 % Author One; Author Two
2291The date must fit on one line.
2293All three metadata fields may contain standard inline formatting
2294(italics, links, footnotes, etc.).
2296Title blocks will always be parsed, but they will affect the output only
2297when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2298will appear twice: once in the document head -- this is the title that
2299will appear at the top of the window in a browser -- and once at the
2300beginning of the document body. The title in the document head can have
2301an optional prefix attached (`--title-prefix` or `-T` option). The title
2302in the body appears as an H1 element with class "title", so it can be
2303suppressed or reformatted with CSS. If a title prefix is specified with
2304`-T` and no title block appears in the document, the title prefix will
2305be used by itself as the HTML title.
2307The man page writer extracts a title, man page section number, and
2308other header and footer information from the title line. The title
2309is assumed to be the first word on the title line, which may optionally
2310end with a (single-digit) section number in parentheses. (There should
2311be no space between the title and the parentheses.) Anything after
2312this is assumed to be additional footer and header text. A single pipe
2313character (`|`) should be used to separate the footer text from the header
2318will yield a man page with the title `PANDOC` and section 1.
2320 % PANDOC(1) Pandoc User Manuals
2322will also have "Pandoc User Manuals" in the footer.
2324 % PANDOC(1) Pandoc User Manuals | Version 4.0
2326will also have "Version 4.0" in the header.
2328#### Extension: `yaml_metadata_block` ####
2330A YAML metadata block is a valid YAML object, delimited by a line of three
2331hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2332(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2333document, but if it is not at the beginning, it must be preceded by a blank
2334line. (Note that, because of the way pandoc concatenates input files when
2335several are provided, you may also keep the metadata in a separate YAML file
2336and pass it to pandoc as an argument, along with your Markdown files:
2338 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2340Just be sure that the YAML file begins with `---` and ends with `---` or
2343Metadata will be taken from the fields of the YAML object and added to any
2344existing document metadata. Metadata can contain lists and objects (nested
2345arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2346with names ending in an underscore will be ignored by pandoc. (They may be
2347given a role by external processors.)
2349A document may contain multiple metadata blocks. The metadata fields will
2350be combined through a *left-biased union*: if two metadata blocks attempt
2351to set the same field, the value from the first block will be taken.
2353When pandoc is used with `-t markdown` to create a Markdown document,
2354a YAML metadata block will be produced only if the `-s/--standalone`
2355option is used. All of the metadata will appear in a single block
2356at the beginning of the document.
2358Note that YAML escaping rules must be followed. Thus, for example,
2359if a title contains a colon, it must be quoted. The pipe character
2360(`|`) can be used to begin an indented block that will be interpreted
2361literally, without need for escaping. This form is necessary
2362when the field contains blank lines:
2365 title: 'This is the title: it contains a colon'
2368 affiliation: University of Somewhere
2370 affiliation: University of Nowhere
2371 tags: [nothing, nothingness]
2373 This is the abstract.
2375 It consists of two paragraphs.
2378Template variables will be set automatically from the metadata. Thus, for
2379example, in writing HTML, the variable `abstract` will be set to the HTML
2380equivalent of the Markdown in the `abstract` field:
2382 <p>This is the abstract.</p>
2383 <p>It consists of two paragraphs.</p>
2385Note: The `author` variable in the default templates expects a simple list or
2386string. To use the structured authors in the example, you would need a
2387custom template. For example:
2391 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2401#### Extension: `all_symbols_escapable` ####
2403Except inside a code block or inline code, any punctuation or space
2404character preceded by a backslash will be treated literally, even if it
2405would normally indicate formatting. Thus, for example, if one writes
2415 <strong>hello</strong>
2417This rule is easier to remember than standard Markdown's rule,
2418which allows only the following characters to be backslash-escaped:
2422(However, if the `markdown_strict` format is used, the standard Markdown rule
2425A backslash-escaped space is parsed as a nonbreaking space. It will
2426appear in TeX output as `~` and in HTML and XML as `\ ` or
2429A backslash-escaped newline (i.e. a backslash occurring at the end of
2430a line) is parsed as a hard line break. It will appear in TeX output as
2431`\\` and in HTML as `<br />`. This is a nice alternative to
2432Markdown's "invisible" way of indicating hard line breaks using
2433two trailing spaces on a line.
2435Backslash escapes do not work in verbatim contexts.
2442If the `--smart` option is specified, pandoc will produce typographically
2443correct output, converting straight quotes to curly quotes, `---` to
2444em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2445are inserted after certain abbreviations, such as "Mr."
2447Note: if your LaTeX template calls for the [`csquotes`] package, pandoc will
2448detect this automatically and use `\enquote{...}` for quoted text.
2455To *emphasize* some text, surround it with `*`s or `_`, like this:
2457 This text is _emphasized with underscores_, and this
2458 is *emphasized with asterisks*.
2460Double `*` or `_` produces **strong emphasis**:
2462 This is **strong emphasis** and __with underscores__.
2464A `*` or `_` character surrounded by spaces, or backslash-escaped,
2465will not trigger emphasis:
2467 This is * not emphasized *, and \*neither is this\*.
2469#### Extension: `intraword_underscores` ####
2471Because `_` is sometimes used inside words and identifiers,
2472pandoc does not interpret a `_` surrounded by alphanumeric
2473characters as an emphasis marker. If you want to emphasize
2474just part of a word, use `*`:
2476 feas*ible*, not feas*able*.
2481#### Extension: `strikeout` ####
2483To strikeout a section of text with a horizontal line, begin and end it
2484with `~~`. Thus, for example,
2486 This ~~is deleted text.~~
2489### Superscripts and subscripts ###
2491#### Extension: `superscript`, `subscript` ####
2493Superscripts may be written by surrounding the superscripted text by `^`
2494characters; subscripts may be written by surrounding the subscripted
2495text by `~` characters. Thus, for example,
2497 H~2~O is a liquid. 2^10^ is 1024.
2499If the superscripted or subscripted text contains spaces, these spaces
2500must be escaped with backslashes. (This is to prevent accidental
2501superscripting and subscripting through the ordinary use of `~` and `^`.)
2502Thus, if you want the letter P with 'a cat' in subscripts, use
2503`P~a\ cat~`, not `P~a cat~`.
2508To make a short span of text verbatim, put it inside backticks:
2510 What is the difference between `>>=` and `>>`?
2512If the verbatim text includes a backtick, use double backticks:
2514 Here is a literal backtick `` ` ``.
2516(The spaces after the opening backticks and before the closing
2517backticks will be ignored.)
2519The general rule is that a verbatim span starts with a string
2520of consecutive backticks (optionally followed by a space)
2521and ends with a string of the same number of backticks (optionally
2522preceded by a space).
2524Note that backslash-escapes (and other Markdown constructs) do not
2525work in verbatim contexts:
2527 This is a backslash followed by an asterisk: `\*`.
2529#### Extension: `inline_code_attributes` ####
2531Attributes can be attached to verbatim text, just as with
2532[fenced code blocks]:
2538To write small caps, you can use an HTML span tag:
2540 <span style="font-variant:small-caps;">Small caps</span>
2542(The semicolon is optional and there may be space after the
2543colon.) This will work in all output formats that support small caps.
2548#### Extension: `tex_math_dollars` ####
2550Anything between two `$` characters will be treated as TeX math. The
2551opening `$` must have a non-space character immediately to its right,
2552while the closing `$` must have a non-space character immediately to its
2553left, and must not be followed immediately by a digit. Thus,
2554`$20,000 and $30,000` won't parse as math. If for some reason
2555you need to enclose text in literal `$` characters, backslash-escape
2556them and they won't be treated as math delimiters.
2558TeX math will be printed in all output formats. How it is rendered
2559depends on the output format:
2561Markdown, LaTeX, Emacs Org mode, ConTeXt
2562 ~ It will appear verbatim between `$` characters.
2565 ~ It will be rendered using an [interpreted text role `:math:`].
2568 ~ It will be rendered as `latexmath:[...]`.
2571 ~ It will be rendered inside a `@math` command.
2574 ~ It will be rendered verbatim without `$`'s.
2577 ~ It will be rendered inside `<math>` tags.
2580 ~ It will be rendered inside `<span class="math">` tags.
2582RTF, OpenDocument, ODT
2583 ~ It will be rendered, if possible, using unicode characters,
2584 and will otherwise appear verbatim.
2587 ~ If the `--mathml` flag is used, it will be rendered using MathML
2588 in an `inlineequation` or `informalequation` tag. Otherwise it
2589 will be rendered, if possible, using unicode characters.
2592 ~ It will be rendered using OMML math markup.
2595 ~ If the `--webtex` option is used, formulas are rendered as images
2596 using Google Charts or other compatible web service, downloaded
2597 and embedded in the e-book. Otherwise, they will appear verbatim.
2599HTML, Slidy, DZSlides, S5, EPUB
2600 ~ The way math is rendered in HTML will depend on the
2601 command-line options selected:
2603 1. The default is to render TeX math as far as possible using unicode
2604 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2605 are put inside a `span` with `class="math"`, so that they may be
2606 styled differently from the surrounding text if needed.
2608 2. If the `--latexmathml` option is used, TeX math will be displayed
2609 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2610 The [LaTeXMathML] script will be used to render it as formulas.
2611 (This trick does not work in all browsers, but it works in Firefox.
2612 In browsers that do not support LaTeXMathML, TeX math will appear
2613 verbatim between `$` characters.)
2615 3. If the `--jsmath` option is used, TeX math will be put inside
2616 `<span>` tags (for inline math) or `<div>` tags (for display math)
2617 with class `math`. The [jsMath] script will be used to render
2620 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2621 be called to generate images for each TeX formula. This should
2622 work in all browsers. The `--mimetex` option takes an optional URL
2623 as argument. If no URL is specified, it will be assumed that the
2624 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2626 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2627 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2628 be processed by [gladTeX], which will produce image files for each
2629 formula and an HTML file with links to these images. So, the
2632 pandoc -s --gladtex myfile.txt -o myfile.htex
2633 gladtex -d myfile-images myfile.htex
2634 # produces myfile.html and images in myfile-images
2636 6. If the `--webtex` option is used, TeX formulas will be converted
2637 to `<img>` tags that link to an external script that converts
2638 formulas to images. The formula will be URL-encoded and concatenated
2639 with the URL provided. If no URL is specified, the Google Chart
2640 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2642 7. If the `--mathjax` option is used, TeX math will be displayed
2643 between `\(...\)` (for inline math) or `\[...\]` (for display
2644 math) and put in `<span>` tags with class `math`.
2645 The [MathJax] script will be used to render it as formulas.
2647[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2652#### Extension: `raw_html` ####
2654Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2655(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2656literally). (Technically this is not an extension, since standard
2657Markdown allows it, but it has been made an extension so that it can
2658be disabled if desired.)
2660The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2661DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2664#### Extension: `markdown_in_html_blocks` ####
2666Standard Markdown allows you to include HTML "blocks": blocks
2667of HTML between balanced tags that are separated from the surrounding text
2668with blank lines, and start and end at the left margin. Within
2669these blocks, everything is interpreted as HTML, not Markdown;
2670so (for example), `*` does not signify emphasis.
2672Pandoc behaves this way when the `markdown_strict` format is used; but
2673by default, pandoc interprets material between HTML block tags as Markdown.
2674Thus, for example, pandoc will turn
2679 <td>[a link](http://google.com)</td>
2687 <td><em>one</em></td>
2688 <td><a href="http://google.com">a link</a></td>
2692whereas `Markdown.pl` will preserve it as is.
2694There is one exception to this rule: text between `<script>` and
2695`<style>` tags is not interpreted as Markdown.
2697This departure from standard Markdown should make it easier to mix
2698Markdown with HTML block elements. For example, one can surround
2699a block of Markdown text with `<div>` tags without preventing it
2700from being interpreted as Markdown.
2702#### Extension: `native_divs` ####
2704Use native pandoc `Div` blocks for content inside `<div>` tags.
2705For the most part this should give the same output as
2706`markdown_in_html_blocks`, but it makes it easier to write pandoc
2707filters to manipulate groups of blocks.
2709#### Extension: `native_spans` ####
2711Use native pandoc `Span` blocks for content inside `<span>` tags.
2712For the most part this should give the same output as `raw_html`,
2713but it makes it easier to write pandoc filters to manipulate groups
2719#### Extension: `raw_tex` ####
2721In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2722included in a document. Inline TeX commands will be preserved and passed
2723unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2724LaTeX to include BibTeX citations:
2726 This result was proved in \cite{jones.1967}.
2728Note that in LaTeX environments, like
2730 \begin{tabular}{|l|l|}\hline
2731 Age & Frequency \\ \hline
2734 36--45 & 22 \\ \hline
2737the material between the begin and end tags will be interpreted as raw
2738LaTeX, not as Markdown.
2740Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2746#### Extension: `latex_macros` ####
2748For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2749`\renewcommand` definitions and apply the resulting macros to all LaTeX
2750math. So, for example, the following will work in all output formats,
2753 \newcommand{\tuple}[1]{\langle #1 \rangle}
2757In LaTeX output, the `\newcommand` definition will simply be passed
2758unchanged to the output.
2764Markdown allows links to be specified in several ways.
2766### Automatic links ###
2768If you enclose a URL or email address in pointy brackets, it
2772 <sam@green.eggs.ham>
2776An inline link consists of the link text in square brackets,
2777followed by the URL in parentheses. (Optionally, the URL can
2778be followed by a link title, in quotes.)
2780 This is an [inline link](/url), and here's [one with
2781 a title](http://fsf.org "click here for a good time!").
2783There can be no space between the bracketed part and the parenthesized part.
2784The link text can contain formatting (such as emphasis), but the title cannot.
2786Email addresses in inline links are not autodetected, so they have to be
2787prefixed with `mailto`:
2789 [Write me!](mailto:sam@green.eggs.ham)
2791### Reference links ###
2793An *explicit* reference link has two parts, the link itself and the link
2794definition, which may occur elsewhere in the document (either
2795before or after the link).
2797The link consists of link text in square brackets, followed by a label in
2798square brackets. (There can be space between the two.) The link definition
2799consists of the bracketed label, followed by a colon and a space, followed by
2800the URL, and optionally (after a space) a link title either in quotes or in
2801parentheses. The label must not be parseable as a citation (assuming
2802the `citations` extension is enabled): citations take precedence over
2805Here are some examples:
2807 [my label 1]: /foo/bar.html "My title, optional"
2809 [my label 3]: http://fsf.org (The free software foundation)
2810 [my label 4]: /bar#special 'A title in single quotes'
2812The URL may optionally be surrounded by angle brackets:
2814 [my label 5]: <http://foo.bar.baz>
2816The title may go on the next line:
2818 [my label 3]: http://fsf.org
2819 "The free software foundation"
2821Note that link labels are not case sensitive. So, this will work:
2823 Here is [my link][FOO]
2827In an *implicit* reference link, the second pair of brackets is
2832 [my website]: http://foo.bar.baz
2834Note: In `Markdown.pl` and most other Markdown implementations,
2835reference link definitions cannot occur in nested constructions
2836such as list items or block quotes. Pandoc lifts this arbitrary
2837seeming restriction. So the following is fine in pandoc, though
2838not in most other implementations:
2844#### Extension: `shortcut_reference_links` ####
2846In a *shortcut* reference link, the second pair of brackets may
2851 [my website]: http://foo.bar.baz
2853### Internal links ###
2855To link to another section of the same document, use the automatically
2856generated identifier (see [Header identifiers]). For example:
2858 See the [Introduction](#introduction).
2862 See the [Introduction].
2864 [Introduction]: #introduction
2866Internal links are currently supported for HTML formats (including
2867HTML slide shows and EPUB), LaTeX, and ConTeXt.
2872A link immediately preceded by a `!` will be treated as an image.
2873The link text will be used as the image's alt text:
2875 
2879 [movie reel]: movie.gif
2881#### Extension: `implicit_figures` ####
2883An image occurring by itself in a paragraph will be rendered as
2884a figure with a caption.[^5] (In LaTeX, a figure environment will be
2885used; in HTML, the image will be placed in a `div` with class
2886`figure`, together with a caption in a `p` with class `caption`.)
2887The image's alt text will be used as the caption.
2889 
2891[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2892 ODT. In those formats, you'll just get an image in a paragraph by
2893 itself, with no caption.
2895If you just want a regular inline image, just make sure it is not
2896the only thing in the paragraph. One way to do this is to insert a
2897nonbreaking space after the image:
2899 \
2905#### Extension: `footnotes` ####
2907Pandoc's Markdown allows footnotes, using the following syntax:
2909 Here is a footnote reference,[^1] and another.[^longnote]
2911 [^1]: Here is the footnote.
2913 [^longnote]: Here's one with multiple blocks.
2915 Subsequent paragraphs are indented to show that they
2916 belong to the previous footnote.
2920 The whole paragraph can be indented, or just the first
2921 line. In this way, multi-paragraph footnotes work like
2922 multi-paragraph list items.
2924 This paragraph won't be part of the note, because it
2927The identifiers in footnote references may not contain spaces, tabs,
2928or newlines. These identifiers are used only to correlate the
2929footnote reference with the note itself; in the output, footnotes
2930will be numbered sequentially.
2932The footnotes themselves need not be placed at the end of the
2933document. They may appear anywhere except inside other block elements
2934(lists, block quotes, tables, etc.).
2936#### Extension: `inline_notes` ####
2938Inline footnotes are also allowed (though, unlike regular notes,
2939they cannot contain multiple paragraphs). The syntax is as follows:
2941 Here is an inline note.^[Inlines notes are easier to write, since
2942 you don't have to pick an identifier and move down to type the
2945Inline and regular footnotes may be mixed freely.
2951#### Extension: `citations` ####
2953Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2954citations and a bibliography in a number of styles. Basic usage is
2956 pandoc --filter pandoc-citeproc myinput.txt
2958In order to use this feature, you will need to specify a bibliography file
2959using the `bibliography` metadata field in a YAML metadata section, or
2960`--bibliography` command line argument. You can supply multiple `--bibliography`
2961arguments or set `bibliography` metadata field to YAML array, if you want to
2962use multiple bibliography files.
2963The bibliography may have any of these formats:
2965 Format File extension
2966 ------------ --------------
2979Note that `.bib` can be used with both BibTeX and BibLaTeX files;
2980use `.bibtex` to force BibTeX.
2982Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
2983can produce `.json` and `.yaml` files from any of the supported formats.
2985In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
2986a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
2994`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3003`<span class="nocase">...</span>`
3004: prevent a phrase from being capitalized as title case
3006`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3007and CSL YAML formats as far as possible.
3009As an alternative to specifying a bibliography file, you can include
3010the citation data directly in the `references` field of the
3011document's YAML metadata. The field should contain an array of
3012YAML-encoded references, for example:
3016 - type: article-journal
3028 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3030 title-short: Molecular structure of nucleic acids
3031 container-title: Nature
3035 DOI: 10.1038/171737a0
3036 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3040(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3041of the supported formats.)
3043Citations and references can be formatted using any style supported by the
3044[Citation Style Language], listed in the [Zotero Style Repository].
3045These files are specified using the `--csl` option or the `csl` metadata field.
3046By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3047format. The CSL project provides further information on [finding and editing styles].
3049Citations go inside square brackets and are separated by semicolons.
3050Each citation must have a key, composed of '@' + the citation
3051identifier from the database, and may optionally have a prefix,
3052a locator, and a suffix. The citation key must begin with a letter, digit,
3053or `_`, and may contain alphanumerics, `_`, and internal punctuation
3054characters (`:.#$%&-+?<>~/`). Here are some examples:
3056 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3058 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3060 Blah blah [@smith04; @doe99].
3062`pandoc-citeproc` detects locator terms in the [CSL locale files].
3063Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3064locale, locator terms can be written in either singular or plural forms,
3065as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3066`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3067`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3068`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3069`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3070`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3071locator term is used, "page" is assumed.
3073A minus sign (`-`) before the `@` will suppress mention of
3074the author in the citation. This can be useful when the
3075author is already mentioned in the text:
3077 Smith says blah [-@smith04].
3079You can also write an in-text citation, as follows:
3083 @smith04 [p. 33] says blah.
3085If the style calls for a list of works cited, it will be placed
3086at the end of the document. Normally, you will want to end your
3087document with an appropriate header:
3093The bibliography will be inserted after this header. Note that
3094the `unnumbered` class will be added to this header, so that the
3095section will not be numbered.
3097If you want to include items in the bibliography without actually
3098citing them in the body text, you can define a dummy `nocite` metadata
3099field and put the citations there:
3108In this example, the document will contain a citation for `item3`
3109only, but the bibliography will contain entries for `item1`, `item2`, and
3112For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3113to render bibliography. In order to do so, specify bibliography files as
3114outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3115invocation. Bear in mind that bibliography files have to be in respective
3116format (either BibTeX or BibLaTeX).
3118[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3119[Chicago Manual of Style]: http://chicagomanualofstyle.org
3120[Citation Style Language]: http://citationstyles.org
3121[Zotero Style Repository]: https://www.zotero.org/styles
3122[finding and editing styles]: http://citationstyles.org/styles/
3123[CSL locale files]: https://github.com/citation-style-language/locales
3125Non-pandoc extensions
3126---------------------
3128The following Markdown syntax extensions are not enabled by default
3129in pandoc, but may be enabled by adding `+EXTENSION` to the format
3130name, where `EXTENSION` is the name of the extension. Thus, for
3131example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3133#### Extension: `lists_without_preceding_blankline` ####
3135Allow a list to occur right after a paragraph, with no intervening
3138#### Extension: `hard_line_breaks` ####
3140Causes all newlines within a paragraph to be interpreted as hard line
3141breaks instead of spaces.
3143#### Extension: `ignore_line_breaks` ####
3145Causes newlines within a paragraph to be ignored, rather than being
3146treated as spaces or as hard line breaks. This option is intended for
3147use with East Asian languages where spaces are not used between words,
3148but text is divided into lines for readability.
3150#### Extension: `emoji` ####
3152Parses textual emojis like `:smile:` as Unicode emoticons.
3154#### Extension: `tex_math_single_backslash` ####
3156Causes anything between `\(` and `\)` to be interpreted as inline
3157TeX math, and anything between `\[` and `\]` to be interpreted
3158as display TeX math. Note: a drawback of this extension is that
3159it precludes escaping `(` and `[`.
3161#### Extension: `tex_math_double_backslash` ####
3163Causes anything between `\\(` and `\\)` to be interpreted as inline
3164TeX math, and anything between `\\[` and `\\]` to be interpreted
3167#### Extension: `markdown_attribute` ####
3169By default, pandoc interprets material inside block-level tags as Markdown.
3170This extension changes the behavior so that Markdown is only parsed
3171inside block-level tags if the tags have the attribute `markdown=1`.
3173#### Extension: `mmd_title_block` ####
3175Enables a [MultiMarkdown] style title block at the top of
3176the document, for example:
3180 Date: September 1, 2008
3181 Comment: This is a sample mmd title block, with
3182 a field spanning multiple lines.
3184See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3185`yaml_metadata_block` is enabled, it will take precedence over
3188[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
3190#### Extension: `abbreviations` ####
3192Parses PHP Markdown Extra abbreviation keys, like
3194 *[HTML]: Hypertext Markup Language
3196Note that the pandoc document model does not support
3197abbreviations, so if this extension is enabled, abbreviation keys are
3198simply skipped (as opposed to being parsed as paragraphs).
3200#### Extension: `autolink_bare_uris` ####
3202Makes all absolute URIs into links, even when not surrounded by
3203pointy braces `<...>`.
3205#### Extension: `ascii_identifiers` ####
3207Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3208Accents are stripped off of accented latin letters, and non-latin
3211#### Extension: `link_attributes` ####
3213Parses multimarkdown style key-value attributes on link and image references.
3214Note that pandoc's internal document model provides nowhere to put
3215these, so they are presently just ignored.
3217#### Extension: `mmd_header_identifiers` ####
3219Parses multimarkdown style header identifiers (in square brackets,
3220after the header but before any trailing `#`s in an ATX header).
3222#### Extension: `compact_definition_lists` ####
3224Activates the definition list syntax of pandoc 1.12.x and earlier.
3225This syntax differs from the one described above under [Definition lists]
3228 - No blank line is required between consecutive items of the
3230 - To get a "tight" or "compact" list, omit space between consecutive
3231 items; the space between a term and its definition does not affect
3233 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3234 be indented four spaces.[^6]
3236[^6]: To see why laziness is incompatible with relaxing the requirement
3237 of a blank line between items, consider the following example:
3244 Is this a single list item with two definitions of "bar," the first of
3245 which is lazily wrapped, or two list items? To remove the ambiguity
3246 we must either disallow lazy wrapping or require a blank line between
3252In addition to pandoc's extended Markdown, the following Markdown
3253variants are supported:
3255`markdown_phpextra` (PHP Markdown Extra)
3256: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3257 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3258 `header_attributes`, `abbreviations`, `shortcut_reference_links`.
3260`markdown_github` (GitHub-Flavored Markdown)
3261: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
3262 `fenced_code_blocks`, `auto_identifiers`,
3263 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3264 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3265 `shortcut_reference_links`.
3267`markdown_mmd` (MultiMarkdown)
3268: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
3269 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
3270 `mmd_title_block`, `footnotes`, `definition_lists`,
3271 `all_symbols_escapable`, `implicit_header_references`,
3272 `auto_identifiers`, `mmd_header_identifiers`,
3273 `shortcut_reference_links`.
3275`markdown_strict` (Markdown.pl)
3278Extensions with formats other than Markdown
3279-------------------------------------------
3281Some of the extensions discussed above can be used with formats
3284* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3285 and `textile` input (and is used by default).
3287* `tex_math_dollars`, `tex_math_single_backslash`, and
3288 `tex_math_double_backslash` can be used with `html` input.
3289 (This is handy for reading web pages formatted using MathJax,
3292Producing slide shows with pandoc
3293=================================
3295You can use pandoc to produce an HTML + javascript slide presentation
3296that can be viewed via a web browser. There are five ways to do this,
3297using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3298You can also produce a PDF slide show using LaTeX [`beamer`].
3300Here's the Markdown source for a simple slide show, `habits.txt`:
3327 
3334To produce an HTML/javascript slide show, simply type
3336 pandoc -t FORMAT -s habits.txt -o habits.html
3338where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3340For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3341`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3342assumed to be available at the relative path `s5/default` (for S5), `slideous`
3343(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3344`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3345`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3346above.) For DZSlides, the (relatively short) javascript and css are included in
3349With all HTML slide formats, the `--self-contained` option can be used to
3350produce a single file that contains all of the data necessary to display the
3351slide show, including linked scripts, stylesheets, images, and videos.
3353To produce a PDF slide show using beamer, type
3355 pandoc -t beamer habits.txt -o habits.pdf
3357Note that a reveal.js slide show can also be converted to a PDF
3358by printing it to a file from the browser.
3360Structuring the slide show
3361--------------------------
3363By default, the *slide level* is the highest header level in
3364the hierarchy that is followed immediately by content, and not another
3365header, somewhere in the document. In the example above, level 1 headers
3366are always followed by level 2 headers, which are followed by content,
3367so 2 is the slide level. This default can be overridden using
3368the `--slide-level` option.
3370The document is carved up into slides according to the following
3373 * A horizontal rule always starts a new slide.
3375 * A header at the slide level always starts a new slide.
3377 * Headers *below* the slide level in the hierarchy create
3378 headers *within* a slide.
3380 * Headers *above* the slide level in the hierarchy create
3381 "title slides," which just contain the section title
3382 and help to break the slide show into sections.
3384 * A title page is constructed automatically from the document's title
3385 block, if present. (In the case of beamer, this can be disabled
3386 by commenting out some lines in the default template.)
3388These rules are designed to support many different styles of slide show. If
3389you don't care about structuring your slides into sections and subsections,
3390you can just use level 1 headers for all each slide. (In that case, level 1
3391will be the slide level.) But you can also structure the slide show into
3392sections, as in the example above.
3394Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3395layout will be produced, with level 1 headers building horizontally
3396and level 2 headers building vertically. It is not recommended that
3397you use deeper nesting of section levels with reveal.js.
3402By default, these writers produce lists that display "all at once."
3403If you want your lists to display incrementally (one item at a time),
3404use the `-i` option. If you want a particular list to depart from the
3405default (that is, to display incrementally without the `-i` option and
3406all at once with the `-i` option), put it in a block quote:
3411In this way incremental and nonincremental lists can be mixed in
3417You can add "pauses" within a slide by including a paragraph containing
3418three dots, separated by spaces:
3420 # Slide with a pause
3422 content before the pause
3426 content after the pause
3431You can change the style of HTML slides by putting customized CSS files
3432in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3433or `$DATADIR/slideous` (for Slideous),
3434where `$DATADIR` is the user data directory (see `--data-dir`, above).
3435The originals may be found in pandoc's system data directory (generally
3436`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3437files it does not find in the user data directory.
3439For dzslides, the CSS is included in the HTML file itself, and may
3442All [reveal.js configuration options] can be set through variables.
3443For example, themes can be used by setting the `theme` variable:
3447Or you can specify a custom stylesheet using the `--css` option.
3449To style beamer slides, you can specify a `theme`, `colortheme`,
3450`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3452 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3454Note that header attributes will turn into slide attributes
3455(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3456to style individual slides. In beamer, the only header attribute
3457that affects slides is the `allowframebreaks` class, which sets the
3458`allowframebreaks` option, causing multiple slides to be created
3459if the content overfills the frame. This is recommended especially for
3462 # References {.allowframebreaks}
3467reveal.js has good support for speaker notes. You can add notes to your
3468Markdown document thus:
3473 - It can contain Markdown
3478To show the notes window, press `s` while viewing the presentation.
3479Notes are not yet supported for other slide formats, but the notes
3480will not appear on the slides themselves.
3482Frame attributes in beamer
3483--------------------------
3485Sometimes it is necessary to add the LaTeX `[fragile]` option to
3486a frame in beamer (for example, when using the `minted` environment).
3487This can be forced by adding the `fragile` class to the header
3488introducing the slide:
3490 # Fragile slide {.fragile}
3492All of the other frame attributes described in Section 8.1 of
3493the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3494`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3497Creating EPUBs with pandoc
3498==========================
3503EPUB metadata may be specified using the `--epub-metadata` option, but
3504if the source document is Markdown, it is better to use a [YAML metadata
3505block][Extension: `yaml_metadata_block`]. Here is an example:
3512 text: An investigation of metadata
3520 text: doi:10.234234.234/33
3522 rights: © 2007 John Smith, CC BY-NC
3525The following fields are recognized:
3528 ~ Either a string value or an object with fields `text` and
3529 `scheme`. Valid values for `scheme` are `ISBN-10`,
3530 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3531 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3532 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3535 ~ Either a string value, or an object with fields `file-as` and
3536 `type`, or a list of such objects. Valid values for `type` are
3537 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3540 ~ Either a string value, or an object with fields `role`, `file-as`,
3541 and `text`, or a list of such objects. Valid values for `role` are
3542 [MARC relators], but
3543 pandoc will attempt to translate the human-readable versions
3544 (like "author" and "editor") to the appropriate marc relators.
3547 ~ Same format as `creator`.
3550 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3551 Pandoc will attempt to convert other common date formats.
3553`lang` (or legacy: `language`)
3554 ~ A string value in [BCP 47] format. Pandoc will default to the local
3555 language if nothing is specified.
3558 ~ A string value or a list of such values.
3579 ~ A string value (path to cover image).
3582 ~ A string value (path to CSS stylesheet).
3584`page-progression-direction`
3585 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3586 attribute for the [`spine` element].
3588[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3589[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3594By default, pandoc will download linked media (including audio and
3595video) and include it in the EPUB container, yielding a completely
3596self-contained EPUB. If you want to link to external media resources
3597instead, use raw HTML in your source and add `data-external="1"` to the tag
3598with the `src` attribute. For example:
3600 <audio controls="1">
3601 <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3"
3602 data-external="1" type="audio/mpeg"></source>
3605Literate Haskell support
3606========================
3608If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3609format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3610`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3611literate Haskell source. This means that
3613 - In Markdown input, "bird track" sections will be parsed as Haskell
3614 code rather than block quotations. Text between `\begin{code}`
3615 and `\end{code}` will also be treated as Haskell code. For
3616 ATX-style headers the character '=' will be used instead of '#'.
3618 - In Markdown output, code blocks with classes `haskell` and `literate`
3619 will be rendered using bird tracks, and block quotations will be
3620 indented one space, so they will not be treated as Haskell code.
3621 In addition, headers will be rendered setext-style (with underlines)
3622 rather than ATX-style (with '#' characters). (This is because ghc
3623 treats '#' characters in column 1 as introducing line numbers.)
3625 - In restructured text input, "bird track" sections will be parsed
3628 - In restructured text output, code blocks with class `haskell` will
3629 be rendered using bird tracks.
3631 - In LaTeX input, text in `code` environments will be parsed as
3634 - In LaTeX output, code blocks with class `haskell` will be rendered
3635 inside `code` environments.
3637 - In HTML output, code blocks with class `haskell` will be rendered
3638 with class `literatehaskell` and bird tracks.
3642 pandoc -f markdown+lhs -t html
3644reads literate Haskell source formatted with Markdown conventions and writes
3645ordinary HTML (without bird tracks).
3647 pandoc -f markdown+lhs -t html+lhs
3649writes HTML with the Haskell code in bird tracks, so it can be copied
3650and pasted as literate Haskell source.
3655Pandoc will automatically highlight syntax in [fenced code blocks] that
3656are marked with a language name. The Haskell library [highlighting-kate] is used for
3657highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3658The color scheme can be selected using the `--highlight-style` option.
3659The default color scheme is `pygments`, which imitates the default color
3660scheme used by the Python library pygments, but pygments is not actually
3661used to do the highlighting.
3663To see a list of language names that pandoc will recognize, type
3666To disable highlighting, use the `--no-highlight` option.
3668[highlighting-kate]: https://github.com/jgm/highlighting-kate
3673Pandoc can be extended with custom writers written in [lua]. (Pandoc
3674includes a lua interpreter, so lua need not be installed separately.)
3676To use a custom writer, simply specify the path to the lua script
3677in place of the output format. For example:
3679 pandoc -t data/sample.lua
3681Creating a custom writer requires writing a lua function for each
3682possible element in a pandoc document. To get a documented example
3683which you can modify according to your needs, do
3685 pandoc --print-default-data-file sample.lua
3687[lua]: http://www.lua.org
3692© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3693[GPL], version 2 or greater. This software carries no warranty of
3694any kind. (See COPYRIGHT for full copyright and warranty notices.)
3699Alexander Kondratskiy,
3701Alexander V Vershilov,
3702Alfred Wechselberger,
3710Beni Cherniavsky-Paskin,
3718Christoffer Ackelman,
3748Jaime Marquínez Ferrándiz,
3777Matthias C. M. Troffaes,
3823[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