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], [TEI Simple], and [Slidy], [Slideous], [DZSlides],
26[reveal.js] or [S5] HTML slide shows. It can also produce [PDF] output
27on systems where LaTeX, ConTeXt, or `wkhtmltopdf` is installed.
29Pandoc's enhanced version of Markdown includes syntax for [footnotes],
30[tables], flexible [ordered lists], [definition lists], [fenced code blocks],
31[superscripts and subscripts], [strikeout], [metadata blocks], automatic tables of
32contents, embedded LaTeX [math], [citations], and [Markdown inside HTML block
33elements][Extension: `markdown_in_html_blocks`]. (These enhancements, described below under
34[Pandoc's Markdown], can be disabled using the
35`markdown_strict` input or output format.)
37In contrast to most existing tools for converting Markdown to HTML, which
38use regex substitutions, pandoc has a modular design: it consists of a
39set of readers, which parse text in a given format and produce a native
40representation of the document, and a set of writers, which convert
41this native representation into a target format. Thus, adding an input
42or output format requires only adding a reader or writer.
44Because pandoc's intermediate representation of a document is less
45expressive than many of the formats it converts between, one should
46not expect perfect conversions between every format and every other.
47Pandoc attempts to preserve the structural elements of a document, but
48not formatting details such as margin size. And some document elements,
49such as complex tables, may not fit into pandoc's simple document
50model. While conversions from pandoc's Markdown to all formats aspire
51to be perfect, conversions from formats more expressive than pandoc's
52Markdown can be expected to be lossy.
54[Markdown]: http://daringfireball.net/projects/markdown/
55[CommonMark]: http://commonmark.org
56[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
57[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
58[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
59[S5]: http://meyerweb.com/eric/tools/s5/
60[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
61[Slideous]: http://goessner.net/articles/slideous/
62[HTML]: http://www.w3.org/html/
63[HTML5]: http://www.w3.org/TR/html5/
64[XHTML]: http://www.w3.org/TR/xhtml1/
65[LaTeX]: http://latex-project.org
66[`beamer`]: https://ctan.org/pkg/beamer
67[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
68[ConTeXt]: http://contextgarden.net/
69[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
70[DocBook]: http://docbook.org
71[txt2tags]: http://txt2tags.org
72[EPUB]: http://idpf.org/epub
73[OPML]: http://dev.opml.org/spec2.html
74[OpenDocument]: http://opendocument.xml.org
75[ODT]: http://en.wikipedia.org/wiki/OpenDocument
76[Textile]: http://redcloth.org/textile
77[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
78[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
79[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
80[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
81[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
82[Haskell]: https://www.haskell.org
83[GNU Texinfo]: http://www.gnu.org/software/texinfo/
84[Emacs Org mode]: http://orgmode.org
85[AsciiDoc]: http://www.methods.co.nz/asciidoc/
86[DZSlides]: http://paulrouget.com/dzslides/
87[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
88[PDF]: https://www.adobe.com/pdf/
89[reveal.js]: http://lab.hakim.se/reveal-js/
90[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
91[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
92[TEI Simple]: https://github.com/TEIC/TEI-Simple
97If no *input-file* is specified, input is read from *stdin*.
98Otherwise, the *input-files* are concatenated (with a blank
99line between each) and used as input. Output goes to *stdout* by
100default (though output to *stdout* is disabled for the `odt`, `docx`,
101`epub`, and `epub3` output formats). For output to a file, use the
104 pandoc -o output.html input.txt
106By default, pandoc produces a document fragment, not a standalone
107document with a proper header and footer. To produce a standalone
108document, use the `-s` or `--standalone` flag:
110 pandoc -s -o output.html input.txt
112For more information on how standalone documents are produced, see
115Instead of a file, an absolute URI may be given. In this case
116pandoc will fetch the content using HTTP:
118 pandoc -f html -t markdown http://www.fsf.org
120If multiple input files are given, `pandoc` will concatenate them all (with
121blank lines between them) before parsing. This feature is disabled for
122 binary input formats such as `EPUB`, `odt`, and `docx`.
124The format of the input and output can be specified explicitly using
125command-line options. The input format can be specified using the
126`-r/--read` or `-f/--from` options, the output format using the
127`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
128Markdown to LaTeX, you could type:
130 pandoc -f markdown -t latex hello.txt
132To convert `hello.html` from HTML to Markdown:
134 pandoc -f html -t markdown hello.html
136Supported output formats are listed below under the `-t/--to` option.
137Supported input formats are listed below under the `-f/--from` option. Note
138that the `rst`, `textile`, `latex`, and `html` readers are not complete;
139there are some constructs that they do not parse.
141If the input or output format is not specified explicitly, `pandoc`
142will attempt to guess it from the extensions of
143the input and output filenames. Thus, for example,
145 pandoc -o hello.tex hello.txt
147will convert `hello.txt` from Markdown to LaTeX. If no output file
148is specified (so that output goes to *stdout*), or if the output file's
149extension is unknown, the output format will default to HTML.
150If no input file is specified (so that input comes from *stdin*), or
151if the input files' extensions are unknown, the input format will
152be assumed to be Markdown unless explicitly specified.
154Pandoc uses the UTF-8 character encoding for both input and output.
155If your local character encoding is not UTF-8, you
156should pipe input and output through [`iconv`]:
158 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
160Note that in some output formats (such as HTML, LaTeX, ConTeXt,
161RTF, OPML, DocBook, and Texinfo), information about
162the character encoding is included in the document header, which
163will only be included if you use the `-s/--standalone` option.
165[`iconv`]: http://www.gnu.org/software/libiconv/
170To produce a PDF, specify an output file with a `.pdf` extension.
171By default, pandoc will use LaTeX to convert it to PDF:
173 pandoc test.txt -o test.pdf
175Production of a PDF requires that a LaTeX engine be installed (see
176`--latex-engine`, below), and assumes that the following LaTeX packages
177are available: [`amsfonts`], [`amsmath`], [`lm`],
178[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
179`--listings` option is used), [`fancyvrb`], [`longtable`],
180[`booktabs`], [`graphicx`] and [`grffile`] (if the
181document contains images), [`hyperref`], [`ulem`],
182[`geometry`] (with the `geometry` variable set), [`setspace`] (with
183`linestretch`), and [`babel`] (with `lang`). The use of `xelatex` or
184`lualatex` as the LaTeX engine requires [`fontspec`]; `xelatex` uses
185[`mathspec`], [`polyglossia`] (with `lang`), [`xecjk`], and
186[`bidi`] (with the `dir` variable set). The [`upquote`] and
187[`microtype`] packages are used if available, and [`csquotes`] will
188be used for [smart punctuation] if added to the template or included in
189any header file. The [`natbib`], [`biblatex`], [`bibtex`], and [`biber`]
190packages can optionally be used for [citation rendering]. These are
191included with all recent versions of [TeX Live].
193Alternatively, pandoc can use ConTeXt or `wkhtmltopdf` to create a PDF.
194To do this, specify an output file with a `.pdf` extension,
195as before, but add `-t context` or `-t html5` to the command line.
197PDF output can be controlled using [variables for LaTeX] (if
198LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
199If `wkhtmltopdf` is used, then the variables `margin-left`,
200`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
201will affect the output, as will `--css`.
203[`amsfonts`]: https://ctan.org/pkg/amsfonts
204[`amsmath`]: https://ctan.org/pkg/amsmath
205[`lm`]: https://ctan.org/pkg/lm
206[`ifxetex`]: https://ctan.org/pkg/ifxetex
207[`ifluatex`]: https://ctan.org/pkg/ifluatex
208[`eurosym`]: https://ctan.org/pkg/eurosym
209[`listings`]: https://ctan.org/pkg/listings
210[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
211[`longtable`]: https://ctan.org/pkg/longtable
212[`booktabs`]: https://ctan.org/pkg/booktabs
213[`graphicx`]: https://ctan.org/pkg/graphicx
214[`grffile`]: https://ctan.org/pkg/grffile
215[`geometry`]: https://ctan.org/pkg/geometry
216[`setspace`]: https://ctan.org/pkg/setspace
217[`xecjk`]: https://ctan.org/pkg/xecjk
218[`hyperref`]: https://ctan.org/pkg/hyperref
219[`ulem`]: https://ctan.org/pkg/ulem
220[`babel`]: https://ctan.org/pkg/babel
221[`bidi`]: https://ctan.org/pkg/bidi
222[`mathspec`]: https://ctan.org/pkg/mathspec
223[`polyglossia`]: https://ctan.org/pkg/polyglossia
224[`fontspec`]: https://ctan.org/pkg/fontspec
225[`upquote`]: https://ctan.org/pkg/upquote
226[`microtype`]: https://ctan.org/pkg/microtype
227[`csquotes`]: https://ctan.org/pkg/csquotes
228[`natbib`]: https://ctan.org/pkg/natbib
229[`biblatex`]: https://ctan.org/pkg/biblatex
230[`bibtex`]: https://ctan.org/pkg/bibtex
231[`biber`]: https://ctan.org/pkg/biber
232[TeX Live]: http://www.tug.org/texlive/
240`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
242: Specify input format. *FORMAT* can be `native` (native Haskell),
243 `json` (JSON version of native AST), `markdown` (pandoc's
244 extended Markdown), `markdown_strict` (original unextended
245 Markdown), `markdown_phpextra` (PHP Markdown Extra),
246 `markdown_github` (GitHub-Flavored Markdown),
247 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
248 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
249 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
250 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
251 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
252 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
253 input will be treated as literate Haskell source: see [Literate
254 Haskell support], below. Markdown
255 syntax extensions can be individually enabled or disabled by
256 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
257 example, `markdown_strict+footnotes+definition_lists` is strict
258 Markdown with footnotes and definition lists enabled, and
259 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
260 without pipe tables and with hard line breaks. See [Pandoc's
261 Markdown], below, for a list of extensions and
264`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
266: Specify output format. *FORMAT* can be `native` (native Haskell),
267 `json` (JSON version of native AST), `plain` (plain text),
268 `markdown` (pandoc's extended Markdown), `markdown_strict`
269 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
270 Extra), `markdown_github` (GitHub-Flavored
271 Markdown), `commonmark` (CommonMark Markdown), `rst`
272 (reStructuredText), `html` (XHTML), `html5` (HTML5), `latex`
273 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
274 `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
275 (DokuWiki markup), `textile` (Textile), `org` (Emacs Org mode),
276 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
277 `opendocument` (OpenDocument), `odt` (OpenOffice text document),
278 `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
279 format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
280 (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
281 ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and javascript slide
282 show), `slideous` (Slideous HTML and javascript slide show),
283 `dzslides` (DZSlides HTML5 + javascript slide show), `revealjs`
284 (reveal.js HTML5 + javascript slide show), `s5` (S5 HTML and javascript
285 slide show), or the path of a custom lua writer (see [Custom
286 writers], below). Note that `odt`, `epub`, and
287 `epub3` output will not be directed to *stdout*; an output
288 filename must be specified using the `-o/--output` option. If
289 `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
290 `html`, or `html5`, the output will be rendered as literate
291 Haskell source: see [Literate Haskell
292 support], below. Markdown syntax
293 extensions can be individually enabled or disabled by appending
294 `+EXTENSION` or `-EXTENSION` to the format name, as described
297`-o` *FILE*, `--output=`*FILE*
299: Write output to *FILE* instead of *stdout*. If *FILE* is
300 `-`, output will go to *stdout*. (Exception: if the output
301 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
303`--data-dir=`*DIRECTORY*
305: Specify the user data directory to search for pandoc data files.
306 If this option is not specified, the default user data directory
307 will be used. This is, in Unix:
313 C:\Documents And Settings\USERNAME\Application Data\pandoc
315 and in Windows Vista or later:
317 C:\Users\USERNAME\AppData\Roaming\pandoc
319 You can find the default user data directory on your system by
320 looking at the output of `pandoc --version`.
321 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
322 `slidy`, `slideous`, or `s5` directory
323 placed in this directory will override pandoc's normal defaults.
327: Generate a bash completion script. To enable bash completion
328 with pandoc, add this to your `.bashrc`:
330 eval "$(pandoc --bash-completion)"
334: Give verbose debugging output. Currently this only has an effect
350: Parse untranslatable HTML codes and LaTeX environments as raw HTML
351 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
352 input. Raw HTML can be printed in Markdown, reStructuredText, HTML,
353 Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
354 can be printed in Markdown, reStructuredText, LaTeX, and ConTeXt output.
355 The default is for the readers to omit untranslatable HTML codes and
356 LaTeX environments. (The LaTeX reader does pass through untranslatable
357 LaTeX *commands*, even if `-R` is not specified.)
361: Produce typographically correct output, converting straight quotes
362 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
363 `...` to ellipses. Nonbreaking spaces are inserted after certain
364 abbreviations, such as "Mr." (Note: This option is selected automatically
365 when the output format is `latex` or `context`, unless `--no-tex-ligatures`
366 is used. It has no effect for `latex` input.)
370: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
371 a numeral is an en-dash, and `--` is an em-dash. This option is selected
372 automatically for `textile` input.
374`--base-header-level=`*NUMBER*
376: Specify the base level for headers (defaults to 1).
378`--indented-code-classes=`*CLASSES*
380: Specify classes to use for indented code blocks--for example,
381 `perl,numberLines` or `haskell`. Multiple classes may be separated
384`--default-image-extension=`*EXTENSION*
386: Specify a default extension to use when image paths/URLs have no
387 extension. This allows you to use the same source for formats that
388 require different kinds of images. Currently this option only affects
389 the Markdown and LaTeX readers.
393: Parse each file individually before combining for multifile
394 documents. This will allow footnotes in different files with the
395 same identifiers to work as expected. If this option is set,
396 footnotes and links will not work across files. Reading binary
397 files (docx, odt, epub) implies `--file-scope`.
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, TEI, 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
520: Specify the dpi (dots per inch) value for conversion from pixels
521 to inch/centimeters and vice versa. The default is 96dpi.
522 Technically, the correct term would be ppi (pixels per inch).
524`--wrap=[auto|none|preserve]`
526: Determine how text is wrapped in the output (the source
527 code, not the rendered version). With `auto` (the default),
528 pandoc will attempt to wrap lines to the column width specified by
529 `--columns` (default 80). With `none`, pandoc will not wrap
530 lines at all. With `preserve`, pandoc will attempt to
531 preserve the wrapping from the source document (that is,
532 where there are nonsemantic newlines in the source, there
533 will be nonsemantic newlines in the output as well).
537: Deprecated synonym for `--wrap=none`.
541: Specify length of lines in characters (for text wrapping).
542 This affects only the generated source code, not the layout on
545`--toc`, `--table-of-contents`
547: Include an automatically generated table of contents (or, in
548 the case of `latex`, `context`, `docx`, and `rst`, an instruction to create
549 one) in the output document. This option has no effect on `man`,
550 `docbook`, `slidy`, `slideous`, `s5`, or `odt` output.
552`--toc-depth=`*NUMBER*
554: Specify the number of section levels to include in the table
555 of contents. The default is 3 (which means that level 1, 2, and 3
556 headers will be listed in the contents).
560: Disables syntax highlighting for code blocks and inlines, even when
561 a language attribute is given.
563`--highlight-style=`*STYLE*
565: Specifies the coloring style to be used in highlighted source code.
566 Options are `pygments` (the default), `kate`, `monochrome`,
567 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
568 on syntax highlighting in pandoc, see [Syntax highlighting], below.
570`-H` *FILE*, `--include-in-header=`*FILE*
572: Include contents of *FILE*, verbatim, at the end of the header.
573 This can be used, for example, to include special
574 CSS or javascript in HTML documents. This option can be used
575 repeatedly to include multiple files in the header. They will be
576 included in the order specified. Implies `--standalone`.
578`-B` *FILE*, `--include-before-body=`*FILE*
580: Include contents of *FILE*, verbatim, at the beginning of the
581 document body (e.g. after the `<body>` tag in HTML, or the
582 `\begin{document}` command in LaTeX). This can be used to include
583 navigation bars or banners in HTML documents. This option can be
584 used repeatedly to include multiple files. They will be included in
585 the order specified. Implies `--standalone`.
587`-A` *FILE*, `--include-after-body=`*FILE*
589: Include contents of *FILE*, verbatim, at the end of the document
590 body (before the `</body>` tag in HTML, or the
591 `\end{document}` command in LaTeX). This option can be used
592 repeatedly to include multiple files. They will be included in the
593 order specified. Implies `--standalone`.
595Options affecting specific writers
596----------------------------------
600: Produce a standalone HTML file with no external dependencies, using
601 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
602 images, and videos. The resulting file should be "self-contained,"
603 in the sense that it needs no external files and no net access to be
604 displayed properly by a browser. This option works only with HTML output
605 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
606 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
607 stylesheets at absolute URLs will be downloaded; those at relative URLs
608 will be sought relative to the working directory (if the first source
609 file is local) or relative to the base URL (if the first source
610 file is remote). Limitation: resources that are loaded dynamically
611 through JavaScript cannot be incorporated; as a result, `--self-contained`
612 does not work with `--mathjax`, and some advanced features (e.g.
613 zoom or speaker notes) may not work in an offline "self-contained"
614 `reveal.js` slide show.
618: Use `<q>` tags for quotes in HTML.
622: Use only ascii characters in output. Currently supported only
623 for HTML output (which uses numerical entities instead of
624 UTF-8 when this option is selected).
628: Use reference-style links, rather than inline links, in writing Markdown
629 or reStructuredText. By default inline links are used.
633: Use ATX-style headers in Markdown and asciidoc output. The default is
634 to use setext-style headers for levels 1-2, and then ATX headers.
638: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
639 output. When the LaTeX document class is set to `report`, `book`,
640 or `memoir` (unless the `article` option is specified), this
641 option is implied. If `beamer` is the output format, top-level
642 headers will become `\part{..}`.
644`-N`, `--number-sections`
646: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
647 By default, sections are not numbered. Sections with class
648 `unnumbered` will never be numbered, even if `--number-sections`
651`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
653: Offset for section headings in HTML output (ignored in other
654 output formats). The first number is added to the section number for
655 top-level headers, the second for second-level headers, and so on.
656 So, for example, if you want the first top-level header in your
657 document to be numbered "6", specify `--number-offset=5`.
658 If your document starts with a level-2 header which you want to
659 be numbered "1.5", specify `--number-offset=1,4`.
660 Offsets are 0 by default. Implies `--number-sections`.
664: Do not use the TeX ligatures for quotation marks, apostrophes,
665 and dashes (`` `...' ``, ` ``..'' `, `--`, `---`) when
666 writing or reading LaTeX or ConTeXt. In reading LaTeX,
667 parse the characters `` ` ``, `'`, and `-` literally, rather
668 than parsing ligatures for quotation marks and dashes. In
669 writing LaTeX or ConTeXt, print unicode quotation mark and
670 dash characters literally, rather than converting them to
671 the standard ASCII TeX ligatures. Note: normally `--smart`
672 is selected automatically for LaTeX and ConTeXt output, but
673 it must be specified explicitly if `--no-tex-ligatures` is
674 selected. If you use literal curly quotes, dashes, and
675 ellipses in your source, then you may want to use
676 `--no-tex-ligatures` without `--smart`.
680: Use the [`listings`] package for LaTeX code blocks
684: Make list items in slide shows display incrementally (one by one).
685 The default is for lists to be displayed all at once.
687`--slide-level=`*NUMBER*
689: Specifies that headers with the specified level create
690 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
691 above this level in the hierarchy are used to divide the
692 slide show into sections; headers below this level create
693 subheads within a slide. The default is to set the slide level
694 based on the contents of the document; see
695 [Structuring the slide show].
699: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
700 and attach identifiers to the enclosing `<div>` (or `<section>`)
701 rather than the header itself. See
702 [Header identifiers], below.
704`--email-obfuscation=none`|`javascript`|`references`
706: Specify a method for obfuscating `mailto:` links in HTML documents.
707 `none` leaves `mailto:` links as they are. `javascript` obfuscates
708 them using javascript. `references` obfuscates them by printing their
709 letters as decimal or hexadecimal character references. The default
712`--id-prefix=`*STRING*
714: Specify a prefix to be added to all automatically generated identifiers
715 in HTML and DocBook output, and to footnote numbers in Markdown output.
716 This is useful for preventing duplicate identifiers when generating
717 fragments to be included in other pages.
719`-T` *STRING*, `--title-prefix=`*STRING*
721: Specify *STRING* as a prefix at the beginning of the title
722 that appears in the HTML header (but not in the title as it
723 appears at the beginning of the HTML body). Implies
726`-c` *URL*, `--css=`*URL*
728: Link to a CSS style sheet. This option can be used repeatedly to
729 include multiple files. They will be included in the order specified.
731`--reference-odt=`*FILE*
733: Use the specified file as a style reference in producing an ODT.
734 For best results, the reference ODT should be a modified version
735 of an ODT produced using pandoc. The contents of the reference ODT
736 are ignored, but its stylesheets are used in the new ODT. If no
737 reference ODT is specified on the command line, pandoc will look
738 for a file `reference.odt` in the user data directory (see
739 `--data-dir`). If this is not found either, sensible defaults will be
742`--reference-docx=`*FILE*
744: Use the specified file as a style reference in producing a docx file.
745 For best results, the reference docx should be a modified version
746 of a docx file produced using pandoc. The contents of the reference docx
747 are ignored, but its stylesheets and document properties (including
748 margins, page size, header, and footer) are used in the new docx. If no
749 reference docx is specified on the command line, pandoc will look
750 for a file `reference.docx` in the user data directory (see
751 `--data-dir`). If this is not found either, sensible defaults will be
752 used. The following styles are used by pandoc: [paragraph]
753 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
754 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
755 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
756 Definition, Caption, Table Caption, Image Caption, Figure,
757 Figure With Caption, TOC Heading;
758 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
759 Footnote Reference, Hyperlink; [table] Normal Table.
761`--epub-stylesheet=`*FILE*
763: Use the specified CSS file to style the EPUB. If no stylesheet
764 is specified, pandoc will look for a file `epub.css` in the
765 user data directory (see `--data-dir`). If it is not
766 found there, sensible defaults will be used.
768`--epub-cover-image=`*FILE*
770: Use the specified image as the EPUB cover. It is recommended
771 that the image be less than 1000px in width and height. Note that
772 in a Markdown source document you can also specify `cover-image`
773 in a YAML metadata block (see [EPUB Metadata], below).
775`--epub-metadata=`*FILE*
777: Look in the specified XML file for metadata for the EPUB.
778 The file should contain a series of [Dublin Core elements].
781 <dc:rights>Creative Commons</dc:rights>
782 <dc:language>es-AR</dc:language>
784 By default, pandoc will include the following metadata elements:
785 `<dc:title>` (from the document title), `<dc:creator>` (from the
786 document authors), `<dc:date>` (from the document date, which should
787 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
788 variable, or, if is not set, the locale), and `<dc:identifier
789 id="BookId">` (a randomly generated UUID). Any of these may be
790 overridden by elements in the metadata file.
792 Note: if the source document is Markdown, a YAML metadata block
793 in the document can be used instead. See below under
796`--epub-embed-font=`*FILE*
798: Embed the specified font in the EPUB. This option can be repeated
799 to embed multiple fonts. Wildcards can also be used: for example,
800 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
801 line, be sure to escape them or put the whole filename in single quotes,
802 to prevent them from being interpreted by the shell. To use the
803 embedded fonts, you will need to add declarations like the following
804 to your CSS (see `--epub-stylesheet`):
807 font-family: DejaVuSans;
810 src:url("DejaVuSans-Regular.ttf");
813 font-family: DejaVuSans;
816 src:url("DejaVuSans-Bold.ttf");
819 font-family: DejaVuSans;
822 src:url("DejaVuSans-Oblique.ttf");
825 font-family: DejaVuSans;
828 src:url("DejaVuSans-BoldOblique.ttf");
830 body { font-family: "DejaVuSans"; }
832`--epub-chapter-level=`*NUMBER*
834: Specify the header level at which to split the EPUB into separate
835 "chapter" files. The default is to split into chapters at level 1
836 headers. This option only affects the internal composition of the
837 EPUB, not the way chapters and sections are displayed to users. Some
838 readers may be slow if the chapter files are too large, so for large
839 documents with few level 1 headers, one might want to use a chapter
842`--latex-engine=pdflatex`|`lualatex`|`xelatex`
844: Use the specified LaTeX engine when producing PDF output.
845 The default is `pdflatex`. If the engine is not in your PATH,
846 the full path of the engine may be specified here.
848`--latex-engine-opt=`*STRING*
850: Use the given string as a command-line argument to the `latex-engine`.
851 If used multiple times, the arguments are provided with spaces between
852 them. Note that no check for duplicate options is done.
854[Dublin Core elements]: http://dublincore.org/documents/dces/
855[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
860`--bibliography=`*FILE*
862: Set the `bibliography` field in the document's metadata to *FILE*,
863 overriding any value set in the metadata, and process citations
864 using `pandoc-citeproc`. (This is equivalent to
865 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
866 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
867 used, making this equivalent to `--metadata bibliography=FILE`.
868 If you supply this argument multiple times, each *FILE* will be added
873: Set the `csl` field in the document's metadata to *FILE*,
874 overriding any value set in the metadata. (This is equivalent to
875 `--metadata csl=FILE`.)
876 This option is only relevant with `pandoc-citeproc`.
878`--citation-abbreviations=`*FILE*
880: Set the `citation-abbreviations` field in the document's metadata to
881 *FILE*, overriding any value set in the metadata. (This is equivalent to
882 `--metadata citation-abbreviations=FILE`.)
883 This option is only relevant with `pandoc-citeproc`.
887: Use [`natbib`] for citations in LaTeX output. This option is not for use
888 with the `pandoc-citeproc` filter or with PDF output. It is intended for
889 use in producing a LaTeX file that can be processed with [`bibtex`].
893: Use [`biblatex`] for citations in LaTeX output. This option is not for use
894 with the `pandoc-citeproc` filter or with PDF output. It is intended for
895 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
897Math rendering in HTML
898----------------------
900`-m` [*URL*], `--latexmathml`[`=`*URL*]
902: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
903 To insert a link to a local copy of the `LaTeXMathML.js` script,
904 provide a *URL*. If no *URL* is provided, the contents of the
905 script will be inserted directly into the HTML header, preserving
906 portability at the price of efficiency. If you plan to use math on
907 several pages, it is much better to link to a copy of the script,
912: Convert TeX math to [MathML] (in `docbook` as well as `html` and `html5`).
913 In standalone `html` output, a small javascript (or a link to such a
914 script if a *URL* is supplied) will be inserted that allows the MathML to
915 be viewed on some browsers.
919: Use [jsMath] to display embedded TeX math in HTML output.
920 The *URL* should point to the jsMath load script (e.g.
921 `jsMath/easy/load.js`); if provided, it will be linked to in
922 the header of standalone HTML documents. If a *URL* is not provided,
923 no link to the jsMath load script will be inserted; it is then
924 up to the author to provide such a link in the HTML template.
928: Use [MathJax] to display embedded TeX math in HTML output.
929 The *URL* should point to the `MathJax.js` load script.
930 If a *URL* is not provided, a link to the MathJax CDN will
935: Enclose TeX math in `<eq>` tags in HTML output. These can then
936 be processed by [gladTeX] to produce links to images of the typeset
941: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
942 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
946: Render TeX formulas using an external script that converts TeX
947 formulas to images. The formula will be concatenated with the URL
948 provided. If *URL* is not specified, the Google Chart API will be used.
952: Use [KaTeX] to display embedded TeX math in HTML output.
953 The *URL* should point to the `katex.js` load script. If a *URL* is
954 not provided, a link to the KaTeX CDN will be inserted.
956`--katex-stylesheet=`*URL*
958: The *URL* should point to the `katex.css` stylesheet. If this option is
959 not specified, a link to the KaTeX CDN will be inserted. Note that this
960 option does not imply `--katex`.
962[MathML]: http://www.w3.org/Math/
963[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
964[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
965[MathJax]: https://www.mathjax.org
966[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
967[mimeTeX]: http://www.forkosh.com/mimetex.html
968[KaTeX]: https://github.com/Khan/KaTeX
970Options for wrapper scripts
971---------------------------
975: Print information about command-line arguments to *stdout*, then exit.
976 This option is intended primarily for use in wrapper scripts.
977 The first line of output contains the name of the output file specified
978 with the `-o` option, or `-` (for *stdout*) if no output file was
979 specified. The remaining lines contain the command-line arguments,
980 one per line, in the order they appear. These do not include regular
981 pandoc options and their arguments, but do include any options appearing
982 after a `--` separator at the end of the line.
986: Ignore command-line arguments (for use in wrapper scripts).
987 Regular pandoc options are not ignored. Thus, for example,
989 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
993 pandoc -o foo.html -s
998When the `-s/--standalone` option is used, pandoc uses a template to
999add header and footer material that is needed for a self-standing
1000document. To see the default template that is used, just type
1004where *FORMAT* is the name of the output format. A custom template
1005can be specified using the `--template` option. You can also override
1006the system default templates for a given output format *FORMAT*
1007by putting a file `templates/default.*FORMAT*` in the user data
1008directory (see `--data-dir`, above). *Exceptions:*
1010- For `odt` output, customize the `default.opendocument`
1012- For `pdf` output, customize the `default.latex` template
1013 (or the `default.beamer` template, if you use `-t beamer`,
1014 or the `default.context` template, if you use `-t context`).
1015- `docx` has no template (however, you can use
1016 `--reference-docx` to customize the output).
1018Templates contain *variables*, which allow for the inclusion of
1019arbitrary information at any point in the file. Variables may be set
1020within the document using [YAML metadata blocks][Extension:
1021`yaml_metadata_block`]. They may also be set at the
1022command line using the `-V/--variable` option: variables set in this
1023way override metadata fields with the same name.
1025Variables set by pandoc
1026-----------------------
1028Some variables are set automatically by pandoc. These vary somewhat
1029depending on the output format, but include metadata fields as well
1032`title`, `author`, `date`
1033: allow identification of basic aspects of the document. Included
1034 in PDF metadata through LaTeX and ConTeXt. These can be set
1035 through a [pandoc title block][Extension: `pandoc_title_block`],
1036 which allows for multiple authors, or through a YAML metadata block:
1045: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1046 renders in LaTeX only when using a document class that supports
1047 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1048 `scrreprt`, `scrbook`).[^subtitle]
1051: author affiliations (in LaTeX and Beamer only). Can be a
1052 list, when there are multiple authors.
1055: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1058: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1059 may be repeated as for `author`, above
1062: contents specified by `-H/--include-in-header` (may have multiple
1066: non-null value if `--toc/--table-of-contents` was specified
1069: title of table of contents (works only with EPUB and docx)
1072: contents specified by `-B/--include-before-body` (may have
1076: contents specified by `-A/--include-after-body` (may have
1083: JSON representation of all of the document's metadata
1085[^subtitle]: To make `subtitle` work with other LaTeX
1086 document classes, you can add the following to `header-includes`:
1088 \providecommand{\subtitle}[1]{%
1089 \usepackage{titling}
1091 \par\large#1\end{center}}
1098: identifies the main language of the document,
1099 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1100 For some output formats, pandoc will convert it to an appropriate
1101 format stored in the additional variables `babel-lang`,
1102 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1104 Native pandoc `span`s and `div`s with the lang attribute
1105 (value in BCP 47) can be used to switch the language in
1109: a list of other languages used in the document
1110 in the YAML metadata, according to [BCP 47]. For example:
1111 `otherlangs: [en-GB, fr]`.
1112 This is automatically generated from the `lang` attributes
1113 in all `span`s and `div`s but can be overridden.
1114 Currently only used by LaTeX through the generated
1115 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1116 The LaTeX writer outputs polyglossia commands in the text but
1117 the `babel-newcommands` variable contains mappings for them
1118 to the corresponding babel.
1121: the base direction of the document, either `rtl` (right-to-left)
1122 or `ltr` (left-to-right).
1124 For bidirectional documents, native pandoc `span`s and `div`s
1125 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1126 override the base direction in some output formats.
1127 This may not always be necessary if the final renderer
1128 (e.g. the browser, when generating HTML) supports the
1129 [Unicode Bidirectional Algorithm].
1131 When using LaTeX for bidirectional documents, only the `xelatex` engine
1132 is fully supported (use `--latex-engine=xelatex`).
1134[BCP 47]: https://tools.ietf.org/html/bcp47
1135[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1140Variables are available for [producing slide shows with pandoc],
1141including all [reveal.js configuration options].
1144: base URL for Slidy documents (defaults to
1145 `http://www.w3.org/Talks/Tools/Slidy2`)
1148: base URL for Slideous documents (defaults to `slideous`)
1151: base URL for S5 documents (defaults to `s5/default`)
1154: base URL for reveal.js documents (defaults to `reveal.js`)
1156`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1157: themes for LaTeX [`beamer`] documents
1160: controls navigation symbols in `beamer` documents
1161 (default is `empty` for no navigation symbols; other valid values
1162 are `frame`, `vertical`, and `horizontal`).
1165: enables on "title pages" for new sections in `beamer`
1166 documents (default = true).
1168[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1173LaTeX variables are used when [creating a PDF].
1176: paper size, e.g. `letter`, `A4`
1179: font size for body text (e.g. `10pt`, `12pt`)
1182: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1185: option for document class, e.g. `oneside`; may be repeated
1186 for multiple options
1189: option for [`geometry`] package, e.g. `margin=1in`;
1190 may be repeated for multiple options
1192`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1193: sets margins, if `geometry` is not used (otherwise `geometry`
1197: adjusts line spacing using the [`setspace`]
1198 package, e.g. `1.25`, `1.5`
1201: font package for use with `pdflatex`:
1202 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1203 The default is [Latin Modern][`lm`].
1206: options for package used as `fontfamily`: e.g. `osf,sc` with
1207 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1208 figures and true small caps; may be repeated for multiple options
1210`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1211: font families for use with `xelatex` or
1212 `lualatex`: take the name of any system font, using the
1213 [`fontspec`] package. Note that if `CJKmainfont` is used,
1214 the [`xecjk`] package must be available.
1216`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1217: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1218 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1219 available through [`fontspec`], such as the OpenType features
1220 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1223: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1224 default is `T1` (see guide to [LaTeX font encodings])
1227: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1228 `urlcolor`, or `toccolor` are set
1230`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1231: color for internal links, citation links, external links, and links in table of contents:
1232 uses any of the [predefined LaTeX colors]
1235: causes links to be printed as footnotes
1238: uses document class settings for indentation (the default LaTeX template
1239 otherwise removes indentation and adds space between paragraphs)
1242: disables default behavior of LaTeX template that redefines (sub)paragraphs
1243 as sections, changing the appearance of nested headings in some classes
1246: specifies contents of acknowledgments footnote after document title.
1249: include table of contents (can also be set using `--toc/--table-of-contents`)
1252: level of section to include in table of contents
1255: include list of figures, list of tables
1258: bibliography to use for resolving references
1261: bibliography style, when used with `--natbib` and
1265: list of options for biblatex.
1267[`article`]: https://ctan.org/pkg/article
1268[`report`]: https://ctan.org/pkg/report
1269[`book`]: https://ctan.org/pkg/book
1270[KOMA-Script]: https://ctan.org/pkg/koma-script
1271[`memoir`]: https://ctan.org/pkg/memoir
1272[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1273[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1274[`mathpazo`]: https://ctan.org/pkg/mathpazo
1275[LaTeX font encodings]: https://ctan.org/pkg/encguide
1277Variables for ConTeXt
1278---------------------
1281: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1282 may be repeated for multiple options
1285: options for page margins and text arrangement (see [ConTeXt Layout]);
1286 may be repeated for multiple options
1288`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1289: sets margins, if `layout` is not used (otherwise `layout`
1293: font size for body text (e.g. `10pt`, `12pt`)
1295`mainfont`, `sansfont`, `monofont`, `mathfont`
1296: font families: take the name of any system font (see [ConTeXt Font Switching])
1298`linkcolor`, `contrastcolor`
1299: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1302: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1305: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1306 may be repeated for multiple options
1309: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1312: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1313 may be repeated for multiple options
1315`headertext`, `footertext`
1316: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1317 may be repeated up to four times for different placement
1320: page number style and location (using [`setuppagenumbering`]);
1321 may be repeated for multiple options
1324: include table of contents (can also be set using `--toc/--table-of-contents`)
1327: include list of figures, list of tables
1329[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1330[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1331[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1332[ConTeXt Color]: http://wiki.contextgarden.net/Color
1333[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1334[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1335[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1336[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1337[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1339Variables for man pages
1340-----------------------
1343: section number in man pages
1346: header in man pages
1349: footer in man pages
1352: adjusts text to left (`l`), right (`r`), center (`c`),
1353 or both (`b`) margins
1356: if `true` (the default), hyphenation will be used
1358Using variables in templates
1359----------------------------
1361Variable names are sequences of alphanumerics, `-`, and `_`,
1362starting with a letter. A variable name surrounded by `$` signs
1363will be replaced by its value. For example, the string `$title$` in
1365 <title>$title$</title>
1367will be replaced by the document title.
1369To write a literal `$` in a template, use `$$`.
1371Templates may contain conditionals. The syntax is as follows:
1379This will include `X` in the template if `variable` has a non-null
1380value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1381any valid template text, and may include interpolated variables or other
1382conditionals. The `$else$` section may be omitted.
1384When variables can have multiple values (for example, `author` in
1385a multi-author document), you can use the `$for$` keyword:
1388 <meta name="author" content="$author$" />
1391You can optionally specify a separator to be used between
1394 $for(author)$$author$$sep$, $endfor$
1396A dot can be used to select a field of a variable that takes
1397an object as its value. So, for example:
1399 $author.name$ ($author.affiliation$)
1401If you use custom templates, you may need to revise them as pandoc
1402changes. We recommend tracking the changes in the default templates,
1403and modifying your custom templates accordingly. An easy way to do this
1404is to fork the [pandoc-templates] repository and merge in changes after each
1407[pandoc-templates]: https://github.com/jgm/pandoc-templates
1412Pandoc understands an extended and slightly revised version of
1413John Gruber's [Markdown] syntax. This document explains the syntax,
1414noting differences from standard Markdown. Except where noted, these
1415differences can be suppressed by using the `markdown_strict` format instead
1416of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1417to the format name and disabled by adding `-EXTENSION`. For example,
1418`markdown_strict+footnotes` is strict Markdown with footnotes
1419enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1420Markdown without footnotes or pipe tables.
1425Markdown is designed to be easy to write, and, even more importantly,
1428> A Markdown-formatted document should be publishable as-is, as plain
1429> text, without looking like it's been marked up with tags or formatting
1431> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1433This principle has guided pandoc's decisions in finding syntax for
1434tables, footnotes, and other extensions.
1436There is, however, one respect in which pandoc's aims are different
1437from the original aims of Markdown. Whereas Markdown was originally
1438designed with HTML generation in mind, pandoc is designed for multiple
1439output formats. Thus, while pandoc allows the embedding of raw HTML,
1440it discourages it, and provides other, non-HTMLish ways of representing
1441important document elements like definition lists, tables, mathematics, and
1447A paragraph is one or more lines of text followed by one or more blank lines.
1448Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1449If you need a hard line break, put two or more spaces at the end of a line.
1451#### Extension: `escaped_line_breaks` ####
1453A backslash followed by a newline is also a hard line break.
1454Note: in multiline and grid table cells, this is the only way
1455to create a hard line break, since trailing spaces in the cells
1461There are two kinds of headers: Setext and ATX.
1463### Setext-style headers ###
1465A setext-style header is a line of text "underlined" with a row of `=` signs
1466(for a level one header) or `-` signs (for a level two header):
1474The header text can contain inline formatting, such as emphasis (see
1475[Inline formatting], below).
1478### ATX-style headers ###
1480An ATX-style header consists of one to six `#` signs and a line of
1481text, optionally followed by any number of `#` signs. The number of
1482`#` signs at the beginning of the line is the header level:
1484 ## A level-two header
1486 ### A level-three header ###
1488As with setext-style headers, the header text can contain formatting:
1490 # A level-one header with a [link](/url) and *emphasis*
1492#### Extension: `blank_before_header` ####
1494Standard Markdown syntax does not require a blank line before a header.
1495Pandoc does require this (except, of course, at the beginning of the
1496document). The reason for the requirement is that it is all too easy for a
1497`#` to end up at the beginning of a line by accident (perhaps through line
1498wrapping). Consider, for example:
1500 I like several of their flavors of ice cream:
1501 #22, for example, and #5.
1504### Header identifiers ###
1506#### Extension: `header_attributes` ####
1508Headers can be assigned attributes using this syntax at the end
1509of the line containing the header text:
1511 {#identifier .class .class key=value key=value}
1513Thus, for example, the following headers will all be assigned the identifier
1518 ## My header ## {#foo}
1520 My other header {#foo}
1523(This syntax is compatible with [PHP Markdown Extra].)
1525Note that although this syntax allows assignment of classes and key/value
1526attributes, writers generally don't use all of this information. Identifiers,
1527classes, and key/value attributes are used in HTML and HTML-based formats such
1528as EPUB and slidy. Identifiers are used for labels and link anchors in the
1529LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1531Headers with the class `unnumbered` will not be numbered, even if
1532`--number-sections` is specified. A single hyphen (`-`) in an attribute
1533context is equivalent to `.unnumbered`, and preferable in non-English
1540 # My header {.unnumbered}
1542#### Extension: `auto_identifiers` ####
1544A header without an explicitly specified identifier will be
1545automatically assigned a unique identifier based on the header text.
1546To derive the identifier from the header text,
1548 - Remove all formatting, links, etc.
1549 - Remove all footnotes.
1550 - Remove all punctuation, except underscores, hyphens, and periods.
1551 - Replace all spaces and newlines with hyphens.
1552 - Convert all alphabetic characters to lowercase.
1553 - Remove everything up to the first letter (identifiers may
1554 not begin with a number or punctuation mark).
1555 - If nothing is left after this, use the identifier `section`.
1560 ------------------------------- ----------------------------
1561 `Header identifiers in HTML` `header-identifiers-in-html`
1562 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1563 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1564 `3. Applications` `applications`
1567These rules should, in most cases, allow one to determine the identifier
1568from the header text. The exception is when several headers have the
1569same text; in this case, the first will get an identifier as described
1570above; the second will get the same identifier with `-1` appended; the
1571third with `-2`; and so on.
1573These identifiers are used to provide link targets in the table of
1574contents generated by the `--toc|--table-of-contents` option. They
1575also make it easy to provide links from one section of a document to
1576another. A link to this section, for example, might look like this:
1579 [header identifiers](#header-identifiers-in-html-latex-and-context).
1581Note, however, that this method of providing links to sections works
1582only in HTML, LaTeX, and ConTeXt formats.
1584If the `--section-divs` option is specified, then each section will
1585be wrapped in a `div` (or a `section`, if `--html5` was specified),
1586and the identifier will be attached to the enclosing `<div>`
1587(or `<section>`) tag rather than the header itself. This allows entire
1588sections to be manipulated using javascript or treated differently in
1591#### Extension: `implicit_header_references` ####
1593Pandoc behaves as if reference links have been defined for each header.
1596 [header identifiers](#header-identifiers-in-html)
1600 [header identifiers]
1604 [header identifiers][]
1608 [the section on header identifiers][header identifiers]
1610If there are multiple headers with identical text, the corresponding
1611reference will link to the first one only, and you will need to use explicit
1612links to link to the others, as described above.
1614Like regular reference links, these references are case-insensitive.
1616Explicit link reference definitions always take priority over
1617implicit header references. So, in the following example, the
1618link will point to `bar`, not to `#foo`:
1629Markdown uses email conventions for quoting blocks of text.
1630A block quotation is one or more paragraphs or other block elements
1631(such as lists or headers), with each line preceded by a `>` character
1632and an optional space. (The `>` need not start at the left margin, but
1633it should not be indented more than three spaces.)
1635 > This is a block quote. This
1636 > paragraph has two lines.
1638 > 1. This is a list inside a block quote.
1641A "lazy" form, which requires the `>` character only on the first
1642line of each block, is also allowed:
1644 > This is a block quote. This
1645 paragraph has two lines.
1647 > 1. This is a list inside a block quote.
1650Among the block elements that can be contained in a block quote are
1651other block quotes. That is, block quotes can be nested:
1653 > This is a block quote.
1655 > > A block quote within a block quote.
1657If the `>` character is followed by an optional space, that space
1658will be considered part of the block quote marker and not part of
1659the indentation of the contents. Thus, to put an indented code
1660block in a block quote, you need five spaces after the `>`:
1664#### Extension: `blank_before_blockquote` ####
1666Standard Markdown syntax does not require a blank line before a block
1667quote. Pandoc does require this (except, of course, at the beginning of the
1668document). The reason for the requirement is that it is all too easy for a
1669`>` to end up at the beginning of a line by accident (perhaps through line
1670wrapping). So, unless the `markdown_strict` format is used, the following does
1671not produce a nested block quote in pandoc:
1673 > This is a block quote.
1677Verbatim (code) blocks
1678----------------------
1680### Indented code blocks ###
1682A block of text indented four spaces (or one tab) is treated as verbatim
1683text: that is, special characters do not trigger special formatting,
1684and all spaces and line breaks are preserved. For example,
1687 moveShip(5 * gravity, DOWN);
1690The initial (four space or one tab) indentation is not considered part
1691of the verbatim text, and is removed in the output.
1693Note: blank lines in the verbatim text need not begin with four spaces.
1696### Fenced code blocks ###
1698#### Extension: `fenced_code_blocks` ####
1700In addition to standard indented code blocks, pandoc supports
1701*fenced* code blocks. These begin with a row of three or more
1702tildes (`~`) and end with a row of tildes that must be at least as long as
1703the starting row. Everything between these lines is treated as code. No
1704indentation is necessary:
1708 moveShip(5 * gravity, DOWN);
1712Like regular code blocks, fenced code blocks must be separated
1713from surrounding text by blank lines.
1715If the code itself contains a row of tildes or backticks, just use a longer
1716row of tildes or backticks at the start and end:
1720 code including tildes
1724#### Extension: `backtick_code_blocks` ####
1726Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1729#### Extension: `fenced_code_attributes` ####
1731Optionally, you may attach attributes to fenced or backtick code block using
1734 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1736 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1737 qsort (filter (>= x) xs)
1738 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1740Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1741`startFrom` is an attribute with value `100`. Some output formats can use this
1742information to do syntax highlighting. Currently, the only output formats
1743that uses this information are HTML and LaTeX. If highlighting is supported
1744for your output format and language, then the code block above will appear
1745highlighted, with numbered lines. (To see which languages are supported, do
1746`pandoc --version`.) Otherwise, the code block above will appear as follows:
1748 <pre id="mycode" class="haskell numberLines" startFrom="100">
1754A shortcut form can also be used for specifying the language of
1761This is equivalent to:
1767If the `fenced_code_attributes` extension is disabled, but
1768input contains class attribute(s) for the codeblock, the first
1769class attribute will be printed after the opening fence as a bare
1772To prevent all highlighting, use the `--no-highlight` flag.
1773To set the highlighting style, use `--highlight-style`.
1774For more information on highlighting, see [Syntax highlighting],
1780#### Extension: `line_blocks` ####
1782A line block is a sequence of lines beginning with a vertical bar (`|`)
1783followed by a space. The division into lines will be preserved in
1784the output, as will any leading spaces; otherwise, the lines will
1785be formatted as Markdown. This is useful for verse and addresses:
1787 | The limerick packs laughs anatomical
1788 | In space that is quite economical.
1789 | But the good ones I've seen
1790 | So seldom are clean
1791 | And the clean ones so seldom are comical
1794 | Berkeley, CA 94718
1796The lines can be hard-wrapped if needed, but the continuation
1797line must begin with a space.
1799 | The Right Honorable Most Venerable and Righteous Samuel L.
1802 | Berkeley, CA 94718
1804This syntax is borrowed from [reStructuredText].
1811A bullet list is a list of bulleted list items. A bulleted list
1812item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1819This will produce a "compact" list. If you want a "loose" list, in which
1820each item is formatted as a paragraph, put spaces between the items:
1828The bullets need not be flush with the left margin; they may be
1829indented one, two, or three spaces. The bullet must be followed
1832List items look best if subsequent lines are flush with the first
1833line (after the bullet):
1839But Markdown also allows a "lazy" format:
1845### The four-space rule ###
1847A list item may contain multiple paragraphs and other block-level
1848content. However, subsequent paragraphs must be preceded by a blank line
1849and indented four spaces or a tab. The list will look better if the first
1850paragraph is aligned with the rest:
1856 * Second paragraph. With a code block, which must be indented
1861List items may include other lists. In this case the preceding blank
1862line is optional. The nested list must be indented four spaces or
1875As noted above, Markdown allows you to write list items "lazily," instead of
1876indenting continuation lines. However, if there are multiple paragraphs or
1877other blocks in a list item, the first line of each must be indented.
1879 + A lazy, lazy, list
1882 + Another one; this looks
1885 Second paragraph of second
1888**Note:** Although the four-space rule for continuation paragraphs
1889comes from the official [Markdown syntax guide], the reference implementation,
1890`Markdown.pl`, does not follow it. So pandoc will give different results than
1891`Markdown.pl` when authors have indented continuation paragraphs fewer than
1894The [Markdown syntax guide] is not explicit whether the four-space
1895rule applies to *all* block-level content in a list item; it only
1896mentions paragraphs and code blocks. But it implies that the rule
1897applies to all block-level content (including nested lists), and
1898pandoc interprets it that way.
1900 [Markdown syntax guide]:
1901 http://daringfireball.net/projects/markdown/syntax#list
1903### Ordered lists ###
1905Ordered lists work just like bulleted lists, except that the items
1906begin with enumerators rather than bullets.
1908In standard Markdown, enumerators are decimal numbers followed
1909by a period and a space. The numbers themselves are ignored, so
1910there is no difference between this list:
1922#### Extension: `fancy_lists` ####
1924Unlike standard Markdown, pandoc allows ordered list items to be marked
1925with uppercase and lowercase letters and roman numerals, in addition to
1926arabic numerals. List markers may be enclosed in parentheses or followed by a
1927single right-parentheses or period. They must be separated from the
1928text that follows by at least one space, and, if the list marker is a
1929capital letter with a period, by at least two spaces.[^2]
1931[^2]: The point of this rule is to ensure that normal paragraphs
1932 starting with people's initials, like
1934 B. Russell was an English philosopher.
1936 do not get treated as list items.
1938 This rule will not prevent
1942 from being interpreted as a list item. In this case, a backslash
1947The `fancy_lists` extension also allows '`#`' to be used as an
1948ordered list marker in place of a numeral:
1953#### Extension: `startnum` ####
1955Pandoc also pays attention to the type of list marker used, and to the
1956starting number, and both of these are preserved where possible in the
1957output format. Thus, the following yields a list with numbers followed
1958by a single parenthesis, starting with 9, and a sublist with lowercase
1968Pandoc will start a new list each time a different type of list
1969marker is used. So, the following will create three lists:
1976If default list markers are desired, use `#.`:
1983### Definition lists ###
1985#### Extension: `definition_lists` ####
1987Pandoc supports definition lists, using the syntax of
1988[PHP Markdown Extra] with some extensions.[^3]
1994 Term 2 with *inline markup*
1998 { some code, part of Definition 2 }
2000 Third paragraph of definition 2.
2002Each term must fit on one line, which may optionally be followed by
2003a blank line, and must be followed by one or more definitions.
2004A definition begins with a colon or tilde, which may be indented one
2007A term may have multiple definitions, and each definition may consist of one or
2008more block elements (paragraph, code block, list, etc.), each indented four
2009spaces or one tab stop. The body of the definition (including the first line,
2010aside from the colon or tilde) should be indented four spaces. However,
2011as with other Markdown lists, you can "lazily" omit indentation except
2012at the beginning of a paragraph or other block element:
2017 with lazy continuation.
2019 Second paragraph of the definition.
2021If you leave space before the definition (as in the example above),
2022the text of the definition will be treated as a paragraph. In some
2023output formats, this will mean greater spacing between term/definition
2024pairs. For a more compact definition list, omit the space before the
2034Note that space between items in a definition list is required.
2035(A variant that loosens this requirement, but disallows "lazy"
2036hard wrapping, can be activated with `compact_definition_lists`: see
2037[Non-pandoc extensions], below.)
2039[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2041### Numbered example lists ###
2043#### Extension: `example_lists` ####
2045The special list marker `@` can be used for sequentially numbered
2046examples. The first list item with a `@` marker will be numbered '1',
2047the next '2', and so on, throughout the document. The numbered examples
2048need not occur in a single list; each new list using `@` will take up
2049where the last stopped. So, for example:
2051 (@) My first example will be numbered (1).
2052 (@) My second example will be numbered (2).
2054 Explanation of examples.
2056 (@) My third example will be numbered (3).
2058Numbered examples can be labeled and referred to elsewhere in the
2061 (@good) This is a good example.
2063 As (@good) illustrates, ...
2065The label can be any string of alphanumeric characters, underscores,
2069### Compact and loose lists ###
2071Pandoc behaves differently from `Markdown.pl` on some "edge
2072cases" involving lists. Consider this source:
2082Pandoc transforms this into a "compact list" (with no `<p>` tags around
2083"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2084"Second" and "Third" (but not "First"), because of the blank space
2085around "Third". Pandoc follows a simple rule: if the text is followed by
2086a blank line, it is treated as a paragraph. Since "Second" is followed
2087by a list, and not a blank line, it isn't treated as a paragraph. The
2088fact that the list is followed by a blank line is irrelevant. (Note:
2089Pandoc works this way even when the `markdown_strict` format is specified. This
2090behavior is consistent with the official Markdown syntax description,
2091even though it is different from that of `Markdown.pl`.)
2094### Ending a list ###
2096What if you want to put an indented code block after a list?
2103Trouble! Here pandoc (like other Markdown implementations) will treat
2104`{ my code block }` as the second paragraph of item two, and not as
2107To "cut off" the list after item two, you can insert some non-indented
2108content, like an HTML comment, which won't produce visible output in
2114 <!-- end of list -->
2118You can use the same trick if you want two consecutive lists instead
2134A line containing a row of three or more `*`, `-`, or `_` characters
2135(optionally separated by spaces) produces a horizontal rule:
2145Four kinds of tables may be used. The first three kinds presuppose the use of
2146a fixed-width font, such as Courier. The fourth kind can be used with
2147proportionally spaced fonts, as it does not require lining up columns.
2149#### Extension: `table_captions` ####
2151A caption may optionally be provided with all 4 kinds of tables (as
2152illustrated in the examples below). A caption is a paragraph beginning
2153with the string `Table:` (or just `:`), which will be stripped off.
2154It may appear either before or after the table.
2156#### Extension: `simple_tables` ####
2158Simple tables look like this:
2160 Right Left Center Default
2161 ------- ------ ---------- -------
2166 Table: Demonstration of simple table syntax.
2168The headers and table rows must each fit on one line. Column
2169alignments are determined by the position of the header text relative
2170to the dashed line below it:[^4]
2172 - If the dashed line is flush with the header text on the right side
2173 but extends beyond it on the left, the column is right-aligned.
2174 - If the dashed line is flush with the header text on the left side
2175 but extends beyond it on the right, the column is left-aligned.
2176 - If the dashed line extends beyond the header text on both sides,
2177 the column is centered.
2178 - If the dashed line is flush with the header text on both sides,
2179 the default alignment is used (in most cases, this will be left).
2181[^4]: This scheme is due to Michel Fortin, who proposed it on the
2182 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2184The table must end with a blank line, or a line of dashes followed by
2187The column headers may be omitted, provided a dashed line is used
2188to end the table. For example:
2190 ------- ------ ---------- -------
2194 ------- ------ ---------- -------
2196When headers are omitted, column alignments are determined on the basis
2197of the first line of the table body. So, in the tables above, the columns
2198would be right, left, center, and right aligned, respectively.
2200#### Extension: `multiline_tables` ####
2202Multiline tables allow headers and table rows to span multiple lines
2203of text (but cells that span multiple columns or rows of the table are
2204not supported). Here is an example:
2206 -------------------------------------------------------------
2207 Centered Default Right Left
2208 Header Aligned Aligned Aligned
2209 ----------- ------- --------------- -------------------------
2210 First row 12.0 Example of a row that
2211 spans multiple lines.
2213 Second row 5.0 Here's another one. Note
2214 the blank line between
2216 -------------------------------------------------------------
2218 Table: Here's the caption. It, too, may span
2221These work like simple tables, but with the following differences:
2223 - They must begin with a row of dashes, before the header text
2224 (unless the headers are omitted).
2225 - They must end with a row of dashes, then a blank line.
2226 - The rows must be separated by blank lines.
2228In multiline tables, the table parser pays attention to the widths of
2229the columns, and the writers try to reproduce these relative widths in
2230the output. So, if you find that one of the columns is too narrow in the
2231output, try widening it in the Markdown source.
2233Headers may be omitted in multiline tables as well as simple tables:
2235 ----------- ------- --------------- -------------------------
2236 First row 12.0 Example of a row that
2237 spans multiple lines.
2239 Second row 5.0 Here's another one. Note
2240 the blank line between
2242 ----------- ------- --------------- -------------------------
2244 : Here's a multiline table without headers.
2246It is possible for a multiline table to have just one row, but the row
2247should be followed by a blank line (and then the row of dashes that ends
2248the table), or the table may be interpreted as a simple table.
2250#### Extension: `grid_tables` ####
2252Grid tables look like this:
2254 : Sample grid table.
2256 +---------------+---------------+--------------------+
2257 | Fruit | Price | Advantages |
2258 +===============+===============+====================+
2259 | Bananas | $1.34 | - built-in wrapper |
2260 | | | - bright color |
2261 +---------------+---------------+--------------------+
2262 | Oranges | $2.10 | - cures scurvy |
2264 +---------------+---------------+--------------------+
2266The row of `=`s separates the header from the table body, and can be
2267omitted for a headerless table. The cells of grid tables may contain
2268arbitrary block elements (multiple paragraphs, code blocks, lists,
2269etc.). Alignments are not supported, nor are cells that span multiple
2270columns or rows. Grid tables can be created easily using [Emacs table mode].
2272[Emacs table mode]: http://table.sourceforge.net/
2274#### Extension: `pipe_tables` ####
2276Pipe tables look like this:
2278 | Right | Left | Default | Center |
2279 |------:|:-----|---------|:------:|
2280 | 12 | 12 | 12 | 12 |
2281 | 123 | 123 | 123 | 123 |
2284 : Demonstration of pipe table syntax.
2286The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2287ending pipe characters are optional, but pipes are required between all
2288columns. The colons indicate column alignment as shown. The header
2289cannot be omitted. To simulate a headerless table, include a header
2292Since the pipes indicate column boundaries, columns need not be vertically
2293aligned, as they are in the above example. So, this is a perfectly
2294legal (though ugly) pipe table:
2302The cells of pipe tables cannot contain block elements like paragraphs
2303and lists, and cannot span multiple lines. If a pipe table contains a
2304row whose printable content is wider than the column width (see
2305`--columns`), then the cell contents will wrap, with the
2306relative cell widths determined by the widths of the separator
2309Note: pandoc also recognizes pipe tables of the following
2310form, as can be produced by Emacs' orgtbl-mode:
2317The difference is that `+` is used instead of `|`. Other orgtbl features
2318are not supported. In particular, to get non-default column alignment,
2319you'll need to add colons as above.
2321[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2326#### Extension: `pandoc_title_block` ####
2328If the file begins with a title block
2331 % author(s) (separated by semicolons)
2334it will be parsed as bibliographic information, not regular text. (It
2335will be used, for example, in the title of standalone LaTeX or HTML
2336output.) The block may contain just a title, a title and an author,
2337or all three elements. If you want to include an author but no
2338title, or a title and a date but no author, you need a blank line:
2347The title may occupy multiple lines, but continuation lines must
2348begin with leading space, thus:
2353If a document has multiple authors, the authors may be put on
2354separate lines with leading space, or separated by semicolons, or
2355both. So, all of the following are equivalent:
2360 % Author One; Author Two
2365The date must fit on one line.
2367All three metadata fields may contain standard inline formatting
2368(italics, links, footnotes, etc.).
2370Title blocks will always be parsed, but they will affect the output only
2371when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2372will appear twice: once in the document head -- this is the title that
2373will appear at the top of the window in a browser -- and once at the
2374beginning of the document body. The title in the document head can have
2375an optional prefix attached (`--title-prefix` or `-T` option). The title
2376in the body appears as an H1 element with class "title", so it can be
2377suppressed or reformatted with CSS. If a title prefix is specified with
2378`-T` and no title block appears in the document, the title prefix will
2379be used by itself as the HTML title.
2381The man page writer extracts a title, man page section number, and
2382other header and footer information from the title line. The title
2383is assumed to be the first word on the title line, which may optionally
2384end with a (single-digit) section number in parentheses. (There should
2385be no space between the title and the parentheses.) Anything after
2386this is assumed to be additional footer and header text. A single pipe
2387character (`|`) should be used to separate the footer text from the header
2392will yield a man page with the title `PANDOC` and section 1.
2394 % PANDOC(1) Pandoc User Manuals
2396will also have "Pandoc User Manuals" in the footer.
2398 % PANDOC(1) Pandoc User Manuals | Version 4.0
2400will also have "Version 4.0" in the header.
2402#### Extension: `yaml_metadata_block` ####
2404A YAML metadata block is a valid YAML object, delimited by a line of three
2405hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2406(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2407document, but if it is not at the beginning, it must be preceded by a blank
2408line. (Note that, because of the way pandoc concatenates input files when
2409several are provided, you may also keep the metadata in a separate YAML file
2410and pass it to pandoc as an argument, along with your Markdown files:
2412 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2414Just be sure that the YAML file begins with `---` and ends with `---` or
2417Metadata will be taken from the fields of the YAML object and added to any
2418existing document metadata. Metadata can contain lists and objects (nested
2419arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2420with names ending in an underscore will be ignored by pandoc. (They may be
2421given a role by external processors.)
2423A document may contain multiple metadata blocks. The metadata fields will
2424be combined through a *left-biased union*: if two metadata blocks attempt
2425to set the same field, the value from the first block will be taken.
2427When pandoc is used with `-t markdown` to create a Markdown document,
2428a YAML metadata block will be produced only if the `-s/--standalone`
2429option is used. All of the metadata will appear in a single block
2430at the beginning of the document.
2432Note that YAML escaping rules must be followed. Thus, for example,
2433if a title contains a colon, it must be quoted. The pipe character
2434(`|`) can be used to begin an indented block that will be interpreted
2435literally, without need for escaping. This form is necessary
2436when the field contains blank lines:
2439 title: 'This is the title: it contains a colon'
2442 affiliation: University of Somewhere
2444 affiliation: University of Nowhere
2445 tags: [nothing, nothingness]
2447 This is the abstract.
2449 It consists of two paragraphs.
2452Template variables will be set automatically from the metadata. Thus, for
2453example, in writing HTML, the variable `abstract` will be set to the HTML
2454equivalent of the Markdown in the `abstract` field:
2456 <p>This is the abstract.</p>
2457 <p>It consists of two paragraphs.</p>
2459Note: The `author` variable in the default templates expects a simple list or
2460string. To use the structured authors in the example, you would need a
2461custom template. For example:
2465 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2475#### Extension: `all_symbols_escapable` ####
2477Except inside a code block or inline code, any punctuation or space
2478character preceded by a backslash will be treated literally, even if it
2479would normally indicate formatting. Thus, for example, if one writes
2489 <strong>hello</strong>
2491This rule is easier to remember than standard Markdown's rule,
2492which allows only the following characters to be backslash-escaped:
2496(However, if the `markdown_strict` format is used, the standard Markdown rule
2499A backslash-escaped space is parsed as a nonbreaking space. It will
2500appear in TeX output as `~` and in HTML and XML as `\ ` or
2503A backslash-escaped newline (i.e. a backslash occurring at the end of
2504a line) is parsed as a hard line break. It will appear in TeX output as
2505`\\` and in HTML as `<br />`. This is a nice alternative to
2506Markdown's "invisible" way of indicating hard line breaks using
2507two trailing spaces on a line.
2509Backslash escapes do not work in verbatim contexts.
2516If the `--smart` option is specified, pandoc will produce typographically
2517correct output, converting straight quotes to curly quotes, `---` to
2518em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2519are inserted after certain abbreviations, such as "Mr."
2521Note: if your LaTeX template or any included header file call for the
2522[`csquotes`] package, pandoc will detect this automatically and use
2523`\enquote{...}` for quoted text.
2530To *emphasize* some text, surround it with `*`s or `_`, like this:
2532 This text is _emphasized with underscores_, and this
2533 is *emphasized with asterisks*.
2535Double `*` or `_` produces **strong emphasis**:
2537 This is **strong emphasis** and __with underscores__.
2539A `*` or `_` character surrounded by spaces, or backslash-escaped,
2540will not trigger emphasis:
2542 This is * not emphasized *, and \*neither is this\*.
2544#### Extension: `intraword_underscores` ####
2546Because `_` is sometimes used inside words and identifiers,
2547pandoc does not interpret a `_` surrounded by alphanumeric
2548characters as an emphasis marker. If you want to emphasize
2549just part of a word, use `*`:
2551 feas*ible*, not feas*able*.
2556#### Extension: `strikeout` ####
2558To strikeout a section of text with a horizontal line, begin and end it
2559with `~~`. Thus, for example,
2561 This ~~is deleted text.~~
2564### Superscripts and subscripts ###
2566#### Extension: `superscript`, `subscript` ####
2568Superscripts may be written by surrounding the superscripted text by `^`
2569characters; subscripts may be written by surrounding the subscripted
2570text by `~` characters. Thus, for example,
2572 H~2~O is a liquid. 2^10^ is 1024.
2574If the superscripted or subscripted text contains spaces, these spaces
2575must be escaped with backslashes. (This is to prevent accidental
2576superscripting and subscripting through the ordinary use of `~` and `^`.)
2577Thus, if you want the letter P with 'a cat' in subscripts, use
2578`P~a\ cat~`, not `P~a cat~`.
2583To make a short span of text verbatim, put it inside backticks:
2585 What is the difference between `>>=` and `>>`?
2587If the verbatim text includes a backtick, use double backticks:
2589 Here is a literal backtick `` ` ``.
2591(The spaces after the opening backticks and before the closing
2592backticks will be ignored.)
2594The general rule is that a verbatim span starts with a string
2595of consecutive backticks (optionally followed by a space)
2596and ends with a string of the same number of backticks (optionally
2597preceded by a space).
2599Note that backslash-escapes (and other Markdown constructs) do not
2600work in verbatim contexts:
2602 This is a backslash followed by an asterisk: `\*`.
2604#### Extension: `inline_code_attributes` ####
2606Attributes can be attached to verbatim text, just as with
2607[fenced code blocks]:
2613To write small caps, you can use an HTML span tag:
2615 <span style="font-variant:small-caps;">Small caps</span>
2617(The semicolon is optional and there may be space after the
2618colon.) This will work in all output formats that support small caps.
2623#### Extension: `tex_math_dollars` ####
2625Anything between two `$` characters will be treated as TeX math. The
2626opening `$` must have a non-space character immediately to its right,
2627while the closing `$` must have a non-space character immediately to its
2628left, and must not be followed immediately by a digit. Thus,
2629`$20,000 and $30,000` won't parse as math. If for some reason
2630you need to enclose text in literal `$` characters, backslash-escape
2631them and they won't be treated as math delimiters.
2633TeX math will be printed in all output formats. How it is rendered
2634depends on the output format:
2636Markdown, LaTeX, Emacs Org mode, ConTeXt
2637 ~ It will appear verbatim between `$` characters.
2640 ~ It will be rendered using an [interpreted text role `:math:`].
2643 ~ It will be rendered as `latexmath:[...]`.
2646 ~ It will be rendered inside a `@math` command.
2649 ~ It will be rendered verbatim without `$`'s.
2652 ~ It will be rendered inside `<math>` tags.
2655 ~ It will be rendered inside `<span class="math">` tags.
2657RTF, OpenDocument, ODT
2658 ~ It will be rendered, if possible, using unicode characters,
2659 and will otherwise appear verbatim.
2662 ~ If the `--mathml` flag is used, it will be rendered using MathML
2663 in an `inlineequation` or `informalequation` tag. Otherwise it
2664 will be rendered, if possible, using unicode characters.
2667 ~ It will be rendered using OMML math markup.
2670 ~ If the `--webtex` option is used, formulas are rendered as images
2671 using Google Charts or other compatible web service, downloaded
2672 and embedded in the e-book. Otherwise, they will appear verbatim.
2674HTML, Slidy, DZSlides, S5, EPUB
2675 ~ The way math is rendered in HTML will depend on the
2676 command-line options selected:
2678 1. The default is to render TeX math as far as possible using unicode
2679 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2680 are put inside a `span` with `class="math"`, so that they may be
2681 styled differently from the surrounding text if needed.
2683 2. If the `--latexmathml` option is used, TeX math will be displayed
2684 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2685 The [LaTeXMathML] script will be used to render it as formulas.
2686 (This trick does not work in all browsers, but it works in Firefox.
2687 In browsers that do not support LaTeXMathML, TeX math will appear
2688 verbatim between `$` characters.)
2690 3. If the `--jsmath` option is used, TeX math will be put inside
2691 `<span>` tags (for inline math) or `<div>` tags (for display math)
2692 with class `math`. The [jsMath] script will be used to render
2695 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2696 be called to generate images for each TeX formula. This should
2697 work in all browsers. The `--mimetex` option takes an optional URL
2698 as argument. If no URL is specified, it will be assumed that the
2699 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2701 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2702 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2703 be processed by [gladTeX], which will produce image files for each
2704 formula and an HTML file with links to these images. So, the
2707 pandoc -s --gladtex myfile.txt -o myfile.htex
2708 gladtex -d myfile-images myfile.htex
2709 # produces myfile.html and images in myfile-images
2711 6. If the `--webtex` option is used, TeX formulas will be converted
2712 to `<img>` tags that link to an external script that converts
2713 formulas to images. The formula will be URL-encoded and concatenated
2714 with the URL provided. If no URL is specified, the Google Chart
2715 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2717 7. If the `--mathjax` option is used, TeX math will be displayed
2718 between `\(...\)` (for inline math) or `\[...\]` (for display
2719 math) and put in `<span>` tags with class `math`.
2720 The [MathJax] script will be used to render it as formulas.
2722[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2727#### Extension: `raw_html` ####
2729Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2730(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2731literally). (Technically this is not an extension, since standard
2732Markdown allows it, but it has been made an extension so that it can
2733be disabled if desired.)
2735The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2736DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2739#### Extension: `markdown_in_html_blocks` ####
2741Standard Markdown allows you to include HTML "blocks": blocks
2742of HTML between balanced tags that are separated from the surrounding text
2743with blank lines, and start and end at the left margin. Within
2744these blocks, everything is interpreted as HTML, not Markdown;
2745so (for example), `*` does not signify emphasis.
2747Pandoc behaves this way when the `markdown_strict` format is used; but
2748by default, pandoc interprets material between HTML block tags as Markdown.
2749Thus, for example, pandoc will turn
2754 <td>[a link](http://google.com)</td>
2762 <td><em>one</em></td>
2763 <td><a href="http://google.com">a link</a></td>
2767whereas `Markdown.pl` will preserve it as is.
2769There is one exception to this rule: text between `<script>` and
2770`<style>` tags is not interpreted as Markdown.
2772This departure from standard Markdown should make it easier to mix
2773Markdown with HTML block elements. For example, one can surround
2774a block of Markdown text with `<div>` tags without preventing it
2775from being interpreted as Markdown.
2777#### Extension: `native_divs` ####
2779Use native pandoc `Div` blocks for content inside `<div>` tags.
2780For the most part this should give the same output as
2781`markdown_in_html_blocks`, but it makes it easier to write pandoc
2782filters to manipulate groups of blocks.
2784#### Extension: `native_spans` ####
2786Use native pandoc `Span` blocks for content inside `<span>` tags.
2787For the most part this should give the same output as `raw_html`,
2788but it makes it easier to write pandoc filters to manipulate groups
2794#### Extension: `raw_tex` ####
2796In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2797included in a document. Inline TeX commands will be preserved and passed
2798unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2799LaTeX to include BibTeX citations:
2801 This result was proved in \cite{jones.1967}.
2803Note that in LaTeX environments, like
2805 \begin{tabular}{|l|l|}\hline
2806 Age & Frequency \\ \hline
2809 36--45 & 22 \\ \hline
2812the material between the begin and end tags will be interpreted as raw
2813LaTeX, not as Markdown.
2815Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2821#### Extension: `latex_macros` ####
2823For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2824`\renewcommand` definitions and apply the resulting macros to all LaTeX
2825math. So, for example, the following will work in all output formats,
2828 \newcommand{\tuple}[1]{\langle #1 \rangle}
2832In LaTeX output, the `\newcommand` definition will simply be passed
2833unchanged to the output.
2839Markdown allows links to be specified in several ways.
2841### Automatic links ###
2843If you enclose a URL or email address in pointy brackets, it
2847 <sam@green.eggs.ham>
2851An inline link consists of the link text in square brackets,
2852followed by the URL in parentheses. (Optionally, the URL can
2853be followed by a link title, in quotes.)
2855 This is an [inline link](/url), and here's [one with
2856 a title](http://fsf.org "click here for a good time!").
2858There can be no space between the bracketed part and the parenthesized part.
2859The link text can contain formatting (such as emphasis), but the title cannot.
2861Email addresses in inline links are not autodetected, so they have to be
2862prefixed with `mailto`:
2864 [Write me!](mailto:sam@green.eggs.ham)
2866### Reference links ###
2868An *explicit* reference link has two parts, the link itself and the link
2869definition, which may occur elsewhere in the document (either
2870before or after the link).
2872The link consists of link text in square brackets, followed by a label in
2873square brackets. (There can be space between the two.) The link definition
2874consists of the bracketed label, followed by a colon and a space, followed by
2875the URL, and optionally (after a space) a link title either in quotes or in
2876parentheses. The label must not be parseable as a citation (assuming
2877the `citations` extension is enabled): citations take precedence over
2880Here are some examples:
2882 [my label 1]: /foo/bar.html "My title, optional"
2884 [my label 3]: http://fsf.org (The free software foundation)
2885 [my label 4]: /bar#special 'A title in single quotes'
2887The URL may optionally be surrounded by angle brackets:
2889 [my label 5]: <http://foo.bar.baz>
2891The title may go on the next line:
2893 [my label 3]: http://fsf.org
2894 "The free software foundation"
2896Note that link labels are not case sensitive. So, this will work:
2898 Here is [my link][FOO]
2902In an *implicit* reference link, the second pair of brackets is
2907 [my website]: http://foo.bar.baz
2909Note: In `Markdown.pl` and most other Markdown implementations,
2910reference link definitions cannot occur in nested constructions
2911such as list items or block quotes. Pandoc lifts this arbitrary
2912seeming restriction. So the following is fine in pandoc, though
2913not in most other implementations:
2919#### Extension: `shortcut_reference_links` ####
2921In a *shortcut* reference link, the second pair of brackets may
2926 [my website]: http://foo.bar.baz
2928### Internal links ###
2930To link to another section of the same document, use the automatically
2931generated identifier (see [Header identifiers]). For example:
2933 See the [Introduction](#introduction).
2937 See the [Introduction].
2939 [Introduction]: #introduction
2941Internal links are currently supported for HTML formats (including
2942HTML slide shows and EPUB), LaTeX, and ConTeXt.
2947A link immediately preceded by a `!` will be treated as an image.
2948The link text will be used as the image's alt text:
2950 
2954 [movie reel]: movie.gif
2956#### Extension: `implicit_figures` ####
2958An image occurring by itself in a paragraph will be rendered as
2959a figure with a caption.[^5] (In LaTeX, a figure environment will be
2960used; in HTML, the image will be placed in a `div` with class
2961`figure`, together with a caption in a `p` with class `caption`.)
2962The image's alt text will be used as the caption.
2964 
2966[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2967 ODT. In those formats, you'll just get an image in a paragraph by
2968 itself, with no caption.
2970If you just want a regular inline image, just make sure it is not
2971the only thing in the paragraph. One way to do this is to insert a
2972nonbreaking space after the image:
2974 \
2976#### Extension: `link_attributes` ####
2978Attributes can be set on links and images:
2980 An inline {#id .class width=30 height=20px}
2981 and a reference ![image][ref] with attributes.
2983 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
2985(This syntax is compatible with [PHP Markdown Extra] when only `#id`
2986and `.class` are used.)
2988For HTML and EPUB, all attributes except `width` and `height` (but
2989including `srcset` and `sizes`) are passed through as is. The other
2990writers ignore attributes that are not supported by their output
2993The `width` and `height` attributes on images are treated specially. When
2994used without a unit, the unit is assumed to be pixels. However, any of
2995the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
2996and `%`. There must not be any spaces between the number and the unit.
3000{ width=50% }
3003- Dimensions are converted to inches for output in page-based formats like
3004 LaTeX. Dimensions are converted to pixels for output in HTML-like
3005 formats. Use the `--dpi` option to specify the number of pixels per
3006 inch. The default is 96dpi.
3007- The `%` unit is generally relative to some available space.
3008 For example the above example will render to
3009 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3010 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3011 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3012- Some output formats have a notion of a class
3013 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3014 or a unique identifier (LaTeX `\caption`), or both (HTML).
3015- When no `width` or `height` attributes are specified, the fallback
3016 is to look at the image resolution and the dpi metadata embedded in
3023#### Extension: `footnotes` ####
3025Pandoc's Markdown allows footnotes, using the following syntax:
3027 Here is a footnote reference,[^1] and another.[^longnote]
3029 [^1]: Here is the footnote.
3031 [^longnote]: Here's one with multiple blocks.
3033 Subsequent paragraphs are indented to show that they
3034 belong to the previous footnote.
3038 The whole paragraph can be indented, or just the first
3039 line. In this way, multi-paragraph footnotes work like
3040 multi-paragraph list items.
3042 This paragraph won't be part of the note, because it
3045The identifiers in footnote references may not contain spaces, tabs,
3046or newlines. These identifiers are used only to correlate the
3047footnote reference with the note itself; in the output, footnotes
3048will be numbered sequentially.
3050The footnotes themselves need not be placed at the end of the
3051document. They may appear anywhere except inside other block elements
3052(lists, block quotes, tables, etc.).
3054#### Extension: `inline_notes` ####
3056Inline footnotes are also allowed (though, unlike regular notes,
3057they cannot contain multiple paragraphs). The syntax is as follows:
3059 Here is an inline note.^[Inlines notes are easier to write, since
3060 you don't have to pick an identifier and move down to type the
3063Inline and regular footnotes may be mixed freely.
3069#### Extension: `citations` ####
3071Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3072citations and a bibliography in a number of styles. Basic usage is
3074 pandoc --filter pandoc-citeproc myinput.txt
3076In order to use this feature, you will need to specify a bibliography file
3077using the `bibliography` metadata field in a YAML metadata section, or
3078`--bibliography` command line argument. You can supply multiple `--bibliography`
3079arguments or set `bibliography` metadata field to YAML array, if you want to
3080use multiple bibliography files. The bibliography may have any of these
3083 Format File extension
3084 ------------ --------------
3097Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3098use `.bibtex` to force BibTeX.
3100Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3101can produce `.json` and `.yaml` files from any of the supported formats.
3103In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3104a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3112`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3121`<span class="nocase">...</span>`
3122: prevent a phrase from being capitalized as title case
3124`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3125and CSL YAML formats as far as possible.
3127As an alternative to specifying a bibliography file using `--bibliography`
3128or the YAML metadata field `bibliography`, you can include
3129the citation data directly in the `references` field of the
3130document's YAML metadata. The field should contain an array of
3131YAML-encoded references, for example:
3135 - type: article-journal
3147 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3149 title-short: Molecular structure of nucleic acids
3150 container-title: Nature
3154 DOI: 10.1038/171737a0
3155 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3159(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3160of the supported formats.)
3162Citations and references can be formatted using any style supported by the
3163[Citation Style Language], listed in the [Zotero Style Repository].
3164These files are specified using the `--csl` option or the `csl` metadata field.
3165By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3166format. The CSL project provides further information on [finding and editing styles].
3168To make your citations hyperlinks to the corresponding bibliography
3169entries, add `link-citations: true` to your YAML metadata.
3171Citations go inside square brackets and are separated by semicolons.
3172Each citation must have a key, composed of '@' + the citation
3173identifier from the database, and may optionally have a prefix,
3174a locator, and a suffix. The citation key must begin with a letter, digit,
3175or `_`, and may contain alphanumerics, `_`, and internal punctuation
3176characters (`:.#$%&-+?<>~/`). Here are some examples:
3178 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3180 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3182 Blah blah [@smith04; @doe99].
3184`pandoc-citeproc` detects locator terms in the [CSL locale files].
3185Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3186locale, locator terms can be written in either singular or plural forms,
3187as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3188`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3189`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3190`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3191`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3192`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3193locator term is used, "page" is assumed.
3195A minus sign (`-`) before the `@` will suppress mention of
3196the author in the citation. This can be useful when the
3197author is already mentioned in the text:
3199 Smith says blah [-@smith04].
3201You can also write an in-text citation, as follows:
3205 @smith04 [p. 33] says blah.
3207If the style calls for a list of works cited, it will be placed
3208at the end of the document. Normally, you will want to end your
3209document with an appropriate header:
3215The bibliography will be inserted after this header. Note that
3216the `unnumbered` class will be added to this header, so that the
3217section will not be numbered.
3219If you want to include items in the bibliography without actually
3220citing them in the body text, you can define a dummy `nocite` metadata
3221field and put the citations there:
3230In this example, the document will contain a citation for `item3`
3231only, but the bibliography will contain entries for `item1`, `item2`, and
3234For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3235to render bibliography. In order to do so, specify bibliography files as
3236outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3237invocation. Bear in mind that bibliography files have to be in respective
3238format (either BibTeX or BibLaTeX).
3240For more information, see the [pandoc-citeproc man page].
3242[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3243[Chicago Manual of Style]: http://chicagomanualofstyle.org
3244[Citation Style Language]: http://citationstyles.org
3245[Zotero Style Repository]: https://www.zotero.org/styles
3246[finding and editing styles]: http://citationstyles.org/styles/
3247[CSL locale files]: https://github.com/citation-style-language/locales
3248[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3250Non-pandoc extensions
3251---------------------
3253The following Markdown syntax extensions are not enabled by default
3254in pandoc, but may be enabled by adding `+EXTENSION` to the format
3255name, where `EXTENSION` is the name of the extension. Thus, for
3256example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3258#### Extension: `lists_without_preceding_blankline` ####
3260Allow a list to occur right after a paragraph, with no intervening
3263#### Extension: `hard_line_breaks` ####
3265Causes all newlines within a paragraph to be interpreted as hard line
3266breaks instead of spaces.
3268#### Extension: `ignore_line_breaks` ####
3270Causes newlines within a paragraph to be ignored, rather than being
3271treated as spaces or as hard line breaks. This option is intended for
3272use with East Asian languages where spaces are not used between words,
3273but text is divided into lines for readability.
3275#### Extension: `east_asian_line_breaks` ####
3277Causes newlines within a paragraph to be ignored, rather than
3278being treated as spaces or as hard line breaks, when they occur
3279between two East Asian wide characters. This is a better choice
3280than `ignore_line_breaks` for texts that include a mix of East
3281Asian wide characters and other characters.
3283##### Extension: `emoji` ####
3285Parses textual emojis like `:smile:` as Unicode emoticons.
3287#### Extension: `tex_math_single_backslash` ####
3289Causes anything between `\(` and `\)` to be interpreted as inline
3290TeX math, and anything between `\[` and `\]` to be interpreted
3291as display TeX math. Note: a drawback of this extension is that
3292it precludes escaping `(` and `[`.
3294#### Extension: `tex_math_double_backslash` ####
3296Causes anything between `\\(` and `\\)` to be interpreted as inline
3297TeX math, and anything between `\\[` and `\\]` to be interpreted
3300#### Extension: `markdown_attribute` ####
3302By default, pandoc interprets material inside block-level tags as Markdown.
3303This extension changes the behavior so that Markdown is only parsed
3304inside block-level tags if the tags have the attribute `markdown=1`.
3306#### Extension: `mmd_title_block` ####
3308Enables a [MultiMarkdown] style title block at the top of
3309the document, for example:
3313 Date: September 1, 2008
3314 Comment: This is a sample mmd title block, with
3315 a field spanning multiple lines.
3317See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3318`yaml_metadata_block` is enabled, it will take precedence over
3321[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
3323#### Extension: `abbreviations` ####
3325Parses PHP Markdown Extra abbreviation keys, like
3327 *[HTML]: Hypertext Markup Language
3329Note that the pandoc document model does not support
3330abbreviations, so if this extension is enabled, abbreviation keys are
3331simply skipped (as opposed to being parsed as paragraphs).
3333#### Extension: `autolink_bare_uris` ####
3335Makes all absolute URIs into links, even when not surrounded by
3336pointy braces `<...>`.
3338#### Extension: `ascii_identifiers` ####
3340Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3341Accents are stripped off of accented latin letters, and non-latin
3344#### Extension: `mmd_link_attributes` ####
3346Parses multimarkdown style key-value attributes on link
3347and image references. This extension should not be confused with the
3348[`link_attributes`](#extension-link_attributes) extension.
3350 This is a reference ![image][ref] with multimarkdown attributes.
3352 [ref]: http://path.to/image "Image title" width=20px height=30px
3353 id=myId class="myClass1 myClass2"
3355#### Extension: `mmd_header_identifiers` ####
3357Parses multimarkdown style header identifiers (in square brackets,
3358after the header but before any trailing `#`s in an ATX header).
3360#### Extension: `compact_definition_lists` ####
3362Activates the definition list syntax of pandoc 1.12.x and earlier.
3363This syntax differs from the one described above under [Definition lists]
3366 - No blank line is required between consecutive items of the
3368 - To get a "tight" or "compact" list, omit space between consecutive
3369 items; the space between a term and its definition does not affect
3371 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3372 be indented four spaces.[^6]
3374[^6]: To see why laziness is incompatible with relaxing the requirement
3375 of a blank line between items, consider the following example:
3382 Is this a single list item with two definitions of "bar," the first of
3383 which is lazily wrapped, or two list items? To remove the ambiguity
3384 we must either disallow lazy wrapping or require a blank line between
3390In addition to pandoc's extended Markdown, the following Markdown
3391variants are supported:
3393`markdown_phpextra` (PHP Markdown Extra)
3394: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3395 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3396 `header_attributes`, `link_attributes`, `abbreviations`,
3397 `shortcut_reference_links`.
3399`markdown_github` (GitHub-Flavored Markdown)
3400: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3401 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3402 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3403 `shortcut_reference_links`.
3405`markdown_mmd` (MultiMarkdown)
3406: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3407 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
3408 `mmd_title_block`, `footnotes`, `definition_lists`,
3409 `all_symbols_escapable`, `implicit_header_references`,
3410 `auto_identifiers`, `mmd_header_identifiers`,
3411 `shortcut_reference_links`.
3413`markdown_strict` (Markdown.pl)
3416Extensions with formats other than Markdown
3417-------------------------------------------
3419Some of the extensions discussed above can be used with formats
3422* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3423 and `textile` input (and is used by default).
3425* `tex_math_dollars`, `tex_math_single_backslash`, and
3426 `tex_math_double_backslash` can be used with `html` input.
3427 (This is handy for reading web pages formatted using MathJax,
3430Producing slide shows with pandoc
3431=================================
3433You can use pandoc to produce an HTML + javascript slide presentation
3434that can be viewed via a web browser. There are five ways to do this,
3435using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3436You can also produce a PDF slide show using LaTeX [`beamer`].
3438Here's the Markdown source for a simple slide show, `habits.txt`:
3465 
3472To produce an HTML/javascript slide show, simply type
3474 pandoc -t FORMAT -s habits.txt -o habits.html
3476where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3478For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3479`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3480assumed to be available at the relative path `s5/default` (for S5), `slideous`
3481(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3482`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3483`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3484above.) For DZSlides, the (relatively short) javascript and css are included in
3487With all HTML slide formats, the `--self-contained` option can be used to
3488produce a single file that contains all of the data necessary to display the
3489slide show, including linked scripts, stylesheets, images, and videos.
3491To produce a PDF slide show using beamer, type
3493 pandoc -t beamer habits.txt -o habits.pdf
3495Note that a reveal.js slide show can also be converted to a PDF
3496by printing it to a file from the browser.
3498Structuring the slide show
3499--------------------------
3501By default, the *slide level* is the highest header level in
3502the hierarchy that is followed immediately by content, and not another
3503header, somewhere in the document. In the example above, level 1 headers
3504are always followed by level 2 headers, which are followed by content,
3505so 2 is the slide level. This default can be overridden using
3506the `--slide-level` option.
3508The document is carved up into slides according to the following
3511 * A horizontal rule always starts a new slide.
3513 * A header at the slide level always starts a new slide.
3515 * Headers *below* the slide level in the hierarchy create
3516 headers *within* a slide.
3518 * Headers *above* the slide level in the hierarchy create
3519 "title slides," which just contain the section title
3520 and help to break the slide show into sections.
3522 * A title page is constructed automatically from the document's title
3523 block, if present. (In the case of beamer, this can be disabled
3524 by commenting out some lines in the default template.)
3526These rules are designed to support many different styles of slide show. If
3527you don't care about structuring your slides into sections and subsections,
3528you can just use level 1 headers for all each slide. (In that case, level 1
3529will be the slide level.) But you can also structure the slide show into
3530sections, as in the example above.
3532Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3533layout will be produced, with level 1 headers building horizontally
3534and level 2 headers building vertically. It is not recommended that
3535you use deeper nesting of section levels with reveal.js.
3540By default, these writers produce lists that display "all at once."
3541If you want your lists to display incrementally (one item at a time),
3542use the `-i` option. If you want a particular list to depart from the
3543default (that is, to display incrementally without the `-i` option and
3544all at once with the `-i` option), put it in a block quote:
3549In this way incremental and nonincremental lists can be mixed in
3555You can add "pauses" within a slide by including a paragraph containing
3556three dots, separated by spaces:
3558 # Slide with a pause
3560 content before the pause
3564 content after the pause
3569You can change the style of HTML slides by putting customized CSS files
3570in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3571or `$DATADIR/slideous` (for Slideous),
3572where `$DATADIR` is the user data directory (see `--data-dir`, above).
3573The originals may be found in pandoc's system data directory (generally
3574`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3575files it does not find in the user data directory.
3577For dzslides, the CSS is included in the HTML file itself, and may
3580All [reveal.js configuration options] can be set through variables.
3581For example, themes can be used by setting the `theme` variable:
3585Or you can specify a custom stylesheet using the `--css` option.
3587To style beamer slides, you can specify a `theme`, `colortheme`,
3588`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3590 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3592Note that header attributes will turn into slide attributes
3593(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3594to style individual slides. In beamer, the only header attribute
3595that affects slides is the `allowframebreaks` class, which sets the
3596`allowframebreaks` option, causing multiple slides to be created
3597if the content overfills the frame. This is recommended especially for
3600 # References {.allowframebreaks}
3605reveal.js has good support for speaker notes. You can add notes to your
3606Markdown document thus:
3611 - It can contain Markdown
3616To show the notes window, press `s` while viewing the presentation.
3617Notes are not yet supported for other slide formats, but the notes
3618will not appear on the slides themselves.
3620Frame attributes in beamer
3621--------------------------
3623Sometimes it is necessary to add the LaTeX `[fragile]` option to
3624a frame in beamer (for example, when using the `minted` environment).
3625This can be forced by adding the `fragile` class to the header
3626introducing the slide:
3628 # Fragile slide {.fragile}
3630All of the other frame attributes described in Section 8.1 of
3631the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3632`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3635Creating EPUBs with pandoc
3636==========================
3641EPUB metadata may be specified using the `--epub-metadata` option, but
3642if the source document is Markdown, it is better to use a [YAML metadata
3643block][Extension: `yaml_metadata_block`]. Here is an example:
3650 text: An investigation of metadata
3658 text: doi:10.234234.234/33
3660 rights: © 2007 John Smith, CC BY-NC
3663The following fields are recognized:
3666 ~ Either a string value or an object with fields `text` and
3667 `scheme`. Valid values for `scheme` are `ISBN-10`,
3668 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3669 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3670 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3673 ~ Either a string value, or an object with fields `file-as` and
3674 `type`, or a list of such objects. Valid values for `type` are
3675 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3678 ~ Either a string value, or an object with fields `role`, `file-as`,
3679 and `text`, or a list of such objects. Valid values for `role` are
3680 [MARC relators], but
3681 pandoc will attempt to translate the human-readable versions
3682 (like "author" and "editor") to the appropriate marc relators.
3685 ~ Same format as `creator`.
3688 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3689 Pandoc will attempt to convert other common date formats.
3691`lang` (or legacy: `language`)
3692 ~ A string value in [BCP 47] format. Pandoc will default to the local
3693 language if nothing is specified.
3696 ~ A string value or a list of such values.
3717 ~ A string value (path to cover image).
3720 ~ A string value (path to CSS stylesheet).
3722`page-progression-direction`
3723 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3724 attribute for the [`spine` element].
3726[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3727[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3732By default, pandoc will download linked media (including audio and
3733video) and include it in the EPUB container, yielding a completely
3734self-contained EPUB. If you want to link to external media resources
3735instead, use raw HTML in your source and add `data-external="1"` to the tag
3736with the `src` attribute. For example:
3738 <audio controls="1">
3739 <source src="http://example.com/music/toccata.mp3"
3740 data-external="1" type="audio/mpeg">
3744Literate Haskell support
3745========================
3747If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3748format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3749`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3750literate Haskell source. This means that
3752 - In Markdown input, "bird track" sections will be parsed as Haskell
3753 code rather than block quotations. Text between `\begin{code}`
3754 and `\end{code}` will also be treated as Haskell code. For
3755 ATX-style headers the character '=' will be used instead of '#'.
3757 - In Markdown output, code blocks with classes `haskell` and `literate`
3758 will be rendered using bird tracks, and block quotations will be
3759 indented one space, so they will not be treated as Haskell code.
3760 In addition, headers will be rendered setext-style (with underlines)
3761 rather than ATX-style (with '#' characters). (This is because ghc
3762 treats '#' characters in column 1 as introducing line numbers.)
3764 - In restructured text input, "bird track" sections will be parsed
3767 - In restructured text output, code blocks with class `haskell` will
3768 be rendered using bird tracks.
3770 - In LaTeX input, text in `code` environments will be parsed as
3773 - In LaTeX output, code blocks with class `haskell` will be rendered
3774 inside `code` environments.
3776 - In HTML output, code blocks with class `haskell` will be rendered
3777 with class `literatehaskell` and bird tracks.
3781 pandoc -f markdown+lhs -t html
3783reads literate Haskell source formatted with Markdown conventions and writes
3784ordinary HTML (without bird tracks).
3786 pandoc -f markdown+lhs -t html+lhs
3788writes HTML with the Haskell code in bird tracks, so it can be copied
3789and pasted as literate Haskell source.
3794Pandoc will automatically highlight syntax in [fenced code blocks] that
3795are marked with a language name. The Haskell library [highlighting-kate] is used for
3796highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3797The color scheme can be selected using the `--highlight-style` option.
3798The default color scheme is `pygments`, which imitates the default color
3799scheme used by the Python library pygments, but pygments is not actually
3800used to do the highlighting.
3802To see a list of language names that pandoc will recognize, type
3805To disable highlighting, use the `--no-highlight` option.
3807[highlighting-kate]: https://github.com/jgm/highlighting-kate
3812Pandoc can be extended with custom writers written in [lua]. (Pandoc
3813includes a lua interpreter, so lua need not be installed separately.)
3815To use a custom writer, simply specify the path to the lua script
3816in place of the output format. For example:
3818 pandoc -t data/sample.lua
3820Creating a custom writer requires writing a lua function for each
3821possible element in a pandoc document. To get a documented example
3822which you can modify according to your needs, do
3824 pandoc --print-default-data-file sample.lua
3826[lua]: http://www.lua.org
3831© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3832[GPL], version 2 or greater. This software carries no warranty of
3833any kind. (See COPYRIGHT for full copyright and warranty notices.)
3838Alexander Kondratskiy,
3840Alexander V Vershilov,
3841Alfred Wechselberger,
3849Beni Cherniavsky-Paskin,
3857Christoffer Ackelman,
3887Jaime Marquínez Ferrándiz,
3916Matthias C. M. Troffaes,
3962[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