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 XML], 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.
391`--filter=`*EXECUTABLE*
393: Specify an executable to be used as a filter transforming the
394 pandoc AST after the input is parsed and before the output is
395 written. The executable should read JSON from stdin and write
396 JSON to stdout. The JSON must be formatted like pandoc's own
397 JSON input and output. The name of the output format will be
398 passed to the filter as the first argument. Hence,
400 pandoc --filter ./caps.py -t latex
404 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
406 The latter form may be useful for debugging filters.
408 Filters may be written in any language. `Text.Pandoc.JSON`
409 exports `toJSONFilter` to facilitate writing filters in Haskell.
410 Those who would prefer to write filters in python can use the
411 module [`pandocfilters`], installable from PyPI. There are also
412 pandoc filter libraries in [PHP], [perl], and [javascript/node.js].
414 Note that the *EXECUTABLE* will be sought in the user's
415 `PATH`, and not in the working directory, if no directory is
416 provided. If you want to run a script in the working directory,
417 preface the filename with `./`.
419`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
421: Set the metadata field *KEY* to the value *VAL*. A value specified
422 on the command line overrides a value specified in the document.
423 Values will be parsed as YAML boolean or string values. If no value is
424 specified, the value will be treated as Boolean true. Like
425 `--variable`, `--metadata` causes template variables to be set.
426 But unlike `--variable`, `--metadata` affects the metadata of the
427 underlying document (which is accessible from filters and may be
428 printed in some output formats).
432: Normalize the document after reading: merge adjacent
433 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
435`-p`, `--preserve-tabs`
437: Preserve tabs instead of converting them to spaces (the default).
438 Note that this will only affect tabs in literal code spans and code
439 blocks; tabs in regular text will be treated as spaces.
443: Specify the number of spaces per tab (default is 4).
445`--track-changes=accept`|`reject`|`all`
447: Specifies what to do with insertions and deletions produced by the MS
448 Word "Track Changes" feature. `accept` (the default), inserts all
449 insertions, and ignores all deletions. `reject` inserts all
450 deletions and ignores insertions. `all` puts in both insertions
451 and deletions, wrapped in spans with `insertion` and `deletion`
452 classes, respectively. The author and time of change is
453 included. `all` is useful for scripting: only accepting changes
454 from a certain reviewer, say, or before a certain date. This
455 option only affects the docx reader.
457`--extract-media=`*DIR*
459: Extract images and other media contained in a docx or epub container
460 to the path *DIR*, creating it if necessary, and adjust the images
461 references in the document so they point to the extracted files.
462 This option only affects the docx and epub readers.
464[`pandocfilters`]: https://github.com/jgm/pandocfilters
465[PHP]: https://github.com/vinai/pandocfilters-php
466[perl]: https://metacpan.org/pod/Pandoc::Filter
467[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
469General writer options
470----------------------
474: Produce output with an appropriate header and footer (e.g. a
475 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
476 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
481: Use *FILE* as a custom template for the generated document. Implies
482 `--standalone`. See [Templates], below, for a description
483 of template syntax. If no extension is specified, an extension
484 corresponding to the writer will be added, so that `--template=special`
485 looks for `special.html` for HTML output. If the template is not
486 found, pandoc will search for it in the `templates` subdirectory of
487 the user data directory (see `--data-dir`). If this option is not used,
488 a default template appropriate for the output format will be used (see
489 `-D/--print-default-template`).
491`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
493: Set the template variable *KEY* to the value *VAL* when rendering the
494 document in standalone mode. This is generally only useful when the
495 `--template` option is used to specify a custom template, since
496 pandoc automatically sets the variables used in the default
497 templates. If no *VAL* is specified, the key will be given the
500`-D` *FORMAT*, `--print-default-template=`*FORMAT*
502: Print the system default template for an output *FORMAT*. (See `-t`
503 for a list of possible *FORMAT*s.) Templates in the user data
504 directory are ignored.
506`--print-default-data-file=`*FILE*
508: Print a system default data file. Files in the user data directory
512: Specify the dpi (dots per inch) value for conversion from pixels
513 to inch/centimeters and vice versa. The default is 96dpi.
514 Technically, the correct term would be ppi (pixels per inch).
516`--wrap=[auto|none|preserve]`
518: Determine how text is wrapped in the output (the source
519 code, not the rendered version). With `auto` (the default),
520 pandoc will attempt to wrap lines to the column width specified by
521 `--columns` (default 80). With `none`, pandoc will not wrap
522 lines at all. With `preserve`, pandoc will attempt to
523 preserve the wrapping from the source document (that is,
524 where there are nonsemantic newlines in the source, there
525 will be nonsemantic newlines in the output as well).
529: Deprecated synonym for `--wrap=none`.
533: Specify length of lines in characters (for text wrapping).
534 This affects only the generated source code, not the layout on
537`--toc`, `--table-of-contents`
539: Include an automatically generated table of contents (or, in
540 the case of `latex`, `context`, and `rst`, an instruction to create
541 one) in the output document. This option has no effect on `man`,
542 `docbook`, `slidy`, `slideous`, `s5`, `docx`, or `odt` output.
544`--toc-depth=`*NUMBER*
546: Specify the number of section levels to include in the table
547 of contents. The default is 3 (which means that level 1, 2, and 3
548 headers will be listed in the contents).
552: Disables syntax highlighting for code blocks and inlines, even when
553 a language attribute is given.
555`--highlight-style=`*STYLE*
557: Specifies the coloring style to be used in highlighted source code.
558 Options are `pygments` (the default), `kate`, `monochrome`,
559 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
560 on syntax highlighting in pandoc, see [Syntax highlighting], below.
562`-H` *FILE*, `--include-in-header=`*FILE*
564: Include contents of *FILE*, verbatim, at the end of the header.
565 This can be used, for example, to include special
566 CSS or javascript in HTML documents. This option can be used
567 repeatedly to include multiple files in the header. They will be
568 included in the order specified. Implies `--standalone`.
570`-B` *FILE*, `--include-before-body=`*FILE*
572: Include contents of *FILE*, verbatim, at the beginning of the
573 document body (e.g. after the `<body>` tag in HTML, or the
574 `\begin{document}` command in LaTeX). This can be used to include
575 navigation bars or banners in HTML documents. This option can be
576 used repeatedly to include multiple files. They will be included in
577 the order specified. Implies `--standalone`.
579`-A` *FILE*, `--include-after-body=`*FILE*
581: Include contents of *FILE*, verbatim, at the end of the document
582 body (before the `</body>` tag in HTML, or the
583 `\end{document}` command in LaTeX). This option can be be used
584 repeatedly to include multiple files. They will be included in the
585 order specified. Implies `--standalone`.
587Options affecting specific writers
588----------------------------------
592: Produce a standalone HTML file with no external dependencies, using
593 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
594 images, and videos. The resulting file should be "self-contained,"
595 in the sense that it needs no external files and no net access to be
596 displayed properly by a browser. This option works only with HTML output
597 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
598 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
599 stylesheets at absolute URLs will be downloaded; those at relative URLs
600 will be sought relative to the working directory (if the first source
601 file is local) or relative to the base URL (if the first source
602 file is remote). Limitation: resources that are loaded dynamically
603 through JavaScript cannot be incorporated; as a result, `--self-contained`
604 does not work with `--mathjax`, and some advanced features (e.g.
605 zoom or speaker notes) may not work in an offline "self-contained"
606 `reveal.js` slide show.
610: Use `<q>` tags for quotes in HTML.
614: Use only ascii characters in output. Currently supported only
615 for HTML output (which uses numerical entities instead of
616 UTF-8 when this option is selected).
620: Use reference-style links, rather than inline links, in writing Markdown
621 or reStructuredText. By default inline links are used.
625: Use ATX-style headers in Markdown and asciidoc output. The default is
626 to use setext-style headers for levels 1-2, and then ATX headers.
630: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
631 output. When the LaTeX document class is set to `report`, `book`, or
632 `memoir`, this option is implied. If `beamer` is the output
633 format, top-level headers will become `\part{..}`.
635`-N`, `--number-sections`
637: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
638 By default, sections are not numbered. Sections with class
639 `unnumbered` will never be numbered, even if `--number-sections`
642`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
644: Offset for section headings in HTML output (ignored in other
645 output formats). The first number is added to the section number for
646 top-level headers, the second for second-level headers, and so on.
647 So, for example, if you want the first top-level header in your
648 document to be numbered "6", specify `--number-offset=5`.
649 If your document starts with a level-2 header which you want to
650 be numbered "1.5", specify `--number-offset=1,4`.
651 Offsets are 0 by default. Implies `--number-sections`.
655: Do not use the TeX ligatures for quotation marks, apostrophes,
656 and dashes (`` `...' ``, ` ``..'' `, `--`, `---`) when
657 writing or reading LaTeX or ConTeXt. In reading LaTeX,
658 parse the characters `` ` ``, `'`, and `-` literally, rather
659 than parsing ligatures for quotation marks and dashes. In
660 writing LaTeX or ConTeXt, print unicode quotation mark and
661 dash characters literally, rather than converting them to
662 the standard ASCII TeX ligatures. Note: normally `--smart`
663 is selected automatically for LaTeX and ConTeXt output, but
664 it must be specified explicitly if `--no-tex-ligatures` is
665 selected. If you use literal curly quotes, dashes, and
666 ellipses in your source, then you may want to use
667 `--no-tex-ligatures` without `--smart`.
671: Use the [`listings`] package for LaTeX code blocks
675: Make list items in slide shows display incrementally (one by one).
676 The default is for lists to be displayed all at once.
678`--slide-level=`*NUMBER*
680: Specifies that headers with the specified level create
681 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
682 above this level in the hierarchy are used to divide the
683 slide show into sections; headers below this level create
684 subheads within a slide. The default is to set the slide level
685 based on the contents of the document; see
686 [Structuring the slide show].
690: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
691 and attach identifiers to the enclosing `<div>` (or `<section>`)
692 rather than the header itself. See
693 [Header identifiers], below.
695`--email-obfuscation=none`|`javascript`|`references`
697: Specify a method for obfuscating `mailto:` links in HTML documents.
698 `none` leaves `mailto:` links as they are. `javascript` obfuscates
699 them using javascript. `references` obfuscates them by printing their
700 letters as decimal or hexadecimal character references. The default
703`--id-prefix=`*STRING*
705: Specify a prefix to be added to all automatically generated identifiers
706 in HTML and DocBook output, and to footnote numbers in Markdown output.
707 This is useful for preventing duplicate identifiers when generating
708 fragments to be included in other pages.
710`-T` *STRING*, `--title-prefix=`*STRING*
712: Specify *STRING* as a prefix at the beginning of the title
713 that appears in the HTML header (but not in the title as it
714 appears at the beginning of the HTML body). Implies
717`-c` *URL*, `--css=`*URL*
719: Link to a CSS style sheet. This option can be be used repeatedly to
720 include multiple files. They will be included in the order specified.
722`--reference-odt=`*FILE*
724: Use the specified file as a style reference in producing an ODT.
725 For best results, the reference ODT should be a modified version
726 of an ODT produced using pandoc. The contents of the reference ODT
727 are ignored, but its stylesheets are used in the new ODT. If no
728 reference ODT is specified on the command line, pandoc will look
729 for a file `reference.odt` in the user data directory (see
730 `--data-dir`). If this is not found either, sensible defaults will be
733`--reference-docx=`*FILE*
735: Use the specified file as a style reference in producing a docx file.
736 For best results, the reference docx should be a modified version
737 of a docx file produced using pandoc. The contents of the reference docx
738 are ignored, but its stylesheets and document properties (including
739 margins, page size, header, and footer) are used in the new docx. If no
740 reference docx is specified on the command line, pandoc will look
741 for a file `reference.docx` in the user data directory (see
742 `--data-dir`). If this is not found either, sensible defaults will be
743 used. The following styles are used by pandoc: [paragraph]
744 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
745 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
746 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
747 Definition, Caption, Table Caption, Image Caption, Figure,
748 Figure With Caption, TOC Heading;
749 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
750 Footnote Reference, Hyperlink; [table] Normal Table.
752`--epub-stylesheet=`*FILE*
754: Use the specified CSS file to style the EPUB. If no stylesheet
755 is specified, pandoc will look for a file `epub.css` in the
756 user data directory (see `--data-dir`). If it is not
757 found there, sensible defaults will be used.
759`--epub-cover-image=`*FILE*
761: Use the specified image as the EPUB cover. It is recommended
762 that the image be less than 1000px in width and height. Note that
763 in a Markdown source document you can also specify `cover-image`
764 in a YAML metadata block (see [EPUB Metadata], below).
766`--epub-metadata=`*FILE*
768: Look in the specified XML file for metadata for the EPUB.
769 The file should contain a series of [Dublin Core elements].
772 <dc:rights>Creative Commons</dc:rights>
773 <dc:language>es-AR</dc:language>
775 By default, pandoc will include the following metadata elements:
776 `<dc:title>` (from the document title), `<dc:creator>` (from the
777 document authors), `<dc:date>` (from the document date, which should
778 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
779 variable, or, if is not set, the locale), and `<dc:identifier
780 id="BookId">` (a randomly generated UUID). Any of these may be
781 overridden by elements in the metadata file.
783 Note: if the source document is Markdown, a YAML metadata block
784 in the document can be used instead. See below under
787`--epub-embed-font=`*FILE*
789: Embed the specified font in the EPUB. This option can be repeated
790 to embed multiple fonts. Wildcards can also be used: for example,
791 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
792 line, be sure to escape them or put the whole filename in single quotes,
793 to prevent them from being interpreted by the shell. To use the
794 embedded fonts, you will need to add declarations like the following
795 to your CSS (see `--epub-stylesheet`):
798 font-family: DejaVuSans;
801 src:url("DejaVuSans-Regular.ttf");
804 font-family: DejaVuSans;
807 src:url("DejaVuSans-Bold.ttf");
810 font-family: DejaVuSans;
813 src:url("DejaVuSans-Oblique.ttf");
816 font-family: DejaVuSans;
819 src:url("DejaVuSans-BoldOblique.ttf");
821 body { font-family: "DejaVuSans"; }
823`--epub-chapter-level=`*NUMBER*
825: Specify the header level at which to split the EPUB into separate
826 "chapter" files. The default is to split into chapters at level 1
827 headers. This option only affects the internal composition of the
828 EPUB, not the way chapters and sections are displayed to users. Some
829 readers may be slow if the chapter files are too large, so for large
830 documents with few level 1 headers, one might want to use a chapter
833`--latex-engine=pdflatex`|`lualatex`|`xelatex`
835: Use the specified LaTeX engine when producing PDF output.
836 The default is `pdflatex`. If the engine is not in your PATH,
837 the full path of the engine may be specified here.
839`--latex-engine-opt=`*STRING*
841: Use the given string as a command-line argument to the `latex-engine`.
842 If used multiple times, the arguments are provided with spaces between
843 them. Note that no check for duplicate options is done.
845[Dublin Core elements]: http://dublincore.org/documents/dces/
846[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
851`--bibliography=`*FILE*
853: Set the `bibliography` field in the document's metadata to *FILE*,
854 overriding any value set in the metadata, and process citations
855 using `pandoc-citeproc`. (This is equivalent to
856 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
857 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
858 used, making this equivalent to `--metadata bibliography=FILE`.
859 If you supply this argument multiple times, each *FILE* will be added
864: Set the `csl` field in the document's metadata to *FILE*,
865 overriding any value set in the metadata. (This is equivalent to
866 `--metadata csl=FILE`.)
867 This option is only relevant with `pandoc-citeproc`.
869`--citation-abbreviations=`*FILE*
871: Set the `citation-abbreviations` field in the document's metadata to
872 *FILE*, overriding any value set in the metadata. (This is equivalent to
873 `--metadata citation-abbreviations=FILE`.)
874 This option is only relevant with `pandoc-citeproc`.
878: Use [`natbib`] for citations in LaTeX output. This option is not for use
879 with the `pandoc-citeproc` filter or with PDF output. It is intended for
880 use in producing a LaTeX file that can be processed with [`bibtex`].
884: Use [`biblatex`] for citations in LaTeX output. This option is not for use
885 with the `pandoc-citeproc` filter or with PDF output. It is intended for
886 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
888Math rendering in HTML
889----------------------
891`-m` [*URL*], `--latexmathml`[`=`*URL*]
893: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
894 To insert a link to a local copy of the `LaTeXMathML.js` script,
895 provide a *URL*. If no *URL* is provided, the contents of the
896 script will be inserted directly into the HTML header, preserving
897 portability at the price of efficiency. If you plan to use math on
898 several pages, it is much better to link to a copy of the script,
903: Convert TeX math to [MathML] (in `docbook` as well as `html` and `html5`).
904 In standalone `html` output, a small javascript (or a link to such a
905 script if a *URL* is supplied) will be inserted that allows the MathML to
906 be viewed on some browsers.
910: Use [jsMath] to display embedded TeX math in HTML output.
911 The *URL* should point to the jsMath load script (e.g.
912 `jsMath/easy/load.js`); if provided, it will be linked to in
913 the header of standalone HTML documents. If a *URL* is not provided,
914 no link to the jsMath load script will be inserted; it is then
915 up to the author to provide such a link in the HTML template.
919: Use [MathJax] to display embedded TeX math in HTML output.
920 The *URL* should point to the `MathJax.js` load script.
921 If a *URL* is not provided, a link to the MathJax CDN will
926: Enclose TeX math in `<eq>` tags in HTML output. These can then
927 be processed by [gladTeX] to produce links to images of the typeset
932: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
933 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
937: Render TeX formulas using an external script that converts TeX
938 formulas to images. The formula will be concatenated with the URL
939 provided. If *URL* is not specified, the Google Chart API will be used.
943: Use [KaTeX] to display embedded TeX math in HTML output.
944 The *URL* should point to the `katex.js` load script. If a *URL* is
945 not provided, a link to the KaTeX CDN will be inserted.
947`--katex-stylesheet=`*URL*
949: The *URL* should point to the `katex.css` stylesheet. If this option is
950 not specified, a link to the KaTeX CDN will be inserted. Note that this
951 option does not imply `--katex`.
953[MathML]: http://www.w3.org/Math/
954[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
955[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
956[MathJax]: https://www.mathjax.org
957[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
958[mimeTeX]: http://www.forkosh.com/mimetex.html
959[KaTeX]: https://github.com/Khan/KaTeX
961Options for wrapper scripts
962---------------------------
966: Print information about command-line arguments to *stdout*, then exit.
967 This option is intended primarily for use in wrapper scripts.
968 The first line of output contains the name of the output file specified
969 with the `-o` option, or `-` (for *stdout*) if no output file was
970 specified. The remaining lines contain the command-line arguments,
971 one per line, in the order they appear. These do not include regular
972 pandoc options and their arguments, but do include any options appearing
973 after a `--` separator at the end of the line.
977: Ignore command-line arguments (for use in wrapper scripts).
978 Regular pandoc options are not ignored. Thus, for example,
980 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
984 pandoc -o foo.html -s
989When the `-s/--standalone` option is used, pandoc uses a template to
990add header and footer material that is needed for a self-standing
991document. To see the default template that is used, just type
995where *FORMAT* is the name of the output format. A custom template
996can be specified using the `--template` option. You can also override
997the system default templates for a given output format *FORMAT*
998by putting a file `templates/default.*FORMAT*` in the user data
999directory (see `--data-dir`, above). *Exceptions:* For `odt` output,
1000customize the `default.opendocument` template. For `pdf` output,
1001customize the `default.latex` template.
1003Templates contain *variables*, which allow for the inclusion of
1004arbitrary information at any point in the file. Variables may be set
1005within the document using [YAML metadata blocks][Extension:
1006`yaml_metadata_block`]. They may also be set at the
1007command line using the `-V/--variable` option: variables set in this
1008way override metadata fields with the same name.
1010Variables set by pandoc
1011-----------------------
1013Some variables are set automatically by pandoc. These vary somewhat
1014depending on the output format, but include metadata fields as well
1017`title`, `author`, `date`
1018: allow identification of basic aspects of the document. Included
1019 in PDF metadata through LaTeX and ConTeXt. These can be set
1020 through a [pandoc title block][Extension: `pandoc_title_block`],
1021 which allows for multiple authors, or through a YAML metadata block:
1030: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1031 renders in LaTeX only when using a document class that supports
1032 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1033 `scrreprt`, `scrbook`).[^subtitle]
1036: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1039: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1040 may be repeated as for `author`, above
1043: contents specified by `-H/--include-in-header` (may have multiple
1047: non-null value if `--toc/--table-of-contents` was specified
1050: title of table of contents (works only with EPUB and docx)
1053: contents specified by `-B/--include-before-body` (may have
1057: contents specified by `-A/--include-after-body` (may have
1064: JSON representation of all of the document's metadata
1066[^subtitle]: To make `subtitle` work with other LaTeX
1067 document classes, you can add the following to `header-includes`:
1069 \providecommand{\subtitle}[1]{%
1070 \usepackage{titling}
1072 \par\large#1\end{center}}
1079: identifies the main language of the document,
1080 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1081 For some output formats, pandoc will convert it to an appropriate
1082 format stored in the additional variables `babel-lang`,
1083 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1085 Native pandoc `span`s and `div`s with the lang attribute
1086 (value in BCP 47) can be used to switch the language in
1090: a list of other languages used in the document
1091 in the YAML metadata, according to [BCP 47]. For example:
1092 `otherlangs: [en-GB, fr]`.
1093 This is automatically generated from the `lang` attributes
1094 in all `span`s and `div`s but can be overriden.
1095 Currently only used by LaTeX through the generated
1096 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1097 The LaTeX writer outputs polyglossia commands in the text but
1098 the `babel-newcommands` variable contains mappings for them
1099 to the corresponding babel.
1102: the base direction of the document, either `rtl` (right-to-left)
1103 or `ltr` (left-to-right).
1105 For bidirectional documents, native pandoc `span`s and `div`s
1106 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1107 override the base direction in some output formats.
1108 This may not always be necessary if the final renderer
1109 (e.g. the browser, when generating HTML) supports the
1110 [Unicode Bidirectional Algorithm].
1112 When using LaTeX for bidirectional documents, only the `xelatex` engine
1113 is fully supported (use `--latex-engine=xelatex`).
1115[BCP 47]: https://tools.ietf.org/html/bcp47
1116[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1121Variables are available for [producing slide shows with pandoc],
1122including all [reveal.js configuration options].
1125: base URL for Slidy documents (defaults to
1126 `http://www.w3.org/Talks/Tools/Slidy2`)
1129: base URL for Slideous documents (defaults to `slideous`)
1132: base URL for S5 documents (defaults to `s5/default`)
1135: base URL for reveal.js documents (defaults to `reveal.js`)
1137`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1138: themes for LaTeX [`beamer`] documents
1141: controls navigation symbols in `beamer` documents
1142 (default is `empty` for no navigation symbols; other valid values
1143 are `frame`, `vertical`, and `horizontal`).
1146: enables on "title pages" for new sections in `beamer`
1147 documents (default = true).
1149[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1154LaTeX variables are used when [creating a PDF].
1157: paper size, e.g. `letter`, `A4`
1160: font size for body text (e.g. `10pt`, `12pt`)
1163: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1166: option for document class, e.g. `oneside`; may be repeated
1167 for multiple options
1170: option for [`geometry`] package, e.g. `margin=1in`;
1171 may be repeated for multiple options
1173`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1174: sets margins, if `geometry` is not used (otherwise `geometry`
1178: adjusts line spacing using the [`setspace`]
1179 package, e.g. `1.25`, `1.5`
1182: font package for use with `pdflatex`:
1183 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1184 The default is [Latin Modern][`lm`].
1187: options for package used as `fontfamily`: e.g. `osf,sc` with
1188 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1189 figures and true small caps; may be repeated for multiple options
1191`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1192: font families for use with `xelatex` or
1193 `lualatex`: take the name of any system font, using the
1194 [`fontspec`] package. Note that if `CJKmainfont` is used,
1195 the [`xecjk`] package must be available.
1197`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1198: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1199 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1200 available through [`fontspec`], such as the OpenType features
1201 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1204: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1205 default is `T1` (see guide to [LaTeX font encodings])
1208: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1209 `urlcolor`, or `toccolor` are set
1211`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1212: color for internal links, citation links, external links, and links in table of contents:
1213 uses any of the [predefined LaTeX colors]
1216: causes links to be printed as footnotes
1219: uses document class settings for indentation (the default LaTeX template
1220 otherwise removes indentation and adds space between paragraphs)
1223: disables default behavior of LaTeX template that redefines (sub)paragraphs
1224 as sections, changing the appearance of nested headings in some classes
1227: specifies contents of acknowledgments footnote after document title.
1230: include table of contents (can also be set using `--toc/--table-of-contents`)
1233: level of section to include in table of contents
1236: include list of figures, list of tables
1239: bibliography to use for resolving references
1242: bibliography style, when used with `--natbib` and
1246: list of options for biblatex.
1248[`article`]: https://ctan.org/pkg/article
1249[`report`]: https://ctan.org/pkg/report
1250[`book`]: https://ctan.org/pkg/book
1251[KOMA-Script]: https://ctan.org/pkg/koma-script
1252[`memoir`]: https://ctan.org/pkg/memoir
1253[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1254[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1255[`mathpazo`]: https://ctan.org/pkg/mathpazo
1256[LaTeX font encodings]: https://ctan.org/pkg/encguide
1258Variables for ConTeXt
1259---------------------
1262: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1263 may be repeated for multiple options
1266: options for page margins and text arrangement (see [ConTeXt Layout]);
1267 may be repeated for multiple options
1269`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1270: sets margins, if `layout` is not used (otherwise `layout`
1274: font size for body text (e.g. `10pt`, `12pt`)
1276`mainfont`, `sansfont`, `monofont`, `mathfont`
1277: font families: take the name of any system font (see [ConTeXt Font Switching])
1279`linkcolor`, `contrastcolor`
1280: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1283: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1286: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1287 may be repeated for multiple options
1290: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1293: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1294 may be repeated for multiple options
1296`headertext`, `footertext`
1297: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1298 may be repeated up to four times for different placement
1301: page number style and location (using [`setuppagenumbering`]);
1302 may be repeated for multiple options
1305: include table of contents (can also be set using `--toc/--table-of-contents`)
1308: include list of figures, list of tables
1310[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1311[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1312[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1313[ConTeXt Color]: http://wiki.contextgarden.net/Color
1314[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1315[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1316[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1317[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1318[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1320Variables for man pages
1321-----------------------
1324: section number in man pages
1327: header in man pages
1330: footer in man pages
1333: adjusts text to left (`l`), right (`r`), center (`c`),
1334 or both (`b`) margins
1337: if `true` (the default), hyphenation will be used
1339Using variables in templates
1340----------------------------
1342Variable names are sequences of alphanumerics, `-`, and `_`,
1343starting with a letter. A variable name surrounded by `$` signs
1344will be replaced by its value. For example, the string `$title$` in
1346 <title>$title$</title>
1348will be replaced by the document title.
1350To write a literal `$` in a template, use `$$`.
1352Templates may contain conditionals. The syntax is as follows:
1360This will include `X` in the template if `variable` has a non-null
1361value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1362any valid template text, and may include interpolated variables or other
1363conditionals. The `$else$` section may be omitted.
1365When variables can have multiple values (for example, `author` in
1366a multi-author document), you can use the `$for$` keyword:
1369 <meta name="author" content="$author$" />
1372You can optionally specify a separator to be used between
1375 $for(author)$$author$$sep$, $endfor$
1377A dot can be used to select a field of a variable that takes
1378an object as its value. So, for example:
1380 $author.name$ ($author.affiliation$)
1382If you use custom templates, you may need to revise them as pandoc
1383changes. We recommend tracking the changes in the default templates,
1384and modifying your custom templates accordingly. An easy way to do this
1385is to fork the [pandoc-templates] repository and merge in changes after each
1388[pandoc-templates]: https://github.com/jgm/pandoc-templates
1393Pandoc understands an extended and slightly revised version of
1394John Gruber's [Markdown] syntax. This document explains the syntax,
1395noting differences from standard Markdown. Except where noted, these
1396differences can be suppressed by using the `markdown_strict` format instead
1397of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1398to the format name and disabled by adding `-EXTENSION`. For example,
1399`markdown_strict+footnotes` is strict Markdown with footnotes
1400enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1401Markdown without footnotes or pipe tables.
1406Markdown is designed to be easy to write, and, even more importantly,
1409> A Markdown-formatted document should be publishable as-is, as plain
1410> text, without looking like it's been marked up with tags or formatting
1412> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1414This principle has guided pandoc's decisions in finding syntax for
1415tables, footnotes, and other extensions.
1417There is, however, one respect in which pandoc's aims are different
1418from the original aims of Markdown. Whereas Markdown was originally
1419designed with HTML generation in mind, pandoc is designed for multiple
1420output formats. Thus, while pandoc allows the embedding of raw HTML,
1421it discourages it, and provides other, non-HTMLish ways of representing
1422important document elements like definition lists, tables, mathematics, and
1428A paragraph is one or more lines of text followed by one or more blank lines.
1429Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1430If you need a hard line break, put two or more spaces at the end of a line.
1432#### Extension: `escaped_line_breaks` ####
1434A backslash followed by a newline is also a hard line break.
1435Note: in multiline and grid table cells, this is the only way
1436to create a hard line break, since trailing spaces in the cells
1442There are two kinds of headers: Setext and ATX.
1444### Setext-style headers ###
1446A setext-style header is a line of text "underlined" with a row of `=` signs
1447(for a level one header) or `-` signs (for a level two header):
1455The header text can contain inline formatting, such as emphasis (see
1456[Inline formatting], below).
1459### ATX-style headers ###
1461An ATX-style header consists of one to six `#` signs and a line of
1462text, optionally followed by any number of `#` signs. The number of
1463`#` signs at the beginning of the line is the header level:
1465 ## A level-two header
1467 ### A level-three header ###
1469As with setext-style headers, the header text can contain formatting:
1471 # A level-one header with a [link](/url) and *emphasis*
1473#### Extension: `blank_before_header` ####
1475Standard Markdown syntax does not require a blank line before a header.
1476Pandoc does require this (except, of course, at the beginning of the
1477document). The reason for the requirement is that it is all too easy for a
1478`#` to end up at the beginning of a line by accident (perhaps through line
1479wrapping). Consider, for example:
1481 I like several of their flavors of ice cream:
1482 #22, for example, and #5.
1485### Header identifiers ###
1487#### Extension: `header_attributes` ####
1489Headers can be assigned attributes using this syntax at the end
1490of the line containing the header text:
1492 {#identifier .class .class key=value key=value}
1494Thus, for example, the following headers will all be assigned the identifier
1499 ## My header ## {#foo}
1501 My other header {#foo}
1504(This syntax is compatible with [PHP Markdown Extra].)
1506Note that although this syntax allows assignment of classes and key/value
1507attributes, writers generally don't use all of this information. Identifiers,
1508classes, and key/value attributes are used in HTML and HTML-based formats such
1509as EPUB and slidy. Identifiers are used for labels and link anchors in the
1510LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1512Headers with the class `unnumbered` will not be numbered, even if
1513`--number-sections` is specified. A single hyphen (`-`) in an attribute
1514context is equivalent to `.unnumbered`, and preferable in non-English
1521 # My header {.unnumbered}
1523#### Extension: `auto_identifiers` ####
1525A header without an explicitly specified identifier will be
1526automatically assigned a unique identifier based on the header text.
1527To derive the identifier from the header text,
1529 - Remove all formatting, links, etc.
1530 - Remove all footnotes.
1531 - Remove all punctuation, except underscores, hyphens, and periods.
1532 - Replace all spaces and newlines with hyphens.
1533 - Convert all alphabetic characters to lowercase.
1534 - Remove everything up to the first letter (identifiers may
1535 not begin with a number or punctuation mark).
1536 - If nothing is left after this, use the identifier `section`.
1541 ------------------------------- ----------------------------
1542 `Header identifiers in HTML` `header-identifiers-in-html`
1543 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1544 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1545 `3. Applications` `applications`
1548These rules should, in most cases, allow one to determine the identifier
1549from the header text. The exception is when several headers have the
1550same text; in this case, the first will get an identifier as described
1551above; the second will get the same identifier with `-1` appended; the
1552third with `-2`; and so on.
1554These identifiers are used to provide link targets in the table of
1555contents generated by the `--toc|--table-of-contents` option. They
1556also make it easy to provide links from one section of a document to
1557another. A link to this section, for example, might look like this:
1560 [header identifiers](#header-identifiers-in-html-latex-and-context).
1562Note, however, that this method of providing links to sections works
1563only in HTML, LaTeX, and ConTeXt formats.
1565If the `--section-divs` option is specified, then each section will
1566be wrapped in a `div` (or a `section`, if `--html5` was specified),
1567and the identifier will be attached to the enclosing `<div>`
1568(or `<section>`) tag rather than the header itself. This allows entire
1569sections to be manipulated using javascript or treated differently in
1572#### Extension: `implicit_header_references` ####
1574Pandoc behaves as if reference links have been defined for each header.
1577 [header identifiers](#header-identifiers-in-html)
1581 [header identifiers]
1585 [header identifiers][]
1589 [the section on header identifiers][header identifiers]
1591If there are multiple headers with identical text, the corresponding
1592reference will link to the first one only, and you will need to use explicit
1593links to link to the others, as described above.
1595Like regular reference links, these references are case-insensitive.
1597Explicit link reference definitions always take priority over
1598implicit header references. So, in the following example, the
1599link will point to `bar`, not to `#foo`:
1610Markdown uses email conventions for quoting blocks of text.
1611A block quotation is one or more paragraphs or other block elements
1612(such as lists or headers), with each line preceded by a `>` character
1613and an optional space. (The `>` need not start at the left margin, but
1614it should not be indented more than three spaces.)
1616 > This is a block quote. This
1617 > paragraph has two lines.
1619 > 1. This is a list inside a block quote.
1622A "lazy" form, which requires the `>` character only on the first
1623line of each block, is also allowed:
1625 > This is a block quote. This
1626 paragraph has two lines.
1628 > 1. This is a list inside a block quote.
1631Among the block elements that can be contained in a block quote are
1632other block quotes. That is, block quotes can be nested:
1634 > This is a block quote.
1636 > > A block quote within a block quote.
1638If the `>` character is followed by an optional space, that space
1639will be considered part of the block quote marker and not part of
1640the indentation of the contents. Thus, to put an indented code
1641block in a block quote, you need five spaces after the `>`:
1645#### Extension: `blank_before_blockquote` ####
1647Standard Markdown syntax does not require a blank line before a block
1648quote. Pandoc does require this (except, of course, at the beginning of the
1649document). The reason for the requirement is that it is all too easy for a
1650`>` to end up at the beginning of a line by accident (perhaps through line
1651wrapping). So, unless the `markdown_strict` format is used, the following does
1652not produce a nested block quote in pandoc:
1654 > This is a block quote.
1658Verbatim (code) blocks
1659----------------------
1661### Indented code blocks ###
1663A block of text indented four spaces (or one tab) is treated as verbatim
1664text: that is, special characters do not trigger special formatting,
1665and all spaces and line breaks are preserved. For example,
1668 moveShip(5 * gravity, DOWN);
1671The initial (four space or one tab) indentation is not considered part
1672of the verbatim text, and is removed in the output.
1674Note: blank lines in the verbatim text need not begin with four spaces.
1677### Fenced code blocks ###
1679#### Extension: `fenced_code_blocks` ####
1681In addition to standard indented code blocks, pandoc supports
1682*fenced* code blocks. These begin with a row of three or more
1683tildes (`~`) and end with a row of tildes that must be at least as long as
1684the starting row. Everything between these lines is treated as code. No
1685indentation is necessary:
1689 moveShip(5 * gravity, DOWN);
1693Like regular code blocks, fenced code blocks must be separated
1694from surrounding text by blank lines.
1696If the code itself contains a row of tildes or backticks, just use a longer
1697row of tildes or backticks at the start and end:
1701 code including tildes
1705#### Extension: `backtick_code_blocks` ####
1707Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1710#### Extension: `fenced_code_attributes` ####
1712Optionally, you may attach attributes to fenced or backtick code block using
1715 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1717 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1718 qsort (filter (>= x) xs)
1719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1721Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1722`startFrom` is an attribute with value `100`. Some output formats can use this
1723information to do syntax highlighting. Currently, the only output formats
1724that uses this information are HTML and LaTeX. If highlighting is supported
1725for your output format and language, then the code block above will appear
1726highlighted, with numbered lines. (To see which languages are supported, do
1727`pandoc --version`.) Otherwise, the code block above will appear as follows:
1729 <pre id="mycode" class="haskell numberLines" startFrom="100">
1735A shortcut form can also be used for specifying the language of
1742This is equivalent to:
1748If the `fenced_code_attributes` extension is disabled, but
1749input contains class attribute(s) for the codeblock, the first
1750class attribute will be printed after the opening fence as a bare
1753To prevent all highlighting, use the `--no-highlight` flag.
1754To set the highlighting style, use `--highlight-style`.
1755For more information on highlighting, see [Syntax highlighting],
1761#### Extension: `line_blocks` ####
1763A line block is a sequence of lines beginning with a vertical bar (`|`)
1764followed by a space. The division into lines will be preserved in
1765the output, as will any leading spaces; otherwise, the lines will
1766be formatted as Markdown. This is useful for verse and addresses:
1768 | The limerick packs laughs anatomical
1769 | In space that is quite economical.
1770 | But the good ones I've seen
1771 | So seldom are clean
1772 | And the clean ones so seldom are comical
1775 | Berkeley, CA 94718
1777The lines can be hard-wrapped if needed, but the continuation
1778line must begin with a space.
1780 | The Right Honorable Most Venerable and Righteous Samuel L.
1783 | Berkeley, CA 94718
1785This syntax is borrowed from [reStructuredText].
1792A bullet list is a list of bulleted list items. A bulleted list
1793item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1800This will produce a "compact" list. If you want a "loose" list, in which
1801each item is formatted as a paragraph, put spaces between the items:
1809The bullets need not be flush with the left margin; they may be
1810indented one, two, or three spaces. The bullet must be followed
1813List items look best if subsequent lines are flush with the first
1814line (after the bullet):
1820But Markdown also allows a "lazy" format:
1826### The four-space rule ###
1828A list item may contain multiple paragraphs and other block-level
1829content. However, subsequent paragraphs must be preceded by a blank line
1830and indented four spaces or a tab. The list will look better if the first
1831paragraph is aligned with the rest:
1837 * Second paragraph. With a code block, which must be indented
1842List items may include other lists. In this case the preceding blank
1843line is optional. The nested list must be indented four spaces or
1856As noted above, Markdown allows you to write list items "lazily," instead of
1857indenting continuation lines. However, if there are multiple paragraphs or
1858other blocks in a list item, the first line of each must be indented.
1860 + A lazy, lazy, list
1863 + Another one; this looks
1866 Second paragraph of second
1869**Note:** Although the four-space rule for continuation paragraphs
1870comes from the official [Markdown syntax guide], the reference implementation,
1871`Markdown.pl`, does not follow it. So pandoc will give different results than
1872`Markdown.pl` when authors have indented continuation paragraphs fewer than
1875The [Markdown syntax guide] is not explicit whether the four-space
1876rule applies to *all* block-level content in a list item; it only
1877mentions paragraphs and code blocks. But it implies that the rule
1878applies to all block-level content (including nested lists), and
1879pandoc interprets it that way.
1881 [Markdown syntax guide]:
1882 http://daringfireball.net/projects/markdown/syntax#list
1884### Ordered lists ###
1886Ordered lists work just like bulleted lists, except that the items
1887begin with enumerators rather than bullets.
1889In standard Markdown, enumerators are decimal numbers followed
1890by a period and a space. The numbers themselves are ignored, so
1891there is no difference between this list:
1903#### Extension: `fancy_lists` ####
1905Unlike standard Markdown, pandoc allows ordered list items to be marked
1906with uppercase and lowercase letters and roman numerals, in addition to
1907arabic numerals. List markers may be enclosed in parentheses or followed by a
1908single right-parentheses or period. They must be separated from the
1909text that follows by at least one space, and, if the list marker is a
1910capital letter with a period, by at least two spaces.[^2]
1912[^2]: The point of this rule is to ensure that normal paragraphs
1913 starting with people's initials, like
1915 B. Russell was an English philosopher.
1917 do not get treated as list items.
1919 This rule will not prevent
1923 from being interpreted as a list item. In this case, a backslash
1928The `fancy_lists` extension also allows '`#`' to be used as an
1929ordered list marker in place of a numeral:
1934#### Extension: `startnum` ####
1936Pandoc also pays attention to the type of list marker used, and to the
1937starting number, and both of these are preserved where possible in the
1938output format. Thus, the following yields a list with numbers followed
1939by a single parenthesis, starting with 9, and a sublist with lowercase
1949Pandoc will start a new list each time a different type of list
1950marker is used. So, the following will create three lists:
1957If default list markers are desired, use `#.`:
1964### Definition lists ###
1966#### Extension: `definition_lists` ####
1968Pandoc supports definition lists, using the syntax of
1969[PHP Markdown Extra] with some extensions.[^3]
1975 Term 2 with *inline markup*
1979 { some code, part of Definition 2 }
1981 Third paragraph of definition 2.
1983Each term must fit on one line, which may optionally be followed by
1984a blank line, and must be followed by one or more definitions.
1985A definition begins with a colon or tilde, which may be indented one
1988A term may have multiple definitions, and each definition may consist of one or
1989more block elements (paragraph, code block, list, etc.), each indented four
1990spaces or one tab stop. The body of the definition (including the first line,
1991aside from the colon or tilde) should be indented four spaces. However,
1992as with other Markdown lists, you can "lazily" omit indentation except
1993at the beginning of a paragraph or other block element:
1998 with lazy continuation.
2000 Second paragraph of the definition.
2002If you leave space before the definition (as in the example above),
2003the text of the definition will be treated as a paragraph. In some
2004output formats, this will mean greater spacing between term/definition
2005pairs. For a more compact definition list, omit the space before the
2015Note that space between items in a definition list is required.
2016(A variant that loosens this requirement, but disallows "lazy"
2017hard wrapping, can be activated with `compact_definition_lists`: see
2018[Non-pandoc extensions], below.)
2020[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2022### Numbered example lists ###
2024#### Extension: `example_lists` ####
2026The special list marker `@` can be used for sequentially numbered
2027examples. The first list item with a `@` marker will be numbered '1',
2028the next '2', and so on, throughout the document. The numbered examples
2029need not occur in a single list; each new list using `@` will take up
2030where the last stopped. So, for example:
2032 (@) My first example will be numbered (1).
2033 (@) My second example will be numbered (2).
2035 Explanation of examples.
2037 (@) My third example will be numbered (3).
2039Numbered examples can be labeled and referred to elsewhere in the
2042 (@good) This is a good example.
2044 As (@good) illustrates, ...
2046The label can be any string of alphanumeric characters, underscores,
2050### Compact and loose lists ###
2052Pandoc behaves differently from `Markdown.pl` on some "edge
2053cases" involving lists. Consider this source:
2063Pandoc transforms this into a "compact list" (with no `<p>` tags around
2064"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2065"Second" and "Third" (but not "First"), because of the blank space
2066around "Third". Pandoc follows a simple rule: if the text is followed by
2067a blank line, it is treated as a paragraph. Since "Second" is followed
2068by a list, and not a blank line, it isn't treated as a paragraph. The
2069fact that the list is followed by a blank line is irrelevant. (Note:
2070Pandoc works this way even when the `markdown_strict` format is specified. This
2071behavior is consistent with the official Markdown syntax description,
2072even though it is different from that of `Markdown.pl`.)
2075### Ending a list ###
2077What if you want to put an indented code block after a list?
2084Trouble! Here pandoc (like other Markdown implementations) will treat
2085`{ my code block }` as the second paragraph of item two, and not as
2088To "cut off" the list after item two, you can insert some non-indented
2089content, like an HTML comment, which won't produce visible output in
2095 <!-- end of list -->
2099You can use the same trick if you want two consecutive lists instead
2115A line containing a row of three or more `*`, `-`, or `_` characters
2116(optionally separated by spaces) produces a horizontal rule:
2126Four kinds of tables may be used. The first three kinds presuppose the use of
2127a fixed-width font, such as Courier. The fourth kind can be used with
2128proportionally spaced fonts, as it does not require lining up columns.
2130#### Extension: `table_captions` ####
2132A caption may optionally be provided with all 4 kinds of tables (as
2133illustrated in the examples below). A caption is a paragraph beginning
2134with the string `Table:` (or just `:`), which will be stripped off.
2135It may appear either before or after the table.
2137#### Extension: `simple_tables` ####
2139Simple tables look like this:
2141 Right Left Center Default
2142 ------- ------ ---------- -------
2147 Table: Demonstration of simple table syntax.
2149The headers and table rows must each fit on one line. Column
2150alignments are determined by the position of the header text relative
2151to the dashed line below it:[^4]
2153 - If the dashed line is flush with the header text on the right side
2154 but extends beyond it on the left, the column is right-aligned.
2155 - If the dashed line is flush with the header text on the left side
2156 but extends beyond it on the right, the column is left-aligned.
2157 - If the dashed line extends beyond the header text on both sides,
2158 the column is centered.
2159 - If the dashed line is flush with the header text on both sides,
2160 the default alignment is used (in most cases, this will be left).
2162[^4]: This scheme is due to Michel Fortin, who proposed it on the
2163 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2165The table must end with a blank line, or a line of dashes followed by
2168The column headers may be omitted, provided a dashed line is used
2169to end the table. For example:
2171 ------- ------ ---------- -------
2175 ------- ------ ---------- -------
2177When headers are omitted, column alignments are determined on the basis
2178of the first line of the table body. So, in the tables above, the columns
2179would be right, left, center, and right aligned, respectively.
2181#### Extension: `multiline_tables` ####
2183Multiline tables allow headers and table rows to span multiple lines
2184of text (but cells that span multiple columns or rows of the table are
2185not supported). Here is an example:
2187 -------------------------------------------------------------
2188 Centered Default Right Left
2189 Header Aligned Aligned Aligned
2190 ----------- ------- --------------- -------------------------
2191 First row 12.0 Example of a row that
2192 spans multiple lines.
2194 Second row 5.0 Here's another one. Note
2195 the blank line between
2197 -------------------------------------------------------------
2199 Table: Here's the caption. It, too, may span
2202These work like simple tables, but with the following differences:
2204 - They must begin with a row of dashes, before the header text
2205 (unless the headers are omitted).
2206 - They must end with a row of dashes, then a blank line.
2207 - The rows must be separated by blank lines.
2209In multiline tables, the table parser pays attention to the widths of
2210the columns, and the writers try to reproduce these relative widths in
2211the output. So, if you find that one of the columns is too narrow in the
2212output, try widening it in the Markdown source.
2214Headers may be omitted in multiline tables as well as simple tables:
2216 ----------- ------- --------------- -------------------------
2217 First row 12.0 Example of a row that
2218 spans multiple lines.
2220 Second row 5.0 Here's another one. Note
2221 the blank line between
2223 ----------- ------- --------------- -------------------------
2225 : Here's a multiline table without headers.
2227It is possible for a multiline table to have just one row, but the row
2228should be followed by a blank line (and then the row of dashes that ends
2229the table), or the table may be interpreted as a simple table.
2231#### Extension: `grid_tables` ####
2233Grid tables look like this:
2235 : Sample grid table.
2237 +---------------+---------------+--------------------+
2238 | Fruit | Price | Advantages |
2239 +===============+===============+====================+
2240 | Bananas | $1.34 | - built-in wrapper |
2241 | | | - bright color |
2242 +---------------+---------------+--------------------+
2243 | Oranges | $2.10 | - cures scurvy |
2245 +---------------+---------------+--------------------+
2247The row of `=`s separates the header from the table body, and can be
2248omitted for a headerless table. The cells of grid tables may contain
2249arbitrary block elements (multiple paragraphs, code blocks, lists,
2250etc.). Alignments are not supported, nor are cells that span multiple
2251columns or rows. Grid tables can be created easily using [Emacs table mode].
2253[Emacs table mode]: http://table.sourceforge.net/
2255#### Extension: `pipe_tables` ####
2257Pipe tables look like this:
2259 | Right | Left | Default | Center |
2260 |------:|:-----|---------|:------:|
2261 | 12 | 12 | 12 | 12 |
2262 | 123 | 123 | 123 | 123 |
2265 : Demonstration of pipe table syntax.
2267The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2268ending pipe characters are optional, but pipes are required between all
2269columns. The colons indicate column alignment as shown. The header
2270cannot be omitted. To simulate a headerless table, include a header
2273Since the pipes indicate column boundaries, columns need not be vertically
2274aligned, as they are in the above example. So, this is a perfectly
2275legal (though ugly) pipe table:
2283The cells of pipe tables cannot contain block elements like paragraphs
2284and lists, and cannot span multiple lines. If a pipe table contains a
2285row whose printable content is wider than the column width (see
2286`--columns`), then the cell contents will wrap, with the
2287relative cell widths determined by the widths of the separator
2290Note: pandoc also recognizes pipe tables of the following
2291form, as can be produced by Emacs' orgtbl-mode:
2298The difference is that `+` is used instead of `|`. Other orgtbl features
2299are not supported. In particular, to get non-default column alignment,
2300you'll need to add colons as above.
2302[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2307#### Extension: `pandoc_title_block` ####
2309If the file begins with a title block
2312 % author(s) (separated by semicolons)
2315it will be parsed as bibliographic information, not regular text. (It
2316will be used, for example, in the title of standalone LaTeX or HTML
2317output.) The block may contain just a title, a title and an author,
2318or all three elements. If you want to include an author but no
2319title, or a title and a date but no author, you need a blank line:
2328The title may occupy multiple lines, but continuation lines must
2329begin with leading space, thus:
2334If a document has multiple authors, the authors may be put on
2335separate lines with leading space, or separated by semicolons, or
2336both. So, all of the following are equivalent:
2341 % Author One; Author Two
2346The date must fit on one line.
2348All three metadata fields may contain standard inline formatting
2349(italics, links, footnotes, etc.).
2351Title blocks will always be parsed, but they will affect the output only
2352when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2353will appear twice: once in the document head -- this is the title that
2354will appear at the top of the window in a browser -- and once at the
2355beginning of the document body. The title in the document head can have
2356an optional prefix attached (`--title-prefix` or `-T` option). The title
2357in the body appears as an H1 element with class "title", so it can be
2358suppressed or reformatted with CSS. If a title prefix is specified with
2359`-T` and no title block appears in the document, the title prefix will
2360be used by itself as the HTML title.
2362The man page writer extracts a title, man page section number, and
2363other header and footer information from the title line. The title
2364is assumed to be the first word on the title line, which may optionally
2365end with a (single-digit) section number in parentheses. (There should
2366be no space between the title and the parentheses.) Anything after
2367this is assumed to be additional footer and header text. A single pipe
2368character (`|`) should be used to separate the footer text from the header
2373will yield a man page with the title `PANDOC` and section 1.
2375 % PANDOC(1) Pandoc User Manuals
2377will also have "Pandoc User Manuals" in the footer.
2379 % PANDOC(1) Pandoc User Manuals | Version 4.0
2381will also have "Version 4.0" in the header.
2383#### Extension: `yaml_metadata_block` ####
2385A YAML metadata block is a valid YAML object, delimited by a line of three
2386hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2387(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2388document, but if it is not at the beginning, it must be preceded by a blank
2389line. (Note that, because of the way pandoc concatenates input files when
2390several are provided, you may also keep the metadata in a separate YAML file
2391and pass it to pandoc as an argument, along with your Markdown files:
2393 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2395Just be sure that the YAML file begins with `---` and ends with `---` or
2398Metadata will be taken from the fields of the YAML object and added to any
2399existing document metadata. Metadata can contain lists and objects (nested
2400arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2401with names ending in an underscore will be ignored by pandoc. (They may be
2402given a role by external processors.)
2404A document may contain multiple metadata blocks. The metadata fields will
2405be combined through a *left-biased union*: if two metadata blocks attempt
2406to set the same field, the value from the first block will be taken.
2408When pandoc is used with `-t markdown` to create a Markdown document,
2409a YAML metadata block will be produced only if the `-s/--standalone`
2410option is used. All of the metadata will appear in a single block
2411at the beginning of the document.
2413Note that YAML escaping rules must be followed. Thus, for example,
2414if a title contains a colon, it must be quoted. The pipe character
2415(`|`) can be used to begin an indented block that will be interpreted
2416literally, without need for escaping. This form is necessary
2417when the field contains blank lines:
2420 title: 'This is the title: it contains a colon'
2423 affiliation: University of Somewhere
2425 affiliation: University of Nowhere
2426 tags: [nothing, nothingness]
2428 This is the abstract.
2430 It consists of two paragraphs.
2433Template variables will be set automatically from the metadata. Thus, for
2434example, in writing HTML, the variable `abstract` will be set to the HTML
2435equivalent of the Markdown in the `abstract` field:
2437 <p>This is the abstract.</p>
2438 <p>It consists of two paragraphs.</p>
2440Note: The `author` variable in the default templates expects a simple list or
2441string. To use the structured authors in the example, you would need a
2442custom template. For example:
2446 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2456#### Extension: `all_symbols_escapable` ####
2458Except inside a code block or inline code, any punctuation or space
2459character preceded by a backslash will be treated literally, even if it
2460would normally indicate formatting. Thus, for example, if one writes
2470 <strong>hello</strong>
2472This rule is easier to remember than standard Markdown's rule,
2473which allows only the following characters to be backslash-escaped:
2477(However, if the `markdown_strict` format is used, the standard Markdown rule
2480A backslash-escaped space is parsed as a nonbreaking space. It will
2481appear in TeX output as `~` and in HTML and XML as `\ ` or
2484A backslash-escaped newline (i.e. a backslash occurring at the end of
2485a line) is parsed as a hard line break. It will appear in TeX output as
2486`\\` and in HTML as `<br />`. This is a nice alternative to
2487Markdown's "invisible" way of indicating hard line breaks using
2488two trailing spaces on a line.
2490Backslash escapes do not work in verbatim contexts.
2497If the `--smart` option is specified, pandoc will produce typographically
2498correct output, converting straight quotes to curly quotes, `---` to
2499em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2500are inserted after certain abbreviations, such as "Mr."
2502Note: if your LaTeX template or any included header file call for the
2503[`csquotes`] package, pandoc will detect this automatically and use
2504`\enquote{...}` for quoted text.
2511To *emphasize* some text, surround it with `*`s or `_`, like this:
2513 This text is _emphasized with underscores_, and this
2514 is *emphasized with asterisks*.
2516Double `*` or `_` produces **strong emphasis**:
2518 This is **strong emphasis** and __with underscores__.
2520A `*` or `_` character surrounded by spaces, or backslash-escaped,
2521will not trigger emphasis:
2523 This is * not emphasized *, and \*neither is this\*.
2525#### Extension: `intraword_underscores` ####
2527Because `_` is sometimes used inside words and identifiers,
2528pandoc does not interpret a `_` surrounded by alphanumeric
2529characters as an emphasis marker. If you want to emphasize
2530just part of a word, use `*`:
2532 feas*ible*, not feas*able*.
2537#### Extension: `strikeout` ####
2539To strikeout a section of text with a horizontal line, begin and end it
2540with `~~`. Thus, for example,
2542 This ~~is deleted text.~~
2545### Superscripts and subscripts ###
2547#### Extension: `superscript`, `subscript` ####
2549Superscripts may be written by surrounding the superscripted text by `^`
2550characters; subscripts may be written by surrounding the subscripted
2551text by `~` characters. Thus, for example,
2553 H~2~O is a liquid. 2^10^ is 1024.
2555If the superscripted or subscripted text contains spaces, these spaces
2556must be escaped with backslashes. (This is to prevent accidental
2557superscripting and subscripting through the ordinary use of `~` and `^`.)
2558Thus, if you want the letter P with 'a cat' in subscripts, use
2559`P~a\ cat~`, not `P~a cat~`.
2564To make a short span of text verbatim, put it inside backticks:
2566 What is the difference between `>>=` and `>>`?
2568If the verbatim text includes a backtick, use double backticks:
2570 Here is a literal backtick `` ` ``.
2572(The spaces after the opening backticks and before the closing
2573backticks will be ignored.)
2575The general rule is that a verbatim span starts with a string
2576of consecutive backticks (optionally followed by a space)
2577and ends with a string of the same number of backticks (optionally
2578preceded by a space).
2580Note that backslash-escapes (and other Markdown constructs) do not
2581work in verbatim contexts:
2583 This is a backslash followed by an asterisk: `\*`.
2585#### Extension: `inline_code_attributes` ####
2587Attributes can be attached to verbatim text, just as with
2588[fenced code blocks]:
2594To write small caps, you can use an HTML span tag:
2596 <span style="font-variant:small-caps;">Small caps</span>
2598(The semicolon is optional and there may be space after the
2599colon.) This will work in all output formats that support small caps.
2604#### Extension: `tex_math_dollars` ####
2606Anything between two `$` characters will be treated as TeX math. The
2607opening `$` must have a non-space character immediately to its right,
2608while the closing `$` must have a non-space character immediately to its
2609left, and must not be followed immediately by a digit. Thus,
2610`$20,000 and $30,000` won't parse as math. If for some reason
2611you need to enclose text in literal `$` characters, backslash-escape
2612them and they won't be treated as math delimiters.
2614TeX math will be printed in all output formats. How it is rendered
2615depends on the output format:
2617Markdown, LaTeX, Emacs Org mode, ConTeXt
2618 ~ It will appear verbatim between `$` characters.
2621 ~ It will be rendered using an [interpreted text role `:math:`].
2624 ~ It will be rendered as `latexmath:[...]`.
2627 ~ It will be rendered inside a `@math` command.
2630 ~ It will be rendered verbatim without `$`'s.
2633 ~ It will be rendered inside `<math>` tags.
2636 ~ It will be rendered inside `<span class="math">` tags.
2638RTF, OpenDocument, ODT
2639 ~ It will be rendered, if possible, using unicode characters,
2640 and will otherwise appear verbatim.
2643 ~ If the `--mathml` flag is used, it will be rendered using MathML
2644 in an `inlineequation` or `informalequation` tag. Otherwise it
2645 will be rendered, if possible, using unicode characters.
2648 ~ It will be rendered using OMML math markup.
2651 ~ If the `--webtex` option is used, formulas are rendered as images
2652 using Google Charts or other compatible web service, downloaded
2653 and embedded in the e-book. Otherwise, they will appear verbatim.
2655HTML, Slidy, DZSlides, S5, EPUB
2656 ~ The way math is rendered in HTML will depend on the
2657 command-line options selected:
2659 1. The default is to render TeX math as far as possible using unicode
2660 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2661 are put inside a `span` with `class="math"`, so that they may be
2662 styled differently from the surrounding text if needed.
2664 2. If the `--latexmathml` option is used, TeX math will be displayed
2665 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2666 The [LaTeXMathML] script will be used to render it as formulas.
2667 (This trick does not work in all browsers, but it works in Firefox.
2668 In browsers that do not support LaTeXMathML, TeX math will appear
2669 verbatim between `$` characters.)
2671 3. If the `--jsmath` option is used, TeX math will be put inside
2672 `<span>` tags (for inline math) or `<div>` tags (for display math)
2673 with class `math`. The [jsMath] script will be used to render
2676 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2677 be called to generate images for each TeX formula. This should
2678 work in all browsers. The `--mimetex` option takes an optional URL
2679 as argument. If no URL is specified, it will be assumed that the
2680 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2682 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2683 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2684 be processed by [gladTeX], which will produce image files for each
2685 formula and an HTML file with links to these images. So, the
2688 pandoc -s --gladtex myfile.txt -o myfile.htex
2689 gladtex -d myfile-images myfile.htex
2690 # produces myfile.html and images in myfile-images
2692 6. If the `--webtex` option is used, TeX formulas will be converted
2693 to `<img>` tags that link to an external script that converts
2694 formulas to images. The formula will be URL-encoded and concatenated
2695 with the URL provided. If no URL is specified, the Google Chart
2696 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2698 7. If the `--mathjax` option is used, TeX math will be displayed
2699 between `\(...\)` (for inline math) or `\[...\]` (for display
2700 math) and put in `<span>` tags with class `math`.
2701 The [MathJax] script will be used to render it as formulas.
2703[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2708#### Extension: `raw_html` ####
2710Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2711(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2712literally). (Technically this is not an extension, since standard
2713Markdown allows it, but it has been made an extension so that it can
2714be disabled if desired.)
2716The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2717DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
2720#### Extension: `markdown_in_html_blocks` ####
2722Standard Markdown allows you to include HTML "blocks": blocks
2723of HTML between balanced tags that are separated from the surrounding text
2724with blank lines, and start and end at the left margin. Within
2725these blocks, everything is interpreted as HTML, not Markdown;
2726so (for example), `*` does not signify emphasis.
2728Pandoc behaves this way when the `markdown_strict` format is used; but
2729by default, pandoc interprets material between HTML block tags as Markdown.
2730Thus, for example, pandoc will turn
2735 <td>[a link](http://google.com)</td>
2743 <td><em>one</em></td>
2744 <td><a href="http://google.com">a link</a></td>
2748whereas `Markdown.pl` will preserve it as is.
2750There is one exception to this rule: text between `<script>` and
2751`<style>` tags is not interpreted as Markdown.
2753This departure from standard Markdown should make it easier to mix
2754Markdown with HTML block elements. For example, one can surround
2755a block of Markdown text with `<div>` tags without preventing it
2756from being interpreted as Markdown.
2758#### Extension: `native_divs` ####
2760Use native pandoc `Div` blocks for content inside `<div>` tags.
2761For the most part this should give the same output as
2762`markdown_in_html_blocks`, but it makes it easier to write pandoc
2763filters to manipulate groups of blocks.
2765#### Extension: `native_spans` ####
2767Use native pandoc `Span` blocks for content inside `<span>` tags.
2768For the most part this should give the same output as `raw_html`,
2769but it makes it easier to write pandoc filters to manipulate groups
2775#### Extension: `raw_tex` ####
2777In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2778included in a document. Inline TeX commands will be preserved and passed
2779unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2780LaTeX to include BibTeX citations:
2782 This result was proved in \cite{jones.1967}.
2784Note that in LaTeX environments, like
2786 \begin{tabular}{|l|l|}\hline
2787 Age & Frequency \\ \hline
2790 36--45 & 22 \\ \hline
2793the material between the begin and end tags will be interpreted as raw
2794LaTeX, not as Markdown.
2796Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2802#### Extension: `latex_macros` ####
2804For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2805`\renewcommand` definitions and apply the resulting macros to all LaTeX
2806math. So, for example, the following will work in all output formats,
2809 \newcommand{\tuple}[1]{\langle #1 \rangle}
2813In LaTeX output, the `\newcommand` definition will simply be passed
2814unchanged to the output.
2820Markdown allows links to be specified in several ways.
2822### Automatic links ###
2824If you enclose a URL or email address in pointy brackets, it
2828 <sam@green.eggs.ham>
2832An inline link consists of the link text in square brackets,
2833followed by the URL in parentheses. (Optionally, the URL can
2834be followed by a link title, in quotes.)
2836 This is an [inline link](/url), and here's [one with
2837 a title](http://fsf.org "click here for a good time!").
2839There can be no space between the bracketed part and the parenthesized part.
2840The link text can contain formatting (such as emphasis), but the title cannot.
2842Email addresses in inline links are not autodetected, so they have to be
2843prefixed with `mailto`:
2845 [Write me!](mailto:sam@green.eggs.ham)
2847### Reference links ###
2849An *explicit* reference link has two parts, the link itself and the link
2850definition, which may occur elsewhere in the document (either
2851before or after the link).
2853The link consists of link text in square brackets, followed by a label in
2854square brackets. (There can be space between the two.) The link definition
2855consists of the bracketed label, followed by a colon and a space, followed by
2856the URL, and optionally (after a space) a link title either in quotes or in
2857parentheses. The label must not be parseable as a citation (assuming
2858the `citations` extension is enabled): citations take precedence over
2861Here are some examples:
2863 [my label 1]: /foo/bar.html "My title, optional"
2865 [my label 3]: http://fsf.org (The free software foundation)
2866 [my label 4]: /bar#special 'A title in single quotes'
2868The URL may optionally be surrounded by angle brackets:
2870 [my label 5]: <http://foo.bar.baz>
2872The title may go on the next line:
2874 [my label 3]: http://fsf.org
2875 "The free software foundation"
2877Note that link labels are not case sensitive. So, this will work:
2879 Here is [my link][FOO]
2883In an *implicit* reference link, the second pair of brackets is
2888 [my website]: http://foo.bar.baz
2890Note: In `Markdown.pl` and most other Markdown implementations,
2891reference link definitions cannot occur in nested constructions
2892such as list items or block quotes. Pandoc lifts this arbitrary
2893seeming restriction. So the following is fine in pandoc, though
2894not in most other implementations:
2900#### Extension: `shortcut_reference_links` ####
2902In a *shortcut* reference link, the second pair of brackets may
2907 [my website]: http://foo.bar.baz
2909### Internal links ###
2911To link to another section of the same document, use the automatically
2912generated identifier (see [Header identifiers]). For example:
2914 See the [Introduction](#introduction).
2918 See the [Introduction].
2920 [Introduction]: #introduction
2922Internal links are currently supported for HTML formats (including
2923HTML slide shows and EPUB), LaTeX, and ConTeXt.
2928A link immediately preceded by a `!` will be treated as an image.
2929The link text will be used as the image's alt text:
2931 
2935 [movie reel]: movie.gif
2937#### Extension: `implicit_figures` ####
2939An image occurring by itself in a paragraph will be rendered as
2940a figure with a caption.[^5] (In LaTeX, a figure environment will be
2941used; in HTML, the image will be placed in a `div` with class
2942`figure`, together with a caption in a `p` with class `caption`.)
2943The image's alt text will be used as the caption.
2945 
2947[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2948 ODT. In those formats, you'll just get an image in a paragraph by
2949 itself, with no caption.
2951If you just want a regular inline image, just make sure it is not
2952the only thing in the paragraph. One way to do this is to insert a
2953nonbreaking space after the image:
2955 \
2957#### Extension: `link_attributes` ####
2959Attributes can be set on links and images:
2961 An inline {#id .class width=30 height=20px}
2962 and a reference ![image][ref] with attributes.
2964 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
2966(This syntax is compatible with [PHP Markdown Extra] when only `#id`
2967and `.class` are used.)
2969For HTML and EPUB, all attributes except `width` and `height` (but
2970including `srcset` and `sizes`) are passed through as is. The other
2971writers ignore attributes that are not supported by their output
2974The `width` and `height` attributes on images are treated specially. When
2975used without a unit, the unit is assumed to be pixels. However, any of
2976the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
2977and `%`. There must not be any spaces between the number and the unit.
2981{ width=50% }
2984- Dimensions are converted to inches for output in page-based formats like
2985 LaTeX. Dimensions are converted to pixels for output in HTML-like
2986 formats. Use the `--dpi` option to specify the number of pixels per
2987 inch. The default is 96dpi.
2988- The `%` unit is generally relative to some available space.
2989 For example the above example will render to
2990 `<img href="file.jpg" style="width: 50%;" />` (HTML),
2991 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
2992 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
2993- Some output formats have a notion of a class
2994 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
2995 or a unique identifier (LaTeX `\caption`), or both (HTML).
2996- When no `width` or `height` attributes are specified, the fallback
2997 is to look at the image resolution and the dpi metadata embedded in
3004#### Extension: `footnotes` ####
3006Pandoc's Markdown allows footnotes, using the following syntax:
3008 Here is a footnote reference,[^1] and another.[^longnote]
3010 [^1]: Here is the footnote.
3012 [^longnote]: Here's one with multiple blocks.
3014 Subsequent paragraphs are indented to show that they
3015 belong to the previous footnote.
3019 The whole paragraph can be indented, or just the first
3020 line. In this way, multi-paragraph footnotes work like
3021 multi-paragraph list items.
3023 This paragraph won't be part of the note, because it
3026The identifiers in footnote references may not contain spaces, tabs,
3027or newlines. These identifiers are used only to correlate the
3028footnote reference with the note itself; in the output, footnotes
3029will be numbered sequentially.
3031The footnotes themselves need not be placed at the end of the
3032document. They may appear anywhere except inside other block elements
3033(lists, block quotes, tables, etc.).
3035#### Extension: `inline_notes` ####
3037Inline footnotes are also allowed (though, unlike regular notes,
3038they cannot contain multiple paragraphs). The syntax is as follows:
3040 Here is an inline note.^[Inlines notes are easier to write, since
3041 you don't have to pick an identifier and move down to type the
3044Inline and regular footnotes may be mixed freely.
3050#### Extension: `citations` ####
3052Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3053citations and a bibliography in a number of styles. Basic usage is
3055 pandoc --filter pandoc-citeproc myinput.txt
3057In order to use this feature, you will need to specify a bibliography file
3058using the `bibliography` metadata field in a YAML metadata section, or
3059`--bibliography` command line argument. You can supply multiple `--bibliography`
3060arguments or set `bibliography` metadata field to YAML array, if you want to
3061use multiple bibliography files. The bibliography may have any of these
3064 Format File extension
3065 ------------ --------------
3078Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3079use `.bibtex` to force BibTeX.
3081Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3082can produce `.json` and `.yaml` files from any of the supported formats.
3084In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3085a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3093`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3102`<span class="nocase">...</span>`
3103: prevent a phrase from being capitalized as title case
3105`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3106and CSL YAML formats as far as possible.
3108As an alternative to specifying a bibliography file using `--bibliography`
3109or the YAML metadata field `bibliography`, you can include
3110the citation data directly in the `references` field of the
3111document's YAML metadata. The field should contain an array of
3112YAML-encoded references, for example:
3116 - type: article-journal
3128 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3130 title-short: Molecular structure of nucleic acids
3131 container-title: Nature
3135 DOI: 10.1038/171737a0
3136 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3140(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3141of the supported formats.)
3143Citations and references can be formatted using any style supported by the
3144[Citation Style Language], listed in the [Zotero Style Repository].
3145These files are specified using the `--csl` option or the `csl` metadata field.
3146By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3147format. The CSL project provides further information on [finding and editing styles].
3149To make your citations hyperlinks to the corresponding bibliography
3150entries, add `link-citations: true` to your YAML metadata.
3152Citations go inside square brackets and are separated by semicolons.
3153Each citation must have a key, composed of '@' + the citation
3154identifier from the database, and may optionally have a prefix,
3155a locator, and a suffix. The citation key must begin with a letter, digit,
3156or `_`, and may contain alphanumerics, `_`, and internal punctuation
3157characters (`:.#$%&-+?<>~/`). Here are some examples:
3159 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3161 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3163 Blah blah [@smith04; @doe99].
3165`pandoc-citeproc` detects locator terms in the [CSL locale files].
3166Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3167locale, locator terms can be written in either singular or plural forms,
3168as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3169`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3170`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3171`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3172`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3173`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3174locator term is used, "page" is assumed.
3176A minus sign (`-`) before the `@` will suppress mention of
3177the author in the citation. This can be useful when the
3178author is already mentioned in the text:
3180 Smith says blah [-@smith04].
3182You can also write an in-text citation, as follows:
3186 @smith04 [p. 33] says blah.
3188If the style calls for a list of works cited, it will be placed
3189at the end of the document. Normally, you will want to end your
3190document with an appropriate header:
3196The bibliography will be inserted after this header. Note that
3197the `unnumbered` class will be added to this header, so that the
3198section will not be numbered.
3200If you want to include items in the bibliography without actually
3201citing them in the body text, you can define a dummy `nocite` metadata
3202field and put the citations there:
3211In this example, the document will contain a citation for `item3`
3212only, but the bibliography will contain entries for `item1`, `item2`, and
3215For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3216to render bibliography. In order to do so, specify bibliography files as
3217outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3218invocation. Bear in mind that bibliography files have to be in respective
3219format (either BibTeX or BibLaTeX).
3221For more information, see the [pandoc-citeproc man page].
3223[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3224[Chicago Manual of Style]: http://chicagomanualofstyle.org
3225[Citation Style Language]: http://citationstyles.org
3226[Zotero Style Repository]: https://www.zotero.org/styles
3227[finding and editing styles]: http://citationstyles.org/styles/
3228[CSL locale files]: https://github.com/citation-style-language/locales
3229[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3231Non-pandoc extensions
3232---------------------
3234The following Markdown syntax extensions are not enabled by default
3235in pandoc, but may be enabled by adding `+EXTENSION` to the format
3236name, where `EXTENSION` is the name of the extension. Thus, for
3237example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3239#### Extension: `lists_without_preceding_blankline` ####
3241Allow a list to occur right after a paragraph, with no intervening
3244#### Extension: `hard_line_breaks` ####
3246Causes all newlines within a paragraph to be interpreted as hard line
3247breaks instead of spaces.
3249#### Extension: `ignore_line_breaks` ####
3251Causes newlines within a paragraph to be ignored, rather than being
3252treated as spaces or as hard line breaks. This option is intended for
3253use with East Asian languages where spaces are not used between words,
3254but text is divided into lines for readability.
3256#### Extension: `east_asian_line_breaks` ####
3258Causes newlines within a paragraph to be ignored, rather than
3259being treated as spaces or as hard line breaks, when they occur
3260between two East Asian wide characters. This is a better choice
3261than `ignore_line_breaks` for texts that include a mix of East
3262Asian wide characters and other characters.
3264##### Extension: `emoji` ####
3266Parses textual emojis like `:smile:` as Unicode emoticons.
3268#### Extension: `tex_math_single_backslash` ####
3270Causes anything between `\(` and `\)` to be interpreted as inline
3271TeX math, and anything between `\[` and `\]` to be interpreted
3272as display TeX math. Note: a drawback of this extension is that
3273it precludes escaping `(` and `[`.
3275#### Extension: `tex_math_double_backslash` ####
3277Causes anything between `\\(` and `\\)` to be interpreted as inline
3278TeX math, and anything between `\\[` and `\\]` to be interpreted
3281#### Extension: `markdown_attribute` ####
3283By default, pandoc interprets material inside block-level tags as Markdown.
3284This extension changes the behavior so that Markdown is only parsed
3285inside block-level tags if the tags have the attribute `markdown=1`.
3287#### Extension: `mmd_title_block` ####
3289Enables a [MultiMarkdown] style title block at the top of
3290the document, for example:
3294 Date: September 1, 2008
3295 Comment: This is a sample mmd title block, with
3296 a field spanning multiple lines.
3298See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3299`yaml_metadata_block` is enabled, it will take precedence over
3302[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
3304#### Extension: `abbreviations` ####
3306Parses PHP Markdown Extra abbreviation keys, like
3308 *[HTML]: Hypertext Markup Language
3310Note that the pandoc document model does not support
3311abbreviations, so if this extension is enabled, abbreviation keys are
3312simply skipped (as opposed to being parsed as paragraphs).
3314#### Extension: `autolink_bare_uris` ####
3316Makes all absolute URIs into links, even when not surrounded by
3317pointy braces `<...>`.
3319#### Extension: `ascii_identifiers` ####
3321Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3322Accents are stripped off of accented latin letters, and non-latin
3325#### Extension: `mmd_link_attributes` ####
3327Parses multimarkdown style key-value attributes on link
3328and image references. This extension should not be confused with the
3329[`link_attributes`](#extension-link_attributes) extension.
3331 This is a reference ![image][ref] with multimarkdown attributes.
3333 [ref]: http://path.to/image "Image title" width=20px height=30px
3334 id=myId class="myClass1 myClass2"
3336#### Extension: `mmd_header_identifiers` ####
3338Parses multimarkdown style header identifiers (in square brackets,
3339after the header but before any trailing `#`s in an ATX header).
3341#### Extension: `compact_definition_lists` ####
3343Activates the definition list syntax of pandoc 1.12.x and earlier.
3344This syntax differs from the one described above under [Definition lists]
3347 - No blank line is required between consecutive items of the
3349 - To get a "tight" or "compact" list, omit space between consecutive
3350 items; the space between a term and its definition does not affect
3352 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3353 be indented four spaces.[^6]
3355[^6]: To see why laziness is incompatible with relaxing the requirement
3356 of a blank line between items, consider the following example:
3363 Is this a single list item with two definitions of "bar," the first of
3364 which is lazily wrapped, or two list items? To remove the ambiguity
3365 we must either disallow lazy wrapping or require a blank line between
3371In addition to pandoc's extended Markdown, the following Markdown
3372variants are supported:
3374`markdown_phpextra` (PHP Markdown Extra)
3375: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3376 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3377 `header_attributes`, `link_attributes`, `abbreviations`,
3378 `shortcut_reference_links`.
3380`markdown_github` (GitHub-Flavored Markdown)
3381: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,
3382 `fenced_code_blocks`, `auto_identifiers`,
3383 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3384 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3385 `shortcut_reference_links`.
3387`markdown_mmd` (MultiMarkdown)
3388: `pipe_tables` `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3389 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
3390 `mmd_title_block`, `footnotes`, `definition_lists`,
3391 `all_symbols_escapable`, `implicit_header_references`,
3392 `auto_identifiers`, `mmd_header_identifiers`,
3393 `shortcut_reference_links`.
3395`markdown_strict` (Markdown.pl)
3398Extensions with formats other than Markdown
3399-------------------------------------------
3401Some of the extensions discussed above can be used with formats
3404* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3405 and `textile` input (and is used by default).
3407* `tex_math_dollars`, `tex_math_single_backslash`, and
3408 `tex_math_double_backslash` can be used with `html` input.
3409 (This is handy for reading web pages formatted using MathJax,
3412Producing slide shows with pandoc
3413=================================
3415You can use pandoc to produce an HTML + javascript slide presentation
3416that can be viewed via a web browser. There are five ways to do this,
3417using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3418You can also produce a PDF slide show using LaTeX [`beamer`].
3420Here's the Markdown source for a simple slide show, `habits.txt`:
3447 
3454To produce an HTML/javascript slide show, simply type
3456 pandoc -t FORMAT -s habits.txt -o habits.html
3458where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3460For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3461`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3462assumed to be available at the relative path `s5/default` (for S5), `slideous`
3463(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3464`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3465`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3466above.) For DZSlides, the (relatively short) javascript and css are included in
3469With all HTML slide formats, the `--self-contained` option can be used to
3470produce a single file that contains all of the data necessary to display the
3471slide show, including linked scripts, stylesheets, images, and videos.
3473To produce a PDF slide show using beamer, type
3475 pandoc -t beamer habits.txt -o habits.pdf
3477Note that a reveal.js slide show can also be converted to a PDF
3478by printing it to a file from the browser.
3480Structuring the slide show
3481--------------------------
3483By default, the *slide level* is the highest header level in
3484the hierarchy that is followed immediately by content, and not another
3485header, somewhere in the document. In the example above, level 1 headers
3486are always followed by level 2 headers, which are followed by content,
3487so 2 is the slide level. This default can be overridden using
3488the `--slide-level` option.
3490The document is carved up into slides according to the following
3493 * A horizontal rule always starts a new slide.
3495 * A header at the slide level always starts a new slide.
3497 * Headers *below* the slide level in the hierarchy create
3498 headers *within* a slide.
3500 * Headers *above* the slide level in the hierarchy create
3501 "title slides," which just contain the section title
3502 and help to break the slide show into sections.
3504 * A title page is constructed automatically from the document's title
3505 block, if present. (In the case of beamer, this can be disabled
3506 by commenting out some lines in the default template.)
3508These rules are designed to support many different styles of slide show. If
3509you don't care about structuring your slides into sections and subsections,
3510you can just use level 1 headers for all each slide. (In that case, level 1
3511will be the slide level.) But you can also structure the slide show into
3512sections, as in the example above.
3514Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3515layout will be produced, with level 1 headers building horizontally
3516and level 2 headers building vertically. It is not recommended that
3517you use deeper nesting of section levels with reveal.js.
3522By default, these writers produce lists that display "all at once."
3523If you want your lists to display incrementally (one item at a time),
3524use the `-i` option. If you want a particular list to depart from the
3525default (that is, to display incrementally without the `-i` option and
3526all at once with the `-i` option), put it in a block quote:
3531In this way incremental and nonincremental lists can be mixed in
3537You can add "pauses" within a slide by including a paragraph containing
3538three dots, separated by spaces:
3540 # Slide with a pause
3542 content before the pause
3546 content after the pause
3551You can change the style of HTML slides by putting customized CSS files
3552in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3553or `$DATADIR/slideous` (for Slideous),
3554where `$DATADIR` is the user data directory (see `--data-dir`, above).
3555The originals may be found in pandoc's system data directory (generally
3556`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3557files it does not find in the user data directory.
3559For dzslides, the CSS is included in the HTML file itself, and may
3562All [reveal.js configuration options] can be set through variables.
3563For example, themes can be used by setting the `theme` variable:
3567Or you can specify a custom stylesheet using the `--css` option.
3569To style beamer slides, you can specify a `theme`, `colortheme`,
3570`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3572 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3574Note that header attributes will turn into slide attributes
3575(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3576to style individual slides. In beamer, the only header attribute
3577that affects slides is the `allowframebreaks` class, which sets the
3578`allowframebreaks` option, causing multiple slides to be created
3579if the content overfills the frame. This is recommended especially for
3582 # References {.allowframebreaks}
3587reveal.js has good support for speaker notes. You can add notes to your
3588Markdown document thus:
3593 - It can contain Markdown
3598To show the notes window, press `s` while viewing the presentation.
3599Notes are not yet supported for other slide formats, but the notes
3600will not appear on the slides themselves.
3602Frame attributes in beamer
3603--------------------------
3605Sometimes it is necessary to add the LaTeX `[fragile]` option to
3606a frame in beamer (for example, when using the `minted` environment).
3607This can be forced by adding the `fragile` class to the header
3608introducing the slide:
3610 # Fragile slide {.fragile}
3612All of the other frame attributes described in Section 8.1 of
3613the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3614`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3617Creating EPUBs with pandoc
3618==========================
3623EPUB metadata may be specified using the `--epub-metadata` option, but
3624if the source document is Markdown, it is better to use a [YAML metadata
3625block][Extension: `yaml_metadata_block`]. Here is an example:
3632 text: An investigation of metadata
3640 text: doi:10.234234.234/33
3642 rights: © 2007 John Smith, CC BY-NC
3645The following fields are recognized:
3648 ~ Either a string value or an object with fields `text` and
3649 `scheme`. Valid values for `scheme` are `ISBN-10`,
3650 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3651 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3652 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3655 ~ Either a string value, or an object with fields `file-as` and
3656 `type`, or a list of such objects. Valid values for `type` are
3657 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3660 ~ Either a string value, or an object with fields `role`, `file-as`,
3661 and `text`, or a list of such objects. Valid values for `role` are
3662 [MARC relators], but
3663 pandoc will attempt to translate the human-readable versions
3664 (like "author" and "editor") to the appropriate marc relators.
3667 ~ Same format as `creator`.
3670 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3671 Pandoc will attempt to convert other common date formats.
3673`lang` (or legacy: `language`)
3674 ~ A string value in [BCP 47] format. Pandoc will default to the local
3675 language if nothing is specified.
3678 ~ A string value or a list of such values.
3699 ~ A string value (path to cover image).
3702 ~ A string value (path to CSS stylesheet).
3704`page-progression-direction`
3705 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3706 attribute for the [`spine` element].
3708[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3709[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3714By default, pandoc will download linked media (including audio and
3715video) and include it in the EPUB container, yielding a completely
3716self-contained EPUB. If you want to link to external media resources
3717instead, use raw HTML in your source and add `data-external="1"` to the tag
3718with the `src` attribute. For example:
3720 <audio controls="1">
3721 <source src="http://example.com/music/toccata.mp3"
3722 data-external="1" type="audio/mpeg">
3726Literate Haskell support
3727========================
3729If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3730format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3731`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3732literate Haskell source. This means that
3734 - In Markdown input, "bird track" sections will be parsed as Haskell
3735 code rather than block quotations. Text between `\begin{code}`
3736 and `\end{code}` will also be treated as Haskell code. For
3737 ATX-style headers the character '=' will be used instead of '#'.
3739 - In Markdown output, code blocks with classes `haskell` and `literate`
3740 will be rendered using bird tracks, and block quotations will be
3741 indented one space, so they will not be treated as Haskell code.
3742 In addition, headers will be rendered setext-style (with underlines)
3743 rather than ATX-style (with '#' characters). (This is because ghc
3744 treats '#' characters in column 1 as introducing line numbers.)
3746 - In restructured text input, "bird track" sections will be parsed
3749 - In restructured text output, code blocks with class `haskell` will
3750 be rendered using bird tracks.
3752 - In LaTeX input, text in `code` environments will be parsed as
3755 - In LaTeX output, code blocks with class `haskell` will be rendered
3756 inside `code` environments.
3758 - In HTML output, code blocks with class `haskell` will be rendered
3759 with class `literatehaskell` and bird tracks.
3763 pandoc -f markdown+lhs -t html
3765reads literate Haskell source formatted with Markdown conventions and writes
3766ordinary HTML (without bird tracks).
3768 pandoc -f markdown+lhs -t html+lhs
3770writes HTML with the Haskell code in bird tracks, so it can be copied
3771and pasted as literate Haskell source.
3776Pandoc will automatically highlight syntax in [fenced code blocks] that
3777are marked with a language name. The Haskell library [highlighting-kate] is used for
3778highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3779The color scheme can be selected using the `--highlight-style` option.
3780The default color scheme is `pygments`, which imitates the default color
3781scheme used by the Python library pygments, but pygments is not actually
3782used to do the highlighting.
3784To see a list of language names that pandoc will recognize, type
3787To disable highlighting, use the `--no-highlight` option.
3789[highlighting-kate]: https://github.com/jgm/highlighting-kate
3794Pandoc can be extended with custom writers written in [lua]. (Pandoc
3795includes a lua interpreter, so lua need not be installed separately.)
3797To use a custom writer, simply specify the path to the lua script
3798in place of the output format. For example:
3800 pandoc -t data/sample.lua
3802Creating a custom writer requires writing a lua function for each
3803possible element in a pandoc document. To get a documented example
3804which you can modify according to your needs, do
3806 pandoc --print-default-data-file sample.lua
3808[lua]: http://www.lua.org
3813© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3814[GPL], version 2 or greater. This software carries no warranty of
3815any kind. (See COPYRIGHT for full copyright and warranty notices.)
3820Alexander Kondratskiy,
3822Alexander V Vershilov,
3823Alfred Wechselberger,
3831Beni Cherniavsky-Paskin,
3839Christoffer Ackelman,
3869Jaime Marquínez Ferrándiz,
3898Matthias C. M. Troffaes,
3944[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