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 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][Math rendering in HTML], [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://pragma-ade.nl
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.
170Pandoc 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].
192PDF output can be controlled using [variables for LaTeX].
194[`amsfonts`]: https://ctan.org/pkg/amsfonts
195[`amsmath`]: https://ctan.org/pkg/amsmath
196[`lm`]: https://ctan.org/pkg/lm
197[`ifxetex`]: https://ctan.org/pkg/ifxetex
198[`ifluatex`]: https://ctan.org/pkg/ifluatex
199[`eurosym`]: https://ctan.org/pkg/eurosym
200[`listings`]: https://ctan.org/pkg/listings
201[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
202[`longtable`]: https://ctan.org/pkg/longtable
203[`booktabs`]: https://ctan.org/pkg/booktabs
204[`url`]: https://ctan.org/pkg/url
205[`graphicx`]: https://ctan.org/pkg/graphicx
206[`grffile`]: https://ctan.org/pkg/grffile
207[`geometry`]: https://ctan.org/pkg/geometry
208[`setspace`]: https://ctan.org/pkg/setspace
209[`color`]: http://ctan.org/pkg/color
210[`xecjk`]: https://ctan.org/pkg/xecjk
211[`hyperref`]: https://ctan.org/pkg/hyperref
212[`ulem`]: https://ctan.org/pkg/ulem
213[`babel`]: https://ctan.org/pkg/babel
214[`bidi`]: https://ctan.org/pkg/bidi
215[`mathspec`]: https://ctan.org/pkg/mathspec
216[`polyglossia`]: https://ctan.org/pkg/polyglossia
217[`fontspec`]: https://ctan.org/pkg/fontspec
218[`upquote`]: https://ctan.org/pkg/upquote
219[`microtype`]: https://ctan.org/pkg/microtype
220[`csquotes`]: https://ctan.org/pkg/csquotes
221[`natbib`]: https://ctan.org/pkg/natbib
222[`biblatex`]: https://ctan.org/pkg/biblatex
223[`bibtex`]: https://ctan.org/pkg/bibtex
224[`biber`]: https://ctan.org/pkg/biber
225[TeX Live]: http://www.tug.org/texlive/
230A user who wants a drop-in replacement for `Markdown.pl` may create
231a symbolic link to the `pandoc` executable called `hsmarkdown`. When
232invoked under the name `hsmarkdown`, `pandoc` will behave as if
233invoked with `-f markdown_strict --email-obfuscation=references`,
234and all command-line options will be treated as regular arguments.
235This approach does not work under [Cygwin], due to problems with
236its simulation of symbolic links.
238[Cygwin]: https://cygwin.com
246`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
248: Specify input format. *FORMAT* can be `native` (native Haskell),
249 `json` (JSON version of native AST), `markdown` (pandoc's
250 extended markdown), `markdown_strict` (original unextended
251 markdown), `markdown_phpextra` (PHP Markdown Extra),
252 `markdown_github` (GitHub-Flavored Markdown),
253 `commonmark` (CommonMark markdown), `textile` (Textile), `rst`
254 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
255 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
256 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
257 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
258 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
259 input will be treated as literate Haskell source: see [Literate
260 Haskell support], below. Markdown
261 syntax extensions can be individually enabled or disabled by
262 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
263 example, `markdown_strict+footnotes+definition_lists` is strict
264 markdown with footnotes and definition lists enabled, and
265 `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
266 without pipe tables and with hard line breaks. See [Pandoc's
267 markdown], below, for a list of extensions and
270`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
272: Specify output format. *FORMAT* can be `native` (native Haskell),
273 `json` (JSON version of native AST), `plain` (plain text),
274 `markdown` (pandoc's extended markdown), `markdown_strict`
275 (original unextended markdown), `markdown_phpextra` (PHP Markdown
276 Extra), `markdown_github` (GitHub-Flavored
277 Markdown), `commonmark` (CommonMark markdown), `rst`
278 (reStructuredText), `html` (XHTML), `html5` (HTML5), `latex`
279 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
280 `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
281 (DokuWiki markup), `textile` (Textile), `org` (Emacs Org mode),
282 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
283 `opendocument` (OpenDocument), `odt` (OpenOffice text document),
284 `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
285 format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
286 (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
287 ICML), `slidy` (Slidy HTML and javascript slide show), `slideous`
288 (Slideous HTML and javascript slide show), `dzslides` (DZSlides
289 HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 +
290 javascript slide show), `s5` (S5 HTML and javascript slide show),
291 or the path of a custom lua writer (see [Custom
292 writers], below). Note that `odt`, `epub`, and
293 `epub3` output will not be directed to *stdout*; an output
294 filename must be specified using the `-o/--output` option. If
295 `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
296 `html`, or `html5`, the output will be rendered as literate
297 Haskell source: see [Literate Haskell
298 support], below. Markdown syntax
299 extensions can be individually enabled or disabled by appending
300 `+EXTENSION` or `-EXTENSION` to the format name, as described
303`-o` *FILE*, `--output=`*FILE*
305: Write output to *FILE* instead of *stdout*. If *FILE* is
306 `-`, output will go to *stdout*. (Exception: if the output
307 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
309`--data-dir=`*DIRECTORY*
311: Specify the user data directory to search for pandoc data files.
312 If this option is not specified, the default user data directory
313 will be used. This is, in Unix:
319 C:\Documents And Settings\USERNAME\Application Data\pandoc
321 and in Windows Vista or later:
323 C:\Users\USERNAME\AppData\Roaming\pandoc
325 You can find the default user data directory on your system by
326 looking at the output of `pandoc --version`.
327 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
328 `slidy`, `slideous`, or `s5` directory
329 placed in this directory will override pandoc's normal defaults.
333: Generate a bash completion script. To enable bash completion
334 with pandoc, add this to your `.bashrc`:
336 eval "$(pandoc --bash-completion)"
340: Give verbose debugging output. Currently this only has an effect
356: Parse untranslatable HTML codes and LaTeX environments as raw HTML
357 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
358 input. Raw HTML can be printed in markdown, reStructuredText, HTML,
359 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
360 can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
361 The default is for the readers to omit untranslatable HTML codes and
362 LaTeX environments. (The LaTeX reader does pass through untranslatable
363 LaTeX *commands*, even if `-R` is not specified.)
367: Produce typographically correct output, converting straight quotes
368 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
369 `...` to ellipses. Nonbreaking spaces are inserted after certain
370 abbreviations, such as "Mr." (Note: This option is significant only when
371 the input format is `markdown`, `markdown_strict`, `textile` or `twiki`.
372 It is selected automatically when the input format is `textile` or the
373 output format is `latex` or `context`, unless `--no-tex-ligatures`
378: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
379 a numeral is an en-dash, and `--` is an em-dash. This option is selected
380 automatically for `textile` input.
382`--base-header-level=`*NUMBER*
384: Specify the base level for headers (defaults to 1).
386`--indented-code-classes=`*CLASSES*
388: Specify classes to use for indented code blocks--for example,
389 `perl,numberLines` or `haskell`. Multiple classes may be separated
392`--default-image-extension=`*EXTENSION*
394: Specify a default extension to use when image paths/URLs have no
395 extension. This allows you to use the same source for formats that
396 require different kinds of images. Currently this option only affects
397 the markdown and LaTeX readers.
399`--filter=`*EXECUTABLE*
401: Specify an executable to be used as a filter transforming the
402 Pandoc AST after the input is parsed and before the output is
403 written. The executable should read JSON from stdin and write
404 JSON to stdout. The JSON must be formatted like pandoc's own
405 JSON input and output. The name of the output format will be
406 passed to the filter as the first argument. Hence,
408 pandoc --filter ./caps.py -t latex
412 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
414 The latter form may be useful for debugging filters.
416 Filters may be written in any language. `Text.Pandoc.JSON`
417 exports `toJSONFilter` to facilitate writing filters in Haskell.
418 Those who would prefer to write filters in python can use the
419 module [`pandocfilters`], installable from PyPI. There are also
420 pandoc filter libraries in [PHP], [perl], and [javascript/node.js].
422 Note that the *EXECUTABLE* will be sought in the user's
423 `PATH`, and not in the working directory, if no directory is
424 provided. If you want to run a script in the working directory,
425 preface the filename with `./`.
427`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
429: Set the metadata field *KEY* to the value *VAL*. A value specified
430 on the command line overrides a value specified in the document.
431 Values will be parsed as YAML boolean or string values. If no value is
432 specified, the value will be treated as Boolean true. Like
433 `--variable`, `--metadata` causes template variables to be set.
434 But unlike `--variable`, `--metadata` affects the metadata of the
435 underlying document (which is accessible from filters and may be
436 printed in some output formats).
440: Normalize the document after reading: merge adjacent
441 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
443`-p`, `--preserve-tabs`
445: Preserve tabs instead of converting them to spaces (the default).
446 Note that this will only affect tabs in literal code spans and code
447 blocks; tabs in regular text will be treated as spaces.
451: Specify the number of spaces per tab (default is 4).
453`--track-changes=accept`|`reject`|`all`
455: Specifies what to do with insertions and deletions produced by the MS
456 Word "Track Changes" feature. `accept` (the default), inserts all
457 insertions, and ignores all deletions. `reject` inserts all
458 deletions and ignores insertions. `all` puts in both insertions
459 and deletions, wrapped in spans with `insertion` and `deletion`
460 classes, respectively. The author and time of change is
461 included. `all` is useful for scripting: only accepting changes
462 from a certain reviewer, say, or before a certain date. This
463 option only affects the docx reader.
465`--extract-media=`*DIR*
467: Extract images and other media contained in a docx or epub container
468 to the path *DIR*, creating it if necessary, and adjust the images
469 references in the document so they point to the extracted files.
470 This option only affects the docx and epub readers.
472[`pandocfilters`]: https://github.com/jgm/pandocfilters
473[PHP]: https://github.com/vinai/pandocfilters-php
474[perl]: https://metacpan.org/pod/Pandoc::Filter
475[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
477General writer options
478----------------------
482: Produce output with an appropriate header and footer (e.g. a
483 standalone HTML, LaTeX, or RTF file, not a fragment). This option
484 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
489: Use *FILE* as a custom template for the generated document. Implies
490 `--standalone`. See [Templates], below, for a description
491 of template syntax. If no extension is specified, an extension
492 corresponding to the writer will be added, so that `--template=special`
493 looks for `special.html` for HTML output. If the template is not
494 found, pandoc will search for it in the `templates` subdirectory of
495 the user data directory (see `--data-dir`). If this option is not used,
496 a default template appropriate for the output format will be used (see
497 `-D/--print-default-template`).
499`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
501: Set the template variable *KEY* to the value *VAL* when rendering the
502 document in standalone mode. This is generally only useful when the
503 `--template` option is used to specify a custom template, since
504 pandoc automatically sets the variables used in the default
505 templates. If no *VAL* is specified, the key will be given the
508`-D` *FORMAT*, `--print-default-template=`*FORMAT*
510: Print the system default template for an output *FORMAT*. (See `-t`
511 for a list of possible *FORMAT*s.) Templates in the user data
512 directory are ignored.
514`--print-default-data-file=`*FILE*
516: Print a system default data file. Files in the user data directory
521: Disable text wrapping in output. By default, text is wrapped
522 appropriately for the output format.
526: Specify length of lines in characters (for text wrapping).
528`--toc`, `--table-of-contents`
530: Include an automatically generated table of contents (or, in
531 the case of `latex`, `context`, and `rst`, an instruction to create
532 one) in the output document. This option has no effect on `man`,
533 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
535`--toc-depth=`*NUMBER*
537: Specify the number of section levels to include in the table
538 of contents. The default is 3 (which means that level 1, 2, and 3
539 headers will be listed in the contents).
543: Disables syntax highlighting for code blocks and inlines, even when
544 a language attribute is given.
546`--highlight-style=`*STYLE*
548: Specifies the coloring style to be used in highlighted source code.
549 Options are `pygments` (the default), `kate`, `monochrome`,
550 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
551 on syntax highlighting in pandoc, see [Syntax highlighting], below.
553`-H` *FILE*, `--include-in-header=`*FILE*
555: Include contents of *FILE*, verbatim, at the end of the header.
556 This can be used, for example, to include special
557 CSS or javascript in HTML documents. This option can be used
558 repeatedly to include multiple files in the header. They will be
559 included in the order specified. Implies `--standalone`.
561`-B` *FILE*, `--include-before-body=`*FILE*
563: Include contents of *FILE*, verbatim, at the beginning of the
564 document body (e.g. after the `<body>` tag in HTML, or the
565 `\begin{document}` command in LaTeX). This can be used to include
566 navigation bars or banners in HTML documents. This option can be
567 used repeatedly to include multiple files. They will be included in
568 the order specified. Implies `--standalone`.
570`-A` *FILE*, `--include-after-body=`*FILE*
572: Include contents of *FILE*, verbatim, at the end of the document
573 body (before the `</body>` tag in HTML, or the
574 `\end{document}` command in LaTeX). This option can be be used
575 repeatedly to include multiple files. They will be included in the
576 order specified. Implies `--standalone`.
578Options affecting specific writers
579----------------------------------
583: Produce a standalone HTML file with no external dependencies, using
584 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
585 images, and videos. The resulting file should be "self-contained,"
586 in the sense that it needs no external files and no net access to be
587 displayed properly by a browser. This option works only with HTML output
588 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
589 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
590 stylesheets at absolute URLs will be downloaded; those at relative URLs
591 will be sought relative to the working directory (if the first source
592 file is local) or relative to the base URL (if the first source
593 file is remote). `--self-contained` does not work with `--mathjax`.
597: Deprecated synonym for `--self-contained`.
601: Produce HTML5 instead of HTML4. This option has no effect for writers
602 other than `html`. (*Deprecated:* Use the `html5` output format instead.)
606: Use `<q>` tags for quotes in HTML.
610: Use only ascii characters in output. Currently supported only
611 for HTML output (which uses numerical entities instead of
612 UTF-8 when this option is selected).
616: Use reference-style links, rather than inline links, in writing markdown
617 or reStructuredText. By default inline links are used.
621: Use ATX-style headers in markdown and asciidoc output. The default is
622 to use setext-style headers for levels 1-2, and then ATX headers.
626: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
627 output. When the LaTeX document class is set to `report`, `book`, or
628 `memoir`, this option is implied. If `beamer` is the output
629 format, top-level headers will become `\part{..}`.
631`-N`, `--number-sections`
633: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
634 By default, sections are not numbered. Sections with class
635 `unnumbered` will never be numbered, even if `--number-sections`
638`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
640: Offset for section headings in HTML output (ignored in other
641 output formats). The first number is added to the section number for
642 top-level headers, the second for second-level headers, and so on.
643 So, for example, if you want the first top-level header in your
644 document to be numbered "6", specify `--number-offset=5`.
645 If your document starts with a level-2 header which you want to
646 be numbered "1.5", specify `--number-offset=1,4`.
647 Offsets are 0 by default. Implies `--number-sections`.
651: Do not convert quotation marks, apostrophes, and dashes to
652 the TeX ligatures when writing LaTeX or ConTeXt. Instead, just
653 use literal unicode characters. This is needed for using advanced
654 OpenType features with `xelatex` and `lualatex`. Note: normally
655 `--smart` is selected automatically for LaTeX and ConTeXt
656 output, but it must be specified explicitly if `--no-tex-ligatures`
657 is selected. If you use literal curly quotes, dashes, and ellipses
658 in your source, then you may want to use `--no-tex-ligatures`
663: Use the [`listings`] package for LaTeX code blocks
667: Make list items in slide shows display incrementally (one by one).
668 The default is for lists to be displayed all at once.
670`--slide-level=`*NUMBER*
672: Specifies that headers with the specified level create
673 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
674 above this level in the hierarchy are used to divide the
675 slide show into sections; headers below this level create
676 subheads within a slide. The default is to set the slide level
677 based on the contents of the document; see
678 [Structuring the slide show].
682: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
683 and attach identifiers to the enclosing `<div>` (or `<section>`)
684 rather than the header itself. See
685 [Header identifiers], below.
687`--email-obfuscation=none`|`javascript`|`references`
689: Specify a method for obfuscating `mailto:` links in HTML documents.
690 `none` leaves `mailto:` links as they are. `javascript` obfuscates
691 them using javascript. `references` obfuscates them by printing their
692 letters as decimal or hexadecimal character references.
694`--id-prefix=`*STRING*
696: Specify a prefix to be added to all automatically generated identifiers
697 in HTML and DocBook output, and to footnote numbers in markdown output.
698 This is useful for preventing duplicate identifiers when generating
699 fragments to be included in other pages.
701`-T` *STRING*, `--title-prefix=`*STRING*
703: Specify *STRING* as a prefix at the beginning of the title
704 that appears in the HTML header (but not in the title as it
705 appears at the beginning of the HTML body). Implies
708`-c` *URL*, `--css=`*URL*
710: Link to a CSS style sheet. This option can be be used repeatedly to
711 include multiple files. They will be included in the order specified.
713`--reference-odt=`*FILE*
715: Use the specified file as a style reference in producing an ODT.
716 For best results, the reference ODT should be a modified version
717 of an ODT produced using pandoc. The contents of the reference ODT
718 are ignored, but its stylesheets are used in the new ODT. If no
719 reference ODT is specified on the command line, pandoc will look
720 for a file `reference.odt` in the user data directory (see
721 `--data-dir`). If this is not found either, sensible defaults will be
724`--reference-docx=`*FILE*
726: Use the specified file as a style reference in producing a docx file.
727 For best results, the reference docx should be a modified version
728 of a docx file produced using pandoc. The contents of the reference docx
729 are ignored, but its stylesheets and document properties (including
730 margins, page size, header, and footer) are used in the new docx. If no
731 reference docx is specified on the command line, pandoc will look
732 for a file `reference.docx` in the user data directory (see
733 `--data-dir`). If this is not found either, sensible defaults will be
734 used. The following styles are used by pandoc: [paragraph]
735 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
736 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
737 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
738 Definition, Caption, Table Caption, Image Caption, Figure,
739 Figure With Caption, TOC Heading;
740 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
741 Footnote Reference, Hyperlink; [table] Normal Table.
743`--epub-stylesheet=`*FILE*
745: Use the specified CSS file to style the EPUB. If no stylesheet
746 is specified, pandoc will look for a file `epub.css` in the
747 user data directory (see `--data-dir`). If it is not
748 found there, sensible defaults will be used.
750`--epub-cover-image=`*FILE*
752: Use the specified image as the EPUB cover. It is recommended
753 that the image be less than 1000px in width and height. Note that
754 in a markdown source document you can also specify `cover-image`
755 in a YAML metadata block (see [EPUB Metadata], below).
757`--epub-metadata=`*FILE*
759: Look in the specified XML file for metadata for the EPUB.
760 The file should contain a series of [Dublin Core elements].
763 <dc:rights>Creative Commons</dc:rights>
764 <dc:language>es-AR</dc:language>
766 By default, pandoc will include the following metadata elements:
767 `<dc:title>` (from the document title), `<dc:creator>` (from the
768 document authors), `<dc:date>` (from the document date, which should
769 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
770 variable, or, if is not set, the locale), and `<dc:identifier
771 id="BookId">` (a randomly generated UUID). Any of these may be
772 overridden by elements in the metadata file.
774 Note: if the source document is markdown, a YAML metadata block
775 in the document can be used instead. See below under
778`--epub-embed-font=`*FILE*
780: Embed the specified font in the EPUB. This option can be repeated
781 to embed multiple fonts. Wildcards can also be used: for example,
782 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
783 line, be sure to escape them or put the whole filename in single quotes,
784 to prevent them from being interpreted by the shell. To use the
785 embedded fonts, you will need to add declarations like the following
786 to your CSS (see `--epub-stylesheet`):
789 font-family: DejaVuSans;
792 src:url("DejaVuSans-Regular.ttf");
795 font-family: DejaVuSans;
798 src:url("DejaVuSans-Bold.ttf");
801 font-family: DejaVuSans;
804 src:url("DejaVuSans-Oblique.ttf");
807 font-family: DejaVuSans;
810 src:url("DejaVuSans-BoldOblique.ttf");
812 body { font-family: "DejaVuSans"; }
814`--epub-chapter-level=`*NUMBER*
816: Specify the header level at which to split the EPUB into separate
817 "chapter" files. The default is to split into chapters at level 1
818 headers. This option only affects the internal composition of the
819 EPUB, not the way chapters and sections are displayed to users. Some
820 readers may be slow if the chapter files are too large, so for large
821 documents with few level 1 headers, one might want to use a chapter
824`--latex-engine=pdflatex`|`lualatex`|`xelatex`
826: Use the specified LaTeX engine when producing PDF output.
827 The default is `pdflatex`. If the engine is not in your PATH,
828 the full path of the engine may be specified here.
830`--latex-engine-opt=`*STRING*
832: Use the given string as a command-line argument to the `latex-engine`.
833 If used multiple times, the arguments are provided with spaces between
834 them. Note that no check for duplicate options is done.
836[Dublin Core elements]: http://dublincore.org/documents/dces/
837[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
842`--bibliography=`*FILE*
844: Set the `bibliography` field in the document's metadata to *FILE*,
845 overriding any value set in the metadata, and process citations
846 using `pandoc-citeproc`. (This is equivalent to
847 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
848 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
849 used, making this equivalent to `--metadata bibliography=FILE`.
850 If you supply this argument multiple times, each *FILE* will be added
855: Set the `csl` field in the document's metadata to *FILE*,
856 overriding any value set in the metadata. (This is equivalent to
857 `--metadata csl=FILE`.)
858 This option is only relevant with `pandoc-citeproc`.
860`--citation-abbreviations=`*FILE*
862: Set the `citation-abbreviations` field in the document's metadata to
863 *FILE*, overriding any value set in the metadata. (This is equivalent to
864 `--metadata citation-abbreviations=FILE`.)
865 This option is only relevant with `pandoc-citeproc`.
869: Use [`natbib`] for citations in LaTeX output. This option is not for use
870 with the `pandoc-citeproc` filter or with PDF output. It is intended for
871 use in producing a LaTeX file that can be processed with [`bibtex`].
875: Use [`biblatex`] for citations in LaTeX output. This option is not for use
876 with the `pandoc-citeproc` filter or with PDF output. It is intended for
877 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
879Math rendering in HTML
880----------------------
882`-m` [*URL*], `--latexmathml`[`=`*URL*]
884: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
885 To insert a link to a local copy of the `LaTeXMathML.js` script,
886 provide a *URL*. If no *URL* is provided, the contents of the
887 script will be inserted directly into the HTML header, preserving
888 portability at the price of efficiency. If you plan to use math on
889 several pages, it is much better to link to a copy of the script,
894: Convert TeX math to [MathML] (in `docbook` as well as `html` and `html5`).
895 In standalone `html` output, a small javascript (or a link to such a
896 script if a *URL* is supplied) will be inserted that allows the MathML to
897 be viewed on some browsers.
901: Use [jsMath] to display embedded TeX math in HTML output.
902 The *URL* should point to the jsMath load script (e.g.
903 `jsMath/easy/load.js`); if provided, it will be linked to in
904 the header of standalone HTML documents. If a *URL* is not provided,
905 no link to the jsMath load script will be inserted; it is then
906 up to the author to provide such a link in the HTML template.
910: Use [MathJax] to display embedded TeX math in HTML output.
911 The *URL* should point to the `MathJax.js` load script.
912 If a *URL* is not provided, a link to the MathJax CDN will
917: Enclose TeX math in `<eq>` tags in HTML output. These can then
918 be processed by [gladTeX] to produce links to images of the typeset
923: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
924 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
928: Render TeX formulas using an external script that converts TeX
929 formulas to images. The formula will be concatenated with the URL
930 provided. If *URL* is not specified, the Google Chart API will be used.
934: Use [KaTeX] to display embedded TeX math in HTML output.
935 The *URL* should point to the `katex.js` load script. If a *URL* is
936 not provided, a link to the KaTeX CDN will be inserted.
938`--katex-stylesheet=`*URL*
940: The *URL* should point to the `katex.css` stylesheet. If this option is
941 not specified, a link to the KaTeX CDN will be inserted. Note that this
942 option does not imply `--katex`.
944[MathML]: http://www.w3.org/Math/
945[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
946[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
947[MathJax]: https://www.mathjax.org
948[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
949[mimeTeX]: http://www.forkosh.com/mimetex.html
950[KaTeX]: https://github.com/Khan/KaTeX
952Options for wrapper scripts
953---------------------------
957: Print information about command-line arguments to *stdout*, then exit.
958 This option is intended primarily for use in wrapper scripts.
959 The first line of output contains the name of the output file specified
960 with the `-o` option, or `-` (for *stdout*) if no output file was
961 specified. The remaining lines contain the command-line arguments,
962 one per line, in the order they appear. These do not include regular
963 Pandoc options and their arguments, but do include any options appearing
964 after a `--` separator at the end of the line.
968: Ignore command-line arguments (for use in wrapper scripts).
969 Regular Pandoc options are not ignored. Thus, for example,
971 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
975 pandoc -o foo.html -s
980When the `-s/--standalone` option is used, pandoc uses a template to
981add header and footer material that is needed for a self-standing
982document. To see the default template that is used, just type
986where *FORMAT* is the name of the output format. A custom template
987can be specified using the `--template` option. You can also override
988the system default templates for a given output format *FORMAT*
989by putting a file `templates/default.*FORMAT*` in the user data
990directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
991customize the `default.opendocument` template. For `pdf` output,
992customize the `default.latex` template.
994Templates contain *variables*, which allow for the inclusion of
995arbitrary information at any point in the file. Variables may be set
996within the document using [YAML metadata blocks][Extension: `yaml_metadata_block`].
997They may also be set at the
998command line using the `-V/--variable` option: variables set in this
999way override metadata fields with the same name.
1001Variables set by pandoc
1002-----------------------
1004Some variables are set automatically by pandoc. These vary somewhat
1005depending on the output format, but include metadata fields as well as the following:
1007`title`, `author`, `date`
1008: allow identification of basic aspects of the document.
1009 Included in PDF metadata through LaTeX.
1010 These can be set through a [pandoc title block][Extension: `pandoc_title_block`],
1011 which allows for multiple authors, or through a YAML metadata block:
1020: allows for specification of document summary in LaTeX and Word docx
1023: contents specified by `-H/--include-in-header` (may have multiple
1027: non-null value if `--toc/--table-of-contents` was specified
1030: contents specified by `-B/--include-before-body` (may have
1034: contents specified by `-A/--include-after-body` (may have
1044: identifies the main language of the document,
1045 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1046 For some output formats, pandoc will convert it to an appropriate
1047 format stored in the additional variables `babel-lang`,
1048 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1050 Native pandoc `span`s and `div`s with the lang attribute
1051 (value in BCP 47) can be used to switch the language in
1055: a list of other languages used in the document
1056 in the YAML metadata, according to [BCP 47]. For example:
1057 `otherlangs: [en-GB, fr]`.
1058 This is automatically generated from the `lang` attributes
1059 in all `span`s and `div`s but can be overriden.
1060 Currently only used by LaTeX through the generated
1061 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1062 The LaTeX writer outputs polyglossia commands in the text but
1063 the `babel-newcommands` variable contains mappings for them
1064 to the corresponding babel.
1067: the base direction of the document, either `rtl` (right-to-left)
1068 or `ltr` (left-to-right).
1070 For bidirectional documents, native pandoc `span`s and `div`s
1071 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1072 override the base direction in some output formats.
1073 This may not always be necessary if the final renderer
1074 (e.g. the browser, when generating HTML) supports the
1075 [Unicode Bidirectional Algorithm].
1077 When using LaTeX for bidirectional documents, only the `xelatex` engine
1078 is fully supported (use `--latex-engine=xelatex`).
1080[BCP 47]: https://tools.ietf.org/html/bcp47
1081[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1086Variables are available for [producing slide shows with pandoc],
1087including all [reveal.js configuration options].
1090: base URL for Slidy documents (defaults to
1091 `http://www.w3.org/Talks/Tools/Slidy2`)
1094: base URL for Slideous documents (defaults to `slideous`)
1097: base URL for S5 documents (defaults to `s5/default`)
1100: base URL for reveal.js documents (defaults to `reveal.js`)
1102`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1103: themes for LaTeX [`beamer`] documents
1105[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1110LaTeX variables are used when [creating a PDF].
1113: font size (e.g. `10pt`, `12pt`) for LaTeX documents
1116: document class for LaTeX documents, e.g. [`article`], [`report`], [`book`], [`memoir`]
1119: option for LaTeX document class, e.g. `oneside`; may be repeated
1120 for multiple options
1123: option for LaTeX [`geometry`] package, e.g. `margin=1in`;
1124 may be repeated for multiple options
1127: adjusts line spacing in LaTeX documents using the [`setspace`]
1128 package, e.g. `1.25`, `1.5`
1131: font package for LaTeX documents (with `pdflatex`):
1132 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1133 The default is [Latin Modern][`lm`].
1136: options for package used as `fontfamily`: e.g. `osf,sc` with
1137 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1138 figures and true small caps
1140`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1141: fonts for LaTeX documents (works only with `xelatex` and
1142 `lualatex`): takes the name of any system font, using the
1143 [`fontspec`] package. Note that if `CJKmainfont` is used,
1144 the [`xecjk`] package must be available.
1146`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1147: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1148 `CJKmainfont` in `xelatex` and `lualatex`. Allows for any choices
1149 available through [`fontspec`], such as the OpenType features
1150 `Numbers=OldStyle,Numbers=Proportional`.
1153: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1154 default is `T1` (see guide to [LaTeX font encodings])
1156`linkcolor`, `toccolor`, `urlcolor`, `citecolor`
1157: color for internal links, links in table of contents, external links,
1158 and citation links in LaTeX documents, using options available through
1159 [`color`] package, e.g. `red`, `green`, `magenta`, `cyan`, `blue`, `black`
1162: enables `hidelinks` option for [`hyperref`], disabling link color
1165: causes links to be printed as footnotes in LaTeX documents
1168: uses document class settings for indentation (the default LaTeX template
1169 otherwise removes indentation and adds space between paragraphs)
1172: disables default behavior of LaTeX template that redefines (sub)paragraphs
1173 as sections, changing the appearance of nested headings in some classes
1176: include table of contents in LaTeX documents
1179: level of section to include in table of contents in LaTeX documents
1182: title of table of contents (works only with EPUB and docx)
1185: include list of figures in LaTeX documents
1188: include list of tables in LaTeX documents
1191: bibliography to use for resolving references
1194: bibliography style in LaTeX, when used with `--natbib`
1196[`article`]: https://ctan.org/pkg/article
1197[`report`]: https://ctan.org/pkg/report
1198[`book`]: https://ctan.org/pkg/book
1199[`memoir`]: https://ctan.org/pkg/memoir
1200[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1201[`mathpazo`]: https://ctan.org/pkg/mathpazo
1202[LaTeX font encodings]: https://ctan.org/pkg/encguide
1204Variables for man pages
1205-----------------------
1208: section number in man pages
1211: header in man pages
1214: footer in man pages
1217: adjusts text to left (`l`), right (`r`), center (`c`),
1218 or both (`b`) margins
1221: if `true` (the default), hyphenation will be used
1223Using variables in templates
1224----------------------------
1226Variable names are sequences of alphanumerics, `-`, and `_`,
1227starting with a letter. A variable name surrounded by `$` signs
1228will be replaced by its value. For example, the string `$title$` in
1230 <title>$title$</title>
1232will be replaced by the document title.
1234To write a literal `$` in a template, use `$$`.
1236Templates may contain conditionals. The syntax is as follows:
1244This will include `X` in the template if `variable` has a non-null
1245value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1246any valid template text, and may include interpolated variables or other
1247conditionals. The `$else$` section may be omitted.
1249When variables can have multiple values (for example, `author` in
1250a multi-author document), you can use the `$for$` keyword:
1253 <meta name="author" content="$author$" />
1256You can optionally specify a separator to be used between
1259 $for(author)$$author$$sep$, $endfor$
1261A dot can be used to select a field of a variable that takes
1262an object as its value. So, for example:
1264 $author.name$ ($author.affiliation$)
1266If you use custom templates, you may need to revise them as pandoc
1267changes. We recommend tracking the changes in the default templates,
1268and modifying your custom templates accordingly. An easy way to do this
1269is to fork the [pandoc-templates] repository and merge in changes after each
1272[pandoc-templates]: https://github.com/jgm/pandoc-templates
1277Pandoc understands an extended and slightly revised version of
1278John Gruber's [markdown] syntax. This document explains the syntax,
1279noting differences from standard markdown. Except where noted, these
1280differences can be suppressed by using the `markdown_strict` format instead
1281of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1282to the format name and disabled by adding `-EXTENSION`. For example,
1283`markdown_strict+footnotes` is strict markdown with footnotes
1284enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1285markdown without footnotes or pipe tables.
1290Markdown is designed to be easy to write, and, even more importantly,
1293> A Markdown-formatted document should be publishable as-is, as plain
1294> text, without looking like it's been marked up with tags or formatting
1296> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1298This principle has guided pandoc's decisions in finding syntax for
1299tables, footnotes, and other extensions.
1301There is, however, one respect in which pandoc's aims are different
1302from the original aims of markdown. Whereas markdown was originally
1303designed with HTML generation in mind, pandoc is designed for multiple
1304output formats. Thus, while pandoc allows the embedding of raw HTML,
1305it discourages it, and provides other, non-HTMLish ways of representing
1306important document elements like definition lists, tables, mathematics, and
1312A paragraph is one or more lines of text followed by one or more blank lines.
1313Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1314If you need a hard line break, put two or more spaces at the end of a line.
1316#### Extension: `escaped_line_breaks` ####
1318A backslash followed by a newline is also a hard line break.
1319Note: in multiline and grid table cells, this is the only way
1320to create a hard line break, since trailing spaces in the cells
1326There are two kinds of headers: Setext and ATX.
1328### Setext-style headers ###
1330A setext-style header is a line of text "underlined" with a row of `=` signs
1331(for a level one header) or `-` signs (for a level two header):
1339The header text can contain inline formatting, such as emphasis (see
1340[Inline formatting], below).
1343### ATX-style headers ###
1345An ATX-style header consists of one to six `#` signs and a line of
1346text, optionally followed by any number of `#` signs. The number of
1347`#` signs at the beginning of the line is the header level:
1349 ## A level-two header
1351 ### A level-three header ###
1353As with setext-style headers, the header text can contain formatting:
1355 # A level-one header with a [link](/url) and *emphasis*
1357#### Extension: `blank_before_header` ####
1359Standard markdown syntax does not require a blank line before a header.
1360Pandoc does require this (except, of course, at the beginning of the
1361document). The reason for the requirement is that it is all too easy for a
1362`#` to end up at the beginning of a line by accident (perhaps through line
1363wrapping). Consider, for example:
1365 I like several of their flavors of ice cream:
1366 #22, for example, and #5.
1369### Header identifiers ###
1371#### Extension: `header_attributes` ####
1373Headers can be assigned attributes using this syntax at the end
1374of the line containing the header text:
1376 {#identifier .class .class key=value key=value}
1378Thus, for example, the following headers will all be assigned the identifier
1383 ## My header ## {#foo}
1385 My other header {#foo}
1388(This syntax is compatible with [PHP Markdown Extra].)
1390Note that although this syntax allows assignment of classes and key/value
1391attributes, writers generally don't use all of this information. Identifiers,
1392classes, and key/value attributes are used in HTML and HTML-based formats such
1393as EPUB and slidy. Identifiers are used for labels and link anchors in the
1394LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1396Headers with the class `unnumbered` will not be numbered, even if
1397`--number-sections` is specified. A single hyphen (`-`) in an attribute
1398context is equivalent to `.unnumbered`, and preferable in non-English
1405 # My header {.unnumbered}
1407#### Extension: `auto_identifiers` ####
1409A header without an explicitly specified identifier will be
1410automatically assigned a unique identifier based on the header text.
1411To derive the identifier from the header text,
1413 - Remove all formatting, links, etc.
1414 - Remove all footnotes.
1415 - Remove all punctuation, except underscores, hyphens, and periods.
1416 - Replace all spaces and newlines with hyphens.
1417 - Convert all alphabetic characters to lowercase.
1418 - Remove everything up to the first letter (identifiers may
1419 not begin with a number or punctuation mark).
1420 - If nothing is left after this, use the identifier `section`.
1425 ------------------------------- ----------------------------
1426 Header identifiers in HTML `header-identifiers-in-html`
1427 *Dogs*?--in *my* house? `dogs--in-my-house`
1428 [HTML], [S5], or [RTF]? `html-s5-or-rtf`
1429 3. Applications `applications`
1432These rules should, in most cases, allow one to determine the identifier
1433from the header text. The exception is when several headers have the
1434same text; in this case, the first will get an identifier as described
1435above; the second will get the same identifier with `-1` appended; the
1436third with `-2`; and so on.
1438These identifiers are used to provide link targets in the table of
1439contents generated by the `--toc|--table-of-contents` option. They
1440also make it easy to provide links from one section of a document to
1441another. A link to this section, for example, might look like this:
1444 [header identifiers](#header-identifiers-in-html-latex-and-context).
1446Note, however, that this method of providing links to sections works
1447only in HTML, LaTeX, and ConTeXt formats.
1449If the `--section-divs` option is specified, then each section will
1450be wrapped in a `div` (or a `section`, if `--html5` was specified),
1451and the identifier will be attached to the enclosing `<div>`
1452(or `<section>`) tag rather than the header itself. This allows entire
1453sections to be manipulated using javascript or treated differently in
1456#### Extension: `implicit_header_references` ####
1458Pandoc behaves as if reference links have been defined for each header.
1461 [header identifiers](#header-identifiers-in-html)
1465 [header identifiers]
1469 [header identifiers][]
1473 [the section on header identifiers][header identifiers]
1475If there are multiple headers with identical text, the corresponding
1476reference will link to the first one only, and you will need to use explicit
1477links to link to the others, as described above.
1479Like regular reference links, these references are case-insensitive.
1481Explicit link reference definitions always take priority over
1482implicit header references. So, in the following example, the
1483link will point to `bar`, not to `#foo`:
1494Markdown uses email conventions for quoting blocks of text.
1495A block quotation is one or more paragraphs or other block elements
1496(such as lists or headers), with each line preceded by a `>` character
1497and an optional space. (The `>` need not start at the left margin, but
1498it should not be indented more than three spaces.)
1500 > This is a block quote. This
1501 > paragraph has two lines.
1503 > 1. This is a list inside a block quote.
1506A "lazy" form, which requires the `>` character only on the first
1507line of each block, is also allowed:
1509 > This is a block quote. This
1510 paragraph has two lines.
1512 > 1. This is a list inside a block quote.
1515Among the block elements that can be contained in a block quote are
1516other block quotes. That is, block quotes can be nested:
1518 > This is a block quote.
1520 > > A block quote within a block quote.
1522If the `>` character is followed by an optional space, that space
1523will be considered part of the block quote marker and not part of
1524the indentation of the contents. Thus, to put an indented code
1525block in a block quote, you need five spaces after the `>`:
1529#### Extension: `blank_before_blockquote` ####
1531Standard markdown syntax does not require a blank line before a block
1532quote. Pandoc does require this (except, of course, at the beginning of the
1533document). The reason for the requirement is that it is all too easy for a
1534`>` to end up at the beginning of a line by accident (perhaps through line
1535wrapping). So, unless the `markdown_strict` format is used, the following does
1536not produce a nested block quote in pandoc:
1538 > This is a block quote.
1542Verbatim (code) blocks
1543----------------------
1545### Indented code blocks ###
1547A block of text indented four spaces (or one tab) is treated as verbatim
1548text: that is, special characters do not trigger special formatting,
1549and all spaces and line breaks are preserved. For example,
1552 moveShip(5 * gravity, DOWN);
1555The initial (four space or one tab) indentation is not considered part
1556of the verbatim text, and is removed in the output.
1558Note: blank lines in the verbatim text need not begin with four spaces.
1561### Fenced code blocks ###
1563#### Extension: `fenced_code_blocks` ####
1565In addition to standard indented code blocks, Pandoc supports
1566*fenced* code blocks. These begin with a row of three or more
1567tildes (`~`) and end with a row of tildes that must be at least as long as
1568the starting row. Everything between these lines is treated as code. No
1569indentation is necessary:
1573 moveShip(5 * gravity, DOWN);
1577Like regular code blocks, fenced code blocks must be separated
1578from surrounding text by blank lines.
1580If the code itself contains a row of tildes or backticks, just use a longer
1581row of tildes or backticks at the start and end:
1585 code including tildes
1589#### Extension: `backtick_code_blocks` ####
1591Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1594#### Extension: `fenced_code_attributes` ####
1596Optionally, you may attach attributes to fenced or backtick code block using
1599 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1601 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1602 qsort (filter (>= x) xs)
1603 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1605Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1606`startFrom` is an attribute with value `100`. Some output formats can use this
1607information to do syntax highlighting. Currently, the only output formats
1608that uses this information are HTML and LaTeX. If highlighting is supported
1609for your output format and language, then the code block above will appear
1610highlighted, with numbered lines. (To see which languages are supported, do
1611`pandoc --version`.) Otherwise, the code block above will appear as follows:
1613 <pre id="mycode" class="haskell numberLines" startFrom="100">
1619A shortcut form can also be used for specifying the language of
1626This is equivalent to:
1632If the `fenced_code_attributes` extension is disabled, but
1633input contains class attribute(s) for the codeblock, the first
1634class attribute will be printed after the opening fence as a bare
1637To prevent all highlighting, use the `--no-highlight` flag.
1638To set the highlighting style, use `--highlight-style`.
1639For more information on highlighting, see [Syntax highlighting],
1645#### Extension: `line_blocks` ####
1647A line block is a sequence of lines beginning with a vertical bar (`|`)
1648followed by a space. The division into lines will be preserved in
1649the output, as will any leading spaces; otherwise, the lines will
1650be formatted as markdown. This is useful for verse and addresses:
1652 | The limerick packs laughs anatomical
1653 | In space that is quite economical.
1654 | But the good ones I've seen
1655 | So seldom are clean
1656 | And the clean ones so seldom are comical
1659 | Berkeley, CA 94718
1661The lines can be hard-wrapped if needed, but the continuation
1662line must begin with a space.
1664 | The Right Honorable Most Venerable and Righteous Samuel L.
1667 | Berkeley, CA 94718
1669This syntax is borrowed from [reStructuredText].
1676A bullet list is a list of bulleted list items. A bulleted list
1677item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1684This will produce a "compact" list. If you want a "loose" list, in which
1685each item is formatted as a paragraph, put spaces between the items:
1693The bullets need not be flush with the left margin; they may be
1694indented one, two, or three spaces. The bullet must be followed
1697List items look best if subsequent lines are flush with the first
1698line (after the bullet):
1704But markdown also allows a "lazy" format:
1710### The four-space rule ###
1712A list item may contain multiple paragraphs and other block-level
1713content. However, subsequent paragraphs must be preceded by a blank line
1714and indented four spaces or a tab. The list will look better if the first
1715paragraph is aligned with the rest:
1721 * Second paragraph. With a code block, which must be indented
1726List items may include other lists. In this case the preceding blank
1727line is optional. The nested list must be indented four spaces or
1740As noted above, markdown allows you to write list items "lazily," instead of
1741indenting continuation lines. However, if there are multiple paragraphs or
1742other blocks in a list item, the first line of each must be indented.
1744 + A lazy, lazy, list
1747 + Another one; this looks
1750 Second paragraph of second
1753**Note:** Although the four-space rule for continuation paragraphs
1754comes from the official [markdown syntax guide], the reference implementation,
1755`Markdown.pl`, does not follow it. So pandoc will give different results than
1756`Markdown.pl` when authors have indented continuation paragraphs fewer than
1759The [markdown syntax guide] is not explicit whether the four-space
1760rule applies to *all* block-level content in a list item; it only
1761mentions paragraphs and code blocks. But it implies that the rule
1762applies to all block-level content (including nested lists), and
1763pandoc interprets it that way.
1765 [markdown syntax guide]:
1766 http://daringfireball.net/projects/markdown/syntax#list
1768### Ordered lists ###
1770Ordered lists work just like bulleted lists, except that the items
1771begin with enumerators rather than bullets.
1773In standard markdown, enumerators are decimal numbers followed
1774by a period and a space. The numbers themselves are ignored, so
1775there is no difference between this list:
1787#### Extension: `fancy_lists` ####
1789Unlike standard markdown, Pandoc allows ordered list items to be marked
1790with uppercase and lowercase letters and roman numerals, in addition to
1791arabic numerals. List markers may be enclosed in parentheses or followed by a
1792single right-parentheses or period. They must be separated from the
1793text that follows by at least one space, and, if the list marker is a
1794capital letter with a period, by at least two spaces.[^2]
1796[^2]: The point of this rule is to ensure that normal paragraphs
1797 starting with people's initials, like
1799 B. Russell was an English philosopher.
1801 do not get treated as list items.
1803 This rule will not prevent
1807 from being interpreted as a list item. In this case, a backslash
1812The `fancy_lists` extension also allows '`#`' to be used as an
1813ordered list marker in place of a numeral:
1818#### Extension: `startnum` ####
1820Pandoc also pays attention to the type of list marker used, and to the
1821starting number, and both of these are preserved where possible in the
1822output format. Thus, the following yields a list with numbers followed
1823by a single parenthesis, starting with 9, and a sublist with lowercase
1833Pandoc will start a new list each time a different type of list
1834marker is used. So, the following will create three lists:
1841If default list markers are desired, use `#.`:
1848### Definition lists ###
1850#### Extension: `definition_lists` ####
1852Pandoc supports definition lists, using the syntax of
1853[PHP Markdown Extra] with some extensions.[^3]
1859 Term 2 with *inline markup*
1863 { some code, part of Definition 2 }
1865 Third paragraph of definition 2.
1867Each term must fit on one line, which may optionally be followed by
1868a blank line, and must be followed by one or more definitions.
1869A definition begins with a colon or tilde, which may be indented one
1872A term may have multiple definitions, and each definition may consist of one or
1873more block elements (paragraph, code block, list, etc.), each indented four
1874spaces or one tab stop. The body of the definition (including the first line,
1875aside from the colon or tilde) should be indented four spaces. However,
1876as with other markdown lists, you can "lazily" omit indentation except
1877at the beginning of a paragraph or other block element:
1882 with lazy continuation.
1884 Second paragraph of the definition.
1886If you leave space before the definition (as in the example above),
1887the text of the definition will be treated as a paragraph. In some
1888output formats, this will mean greater spacing between term/definition
1889pairs. For a more compact definition list, omit the space before the
1899Note that space between items in a definition list is required.
1900(A variant that loosens this requirement, but disallows "lazy"
1901hard wrapping, can be activated with `compact_definition_lists`: see
1902[Non-pandoc extensions], below.)
1904[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
1906### Numbered example lists ###
1908#### Extension: `example_lists` ####
1910The special list marker `@` can be used for sequentially numbered
1911examples. The first list item with a `@` marker will be numbered '1',
1912the next '2', and so on, throughout the document. The numbered examples
1913need not occur in a single list; each new list using `@` will take up
1914where the last stopped. So, for example:
1916 (@) My first example will be numbered (1).
1917 (@) My second example will be numbered (2).
1919 Explanation of examples.
1921 (@) My third example will be numbered (3).
1923Numbered examples can be labeled and referred to elsewhere in the
1926 (@good) This is a good example.
1928 As (@good) illustrates, ...
1930The label can be any string of alphanumeric characters, underscores,
1934### Compact and loose lists ###
1936Pandoc behaves differently from `Markdown.pl` on some "edge
1937cases" involving lists. Consider this source:
1947Pandoc transforms this into a "compact list" (with no `<p>` tags around
1948"First", "Second", or "Third"), while markdown puts `<p>` tags around
1949"Second" and "Third" (but not "First"), because of the blank space
1950around "Third". Pandoc follows a simple rule: if the text is followed by
1951a blank line, it is treated as a paragraph. Since "Second" is followed
1952by a list, and not a blank line, it isn't treated as a paragraph. The
1953fact that the list is followed by a blank line is irrelevant. (Note:
1954Pandoc works this way even when the `markdown_strict` format is specified. This
1955behavior is consistent with the official markdown syntax description,
1956even though it is different from that of `Markdown.pl`.)
1959### Ending a list ###
1961What if you want to put an indented code block after a list?
1968Trouble! Here pandoc (like other markdown implementations) will treat
1969`{ my code block }` as the second paragraph of item two, and not as
1972To "cut off" the list after item two, you can insert some non-indented
1973content, like an HTML comment, which won't produce visible output in
1979 <!-- end of list -->
1983You can use the same trick if you want two consecutive lists instead
1999A line containing a row of three or more `*`, `-`, or `_` characters
2000(optionally separated by spaces) produces a horizontal rule:
2010Four kinds of tables may be used. The first three kinds presuppose the use of
2011a fixed-width font, such as Courier. The fourth kind can be used with
2012proportionally spaced fonts, as it does not require lining up columns.
2014#### Extension: `table_captions` ####
2016A caption may optionally be provided with all 4 kinds of tables (as
2017illustrated in the examples below). A caption is a paragraph beginning
2018with the string `Table:` (or just `:`), which will be stripped off.
2019It may appear either before or after the table.
2021#### Extension: `simple_tables` ####
2023Simple tables look like this:
2025 Right Left Center Default
2026 ------- ------ ---------- -------
2031 Table: Demonstration of simple table syntax.
2033The headers and table rows must each fit on one line. Column
2034alignments are determined by the position of the header text relative
2035to the dashed line below it:[^4]
2037 - If the dashed line is flush with the header text on the right side
2038 but extends beyond it on the left, the column is right-aligned.
2039 - If the dashed line is flush with the header text on the left side
2040 but extends beyond it on the right, the column is left-aligned.
2041 - If the dashed line extends beyond the header text on both sides,
2042 the column is centered.
2043 - If the dashed line is flush with the header text on both sides,
2044 the default alignment is used (in most cases, this will be left).
2046[^4]: This scheme is due to Michel Fortin, who proposed it on the
2047 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2049The table must end with a blank line, or a line of dashes followed by
2052The column headers may be omitted, provided a dashed line is used
2053to end the table. For example:
2055 ------- ------ ---------- -------
2059 ------- ------ ---------- -------
2061When headers are omitted, column alignments are determined on the basis
2062of the first line of the table body. So, in the tables above, the columns
2063would be right, left, center, and right aligned, respectively.
2065#### Extension: `multiline_tables` ####
2067Multiline tables allow headers and table rows to span multiple lines
2068of text (but cells that span multiple columns or rows of the table are
2069not supported). Here is an example:
2071 -------------------------------------------------------------
2072 Centered Default Right Left
2073 Header Aligned Aligned Aligned
2074 ----------- ------- --------------- -------------------------
2075 First row 12.0 Example of a row that
2076 spans multiple lines.
2078 Second row 5.0 Here's another one. Note
2079 the blank line between
2081 -------------------------------------------------------------
2083 Table: Here's the caption. It, too, may span
2086These work like simple tables, but with the following differences:
2088 - They must begin with a row of dashes, before the header text
2089 (unless the headers are omitted).
2090 - They must end with a row of dashes, then a blank line.
2091 - The rows must be separated by blank lines.
2093In multiline tables, the table parser pays attention to the widths of
2094the columns, and the writers try to reproduce these relative widths in
2095the output. So, if you find that one of the columns is too narrow in the
2096output, try widening it in the markdown source.
2098Headers may be omitted in multiline tables as well as simple tables:
2100 ----------- ------- --------------- -------------------------
2101 First row 12.0 Example of a row that
2102 spans multiple lines.
2104 Second row 5.0 Here's another one. Note
2105 the blank line between
2107 ----------- ------- --------------- -------------------------
2109 : Here's a multiline table without headers.
2111It is possible for a multiline table to have just one row, but the row
2112should be followed by a blank line (and then the row of dashes that ends
2113the table), or the table may be interpreted as a simple table.
2115#### Extension: `grid_tables` ####
2117Grid tables look like this:
2119 : Sample grid table.
2121 +---------------+---------------+--------------------+
2122 | Fruit | Price | Advantages |
2123 +===============+===============+====================+
2124 | Bananas | $1.34 | - built-in wrapper |
2125 | | | - bright color |
2126 +---------------+---------------+--------------------+
2127 | Oranges | $2.10 | - cures scurvy |
2129 +---------------+---------------+--------------------+
2131The row of `=`s separates the header from the table body, and can be
2132omitted for a headerless table. The cells of grid tables may contain
2133arbitrary block elements (multiple paragraphs, code blocks, lists,
2134etc.). Alignments are not supported, nor are cells that span multiple
2135columns or rows. Grid tables can be created easily using [Emacs table mode].
2137[Emacs table mode]: http://table.sourceforge.net/
2139#### Extension: `pipe_tables` ####
2141Pipe tables look like this:
2143 | Right | Left | Default | Center |
2144 |------:|:-----|---------|:------:|
2145 | 12 | 12 | 12 | 12 |
2146 | 123 | 123 | 123 | 123 |
2149 : Demonstration of pipe table syntax.
2151The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2152ending pipe characters are optional, but pipes are required between all
2153columns. The colons indicate column alignment as shown. The header
2154cannot be omitted. To simulate a headerless table, include a header
2157Since the pipes indicate column boundaries, columns need not be vertically
2158aligned, as they are in the above example. So, this is a perfectly
2159legal (though ugly) pipe table:
2167The cells of pipe tables cannot contain block elements like paragraphs
2168and lists, and cannot span multiple lines. Note also that in LaTeX/PDF
2169output, the cells produced by pipe tables will not wrap, since there
2170is no information available about relative widths. If you want content
2171to wrap within cells, use multiline or grid tables.
2173Note: Pandoc also recognizes pipe tables of the following
2174form, as can be produced by Emacs' orgtbl-mode:
2181The difference is that `+` is used instead of `|`. Other orgtbl features
2182are not supported. In particular, to get non-default column alignment,
2183you'll need to add colons as above.
2185[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2190#### Extension: `pandoc_title_block` ####
2192If the file begins with a title block
2195 % author(s) (separated by semicolons)
2198it will be parsed as bibliographic information, not regular text. (It
2199will be used, for example, in the title of standalone LaTeX or HTML
2200output.) The block may contain just a title, a title and an author,
2201or all three elements. If you want to include an author but no
2202title, or a title and a date but no author, you need a blank line:
2211The title may occupy multiple lines, but continuation lines must
2212begin with leading space, thus:
2217If a document has multiple authors, the authors may be put on
2218separate lines with leading space, or separated by semicolons, or
2219both. So, all of the following are equivalent:
2224 % Author One; Author Two
2229The date must fit on one line.
2231All three metadata fields may contain standard inline formatting
2232(italics, links, footnotes, etc.).
2234Title blocks will always be parsed, but they will affect the output only
2235when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2236will appear twice: once in the document head -- this is the title that
2237will appear at the top of the window in a browser -- and once at the
2238beginning of the document body. The title in the document head can have
2239an optional prefix attached (`--title-prefix` or `-T` option). The title
2240in the body appears as an H1 element with class "title", so it can be
2241suppressed or reformatted with CSS. If a title prefix is specified with
2242`-T` and no title block appears in the document, the title prefix will
2243be used by itself as the HTML title.
2245The man page writer extracts a title, man page section number, and
2246other header and footer information from the title line. The title
2247is assumed to be the first word on the title line, which may optionally
2248end with a (single-digit) section number in parentheses. (There should
2249be no space between the title and the parentheses.) Anything after
2250this is assumed to be additional footer and header text. A single pipe
2251character (`|`) should be used to separate the footer text from the header
2256will yield a man page with the title `PANDOC` and section 1.
2258 % PANDOC(1) Pandoc User Manuals
2260will also have "Pandoc User Manuals" in the footer.
2262 % PANDOC(1) Pandoc User Manuals | Version 4.0
2264will also have "Version 4.0" in the header.
2266#### Extension: `yaml_metadata_block` ####
2268A YAML metadata block is a valid YAML object, delimited by a line of three
2269hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2270(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2271document, but if it is not at the beginning, it must be preceded by a blank
2272line. (Note that, because of the way pandoc concatenates input files when
2273several are provided, you may also keep the metadata in a separate YAML file
2274and pass it to pandoc as an argument, along with your markdown files:
2276 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2278Just be sure that the YAML file begins with `---` and ends with `---` or
2281Metadata will be taken from the fields of the YAML object and added to any
2282existing document metadata. Metadata can contain lists and objects (nested
2283arbitrarily), but all string scalars will be interpreted as markdown. Fields
2284with names ending in an underscore will be ignored by pandoc. (They may be
2285given a role by external processors.)
2287A document may contain multiple metadata blocks. The metadata fields will
2288be combined through a *left-biased union*: if two metadata blocks attempt
2289to set the same field, the value from the first block will be taken.
2291When pandoc is used with `-t markdown` to create a markdown document,
2292a YAML metadata block will be produced only if the `-s/--standalone`
2293option is used. All of the metadata will appear in a single block
2294at the beginning of the document.
2296Note that YAML escaping rules must be followed. Thus, for example,
2297if a title contains a colon, it must be quoted. The pipe character
2298(`|`) can be used to begin an indented block that will be interpreted
2299literally, without need for escaping. This form is necessary
2300when the field contains blank lines:
2303 title: 'This is the title: it contains a colon'
2306 affiliation: University of Somewhere
2308 affiliation: University of Nowhere
2309 tags: [nothing, nothingness]
2311 This is the abstract.
2313 It consists of two paragraphs.
2316Template variables will be set automatically from the metadata. Thus, for
2317example, in writing HTML, the variable `abstract` will be set to the HTML
2318equivalent of the markdown in the `abstract` field:
2320 <p>This is the abstract.</p>
2321 <p>It consists of two paragraphs.</p>
2323Note: The `author` variable in the default templates expects a simple list or
2324string. To use the structured authors in the example, you would need a
2325custom template. For example:
2329 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2339#### Extension: `all_symbols_escapable` ####
2341Except inside a code block or inline code, any punctuation or space
2342character preceded by a backslash will be treated literally, even if it
2343would normally indicate formatting. Thus, for example, if one writes
2353 <strong>hello</strong>
2355This rule is easier to remember than standard markdown's rule,
2356which allows only the following characters to be backslash-escaped:
2360(However, if the `markdown_strict` format is used, the standard markdown rule
2363A backslash-escaped space is parsed as a nonbreaking space. It will
2364appear in TeX output as `~` and in HTML and XML as `\ ` or
2367A backslash-escaped newline (i.e. a backslash occurring at the end of
2368a line) is parsed as a hard line break. It will appear in TeX output as
2369`\\` and in HTML as `<br />`. This is a nice alternative to
2370markdown's "invisible" way of indicating hard line breaks using
2371two trailing spaces on a line.
2373Backslash escapes do not work in verbatim contexts.
2380If the `--smart` option is specified, pandoc will produce typographically
2381correct output, converting straight quotes to curly quotes, `---` to
2382em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2383are inserted after certain abbreviations, such as "Mr."
2385Note: if your LaTeX template calls for the [`csquotes`] package, pandoc will
2386detect this automatically and use `\enquote{...}` for quoted text.
2393To *emphasize* some text, surround it with `*`s or `_`, like this:
2395 This text is _emphasized with underscores_, and this
2396 is *emphasized with asterisks*.
2398Double `*` or `_` produces **strong emphasis**:
2400 This is **strong emphasis** and __with underscores__.
2402A `*` or `_` character surrounded by spaces, or backslash-escaped,
2403will not trigger emphasis:
2405 This is * not emphasized *, and \*neither is this\*.
2407#### Extension: `intraword_underscores` ####
2409Because `_` is sometimes used inside words and identifiers,
2410pandoc does not interpret a `_` surrounded by alphanumeric
2411characters as an emphasis marker. If you want to emphasize
2412just part of a word, use `*`:
2414 feas*ible*, not feas*able*.
2419#### Extension: `strikeout` ####
2421To strikeout a section of text with a horizontal line, begin and end it
2422with `~~`. Thus, for example,
2424 This ~~is deleted text.~~
2427### Superscripts and subscripts ###
2429#### Extension: `superscript`, `subscript` ####
2431Superscripts may be written by surrounding the superscripted text by `^`
2432characters; subscripts may be written by surrounding the subscripted
2433text by `~` characters. Thus, for example,
2435 H~2~O is a liquid. 2^10^ is 1024.
2437If the superscripted or subscripted text contains spaces, these spaces
2438must be escaped with backslashes. (This is to prevent accidental
2439superscripting and subscripting through the ordinary use of `~` and `^`.)
2440Thus, if you want the letter P with 'a cat' in subscripts, use
2441`P~a\ cat~`, not `P~a cat~`.
2446To make a short span of text verbatim, put it inside backticks:
2448 What is the difference between `>>=` and `>>`?
2450If the verbatim text includes a backtick, use double backticks:
2452 Here is a literal backtick `` ` ``.
2454(The spaces after the opening backticks and before the closing
2455backticks will be ignored.)
2457The general rule is that a verbatim span starts with a string
2458of consecutive backticks (optionally followed by a space)
2459and ends with a string of the same number of backticks (optionally
2460preceded by a space).
2462Note that backslash-escapes (and other markdown constructs) do not
2463work in verbatim contexts:
2465 This is a backslash followed by an asterisk: `\*`.
2467#### Extension: `inline_code_attributes` ####
2469Attributes can be attached to verbatim text, just as with
2470[fenced code blocks]:
2476To write small caps, you can use an HTML span tag:
2478 <span style="font-variant:small-caps;">Small caps</span>
2480(The semicolon is optional and there may be space after the
2481colon.) This will work in all output formats that support small caps.
2486#### Extension: `tex_math_dollars` ####
2488Anything between two `$` characters will be treated as TeX math. The
2489opening `$` must have a non-space character immediately to its right,
2490while the closing `$` must have a non-space character immediately to its
2491left, and must not be followed immediately by a digit. Thus,
2492`$20,000 and $30,000` won't parse as math. If for some reason
2493you need to enclose text in literal `$` characters, backslash-escape
2494them and they won't be treated as math delimiters.
2496TeX math will be printed in all output formats. How it is rendered
2497depends on the output format:
2499Markdown, LaTeX, Emacs Org mode, ConTeXt
2500 ~ It will appear verbatim between `$` characters.
2503 ~ It will be rendered using an [interpreted text role `:math:`].
2506 ~ It will be rendered as `latexmath:[...]`.
2509 ~ It will be rendered inside a `@math` command.
2512 ~ It will be rendered verbatim without `$`'s.
2515 ~ It will be rendered inside `<math>` tags.
2518 ~ It will be rendered inside `<span class="math">` tags.
2520RTF, OpenDocument, ODT
2521 ~ It will be rendered, if possible, using unicode characters,
2522 and will otherwise appear verbatim.
2525 ~ If the `--mathml` flag is used, it will be rendered using MathML
2526 in an `inlineequation` or `informalequation` tag. Otherwise it
2527 will be rendered, if possible, using unicode characters.
2530 ~ It will be rendered using OMML math markup.
2533 ~ If the `--webtex` option is used, formulas are rendered as images
2534 using Google Charts or other compatible web service, downloaded
2535 and embedded in the e-book. Otherwise, they will appear verbatim.
2537HTML, Slidy, DZSlides, S5, EPUB
2538 ~ The way math is rendered in HTML will depend on the
2539 command-line options selected:
2541 1. The default is to render TeX math as far as possible using unicode
2542 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2543 are put inside a `span` with `class="math"`, so that they may be
2544 styled differently from the surrounding text if needed.
2546 2. If the `--latexmathml` option is used, TeX math will be displayed
2547 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2548 The [LaTeXMathML] script will be used to render it as formulas.
2549 (This trick does not work in all browsers, but it works in Firefox.
2550 In browsers that do not support LaTeXMathML, TeX math will appear
2551 verbatim between `$` characters.)
2553 3. If the `--jsmath` option is used, TeX math will be put inside
2554 `<span>` tags (for inline math) or `<div>` tags (for display math)
2555 with class `math`. The [jsMath] script will be used to render
2558 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2559 be called to generate images for each TeX formula. This should
2560 work in all browsers. The `--mimetex` option takes an optional URL
2561 as argument. If no URL is specified, it will be assumed that the
2562 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2564 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2565 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2566 be processed by [gladTeX], which will produce image files for each
2567 formula and an HTML file with links to these images. So, the
2570 pandoc -s --gladtex myfile.txt -o myfile.htex
2571 gladtex -d myfile-images myfile.htex
2572 # produces myfile.html and images in myfile-images
2574 6. If the `--webtex` option is used, TeX formulas will be converted
2575 to `<img>` tags that link to an external script that converts
2576 formulas to images. The formula will be URL-encoded and concatenated
2577 with the URL provided. If no URL is specified, the Google Chart
2578 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2580 7. If the `--mathjax` option is used, TeX math will be displayed
2581 between `\(...\)` (for inline math) or `\[...\]` (for display
2582 math) and put in `<span>` tags with class `math`.
2583 The [MathJax] script will be used to render it as formulas.
2585[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2590#### Extension: `raw_html` ####
2592Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2593(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2594literally). (Technically this is not an extension, since standard
2595markdown allows it, but it has been made an extension so that it can
2596be disabled if desired.)
2598The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2599DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2602#### Extension: `markdown_in_html_blocks` ####
2604Standard markdown allows you to include HTML "blocks": blocks
2605of HTML between balanced tags that are separated from the surrounding text
2606with blank lines, and start and end at the left margin. Within
2607these blocks, everything is interpreted as HTML, not markdown;
2608so (for example), `*` does not signify emphasis.
2610Pandoc behaves this way when the `markdown_strict` format is used; but
2611by default, pandoc interprets material between HTML block tags as markdown.
2612Thus, for example, Pandoc will turn
2617 <td>[a link](http://google.com)</td>
2625 <td><em>one</em></td>
2626 <td><a href="http://google.com">a link</a></td>
2630whereas `Markdown.pl` will preserve it as is.
2632There is one exception to this rule: text between `<script>` and
2633`<style>` tags is not interpreted as markdown.
2635This departure from standard markdown should make it easier to mix
2636markdown with HTML block elements. For example, one can surround
2637a block of markdown text with `<div>` tags without preventing it
2638from being interpreted as markdown.
2640#### Extension: `native_divs` ####
2642Use native pandoc `Div` blocks for content inside `<div>` tags.
2643For the most part this should give the same output as
2644`markdown_in_html_blocks`, but it makes it easier to write pandoc
2645filters to manipulate groups of blocks.
2647#### Extension: `native_spans` ####
2649Use native pandoc `Span` blocks for content inside `<span>` tags.
2650For the most part this should give the same output as `raw_html`,
2651but it makes it easier to write pandoc filters to manipulate groups
2657#### Extension: `raw_tex` ####
2659In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2660included in a document. Inline TeX commands will be preserved and passed
2661unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2662LaTeX to include BibTeX citations:
2664 This result was proved in \cite{jones.1967}.
2666Note that in LaTeX environments, like
2668 \begin{tabular}{|l|l|}\hline
2669 Age & Frequency \\ \hline
2672 36--45 & 22 \\ \hline
2675the material between the begin and end tags will be interpreted as raw
2676LaTeX, not as markdown.
2678Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2684#### Extension: `latex_macros` ####
2686For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2687`\renewcommand` definitions and apply the resulting macros to all LaTeX
2688math. So, for example, the following will work in all output formats,
2691 \newcommand{\tuple}[1]{\langle #1 \rangle}
2695In LaTeX output, the `\newcommand` definition will simply be passed
2696unchanged to the output.
2702Markdown allows links to be specified in several ways.
2704### Automatic links ###
2706If you enclose a URL or email address in pointy brackets, it
2710 <sam@green.eggs.ham>
2714An inline link consists of the link text in square brackets,
2715followed by the URL in parentheses. (Optionally, the URL can
2716be followed by a link title, in quotes.)
2718 This is an [inline link](/url), and here's [one with
2719 a title](http://fsf.org "click here for a good time!").
2721There can be no space between the bracketed part and the parenthesized part.
2722The link text can contain formatting (such as emphasis), but the title cannot.
2724Email addresses in inline links are not autodetected, so they have to be
2725prefixed with `mailto`:
2727 [Write me!](mailto:sam@green.eggs.ham)
2729### Reference links ###
2731An *explicit* reference link has two parts, the link itself and the link
2732definition, which may occur elsewhere in the document (either
2733before or after the link).
2735The link consists of link text in square brackets, followed by a label in
2736square brackets. (There can be space between the two.) The link definition
2737consists of the bracketed label, followed by a colon and a space, followed by
2738the URL, and optionally (after a space) a link title either in quotes or in
2739parentheses. The label must not be parseable as a citation (assuming
2740the `citations` extension is enabled): citations take precedence over
2743Here are some examples:
2745 [my label 1]: /foo/bar.html "My title, optional"
2747 [my label 3]: http://fsf.org (The free software foundation)
2748 [my label 4]: /bar#special 'A title in single quotes'
2750The URL may optionally be surrounded by angle brackets:
2752 [my label 5]: <http://foo.bar.baz>
2754The title may go on the next line:
2756 [my label 3]: http://fsf.org
2757 "The free software foundation"
2759Note that link labels are not case sensitive. So, this will work:
2761 Here is [my link][FOO]
2765In an *implicit* reference link, the second pair of brackets is
2770 [my website]: http://foo.bar.baz
2772Note: In `Markdown.pl` and most other markdown implementations,
2773reference link definitions cannot occur in nested constructions
2774such as list items or block quotes. Pandoc lifts this arbitrary
2775seeming restriction. So the following is fine in pandoc, though
2776not in most other implementations:
2782#### Extension: `shortcut_reference_links` ####
2784In a *shortcut* reference link, the second pair of brackets may
2789 [my website]: http://foo.bar.baz
2791### Internal links ###
2793To link to another section of the same document, use the automatically
2794generated identifier (see [Header identifiers]). For example:
2796 See the [Introduction](#introduction).
2800 See the [Introduction].
2802 [Introduction]: #introduction
2804Internal links are currently supported for HTML formats (including
2805HTML slide shows and EPUB), LaTeX, and ConTeXt.
2810A link immediately preceded by a `!` will be treated as an image.
2811The link text will be used as the image's alt text:
2813 
2817 [movie reel]: movie.gif
2819#### Extension: `implicit_figures` ####
2821An image occurring by itself in a paragraph will be rendered as
2822a figure with a caption.[^5] (In LaTeX, a figure environment will be
2823used; in HTML, the image will be placed in a `div` with class
2824`figure`, together with a caption in a `p` with class `caption`.)
2825The image's alt text will be used as the caption.
2827 
2829[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2830 ODT. In those formats, you'll just get an image in a paragraph by
2831 itself, with no caption.
2833If you just want a regular inline image, just make sure it is not
2834the only thing in the paragraph. One way to do this is to insert a
2835nonbreaking space after the image:
2837 \
2843#### Extension: `footnotes` ####
2845Pandoc's markdown allows footnotes, using the following syntax:
2847 Here is a footnote reference,[^1] and another.[^longnote]
2849 [^1]: Here is the footnote.
2851 [^longnote]: Here's one with multiple blocks.
2853 Subsequent paragraphs are indented to show that they
2854 belong to the previous footnote.
2858 The whole paragraph can be indented, or just the first
2859 line. In this way, multi-paragraph footnotes work like
2860 multi-paragraph list items.
2862 This paragraph won't be part of the note, because it
2865The identifiers in footnote references may not contain spaces, tabs,
2866or newlines. These identifiers are used only to correlate the
2867footnote reference with the note itself; in the output, footnotes
2868will be numbered sequentially.
2870The footnotes themselves need not be placed at the end of the
2871document. They may appear anywhere except inside other block elements
2872(lists, block quotes, tables, etc.).
2874#### Extension: `inline_notes` ####
2876Inline footnotes are also allowed (though, unlike regular notes,
2877they cannot contain multiple paragraphs). The syntax is as follows:
2879 Here is an inline note.^[Inlines notes are easier to write, since
2880 you don't have to pick an identifier and move down to type the
2883Inline and regular footnotes may be mixed freely.
2889#### Extension: `citations` ####
2891Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
2892citations and a bibliography in a number of styles. Basic usage is
2894 pandoc --filter pandoc-citeproc myinput.txt
2896In order to use this feature, you will need to specify a bibliography file
2897using the `bibliography` metadata field in a YAML metadata section, or
2898`--bibliography` command line argument. You can supply multiple `--bibliography`
2899arguments or set `bibliography` metadata field to YAML array, if you want to
2900use multiple bibliography files.
2901The bibliography may have any of these formats:
2903 Format File extension
2904 ------------ --------------
2917Note that `.bib` can be used with both BibTeX and BibLaTeX files;
2918use `.bibtex` to force BibTeX.
2920Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
2921can produce `.json` and `.yaml` files from any of the supported formats.
2923In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
2924a subset of LaTeX markup; in CSL YAML databases, pandoc markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
2932`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
2941`<span class="nocase">...</span>`
2942: prevent a phrase from being capitalized as title case
2944`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
2945and CSL YAML formats as far as possible.
2947As an alternative to specifying a bibliography file, you can include
2948the citation data directly in the `references` field of the
2949document's YAML metadata. The field should contain an array of
2950YAML-encoded references, for example:
2954 - type: article-journal
2966 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
2968 title-short: Molecular structure of nucleic acids
2969 container-title: Nature
2973 DOI: 10.1038/171737a0
2974 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
2978(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
2979of the supported formats.)
2981Citations and references can be formatted using any style supported by the
2982[Citation Style Language], listed in the [Zotero Style Repository].
2983These files are specified using the `--csl` option or the `csl` metadata field.
2984By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
2985format. The CSL project provides further information on [finding and editing styles].
2987Citations go inside square brackets and are separated by semicolons.
2988Each citation must have a key, composed of '@' + the citation
2989identifier from the database, and may optionally have a prefix,
2990a locator, and a suffix. The citation key must begin with a letter, digit,
2991or `_`, and may contain alphanumerics, `_`, and internal punctuation
2992characters (`:.#$%&-+?<>~/`). Here are some examples:
2994 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
2996 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
2998 Blah blah [@smith04; @doe99].
3000`pandoc-citeproc` detects locator terms in the [CSL locale files].
3001Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3002locale, locator terms can be written in either singular or plural forms,
3003as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3004`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3005`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3006`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3007`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3008`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3009locator term is used, "page" is assumed.
3011A minus sign (`-`) before the `@` will suppress mention of
3012the author in the citation. This can be useful when the
3013author is already mentioned in the text:
3015 Smith says blah [-@smith04].
3017You can also write an in-text citation, as follows:
3021 @smith04 [p. 33] says blah.
3023If the style calls for a list of works cited, it will be placed
3024at the end of the document. Normally, you will want to end your
3025document with an appropriate header:
3031The bibliography will be inserted after this header. Note that
3032the `unnumbered` class will be added to this header, so that the
3033section will not be numbered.
3035If you want to include items in the bibliography without actually
3036citing them in the body text, you can define a dummy `nocite` metadata
3037field and put the citations there:
3046In this example, the document will contain a citation for `item3`
3047only, but the bibliography will contain entries for `item1`, `item2`, and
3050For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3051to render bibliography. In order to do so, specify bibliography files as
3052outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3053invocation. Bear in mind that bibliography files have to be in respective
3054format (either BibTeX or BibLaTeX).
3056[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3057[Chicago Manual of Style]: http://chicagomanualofstyle.org
3058[Citation Style Language]: http://citationstyles.org
3059[Zotero Style Repository]: https://www.zotero.org/styles
3060[finding and editing styles]: http://citationstyles.org/styles/
3061[CSL locale files]: https://github.com/citation-style-language/locales
3063Non-pandoc extensions
3064---------------------
3066The following markdown syntax extensions are not enabled by default
3067in pandoc, but may be enabled by adding `+EXTENSION` to the format
3068name, where `EXTENSION` is the name of the extension. Thus, for
3069example, `markdown+hard_line_breaks` is markdown with hard line breaks.
3071#### Extension: `lists_without_preceding_blankline` ####
3073Allow a list to occur right after a paragraph, with no intervening
3076#### Extension: `hard_line_breaks` ####
3078Causes all newlines within a paragraph to be interpreted as hard line
3079breaks instead of spaces.
3081#### Extension: `ignore_line_breaks` ####
3083Causes newlines within a paragraph to be ignored, rather than being
3084treated as spaces or as hard line breaks. This option is intended for
3085use with East Asian languages where spaces are not used between words,
3086but text is divided into lines for readability.
3088#### Extension: `tex_math_single_backslash` ####
3090Causes anything between `\(` and `\)` to be interpreted as inline
3091TeX math, and anything between `\[` and `\]` to be interpreted
3092as display TeX math. Note: a drawback of this extension is that
3093it precludes escaping `(` and `[`.
3095#### Extension: `tex_math_double_backslash` ####
3097Causes anything between `\\(` and `\\)` to be interpreted as inline
3098TeX math, and anything between `\\[` and `\\]` to be interpreted
3101#### Extension: `markdown_attribute` ####
3103By default, pandoc interprets material inside block-level tags as markdown.
3104This extension changes the behavior so that markdown is only parsed
3105inside block-level tags if the tags have the attribute `markdown=1`.
3107#### Extension: `mmd_title_block` ####
3109Enables a [MultiMarkdown] style title block at the top of
3110the document, for example:
3114 Date: September 1, 2008
3115 Comment: This is a sample mmd title block, with
3116 a field spanning multiple lines.
3118See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3119`yaml_metadata_block` is enabled, it will take precedence over
3122[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
3124#### Extension: `abbreviations` ####
3126Parses PHP Markdown Extra abbreviation keys, like
3128 *[HTML]: Hypertext Markup Language
3130Note that the pandoc document model does not support
3131abbreviations, so if this extension is enabled, abbreviation keys are
3132simply skipped (as opposed to being parsed as paragraphs).
3134#### Extension: `autolink_bare_uris` ####
3136Makes all absolute URIs into links, even when not surrounded by
3137pointy braces `<...>`.
3139#### Extension: `ascii_identifiers` ####
3141Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3142Accents are stripped off of accented latin letters, and non-latin
3145#### Extension: `link_attributes` ####
3147Parses multimarkdown style key-value attributes on link and image references.
3148Note that pandoc's internal document model provides nowhere to put
3149these, so they are presently just ignored.
3151#### Extension: `mmd_header_identifiers` ####
3153Parses multimarkdown style header identifiers (in square brackets,
3154after the header but before any trailing `#`s in an ATX header).
3156#### Extension: `compact_definition_lists` ####
3158Activates the definition list syntax of pandoc 1.12.x and earlier.
3159This syntax differs from the one described above under [Definition lists]
3162 - No blank line is required between consecutive items of the
3164 - To get a "tight" or "compact" list, omit space between consecutive
3165 items; the space between a term and its definition does not affect
3167 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3168 be indented four spaces.[^6]
3170[^6]: To see why laziness is incompatible with relaxing the requirement
3171 of a blank line between items, consider the following example:
3178 Is this a single list item with two definitions of "bar," the first of
3179 which is lazily wrapped, or two list items? To remove the ambiguity
3180 we must either disallow lazy wrapping or require a blank line between
3186In addition to pandoc's extended markdown, the following markdown
3187variants are supported:
3189`markdown_phpextra` (PHP Markdown Extra)
3190: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3191 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3192 `header_attributes`, `abbreviations`, `shortcut_reference_links`.
3194`markdown_github` (GitHub-Flavored Markdown)
3195: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
3196 `fenced_code_blocks`, `auto_identifiers`,
3197 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3198 `intraword_underscores`, `strikeout`, `hard_line_breaks`,
3199 `shortcut_reference_links`.
3201`markdown_mmd` (MultiMarkdown)
3202: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,
3203 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
3204 `mmd_title_block`, `footnotes`, `definition_lists`,
3205 `all_symbols_escapable`, `implicit_header_references`,
3206 `auto_identifiers`, `mmd_header_identifiers`,
3207 `shortcut_reference_links`.
3209`markdown_strict` (Markdown.pl)
3212Extensions with formats other than markdown
3213-------------------------------------------
3215Some of the extensions discussed above can be used with formats
3218* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3219 and `textile` input (and is used by default).
3221* `tex_math_dollars`, `tex_math_single_backslash`, and
3222 `tex_math_double_backslash` can be used with `html` input.
3223 (This is handy for reading web pages formatted using MathJax,
3226Producing slide shows with Pandoc
3227=================================
3229You can use Pandoc to produce an HTML + javascript slide presentation
3230that can be viewed via a web browser. There are five ways to do this,
3231using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3232You can also produce a PDF slide show using LaTeX [`beamer`].
3234Here's the markdown source for a simple slide show, `habits.txt`:
3261 
3268To produce an HTML/javascript slide show, simply type
3270 pandoc -t FORMAT -s habits.txt -o habits.html
3272where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3274For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3275`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3276assumed to be available at the relative path `s5/default` (for S5), `slideous`
3277(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3278`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3279`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3280above.) For DZSlides, the (relatively short) javascript and css are included in
3283With all HTML slide formats, the `--self-contained` option can be used to
3284produce a single file that contains all of the data necessary to display the
3285slide show, including linked scripts, stylesheets, images, and videos.
3287To produce a PDF slide show using beamer, type
3289 pandoc -t beamer habits.txt -o habits.pdf
3291Note that a reveal.js slide show can also be converted to a PDF
3292by printing it to a file from the browser.
3294Structuring the slide show
3295--------------------------
3297By default, the *slide level* is the highest header level in
3298the hierarchy that is followed immediately by content, and not another
3299header, somewhere in the document. In the example above, level 1 headers
3300are always followed by level 2 headers, which are followed by content,
3301so 2 is the slide level. This default can be overridden using
3302the `--slide-level` option.
3304The document is carved up into slides according to the following
3307 * A horizontal rule always starts a new slide.
3309 * A header at the slide level always starts a new slide.
3311 * Headers *below* the slide level in the hierarchy create
3312 headers *within* a slide.
3314 * Headers *above* the slide level in the hierarchy create
3315 "title slides," which just contain the section title
3316 and help to break the slide show into sections.
3318 * A title page is constructed automatically from the document's title
3319 block, if present. (In the case of beamer, this can be disabled
3320 by commenting out some lines in the default template.)
3322These rules are designed to support many different styles of slide show. If
3323you don't care about structuring your slides into sections and subsections,
3324you can just use level 1 headers for all each slide. (In that case, level 1
3325will be the slide level.) But you can also structure the slide show into
3326sections, as in the example above.
3328Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3329layout will be produced, with level 1 headers building horizontally
3330and level 2 headers building vertically. It is not recommended that
3331you use deeper nesting of section levels with reveal.js.
3336By default, these writers produce lists that display "all at once."
3337If you want your lists to display incrementally (one item at a time),
3338use the `-i` option. If you want a particular list to depart from the
3339default (that is, to display incrementally without the `-i` option and
3340all at once with the `-i` option), put it in a block quote:
3345In this way incremental and nonincremental lists can be mixed in
3351You can add "pauses" within a slide by including a paragraph containing
3352three dots, separated by spaces:
3354 # Slide with a pause
3356 content before the pause
3360 content after the pause
3365You can change the style of HTML slides by putting customized CSS files
3366in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3367or `$DATADIR/slideous` (for Slideous),
3368where `$DATADIR` is the user data directory (see `--data-dir`, above).
3369The originals may be found in pandoc's system data directory (generally
3370`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3371files it does not find in the user data directory.
3373For dzslides, the CSS is included in the HTML file itself, and may
3376All [reveal.js configuration options] can be set through variables.
3377For example, themes can be used by setting the `theme` variable:
3381Or you can specify a custom stylesheet using the `--css` option.
3383To style beamer slides, you can specify a `theme`, `colortheme`,
3384`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3386 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3388Note that header attributes will turn into slide attributes
3389(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3390to style individual slides. In beamer, the only header attribute
3391that affects slides is the `allowframebreaks` class, which sets the
3392`allowframebreaks` option, causing multiple slides to be created
3393if the content overfills the frame. This is recommended especially for
3396 # References {.allowframebreaks}
3401reveal.js has good support for speaker notes. You can add notes to your
3402markdown document thus:
3407 - It can contain markdown
3412To show the notes window, press `s` while viewing the presentation.
3413Notes are not yet supported for other slide formats, but the notes
3414will not appear on the slides themselves.
3416Frame attributes in beamer
3417--------------------------
3419Sometimes it is necessary to add the LaTeX `[fragile]` option to
3420a frame in beamer (for example, when using the `minted` environment).
3421This can be forced by adding the `fragile` class to the header
3422introducing the slide:
3424 # Fragile slide {.fragile}
3426All of the other frame attributes described in Section 8.1 of
3427the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3428`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3434EPUB metadata may be specified using the `--epub-metadata` option, but
3435if the source document is markdown, it is better to use a [YAML metadata
3436block][Extension: `yaml_metadata_block`]. Here is an example:
3443 text: An investigation of metadata
3451 text: doi:10.234234.234/33
3453 rights: © 2007 John Smith, CC BY-NC
3456The following fields are recognized:
3459 ~ Either a string value or an object with fields `text` and
3460 `scheme`. Valid values for `scheme` are `ISBN-10`,
3461 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3462 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3463 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3466 ~ Either a string value, or an object with fields `file-as` and
3467 `type`, or a list of such objects. Valid values for `type` are
3468 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3471 ~ Either a string value, or an object with fields `role`, `file-as`,
3472 and `text`, or a list of such objects. Valid values for `role` are
3473 [MARC relators], but
3474 pandoc will attempt to translate the human-readable versions
3475 (like "author" and "editor") to the appropriate marc relators.
3478 ~ Same format as `creator`.
3481 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3482 Pandoc will attempt to convert other common date formats.
3484`lang` (or legacy: `language`)
3485 ~ A string value in [BCP 47] format. Pandoc will default to the local
3486 language if nothing is specified.
3489 ~ A string value or a list of such values.
3510 ~ A string value (path to cover image).
3513 ~ A string value (path to CSS stylesheet).
3515`page-progression-direction`
3516 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3517 attribute for the [`spine` element].
3519[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3520[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3522Literate Haskell support
3523========================
3525If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3526format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3527`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3528literate Haskell source. This means that
3530 - In markdown input, "bird track" sections will be parsed as Haskell
3531 code rather than block quotations. Text between `\begin{code}`
3532 and `\end{code}` will also be treated as Haskell code. For
3533 ATX-style headers the character '=' will be used instead of '#'.
3535 - In markdown output, code blocks with classes `haskell` and `literate`
3536 will be rendered using bird tracks, and block quotations will be
3537 indented one space, so they will not be treated as Haskell code.
3538 In addition, headers will be rendered setext-style (with underlines)
3539 rather than ATX-style (with '#' characters). (This is because ghc
3540 treats '#' characters in column 1 as introducing line numbers.)
3542 - In restructured text input, "bird track" sections will be parsed
3545 - In restructured text output, code blocks with class `haskell` will
3546 be rendered using bird tracks.
3548 - In LaTeX input, text in `code` environments will be parsed as
3551 - In LaTeX output, code blocks with class `haskell` will be rendered
3552 inside `code` environments.
3554 - In HTML output, code blocks with class `haskell` will be rendered
3555 with class `literatehaskell` and bird tracks.
3559 pandoc -f markdown+lhs -t html
3561reads literate Haskell source formatted with markdown conventions and writes
3562ordinary HTML (without bird tracks).
3564 pandoc -f markdown+lhs -t html+lhs
3566writes HTML with the Haskell code in bird tracks, so it can be copied
3567and pasted as literate Haskell source.
3572Pandoc will automatically highlight syntax in [fenced code blocks] that
3573are marked with a language name. The Haskell library [highlighting-kate] is used for
3574highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3575The color scheme can be selected using the `--highlight-style` option.
3576The default color scheme is `pygments`, which imitates the default color
3577scheme used by the Python library pygments, but pygments is not actually
3578used to do the highlighting.
3580To see a list of language names that pandoc will recognize, type
3583To disable highlighting, use the `--no-highlight` option.
3585[highlighting-kate]: https://github.com/jgm/highlighting-kate
3590Pandoc can be extended with custom writers written in [lua]. (Pandoc
3591includes a lua interpreter, so lua need not be installed separately.)
3593To use a custom writer, simply specify the path to the lua script
3594in place of the output format. For example:
3596 pandoc -t data/sample.lua
3598Creating a custom writer requires writing a lua function for each
3599possible element in a pandoc document. To get a documented example
3600which you can modify according to your needs, do
3602 pandoc --print-default-data-file sample.lua
3604[lua]: http://www.lua.org
3609© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3610[GPL], version 2 or greater. This software carries no warranty of
3611any kind. (See COPYRIGHT for full copyright and warranty notices.)
3616Alexander Kondratskiy,
3618Alexander V Vershilov,
3619Alfred Wechselberger,
3626Beni Cherniavsky-Paskin,
3634Christoffer Ackelman,
3664Jaime Marquínez Ferrándiz,
3693Matthias C. M. Troffaes,
3739[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