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
35further under [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://www.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://man7.org/linux/man-pages/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]: https://en.wikipedia.org/wiki/Office_Open_XML
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
265 their names. See `--list-input-formats` and `--list-extensions`,
268`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
270: Specify output format. *FORMAT* can be `native` (native Haskell),
271 `json` (JSON version of native AST), `plain` (plain text),
272 `markdown` (pandoc's extended Markdown), `markdown_strict`
273 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
274 Extra), `markdown_github` (GitHub-Flavored Markdown), `markdown_mmd`
275 (MultiMarkdown), `commonmark` (CommonMark Markdown), `rst`
276 (reStructuredText), `html` (XHTML), `html5` (HTML5), `latex`
277 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
278 `man` (groff man), `mediawiki` (MediaWiki markup),
279 `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
280 `textile` (Textile), `org` (Emacs Org mode),
281 `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook 4),
282 `docbook5` (DocBook 5), `opendocument` (OpenDocument), `odt`
283 (OpenOffice text document), `docx` (Word docx), `haddock`
284 (Haddock markup), `rtf` (rich text format), `epub` (EPUB v2
285 book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
286 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
287 Simple), `slidy` (Slidy HTML and JavaScript slide show),
288 `slideous` (Slideous HTML and JavaScript slide show),
289 `dzslides` (DZSlides HTML5 + JavaScript slide show),
290 `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
291 (S5 HTML and JavaScript slide show), or the path of a custom
292 lua writer (see [Custom writers], below). Note that `odt`,
293 `epub`, and `epub3` output will not be directed to *stdout*;
294 an output filename must be specified using the `-o/--output`
295 option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
296 `beamer`, `html`, or `html5`, the output will be rendered as
297 literate Haskell source: see [Literate Haskell support],
298 below. Markdown syntax extensions can be individually
299 enabled or disabled by appending `+EXTENSION` or
300 `-EXTENSION` to the format name, as described above under `-f`.
301 See `--list-output-formats` and `--list-extensions`, below.
303`-o` *FILE*, `--output=`*FILE*
305: Write output to *FILE* instead of *stdout*. If *FILE* is
306 `-`, output will go to *stdout*. (Exception: if the output
307 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
309`--data-dir=`*DIRECTORY*
311: Specify the user data directory to search for pandoc data files.
312 If this option is not specified, the default user data directory
313 will be used. This is, in Unix:
319 C:\Documents And Settings\USERNAME\Application Data\pandoc
321 and in Windows Vista or later:
323 C:\Users\USERNAME\AppData\Roaming\pandoc
325 You can find the default user data directory on your system by
326 looking at the output of `pandoc --version`.
327 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
328 `slidy`, `slideous`, or `s5` directory
329 placed in this directory will override pandoc's normal defaults.
333: Generate a bash completion script. To enable bash completion
334 with pandoc, add this to your `.bashrc`:
336 eval "$(pandoc --bash-completion)"
340: Give verbose debugging output. Currently this only has an effect
343`--list-input-formats`
345: List supported input formats, one per line.
347`--list-output-formats`
349: List supported output formats, one per line.
353: List supported Markdown extensions, one per line, followed
354 by a `+` or `-` indicating whether it is enabled by default
355 in pandoc's Markdown.
357`--list-highlight-languages`
359: List supported languages for syntax highlighting, one per
362`--list-highlight-styles`
364: List supported styles for syntax highlighting, one per line.
365 See `--highlight-style`.
380: Parse untranslatable HTML codes and LaTeX environments as raw HTML
381 or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
382 input. Raw HTML can be printed in Markdown, reStructuredText, Emacs Org
383 mode, HTML, Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX
384 can be printed in Markdown, reStructuredText, Emacs Org mode, LaTeX, and
385 ConTeXt output. The default is for the readers to omit untranslatable
386 HTML codes and LaTeX environments. (The LaTeX reader does pass through
387 untranslatable LaTeX *commands*, even if `-R` is not specified.)
391: Produce typographically correct output, converting straight quotes
392 to curly quotes, `---` to em-dashes, `--` to en-dashes, and
393 `...` to ellipses. Nonbreaking spaces are inserted after certain
394 abbreviations, such as "Mr." (Note: This option is selected automatically
395 when the output format is `latex` or `context`, unless `--no-tex-ligatures`
396 is used. It has no effect for `latex` input.)
400: Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: `-` before
401 a numeral is an en-dash, and `--` is an em-dash. This option is selected
402 automatically for `textile` input.
404`--base-header-level=`*NUMBER*
406: Specify the base level for headers (defaults to 1).
408`--indented-code-classes=`*CLASSES*
410: Specify classes to use for indented code blocks--for example,
411 `perl,numberLines` or `haskell`. Multiple classes may be separated
414`--default-image-extension=`*EXTENSION*
416: Specify a default extension to use when image paths/URLs have no
417 extension. This allows you to use the same source for formats that
418 require different kinds of images. Currently this option only affects
419 the Markdown and LaTeX readers.
423: Parse each file individually before combining for multifile
424 documents. This will allow footnotes in different files with the
425 same identifiers to work as expected. If this option is set,
426 footnotes and links will not work across files. Reading binary
427 files (docx, odt, epub) implies `--file-scope`.
431: Specify an executable to be used as a filter transforming the
432 pandoc AST after the input is parsed and before the output is
433 written. The executable should read JSON from stdin and write
434 JSON to stdout. The JSON must be formatted like pandoc's own
435 JSON input and output. The name of the output format will be
436 passed to the filter as the first argument. Hence,
438 pandoc --filter ./caps.py -t latex
442 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
444 The latter form may be useful for debugging filters.
446 Filters may be written in any language. `Text.Pandoc.JSON`
447 exports `toJSONFilter` to facilitate writing filters in Haskell.
448 Those who would prefer to write filters in python can use the
449 module [`pandocfilters`], installable from PyPI. There are also
450 pandoc filter libraries in [PHP], [perl], and
451 [javascript/node.js].
453 In order of preference, pandoc will look for filters in
455 1. a specified full or relative path (executable or
458 2. `$DATADIR/filters` (executable or non-executable)
460 3. `$PATH` (executable only)
462`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
464: Set the metadata field *KEY* to the value *VAL*. A value specified
465 on the command line overrides a value specified in the document.
466 Values will be parsed as YAML boolean or string values. If no value is
467 specified, the value will be treated as Boolean true. Like
468 `--variable`, `--metadata` causes template variables to be set.
469 But unlike `--variable`, `--metadata` affects the metadata of the
470 underlying document (which is accessible from filters and may be
471 printed in some output formats).
475: Normalize the document after reading: merge adjacent
476 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
478`-p`, `--preserve-tabs`
480: Preserve tabs instead of converting them to spaces (the default).
481 Note that this will only affect tabs in literal code spans and code
482 blocks; tabs in regular text will be treated as spaces.
486: Specify the number of spaces per tab (default is 4).
488`--track-changes=accept`|`reject`|`all`
490: Specifies what to do with insertions, deletions, and comments
491 produced by the MS Word "Track Changes" feature. `accept` (the
492 default), inserts all insertions, and ignores all
493 deletions. `reject` inserts all deletions and ignores
494 insertions. Both `accept` and `reject` ignore comments. `all` puts
495 in insertions, deletions, and comments, wrapped in spans with
496 `insertion`, `deletion`, `comment-start`, and `comment-end`
497 classes, respectively. The author and time of change is
498 included. `all` is useful for scripting: only accepting changes
499 from a certain reviewer, say, or before a certain date. This
500 option only affects the docx reader.
502`--extract-media=`*DIR*
504: Extract images and other media contained in a docx or epub container
505 to the path *DIR*, creating it if necessary, and adjust the images
506 references in the document so they point to the extracted files.
507 This option only affects the docx and epub readers.
509[`pandocfilters`]: https://github.com/jgm/pandocfilters
510[PHP]: https://github.com/vinai/pandocfilters-php
511[perl]: https://metacpan.org/pod/Pandoc::Filter
512[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
514General writer options
515----------------------
519: Produce output with an appropriate header and footer (e.g. a
520 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
521 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
526: Use *FILE* as a custom template for the generated document. Implies
527 `--standalone`. See [Templates], below, for a description
528 of template syntax. If no extension is specified, an extension
529 corresponding to the writer will be added, so that `--template=special`
530 looks for `special.html` for HTML output. If the template is not
531 found, pandoc will search for it in the `templates` subdirectory of
532 the user data directory (see `--data-dir`). If this option is not used,
533 a default template appropriate for the output format will be used (see
534 `-D/--print-default-template`).
536`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
538: Set the template variable *KEY* to the value *VAL* when rendering the
539 document in standalone mode. This is generally only useful when the
540 `--template` option is used to specify a custom template, since
541 pandoc automatically sets the variables used in the default
542 templates. If no *VAL* is specified, the key will be given the
545`-D` *FORMAT*, `--print-default-template=`*FORMAT*
547: Print the system default template for an output *FORMAT*. (See `-t`
548 for a list of possible *FORMAT*s.) Templates in the user data
549 directory are ignored.
551`--print-default-data-file=`*FILE*
553: Print a system default data file. Files in the user data directory
557: Specify the dpi (dots per inch) value for conversion from pixels
558 to inch/centimeters and vice versa. The default is 96dpi.
559 Technically, the correct term would be ppi (pixels per inch).
561`--wrap=auto`|`none`|`preserve`
563: Determine how text is wrapped in the output (the source
564 code, not the rendered version). With `auto` (the default),
565 pandoc will attempt to wrap lines to the column width specified by
566 `--columns` (default 72). With `none`, pandoc will not wrap
567 lines at all. With `preserve`, pandoc will attempt to
568 preserve the wrapping from the source document (that is,
569 where there are nonsemantic newlines in the source, there
570 will be nonsemantic newlines in the output as well).
571 Automatic wrapping does not currently work in HTML output.
575: Deprecated synonym for `--wrap=none`.
579: Specify length of lines in characters. This affects text wrapping
580 in the generated source code (see `--wrap`). It also affects
581 calculation of column widths for plain text tables (see [Tables] below).
583`--toc`, `--table-of-contents`
585: Include an automatically generated table of contents (or, in
586 the case of `latex`, `context`, `docx`, and `rst`, an instruction to create
587 one) in the output document. This option has no effect on `man`,
588 `docbook`, `docbook5`, `slidy`, `slideous`, `s5`, or `odt` output.
590`--toc-depth=`*NUMBER*
592: Specify the number of section levels to include in the table
593 of contents. The default is 3 (which means that level 1, 2, and 3
594 headers will be listed in the contents).
598: Disables syntax highlighting for code blocks and inlines, even when
599 a language attribute is given.
601`--highlight-style=`*STYLE*
603: Specifies the coloring style to be used in highlighted source code.
604 Options are `pygments` (the default), `kate`, `monochrome`,
605 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
606 For more information on syntax highlighting in pandoc, see
607 [Syntax highlighting], below. See also
608 `--list-highlight-styles`.
610`-H` *FILE*, `--include-in-header=`*FILE*
612: Include contents of *FILE*, verbatim, at the end of the header.
613 This can be used, for example, to include special
614 CSS or JavaScript in HTML documents. This option can be used
615 repeatedly to include multiple files in the header. They will be
616 included in the order specified. Implies `--standalone`.
618`-B` *FILE*, `--include-before-body=`*FILE*
620: Include contents of *FILE*, verbatim, at the beginning of the
621 document body (e.g. after the `<body>` tag in HTML, or the
622 `\begin{document}` command in LaTeX). This can be used to include
623 navigation bars or banners in HTML documents. This option can be
624 used repeatedly to include multiple files. They will be included in
625 the order specified. Implies `--standalone`.
627`-A` *FILE*, `--include-after-body=`*FILE*
629: Include contents of *FILE*, verbatim, at the end of the document
630 body (before the `</body>` tag in HTML, or the
631 `\end{document}` command in LaTeX). This option can be used
632 repeatedly to include multiple files. They will be included in the
633 order specified. Implies `--standalone`.
635Options affecting specific writers
636----------------------------------
640: Produce a standalone HTML file with no external dependencies, using
641 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
642 images, and videos. The resulting file should be "self-contained,"
643 in the sense that it needs no external files and no net access to be
644 displayed properly by a browser. This option works only with HTML output
645 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
646 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
647 stylesheets at absolute URLs will be downloaded; those at relative URLs
648 will be sought relative to the working directory (if the first source
649 file is local) or relative to the base URL (if the first source
650 file is remote). Limitation: resources that are loaded dynamically
651 through JavaScript cannot be incorporated; as a result, `--self-contained`
652 does not work with `--mathjax`, and some advanced features (e.g.
653 zoom or speaker notes) may not work in an offline "self-contained"
654 `reveal.js` slide show.
658: Use `<q>` tags for quotes in HTML.
662: Use only ASCII characters in output. Currently supported only
663 for HTML output (which uses numerical entities instead of
664 UTF-8 when this option is selected).
668: Use reference-style links, rather than inline links, in writing Markdown
669 or reStructuredText. By default inline links are used. The
670 placement of link references is affected by the
671 `--reference-location` option.
673`--reference-location = block`|`section`|`document`
675: Specify whether footnotes (and references, if `reference-links` is
676 set) are placed at the end of the current (top-level) block, the
677 current section, or the document. The default is
678 `document`. Currently only affects the markdown writer.
682: Use ATX-style headers in Markdown and AsciiDoc output. The default is
683 to use setext-style headers for levels 1-2, and then ATX headers.
687: Deprecated synonym for `--top-level-division=chapter`.
689`--top-level-division=[default|section|chapter|part]`
691: Treat top-level headers as the given division type in LaTeX, ConTeXt,
692 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
693 all headers are shifted such that the top-level header becomes the specified
694 type. The default behavior is to determine the best division type via
695 heuristics: unless other conditions apply, `section` is chosen. When the
696 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
697 `article` option is specified), `chapter` is implied as the setting for this
698 option. If `beamer` is the output format, specifying either `chapter` or
699 `part` will cause top-level headers to become `\part{..}`, while
700 second-level headers remain as their default type.
702`-N`, `--number-sections`
704: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
705 By default, sections are not numbered. Sections with class
706 `unnumbered` will never be numbered, even if `--number-sections`
709`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
711: Offset for section headings in HTML output (ignored in other
712 output formats). The first number is added to the section number for
713 top-level headers, the second for second-level headers, and so on.
714 So, for example, if you want the first top-level header in your
715 document to be numbered "6", specify `--number-offset=5`.
716 If your document starts with a level-2 header which you want to
717 be numbered "1.5", specify `--number-offset=1,4`.
718 Offsets are 0 by default. Implies `--number-sections`.
722: Do not use the TeX ligatures for quotation marks, apostrophes,
723 and dashes (`` `...' ``, ` ``..'' `, `--`, `---`) when
724 writing or reading LaTeX or ConTeXt. In reading LaTeX,
725 parse the characters `` ` ``, `'`, and `-` literally, rather
726 than parsing ligatures for quotation marks and dashes. In
727 writing LaTeX or ConTeXt, print unicode quotation mark and
728 dash characters literally, rather than converting them to
729 the standard ASCII TeX ligatures. Note: normally `--smart`
730 is selected automatically for LaTeX and ConTeXt output, but
731 it must be specified explicitly if `--no-tex-ligatures` is
732 selected. If you use literal curly quotes, dashes, and
733 ellipses in your source, then you may want to use
734 `--no-tex-ligatures` without `--smart`.
738: Use the [`listings`] package for LaTeX code blocks
742: Make list items in slide shows display incrementally (one by one).
743 The default is for lists to be displayed all at once.
745`--slide-level=`*NUMBER*
747: Specifies that headers with the specified level create
748 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
749 above this level in the hierarchy are used to divide the
750 slide show into sections; headers below this level create
751 subheads within a slide. The default is to set the slide level
752 based on the contents of the document; see
753 [Structuring the slide show].
757: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
758 and attach identifiers to the enclosing `<div>` (or `<section>`)
759 rather than the header itself. See
760 [Header identifiers], below.
762`--email-obfuscation=none`|`javascript`|`references`
764: Specify a method for obfuscating `mailto:` links in HTML documents.
765 `none` leaves `mailto:` links as they are. `javascript` obfuscates
766 them using JavaScript. `references` obfuscates them by printing their
767 letters as decimal or hexadecimal character references. The default
770`--id-prefix=`*STRING*
772: Specify a prefix to be added to all automatically generated identifiers
773 in HTML and DocBook output, and to footnote numbers in Markdown output.
774 This is useful for preventing duplicate identifiers when generating
775 fragments to be included in other pages.
777`-T` *STRING*, `--title-prefix=`*STRING*
779: Specify *STRING* as a prefix at the beginning of the title
780 that appears in the HTML header (but not in the title as it
781 appears at the beginning of the HTML body). Implies
784`-c` *URL*, `--css=`*URL*
786: Link to a CSS style sheet. This option can be used repeatedly to
787 include multiple files. They will be included in the order specified.
789`--reference-odt=`*FILE*
791: Use the specified file as a style reference in producing an ODT.
792 For best results, the reference ODT should be a modified version
793 of an ODT produced using pandoc. The contents of the reference ODT
794 are ignored, but its stylesheets are used in the new ODT. If no
795 reference ODT is specified on the command line, pandoc will look
796 for a file `reference.odt` in the user data directory (see
797 `--data-dir`). If this is not found either, sensible defaults will be
800 To produce a custom `reference.odt`, first get a copy of
801 the default `reference.odt`: `pandoc
802 --print-default-data-file reference.odt >
803 custom-reference.odt`. Then open `custom-reference.docx` in
804 LibreOffice, modify the styles as you wish, and save the
807`--reference-docx=`*FILE*
809: Use the specified file as a style reference in producing a docx file.
810 For best results, the reference docx should be a modified version
811 of a docx file produced using pandoc. The contents of the reference docx
812 are ignored, but its stylesheets and document properties (including
813 margins, page size, header, and footer) are used in the new docx. If no
814 reference docx is specified on the command line, pandoc will look
815 for a file `reference.docx` in the user data directory (see
816 `--data-dir`). If this is not found either, sensible defaults will be
819 To produce a custom `reference.docx`, first get a copy of
820 the default `reference.docx`: `pandoc
821 --print-default-data-file reference.docx >
822 custom-reference.docx`. Then open `custom-reference.docx`
823 in Word, modify the styles as you wish, and save the file.
824 For best results, do not make changes to this file other
825 than modifying the styles used by pandoc: [paragraph] Normal,
826 Body Text, First Paragraph, Compact, Title, Subtitle,
827 Author, Date, Abstract, Bibliography, Heading 1, Heading 2,
828 Heading 3, Heading 4, Heading 5, Heading 6, Block Text,
829 Footnote Text, Definition Term, Definition, Caption, Table
830 Caption, Image Caption, Figure, Figure With Caption, TOC
831 Heading; [character] Default Paragraph Font, Body Text Char,
832 Verbatim Char, Footnote Reference, Hyperlink; [table] Normal
835`--epub-stylesheet=`*FILE*
837: Use the specified CSS file to style the EPUB. If no stylesheet
838 is specified, pandoc will look for a file `epub.css` in the
839 user data directory (see `--data-dir`). If it is not
840 found there, sensible defaults will be used.
842`--epub-cover-image=`*FILE*
844: Use the specified image as the EPUB cover. It is recommended
845 that the image be less than 1000px in width and height. Note that
846 in a Markdown source document you can also specify `cover-image`
847 in a YAML metadata block (see [EPUB Metadata], below).
849`--epub-metadata=`*FILE*
851: Look in the specified XML file for metadata for the EPUB.
852 The file should contain a series of [Dublin Core elements].
855 <dc:rights>Creative Commons</dc:rights>
856 <dc:language>es-AR</dc:language>
858 By default, pandoc will include the following metadata elements:
859 `<dc:title>` (from the document title), `<dc:creator>` (from the
860 document authors), `<dc:date>` (from the document date, which should
861 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
862 variable, or, if is not set, the locale), and `<dc:identifier
863 id="BookId">` (a randomly generated UUID). Any of these may be
864 overridden by elements in the metadata file.
866 Note: if the source document is Markdown, a YAML metadata block
867 in the document can be used instead. See below under
870`--epub-embed-font=`*FILE*
872: Embed the specified font in the EPUB. This option can be repeated
873 to embed multiple fonts. Wildcards can also be used: for example,
874 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
875 line, be sure to escape them or put the whole filename in single quotes,
876 to prevent them from being interpreted by the shell. To use the
877 embedded fonts, you will need to add declarations like the following
878 to your CSS (see `--epub-stylesheet`):
881 font-family: DejaVuSans;
884 src:url("DejaVuSans-Regular.ttf");
887 font-family: DejaVuSans;
890 src:url("DejaVuSans-Bold.ttf");
893 font-family: DejaVuSans;
896 src:url("DejaVuSans-Oblique.ttf");
899 font-family: DejaVuSans;
902 src:url("DejaVuSans-BoldOblique.ttf");
904 body { font-family: "DejaVuSans"; }
906`--epub-chapter-level=`*NUMBER*
908: Specify the header level at which to split the EPUB into separate
909 "chapter" files. The default is to split into chapters at level 1
910 headers. This option only affects the internal composition of the
911 EPUB, not the way chapters and sections are displayed to users. Some
912 readers may be slow if the chapter files are too large, so for large
913 documents with few level 1 headers, one might want to use a chapter
916`--latex-engine=pdflatex`|`lualatex`|`xelatex`
918: Use the specified LaTeX engine when producing PDF output.
919 The default is `pdflatex`. If the engine is not in your PATH,
920 the full path of the engine may be specified here.
922`--latex-engine-opt=`*STRING*
924: Use the given string as a command-line argument to the `latex-engine`.
925 If used multiple times, the arguments are provided with spaces between
926 them. Note that no check for duplicate options is done.
928[Dublin Core elements]: http://dublincore.org/documents/dces/
929[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
934`--bibliography=`*FILE*
936: Set the `bibliography` field in the document's metadata to *FILE*,
937 overriding any value set in the metadata, and process citations
938 using `pandoc-citeproc`. (This is equivalent to
939 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
940 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
941 used, making this equivalent to `--metadata bibliography=FILE`.
942 If you supply this argument multiple times, each *FILE* will be added
947: Set the `csl` field in the document's metadata to *FILE*,
948 overriding any value set in the metadata. (This is equivalent to
949 `--metadata csl=FILE`.)
950 This option is only relevant with `pandoc-citeproc`.
952`--citation-abbreviations=`*FILE*
954: Set the `citation-abbreviations` field in the document's metadata to
955 *FILE*, overriding any value set in the metadata. (This is equivalent to
956 `--metadata citation-abbreviations=FILE`.)
957 This option is only relevant with `pandoc-citeproc`.
961: Use [`natbib`] for citations in LaTeX output. This option is not for use
962 with the `pandoc-citeproc` filter or with PDF output. It is intended for
963 use in producing a LaTeX file that can be processed with [`bibtex`].
967: Use [`biblatex`] for citations in LaTeX output. This option is not for use
968 with the `pandoc-citeproc` filter or with PDF output. It is intended for
969 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
971Math rendering in HTML
972----------------------
974`-m` [*URL*], `--latexmathml`[`=`*URL*]
976: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
977 To insert a link to a local copy of the `LaTeXMathML.js` script,
978 provide a *URL*. If no *URL* is provided, the contents of the
979 script will be inserted directly into the HTML header, preserving
980 portability at the price of efficiency. If you plan to use math on
981 several pages, it is much better to link to a copy of the script,
986: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
987 In standalone `html` output, a small JavaScript (or a link to such a
988 script if a *URL* is supplied) will be inserted that allows the MathML to
989 be viewed on some browsers.
993: Use [jsMath] to display embedded TeX math in HTML output.
994 The *URL* should point to the jsMath load script (e.g.
995 `jsMath/easy/load.js`); if provided, it will be linked to in
996 the header of standalone HTML documents. If a *URL* is not provided,
997 no link to the jsMath load script will be inserted; it is then
998 up to the author to provide such a link in the HTML template.
1000`--mathjax`[`=`*URL*]
1002: Use [MathJax] to display embedded TeX math in HTML output.
1003 The *URL* should point to the `MathJax.js` load script.
1004 If a *URL* is not provided, a link to the MathJax CDN will
1009: Enclose TeX math in `<eq>` tags in HTML output. These can then
1010 be processed by [gladTeX] to produce links to images of the typeset
1013`--mimetex`[`=`*URL*]
1015: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1016 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1020: Render TeX formulas using an external script that converts TeX
1021 formulas to images. The formula will be concatenated with the URL
1022 provided. If *URL* is not specified, the CodeCogs will be used.
1023 Note: the `--webtex` option will affect Markdown output
1024 as well as HTML, which is useful if you're targeting a
1025 version of Markdown without native math support.
1029: Use [KaTeX] to display embedded TeX math in HTML output.
1030 The *URL* should point to the `katex.js` load script. If a *URL* is
1031 not provided, a link to the KaTeX CDN will be inserted.
1032 Note: [KaTeX] seems to work best with `html5` output.
1034`--katex-stylesheet=`*URL*
1036: The *URL* should point to the `katex.css` stylesheet. If this option is
1037 not specified, a link to the KaTeX CDN will be inserted. Note that this
1038 option does not imply `--katex`.
1040[MathML]: http://www.w3.org/Math/
1041[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1042[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1043[MathJax]: https://www.mathjax.org
1044[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1045[mimeTeX]: http://www.forkosh.com/mimetex.html
1046[KaTeX]: https://github.com/Khan/KaTeX
1048Options for wrapper scripts
1049---------------------------
1053: Print information about command-line arguments to *stdout*, then exit.
1054 This option is intended primarily for use in wrapper scripts.
1055 The first line of output contains the name of the output file specified
1056 with the `-o` option, or `-` (for *stdout*) if no output file was
1057 specified. The remaining lines contain the command-line arguments,
1058 one per line, in the order they appear. These do not include regular
1059 pandoc options and their arguments, but do include any options appearing
1060 after a `--` separator at the end of the line.
1064: Ignore command-line arguments (for use in wrapper scripts).
1065 Regular pandoc options are not ignored. Thus, for example,
1067 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1071 pandoc -o foo.html -s
1076When the `-s/--standalone` option is used, pandoc uses a template to
1077add header and footer material that is needed for a self-standing
1078document. To see the default template that is used, just type
1082where *FORMAT* is the name of the output format. A custom template
1083can be specified using the `--template` option. You can also override
1084the system default templates for a given output format *FORMAT*
1085by putting a file `templates/default.*FORMAT*` in the user data
1086directory (see `--data-dir`, above). *Exceptions:*
1088- For `odt` output, customize the `default.opendocument`
1090- For `pdf` output, customize the `default.latex` template
1091 (or the `default.beamer` template, if you use `-t beamer`,
1092 or the `default.context` template, if you use `-t context`).
1093- `docx` has no template (however, you can use
1094 `--reference-docx` to customize the output).
1096Templates contain *variables*, which allow for the inclusion of
1097arbitrary information at any point in the file. Variables may be set
1098within the document using [YAML metadata blocks][Extension:
1099`yaml_metadata_block`]. They may also be set at the
1100command line using the `-V/--variable` option: variables set in this
1101way override metadata fields with the same name.
1103Variables set by pandoc
1104-----------------------
1106Some variables are set automatically by pandoc. These vary somewhat
1107depending on the output format, but include metadata fields as well
1110`title`, `author`, `date`
1111: allow identification of basic aspects of the document. Included
1112 in PDF metadata through LaTeX and ConTeXt. These can be set
1113 through a [pandoc title block][Extension: `pandoc_title_block`],
1114 which allows for multiple authors, or through a YAML metadata block:
1123: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1124 renders in LaTeX only when using a document class that supports
1125 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1126 `scrreprt`, `scrbook`).[^subtitle]
1129: author affiliations (in LaTeX and Beamer only). Can be a
1130 list, when there are multiple authors.
1133: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1136: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1137 may be repeated as for `author`, above
1140: contents specified by `-H/--include-in-header` (may have multiple
1144: non-null value if `--toc/--table-of-contents` was specified
1147: title of table of contents (works only with EPUB and docx)
1150: contents specified by `-B/--include-before-body` (may have
1154: contents specified by `-A/--include-after-body` (may have
1161: JSON representation of all of the document's metadata
1163[^subtitle]: To make `subtitle` work with other LaTeX
1164 document classes, you can add the following to `header-includes`:
1166 \providecommand{\subtitle}[1]{%
1167 \usepackage{titling}
1169 \par\large#1\end{center}}
1176: identifies the main language of the document,
1177 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1178 For some output formats, pandoc will convert it to an appropriate
1179 format stored in the additional variables `babel-lang`,
1180 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1182 Native pandoc `span`s and `div`s with the lang attribute
1183 (value in BCP 47) can be used to switch the language in
1187: a list of other languages used in the document
1188 in the YAML metadata, according to [BCP 47]. For example:
1189 `otherlangs: [en-GB, fr]`.
1190 This is automatically generated from the `lang` attributes
1191 in all `span`s and `div`s but can be overridden.
1192 Currently only used by LaTeX through the generated
1193 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1194 The LaTeX writer outputs polyglossia commands in the text but
1195 the `babel-newcommands` variable contains mappings for them
1196 to the corresponding babel.
1199: the base direction of the document, either `rtl` (right-to-left)
1200 or `ltr` (left-to-right).
1202 For bidirectional documents, native pandoc `span`s and `div`s
1203 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1204 override the base direction in some output formats.
1205 This may not always be necessary if the final renderer
1206 (e.g. the browser, when generating HTML) supports the
1207 [Unicode Bidirectional Algorithm].
1209 When using LaTeX for bidirectional documents, only the `xelatex` engine
1210 is fully supported (use `--latex-engine=xelatex`).
1212[BCP 47]: https://tools.ietf.org/html/bcp47
1213[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1218Variables are available for [producing slide shows with pandoc],
1219including all [reveal.js configuration options].
1222: base URL for Slidy documents (defaults to
1223 `http://www.w3.org/Talks/Tools/Slidy2`)
1226: base URL for Slideous documents (defaults to `slideous`)
1229: base URL for S5 documents (defaults to `s5/default`)
1232: base URL for reveal.js documents (defaults to `reveal.js`)
1234`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1235: themes for LaTeX [`beamer`] documents
1238: options for LaTeX beamer themes (a list).
1241: controls navigation symbols in `beamer` documents
1242 (default is `empty` for no navigation symbols; other valid values
1243 are `frame`, `vertical`, and `horizontal`).
1246: enables on "title pages" for new sections in `beamer`
1247 documents (default = true).
1250: when true, the `beamerarticle` package is loaded (for
1251 producing an article from beamer slides).
1254: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1255 `urlcolor`, or `toccolor` are set (for beamer only).
1257`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1258: color for internal links, citation links, external links, and links in table
1259 of contents: uses any of the [predefined LaTeX colors] (for beamer only).
1261[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1266LaTeX variables are used when [creating a PDF].
1269: paper size, e.g. `letter`, `A4`
1272: font size for body text (e.g. `10pt`, `12pt`)
1275: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1278: option for document class, e.g. `oneside`; may be repeated
1279 for multiple options
1282: option for [`geometry`] package, e.g. `margin=1in`;
1283 may be repeated for multiple options
1285`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1286: sets margins, if `geometry` is not used (otherwise `geometry`
1290: adjusts line spacing using the [`setspace`]
1291 package, e.g. `1.25`, `1.5`
1294: font package for use with `pdflatex`:
1295 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1296 The default is [Latin Modern][`lm`].
1299: options for package used as `fontfamily`: e.g. `osf,sc` with
1300 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1301 figures and true small caps; may be repeated for multiple options
1303`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1304: font families for use with `xelatex` or
1305 `lualatex`: take the name of any system font, using the
1306 [`fontspec`] package. Note that if `CJKmainfont` is used,
1307 the [`xecjk`] package must be available.
1309`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1310: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1311 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1312 available through [`fontspec`], such as the OpenType features
1313 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1316: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1317 default is `T1` (see guide to [LaTeX font encodings])
1320: options to pass to the microtype package
1323: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1324 `urlcolor`, or `toccolor` are set
1326`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1327: color for internal links, citation links, external links, and links in table of contents:
1328 uses any of the [predefined LaTeX colors]
1331: causes links to be printed as footnotes
1334: uses document class settings for indentation (the default LaTeX template
1335 otherwise removes indentation and adds space between paragraphs)
1338: disables default behavior of LaTeX template that redefines (sub)paragraphs
1339 as sections, changing the appearance of nested headings in some classes
1342: specifies contents of acknowledgments footnote after document title.
1345: include table of contents (can also be set using `--toc/--table-of-contents`)
1348: level of section to include in table of contents
1351: numbering depth for sections, if sections are numbered
1354: include list of figures, list of tables
1357: bibliography to use for resolving references
1360: bibliography style, when used with `--natbib` and `--biblatex`.
1363: bibliography title, when used with `--natbib` and `--biblatex`.
1366: list of options for biblatex.
1368[`article`]: https://ctan.org/pkg/article
1369[`report`]: https://ctan.org/pkg/report
1370[`book`]: https://ctan.org/pkg/book
1371[KOMA-Script]: https://ctan.org/pkg/koma-script
1372[`memoir`]: https://ctan.org/pkg/memoir
1373[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1374[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1375[`mathpazo`]: https://ctan.org/pkg/mathpazo
1376[LaTeX font encodings]: https://ctan.org/pkg/encguide
1378Variables for ConTeXt
1379---------------------
1382: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1383 may be repeated for multiple options
1386: options for page margins and text arrangement (see [ConTeXt Layout]);
1387 may be repeated for multiple options
1389`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1390: sets margins, if `layout` is not used (otherwise `layout`
1394: font size for body text (e.g. `10pt`, `12pt`)
1396`mainfont`, `sansfont`, `monofont`, `mathfont`
1397: font families: take the name of any system font (see [ConTeXt Font Switching])
1399`linkcolor`, `contrastcolor`
1400: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1403: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1406: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1407 may be repeated for multiple options
1410: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1413: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1414 may be repeated for multiple options
1416`headertext`, `footertext`
1417: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1418 may be repeated up to four times for different placement
1421: page number style and location (using [`setuppagenumbering`]);
1422 may be repeated for multiple options
1425: include table of contents (can also be set using `--toc/--table-of-contents`)
1428: include list of figures, list of tables
1430[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1431[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1432[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1433[ConTeXt Color]: http://wiki.contextgarden.net/Color
1434[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1435[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1436[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1437[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1438[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1440Variables for man pages
1441-----------------------
1444: section number in man pages
1447: header in man pages
1450: footer in man pages
1453: adjusts text to left (`l`), right (`r`), center (`c`),
1454 or both (`b`) margins
1457: if `true` (the default), hyphenation will be used
1459Using variables in templates
1460----------------------------
1462Variable names are sequences of alphanumerics, `-`, and `_`,
1463starting with a letter. A variable name surrounded by `$` signs
1464will be replaced by its value. For example, the string `$title$` in
1466 <title>$title$</title>
1468will be replaced by the document title.
1470To write a literal `$` in a template, use `$$`.
1472Templates may contain conditionals. The syntax is as follows:
1480This will include `X` in the template if `variable` has a non-null
1481value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1482any valid template text, and may include interpolated variables or other
1483conditionals. The `$else$` section may be omitted.
1485When variables can have multiple values (for example, `author` in
1486a multi-author document), you can use the `$for$` keyword:
1489 <meta name="author" content="$author$" />
1492You can optionally specify a separator to be used between
1495 $for(author)$$author$$sep$, $endfor$
1497A dot can be used to select a field of a variable that takes
1498an object as its value. So, for example:
1500 $author.name$ ($author.affiliation$)
1502If you use custom templates, you may need to revise them as pandoc
1503changes. We recommend tracking the changes in the default templates,
1504and modifying your custom templates accordingly. An easy way to do this
1505is to fork the [pandoc-templates] repository and merge in changes after each
1508[pandoc-templates]: https://github.com/jgm/pandoc-templates
1513Pandoc understands an extended and slightly revised version of
1514John Gruber's [Markdown] syntax. This document explains the syntax,
1515noting differences from standard Markdown. Except where noted, these
1516differences can be suppressed by using the `markdown_strict` format instead
1517of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1518to the format name and disabled by adding `-EXTENSION`. For example,
1519`markdown_strict+footnotes` is strict Markdown with footnotes
1520enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1521Markdown without footnotes or pipe tables.
1526Markdown is designed to be easy to write, and, even more importantly,
1529> A Markdown-formatted document should be publishable as-is, as plain
1530> text, without looking like it's been marked up with tags or formatting
1532> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1534This principle has guided pandoc's decisions in finding syntax for
1535tables, footnotes, and other extensions.
1537There is, however, one respect in which pandoc's aims are different
1538from the original aims of Markdown. Whereas Markdown was originally
1539designed with HTML generation in mind, pandoc is designed for multiple
1540output formats. Thus, while pandoc allows the embedding of raw HTML,
1541it discourages it, and provides other, non-HTMLish ways of representing
1542important document elements like definition lists, tables, mathematics, and
1548A paragraph is one or more lines of text followed by one or more blank lines.
1549Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1550If you need a hard line break, put two or more spaces at the end of a line.
1552#### Extension: `escaped_line_breaks` ####
1554A backslash followed by a newline is also a hard line break.
1555Note: in multiline and grid table cells, this is the only way
1556to create a hard line break, since trailing spaces in the cells
1562There are two kinds of headers: Setext and ATX.
1564### Setext-style headers ###
1566A setext-style header is a line of text "underlined" with a row of `=` signs
1567(for a level one header) or `-` signs (for a level two header):
1575The header text can contain inline formatting, such as emphasis (see
1576[Inline formatting], below).
1579### ATX-style headers ###
1581An ATX-style header consists of one to six `#` signs and a line of
1582text, optionally followed by any number of `#` signs. The number of
1583`#` signs at the beginning of the line is the header level:
1585 ## A level-two header
1587 ### A level-three header ###
1589As with setext-style headers, the header text can contain formatting:
1591 # A level-one header with a [link](/url) and *emphasis*
1593#### Extension: `blank_before_header` ####
1595Standard Markdown syntax does not require a blank line before a header.
1596Pandoc does require this (except, of course, at the beginning of the
1597document). The reason for the requirement is that it is all too easy for a
1598`#` to end up at the beginning of a line by accident (perhaps through line
1599wrapping). Consider, for example:
1601 I like several of their flavors of ice cream:
1602 #22, for example, and #5.
1605### Header identifiers ###
1607#### Extension: `header_attributes` ####
1609Headers can be assigned attributes using this syntax at the end
1610of the line containing the header text:
1612 {#identifier .class .class key=value key=value}
1614Thus, for example, the following headers will all be assigned the identifier
1619 ## My header ## {#foo}
1621 My other header {#foo}
1624(This syntax is compatible with [PHP Markdown Extra].)
1626Note that although this syntax allows assignment of classes and key/value
1627attributes, writers generally don't use all of this information. Identifiers,
1628classes, and key/value attributes are used in HTML and HTML-based formats such
1629as EPUB and slidy. Identifiers are used for labels and link anchors in the
1630LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1632Headers with the class `unnumbered` will not be numbered, even if
1633`--number-sections` is specified. A single hyphen (`-`) in an attribute
1634context is equivalent to `.unnumbered`, and preferable in non-English
1641 # My header {.unnumbered}
1643#### Extension: `auto_identifiers` ####
1645A header without an explicitly specified identifier will be
1646automatically assigned a unique identifier based on the header text.
1647To derive the identifier from the header text,
1649 - Remove all formatting, links, etc.
1650 - Remove all footnotes.
1651 - Remove all punctuation, except underscores, hyphens, and periods.
1652 - Replace all spaces and newlines with hyphens.
1653 - Convert all alphabetic characters to lowercase.
1654 - Remove everything up to the first letter (identifiers may
1655 not begin with a number or punctuation mark).
1656 - If nothing is left after this, use the identifier `section`.
1661 ------------------------------- ----------------------------
1662 `Header identifiers in HTML` `header-identifiers-in-html`
1663 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1664 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1665 `3. Applications` `applications`
1668These rules should, in most cases, allow one to determine the identifier
1669from the header text. The exception is when several headers have the
1670same text; in this case, the first will get an identifier as described
1671above; the second will get the same identifier with `-1` appended; the
1672third with `-2`; and so on.
1674These identifiers are used to provide link targets in the table of
1675contents generated by the `--toc|--table-of-contents` option. They
1676also make it easy to provide links from one section of a document to
1677another. A link to this section, for example, might look like this:
1680 [header identifiers](#header-identifiers-in-html-latex-and-context).
1682Note, however, that this method of providing links to sections works
1683only in HTML, LaTeX, and ConTeXt formats.
1685If the `--section-divs` option is specified, then each section will
1686be wrapped in a `div` (or a `section`, if `--html5` was specified),
1687and the identifier will be attached to the enclosing `<div>`
1688(or `<section>`) tag rather than the header itself. This allows entire
1689sections to be manipulated using JavaScript or treated differently in
1692#### Extension: `implicit_header_references` ####
1694Pandoc behaves as if reference links have been defined for each header.
1695So, to link to a header
1697 # Header identifiers in HTML
1701 [Header identifiers in HTML]
1705 [Header identifiers in HTML][]
1709 [the section on header identifiers][header identifiers in
1712instead of giving the identifier explicitly:
1714 [Header identifiers in HTML](#header-identifiers-in-html)
1716If there are multiple headers with identical text, the corresponding
1717reference will link to the first one only, and you will need to use explicit
1718links to link to the others, as described above.
1720Like regular reference links, these references are case-insensitive.
1722Explicit link reference definitions always take priority over
1723implicit header references. So, in the following example, the
1724link will point to `bar`, not to `#foo`:
1735Markdown uses email conventions for quoting blocks of text.
1736A block quotation is one or more paragraphs or other block elements
1737(such as lists or headers), with each line preceded by a `>` character
1738and an optional space. (The `>` need not start at the left margin, but
1739it should not be indented more than three spaces.)
1741 > This is a block quote. This
1742 > paragraph has two lines.
1744 > 1. This is a list inside a block quote.
1747A "lazy" form, which requires the `>` character only on the first
1748line of each block, is also allowed:
1750 > This is a block quote. This
1751 paragraph has two lines.
1753 > 1. This is a list inside a block quote.
1756Among the block elements that can be contained in a block quote are
1757other block quotes. That is, block quotes can be nested:
1759 > This is a block quote.
1761 > > A block quote within a block quote.
1763If the `>` character is followed by an optional space, that space
1764will be considered part of the block quote marker and not part of
1765the indentation of the contents. Thus, to put an indented code
1766block in a block quote, you need five spaces after the `>`:
1770#### Extension: `blank_before_blockquote` ####
1772Standard Markdown syntax does not require a blank line before a block
1773quote. Pandoc does require this (except, of course, at the beginning of the
1774document). The reason for the requirement is that it is all too easy for a
1775`>` to end up at the beginning of a line by accident (perhaps through line
1776wrapping). So, unless the `markdown_strict` format is used, the following does
1777not produce a nested block quote in pandoc:
1779 > This is a block quote.
1783Verbatim (code) blocks
1784----------------------
1786### Indented code blocks ###
1788A block of text indented four spaces (or one tab) is treated as verbatim
1789text: that is, special characters do not trigger special formatting,
1790and all spaces and line breaks are preserved. For example,
1793 moveShip(5 * gravity, DOWN);
1796The initial (four space or one tab) indentation is not considered part
1797of the verbatim text, and is removed in the output.
1799Note: blank lines in the verbatim text need not begin with four spaces.
1802### Fenced code blocks ###
1804#### Extension: `fenced_code_blocks` ####
1806In addition to standard indented code blocks, pandoc supports
1807*fenced* code blocks. These begin with a row of three or more
1808tildes (`~`) and end with a row of tildes that must be at least as long as
1809the starting row. Everything between these lines is treated as code. No
1810indentation is necessary:
1814 moveShip(5 * gravity, DOWN);
1818Like regular code blocks, fenced code blocks must be separated
1819from surrounding text by blank lines.
1821If the code itself contains a row of tildes or backticks, just use a longer
1822row of tildes or backticks at the start and end:
1826 code including tildes
1830#### Extension: `backtick_code_blocks` ####
1832Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1835#### Extension: `fenced_code_attributes` ####
1837Optionally, you may attach attributes to fenced or backtick code block using
1840 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1842 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1843 qsort (filter (>= x) xs)
1844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1846Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1847`startFrom` is an attribute with value `100`. Some output formats can use this
1848information to do syntax highlighting. Currently, the only output formats
1849that uses this information are HTML and LaTeX. If highlighting is supported
1850for your output format and language, then the code block above will appear
1851highlighted, with numbered lines. (To see which languages are supported, type
1852`pandoc --list-highlight-languages`.) Otherwise, the code block above will
1855 <pre id="mycode" class="haskell numberLines" startFrom="100">
1861A shortcut form can also be used for specifying the language of
1868This is equivalent to:
1874If the `fenced_code_attributes` extension is disabled, but
1875input contains class attribute(s) for the code block, the first
1876class attribute will be printed after the opening fence as a bare
1879To prevent all highlighting, use the `--no-highlight` flag.
1880To set the highlighting style, use `--highlight-style`.
1881For more information on highlighting, see [Syntax highlighting],
1887#### Extension: `line_blocks` ####
1889A line block is a sequence of lines beginning with a vertical bar (`|`)
1890followed by a space. The division into lines will be preserved in
1891the output, as will any leading spaces; otherwise, the lines will
1892be formatted as Markdown. This is useful for verse and addresses:
1894 | The limerick packs laughs anatomical
1895 | In space that is quite economical.
1896 | But the good ones I've seen
1897 | So seldom are clean
1898 | And the clean ones so seldom are comical
1901 | Berkeley, CA 94718
1903The lines can be hard-wrapped if needed, but the continuation
1904line must begin with a space.
1906 | The Right Honorable Most Venerable and Righteous Samuel L.
1909 | Berkeley, CA 94718
1911This syntax is borrowed from [reStructuredText].
1918A bullet list is a list of bulleted list items. A bulleted list
1919item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1926This will produce a "compact" list. If you want a "loose" list, in which
1927each item is formatted as a paragraph, put spaces between the items:
1935The bullets need not be flush with the left margin; they may be
1936indented one, two, or three spaces. The bullet must be followed
1939List items look best if subsequent lines are flush with the first
1940line (after the bullet):
1946But Markdown also allows a "lazy" format:
1952### The four-space rule ###
1954A list item may contain multiple paragraphs and other block-level
1955content. However, subsequent paragraphs must be preceded by a blank line
1956and indented four spaces or a tab. The list will look better if the first
1957paragraph is aligned with the rest:
1963 * Second paragraph. With a code block, which must be indented
1968List items may include other lists. In this case the preceding blank
1969line is optional. The nested list must be indented four spaces or
1982As noted above, Markdown allows you to write list items "lazily," instead of
1983indenting continuation lines. However, if there are multiple paragraphs or
1984other blocks in a list item, the first line of each must be indented.
1986 + A lazy, lazy, list
1989 + Another one; this looks
1992 Second paragraph of second
1995**Note:** Although the four-space rule for continuation paragraphs
1996comes from the official [Markdown syntax guide], the reference implementation,
1997`Markdown.pl`, does not follow it. So pandoc will give different results than
1998`Markdown.pl` when authors have indented continuation paragraphs fewer than
2001The [Markdown syntax guide] is not explicit whether the four-space
2002rule applies to *all* block-level content in a list item; it only
2003mentions paragraphs and code blocks. But it implies that the rule
2004applies to all block-level content (including nested lists), and
2005pandoc interprets it that way.
2007 [Markdown syntax guide]:
2008 http://daringfireball.net/projects/markdown/syntax#list
2010### Ordered lists ###
2012Ordered lists work just like bulleted lists, except that the items
2013begin with enumerators rather than bullets.
2015In standard Markdown, enumerators are decimal numbers followed
2016by a period and a space. The numbers themselves are ignored, so
2017there is no difference between this list:
2029#### Extension: `fancy_lists` ####
2031Unlike standard Markdown, pandoc allows ordered list items to be marked
2032with uppercase and lowercase letters and roman numerals, in addition to
2033Arabic numerals. List markers may be enclosed in parentheses or followed by a
2034single right-parentheses or period. They must be separated from the
2035text that follows by at least one space, and, if the list marker is a
2036capital letter with a period, by at least two spaces.[^2]
2038[^2]: The point of this rule is to ensure that normal paragraphs
2039 starting with people's initials, like
2041 B. Russell was an English philosopher.
2043 do not get treated as list items.
2045 This rule will not prevent
2049 from being interpreted as a list item. In this case, a backslash
2054The `fancy_lists` extension also allows '`#`' to be used as an
2055ordered list marker in place of a numeral:
2060#### Extension: `startnum` ####
2062Pandoc also pays attention to the type of list marker used, and to the
2063starting number, and both of these are preserved where possible in the
2064output format. Thus, the following yields a list with numbers followed
2065by a single parenthesis, starting with 9, and a sublist with lowercase
2075Pandoc will start a new list each time a different type of list
2076marker is used. So, the following will create three lists:
2083If default list markers are desired, use `#.`:
2090### Definition lists ###
2092#### Extension: `definition_lists` ####
2094Pandoc supports definition lists, using the syntax of
2095[PHP Markdown Extra] with some extensions.[^3]
2101 Term 2 with *inline markup*
2105 { some code, part of Definition 2 }
2107 Third paragraph of definition 2.
2109Each term must fit on one line, which may optionally be followed by
2110a blank line, and must be followed by one or more definitions.
2111A definition begins with a colon or tilde, which may be indented one
2114A term may have multiple definitions, and each definition may consist of one or
2115more block elements (paragraph, code block, list, etc.), each indented four
2116spaces or one tab stop. The body of the definition (including the first line,
2117aside from the colon or tilde) should be indented four spaces. However,
2118as with other Markdown lists, you can "lazily" omit indentation except
2119at the beginning of a paragraph or other block element:
2124 with lazy continuation.
2126 Second paragraph of the definition.
2128If you leave space before the definition (as in the example above),
2129the text of the definition will be treated as a paragraph. In some
2130output formats, this will mean greater spacing between term/definition
2131pairs. For a more compact definition list, omit the space before the
2141Note that space between items in a definition list is required.
2142(A variant that loosens this requirement, but disallows "lazy"
2143hard wrapping, can be activated with `compact_definition_lists`: see
2144[Non-pandoc extensions], below.)
2146[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2148### Numbered example lists ###
2150#### Extension: `example_lists` ####
2152The special list marker `@` can be used for sequentially numbered
2153examples. The first list item with a `@` marker will be numbered '1',
2154the next '2', and so on, throughout the document. The numbered examples
2155need not occur in a single list; each new list using `@` will take up
2156where the last stopped. So, for example:
2158 (@) My first example will be numbered (1).
2159 (@) My second example will be numbered (2).
2161 Explanation of examples.
2163 (@) My third example will be numbered (3).
2165Numbered examples can be labeled and referred to elsewhere in the
2168 (@good) This is a good example.
2170 As (@good) illustrates, ...
2172The label can be any string of alphanumeric characters, underscores,
2176### Compact and loose lists ###
2178Pandoc behaves differently from `Markdown.pl` on some "edge
2179cases" involving lists. Consider this source:
2189Pandoc transforms this into a "compact list" (with no `<p>` tags around
2190"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2191"Second" and "Third" (but not "First"), because of the blank space
2192around "Third". Pandoc follows a simple rule: if the text is followed by
2193a blank line, it is treated as a paragraph. Since "Second" is followed
2194by a list, and not a blank line, it isn't treated as a paragraph. The
2195fact that the list is followed by a blank line is irrelevant. (Note:
2196Pandoc works this way even when the `markdown_strict` format is specified. This
2197behavior is consistent with the official Markdown syntax description,
2198even though it is different from that of `Markdown.pl`.)
2201### Ending a list ###
2203What if you want to put an indented code block after a list?
2210Trouble! Here pandoc (like other Markdown implementations) will treat
2211`{ my code block }` as the second paragraph of item two, and not as
2214To "cut off" the list after item two, you can insert some non-indented
2215content, like an HTML comment, which won't produce visible output in
2221 <!-- end of list -->
2225You can use the same trick if you want two consecutive lists instead
2241A line containing a row of three or more `*`, `-`, or `_` characters
2242(optionally separated by spaces) produces a horizontal rule:
2252Four kinds of tables may be used. The first three kinds presuppose the use of
2253a fixed-width font, such as Courier. The fourth kind can be used with
2254proportionally spaced fonts, as it does not require lining up columns.
2256#### Extension: `table_captions` ####
2258A caption may optionally be provided with all 4 kinds of tables (as
2259illustrated in the examples below). A caption is a paragraph beginning
2260with the string `Table:` (or just `:`), which will be stripped off.
2261It may appear either before or after the table.
2263#### Extension: `simple_tables` ####
2265Simple tables look like this:
2267 Right Left Center Default
2268 ------- ------ ---------- -------
2273 Table: Demonstration of simple table syntax.
2275The headers and table rows must each fit on one line. Column
2276alignments are determined by the position of the header text relative
2277to the dashed line below it:[^4]
2279 - If the dashed line is flush with the header text on the right side
2280 but extends beyond it on the left, the column is right-aligned.
2281 - If the dashed line is flush with the header text on the left side
2282 but extends beyond it on the right, the column is left-aligned.
2283 - If the dashed line extends beyond the header text on both sides,
2284 the column is centered.
2285 - If the dashed line is flush with the header text on both sides,
2286 the default alignment is used (in most cases, this will be left).
2288[^4]: This scheme is due to Michel Fortin, who proposed it on the
2289 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2291The table must end with a blank line, or a line of dashes followed by
2294The column headers may be omitted, provided a dashed line is used
2295to end the table. For example:
2297 ------- ------ ---------- -------
2301 ------- ------ ---------- -------
2303When headers are omitted, column alignments are determined on the basis
2304of the first line of the table body. So, in the tables above, the columns
2305would be right, left, center, and right aligned, respectively.
2307#### Extension: `multiline_tables` ####
2309Multiline tables allow headers and table rows to span multiple lines
2310of text (but cells that span multiple columns or rows of the table are
2311not supported). Here is an example:
2313 -------------------------------------------------------------
2314 Centered Default Right Left
2315 Header Aligned Aligned Aligned
2316 ----------- ------- --------------- -------------------------
2317 First row 12.0 Example of a row that
2318 spans multiple lines.
2320 Second row 5.0 Here's another one. Note
2321 the blank line between
2323 -------------------------------------------------------------
2325 Table: Here's the caption. It, too, may span
2328These work like simple tables, but with the following differences:
2330 - They must begin with a row of dashes, before the header text
2331 (unless the headers are omitted).
2332 - They must end with a row of dashes, then a blank line.
2333 - The rows must be separated by blank lines.
2335In multiline tables, the table parser pays attention to the widths of
2336the columns, and the writers try to reproduce these relative widths in
2337the output. So, if you find that one of the columns is too narrow in the
2338output, try widening it in the Markdown source.
2340Headers may be omitted in multiline tables as well as simple tables:
2342 ----------- ------- --------------- -------------------------
2343 First row 12.0 Example of a row that
2344 spans multiple lines.
2346 Second row 5.0 Here's another one. Note
2347 the blank line between
2349 ----------- ------- --------------- -------------------------
2351 : Here's a multiline table without headers.
2353It is possible for a multiline table to have just one row, but the row
2354should be followed by a blank line (and then the row of dashes that ends
2355the table), or the table may be interpreted as a simple table.
2357#### Extension: `grid_tables` ####
2359Grid tables look like this:
2361 : Sample grid table.
2363 +---------------+---------------+--------------------+
2364 | Fruit | Price | Advantages |
2365 +===============+===============+====================+
2366 | Bananas | $1.34 | - built-in wrapper |
2367 | | | - bright color |
2368 +---------------+---------------+--------------------+
2369 | Oranges | $2.10 | - cures scurvy |
2371 +---------------+---------------+--------------------+
2373The row of `=`s separates the header from the table body, and can be
2374omitted for a headerless table. The cells of grid tables may contain
2375arbitrary block elements (multiple paragraphs, code blocks, lists,
2376etc.). Cells that span multiple columns or rows are not
2377supported. Grid tables can be created easily using [Emacs table mode].
2379[Emacs table mode]: http://table.sourceforge.net/
2381Alignments can be specified as with pipe tables, by putting
2382colons at the boundaries of the separator line after the
2385 +---------------+---------------+--------------------+
2386 | Right | Left | Centered |
2387 +==============:+:==============+:==================:+
2388 | Bananas | $1.34 | built-in wrapper |
2389 +---------------+---------------+--------------------+
2391For headerless tables, the colons go on the top line instead:
2393 +--------------:+:--------------+:------------------:+
2394 | Right | Left | Centered |
2395 +---------------+---------------+--------------------+
2398#### Extension: `pipe_tables` ####
2400Pipe tables look like this:
2402 | Right | Left | Default | Center |
2403 |------:|:-----|---------|:------:|
2404 | 12 | 12 | 12 | 12 |
2405 | 123 | 123 | 123 | 123 |
2408 : Demonstration of pipe table syntax.
2410The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2411ending pipe characters are optional, but pipes are required between all
2412columns. The colons indicate column alignment as shown. The header
2413cannot be omitted. To simulate a headerless table, include a header
2416Since the pipes indicate column boundaries, columns need not be vertically
2417aligned, as they are in the above example. So, this is a perfectly
2418legal (though ugly) pipe table:
2426The cells of pipe tables cannot contain block elements like paragraphs
2427and lists, and cannot span multiple lines. If a pipe table contains a
2428row whose printable content is wider than the column width (see
2429`--columns`), then the cell contents will wrap, with the
2430relative cell widths determined by the widths of the separator
2433Note: pandoc also recognizes pipe tables of the following
2434form, as can be produced by Emacs' orgtbl-mode:
2441The difference is that `+` is used instead of `|`. Other orgtbl features
2442are not supported. In particular, to get non-default column alignment,
2443you'll need to add colons as above.
2445[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2450#### Extension: `pandoc_title_block` ####
2452If the file begins with a title block
2455 % author(s) (separated by semicolons)
2458it will be parsed as bibliographic information, not regular text. (It
2459will be used, for example, in the title of standalone LaTeX or HTML
2460output.) The block may contain just a title, a title and an author,
2461or all three elements. If you want to include an author but no
2462title, or a title and a date but no author, you need a blank line:
2471The title may occupy multiple lines, but continuation lines must
2472begin with leading space, thus:
2477If a document has multiple authors, the authors may be put on
2478separate lines with leading space, or separated by semicolons, or
2479both. So, all of the following are equivalent:
2484 % Author One; Author Two
2489The date must fit on one line.
2491All three metadata fields may contain standard inline formatting
2492(italics, links, footnotes, etc.).
2494Title blocks will always be parsed, but they will affect the output only
2495when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2496will appear twice: once in the document head -- this is the title that
2497will appear at the top of the window in a browser -- and once at the
2498beginning of the document body. The title in the document head can have
2499an optional prefix attached (`--title-prefix` or `-T` option). The title
2500in the body appears as an H1 element with class "title", so it can be
2501suppressed or reformatted with CSS. If a title prefix is specified with
2502`-T` and no title block appears in the document, the title prefix will
2503be used by itself as the HTML title.
2505The man page writer extracts a title, man page section number, and
2506other header and footer information from the title line. The title
2507is assumed to be the first word on the title line, which may optionally
2508end with a (single-digit) section number in parentheses. (There should
2509be no space between the title and the parentheses.) Anything after
2510this is assumed to be additional footer and header text. A single pipe
2511character (`|`) should be used to separate the footer text from the header
2516will yield a man page with the title `PANDOC` and section 1.
2518 % PANDOC(1) Pandoc User Manuals
2520will also have "Pandoc User Manuals" in the footer.
2522 % PANDOC(1) Pandoc User Manuals | Version 4.0
2524will also have "Version 4.0" in the header.
2526#### Extension: `yaml_metadata_block` ####
2528A YAML metadata block is a valid YAML object, delimited by a line of three
2529hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2530(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2531document, but if it is not at the beginning, it must be preceded by a blank
2532line. (Note that, because of the way pandoc concatenates input files when
2533several are provided, you may also keep the metadata in a separate YAML file
2534and pass it to pandoc as an argument, along with your Markdown files:
2536 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2538Just be sure that the YAML file begins with `---` and ends with `---` or
2541Metadata will be taken from the fields of the YAML object and added to any
2542existing document metadata. Metadata can contain lists and objects (nested
2543arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2544with names ending in an underscore will be ignored by pandoc. (They may be
2545given a role by external processors.)
2547A document may contain multiple metadata blocks. The metadata fields will
2548be combined through a *left-biased union*: if two metadata blocks attempt
2549to set the same field, the value from the first block will be taken.
2551When pandoc is used with `-t markdown` to create a Markdown document,
2552a YAML metadata block will be produced only if the `-s/--standalone`
2553option is used. All of the metadata will appear in a single block
2554at the beginning of the document.
2556Note that YAML escaping rules must be followed. Thus, for example,
2557if a title contains a colon, it must be quoted. The pipe character
2558(`|`) can be used to begin an indented block that will be interpreted
2559literally, without need for escaping. This form is necessary
2560when the field contains blank lines:
2563 title: 'This is the title: it contains a colon'
2567 tags: [nothing, nothingness]
2569 This is the abstract.
2571 It consists of two paragraphs.
2574Template variables will be set automatically from the metadata. Thus, for
2575example, in writing HTML, the variable `abstract` will be set to the HTML
2576equivalent of the Markdown in the `abstract` field:
2578 <p>This is the abstract.</p>
2579 <p>It consists of two paragraphs.</p>
2581Variables can contain arbitrary YAML structures, but the template must match
2582this structure. The `author` variable in the default templates expects a
2583simple list or string, but can be changed to support more complicated
2584structures. The following combination, for example, would add an affiliation
2585to the author if one is given:
2588 title: The document title
2591 affiliation: University of Somewhere
2593 affiliation: University of Nowhere
2596To use the structured authors in the example above, you would need a custom
2601 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2611#### Extension: `all_symbols_escapable` ####
2613Except inside a code block or inline code, any punctuation or space
2614character preceded by a backslash will be treated literally, even if it
2615would normally indicate formatting. Thus, for example, if one writes
2625 <strong>hello</strong>
2627This rule is easier to remember than standard Markdown's rule,
2628which allows only the following characters to be backslash-escaped:
2632(However, if the `markdown_strict` format is used, the standard Markdown rule
2635A backslash-escaped space is parsed as a nonbreaking space. It will
2636appear in TeX output as `~` and in HTML and XML as `\ ` or
2639A backslash-escaped newline (i.e. a backslash occurring at the end of
2640a line) is parsed as a hard line break. It will appear in TeX output as
2641`\\` and in HTML as `<br />`. This is a nice alternative to
2642Markdown's "invisible" way of indicating hard line breaks using
2643two trailing spaces on a line.
2645Backslash escapes do not work in verbatim contexts.
2652If the `--smart` option is specified, pandoc will produce typographically
2653correct output, converting straight quotes to curly quotes, `---` to
2654em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2655are inserted after certain abbreviations, such as "Mr."
2657Note: if your LaTeX template or any included header file call for the
2658[`csquotes`] package, pandoc will detect this automatically and use
2659`\enquote{...}` for quoted text.
2666To *emphasize* some text, surround it with `*`s or `_`, like this:
2668 This text is _emphasized with underscores_, and this
2669 is *emphasized with asterisks*.
2671Double `*` or `_` produces **strong emphasis**:
2673 This is **strong emphasis** and __with underscores__.
2675A `*` or `_` character surrounded by spaces, or backslash-escaped,
2676will not trigger emphasis:
2678 This is * not emphasized *, and \*neither is this\*.
2680#### Extension: `intraword_underscores` ####
2682Because `_` is sometimes used inside words and identifiers,
2683pandoc does not interpret a `_` surrounded by alphanumeric
2684characters as an emphasis marker. If you want to emphasize
2685just part of a word, use `*`:
2687 feas*ible*, not feas*able*.
2692#### Extension: `strikeout` ####
2694To strikeout a section of text with a horizontal line, begin and end it
2695with `~~`. Thus, for example,
2697 This ~~is deleted text.~~
2700### Superscripts and subscripts ###
2702#### Extension: `superscript`, `subscript` ####
2704Superscripts may be written by surrounding the superscripted text by `^`
2705characters; subscripts may be written by surrounding the subscripted
2706text by `~` characters. Thus, for example,
2708 H~2~O is a liquid. 2^10^ is 1024.
2710If the superscripted or subscripted text contains spaces, these spaces
2711must be escaped with backslashes. (This is to prevent accidental
2712superscripting and subscripting through the ordinary use of `~` and `^`.)
2713Thus, if you want the letter P with 'a cat' in subscripts, use
2714`P~a\ cat~`, not `P~a cat~`.
2719To make a short span of text verbatim, put it inside backticks:
2721 What is the difference between `>>=` and `>>`?
2723If the verbatim text includes a backtick, use double backticks:
2725 Here is a literal backtick `` ` ``.
2727(The spaces after the opening backticks and before the closing
2728backticks will be ignored.)
2730The general rule is that a verbatim span starts with a string
2731of consecutive backticks (optionally followed by a space)
2732and ends with a string of the same number of backticks (optionally
2733preceded by a space).
2735Note that backslash-escapes (and other Markdown constructs) do not
2736work in verbatim contexts:
2738 This is a backslash followed by an asterisk: `\*`.
2740#### Extension: `inline_code_attributes` ####
2742Attributes can be attached to verbatim text, just as with
2743[fenced code blocks]:
2749To write small caps, you can use an HTML span tag:
2751 <span style="font-variant:small-caps;">Small caps</span>
2753(The semicolon is optional and there may be space after the
2754colon.) This will work in all output formats that support small caps.
2756Alternatively, you can also use the new `bracketed_spans` syntax:
2758 [Small caps]{style="font-variant:small-caps;"}
2763#### Extension: `tex_math_dollars` ####
2765Anything between two `$` characters will be treated as TeX math. The
2766opening `$` must have a non-space character immediately to its right,
2767while the closing `$` must have a non-space character immediately to its
2768left, and must not be followed immediately by a digit. Thus,
2769`$20,000 and $30,000` won't parse as math. If for some reason
2770you need to enclose text in literal `$` characters, backslash-escape
2771them and they won't be treated as math delimiters.
2773TeX math will be printed in all output formats. How it is rendered
2774depends on the output format:
2776Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2777 ~ It will appear verbatim between `$` characters.
2780 ~ It will be rendered using an [interpreted text role `:math:`].
2783 ~ It will be rendered as `latexmath:[...]`.
2786 ~ It will be rendered inside a `@math` command.
2789 ~ It will be rendered verbatim without `$`'s.
2792 ~ It will be rendered inside `<math>` tags.
2795 ~ It will be rendered inside `<span class="math">` tags.
2797RTF, OpenDocument, ODT
2798 ~ It will be rendered, if possible, using Unicode characters,
2799 and will otherwise appear verbatim.
2802 ~ If the `--mathml` flag is used, it will be rendered using MathML
2803 in an `inlineequation` or `informalequation` tag. Otherwise it
2804 will be rendered, if possible, using Unicode characters.
2807 ~ It will be rendered using OMML math markup.
2810 ~ If the `--webtex` option is used, formulas are rendered as images
2811 using CodeCogs or other compatible web service, downloaded
2812 and embedded in the e-book. Otherwise, they will appear verbatim.
2814HTML, Slidy, DZSlides, S5, EPUB
2815 ~ The way math is rendered in HTML will depend on the
2816 command-line options selected:
2818 1. The default is to render TeX math as far as possible using Unicode
2819 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2820 are put inside a `span` with `class="math"`, so that they may be
2821 styled differently from the surrounding text if needed.
2823 2. If the `--latexmathml` option is used, TeX math will be displayed
2824 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2825 The [LaTeXMathML] script will be used to render it as formulas.
2826 (This trick does not work in all browsers, but it works in Firefox.
2827 In browsers that do not support LaTeXMathML, TeX math will appear
2828 verbatim between `$` characters.)
2830 3. If the `--jsmath` option is used, TeX math will be put inside
2831 `<span>` tags (for inline math) or `<div>` tags (for display math)
2832 with class `math`. The [jsMath] script will be used to render
2835 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2836 be called to generate images for each TeX formula. This should
2837 work in all browsers. The `--mimetex` option takes an optional URL
2838 as argument. If no URL is specified, it will be assumed that the
2839 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2841 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2842 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2843 be processed by [gladTeX], which will produce image files for each
2844 formula and an HTML file with links to these images. So, the
2847 pandoc -s --gladtex myfile.txt -o myfile.htex
2848 gladtex -d myfile-images myfile.htex
2849 # produces myfile.html and images in myfile-images
2851 6. If the `--webtex` option is used, TeX formulas will be converted
2852 to `<img>` tags that link to an external script that converts
2853 formulas to images. The formula will be URL-encoded and concatenated
2854 with the URL provided. If no URL is specified, the CodeCogs
2855 will be used (`https://latex.codecogs.com/png.latex?`).
2857 7. If the `--mathjax` option is used, TeX math will be displayed
2858 between `\(...\)` (for inline math) or `\[...\]` (for display
2859 math) and put in `<span>` tags with class `math`.
2860 The [MathJax] script will be used to render it as formulas.
2862[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2867#### Extension: `raw_html` ####
2869Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2870(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2871literally). (Technically this is not an extension, since standard
2872Markdown allows it, but it has been made an extension so that it can
2873be disabled if desired.)
2875The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2876DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
2879#### Extension: `markdown_in_html_blocks` ####
2881Standard Markdown allows you to include HTML "blocks": blocks
2882of HTML between balanced tags that are separated from the surrounding text
2883with blank lines, and start and end at the left margin. Within
2884these blocks, everything is interpreted as HTML, not Markdown;
2885so (for example), `*` does not signify emphasis.
2887Pandoc behaves this way when the `markdown_strict` format is used; but
2888by default, pandoc interprets material between HTML block tags as Markdown.
2889Thus, for example, pandoc will turn
2894 <td>[a link](http://google.com)</td>
2902 <td><em>one</em></td>
2903 <td><a href="http://google.com">a link</a></td>
2907whereas `Markdown.pl` will preserve it as is.
2909There is one exception to this rule: text between `<script>` and
2910`<style>` tags is not interpreted as Markdown.
2912This departure from standard Markdown should make it easier to mix
2913Markdown with HTML block elements. For example, one can surround
2914a block of Markdown text with `<div>` tags without preventing it
2915from being interpreted as Markdown.
2917#### Extension: `native_divs` ####
2919Use native pandoc `Div` blocks for content inside `<div>` tags.
2920For the most part this should give the same output as
2921`markdown_in_html_blocks`, but it makes it easier to write pandoc
2922filters to manipulate groups of blocks.
2924#### Extension: `native_spans` ####
2926Use native pandoc `Span` blocks for content inside `<span>` tags.
2927For the most part this should give the same output as `raw_html`,
2928but it makes it easier to write pandoc filters to manipulate groups
2934#### Extension: `raw_tex` ####
2936In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2937included in a document. Inline TeX commands will be preserved and passed
2938unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2939LaTeX to include BibTeX citations:
2941 This result was proved in \cite{jones.1967}.
2943Note that in LaTeX environments, like
2945 \begin{tabular}{|l|l|}\hline
2946 Age & Frequency \\ \hline
2949 36--45 & 22 \\ \hline
2952the material between the begin and end tags will be interpreted as raw
2953LaTeX, not as Markdown.
2955Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2956Emacs Org mode, and ConTeXt.
2961#### Extension: `latex_macros` ####
2963For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2964`\renewcommand` definitions and apply the resulting macros to all LaTeX
2965math. So, for example, the following will work in all output formats,
2968 \newcommand{\tuple}[1]{\langle #1 \rangle}
2972In LaTeX output, the `\newcommand` definition will simply be passed
2973unchanged to the output.
2979Markdown allows links to be specified in several ways.
2981### Automatic links ###
2983If you enclose a URL or email address in pointy brackets, it
2987 <sam@green.eggs.ham>
2991An inline link consists of the link text in square brackets,
2992followed by the URL in parentheses. (Optionally, the URL can
2993be followed by a link title, in quotes.)
2995 This is an [inline link](/url), and here's [one with
2996 a title](http://fsf.org "click here for a good time!").
2998There can be no space between the bracketed part and the parenthesized part.
2999The link text can contain formatting (such as emphasis), but the title cannot.
3001Email addresses in inline links are not autodetected, so they have to be
3002prefixed with `mailto`:
3004 [Write me!](mailto:sam@green.eggs.ham)
3006### Reference links ###
3008An *explicit* reference link has two parts, the link itself and the link
3009definition, which may occur elsewhere in the document (either
3010before or after the link).
3012The link consists of link text in square brackets, followed by a label in
3013square brackets. (There can be space between the two.) The link definition
3014consists of the bracketed label, followed by a colon and a space, followed by
3015the URL, and optionally (after a space) a link title either in quotes or in
3016parentheses. The label must not be parseable as a citation (assuming
3017the `citations` extension is enabled): citations take precedence over
3020Here are some examples:
3022 [my label 1]: /foo/bar.html "My title, optional"
3024 [my label 3]: http://fsf.org (The free software foundation)
3025 [my label 4]: /bar#special 'A title in single quotes'
3027The URL may optionally be surrounded by angle brackets:
3029 [my label 5]: <http://foo.bar.baz>
3031The title may go on the next line:
3033 [my label 3]: http://fsf.org
3034 "The free software foundation"
3036Note that link labels are not case sensitive. So, this will work:
3038 Here is [my link][FOO]
3042In an *implicit* reference link, the second pair of brackets is
3047 [my website]: http://foo.bar.baz
3049Note: In `Markdown.pl` and most other Markdown implementations,
3050reference link definitions cannot occur in nested constructions
3051such as list items or block quotes. Pandoc lifts this arbitrary
3052seeming restriction. So the following is fine in pandoc, though
3053not in most other implementations:
3059#### Extension: `shortcut_reference_links` ####
3061In a *shortcut* reference link, the second pair of brackets may
3066 [my website]: http://foo.bar.baz
3068### Internal links ###
3070To link to another section of the same document, use the automatically
3071generated identifier (see [Header identifiers]). For example:
3073 See the [Introduction](#introduction).
3077 See the [Introduction].
3079 [Introduction]: #introduction
3081Internal links are currently supported for HTML formats (including
3082HTML slide shows and EPUB), LaTeX, and ConTeXt.
3087A link immediately preceded by a `!` will be treated as an image.
3088The link text will be used as the image's alt text:
3090 
3094 [movie reel]: movie.gif
3096#### Extension: `implicit_figures` ####
3098An image occurring by itself in a paragraph will be rendered as
3099a figure with a caption.[^5] (In LaTeX, a figure environment will be
3100used; in HTML, the image will be placed in a `div` with class
3101`figure`, together with a caption in a `p` with class `caption`.)
3102The image's alt text will be used as the caption.
3104 
3106[^5]: This feature is not yet implemented for RTF, OpenDocument, or
3107 ODT. In those formats, you'll just get an image in a paragraph by
3108 itself, with no caption.
3110If you just want a regular inline image, just make sure it is not
3111the only thing in the paragraph. One way to do this is to insert a
3112nonbreaking space after the image:
3114 \
3116#### Extension: `link_attributes` ####
3118Attributes can be set on links and images:
3120 An inline {#id .class width=30 height=20px}
3121 and a reference ![image][ref] with attributes.
3123 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3125(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3126and `.class` are used.)
3128For HTML and EPUB, all attributes except `width` and `height` (but
3129including `srcset` and `sizes`) are passed through as is. The other
3130writers ignore attributes that are not supported by their output
3133The `width` and `height` attributes on images are treated specially. When
3134used without a unit, the unit is assumed to be pixels. However, any of
3135the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3136and `%`. There must not be any spaces between the number and the unit.
3140{ width=50% }
3143- Dimensions are converted to inches for output in page-based formats like
3144 LaTeX. Dimensions are converted to pixels for output in HTML-like
3145 formats. Use the `--dpi` option to specify the number of pixels per
3146 inch. The default is 96dpi.
3147- The `%` unit is generally relative to some available space.
3148 For example the above example will render to
3149 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3150 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3151 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3152- Some output formats have a notion of a class
3153 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3154 or a unique identifier (LaTeX `\caption`), or both (HTML).
3155- When no `width` or `height` attributes are specified, the fallback
3156 is to look at the image resolution and the dpi metadata embedded in
3162#### Extension: `bracketed_spans` ####
3164A bracketed sequence of inlines, as one would use to begin
3165a link, will be treated as a span with attributes if it is
3166followed immediately by attributes:
3168 [This is *some text*]{.class key="val"}
3173#### Extension: `footnotes` ####
3175Pandoc's Markdown allows footnotes, using the following syntax:
3177 Here is a footnote reference,[^1] and another.[^longnote]
3179 [^1]: Here is the footnote.
3181 [^longnote]: Here's one with multiple blocks.
3183 Subsequent paragraphs are indented to show that they
3184 belong to the previous footnote.
3188 The whole paragraph can be indented, or just the first
3189 line. In this way, multi-paragraph footnotes work like
3190 multi-paragraph list items.
3192 This paragraph won't be part of the note, because it
3195The identifiers in footnote references may not contain spaces, tabs,
3196or newlines. These identifiers are used only to correlate the
3197footnote reference with the note itself; in the output, footnotes
3198will be numbered sequentially.
3200The footnotes themselves need not be placed at the end of the
3201document. They may appear anywhere except inside other block elements
3202(lists, block quotes, tables, etc.). Each footnote should be
3203separated from surrounding content (including other footnotes)
3206#### Extension: `inline_notes` ####
3208Inline footnotes are also allowed (though, unlike regular notes,
3209they cannot contain multiple paragraphs). The syntax is as follows:
3211 Here is an inline note.^[Inlines notes are easier to write, since
3212 you don't have to pick an identifier and move down to type the
3215Inline and regular footnotes may be mixed freely.
3221#### Extension: `citations` ####
3223Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3224citations and a bibliography in a number of styles. Basic usage is
3226 pandoc --filter pandoc-citeproc myinput.txt
3228In order to use this feature, you will need to specify a bibliography file
3229using the `bibliography` metadata field in a YAML metadata section, or
3230`--bibliography` command line argument. You can supply multiple `--bibliography`
3231arguments or set `bibliography` metadata field to YAML array, if you want to
3232use multiple bibliography files. The bibliography may have any of these
3235 Format File extension
3236 ------------ --------------
3249Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3250use `.bibtex` to force BibTeX.
3252Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3253can produce `.json` and `.yaml` files from any of the supported formats.
3255In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3256a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3264`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3273`<span class="nocase">...</span>`
3274: prevent a phrase from being capitalized as title case
3276`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3277and CSL YAML formats as far as possible.
3279As an alternative to specifying a bibliography file using `--bibliography`
3280or the YAML metadata field `bibliography`, you can include
3281the citation data directly in the `references` field of the
3282document's YAML metadata. The field should contain an array of
3283YAML-encoded references, for example:
3287 - type: article-journal
3299 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3301 title-short: Molecular structure of nucleic acids
3302 container-title: Nature
3306 DOI: 10.1038/171737a0
3307 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3311(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3312of the supported formats.)
3314Citations and references can be formatted using any style supported by the
3315[Citation Style Language], listed in the [Zotero Style Repository].
3316These files are specified using the `--csl` option or the `csl` metadata field.
3317By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3318format. The CSL project provides further information on [finding and editing styles].
3320To make your citations hyperlinks to the corresponding bibliography
3321entries, add `link-citations: true` to your YAML metadata.
3323Citations go inside square brackets and are separated by semicolons.
3324Each citation must have a key, composed of '@' + the citation
3325identifier from the database, and may optionally have a prefix,
3326a locator, and a suffix. The citation key must begin with a letter, digit,
3327or `_`, and may contain alphanumerics, `_`, and internal punctuation
3328characters (`:.#$%&-+?<>~/`). Here are some examples:
3330 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3332 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3334 Blah blah [@smith04; @doe99].
3336`pandoc-citeproc` detects locator terms in the [CSL locale files].
3337Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3338locale, locator terms can be written in either singular or plural forms,
3339as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3340`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3341`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3342`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3343`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3344`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3345locator term is used, "page" is assumed.
3347A minus sign (`-`) before the `@` will suppress mention of
3348the author in the citation. This can be useful when the
3349author is already mentioned in the text:
3351 Smith says blah [-@smith04].
3353You can also write an in-text citation, as follows:
3357 @smith04 [p. 33] says blah.
3359If the style calls for a list of works cited, it will be placed
3360at the end of the document. Normally, you will want to end your
3361document with an appropriate header:
3367The bibliography will be inserted after this header. Note that
3368the `unnumbered` class will be added to this header, so that the
3369section will not be numbered.
3371If you want to include items in the bibliography without actually
3372citing them in the body text, you can define a dummy `nocite` metadata
3373field and put the citations there:
3382In this example, the document will contain a citation for `item3`
3383only, but the bibliography will contain entries for `item1`, `item2`, and
3386It is possible to create a bibliography with all the citations,
3387whether or not they appear in the document, by using a wildcard:
3394For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3395to render bibliography. In order to do so, specify bibliography files as
3396outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3397invocation. Bear in mind that bibliography files have to be in respective
3398format (either BibTeX or BibLaTeX).
3400For more information, see the [pandoc-citeproc man page].
3402[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3403[Chicago Manual of Style]: http://chicagomanualofstyle.org
3404[Citation Style Language]: http://citationstyles.org
3405[Zotero Style Repository]: https://www.zotero.org/styles
3406[finding and editing styles]: http://citationstyles.org/styles/
3407[CSL locale files]: https://github.com/citation-style-language/locales
3408[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3410Non-pandoc extensions
3411---------------------
3413The following Markdown syntax extensions are not enabled by default
3414in pandoc, but may be enabled by adding `+EXTENSION` to the format
3415name, where `EXTENSION` is the name of the extension. Thus, for
3416example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3418#### Extension: `angle_brackets_escapable` ####
3420Allow `<` and `>` to be backslash-escaped, as they can be in
3421GitHub flavored Markdown but not original Markdown. This is
3422implied by pandoc's default `all_symbols_escapable`.
3424#### Extension: `lists_without_preceding_blankline` ####
3426Allow a list to occur right after a paragraph, with no intervening
3429#### Extension: `hard_line_breaks` ####
3431Causes all newlines within a paragraph to be interpreted as hard line
3432breaks instead of spaces.
3434#### Extension: `ignore_line_breaks` ####
3436Causes newlines within a paragraph to be ignored, rather than being
3437treated as spaces or as hard line breaks. This option is intended for
3438use with East Asian languages where spaces are not used between words,
3439but text is divided into lines for readability.
3441#### Extension: `east_asian_line_breaks` ####
3443Causes newlines within a paragraph to be ignored, rather than
3444being treated as spaces or as hard line breaks, when they occur
3445between two East Asian wide characters. This is a better choice
3446than `ignore_line_breaks` for texts that include a mix of East
3447Asian wide characters and other characters.
3449##### Extension: `emoji` ####
3451Parses textual emojis like `:smile:` as Unicode emoticons.
3453#### Extension: `tex_math_single_backslash` ####
3455Causes anything between `\(` and `\)` to be interpreted as inline
3456TeX math, and anything between `\[` and `\]` to be interpreted
3457as display TeX math. Note: a drawback of this extension is that
3458it precludes escaping `(` and `[`.
3460#### Extension: `tex_math_double_backslash` ####
3462Causes anything between `\\(` and `\\)` to be interpreted as inline
3463TeX math, and anything between `\\[` and `\\]` to be interpreted
3466#### Extension: `markdown_attribute` ####
3468By default, pandoc interprets material inside block-level tags as Markdown.
3469This extension changes the behavior so that Markdown is only parsed
3470inside block-level tags if the tags have the attribute `markdown=1`.
3472#### Extension: `mmd_title_block` ####
3474Enables a [MultiMarkdown] style title block at the top of
3475the document, for example:
3479 Date: September 1, 2008
3480 Comment: This is a sample mmd title block, with
3481 a field spanning multiple lines.
3483See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3484`yaml_metadata_block` is enabled, it will take precedence over
3487#### Extension: `abbreviations` ####
3489Parses PHP Markdown Extra abbreviation keys, like
3491 *[HTML]: Hypertext Markup Language
3493Note that the pandoc document model does not support
3494abbreviations, so if this extension is enabled, abbreviation keys are
3495simply skipped (as opposed to being parsed as paragraphs).
3497#### Extension: `autolink_bare_uris` ####
3499Makes all absolute URIs into links, even when not surrounded by
3500pointy braces `<...>`.
3502#### Extension: `ascii_identifiers` ####
3504Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3505Accents are stripped off of accented Latin letters, and non-Latin
3508#### Extension: `mmd_link_attributes` ####
3510Parses multimarkdown style key-value attributes on link
3511and image references. This extension should not be confused with the
3512[`link_attributes`](#extension-link_attributes) extension.
3514 This is a reference ![image][ref] with multimarkdown attributes.
3516 [ref]: http://path.to/image "Image title" width=20px height=30px
3517 id=myId class="myClass1 myClass2"
3519#### Extension: `mmd_header_identifiers` ####
3521Parses multimarkdown style header identifiers (in square brackets,
3522after the header but before any trailing `#`s in an ATX header).
3524#### Extension: `compact_definition_lists` ####
3526Activates the definition list syntax of pandoc 1.12.x and earlier.
3527This syntax differs from the one described above under [Definition lists]
3530 - No blank line is required between consecutive items of the
3532 - To get a "tight" or "compact" list, omit space between consecutive
3533 items; the space between a term and its definition does not affect
3535 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3536 be indented four spaces.[^6]
3538[^6]: To see why laziness is incompatible with relaxing the requirement
3539 of a blank line between items, consider the following example:
3546 Is this a single list item with two definitions of "bar," the first of
3547 which is lazily wrapped, or two list items? To remove the ambiguity
3548 we must either disallow lazy wrapping or require a blank line between
3554In addition to pandoc's extended Markdown, the following Markdown
3555variants are supported:
3557`markdown_phpextra` (PHP Markdown Extra)
3558: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3559 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3560 `header_attributes`, `link_attributes`, `abbreviations`,
3561 `shortcut_reference_links`.
3563`markdown_github` (GitHub-Flavored Markdown)
3564: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3565 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3566 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3567 `shortcut_reference_links`, `angle_brackets_escapable`.
3569`markdown_mmd` (MultiMarkdown)
3570: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3571 `tex_math_double_backslash`, `intraword_underscores`,
3572 `mmd_title_block`, `footnotes`, `definition_lists`,
3573 `all_symbols_escapable`, `implicit_header_references`,
3574 `auto_identifiers`, `mmd_header_identifiers`,
3575 `shortcut_reference_links`.
3577`markdown_strict` (Markdown.pl)
3580Extensions with formats other than Markdown
3581-------------------------------------------
3583Some of the extensions discussed above can be used with formats
3586* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3587 and `textile` input (and is used by default).
3589* `tex_math_dollars`, `tex_math_single_backslash`, and
3590 `tex_math_double_backslash` can be used with `html` input.
3591 (This is handy for reading web pages formatted using MathJax,
3594Producing slide shows with pandoc
3595=================================
3597You can use pandoc to produce an HTML + JavaScript slide presentation
3598that can be viewed via a web browser. There are five ways to do this,
3599using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3600You can also produce a PDF slide show using LaTeX [`beamer`].
3602Here's the Markdown source for a simple slide show, `habits.txt`:
3629 
3636To produce an HTML/JavaScript slide show, simply type
3638 pandoc -t FORMAT -s habits.txt -o habits.html
3640where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3642For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3643`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3644assumed to be available at the relative path `s5/default` (for S5), `slideous`
3645(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3646`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3647`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3648above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3651With all HTML slide formats, the `--self-contained` option can be used to
3652produce a single file that contains all of the data necessary to display the
3653slide show, including linked scripts, stylesheets, images, and videos.
3655To produce a PDF slide show using beamer, type
3657 pandoc -t beamer habits.txt -o habits.pdf
3659Note that a reveal.js slide show can also be converted to a PDF
3660by printing it to a file from the browser.
3662Structuring the slide show
3663--------------------------
3665By default, the *slide level* is the highest header level in
3666the hierarchy that is followed immediately by content, and not another
3667header, somewhere in the document. In the example above, level 1 headers
3668are always followed by level 2 headers, which are followed by content,
3669so 2 is the slide level. This default can be overridden using
3670the `--slide-level` option.
3672The document is carved up into slides according to the following
3675 * A horizontal rule always starts a new slide.
3677 * A header at the slide level always starts a new slide.
3679 * Headers *below* the slide level in the hierarchy create
3680 headers *within* a slide.
3682 * Headers *above* the slide level in the hierarchy create
3683 "title slides," which just contain the section title
3684 and help to break the slide show into sections.
3686 * A title page is constructed automatically from the document's title
3687 block, if present. (In the case of beamer, this can be disabled
3688 by commenting out some lines in the default template.)
3690These rules are designed to support many different styles of slide show. If
3691you don't care about structuring your slides into sections and subsections,
3692you can just use level 1 headers for all each slide. (In that case, level 1
3693will be the slide level.) But you can also structure the slide show into
3694sections, as in the example above.
3696Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3697layout will be produced, with level 1 headers building horizontally
3698and level 2 headers building vertically. It is not recommended that
3699you use deeper nesting of section levels with reveal.js.
3704By default, these writers produce lists that display "all at once."
3705If you want your lists to display incrementally (one item at a time),
3706use the `-i` option. If you want a particular list to depart from the
3707default (that is, to display incrementally without the `-i` option and
3708all at once with the `-i` option), put it in a block quote:
3713In this way incremental and nonincremental lists can be mixed in
3719You can add "pauses" within a slide by including a paragraph containing
3720three dots, separated by spaces:
3722 # Slide with a pause
3724 content before the pause
3728 content after the pause
3733You can change the style of HTML slides by putting customized CSS files
3734in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3735or `$DATADIR/slideous` (for Slideous),
3736where `$DATADIR` is the user data directory (see `--data-dir`, above).
3737The originals may be found in pandoc's system data directory (generally
3738`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3739files it does not find in the user data directory.
3741For dzslides, the CSS is included in the HTML file itself, and may
3744All [reveal.js configuration options] can be set through variables.
3745For example, themes can be used by setting the `theme` variable:
3749Or you can specify a custom stylesheet using the `--css` option.
3751To style beamer slides, you can specify a `theme`, `colortheme`,
3752`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3754 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3756Note that header attributes will turn into slide attributes
3757(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3758to style individual slides. In beamer, the only header attribute
3759that affects slides is the `allowframebreaks` class, which sets the
3760`allowframebreaks` option, causing multiple slides to be created
3761if the content overfills the frame. This is recommended especially for
3764 # References {.allowframebreaks}
3769reveal.js has good support for speaker notes. You can add notes to your
3770Markdown document thus:
3775 - It can contain Markdown
3780To show the notes window, press `s` while viewing the presentation.
3781Notes are not yet supported for other slide formats, but the notes
3782will not appear on the slides themselves.
3784Frame attributes in beamer
3785--------------------------
3787Sometimes it is necessary to add the LaTeX `[fragile]` option to
3788a frame in beamer (for example, when using the `minted` environment).
3789This can be forced by adding the `fragile` class to the header
3790introducing the slide:
3792 # Fragile slide {.fragile}
3794All of the other frame attributes described in Section 8.1 of
3795the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3796`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3799Creating EPUBs with pandoc
3800==========================
3805EPUB metadata may be specified using the `--epub-metadata` option, but
3806if the source document is Markdown, it is better to use a [YAML metadata
3807block][Extension: `yaml_metadata_block`]. Here is an example:
3814 text: An investigation of metadata
3822 text: doi:10.234234.234/33
3824 rights: © 2007 John Smith, CC BY-NC
3827The following fields are recognized:
3830 ~ Either a string value or an object with fields `text` and
3831 `scheme`. Valid values for `scheme` are `ISBN-10`,
3832 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3833 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3834 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3837 ~ Either a string value, or an object with fields `file-as` and
3838 `type`, or a list of such objects. Valid values for `type` are
3839 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3842 ~ Either a string value, or an object with fields `role`, `file-as`,
3843 and `text`, or a list of such objects. Valid values for `role` are
3844 [MARC relators], but
3845 pandoc will attempt to translate the human-readable versions
3846 (like "author" and "editor") to the appropriate marc relators.
3849 ~ Same format as `creator`.
3852 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3853 Pandoc will attempt to convert other common date formats.
3855`lang` (or legacy: `language`)
3856 ~ A string value in [BCP 47] format. Pandoc will default to the local
3857 language if nothing is specified.
3860 ~ A string value or a list of such values.
3881 ~ A string value (path to cover image).
3884 ~ A string value (path to CSS stylesheet).
3886`page-progression-direction`
3887 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3888 attribute for the [`spine` element].
3890[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3891[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3896By default, pandoc will download linked media (including audio and
3897video) and include it in the EPUB container, yielding a completely
3898self-contained EPUB. If you want to link to external media resources
3899instead, use raw HTML in your source and add `data-external="1"` to the tag
3900with the `src` attribute. For example:
3902 <audio controls="1">
3903 <source src="http://example.com/music/toccata.mp3"
3904 data-external="1" type="audio/mpeg">
3908Literate Haskell support
3909========================
3911If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3912format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3913`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3914literate Haskell source. This means that
3916 - In Markdown input, "bird track" sections will be parsed as Haskell
3917 code rather than block quotations. Text between `\begin{code}`
3918 and `\end{code}` will also be treated as Haskell code. For
3919 ATX-style headers the character '=' will be used instead of '#'.
3921 - In Markdown output, code blocks with classes `haskell` and `literate`
3922 will be rendered using bird tracks, and block quotations will be
3923 indented one space, so they will not be treated as Haskell code.
3924 In addition, headers will be rendered setext-style (with underlines)
3925 rather than ATX-style (with '#' characters). (This is because ghc
3926 treats '#' characters in column 1 as introducing line numbers.)
3928 - In restructured text input, "bird track" sections will be parsed
3931 - In restructured text output, code blocks with class `haskell` will
3932 be rendered using bird tracks.
3934 - In LaTeX input, text in `code` environments will be parsed as
3937 - In LaTeX output, code blocks with class `haskell` will be rendered
3938 inside `code` environments.
3940 - In HTML output, code blocks with class `haskell` will be rendered
3941 with class `literatehaskell` and bird tracks.
3945 pandoc -f markdown+lhs -t html
3947reads literate Haskell source formatted with Markdown conventions and writes
3948ordinary HTML (without bird tracks).
3950 pandoc -f markdown+lhs -t html+lhs
3952writes HTML with the Haskell code in bird tracks, so it can be copied
3953and pasted as literate Haskell source.
3958Pandoc will automatically highlight syntax in [fenced code blocks] that
3959are marked with a language name. The Haskell library [highlighting-kate] is
3960used for highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3961To see a list of language names that pandoc will recognize, type
3962`pandoc --list-highlight-languages`.
3964The color scheme can be selected using the `--highlight-style` option.
3965The default color scheme is `pygments`, which imitates the default color
3966scheme used by the Python library pygments (though pygments is not actually
3967used to do the highlighting). To see a list of highlight styles,
3968type `pandoc --list-highlight-styles`.
3970To disable highlighting, use the `--no-highlight` option.
3972[highlighting-kate]: https://github.com/jgm/highlighting-kate
3974Custom Styles in Docx Output
3975============================
3977By default, pandoc's docx output applies a predefined set of styles for
3978blocks such as paragraphs and block quotes, and uses largely default
3979formatting (italics, bold) for inlines. This will work for most
3980purposes, especially alongside a `reference.docx` file. However, if you
3981need to apply your own styles to blocks, or match a preexisting set of
3982styles, pandoc allows you to define custom styles for blocks and text
3983using `div`s and `span`s, respectively.
3985If you define a `div` or `span` with the attribute `custom-style`,
3986pandoc will apply your specified style to the contained elements. So,
3989 <span custom-style="Emphatically">Get out,</span> he said.
3991would produce a docx file with "Get out," styled with character
3992style `Emphatically`. Similarly,
3994 Dickinson starts the poem simply:
3996 <div custom-style="Poetry">
3997 | A Bird came down the Walk---
3998 | He did not know I saw---
4001would style the two contained lines with the `Poetry` paragraph style.
4003If the styles are not yet in your reference.docx, they will be defined
4004in the output file as inheriting from normal text. If they are already
4005defined, pandoc will not alter the definition.
4007This feature allows for greatest customization in conjunction with
4008[pandoc filters]. If you want all paragraphs after block quotes to be
4009indented, you can write a filter to apply the styles necessary. If you
4010want all italics to be transformed to the `Emphasis` character style
4011(perhaps to change their color), you can write a filter which will
4012transform all italicized inlines to inlines within an `Emphasis`
4015[pandoc filters]: http://pandoc.org/scripting.html
4020Pandoc can be extended with custom writers written in [lua]. (Pandoc
4021includes a lua interpreter, so lua need not be installed separately.)
4023To use a custom writer, simply specify the path to the lua script
4024in place of the output format. For example:
4026 pandoc -t data/sample.lua
4028Creating a custom writer requires writing a lua function for each
4029possible element in a pandoc document. To get a documented example
4030which you can modify according to your needs, do
4032 pandoc --print-default-data-file sample.lua
4034[lua]: http://www.lua.org
4039© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the
4040[GPL], version 2 or greater. This software carries no warranty of
4041any kind. (See COPYRIGHT for full copyright and warranty notices.)
4049Alexander Kondratskiy,
4051Alexander V Vershilov,
4052Alfred Wechselberger,
4061Beni Cherniavsky-Paskin,
4072Christoffer Ackelman,
4110Jaime Marquínez Ferrándiz,
4147Matthias C. M. Troffaes,
4217[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