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],
16[MultiMarkdown], and (subsets of) [Textile], [reStructuredText], [HTML],
17[LaTeX], [MediaWiki markup], [TWiki markup], [Haddock markup], [OPML], [Emacs
18Org mode], [DocBook], [txt2tags], [EPUB], [ODT] and [Word docx]; and it can
19write plain text, [Markdown], [CommonMark], [PHP Markdown Extra],
20[GitHub-Flavored Markdown], [MultiMarkdown], [reStructuredText], [XHTML],
21[HTML5], [LaTeX] (including [`beamer`] slide shows), [ConTeXt], [RTF], [OPML],
22[DocBook], [OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
23markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
24[EPUB] (v2 or v3), [FictionBook2], [Textile], [groff man] pages,
25[Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI Simple], and [Slidy],
26[Slideous], [DZSlides], [reveal.js] or [S5] HTML slide shows. It can also
27produce [PDF] output on systems where LaTeX, ConTeXt, or `wkhtmltopdf` is
30Pandoc's enhanced version of Markdown includes syntax for [footnotes],
31[tables], flexible [ordered lists], [definition lists], [fenced code blocks],
32[superscripts and subscripts], [strikeout], [metadata blocks], automatic tables of
33contents, embedded LaTeX [math], [citations], and [Markdown inside HTML block
34elements][Extension: `markdown_in_html_blocks`]. (These enhancements, described below under
35[Pandoc's Markdown], can be disabled using the
36`markdown_strict` input or output format.)
38In contrast to most existing tools for converting Markdown to HTML, which
39use regex substitutions, pandoc has a modular design: it consists of a
40set of readers, which parse text in a given format and produce a native
41representation of the document, and a set of writers, which convert
42this native representation into a target format. Thus, adding an input
43or output format requires only adding a reader or writer.
45Because pandoc's intermediate representation of a document is less
46expressive than many of the formats it converts between, one should
47not expect perfect conversions between every format and every other.
48Pandoc attempts to preserve the structural elements of a document, but
49not formatting details such as margin size. And some document elements,
50such as complex tables, may not fit into pandoc's simple document
51model. While conversions from pandoc's Markdown to all formats aspire
52to be perfect, conversions from formats more expressive than pandoc's
53Markdown can be expected to be lossy.
55[Markdown]: http://daringfireball.net/projects/markdown/
56[CommonMark]: http://commonmark.org
57[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
58[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
59[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
60[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
61[S5]: http://meyerweb.com/eric/tools/s5/
62[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
63[Slideous]: http://goessner.net/articles/slideous/
64[HTML]: http://www.w3.org/html/
65[HTML5]: http://www.w3.org/TR/html5/
66[XHTML]: http://www.w3.org/TR/xhtml1/
67[LaTeX]: http://latex-project.org
68[`beamer`]: https://ctan.org/pkg/beamer
69[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
70[ConTeXt]: http://contextgarden.net/
71[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
72[DocBook]: http://docbook.org
73[txt2tags]: http://txt2tags.org
74[EPUB]: http://idpf.org/epub
75[OPML]: http://dev.opml.org/spec2.html
76[OpenDocument]: http://opendocument.xml.org
77[ODT]: http://en.wikipedia.org/wiki/OpenDocument
78[Textile]: http://redcloth.org/textile
79[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
80[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
81[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
82[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
83[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
84[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
85[Haskell]: https://www.haskell.org
86[GNU Texinfo]: http://www.gnu.org/software/texinfo/
87[Emacs Org mode]: http://orgmode.org
88[AsciiDoc]: http://www.methods.co.nz/asciidoc/
89[DZSlides]: http://paulrouget.com/dzslides/
90[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
91[PDF]: https://www.adobe.com/pdf/
92[reveal.js]: http://lab.hakim.se/reveal-js/
93[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
94[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
95[TEI Simple]: https://github.com/TEIC/TEI-Simple
100If no *input-file* is specified, input is read from *stdin*.
101Otherwise, the *input-files* are concatenated (with a blank
102line between each) and used as input. Output goes to *stdout* by
103default (though output to *stdout* is disabled for the `odt`, `docx`,
104`epub`, and `epub3` output formats). For output to a file, use the
107 pandoc -o output.html input.txt
109By default, pandoc produces a document fragment, not a standalone
110document with a proper header and footer. To produce a standalone
111document, use the `-s` or `--standalone` flag:
113 pandoc -s -o output.html input.txt
115For more information on how standalone documents are produced, see
118Instead of a file, an absolute URI may be given. In this case
119pandoc will fetch the content using HTTP:
121 pandoc -f html -t markdown http://www.fsf.org
123If multiple input files are given, `pandoc` will concatenate them all (with
124blank lines between them) before parsing. This feature is disabled for
125 binary input formats such as `EPUB`, `odt`, and `docx`.
127The format of the input and output can be specified explicitly using
128command-line options. The input format can be specified using the
129`-r/--read` or `-f/--from` options, the output format using the
130`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
131Markdown to LaTeX, you could type:
133 pandoc -f markdown -t latex hello.txt
135To convert `hello.html` from HTML to Markdown:
137 pandoc -f html -t markdown hello.html
139Supported output formats are listed below under the `-t/--to` option.
140Supported input formats are listed below under the `-f/--from` option. Note
141that the `rst`, `textile`, `latex`, and `html` readers are not complete;
142there are some constructs that they do not parse.
144If the input or output format is not specified explicitly, `pandoc`
145will attempt to guess it from the extensions of
146the input and output filenames. Thus, for example,
148 pandoc -o hello.tex hello.txt
150will convert `hello.txt` from Markdown to LaTeX. If no output file
151is specified (so that output goes to *stdout*), or if the output file's
152extension is unknown, the output format will default to HTML.
153If no input file is specified (so that input comes from *stdin*), or
154if the input files' extensions are unknown, the input format will
155be assumed to be Markdown unless explicitly specified.
157Pandoc uses the UTF-8 character encoding for both input and output.
158If your local character encoding is not UTF-8, you
159should pipe input and output through [`iconv`]:
161 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
163Note that in some output formats (such as HTML, LaTeX, ConTeXt,
164RTF, OPML, DocBook, and Texinfo), information about
165the character encoding is included in the document header, which
166will only be included if you use the `-s/--standalone` option.
168[`iconv`]: http://www.gnu.org/software/libiconv/
173To produce a PDF, specify an output file with a `.pdf` extension.
174By default, pandoc will use LaTeX to convert it to PDF:
176 pandoc test.txt -o test.pdf
178Production of a PDF requires that a LaTeX engine be installed (see
179`--latex-engine`, below), and assumes that the following LaTeX packages
180are available: [`amsfonts`], [`amsmath`], [`lm`],
181[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
182`--listings` option is used), [`fancyvrb`], [`longtable`],
183[`booktabs`], [`graphicx`] and [`grffile`] (if the
184document contains images), [`hyperref`], [`ulem`],
185[`geometry`] (with the `geometry` variable set), [`setspace`] (with
186`linestretch`), and [`babel`] (with `lang`). The use of `xelatex` or
187`lualatex` as the LaTeX engine requires [`fontspec`]; `xelatex` uses
188[`mathspec`], [`polyglossia`] (with `lang`), [`xecjk`], and
189[`bidi`] (with the `dir` variable set). The [`upquote`] and
190[`microtype`] packages are used if available, and [`csquotes`] will
191be used for [smart punctuation] if added to the template or included in
192any header file. The [`natbib`], [`biblatex`], [`bibtex`], and [`biber`]
193packages can optionally be used for [citation rendering]. These are
194included with all recent versions of [TeX Live].
196Alternatively, pandoc can use ConTeXt or `wkhtmltopdf` to create a PDF.
197To do this, specify an output file with a `.pdf` extension,
198as before, but add `-t context` or `-t html5` to the command line.
200PDF output can be controlled using [variables for LaTeX] (if
201LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
202If `wkhtmltopdf` is used, then the variables `margin-left`,
203`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
204will affect the output, as will `--css`.
206[`amsfonts`]: https://ctan.org/pkg/amsfonts
207[`amsmath`]: https://ctan.org/pkg/amsmath
208[`lm`]: https://ctan.org/pkg/lm
209[`ifxetex`]: https://ctan.org/pkg/ifxetex
210[`ifluatex`]: https://ctan.org/pkg/ifluatex
211[`eurosym`]: https://ctan.org/pkg/eurosym
212[`listings`]: https://ctan.org/pkg/listings
213[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
214[`longtable`]: https://ctan.org/pkg/longtable
215[`booktabs`]: https://ctan.org/pkg/booktabs
216[`graphicx`]: https://ctan.org/pkg/graphicx
217[`grffile`]: https://ctan.org/pkg/grffile
218[`geometry`]: https://ctan.org/pkg/geometry
219[`setspace`]: https://ctan.org/pkg/setspace
220[`xecjk`]: https://ctan.org/pkg/xecjk
221[`hyperref`]: https://ctan.org/pkg/hyperref
222[`ulem`]: https://ctan.org/pkg/ulem
223[`babel`]: https://ctan.org/pkg/babel
224[`bidi`]: https://ctan.org/pkg/bidi
225[`mathspec`]: https://ctan.org/pkg/mathspec
226[`polyglossia`]: https://ctan.org/pkg/polyglossia
227[`fontspec`]: https://ctan.org/pkg/fontspec
228[`upquote`]: https://ctan.org/pkg/upquote
229[`microtype`]: https://ctan.org/pkg/microtype
230[`csquotes`]: https://ctan.org/pkg/csquotes
231[`natbib`]: https://ctan.org/pkg/natbib
232[`biblatex`]: https://ctan.org/pkg/biblatex
233[`bibtex`]: https://ctan.org/pkg/bibtex
234[`biber`]: https://ctan.org/pkg/biber
235[TeX Live]: http://www.tug.org/texlive/
243`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
245: Specify input format. *FORMAT* can be `native` (native Haskell),
246 `json` (JSON version of native AST), `markdown` (pandoc's
247 extended Markdown), `markdown_strict` (original unextended
248 Markdown), `markdown_phpextra` (PHP Markdown Extra), `markdown_github`
249 (GitHub-Flavored Markdown), `markdown_mmd` (MultiMarkdown),
250 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
251 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
252 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
253 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
254 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
255 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
256 input will be treated as literate Haskell source: see [Literate
257 Haskell support], below. Markdown
258 syntax extensions can be individually enabled or disabled by
259 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
260 example, `markdown_strict+footnotes+definition_lists` is strict
261 Markdown with footnotes and definition lists enabled, and
262 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
263 without pipe tables and with hard line breaks. See [Pandoc's
264 Markdown], below, for a list of extensions and
267`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
269: Specify output format. *FORMAT* can be `native` (native Haskell),
270 `json` (JSON version of native AST), `plain` (plain text),
271 `markdown` (pandoc's extended Markdown), `markdown_strict`
272 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
273 Extra), `markdown_github` (GitHub-Flavored Markdown), `markdown_mmd`
274 (MultiMarkdown), `commonmark` (CommonMark Markdown), `rst`
275 (reStructuredText), `html` (XHTML), `html5` (HTML5), `latex`
276 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
277 `man` (groff man), `mediawiki` (MediaWiki markup),
278 `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
279 `textile` (Textile), `org` (Emacs Org mode),
280 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook 4),
281 `docbook5` (DocBook 5), `opendocument` (OpenDocument), `odt`
282 (OpenOffice text document), `docx` (Word docx), `haddock`
283 (Haddock markup), `rtf` (rich text format), `epub` (EPUB v2
284 book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
285 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
286 Simple), `slidy` (Slidy HTML and javascript slide show),
287 `slideous` (Slideous HTML and javascript slide show),
288 `dzslides` (DZSlides HTML5 + javascript slide show),
289 `revealjs` (reveal.js HTML5 + javascript slide show), `s5`
290 (S5 HTML and javascript slide show), or the path of a custom
291 lua writer (see [Custom writers], below). Note that `odt`,
292 `epub`, and `epub3` output will not be directed to *stdout*;
293 an output filename must be specified using the `-o/--output`
294 option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
295 `beamer`, `html`, or `html5`, the output will be rendered as
296 literate Haskell source: see [Literate Haskell support],
297 below. Markdown syntax extensions can be individually
298 enabled or disabled by appending `+EXTENSION` or
299 `-EXTENSION` to the format name, as described above under `-f`.
301`-o` *FILE*, `--output=`*FILE*
303: Write output to *FILE* instead of *stdout*. If *FILE* is
304 `-`, output will go to *stdout*. (Exception: if the output
305 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
307`--data-dir=`*DIRECTORY*
309: Specify the user data directory to search for pandoc data files.
310 If this option is not specified, the default user data directory
311 will be used. This is, in Unix:
317 C:\Documents And Settings\USERNAME\Application Data\pandoc
319 and in Windows Vista or later:
321 C:\Users\USERNAME\AppData\Roaming\pandoc
323 You can find the default user data directory on your system by
324 looking at the output of `pandoc --version`.
325 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
326 `slidy`, `slideous`, or `s5` directory
327 placed in this directory will override pandoc's normal defaults.
331: Generate a bash completion script. To enable bash completion
332 with pandoc, add this to your `.bashrc`:
334 eval "$(pandoc --bash-completion)"
338: Give verbose debugging output. Currently this only has an effect
354: Parse untranslatable HTML codes and LaTeX environments as raw HTML
355 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
356 input. Raw HTML can be printed in Markdown, reStructuredText, Emacs Org
357 mode, HTML, Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
358 can be printed in Markdown, reStructuredText, Emacs Org mode, LaTeX, and
359 ConTeXt output. The default is for the readers to omit untranslatable
360 HTML codes and LaTeX environments. (The LaTeX reader does pass through
361 untranslatable LaTeX *commands*, even if `-R` is not specified.)
365: Produce typographically correct output, converting straight quotes
366 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
367 `...` to ellipses. Nonbreaking spaces are inserted after certain
368 abbreviations, such as "Mr." (Note: This option is selected automatically
369 when the output format is `latex` or `context`, unless `--no-tex-ligatures`
370 is used. It has no effect for `latex` input.)
374: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
375 a numeral is an en-dash, and `--` is an em-dash. This option is selected
376 automatically for `textile` input.
378`--base-header-level=`*NUMBER*
380: Specify the base level for headers (defaults to 1).
382`--indented-code-classes=`*CLASSES*
384: Specify classes to use for indented code blocks--for example,
385 `perl,numberLines` or `haskell`. Multiple classes may be separated
388`--default-image-extension=`*EXTENSION*
390: Specify a default extension to use when image paths/URLs have no
391 extension. This allows you to use the same source for formats that
392 require different kinds of images. Currently this option only affects
393 the Markdown and LaTeX readers.
397: Parse each file individually before combining for multifile
398 documents. This will allow footnotes in different files with the
399 same identifiers to work as expected. If this option is set,
400 footnotes and links will not work across files. Reading binary
401 files (docx, odt, epub) implies `--file-scope`.
403`--filter=`*EXECUTABLE*
405: Specify an executable to be used as a filter transforming the
406 pandoc AST after the input is parsed and before the output is
407 written. The executable should read JSON from stdin and write
408 JSON to stdout. The JSON must be formatted like pandoc's own
409 JSON input and output. The name of the output format will be
410 passed to the filter as the first argument. Hence,
412 pandoc --filter ./caps.py -t latex
416 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
418 The latter form may be useful for debugging filters.
420 Filters may be written in any language. `Text.Pandoc.JSON`
421 exports `toJSONFilter` to facilitate writing filters in Haskell.
422 Those who would prefer to write filters in python can use the
423 module [`pandocfilters`], installable from PyPI. There are also
424 pandoc filter libraries in [PHP], [perl], and [javascript/node.js].
426 Note that the *EXECUTABLE* will be sought in the user's
427 `PATH`, and not in the working directory, if no directory is
428 provided. If you want to run a script in the working directory,
429 preface the filename with `./`.
431`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
433: Set the metadata field *KEY* to the value *VAL*. A value specified
434 on the command line overrides a value specified in the document.
435 Values will be parsed as YAML boolean or string values. If no value is
436 specified, the value will be treated as Boolean true. Like
437 `--variable`, `--metadata` causes template variables to be set.
438 But unlike `--variable`, `--metadata` affects the metadata of the
439 underlying document (which is accessible from filters and may be
440 printed in some output formats).
444: Normalize the document after reading: merge adjacent
445 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
447`-p`, `--preserve-tabs`
449: Preserve tabs instead of converting them to spaces (the default).
450 Note that this will only affect tabs in literal code spans and code
451 blocks; tabs in regular text will be treated as spaces.
455: Specify the number of spaces per tab (default is 4).
457`--track-changes=accept`|`reject`|`all`
459: Specifies what to do with insertions, deletions, and comments
460 produced by the MS Word "Track Changes" feature. `accept` (the
461 default), inserts all insertions, and ignores all
462 deletions. `reject` inserts all deletions and ignores
463 insertions. Both `accept` and `reject` ignore comments. `all` puts
464 in insertions, deletions, and comments, wrapped in spans with
465 `insertion`, `deletion`, `comment-start`, and `comment-end`
466 classes, respectively. The author and time of change is
467 included. `all` is useful for scripting: only accepting changes
468 from a certain reviewer, say, or before a certain date. This
469 option only affects the docx reader.
471`--extract-media=`*DIR*
473: Extract images and other media contained in a docx or epub container
474 to the path *DIR*, creating it if necessary, and adjust the images
475 references in the document so they point to the extracted files.
476 This option only affects the docx and epub readers.
478[`pandocfilters`]: https://github.com/jgm/pandocfilters
479[PHP]: https://github.com/vinai/pandocfilters-php
480[perl]: https://metacpan.org/pod/Pandoc::Filter
481[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
483General writer options
484----------------------
488: Produce output with an appropriate header and footer (e.g. a
489 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
490 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
495: Use *FILE* as a custom template for the generated document. Implies
496 `--standalone`. See [Templates], below, for a description
497 of template syntax. If no extension is specified, an extension
498 corresponding to the writer will be added, so that `--template=special`
499 looks for `special.html` for HTML output. If the template is not
500 found, pandoc will search for it in the `templates` subdirectory of
501 the user data directory (see `--data-dir`). If this option is not used,
502 a default template appropriate for the output format will be used (see
503 `-D/--print-default-template`).
505`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
507: Set the template variable *KEY* to the value *VAL* when rendering the
508 document in standalone mode. This is generally only useful when the
509 `--template` option is used to specify a custom template, since
510 pandoc automatically sets the variables used in the default
511 templates. If no *VAL* is specified, the key will be given the
514`-D` *FORMAT*, `--print-default-template=`*FORMAT*
516: Print the system default template for an output *FORMAT*. (See `-t`
517 for a list of possible *FORMAT*s.) Templates in the user data
518 directory are ignored.
520`--print-default-data-file=`*FILE*
522: Print a system default data file. Files in the user data directory
526: Specify the dpi (dots per inch) value for conversion from pixels
527 to inch/centimeters and vice versa. The default is 96dpi.
528 Technically, the correct term would be ppi (pixels per inch).
530`--wrap=[auto|none|preserve]`
532: Determine how text is wrapped in the output (the source
533 code, not the rendered version). With `auto` (the default),
534 pandoc will attempt to wrap lines to the column width specified by
535 `--columns` (default 80). With `none`, pandoc will not wrap
536 lines at all. With `preserve`, pandoc will attempt to
537 preserve the wrapping from the source document (that is,
538 where there are nonsemantic newlines in the source, there
539 will be nonsemantic newlines in the output as well).
543: Deprecated synonym for `--wrap=none`.
547: Specify length of lines in characters. This affects text wrapping
548 in the generated source code (see `--wrap`). It also affects
549 calculation of column widths for plain text tables (see [Tables] below).
551`--toc`, `--table-of-contents`
553: Include an automatically generated table of contents (or, in
554 the case of `latex`, `context`, `docx`, and `rst`, an instruction to create
555 one) in the output document. This option has no effect on `man`,
556 `docbook`, `docbook5`, `slidy`, `slideous`, `s5`, or `odt` output.
558`--toc-depth=`*NUMBER*
560: Specify the number of section levels to include in the table
561 of contents. The default is 3 (which means that level 1, 2, and 3
562 headers will be listed in the contents).
566: Disables syntax highlighting for code blocks and inlines, even when
567 a language attribute is given.
569`--highlight-style=`*STYLE*
571: Specifies the coloring style to be used in highlighted source code.
572 Options are `pygments` (the default), `kate`, `monochrome`,
573 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
574 on syntax highlighting in pandoc, see [Syntax highlighting], below.
576`-H` *FILE*, `--include-in-header=`*FILE*
578: Include contents of *FILE*, verbatim, at the end of the header.
579 This can be used, for example, to include special
580 CSS or javascript in HTML documents. This option can be used
581 repeatedly to include multiple files in the header. They will be
582 included in the order specified. Implies `--standalone`.
584`-B` *FILE*, `--include-before-body=`*FILE*
586: Include contents of *FILE*, verbatim, at the beginning of the
587 document body (e.g. after the `<body>` tag in HTML, or the
588 `\begin{document}` command in LaTeX). This can be used to include
589 navigation bars or banners in HTML documents. This option can be
590 used repeatedly to include multiple files. They will be included in
591 the order specified. Implies `--standalone`.
593`-A` *FILE*, `--include-after-body=`*FILE*
595: Include contents of *FILE*, verbatim, at the end of the document
596 body (before the `</body>` tag in HTML, or the
597 `\end{document}` command in LaTeX). This option can be used
598 repeatedly to include multiple files. They will be included in the
599 order specified. Implies `--standalone`.
601Options affecting specific writers
602----------------------------------
606: Produce a standalone HTML file with no external dependencies, using
607 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
608 images, and videos. The resulting file should be "self-contained,"
609 in the sense that it needs no external files and no net access to be
610 displayed properly by a browser. This option works only with HTML output
611 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
612 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
613 stylesheets at absolute URLs will be downloaded; those at relative URLs
614 will be sought relative to the working directory (if the first source
615 file is local) or relative to the base URL (if the first source
616 file is remote). Limitation: resources that are loaded dynamically
617 through JavaScript cannot be incorporated; as a result, `--self-contained`
618 does not work with `--mathjax`, and some advanced features (e.g.
619 zoom or speaker notes) may not work in an offline "self-contained"
620 `reveal.js` slide show.
624: Use `<q>` tags for quotes in HTML.
628: Use only ascii characters in output. Currently supported only
629 for HTML output (which uses numerical entities instead of
630 UTF-8 when this option is selected).
634: Use reference-style links, rather than inline links, in writing Markdown
635 or reStructuredText. By default inline links are used.
639: Use ATX-style headers in Markdown and asciidoc output. The default is
640 to use setext-style headers for levels 1-2, and then ATX headers.
644: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
645 output. When the LaTeX document class is set to `report`, `book`,
646 or `memoir` (unless the `article` option is specified), this
647 option is implied. If `beamer` is the output format, top-level
648 headers will become `\part{..}`.
650`-N`, `--number-sections`
652: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
653 By default, sections are not numbered. Sections with class
654 `unnumbered` will never be numbered, even if `--number-sections`
657`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
659: Offset for section headings in HTML output (ignored in other
660 output formats). The first number is added to the section number for
661 top-level headers, the second for second-level headers, and so on.
662 So, for example, if you want the first top-level header in your
663 document to be numbered "6", specify `--number-offset=5`.
664 If your document starts with a level-2 header which you want to
665 be numbered "1.5", specify `--number-offset=1,4`.
666 Offsets are 0 by default. Implies `--number-sections`.
670: Do not use the TeX ligatures for quotation marks, apostrophes,
671 and dashes (`` `...' ``, ` ``..'' `, `--`, `---`) when
672 writing or reading LaTeX or ConTeXt. In reading LaTeX,
673 parse the characters `` ` ``, `'`, and `-` literally, rather
674 than parsing ligatures for quotation marks and dashes. In
675 writing LaTeX or ConTeXt, print unicode quotation mark and
676 dash characters literally, rather than converting them to
677 the standard ASCII TeX ligatures. Note: normally `--smart`
678 is selected automatically for LaTeX and ConTeXt output, but
679 it must be specified explicitly if `--no-tex-ligatures` is
680 selected. If you use literal curly quotes, dashes, and
681 ellipses in your source, then you may want to use
682 `--no-tex-ligatures` without `--smart`.
686: Use the [`listings`] package for LaTeX code blocks
690: Make list items in slide shows display incrementally (one by one).
691 The default is for lists to be displayed all at once.
693`--slide-level=`*NUMBER*
695: Specifies that headers with the specified level create
696 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
697 above this level in the hierarchy are used to divide the
698 slide show into sections; headers below this level create
699 subheads within a slide. The default is to set the slide level
700 based on the contents of the document; see
701 [Structuring the slide show].
705: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
706 and attach identifiers to the enclosing `<div>` (or `<section>`)
707 rather than the header itself. See
708 [Header identifiers], below.
710`--email-obfuscation=none`|`javascript`|`references`
712: Specify a method for obfuscating `mailto:` links in HTML documents.
713 `none` leaves `mailto:` links as they are. `javascript` obfuscates
714 them using javascript. `references` obfuscates them by printing their
715 letters as decimal or hexadecimal character references. The default
718`--id-prefix=`*STRING*
720: Specify a prefix to be added to all automatically generated identifiers
721 in HTML and DocBook output, and to footnote numbers in Markdown output.
722 This is useful for preventing duplicate identifiers when generating
723 fragments to be included in other pages.
725`-T` *STRING*, `--title-prefix=`*STRING*
727: Specify *STRING* as a prefix at the beginning of the title
728 that appears in the HTML header (but not in the title as it
729 appears at the beginning of the HTML body). Implies
732`-c` *URL*, `--css=`*URL*
734: Link to a CSS style sheet. This option can be used repeatedly to
735 include multiple files. They will be included in the order specified.
737`--reference-odt=`*FILE*
739: Use the specified file as a style reference in producing an ODT.
740 For best results, the reference ODT should be a modified version
741 of an ODT produced using pandoc. The contents of the reference ODT
742 are ignored, but its stylesheets are used in the new ODT. If no
743 reference ODT is specified on the command line, pandoc will look
744 for a file `reference.odt` in the user data directory (see
745 `--data-dir`). If this is not found either, sensible defaults will be
748`--reference-docx=`*FILE*
750: Use the specified file as a style reference in producing a docx file.
751 For best results, the reference docx should be a modified version
752 of a docx file produced using pandoc. The contents of the reference docx
753 are ignored, but its stylesheets and document properties (including
754 margins, page size, header, and footer) are used in the new docx. If no
755 reference docx is specified on the command line, pandoc will look
756 for a file `reference.docx` in the user data directory (see
757 `--data-dir`). If this is not found either, sensible defaults will be
758 used. The following styles are used by pandoc: [paragraph]
759 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
760 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
761 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
762 Definition, Caption, Table Caption, Image Caption, Figure,
763 Figure With Caption, TOC Heading;
764 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
765 Footnote Reference, Hyperlink; [table] Normal Table.
767`--epub-stylesheet=`*FILE*
769: Use the specified CSS file to style the EPUB. If no stylesheet
770 is specified, pandoc will look for a file `epub.css` in the
771 user data directory (see `--data-dir`). If it is not
772 found there, sensible defaults will be used.
774`--epub-cover-image=`*FILE*
776: Use the specified image as the EPUB cover. It is recommended
777 that the image be less than 1000px in width and height. Note that
778 in a Markdown source document you can also specify `cover-image`
779 in a YAML metadata block (see [EPUB Metadata], below).
781`--epub-metadata=`*FILE*
783: Look in the specified XML file for metadata for the EPUB.
784 The file should contain a series of [Dublin Core elements].
787 <dc:rights>Creative Commons</dc:rights>
788 <dc:language>es-AR</dc:language>
790 By default, pandoc will include the following metadata elements:
791 `<dc:title>` (from the document title), `<dc:creator>` (from the
792 document authors), `<dc:date>` (from the document date, which should
793 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
794 variable, or, if is not set, the locale), and `<dc:identifier
795 id="BookId">` (a randomly generated UUID). Any of these may be
796 overridden by elements in the metadata file.
798 Note: if the source document is Markdown, a YAML metadata block
799 in the document can be used instead. See below under
802`--epub-embed-font=`*FILE*
804: Embed the specified font in the EPUB. This option can be repeated
805 to embed multiple fonts. Wildcards can also be used: for example,
806 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
807 line, be sure to escape them or put the whole filename in single quotes,
808 to prevent them from being interpreted by the shell. To use the
809 embedded fonts, you will need to add declarations like the following
810 to your CSS (see `--epub-stylesheet`):
813 font-family: DejaVuSans;
816 src:url("DejaVuSans-Regular.ttf");
819 font-family: DejaVuSans;
822 src:url("DejaVuSans-Bold.ttf");
825 font-family: DejaVuSans;
828 src:url("DejaVuSans-Oblique.ttf");
831 font-family: DejaVuSans;
834 src:url("DejaVuSans-BoldOblique.ttf");
836 body { font-family: "DejaVuSans"; }
838`--epub-chapter-level=`*NUMBER*
840: Specify the header level at which to split the EPUB into separate
841 "chapter" files. The default is to split into chapters at level 1
842 headers. This option only affects the internal composition of the
843 EPUB, not the way chapters and sections are displayed to users. Some
844 readers may be slow if the chapter files are too large, so for large
845 documents with few level 1 headers, one might want to use a chapter
848`--latex-engine=pdflatex`|`lualatex`|`xelatex`
850: Use the specified LaTeX engine when producing PDF output.
851 The default is `pdflatex`. If the engine is not in your PATH,
852 the full path of the engine may be specified here.
854`--latex-engine-opt=`*STRING*
856: Use the given string as a command-line argument to the `latex-engine`.
857 If used multiple times, the arguments are provided with spaces between
858 them. Note that no check for duplicate options is done.
860[Dublin Core elements]: http://dublincore.org/documents/dces/
861[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
866`--bibliography=`*FILE*
868: Set the `bibliography` field in the document's metadata to *FILE*,
869 overriding any value set in the metadata, and process citations
870 using `pandoc-citeproc`. (This is equivalent to
871 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
872 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
873 used, making this equivalent to `--metadata bibliography=FILE`.
874 If you supply this argument multiple times, each *FILE* will be added
879: Set the `csl` field in the document's metadata to *FILE*,
880 overriding any value set in the metadata. (This is equivalent to
881 `--metadata csl=FILE`.)
882 This option is only relevant with `pandoc-citeproc`.
884`--citation-abbreviations=`*FILE*
886: Set the `citation-abbreviations` field in the document's metadata to
887 *FILE*, overriding any value set in the metadata. (This is equivalent to
888 `--metadata citation-abbreviations=FILE`.)
889 This option is only relevant with `pandoc-citeproc`.
893: Use [`natbib`] for citations in LaTeX output. This option is not for use
894 with the `pandoc-citeproc` filter or with PDF output. It is intended for
895 use in producing a LaTeX file that can be processed with [`bibtex`].
899: Use [`biblatex`] for citations in LaTeX output. This option is not for use
900 with the `pandoc-citeproc` filter or with PDF output. It is intended for
901 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
903Math rendering in HTML
904----------------------
906`-m` [*URL*], `--latexmathml`[`=`*URL*]
908: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
909 To insert a link to a local copy of the `LaTeXMathML.js` script,
910 provide a *URL*. If no *URL* is provided, the contents of the
911 script will be inserted directly into the HTML header, preserving
912 portability at the price of efficiency. If you plan to use math on
913 several pages, it is much better to link to a copy of the script,
918: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
919 In standalone `html` output, a small javascript (or a link to such a
920 script if a *URL* is supplied) will be inserted that allows the MathML to
921 be viewed on some browsers.
925: Use [jsMath] to display embedded TeX math in HTML output.
926 The *URL* should point to the jsMath load script (e.g.
927 `jsMath/easy/load.js`); if provided, it will be linked to in
928 the header of standalone HTML documents. If a *URL* is not provided,
929 no link to the jsMath load script will be inserted; it is then
930 up to the author to provide such a link in the HTML template.
934: Use [MathJax] to display embedded TeX math in HTML output.
935 The *URL* should point to the `MathJax.js` load script.
936 If a *URL* is not provided, a link to the MathJax CDN will
941: Enclose TeX math in `<eq>` tags in HTML output. These can then
942 be processed by [gladTeX] to produce links to images of the typeset
947: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
948 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
952: Render TeX formulas using an external script that converts TeX
953 formulas to images. The formula will be concatenated with the URL
954 provided. If *URL* is not specified, the Google Chart API will be used.
955 Note: the `--webtex` option will affect Markdown output
960: Use [KaTeX] to display embedded TeX math in HTML output.
961 The *URL* should point to the `katex.js` load script. If a *URL* is
962 not provided, a link to the KaTeX CDN will be inserted.
964`--katex-stylesheet=`*URL*
966: The *URL* should point to the `katex.css` stylesheet. If this option is
967 not specified, a link to the KaTeX CDN will be inserted. Note that this
968 option does not imply `--katex`.
970[MathML]: http://www.w3.org/Math/
971[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
972[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
973[MathJax]: https://www.mathjax.org
974[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
975[mimeTeX]: http://www.forkosh.com/mimetex.html
976[KaTeX]: https://github.com/Khan/KaTeX
978Options for wrapper scripts
979---------------------------
983: Print information about command-line arguments to *stdout*, then exit.
984 This option is intended primarily for use in wrapper scripts.
985 The first line of output contains the name of the output file specified
986 with the `-o` option, or `-` (for *stdout*) if no output file was
987 specified. The remaining lines contain the command-line arguments,
988 one per line, in the order they appear. These do not include regular
989 pandoc options and their arguments, but do include any options appearing
990 after a `--` separator at the end of the line.
994: Ignore command-line arguments (for use in wrapper scripts).
995 Regular pandoc options are not ignored. Thus, for example,
997 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1001 pandoc -o foo.html -s
1006When the `-s/--standalone` option is used, pandoc uses a template to
1007add header and footer material that is needed for a self-standing
1008document. To see the default template that is used, just type
1012where *FORMAT* is the name of the output format. A custom template
1013can be specified using the `--template` option. You can also override
1014the system default templates for a given output format *FORMAT*
1015by putting a file `templates/default.*FORMAT*` in the user data
1016directory (see `--data-dir`, above). *Exceptions:*
1018- For `odt` output, customize the `default.opendocument`
1020- For `pdf` output, customize the `default.latex` template
1021 (or the `default.beamer` template, if you use `-t beamer`,
1022 or the `default.context` template, if you use `-t context`).
1023- `docx` has no template (however, you can use
1024 `--reference-docx` to customize the output).
1026Templates contain *variables*, which allow for the inclusion of
1027arbitrary information at any point in the file. Variables may be set
1028within the document using [YAML metadata blocks][Extension:
1029`yaml_metadata_block`]. They may also be set at the
1030command line using the `-V/--variable` option: variables set in this
1031way override metadata fields with the same name.
1033Variables set by pandoc
1034-----------------------
1036Some variables are set automatically by pandoc. These vary somewhat
1037depending on the output format, but include metadata fields as well
1040`title`, `author`, `date`
1041: allow identification of basic aspects of the document. Included
1042 in PDF metadata through LaTeX and ConTeXt. These can be set
1043 through a [pandoc title block][Extension: `pandoc_title_block`],
1044 which allows for multiple authors, or through a YAML metadata block:
1053: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1054 renders in LaTeX only when using a document class that supports
1055 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1056 `scrreprt`, `scrbook`).[^subtitle]
1059: author affiliations (in LaTeX and Beamer only). Can be a
1060 list, when there are multiple authors.
1063: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1066: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1067 may be repeated as for `author`, above
1070: contents specified by `-H/--include-in-header` (may have multiple
1074: non-null value if `--toc/--table-of-contents` was specified
1077: title of table of contents (works only with EPUB and docx)
1080: contents specified by `-B/--include-before-body` (may have
1084: contents specified by `-A/--include-after-body` (may have
1091: JSON representation of all of the document's metadata
1093[^subtitle]: To make `subtitle` work with other LaTeX
1094 document classes, you can add the following to `header-includes`:
1096 \providecommand{\subtitle}[1]{%
1097 \usepackage{titling}
1099 \par\large#1\end{center}}
1106: identifies the main language of the document,
1107 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1108 For some output formats, pandoc will convert it to an appropriate
1109 format stored in the additional variables `babel-lang`,
1110 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1112 Native pandoc `span`s and `div`s with the lang attribute
1113 (value in BCP 47) can be used to switch the language in
1117: a list of other languages used in the document
1118 in the YAML metadata, according to [BCP 47]. For example:
1119 `otherlangs: [en-GB, fr]`.
1120 This is automatically generated from the `lang` attributes
1121 in all `span`s and `div`s but can be overridden.
1122 Currently only used by LaTeX through the generated
1123 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1124 The LaTeX writer outputs polyglossia commands in the text but
1125 the `babel-newcommands` variable contains mappings for them
1126 to the corresponding babel.
1129: the base direction of the document, either `rtl` (right-to-left)
1130 or `ltr` (left-to-right).
1132 For bidirectional documents, native pandoc `span`s and `div`s
1133 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1134 override the base direction in some output formats.
1135 This may not always be necessary if the final renderer
1136 (e.g. the browser, when generating HTML) supports the
1137 [Unicode Bidirectional Algorithm].
1139 When using LaTeX for bidirectional documents, only the `xelatex` engine
1140 is fully supported (use `--latex-engine=xelatex`).
1142[BCP 47]: https://tools.ietf.org/html/bcp47
1143[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1148Variables are available for [producing slide shows with pandoc],
1149including all [reveal.js configuration options].
1152: base URL for Slidy documents (defaults to
1153 `http://www.w3.org/Talks/Tools/Slidy2`)
1156: base URL for Slideous documents (defaults to `slideous`)
1159: base URL for S5 documents (defaults to `s5/default`)
1162: base URL for reveal.js documents (defaults to `reveal.js`)
1164`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1165: themes for LaTeX [`beamer`] documents
1168: controls navigation symbols in `beamer` documents
1169 (default is `empty` for no navigation symbols; other valid values
1170 are `frame`, `vertical`, and `horizontal`).
1173: enables on "title pages" for new sections in `beamer`
1174 documents (default = true).
1176[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1181LaTeX variables are used when [creating a PDF].
1184: paper size, e.g. `letter`, `A4`
1187: font size for body text (e.g. `10pt`, `12pt`)
1190: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1193: option for document class, e.g. `oneside`; may be repeated
1194 for multiple options
1197: option for [`geometry`] package, e.g. `margin=1in`;
1198 may be repeated for multiple options
1200`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1201: sets margins, if `geometry` is not used (otherwise `geometry`
1205: adjusts line spacing using the [`setspace`]
1206 package, e.g. `1.25`, `1.5`
1209: font package for use with `pdflatex`:
1210 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1211 The default is [Latin Modern][`lm`].
1214: options for package used as `fontfamily`: e.g. `osf,sc` with
1215 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1216 figures and true small caps; may be repeated for multiple options
1218`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1219: font families for use with `xelatex` or
1220 `lualatex`: take the name of any system font, using the
1221 [`fontspec`] package. Note that if `CJKmainfont` is used,
1222 the [`xecjk`] package must be available.
1224`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1225: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1226 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1227 available through [`fontspec`], such as the OpenType features
1228 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1231: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1232 default is `T1` (see guide to [LaTeX font encodings])
1235: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1236 `urlcolor`, or `toccolor` are set
1238`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1239: color for internal links, citation links, external links, and links in table of contents:
1240 uses any of the [predefined LaTeX colors]
1243: causes links to be printed as footnotes
1246: uses document class settings for indentation (the default LaTeX template
1247 otherwise removes indentation and adds space between paragraphs)
1250: disables default behavior of LaTeX template that redefines (sub)paragraphs
1251 as sections, changing the appearance of nested headings in some classes
1254: specifies contents of acknowledgments footnote after document title.
1257: include table of contents (can also be set using `--toc/--table-of-contents`)
1260: level of section to include in table of contents
1263: numbering depth for sections, if sections are numbered
1266: include list of figures, list of tables
1269: bibliography to use for resolving references
1272: bibliography style, when used with `--natbib` and
1276: list of options for biblatex.
1278[`article`]: https://ctan.org/pkg/article
1279[`report`]: https://ctan.org/pkg/report
1280[`book`]: https://ctan.org/pkg/book
1281[KOMA-Script]: https://ctan.org/pkg/koma-script
1282[`memoir`]: https://ctan.org/pkg/memoir
1283[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1284[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1285[`mathpazo`]: https://ctan.org/pkg/mathpazo
1286[LaTeX font encodings]: https://ctan.org/pkg/encguide
1288Variables for ConTeXt
1289---------------------
1292: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1293 may be repeated for multiple options
1296: options for page margins and text arrangement (see [ConTeXt Layout]);
1297 may be repeated for multiple options
1299`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1300: sets margins, if `layout` is not used (otherwise `layout`
1304: font size for body text (e.g. `10pt`, `12pt`)
1306`mainfont`, `sansfont`, `monofont`, `mathfont`
1307: font families: take the name of any system font (see [ConTeXt Font Switching])
1309`linkcolor`, `contrastcolor`
1310: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1313: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1316: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1317 may be repeated for multiple options
1320: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1323: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1324 may be repeated for multiple options
1326`headertext`, `footertext`
1327: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1328 may be repeated up to four times for different placement
1331: page number style and location (using [`setuppagenumbering`]);
1332 may be repeated for multiple options
1335: include table of contents (can also be set using `--toc/--table-of-contents`)
1338: include list of figures, list of tables
1340[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1341[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1342[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1343[ConTeXt Color]: http://wiki.contextgarden.net/Color
1344[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1345[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1346[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1347[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1348[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1350Variables for man pages
1351-----------------------
1354: section number in man pages
1357: header in man pages
1360: footer in man pages
1363: adjusts text to left (`l`), right (`r`), center (`c`),
1364 or both (`b`) margins
1367: if `true` (the default), hyphenation will be used
1369Using variables in templates
1370----------------------------
1372Variable names are sequences of alphanumerics, `-`, and `_`,
1373starting with a letter. A variable name surrounded by `$` signs
1374will be replaced by its value. For example, the string `$title$` in
1376 <title>$title$</title>
1378will be replaced by the document title.
1380To write a literal `$` in a template, use `$$`.
1382Templates may contain conditionals. The syntax is as follows:
1390This will include `X` in the template if `variable` has a non-null
1391value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1392any valid template text, and may include interpolated variables or other
1393conditionals. The `$else$` section may be omitted.
1395When variables can have multiple values (for example, `author` in
1396a multi-author document), you can use the `$for$` keyword:
1399 <meta name="author" content="$author$" />
1402You can optionally specify a separator to be used between
1405 $for(author)$$author$$sep$, $endfor$
1407A dot can be used to select a field of a variable that takes
1408an object as its value. So, for example:
1410 $author.name$ ($author.affiliation$)
1412If you use custom templates, you may need to revise them as pandoc
1413changes. We recommend tracking the changes in the default templates,
1414and modifying your custom templates accordingly. An easy way to do this
1415is to fork the [pandoc-templates] repository and merge in changes after each
1418[pandoc-templates]: https://github.com/jgm/pandoc-templates
1423Pandoc understands an extended and slightly revised version of
1424John Gruber's [Markdown] syntax. This document explains the syntax,
1425noting differences from standard Markdown. Except where noted, these
1426differences can be suppressed by using the `markdown_strict` format instead
1427of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1428to the format name and disabled by adding `-EXTENSION`. For example,
1429`markdown_strict+footnotes` is strict Markdown with footnotes
1430enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1431Markdown without footnotes or pipe tables.
1436Markdown is designed to be easy to write, and, even more importantly,
1439> A Markdown-formatted document should be publishable as-is, as plain
1440> text, without looking like it's been marked up with tags or formatting
1442> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1444This principle has guided pandoc's decisions in finding syntax for
1445tables, footnotes, and other extensions.
1447There is, however, one respect in which pandoc's aims are different
1448from the original aims of Markdown. Whereas Markdown was originally
1449designed with HTML generation in mind, pandoc is designed for multiple
1450output formats. Thus, while pandoc allows the embedding of raw HTML,
1451it discourages it, and provides other, non-HTMLish ways of representing
1452important document elements like definition lists, tables, mathematics, and
1458A paragraph is one or more lines of text followed by one or more blank lines.
1459Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1460If you need a hard line break, put two or more spaces at the end of a line.
1462#### Extension: `escaped_line_breaks` ####
1464A backslash followed by a newline is also a hard line break.
1465Note: in multiline and grid table cells, this is the only way
1466to create a hard line break, since trailing spaces in the cells
1472There are two kinds of headers: Setext and ATX.
1474### Setext-style headers ###
1476A setext-style header is a line of text "underlined" with a row of `=` signs
1477(for a level one header) or `-` signs (for a level two header):
1485The header text can contain inline formatting, such as emphasis (see
1486[Inline formatting], below).
1489### ATX-style headers ###
1491An ATX-style header consists of one to six `#` signs and a line of
1492text, optionally followed by any number of `#` signs. The number of
1493`#` signs at the beginning of the line is the header level:
1495 ## A level-two header
1497 ### A level-three header ###
1499As with setext-style headers, the header text can contain formatting:
1501 # A level-one header with a [link](/url) and *emphasis*
1503#### Extension: `blank_before_header` ####
1505Standard Markdown syntax does not require a blank line before a header.
1506Pandoc does require this (except, of course, at the beginning of the
1507document). The reason for the requirement is that it is all too easy for a
1508`#` to end up at the beginning of a line by accident (perhaps through line
1509wrapping). Consider, for example:
1511 I like several of their flavors of ice cream:
1512 #22, for example, and #5.
1515### Header identifiers ###
1517#### Extension: `header_attributes` ####
1519Headers can be assigned attributes using this syntax at the end
1520of the line containing the header text:
1522 {#identifier .class .class key=value key=value}
1524Thus, for example, the following headers will all be assigned the identifier
1529 ## My header ## {#foo}
1531 My other header {#foo}
1534(This syntax is compatible with [PHP Markdown Extra].)
1536Note that although this syntax allows assignment of classes and key/value
1537attributes, writers generally don't use all of this information. Identifiers,
1538classes, and key/value attributes are used in HTML and HTML-based formats such
1539as EPUB and slidy. Identifiers are used for labels and link anchors in the
1540LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1542Headers with the class `unnumbered` will not be numbered, even if
1543`--number-sections` is specified. A single hyphen (`-`) in an attribute
1544context is equivalent to `.unnumbered`, and preferable in non-English
1551 # My header {.unnumbered}
1553#### Extension: `auto_identifiers` ####
1555A header without an explicitly specified identifier will be
1556automatically assigned a unique identifier based on the header text.
1557To derive the identifier from the header text,
1559 - Remove all formatting, links, etc.
1560 - Remove all footnotes.
1561 - Remove all punctuation, except underscores, hyphens, and periods.
1562 - Replace all spaces and newlines with hyphens.
1563 - Convert all alphabetic characters to lowercase.
1564 - Remove everything up to the first letter (identifiers may
1565 not begin with a number or punctuation mark).
1566 - If nothing is left after this, use the identifier `section`.
1571 ------------------------------- ----------------------------
1572 `Header identifiers in HTML` `header-identifiers-in-html`
1573 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1574 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1575 `3. Applications` `applications`
1578These rules should, in most cases, allow one to determine the identifier
1579from the header text. The exception is when several headers have the
1580same text; in this case, the first will get an identifier as described
1581above; the second will get the same identifier with `-1` appended; the
1582third with `-2`; and so on.
1584These identifiers are used to provide link targets in the table of
1585contents generated by the `--toc|--table-of-contents` option. They
1586also make it easy to provide links from one section of a document to
1587another. A link to this section, for example, might look like this:
1590 [header identifiers](#header-identifiers-in-html-latex-and-context).
1592Note, however, that this method of providing links to sections works
1593only in HTML, LaTeX, and ConTeXt formats.
1595If the `--section-divs` option is specified, then each section will
1596be wrapped in a `div` (or a `section`, if `--html5` was specified),
1597and the identifier will be attached to the enclosing `<div>`
1598(or `<section>`) tag rather than the header itself. This allows entire
1599sections to be manipulated using javascript or treated differently in
1602#### Extension: `implicit_header_references` ####
1604Pandoc behaves as if reference links have been defined for each header.
1605So, to link to a header
1607 # Header identifiers in HTML
1611 [Header identifiers in HTML]
1615 [Header identifiers in HTML][]
1619 [the section on header identifiers][header identifiers in
1622instead of giving the identifier explicitly:
1624 [Header identifiers in HTML](#header-identifiers-in-html)
1626If there are multiple headers with identical text, the corresponding
1627reference will link to the first one only, and you will need to use explicit
1628links to link to the others, as described above.
1630Like regular reference links, these references are case-insensitive.
1632Explicit link reference definitions always take priority over
1633implicit header references. So, in the following example, the
1634link will point to `bar`, not to `#foo`:
1645Markdown uses email conventions for quoting blocks of text.
1646A block quotation is one or more paragraphs or other block elements
1647(such as lists or headers), with each line preceded by a `>` character
1648and an optional space. (The `>` need not start at the left margin, but
1649it should not be indented more than three spaces.)
1651 > This is a block quote. This
1652 > paragraph has two lines.
1654 > 1. This is a list inside a block quote.
1657A "lazy" form, which requires the `>` character only on the first
1658line of each block, is also allowed:
1660 > This is a block quote. This
1661 paragraph has two lines.
1663 > 1. This is a list inside a block quote.
1666Among the block elements that can be contained in a block quote are
1667other block quotes. That is, block quotes can be nested:
1669 > This is a block quote.
1671 > > A block quote within a block quote.
1673If the `>` character is followed by an optional space, that space
1674will be considered part of the block quote marker and not part of
1675the indentation of the contents. Thus, to put an indented code
1676block in a block quote, you need five spaces after the `>`:
1680#### Extension: `blank_before_blockquote` ####
1682Standard Markdown syntax does not require a blank line before a block
1683quote. Pandoc does require this (except, of course, at the beginning of the
1684document). The reason for the requirement is that it is all too easy for a
1685`>` to end up at the beginning of a line by accident (perhaps through line
1686wrapping). So, unless the `markdown_strict` format is used, the following does
1687not produce a nested block quote in pandoc:
1689 > This is a block quote.
1693Verbatim (code) blocks
1694----------------------
1696### Indented code blocks ###
1698A block of text indented four spaces (or one tab) is treated as verbatim
1699text: that is, special characters do not trigger special formatting,
1700and all spaces and line breaks are preserved. For example,
1703 moveShip(5 * gravity, DOWN);
1706The initial (four space or one tab) indentation is not considered part
1707of the verbatim text, and is removed in the output.
1709Note: blank lines in the verbatim text need not begin with four spaces.
1712### Fenced code blocks ###
1714#### Extension: `fenced_code_blocks` ####
1716In addition to standard indented code blocks, pandoc supports
1717*fenced* code blocks. These begin with a row of three or more
1718tildes (`~`) and end with a row of tildes that must be at least as long as
1719the starting row. Everything between these lines is treated as code. No
1720indentation is necessary:
1724 moveShip(5 * gravity, DOWN);
1728Like regular code blocks, fenced code blocks must be separated
1729from surrounding text by blank lines.
1731If the code itself contains a row of tildes or backticks, just use a longer
1732row of tildes or backticks at the start and end:
1736 code including tildes
1740#### Extension: `backtick_code_blocks` ####
1742Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1745#### Extension: `fenced_code_attributes` ####
1747Optionally, you may attach attributes to fenced or backtick code block using
1750 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1752 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1753 qsort (filter (>= x) xs)
1754 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1756Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1757`startFrom` is an attribute with value `100`. Some output formats can use this
1758information to do syntax highlighting. Currently, the only output formats
1759that uses this information are HTML and LaTeX. If highlighting is supported
1760for your output format and language, then the code block above will appear
1761highlighted, with numbered lines. (To see which languages are supported, do
1762`pandoc --version`.) Otherwise, the code block above will appear as follows:
1764 <pre id="mycode" class="haskell numberLines" startFrom="100">
1770A shortcut form can also be used for specifying the language of
1777This is equivalent to:
1783If the `fenced_code_attributes` extension is disabled, but
1784input contains class attribute(s) for the codeblock, the first
1785class attribute will be printed after the opening fence as a bare
1788To prevent all highlighting, use the `--no-highlight` flag.
1789To set the highlighting style, use `--highlight-style`.
1790For more information on highlighting, see [Syntax highlighting],
1796#### Extension: `line_blocks` ####
1798A line block is a sequence of lines beginning with a vertical bar (`|`)
1799followed by a space. The division into lines will be preserved in
1800the output, as will any leading spaces; otherwise, the lines will
1801be formatted as Markdown. This is useful for verse and addresses:
1803 | The limerick packs laughs anatomical
1804 | In space that is quite economical.
1805 | But the good ones I've seen
1806 | So seldom are clean
1807 | And the clean ones so seldom are comical
1810 | Berkeley, CA 94718
1812The lines can be hard-wrapped if needed, but the continuation
1813line must begin with a space.
1815 | The Right Honorable Most Venerable and Righteous Samuel L.
1818 | Berkeley, CA 94718
1820This syntax is borrowed from [reStructuredText].
1827A bullet list is a list of bulleted list items. A bulleted list
1828item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1835This will produce a "compact" list. If you want a "loose" list, in which
1836each item is formatted as a paragraph, put spaces between the items:
1844The bullets need not be flush with the left margin; they may be
1845indented one, two, or three spaces. The bullet must be followed
1848List items look best if subsequent lines are flush with the first
1849line (after the bullet):
1855But Markdown also allows a "lazy" format:
1861### The four-space rule ###
1863A list item may contain multiple paragraphs and other block-level
1864content. However, subsequent paragraphs must be preceded by a blank line
1865and indented four spaces or a tab. The list will look better if the first
1866paragraph is aligned with the rest:
1872 * Second paragraph. With a code block, which must be indented
1877List items may include other lists. In this case the preceding blank
1878line is optional. The nested list must be indented four spaces or
1891As noted above, Markdown allows you to write list items "lazily," instead of
1892indenting continuation lines. However, if there are multiple paragraphs or
1893other blocks in a list item, the first line of each must be indented.
1895 + A lazy, lazy, list
1898 + Another one; this looks
1901 Second paragraph of second
1904**Note:** Although the four-space rule for continuation paragraphs
1905comes from the official [Markdown syntax guide], the reference implementation,
1906`Markdown.pl`, does not follow it. So pandoc will give different results than
1907`Markdown.pl` when authors have indented continuation paragraphs fewer than
1910The [Markdown syntax guide] is not explicit whether the four-space
1911rule applies to *all* block-level content in a list item; it only
1912mentions paragraphs and code blocks. But it implies that the rule
1913applies to all block-level content (including nested lists), and
1914pandoc interprets it that way.
1916 [Markdown syntax guide]:
1917 http://daringfireball.net/projects/markdown/syntax#list
1919### Ordered lists ###
1921Ordered lists work just like bulleted lists, except that the items
1922begin with enumerators rather than bullets.
1924In standard Markdown, enumerators are decimal numbers followed
1925by a period and a space. The numbers themselves are ignored, so
1926there is no difference between this list:
1938#### Extension: `fancy_lists` ####
1940Unlike standard Markdown, pandoc allows ordered list items to be marked
1941with uppercase and lowercase letters and roman numerals, in addition to
1942arabic numerals. List markers may be enclosed in parentheses or followed by a
1943single right-parentheses or period. They must be separated from the
1944text that follows by at least one space, and, if the list marker is a
1945capital letter with a period, by at least two spaces.[^2]
1947[^2]: The point of this rule is to ensure that normal paragraphs
1948 starting with people's initials, like
1950 B. Russell was an English philosopher.
1952 do not get treated as list items.
1954 This rule will not prevent
1958 from being interpreted as a list item. In this case, a backslash
1963The `fancy_lists` extension also allows '`#`' to be used as an
1964ordered list marker in place of a numeral:
1969#### Extension: `startnum` ####
1971Pandoc also pays attention to the type of list marker used, and to the
1972starting number, and both of these are preserved where possible in the
1973output format. Thus, the following yields a list with numbers followed
1974by a single parenthesis, starting with 9, and a sublist with lowercase
1984Pandoc will start a new list each time a different type of list
1985marker is used. So, the following will create three lists:
1992If default list markers are desired, use `#.`:
1999### Definition lists ###
2001#### Extension: `definition_lists` ####
2003Pandoc supports definition lists, using the syntax of
2004[PHP Markdown Extra] with some extensions.[^3]
2010 Term 2 with *inline markup*
2014 { some code, part of Definition 2 }
2016 Third paragraph of definition 2.
2018Each term must fit on one line, which may optionally be followed by
2019a blank line, and must be followed by one or more definitions.
2020A definition begins with a colon or tilde, which may be indented one
2023A term may have multiple definitions, and each definition may consist of one or
2024more block elements (paragraph, code block, list, etc.), each indented four
2025spaces or one tab stop. The body of the definition (including the first line,
2026aside from the colon or tilde) should be indented four spaces. However,
2027as with other Markdown lists, you can "lazily" omit indentation except
2028at the beginning of a paragraph or other block element:
2033 with lazy continuation.
2035 Second paragraph of the definition.
2037If you leave space before the definition (as in the example above),
2038the text of the definition will be treated as a paragraph. In some
2039output formats, this will mean greater spacing between term/definition
2040pairs. For a more compact definition list, omit the space before the
2050Note that space between items in a definition list is required.
2051(A variant that loosens this requirement, but disallows "lazy"
2052hard wrapping, can be activated with `compact_definition_lists`: see
2053[Non-pandoc extensions], below.)
2055[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2057### Numbered example lists ###
2059#### Extension: `example_lists` ####
2061The special list marker `@` can be used for sequentially numbered
2062examples. The first list item with a `@` marker will be numbered '1',
2063the next '2', and so on, throughout the document. The numbered examples
2064need not occur in a single list; each new list using `@` will take up
2065where the last stopped. So, for example:
2067 (@) My first example will be numbered (1).
2068 (@) My second example will be numbered (2).
2070 Explanation of examples.
2072 (@) My third example will be numbered (3).
2074Numbered examples can be labeled and referred to elsewhere in the
2077 (@good) This is a good example.
2079 As (@good) illustrates, ...
2081The label can be any string of alphanumeric characters, underscores,
2085### Compact and loose lists ###
2087Pandoc behaves differently from `Markdown.pl` on some "edge
2088cases" involving lists. Consider this source:
2098Pandoc transforms this into a "compact list" (with no `<p>` tags around
2099"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2100"Second" and "Third" (but not "First"), because of the blank space
2101around "Third". Pandoc follows a simple rule: if the text is followed by
2102a blank line, it is treated as a paragraph. Since "Second" is followed
2103by a list, and not a blank line, it isn't treated as a paragraph. The
2104fact that the list is followed by a blank line is irrelevant. (Note:
2105Pandoc works this way even when the `markdown_strict` format is specified. This
2106behavior is consistent with the official Markdown syntax description,
2107even though it is different from that of `Markdown.pl`.)
2110### Ending a list ###
2112What if you want to put an indented code block after a list?
2119Trouble! Here pandoc (like other Markdown implementations) will treat
2120`{ my code block }` as the second paragraph of item two, and not as
2123To "cut off" the list after item two, you can insert some non-indented
2124content, like an HTML comment, which won't produce visible output in
2130 <!-- end of list -->
2134You can use the same trick if you want two consecutive lists instead
2150A line containing a row of three or more `*`, `-`, or `_` characters
2151(optionally separated by spaces) produces a horizontal rule:
2161Four kinds of tables may be used. The first three kinds presuppose the use of
2162a fixed-width font, such as Courier. The fourth kind can be used with
2163proportionally spaced fonts, as it does not require lining up columns.
2165#### Extension: `table_captions` ####
2167A caption may optionally be provided with all 4 kinds of tables (as
2168illustrated in the examples below). A caption is a paragraph beginning
2169with the string `Table:` (or just `:`), which will be stripped off.
2170It may appear either before or after the table.
2172#### Extension: `simple_tables` ####
2174Simple tables look like this:
2176 Right Left Center Default
2177 ------- ------ ---------- -------
2182 Table: Demonstration of simple table syntax.
2184The headers and table rows must each fit on one line. Column
2185alignments are determined by the position of the header text relative
2186to the dashed line below it:[^4]
2188 - If the dashed line is flush with the header text on the right side
2189 but extends beyond it on the left, the column is right-aligned.
2190 - If the dashed line is flush with the header text on the left side
2191 but extends beyond it on the right, the column is left-aligned.
2192 - If the dashed line extends beyond the header text on both sides,
2193 the column is centered.
2194 - If the dashed line is flush with the header text on both sides,
2195 the default alignment is used (in most cases, this will be left).
2197[^4]: This scheme is due to Michel Fortin, who proposed it on the
2198 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2200The table must end with a blank line, or a line of dashes followed by
2203The column headers may be omitted, provided a dashed line is used
2204to end the table. For example:
2206 ------- ------ ---------- -------
2210 ------- ------ ---------- -------
2212When headers are omitted, column alignments are determined on the basis
2213of the first line of the table body. So, in the tables above, the columns
2214would be right, left, center, and right aligned, respectively.
2216#### Extension: `multiline_tables` ####
2218Multiline tables allow headers and table rows to span multiple lines
2219of text (but cells that span multiple columns or rows of the table are
2220not supported). Here is an example:
2222 -------------------------------------------------------------
2223 Centered Default Right Left
2224 Header Aligned Aligned Aligned
2225 ----------- ------- --------------- -------------------------
2226 First row 12.0 Example of a row that
2227 spans multiple lines.
2229 Second row 5.0 Here's another one. Note
2230 the blank line between
2232 -------------------------------------------------------------
2234 Table: Here's the caption. It, too, may span
2237These work like simple tables, but with the following differences:
2239 - They must begin with a row of dashes, before the header text
2240 (unless the headers are omitted).
2241 - They must end with a row of dashes, then a blank line.
2242 - The rows must be separated by blank lines.
2244In multiline tables, the table parser pays attention to the widths of
2245the columns, and the writers try to reproduce these relative widths in
2246the output. So, if you find that one of the columns is too narrow in the
2247output, try widening it in the Markdown source.
2249Headers may be omitted in multiline tables as well as simple tables:
2251 ----------- ------- --------------- -------------------------
2252 First row 12.0 Example of a row that
2253 spans multiple lines.
2255 Second row 5.0 Here's another one. Note
2256 the blank line between
2258 ----------- ------- --------------- -------------------------
2260 : Here's a multiline table without headers.
2262It is possible for a multiline table to have just one row, but the row
2263should be followed by a blank line (and then the row of dashes that ends
2264the table), or the table may be interpreted as a simple table.
2266#### Extension: `grid_tables` ####
2268Grid tables look like this:
2270 : Sample grid table.
2272 +---------------+---------------+--------------------+
2273 | Fruit | Price | Advantages |
2274 +===============+===============+====================+
2275 | Bananas | $1.34 | - built-in wrapper |
2276 | | | - bright color |
2277 +---------------+---------------+--------------------+
2278 | Oranges | $2.10 | - cures scurvy |
2280 +---------------+---------------+--------------------+
2282The row of `=`s separates the header from the table body, and can be
2283omitted for a headerless table. The cells of grid tables may contain
2284arbitrary block elements (multiple paragraphs, code blocks, lists,
2285etc.). Alignments are not supported, nor are cells that span multiple
2286columns or rows. Grid tables can be created easily using [Emacs table mode].
2288[Emacs table mode]: http://table.sourceforge.net/
2290#### Extension: `pipe_tables` ####
2292Pipe tables look like this:
2294 | Right | Left | Default | Center |
2295 |------:|:-----|---------|:------:|
2296 | 12 | 12 | 12 | 12 |
2297 | 123 | 123 | 123 | 123 |
2300 : Demonstration of pipe table syntax.
2302The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2303ending pipe characters are optional, but pipes are required between all
2304columns. The colons indicate column alignment as shown. The header
2305cannot be omitted. To simulate a headerless table, include a header
2308Since the pipes indicate column boundaries, columns need not be vertically
2309aligned, as they are in the above example. So, this is a perfectly
2310legal (though ugly) pipe table:
2318The cells of pipe tables cannot contain block elements like paragraphs
2319and lists, and cannot span multiple lines. If a pipe table contains a
2320row whose printable content is wider than the column width (see
2321`--columns`), then the cell contents will wrap, with the
2322relative cell widths determined by the widths of the separator
2325Note: pandoc also recognizes pipe tables of the following
2326form, as can be produced by Emacs' orgtbl-mode:
2333The difference is that `+` is used instead of `|`. Other orgtbl features
2334are not supported. In particular, to get non-default column alignment,
2335you'll need to add colons as above.
2337[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2342#### Extension: `pandoc_title_block` ####
2344If the file begins with a title block
2347 % author(s) (separated by semicolons)
2350it will be parsed as bibliographic information, not regular text. (It
2351will be used, for example, in the title of standalone LaTeX or HTML
2352output.) The block may contain just a title, a title and an author,
2353or all three elements. If you want to include an author but no
2354title, or a title and a date but no author, you need a blank line:
2363The title may occupy multiple lines, but continuation lines must
2364begin with leading space, thus:
2369If a document has multiple authors, the authors may be put on
2370separate lines with leading space, or separated by semicolons, or
2371both. So, all of the following are equivalent:
2376 % Author One; Author Two
2381The date must fit on one line.
2383All three metadata fields may contain standard inline formatting
2384(italics, links, footnotes, etc.).
2386Title blocks will always be parsed, but they will affect the output only
2387when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2388will appear twice: once in the document head -- this is the title that
2389will appear at the top of the window in a browser -- and once at the
2390beginning of the document body. The title in the document head can have
2391an optional prefix attached (`--title-prefix` or `-T` option). The title
2392in the body appears as an H1 element with class "title", so it can be
2393suppressed or reformatted with CSS. If a title prefix is specified with
2394`-T` and no title block appears in the document, the title prefix will
2395be used by itself as the HTML title.
2397The man page writer extracts a title, man page section number, and
2398other header and footer information from the title line. The title
2399is assumed to be the first word on the title line, which may optionally
2400end with a (single-digit) section number in parentheses. (There should
2401be no space between the title and the parentheses.) Anything after
2402this is assumed to be additional footer and header text. A single pipe
2403character (`|`) should be used to separate the footer text from the header
2408will yield a man page with the title `PANDOC` and section 1.
2410 % PANDOC(1) Pandoc User Manuals
2412will also have "Pandoc User Manuals" in the footer.
2414 % PANDOC(1) Pandoc User Manuals | Version 4.0
2416will also have "Version 4.0" in the header.
2418#### Extension: `yaml_metadata_block` ####
2420A YAML metadata block is a valid YAML object, delimited by a line of three
2421hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2422(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2423document, but if it is not at the beginning, it must be preceded by a blank
2424line. (Note that, because of the way pandoc concatenates input files when
2425several are provided, you may also keep the metadata in a separate YAML file
2426and pass it to pandoc as an argument, along with your Markdown files:
2428 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2430Just be sure that the YAML file begins with `---` and ends with `---` or
2433Metadata will be taken from the fields of the YAML object and added to any
2434existing document metadata. Metadata can contain lists and objects (nested
2435arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2436with names ending in an underscore will be ignored by pandoc. (They may be
2437given a role by external processors.)
2439A document may contain multiple metadata blocks. The metadata fields will
2440be combined through a *left-biased union*: if two metadata blocks attempt
2441to set the same field, the value from the first block will be taken.
2443When pandoc is used with `-t markdown` to create a Markdown document,
2444a YAML metadata block will be produced only if the `-s/--standalone`
2445option is used. All of the metadata will appear in a single block
2446at the beginning of the document.
2448Note that YAML escaping rules must be followed. Thus, for example,
2449if a title contains a colon, it must be quoted. The pipe character
2450(`|`) can be used to begin an indented block that will be interpreted
2451literally, without need for escaping. This form is necessary
2452when the field contains blank lines:
2455 title: 'This is the title: it contains a colon'
2458 affiliation: University of Somewhere
2460 affiliation: University of Nowhere
2461 tags: [nothing, nothingness]
2463 This is the abstract.
2465 It consists of two paragraphs.
2468Template variables will be set automatically from the metadata. Thus, for
2469example, in writing HTML, the variable `abstract` will be set to the HTML
2470equivalent of the Markdown in the `abstract` field:
2472 <p>This is the abstract.</p>
2473 <p>It consists of two paragraphs.</p>
2475Note: The `author` variable in the default templates expects a simple list or
2476string. To use the structured authors in the example, you would need a
2477custom template. For example:
2481 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2491#### Extension: `all_symbols_escapable` ####
2493Except inside a code block or inline code, any punctuation or space
2494character preceded by a backslash will be treated literally, even if it
2495would normally indicate formatting. Thus, for example, if one writes
2505 <strong>hello</strong>
2507This rule is easier to remember than standard Markdown's rule,
2508which allows only the following characters to be backslash-escaped:
2512(However, if the `markdown_strict` format is used, the standard Markdown rule
2515A backslash-escaped space is parsed as a nonbreaking space. It will
2516appear in TeX output as `~` and in HTML and XML as `\ ` or
2519A backslash-escaped newline (i.e. a backslash occurring at the end of
2520a line) is parsed as a hard line break. It will appear in TeX output as
2521`\\` and in HTML as `<br />`. This is a nice alternative to
2522Markdown's "invisible" way of indicating hard line breaks using
2523two trailing spaces on a line.
2525Backslash escapes do not work in verbatim contexts.
2532If the `--smart` option is specified, pandoc will produce typographically
2533correct output, converting straight quotes to curly quotes, `---` to
2534em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2535are inserted after certain abbreviations, such as "Mr."
2537Note: if your LaTeX template or any included header file call for the
2538[`csquotes`] package, pandoc will detect this automatically and use
2539`\enquote{...}` for quoted text.
2546To *emphasize* some text, surround it with `*`s or `_`, like this:
2548 This text is _emphasized with underscores_, and this
2549 is *emphasized with asterisks*.
2551Double `*` or `_` produces **strong emphasis**:
2553 This is **strong emphasis** and __with underscores__.
2555A `*` or `_` character surrounded by spaces, or backslash-escaped,
2556will not trigger emphasis:
2558 This is * not emphasized *, and \*neither is this\*.
2560#### Extension: `intraword_underscores` ####
2562Because `_` is sometimes used inside words and identifiers,
2563pandoc does not interpret a `_` surrounded by alphanumeric
2564characters as an emphasis marker. If you want to emphasize
2565just part of a word, use `*`:
2567 feas*ible*, not feas*able*.
2572#### Extension: `strikeout` ####
2574To strikeout a section of text with a horizontal line, begin and end it
2575with `~~`. Thus, for example,
2577 This ~~is deleted text.~~
2580### Superscripts and subscripts ###
2582#### Extension: `superscript`, `subscript` ####
2584Superscripts may be written by surrounding the superscripted text by `^`
2585characters; subscripts may be written by surrounding the subscripted
2586text by `~` characters. Thus, for example,
2588 H~2~O is a liquid. 2^10^ is 1024.
2590If the superscripted or subscripted text contains spaces, these spaces
2591must be escaped with backslashes. (This is to prevent accidental
2592superscripting and subscripting through the ordinary use of `~` and `^`.)
2593Thus, if you want the letter P with 'a cat' in subscripts, use
2594`P~a\ cat~`, not `P~a cat~`.
2599To make a short span of text verbatim, put it inside backticks:
2601 What is the difference between `>>=` and `>>`?
2603If the verbatim text includes a backtick, use double backticks:
2605 Here is a literal backtick `` ` ``.
2607(The spaces after the opening backticks and before the closing
2608backticks will be ignored.)
2610The general rule is that a verbatim span starts with a string
2611of consecutive backticks (optionally followed by a space)
2612and ends with a string of the same number of backticks (optionally
2613preceded by a space).
2615Note that backslash-escapes (and other Markdown constructs) do not
2616work in verbatim contexts:
2618 This is a backslash followed by an asterisk: `\*`.
2620#### Extension: `inline_code_attributes` ####
2622Attributes can be attached to verbatim text, just as with
2623[fenced code blocks]:
2629To write small caps, you can use an HTML span tag:
2631 <span style="font-variant:small-caps;">Small caps</span>
2633(The semicolon is optional and there may be space after the
2634colon.) This will work in all output formats that support small caps.
2639#### Extension: `tex_math_dollars` ####
2641Anything between two `$` characters will be treated as TeX math. The
2642opening `$` must have a non-space character immediately to its right,
2643while the closing `$` must have a non-space character immediately to its
2644left, and must not be followed immediately by a digit. Thus,
2645`$20,000 and $30,000` won't parse as math. If for some reason
2646you need to enclose text in literal `$` characters, backslash-escape
2647them and they won't be treated as math delimiters.
2649TeX math will be printed in all output formats. How it is rendered
2650depends on the output format:
2652Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2653 ~ It will appear verbatim between `$` characters.
2656 ~ It will be rendered using an [interpreted text role `:math:`].
2659 ~ It will be rendered as `latexmath:[...]`.
2662 ~ It will be rendered inside a `@math` command.
2665 ~ It will be rendered verbatim without `$`'s.
2668 ~ It will be rendered inside `<math>` tags.
2671 ~ It will be rendered inside `<span class="math">` tags.
2673RTF, OpenDocument, ODT
2674 ~ It will be rendered, if possible, using unicode characters,
2675 and will otherwise appear verbatim.
2678 ~ If the `--mathml` flag is used, it will be rendered using MathML
2679 in an `inlineequation` or `informalequation` tag. Otherwise it
2680 will be rendered, if possible, using unicode characters.
2683 ~ It will be rendered using OMML math markup.
2686 ~ If the `--webtex` option is used, formulas are rendered as images
2687 using Google Charts or other compatible web service, downloaded
2688 and embedded in the e-book. Otherwise, they will appear verbatim.
2690HTML, Slidy, DZSlides, S5, EPUB
2691 ~ The way math is rendered in HTML will depend on the
2692 command-line options selected:
2694 1. The default is to render TeX math as far as possible using unicode
2695 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2696 are put inside a `span` with `class="math"`, so that they may be
2697 styled differently from the surrounding text if needed.
2699 2. If the `--latexmathml` option is used, TeX math will be displayed
2700 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2701 The [LaTeXMathML] script will be used to render it as formulas.
2702 (This trick does not work in all browsers, but it works in Firefox.
2703 In browsers that do not support LaTeXMathML, TeX math will appear
2704 verbatim between `$` characters.)
2706 3. If the `--jsmath` option is used, TeX math will be put inside
2707 `<span>` tags (for inline math) or `<div>` tags (for display math)
2708 with class `math`. The [jsMath] script will be used to render
2711 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2712 be called to generate images for each TeX formula. This should
2713 work in all browsers. The `--mimetex` option takes an optional URL
2714 as argument. If no URL is specified, it will be assumed that the
2715 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2717 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2718 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2719 be processed by [gladTeX], which will produce image files for each
2720 formula and an HTML file with links to these images. So, the
2723 pandoc -s --gladtex myfile.txt -o myfile.htex
2724 gladtex -d myfile-images myfile.htex
2725 # produces myfile.html and images in myfile-images
2727 6. If the `--webtex` option is used, TeX formulas will be converted
2728 to `<img>` tags that link to an external script that converts
2729 formulas to images. The formula will be URL-encoded and concatenated
2730 with the URL provided. If no URL is specified, the Google Chart
2731 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).
2733 7. If the `--mathjax` option is used, TeX math will be displayed
2734 between `\(...\)` (for inline math) or `\[...\]` (for display
2735 math) and put in `<span>` tags with class `math`.
2736 The [MathJax] script will be used to render it as formulas.
2738[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2743#### Extension: `raw_html` ####
2745Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2746(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2747literally). (Technically this is not an extension, since standard
2748Markdown allows it, but it has been made an extension so that it can
2749be disabled if desired.)
2751The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2752DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
2755#### Extension: `markdown_in_html_blocks` ####
2757Standard Markdown allows you to include HTML "blocks": blocks
2758of HTML between balanced tags that are separated from the surrounding text
2759with blank lines, and start and end at the left margin. Within
2760these blocks, everything is interpreted as HTML, not Markdown;
2761so (for example), `*` does not signify emphasis.
2763Pandoc behaves this way when the `markdown_strict` format is used; but
2764by default, pandoc interprets material between HTML block tags as Markdown.
2765Thus, for example, pandoc will turn
2770 <td>[a link](http://google.com)</td>
2778 <td><em>one</em></td>
2779 <td><a href="http://google.com">a link</a></td>
2783whereas `Markdown.pl` will preserve it as is.
2785There is one exception to this rule: text between `<script>` and
2786`<style>` tags is not interpreted as Markdown.
2788This departure from standard Markdown should make it easier to mix
2789Markdown with HTML block elements. For example, one can surround
2790a block of Markdown text with `<div>` tags without preventing it
2791from being interpreted as Markdown.
2793#### Extension: `native_divs` ####
2795Use native pandoc `Div` blocks for content inside `<div>` tags.
2796For the most part this should give the same output as
2797`markdown_in_html_blocks`, but it makes it easier to write pandoc
2798filters to manipulate groups of blocks.
2800#### Extension: `native_spans` ####
2802Use native pandoc `Span` blocks for content inside `<span>` tags.
2803For the most part this should give the same output as `raw_html`,
2804but it makes it easier to write pandoc filters to manipulate groups
2810#### Extension: `raw_tex` ####
2812In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2813included in a document. Inline TeX commands will be preserved and passed
2814unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2815LaTeX to include BibTeX citations:
2817 This result was proved in \cite{jones.1967}.
2819Note that in LaTeX environments, like
2821 \begin{tabular}{|l|l|}\hline
2822 Age & Frequency \\ \hline
2825 36--45 & 22 \\ \hline
2828the material between the begin and end tags will be interpreted as raw
2829LaTeX, not as Markdown.
2831Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2832Emacs Org mode, and ConTeXt.
2837#### Extension: `latex_macros` ####
2839For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2840`\renewcommand` definitions and apply the resulting macros to all LaTeX
2841math. So, for example, the following will work in all output formats,
2844 \newcommand{\tuple}[1]{\langle #1 \rangle}
2848In LaTeX output, the `\newcommand` definition will simply be passed
2849unchanged to the output.
2855Markdown allows links to be specified in several ways.
2857### Automatic links ###
2859If you enclose a URL or email address in pointy brackets, it
2863 <sam@green.eggs.ham>
2867An inline link consists of the link text in square brackets,
2868followed by the URL in parentheses. (Optionally, the URL can
2869be followed by a link title, in quotes.)
2871 This is an [inline link](/url), and here's [one with
2872 a title](http://fsf.org "click here for a good time!").
2874There can be no space between the bracketed part and the parenthesized part.
2875The link text can contain formatting (such as emphasis), but the title cannot.
2877Email addresses in inline links are not autodetected, so they have to be
2878prefixed with `mailto`:
2880 [Write me!](mailto:sam@green.eggs.ham)
2882### Reference links ###
2884An *explicit* reference link has two parts, the link itself and the link
2885definition, which may occur elsewhere in the document (either
2886before or after the link).
2888The link consists of link text in square brackets, followed by a label in
2889square brackets. (There can be space between the two.) The link definition
2890consists of the bracketed label, followed by a colon and a space, followed by
2891the URL, and optionally (after a space) a link title either in quotes or in
2892parentheses. The label must not be parseable as a citation (assuming
2893the `citations` extension is enabled): citations take precedence over
2896Here are some examples:
2898 [my label 1]: /foo/bar.html "My title, optional"
2900 [my label 3]: http://fsf.org (The free software foundation)
2901 [my label 4]: /bar#special 'A title in single quotes'
2903The URL may optionally be surrounded by angle brackets:
2905 [my label 5]: <http://foo.bar.baz>
2907The title may go on the next line:
2909 [my label 3]: http://fsf.org
2910 "The free software foundation"
2912Note that link labels are not case sensitive. So, this will work:
2914 Here is [my link][FOO]
2918In an *implicit* reference link, the second pair of brackets is
2923 [my website]: http://foo.bar.baz
2925Note: In `Markdown.pl` and most other Markdown implementations,
2926reference link definitions cannot occur in nested constructions
2927such as list items or block quotes. Pandoc lifts this arbitrary
2928seeming restriction. So the following is fine in pandoc, though
2929not in most other implementations:
2935#### Extension: `shortcut_reference_links` ####
2937In a *shortcut* reference link, the second pair of brackets may
2942 [my website]: http://foo.bar.baz
2944### Internal links ###
2946To link to another section of the same document, use the automatically
2947generated identifier (see [Header identifiers]). For example:
2949 See the [Introduction](#introduction).
2953 See the [Introduction].
2955 [Introduction]: #introduction
2957Internal links are currently supported for HTML formats (including
2958HTML slide shows and EPUB), LaTeX, and ConTeXt.
2963A link immediately preceded by a `!` will be treated as an image.
2964The link text will be used as the image's alt text:
2966 
2970 [movie reel]: movie.gif
2972#### Extension: `implicit_figures` ####
2974An image occurring by itself in a paragraph will be rendered as
2975a figure with a caption.[^5] (In LaTeX, a figure environment will be
2976used; in HTML, the image will be placed in a `div` with class
2977`figure`, together with a caption in a `p` with class `caption`.)
2978The image's alt text will be used as the caption.
2980 
2982[^5]: This feature is not yet implemented for RTF, OpenDocument, or
2983 ODT. In those formats, you'll just get an image in a paragraph by
2984 itself, with no caption.
2986If you just want a regular inline image, just make sure it is not
2987the only thing in the paragraph. One way to do this is to insert a
2988nonbreaking space after the image:
2990 \
2992#### Extension: `link_attributes` ####
2994Attributes can be set on links and images:
2996 An inline {#id .class width=30 height=20px}
2997 and a reference ![image][ref] with attributes.
2999 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3001(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3002and `.class` are used.)
3004For HTML and EPUB, all attributes except `width` and `height` (but
3005including `srcset` and `sizes`) are passed through as is. The other
3006writers ignore attributes that are not supported by their output
3009The `width` and `height` attributes on images are treated specially. When
3010used without a unit, the unit is assumed to be pixels. However, any of
3011the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3012and `%`. There must not be any spaces between the number and the unit.
3016{ width=50% }
3019- Dimensions are converted to inches for output in page-based formats like
3020 LaTeX. Dimensions are converted to pixels for output in HTML-like
3021 formats. Use the `--dpi` option to specify the number of pixels per
3022 inch. The default is 96dpi.
3023- The `%` unit is generally relative to some available space.
3024 For example the above example will render to
3025 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3026 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3027 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3028- Some output formats have a notion of a class
3029 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3030 or a unique identifier (LaTeX `\caption`), or both (HTML).
3031- When no `width` or `height` attributes are specified, the fallback
3032 is to look at the image resolution and the dpi metadata embedded in
3039#### Extension: `footnotes` ####
3041Pandoc's Markdown allows footnotes, using the following syntax:
3043 Here is a footnote reference,[^1] and another.[^longnote]
3045 [^1]: Here is the footnote.
3047 [^longnote]: Here's one with multiple blocks.
3049 Subsequent paragraphs are indented to show that they
3050 belong to the previous footnote.
3054 The whole paragraph can be indented, or just the first
3055 line. In this way, multi-paragraph footnotes work like
3056 multi-paragraph list items.
3058 This paragraph won't be part of the note, because it
3061The identifiers in footnote references may not contain spaces, tabs,
3062or newlines. These identifiers are used only to correlate the
3063footnote reference with the note itself; in the output, footnotes
3064will be numbered sequentially.
3066The footnotes themselves need not be placed at the end of the
3067document. They may appear anywhere except inside other block elements
3068(lists, block quotes, tables, etc.).
3070#### Extension: `inline_notes` ####
3072Inline footnotes are also allowed (though, unlike regular notes,
3073they cannot contain multiple paragraphs). The syntax is as follows:
3075 Here is an inline note.^[Inlines notes are easier to write, since
3076 you don't have to pick an identifier and move down to type the
3079Inline and regular footnotes may be mixed freely.
3085#### Extension: `citations` ####
3087Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3088citations and a bibliography in a number of styles. Basic usage is
3090 pandoc --filter pandoc-citeproc myinput.txt
3092In order to use this feature, you will need to specify a bibliography file
3093using the `bibliography` metadata field in a YAML metadata section, or
3094`--bibliography` command line argument. You can supply multiple `--bibliography`
3095arguments or set `bibliography` metadata field to YAML array, if you want to
3096use multiple bibliography files. The bibliography may have any of these
3099 Format File extension
3100 ------------ --------------
3113Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3114use `.bibtex` to force BibTeX.
3116Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3117can produce `.json` and `.yaml` files from any of the supported formats.
3119In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3120a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3128`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3137`<span class="nocase">...</span>`
3138: prevent a phrase from being capitalized as title case
3140`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3141and CSL YAML formats as far as possible.
3143As an alternative to specifying a bibliography file using `--bibliography`
3144or the YAML metadata field `bibliography`, you can include
3145the citation data directly in the `references` field of the
3146document's YAML metadata. The field should contain an array of
3147YAML-encoded references, for example:
3151 - type: article-journal
3163 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3165 title-short: Molecular structure of nucleic acids
3166 container-title: Nature
3170 DOI: 10.1038/171737a0
3171 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3175(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3176of the supported formats.)
3178Citations and references can be formatted using any style supported by the
3179[Citation Style Language], listed in the [Zotero Style Repository].
3180These files are specified using the `--csl` option or the `csl` metadata field.
3181By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3182format. The CSL project provides further information on [finding and editing styles].
3184To make your citations hyperlinks to the corresponding bibliography
3185entries, add `link-citations: true` to your YAML metadata.
3187Citations go inside square brackets and are separated by semicolons.
3188Each citation must have a key, composed of '@' + the citation
3189identifier from the database, and may optionally have a prefix,
3190a locator, and a suffix. The citation key must begin with a letter, digit,
3191or `_`, and may contain alphanumerics, `_`, and internal punctuation
3192characters (`:.#$%&-+?<>~/`). Here are some examples:
3194 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3196 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3198 Blah blah [@smith04; @doe99].
3200`pandoc-citeproc` detects locator terms in the [CSL locale files].
3201Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3202locale, locator terms can be written in either singular or plural forms,
3203as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3204`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3205`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3206`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3207`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3208`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3209locator term is used, "page" is assumed.
3211A minus sign (`-`) before the `@` will suppress mention of
3212the author in the citation. This can be useful when the
3213author is already mentioned in the text:
3215 Smith says blah [-@smith04].
3217You can also write an in-text citation, as follows:
3221 @smith04 [p. 33] says blah.
3223If the style calls for a list of works cited, it will be placed
3224at the end of the document. Normally, you will want to end your
3225document with an appropriate header:
3231The bibliography will be inserted after this header. Note that
3232the `unnumbered` class will be added to this header, so that the
3233section will not be numbered.
3235If you want to include items in the bibliography without actually
3236citing them in the body text, you can define a dummy `nocite` metadata
3237field and put the citations there:
3246In this example, the document will contain a citation for `item3`
3247only, but the bibliography will contain entries for `item1`, `item2`, and
3250For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3251to render bibliography. In order to do so, specify bibliography files as
3252outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3253invocation. Bear in mind that bibliography files have to be in respective
3254format (either BibTeX or BibLaTeX).
3256For more information, see the [pandoc-citeproc man page].
3258[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3259[Chicago Manual of Style]: http://chicagomanualofstyle.org
3260[Citation Style Language]: http://citationstyles.org
3261[Zotero Style Repository]: https://www.zotero.org/styles
3262[finding and editing styles]: http://citationstyles.org/styles/
3263[CSL locale files]: https://github.com/citation-style-language/locales
3264[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3266Non-pandoc extensions
3267---------------------
3269The following Markdown syntax extensions are not enabled by default
3270in pandoc, but may be enabled by adding `+EXTENSION` to the format
3271name, where `EXTENSION` is the name of the extension. Thus, for
3272example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3274#### Extension: `lists_without_preceding_blankline` ####
3276Allow a list to occur right after a paragraph, with no intervening
3279#### Extension: `hard_line_breaks` ####
3281Causes all newlines within a paragraph to be interpreted as hard line
3282breaks instead of spaces.
3284#### Extension: `ignore_line_breaks` ####
3286Causes newlines within a paragraph to be ignored, rather than being
3287treated as spaces or as hard line breaks. This option is intended for
3288use with East Asian languages where spaces are not used between words,
3289but text is divided into lines for readability.
3291#### Extension: `east_asian_line_breaks` ####
3293Causes newlines within a paragraph to be ignored, rather than
3294being treated as spaces or as hard line breaks, when they occur
3295between two East Asian wide characters. This is a better choice
3296than `ignore_line_breaks` for texts that include a mix of East
3297Asian wide characters and other characters.
3299##### Extension: `emoji` ####
3301Parses textual emojis like `:smile:` as Unicode emoticons.
3303#### Extension: `tex_math_single_backslash` ####
3305Causes anything between `\(` and `\)` to be interpreted as inline
3306TeX math, and anything between `\[` and `\]` to be interpreted
3307as display TeX math. Note: a drawback of this extension is that
3308it precludes escaping `(` and `[`.
3310#### Extension: `tex_math_double_backslash` ####
3312Causes anything between `\\(` and `\\)` to be interpreted as inline
3313TeX math, and anything between `\\[` and `\\]` to be interpreted
3316#### Extension: `markdown_attribute` ####
3318By default, pandoc interprets material inside block-level tags as Markdown.
3319This extension changes the behavior so that Markdown is only parsed
3320inside block-level tags if the tags have the attribute `markdown=1`.
3322#### Extension: `mmd_title_block` ####
3324Enables a [MultiMarkdown] style title block at the top of
3325the document, for example:
3329 Date: September 1, 2008
3330 Comment: This is a sample mmd title block, with
3331 a field spanning multiple lines.
3333See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3334`yaml_metadata_block` is enabled, it will take precedence over
3337#### Extension: `abbreviations` ####
3339Parses PHP Markdown Extra abbreviation keys, like
3341 *[HTML]: Hypertext Markup Language
3343Note that the pandoc document model does not support
3344abbreviations, so if this extension is enabled, abbreviation keys are
3345simply skipped (as opposed to being parsed as paragraphs).
3347#### Extension: `autolink_bare_uris` ####
3349Makes all absolute URIs into links, even when not surrounded by
3350pointy braces `<...>`.
3352#### Extension: `ascii_identifiers` ####
3354Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3355Accents are stripped off of accented latin letters, and non-latin
3358#### Extension: `mmd_link_attributes` ####
3360Parses multimarkdown style key-value attributes on link
3361and image references. This extension should not be confused with the
3362[`link_attributes`](#extension-link_attributes) extension.
3364 This is a reference ![image][ref] with multimarkdown attributes.
3366 [ref]: http://path.to/image "Image title" width=20px height=30px
3367 id=myId class="myClass1 myClass2"
3369#### Extension: `mmd_header_identifiers` ####
3371Parses multimarkdown style header identifiers (in square brackets,
3372after the header but before any trailing `#`s in an ATX header).
3374#### Extension: `compact_definition_lists` ####
3376Activates the definition list syntax of pandoc 1.12.x and earlier.
3377This syntax differs from the one described above under [Definition lists]
3380 - No blank line is required between consecutive items of the
3382 - To get a "tight" or "compact" list, omit space between consecutive
3383 items; the space between a term and its definition does not affect
3385 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3386 be indented four spaces.[^6]
3388[^6]: To see why laziness is incompatible with relaxing the requirement
3389 of a blank line between items, consider the following example:
3396 Is this a single list item with two definitions of "bar," the first of
3397 which is lazily wrapped, or two list items? To remove the ambiguity
3398 we must either disallow lazy wrapping or require a blank line between
3404In addition to pandoc's extended Markdown, the following Markdown
3405variants are supported:
3407`markdown_phpextra` (PHP Markdown Extra)
3408: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3409 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3410 `header_attributes`, `link_attributes`, `abbreviations`,
3411 `shortcut_reference_links`.
3413`markdown_github` (GitHub-Flavored Markdown)
3414: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3415 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3416 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3417 `shortcut_reference_links`.
3419`markdown_mmd` (MultiMarkdown)
3420: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3421 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,
3422 `mmd_title_block`, `footnotes`, `definition_lists`,
3423 `all_symbols_escapable`, `implicit_header_references`,
3424 `auto_identifiers`, `mmd_header_identifiers`,
3425 `shortcut_reference_links`.
3427`markdown_strict` (Markdown.pl)
3430Extensions with formats other than Markdown
3431-------------------------------------------
3433Some of the extensions discussed above can be used with formats
3436* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3437 and `textile` input (and is used by default).
3439* `tex_math_dollars`, `tex_math_single_backslash`, and
3440 `tex_math_double_backslash` can be used with `html` input.
3441 (This is handy for reading web pages formatted using MathJax,
3444Producing slide shows with pandoc
3445=================================
3447You can use pandoc to produce an HTML + javascript slide presentation
3448that can be viewed via a web browser. There are five ways to do this,
3449using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3450You can also produce a PDF slide show using LaTeX [`beamer`].
3452Here's the Markdown source for a simple slide show, `habits.txt`:
3479 
3486To produce an HTML/javascript slide show, simply type
3488 pandoc -t FORMAT -s habits.txt -o habits.html
3490where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3492For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3493`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3494assumed to be available at the relative path `s5/default` (for S5), `slideous`
3495(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3496`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3497`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3498above.) For DZSlides, the (relatively short) javascript and css are included in
3501With all HTML slide formats, the `--self-contained` option can be used to
3502produce a single file that contains all of the data necessary to display the
3503slide show, including linked scripts, stylesheets, images, and videos.
3505To produce a PDF slide show using beamer, type
3507 pandoc -t beamer habits.txt -o habits.pdf
3509Note that a reveal.js slide show can also be converted to a PDF
3510by printing it to a file from the browser.
3512Structuring the slide show
3513--------------------------
3515By default, the *slide level* is the highest header level in
3516the hierarchy that is followed immediately by content, and not another
3517header, somewhere in the document. In the example above, level 1 headers
3518are always followed by level 2 headers, which are followed by content,
3519so 2 is the slide level. This default can be overridden using
3520the `--slide-level` option.
3522The document is carved up into slides according to the following
3525 * A horizontal rule always starts a new slide.
3527 * A header at the slide level always starts a new slide.
3529 * Headers *below* the slide level in the hierarchy create
3530 headers *within* a slide.
3532 * Headers *above* the slide level in the hierarchy create
3533 "title slides," which just contain the section title
3534 and help to break the slide show into sections.
3536 * A title page is constructed automatically from the document's title
3537 block, if present. (In the case of beamer, this can be disabled
3538 by commenting out some lines in the default template.)
3540These rules are designed to support many different styles of slide show. If
3541you don't care about structuring your slides into sections and subsections,
3542you can just use level 1 headers for all each slide. (In that case, level 1
3543will be the slide level.) But you can also structure the slide show into
3544sections, as in the example above.
3546Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3547layout will be produced, with level 1 headers building horizontally
3548and level 2 headers building vertically. It is not recommended that
3549you use deeper nesting of section levels with reveal.js.
3554By default, these writers produce lists that display "all at once."
3555If you want your lists to display incrementally (one item at a time),
3556use the `-i` option. If you want a particular list to depart from the
3557default (that is, to display incrementally without the `-i` option and
3558all at once with the `-i` option), put it in a block quote:
3563In this way incremental and nonincremental lists can be mixed in
3569You can add "pauses" within a slide by including a paragraph containing
3570three dots, separated by spaces:
3572 # Slide with a pause
3574 content before the pause
3578 content after the pause
3583You can change the style of HTML slides by putting customized CSS files
3584in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3585or `$DATADIR/slideous` (for Slideous),
3586where `$DATADIR` is the user data directory (see `--data-dir`, above).
3587The originals may be found in pandoc's system data directory (generally
3588`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3589files it does not find in the user data directory.
3591For dzslides, the CSS is included in the HTML file itself, and may
3594All [reveal.js configuration options] can be set through variables.
3595For example, themes can be used by setting the `theme` variable:
3599Or you can specify a custom stylesheet using the `--css` option.
3601To style beamer slides, you can specify a `theme`, `colortheme`,
3602`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3604 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3606Note that header attributes will turn into slide attributes
3607(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3608to style individual slides. In beamer, the only header attribute
3609that affects slides is the `allowframebreaks` class, which sets the
3610`allowframebreaks` option, causing multiple slides to be created
3611if the content overfills the frame. This is recommended especially for
3614 # References {.allowframebreaks}
3619reveal.js has good support for speaker notes. You can add notes to your
3620Markdown document thus:
3625 - It can contain Markdown
3630To show the notes window, press `s` while viewing the presentation.
3631Notes are not yet supported for other slide formats, but the notes
3632will not appear on the slides themselves.
3634Frame attributes in beamer
3635--------------------------
3637Sometimes it is necessary to add the LaTeX `[fragile]` option to
3638a frame in beamer (for example, when using the `minted` environment).
3639This can be forced by adding the `fragile` class to the header
3640introducing the slide:
3642 # Fragile slide {.fragile}
3644All of the other frame attributes described in Section 8.1 of
3645the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3646`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3649Creating EPUBs with pandoc
3650==========================
3655EPUB metadata may be specified using the `--epub-metadata` option, but
3656if the source document is Markdown, it is better to use a [YAML metadata
3657block][Extension: `yaml_metadata_block`]. Here is an example:
3664 text: An investigation of metadata
3672 text: doi:10.234234.234/33
3674 rights: © 2007 John Smith, CC BY-NC
3677The following fields are recognized:
3680 ~ Either a string value or an object with fields `text` and
3681 `scheme`. Valid values for `scheme` are `ISBN-10`,
3682 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3683 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3684 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3687 ~ Either a string value, or an object with fields `file-as` and
3688 `type`, or a list of such objects. Valid values for `type` are
3689 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3692 ~ Either a string value, or an object with fields `role`, `file-as`,
3693 and `text`, or a list of such objects. Valid values for `role` are
3694 [MARC relators], but
3695 pandoc will attempt to translate the human-readable versions
3696 (like "author" and "editor") to the appropriate marc relators.
3699 ~ Same format as `creator`.
3702 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3703 Pandoc will attempt to convert other common date formats.
3705`lang` (or legacy: `language`)
3706 ~ A string value in [BCP 47] format. Pandoc will default to the local
3707 language if nothing is specified.
3710 ~ A string value or a list of such values.
3731 ~ A string value (path to cover image).
3734 ~ A string value (path to CSS stylesheet).
3736`page-progression-direction`
3737 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3738 attribute for the [`spine` element].
3740[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3741[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3746By default, pandoc will download linked media (including audio and
3747video) and include it in the EPUB container, yielding a completely
3748self-contained EPUB. If you want to link to external media resources
3749instead, use raw HTML in your source and add `data-external="1"` to the tag
3750with the `src` attribute. For example:
3752 <audio controls="1">
3753 <source src="http://example.com/music/toccata.mp3"
3754 data-external="1" type="audio/mpeg">
3758Literate Haskell support
3759========================
3761If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3762format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3763`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3764literate Haskell source. This means that
3766 - In Markdown input, "bird track" sections will be parsed as Haskell
3767 code rather than block quotations. Text between `\begin{code}`
3768 and `\end{code}` will also be treated as Haskell code. For
3769 ATX-style headers the character '=' will be used instead of '#'.
3771 - In Markdown output, code blocks with classes `haskell` and `literate`
3772 will be rendered using bird tracks, and block quotations will be
3773 indented one space, so they will not be treated as Haskell code.
3774 In addition, headers will be rendered setext-style (with underlines)
3775 rather than ATX-style (with '#' characters). (This is because ghc
3776 treats '#' characters in column 1 as introducing line numbers.)
3778 - In restructured text input, "bird track" sections will be parsed
3781 - In restructured text output, code blocks with class `haskell` will
3782 be rendered using bird tracks.
3784 - In LaTeX input, text in `code` environments will be parsed as
3787 - In LaTeX output, code blocks with class `haskell` will be rendered
3788 inside `code` environments.
3790 - In HTML output, code blocks with class `haskell` will be rendered
3791 with class `literatehaskell` and bird tracks.
3795 pandoc -f markdown+lhs -t html
3797reads literate Haskell source formatted with Markdown conventions and writes
3798ordinary HTML (without bird tracks).
3800 pandoc -f markdown+lhs -t html+lhs
3802writes HTML with the Haskell code in bird tracks, so it can be copied
3803and pasted as literate Haskell source.
3808Pandoc will automatically highlight syntax in [fenced code blocks] that
3809are marked with a language name. The Haskell library [highlighting-kate] is used for
3810highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3811The color scheme can be selected using the `--highlight-style` option.
3812The default color scheme is `pygments`, which imitates the default color
3813scheme used by the Python library pygments, but pygments is not actually
3814used to do the highlighting.
3816To see a list of language names that pandoc will recognize, type
3819To disable highlighting, use the `--no-highlight` option.
3821[highlighting-kate]: https://github.com/jgm/highlighting-kate
3826Pandoc can be extended with custom writers written in [lua]. (Pandoc
3827includes a lua interpreter, so lua need not be installed separately.)
3829To use a custom writer, simply specify the path to the lua script
3830in place of the output format. For example:
3832 pandoc -t data/sample.lua
3834Creating a custom writer requires writing a lua function for each
3835possible element in a pandoc document. To get a documented example
3836which you can modify according to your needs, do
3838 pandoc --print-default-data-file sample.lua
3840[lua]: http://www.lua.org
3845© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
3846[GPL], version 2 or greater. This software carries no warranty of
3847any kind. (See COPYRIGHT for full copyright and warranty notices.)
3853Alexander Kondratskiy,
3855Alexander V Vershilov,
3856Alfred Wechselberger,
3864Beni Cherniavsky-Paskin,
3876Christoffer Ackelman,
3914Jaime Marquínez Ferrándiz,
3950Matthias C. M. Troffaes,
4007[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