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://contextgarden.net/
71[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
72[DocBook]: http://docbook.org
73[txt2tags]: http://txt2tags.org
74[EPUB]: http://idpf.org/epub
75[OPML]: http://dev.opml.org/spec2.html
76[OpenDocument]: http://opendocument.xml.org
77[ODT]: http://en.wikipedia.org/wiki/OpenDocument
78[Textile]: http://redcloth.org/textile
79[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
80[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
81[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
82[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
83[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
84[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
85[Haskell]: https://www.haskell.org
86[GNU Texinfo]: http://www.gnu.org/software/texinfo/
87[Emacs Org mode]: http://orgmode.org
88[AsciiDoc]: http://www.methods.co.nz/asciidoc/
89[DZSlides]: http://paulrouget.com/dzslides/
90[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx
91[PDF]: https://www.adobe.com/pdf/
92[reveal.js]: http://lab.hakim.se/reveal-js/
93[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
94[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
95[TEI Simple]: https://github.com/TEIC/TEI-Simple
100If no *input-file* is specified, input is read from *stdin*.
101Otherwise, the *input-files* are concatenated (with a blank
102line between each) and used as input. Output goes to *stdout* by
103default (though output to *stdout* is disabled for the `odt`, `docx`,
104`epub`, and `epub3` output formats). For output to a file, use the
107 pandoc -o output.html input.txt
109By default, pandoc produces a document fragment, not a standalone
110document with a proper header and footer. To produce a standalone
111document, use the `-s` or `--standalone` flag:
113 pandoc -s -o output.html input.txt
115For more information on how standalone documents are produced, see
118Instead of a file, an absolute URI may be given. In this case
119pandoc will fetch the content using HTTP:
121 pandoc -f html -t markdown http://www.fsf.org
123If multiple input files are given, `pandoc` will concatenate them all (with
124blank lines between them) before parsing. This feature is disabled for
125 binary input formats such as `EPUB`, `odt`, and `docx`.
127The format of the input and output can be specified explicitly using
128command-line options. The input format can be specified using the
129`-r/--read` or `-f/--from` options, the output format using the
130`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
131Markdown to LaTeX, you could type:
133 pandoc -f markdown -t latex hello.txt
135To convert `hello.html` from HTML to Markdown:
137 pandoc -f html -t markdown hello.html
139Supported output formats are listed below under the `-t/--to` option.
140Supported input formats are listed below under the `-f/--from` option. Note
141that the `rst`, `textile`, `latex`, and `html` readers are not complete;
142there are some constructs that they do not parse.
144If the input or output format is not specified explicitly, `pandoc`
145will attempt to guess it from the extensions of
146the input and output filenames. Thus, for example,
148 pandoc -o hello.tex hello.txt
150will convert `hello.txt` from Markdown to LaTeX. If no output file
151is specified (so that output goes to *stdout*), or if the output file's
152extension is unknown, the output format will default to HTML.
153If no input file is specified (so that input comes from *stdin*), or
154if the input files' extensions are unknown, the input format will
155be assumed to be Markdown unless explicitly specified.
157Pandoc uses the UTF-8 character encoding for both input and output.
158If your local character encoding is not UTF-8, you
159should pipe input and output through [`iconv`]:
161 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
163Note that in some output formats (such as HTML, LaTeX, ConTeXt,
164RTF, OPML, DocBook, and Texinfo), information about
165the character encoding is included in the document header, which
166will only be included if you use the `-s/--standalone` option.
168[`iconv`]: http://www.gnu.org/software/libiconv/
173To produce a PDF, specify an output file with a `.pdf` extension.
174By default, pandoc will use LaTeX to convert it to PDF:
176 pandoc test.txt -o test.pdf
178Production of a PDF requires that a LaTeX engine be installed (see
179`--latex-engine`, below), and assumes that the following LaTeX packages
180are available: [`amsfonts`], [`amsmath`], [`lm`],
181[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
182`--listings` option is used), [`fancyvrb`], [`longtable`],
183[`booktabs`], [`graphicx`] and [`grffile`] (if the
184document contains images), [`hyperref`], [`ulem`],
185[`geometry`] (with the `geometry` variable set), [`setspace`] (with
186`linestretch`), and [`babel`] (with `lang`). The use of `xelatex` or
187`lualatex` as the LaTeX engine requires [`fontspec`]; `xelatex` uses
188[`mathspec`], [`polyglossia`] (with `lang`), [`xecjk`], and
189[`bidi`] (with the `dir` variable set). The [`upquote`] and
190[`microtype`] packages are used if available, and [`csquotes`] will
191be used for [smart punctuation] if added to the template or included in
192any header file. The [`natbib`], [`biblatex`], [`bibtex`], and [`biber`]
193packages can optionally be used for [citation rendering]. These are
194included with all recent versions of [TeX Live].
196Alternatively, pandoc can use ConTeXt or `wkhtmltopdf` to create a PDF.
197To do this, specify an output file with a `.pdf` extension,
198as before, but add `-t context` or `-t html5` to the command line.
200PDF output can be controlled using [variables for LaTeX] (if
201LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
202If `wkhtmltopdf` is used, then the variables `margin-left`,
203`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
204will affect the output, as will `--css`.
206[`amsfonts`]: https://ctan.org/pkg/amsfonts
207[`amsmath`]: https://ctan.org/pkg/amsmath
208[`lm`]: https://ctan.org/pkg/lm
209[`ifxetex`]: https://ctan.org/pkg/ifxetex
210[`ifluatex`]: https://ctan.org/pkg/ifluatex
211[`eurosym`]: https://ctan.org/pkg/eurosym
212[`listings`]: https://ctan.org/pkg/listings
213[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
214[`longtable`]: https://ctan.org/pkg/longtable
215[`booktabs`]: https://ctan.org/pkg/booktabs
216[`graphicx`]: https://ctan.org/pkg/graphicx
217[`grffile`]: https://ctan.org/pkg/grffile
218[`geometry`]: https://ctan.org/pkg/geometry
219[`setspace`]: https://ctan.org/pkg/setspace
220[`xecjk`]: https://ctan.org/pkg/xecjk
221[`hyperref`]: https://ctan.org/pkg/hyperref
222[`ulem`]: https://ctan.org/pkg/ulem
223[`babel`]: https://ctan.org/pkg/babel
224[`bidi`]: https://ctan.org/pkg/bidi
225[`mathspec`]: https://ctan.org/pkg/mathspec
226[`polyglossia`]: https://ctan.org/pkg/polyglossia
227[`fontspec`]: https://ctan.org/pkg/fontspec
228[`upquote`]: https://ctan.org/pkg/upquote
229[`microtype`]: https://ctan.org/pkg/microtype
230[`csquotes`]: https://ctan.org/pkg/csquotes
231[`natbib`]: https://ctan.org/pkg/natbib
232[`biblatex`]: https://ctan.org/pkg/biblatex
233[`bibtex`]: https://ctan.org/pkg/bibtex
234[`biber`]: https://ctan.org/pkg/biber
235[TeX Live]: http://www.tug.org/texlive/
243`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
245: Specify input format. *FORMAT* can be `native` (native Haskell),
246 `json` (JSON version of native AST), `markdown` (pandoc's
247 extended Markdown), `markdown_strict` (original unextended
248 Markdown), `markdown_phpextra` (PHP Markdown Extra), `markdown_github`
249 (GitHub-Flavored Markdown), `markdown_mmd` (MultiMarkdown),
250 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
251 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
252 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
253 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
254 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
255 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
256 input will be treated as literate Haskell source: see [Literate
257 Haskell support], below. Markdown
258 syntax extensions can be individually enabled or disabled by
259 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
260 example, `markdown_strict+footnotes+definition_lists` is strict
261 Markdown with footnotes and definition lists enabled, and
262 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
263 without pipe tables and with hard line breaks. See [Pandoc's
264 Markdown], below, for a list of extensions and
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`.
429`--filter=`*EXECUTABLE*
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 If no directory is provided pandoc will look for executable or
454 non-executable filters in the director `$DATADIR/filters`, and
455 then for executable filters in the user's `PATH`. If you want to
456 run a script in the working directory, preface the filename with
459 In order of preference, pandoc will look for filters in
461 1. a specified full or relative path (executable or
464 2. `$DATADIR/filters` (executable or non-executable)
466 3. `$PATH` (executable only)
468`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
470: Set the metadata field *KEY* to the value *VAL*. A value specified
471 on the command line overrides a value specified in the document.
472 Values will be parsed as YAML boolean or string values. If no value is
473 specified, the value will be treated as Boolean true. Like
474 `--variable`, `--metadata` causes template variables to be set.
475 But unlike `--variable`, `--metadata` affects the metadata of the
476 underlying document (which is accessible from filters and may be
477 printed in some output formats).
481: Normalize the document after reading: merge adjacent
482 `Str` or `Emph` elements, for example, and remove repeated `Space`s.
484`-p`, `--preserve-tabs`
486: Preserve tabs instead of converting them to spaces (the default).
487 Note that this will only affect tabs in literal code spans and code
488 blocks; tabs in regular text will be treated as spaces.
492: Specify the number of spaces per tab (default is 4).
494`--track-changes=accept`|`reject`|`all`
496: Specifies what to do with insertions, deletions, and comments
497 produced by the MS Word "Track Changes" feature. `accept` (the
498 default), inserts all insertions, and ignores all
499 deletions. `reject` inserts all deletions and ignores
500 insertions. Both `accept` and `reject` ignore comments. `all` puts
501 in insertions, deletions, and comments, wrapped in spans with
502 `insertion`, `deletion`, `comment-start`, and `comment-end`
503 classes, respectively. The author and time of change is
504 included. `all` is useful for scripting: only accepting changes
505 from a certain reviewer, say, or before a certain date. This
506 option only affects the docx reader.
508`--extract-media=`*DIR*
510: Extract images and other media contained in a docx or epub container
511 to the path *DIR*, creating it if necessary, and adjust the images
512 references in the document so they point to the extracted files.
513 This option only affects the docx and epub readers.
515[`pandocfilters`]: https://github.com/jgm/pandocfilters
516[PHP]: https://github.com/vinai/pandocfilters-php
517[perl]: https://metacpan.org/pod/Pandoc::Filter
518[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
520General writer options
521----------------------
525: Produce output with an appropriate header and footer (e.g. a
526 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
527 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
532: Use *FILE* as a custom template for the generated document. Implies
533 `--standalone`. See [Templates], below, for a description
534 of template syntax. If no extension is specified, an extension
535 corresponding to the writer will be added, so that `--template=special`
536 looks for `special.html` for HTML output. If the template is not
537 found, pandoc will search for it in the `templates` subdirectory of
538 the user data directory (see `--data-dir`). If this option is not used,
539 a default template appropriate for the output format will be used (see
540 `-D/--print-default-template`).
542`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
544: Set the template variable *KEY* to the value *VAL* when rendering the
545 document in standalone mode. This is generally only useful when the
546 `--template` option is used to specify a custom template, since
547 pandoc automatically sets the variables used in the default
548 templates. If no *VAL* is specified, the key will be given the
551`-D` *FORMAT*, `--print-default-template=`*FORMAT*
553: Print the system default template for an output *FORMAT*. (See `-t`
554 for a list of possible *FORMAT*s.) Templates in the user data
555 directory are ignored.
557`--print-default-data-file=`*FILE*
559: Print a system default data file. Files in the user data directory
563: Specify the dpi (dots per inch) value for conversion from pixels
564 to inch/centimeters and vice versa. The default is 96dpi.
565 Technically, the correct term would be ppi (pixels per inch).
567`--wrap=auto`|`none`|`preserve`
569: Determine how text is wrapped in the output (the source
570 code, not the rendered version). With `auto` (the default),
571 pandoc will attempt to wrap lines to the column width specified by
572 `--columns` (default 80). With `none`, pandoc will not wrap
573 lines at all. With `preserve`, pandoc will attempt to
574 preserve the wrapping from the source document (that is,
575 where there are nonsemantic newlines in the source, there
576 will be nonsemantic newlines in the output as well).
580: Deprecated synonym for `--wrap=none`.
584: Specify length of lines in characters. This affects text wrapping
585 in the generated source code (see `--wrap`). It also affects
586 calculation of column widths for plain text tables (see [Tables] below).
588`--toc`, `--table-of-contents`
590: Include an automatically generated table of contents (or, in
591 the case of `latex`, `context`, `docx`, and `rst`, an instruction to create
592 one) in the output document. This option has no effect on `man`,
593 `docbook`, `docbook5`, `slidy`, `slideous`, `s5`, or `odt` output.
595`--toc-depth=`*NUMBER*
597: Specify the number of section levels to include in the table
598 of contents. The default is 3 (which means that level 1, 2, and 3
599 headers will be listed in the contents).
603: Disables syntax highlighting for code blocks and inlines, even when
604 a language attribute is given.
606`--highlight-style=`*STYLE*
608: Specifies the coloring style to be used in highlighted source code.
609 Options are `pygments` (the default), `kate`, `monochrome`,
610 `espresso`, `zenburn`, `haddock`, and `tango`. For more information
611 on syntax highlighting in pandoc, see [Syntax highlighting], below.
612 See also `--list-highlight-styles`.
614`-H` *FILE*, `--include-in-header=`*FILE*
616: Include contents of *FILE*, verbatim, at the end of the header.
617 This can be used, for example, to include special
618 CSS or javascript in HTML documents. This option can be used
619 repeatedly to include multiple files in the header. They will be
620 included in the order specified. Implies `--standalone`.
622`-B` *FILE*, `--include-before-body=`*FILE*
624: Include contents of *FILE*, verbatim, at the beginning of the
625 document body (e.g. after the `<body>` tag in HTML, or the
626 `\begin{document}` command in LaTeX). This can be used to include
627 navigation bars or banners in HTML documents. This option can be
628 used repeatedly to include multiple files. They will be included in
629 the order specified. Implies `--standalone`.
631`-A` *FILE*, `--include-after-body=`*FILE*
633: Include contents of *FILE*, verbatim, at the end of the document
634 body (before the `</body>` tag in HTML, or the
635 `\end{document}` command in LaTeX). This option can be used
636 repeatedly to include multiple files. They will be included in the
637 order specified. Implies `--standalone`.
639Options affecting specific writers
640----------------------------------
644: Produce a standalone HTML file with no external dependencies, using
645 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
646 images, and videos. The resulting file should be "self-contained,"
647 in the sense that it needs no external files and no net access to be
648 displayed properly by a browser. This option works only with HTML output
649 formats, including `html`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
650 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
651 stylesheets at absolute URLs will be downloaded; those at relative URLs
652 will be sought relative to the working directory (if the first source
653 file is local) or relative to the base URL (if the first source
654 file is remote). Limitation: resources that are loaded dynamically
655 through JavaScript cannot be incorporated; as a result, `--self-contained`
656 does not work with `--mathjax`, and some advanced features (e.g.
657 zoom or speaker notes) may not work in an offline "self-contained"
658 `reveal.js` slide show.
662: Use `<q>` tags for quotes in HTML.
666: Use only ascii characters in output. Currently supported only
667 for HTML output (which uses numerical entities instead of
668 UTF-8 when this option is selected).
672: Use reference-style links, rather than inline links, in writing Markdown
673 or reStructuredText. By default inline links are used. The
674 placement of link references is affected by the
675 `--reference-location` option.
677`--reference-location = block`|`section`|`document`
679: Specify whether footnotes (and references, if `reference-links` is
680 set) are placed at the end of the current (top-level) block, the
681 current section, or the document. The default is
682 `document`. Currently only affects the markdown writer.
686: Use ATX-style headers in Markdown and asciidoc output. The default is
687 to use setext-style headers for levels 1-2, and then ATX headers.
691: Deprecated synonym for `--top-level-division=chapter`.
693`--top-level-division=[section|chapter|part]`
695: Treat top-level headers as the given division type in LaTeX, ConTeXt,
696 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
697 all headers are shifted such that the top-level header becomes the specified
698 type. The default is `section`. When the LaTeX document class is set to
699 `report`, `book`, or `memoir` (unless the `article` option is specified),
700 `chapter` is implied as the setting for this option. If `beamer` is the
701 output format, specifying either `chapter` or `part` will cause top-level
702 headers to become `\part{..}`, while second-level headers remain as their
705`-N`, `--number-sections`
707: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
708 By default, sections are not numbered. Sections with class
709 `unnumbered` will never be numbered, even if `--number-sections`
712`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
714: Offset for section headings in HTML output (ignored in other
715 output formats). The first number is added to the section number for
716 top-level headers, the second for second-level headers, and so on.
717 So, for example, if you want the first top-level header in your
718 document to be numbered "6", specify `--number-offset=5`.
719 If your document starts with a level-2 header which you want to
720 be numbered "1.5", specify `--number-offset=1,4`.
721 Offsets are 0 by default. Implies `--number-sections`.
725: Do not use the TeX ligatures for quotation marks, apostrophes,
726 and dashes (`` `...' ``, ` ``..'' `, `--`, `---`) when
727 writing or reading LaTeX or ConTeXt. In reading LaTeX,
728 parse the characters `` ` ``, `'`, and `-` literally, rather
729 than parsing ligatures for quotation marks and dashes. In
730 writing LaTeX or ConTeXt, print unicode quotation mark and
731 dash characters literally, rather than converting them to
732 the standard ASCII TeX ligatures. Note: normally `--smart`
733 is selected automatically for LaTeX and ConTeXt output, but
734 it must be specified explicitly if `--no-tex-ligatures` is
735 selected. If you use literal curly quotes, dashes, and
736 ellipses in your source, then you may want to use
737 `--no-tex-ligatures` without `--smart`.
741: Use the [`listings`] package for LaTeX code blocks
745: Make list items in slide shows display incrementally (one by one).
746 The default is for lists to be displayed all at once.
748`--slide-level=`*NUMBER*
750: Specifies that headers with the specified level create
751 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
752 above this level in the hierarchy are used to divide the
753 slide show into sections; headers below this level create
754 subheads within a slide. The default is to set the slide level
755 based on the contents of the document; see
756 [Structuring the slide show].
760: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
761 and attach identifiers to the enclosing `<div>` (or `<section>`)
762 rather than the header itself. See
763 [Header identifiers], below.
765`--email-obfuscation=none`|`javascript`|`references`
767: Specify a method for obfuscating `mailto:` links in HTML documents.
768 `none` leaves `mailto:` links as they are. `javascript` obfuscates
769 them using javascript. `references` obfuscates them by printing their
770 letters as decimal or hexadecimal character references. The default
773`--id-prefix=`*STRING*
775: Specify a prefix to be added to all automatically generated identifiers
776 in HTML and DocBook output, and to footnote numbers in Markdown output.
777 This is useful for preventing duplicate identifiers when generating
778 fragments to be included in other pages.
780`-T` *STRING*, `--title-prefix=`*STRING*
782: Specify *STRING* as a prefix at the beginning of the title
783 that appears in the HTML header (but not in the title as it
784 appears at the beginning of the HTML body). Implies
787`-c` *URL*, `--css=`*URL*
789: Link to a CSS style sheet. This option can be used repeatedly to
790 include multiple files. They will be included in the order specified.
792`--reference-odt=`*FILE*
794: Use the specified file as a style reference in producing an ODT.
795 For best results, the reference ODT should be a modified version
796 of an ODT produced using pandoc. The contents of the reference ODT
797 are ignored, but its stylesheets are used in the new ODT. If no
798 reference ODT is specified on the command line, pandoc will look
799 for a file `reference.odt` in the user data directory (see
800 `--data-dir`). If this is not found either, sensible defaults will be
803`--reference-docx=`*FILE*
805: Use the specified file as a style reference in producing a docx file.
806 For best results, the reference docx should be a modified version
807 of a docx file produced using pandoc. The contents of the reference docx
808 are ignored, but its stylesheets and document properties (including
809 margins, page size, header, and footer) are used in the new docx. If no
810 reference docx is specified on the command line, pandoc will look
811 for a file `reference.docx` in the user data directory (see
812 `--data-dir`). If this is not found either, sensible defaults will be
813 used. The following styles are used by pandoc: [paragraph]
814 Normal, Body Text, First Paragraph, Compact, Title, Subtitle, Author, Date,
815 Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading 4,
816 Heading 5, Heading 6, Block Text, Footnote Text, Definition Term,
817 Definition, Caption, Table Caption, Image Caption, Figure,
818 Figure With Caption, TOC Heading;
819 [character] Default Paragraph Font, Body Text Char, Verbatim Char,
820 Footnote Reference, Hyperlink; [table] Normal Table.
822`--epub-stylesheet=`*FILE*
824: Use the specified CSS file to style the EPUB. If no stylesheet
825 is specified, pandoc will look for a file `epub.css` in the
826 user data directory (see `--data-dir`). If it is not
827 found there, sensible defaults will be used.
829`--epub-cover-image=`*FILE*
831: Use the specified image as the EPUB cover. It is recommended
832 that the image be less than 1000px in width and height. Note that
833 in a Markdown source document you can also specify `cover-image`
834 in a YAML metadata block (see [EPUB Metadata], below).
836`--epub-metadata=`*FILE*
838: Look in the specified XML file for metadata for the EPUB.
839 The file should contain a series of [Dublin Core elements].
842 <dc:rights>Creative Commons</dc:rights>
843 <dc:language>es-AR</dc:language>
845 By default, pandoc will include the following metadata elements:
846 `<dc:title>` (from the document title), `<dc:creator>` (from the
847 document authors), `<dc:date>` (from the document date, which should
848 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
849 variable, or, if is not set, the locale), and `<dc:identifier
850 id="BookId">` (a randomly generated UUID). Any of these may be
851 overridden by elements in the metadata file.
853 Note: if the source document is Markdown, a YAML metadata block
854 in the document can be used instead. See below under
857`--epub-embed-font=`*FILE*
859: Embed the specified font in the EPUB. This option can be repeated
860 to embed multiple fonts. Wildcards can also be used: for example,
861 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
862 line, be sure to escape them or put the whole filename in single quotes,
863 to prevent them from being interpreted by the shell. To use the
864 embedded fonts, you will need to add declarations like the following
865 to your CSS (see `--epub-stylesheet`):
868 font-family: DejaVuSans;
871 src:url("DejaVuSans-Regular.ttf");
874 font-family: DejaVuSans;
877 src:url("DejaVuSans-Bold.ttf");
880 font-family: DejaVuSans;
883 src:url("DejaVuSans-Oblique.ttf");
886 font-family: DejaVuSans;
889 src:url("DejaVuSans-BoldOblique.ttf");
891 body { font-family: "DejaVuSans"; }
893`--epub-chapter-level=`*NUMBER*
895: Specify the header level at which to split the EPUB into separate
896 "chapter" files. The default is to split into chapters at level 1
897 headers. This option only affects the internal composition of the
898 EPUB, not the way chapters and sections are displayed to users. Some
899 readers may be slow if the chapter files are too large, so for large
900 documents with few level 1 headers, one might want to use a chapter
903`--latex-engine=pdflatex`|`lualatex`|`xelatex`
905: Use the specified LaTeX engine when producing PDF output.
906 The default is `pdflatex`. If the engine is not in your PATH,
907 the full path of the engine may be specified here.
909`--latex-engine-opt=`*STRING*
911: Use the given string as a command-line argument to the `latex-engine`.
912 If used multiple times, the arguments are provided with spaces between
913 them. Note that no check for duplicate options is done.
915[Dublin Core elements]: http://dublincore.org/documents/dces/
916[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
921`--bibliography=`*FILE*
923: Set the `bibliography` field in the document's metadata to *FILE*,
924 overriding any value set in the metadata, and process citations
925 using `pandoc-citeproc`. (This is equivalent to
926 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
927 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
928 used, making this equivalent to `--metadata bibliography=FILE`.
929 If you supply this argument multiple times, each *FILE* will be added
934: Set the `csl` field in the document's metadata to *FILE*,
935 overriding any value set in the metadata. (This is equivalent to
936 `--metadata csl=FILE`.)
937 This option is only relevant with `pandoc-citeproc`.
939`--citation-abbreviations=`*FILE*
941: Set the `citation-abbreviations` field in the document's metadata to
942 *FILE*, overriding any value set in the metadata. (This is equivalent to
943 `--metadata citation-abbreviations=FILE`.)
944 This option is only relevant with `pandoc-citeproc`.
948: Use [`natbib`] for citations in LaTeX output. This option is not for use
949 with the `pandoc-citeproc` filter or with PDF output. It is intended for
950 use in producing a LaTeX file that can be processed with [`bibtex`].
954: Use [`biblatex`] for citations in LaTeX output. This option is not for use
955 with the `pandoc-citeproc` filter or with PDF output. It is intended for
956 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
958Math rendering in HTML
959----------------------
961`-m` [*URL*], `--latexmathml`[`=`*URL*]
963: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
964 To insert a link to a local copy of the `LaTeXMathML.js` script,
965 provide a *URL*. If no *URL* is provided, the contents of the
966 script will be inserted directly into the HTML header, preserving
967 portability at the price of efficiency. If you plan to use math on
968 several pages, it is much better to link to a copy of the script,
973: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
974 In standalone `html` output, a small javascript (or a link to such a
975 script if a *URL* is supplied) will be inserted that allows the MathML to
976 be viewed on some browsers.
980: Use [jsMath] to display embedded TeX math in HTML output.
981 The *URL* should point to the jsMath load script (e.g.
982 `jsMath/easy/load.js`); if provided, it will be linked to in
983 the header of standalone HTML documents. If a *URL* is not provided,
984 no link to the jsMath load script will be inserted; it is then
985 up to the author to provide such a link in the HTML template.
989: Use [MathJax] to display embedded TeX math in HTML output.
990 The *URL* should point to the `MathJax.js` load script.
991 If a *URL* is not provided, a link to the MathJax CDN will
996: Enclose TeX math in `<eq>` tags in HTML output. These can then
997 be processed by [gladTeX] to produce links to images of the typeset
1000`--mimetex`[`=`*URL*]
1002: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1003 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1007: Render TeX formulas using an external script that converts TeX
1008 formulas to images. The formula will be concatenated with the URL
1009 provided. If *URL* is not specified, the CodeCogs will be used.
1010 Note: the `--webtex` option will affect Markdown output
1011 as well as HTML, which is useful if you're targeting a
1012 version of Markdown without native math support.
1016: Use [KaTeX] to display embedded TeX math in HTML output.
1017 The *URL* should point to the `katex.js` load script. If a *URL* is
1018 not provided, a link to the KaTeX CDN will be inserted.
1019 Note: [KaTeX] seems to work best with `html5` output.
1021`--katex-stylesheet=`*URL*
1023: The *URL* should point to the `katex.css` stylesheet. If this option is
1024 not specified, a link to the KaTeX CDN will be inserted. Note that this
1025 option does not imply `--katex`.
1027[MathML]: http://www.w3.org/Math/
1028[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1029[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1030[MathJax]: https://www.mathjax.org
1031[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1032[mimeTeX]: http://www.forkosh.com/mimetex.html
1033[KaTeX]: https://github.com/Khan/KaTeX
1035Options for wrapper scripts
1036---------------------------
1040: Print information about command-line arguments to *stdout*, then exit.
1041 This option is intended primarily for use in wrapper scripts.
1042 The first line of output contains the name of the output file specified
1043 with the `-o` option, or `-` (for *stdout*) if no output file was
1044 specified. The remaining lines contain the command-line arguments,
1045 one per line, in the order they appear. These do not include regular
1046 pandoc options and their arguments, but do include any options appearing
1047 after a `--` separator at the end of the line.
1051: Ignore command-line arguments (for use in wrapper scripts).
1052 Regular pandoc options are not ignored. Thus, for example,
1054 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1058 pandoc -o foo.html -s
1063When the `-s/--standalone` option is used, pandoc uses a template to
1064add header and footer material that is needed for a self-standing
1065document. To see the default template that is used, just type
1069where *FORMAT* is the name of the output format. A custom template
1070can be specified using the `--template` option. You can also override
1071the system default templates for a given output format *FORMAT*
1072by putting a file `templates/default.*FORMAT*` in the user data
1073directory (see `--data-dir`, above). *Exceptions:*
1075- For `odt` output, customize the `default.opendocument`
1077- For `pdf` output, customize the `default.latex` template
1078 (or the `default.beamer` template, if you use `-t beamer`,
1079 or the `default.context` template, if you use `-t context`).
1080- `docx` has no template (however, you can use
1081 `--reference-docx` to customize the output).
1083Templates contain *variables*, which allow for the inclusion of
1084arbitrary information at any point in the file. Variables may be set
1085within the document using [YAML metadata blocks][Extension:
1086`yaml_metadata_block`]. They may also be set at the
1087command line using the `-V/--variable` option: variables set in this
1088way override metadata fields with the same name.
1090Variables set by pandoc
1091-----------------------
1093Some variables are set automatically by pandoc. These vary somewhat
1094depending on the output format, but include metadata fields as well
1097`title`, `author`, `date`
1098: allow identification of basic aspects of the document. Included
1099 in PDF metadata through LaTeX and ConTeXt. These can be set
1100 through a [pandoc title block][Extension: `pandoc_title_block`],
1101 which allows for multiple authors, or through a YAML metadata block:
1110: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1111 renders in LaTeX only when using a document class that supports
1112 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1113 `scrreprt`, `scrbook`).[^subtitle]
1116: author affiliations (in LaTeX and Beamer only). Can be a
1117 list, when there are multiple authors.
1120: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1123: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1124 may be repeated as for `author`, above
1127: contents specified by `-H/--include-in-header` (may have multiple
1131: non-null value if `--toc/--table-of-contents` was specified
1134: title of table of contents (works only with EPUB and docx)
1137: contents specified by `-B/--include-before-body` (may have
1141: contents specified by `-A/--include-after-body` (may have
1148: JSON representation of all of the document's metadata
1150[^subtitle]: To make `subtitle` work with other LaTeX
1151 document classes, you can add the following to `header-includes`:
1153 \providecommand{\subtitle}[1]{%
1154 \usepackage{titling}
1156 \par\large#1\end{center}}
1163: identifies the main language of the document,
1164 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1165 For some output formats, pandoc will convert it to an appropriate
1166 format stored in the additional variables `babel-lang`,
1167 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1169 Native pandoc `span`s and `div`s with the lang attribute
1170 (value in BCP 47) can be used to switch the language in
1174: a list of other languages used in the document
1175 in the YAML metadata, according to [BCP 47]. For example:
1176 `otherlangs: [en-GB, fr]`.
1177 This is automatically generated from the `lang` attributes
1178 in all `span`s and `div`s but can be overridden.
1179 Currently only used by LaTeX through the generated
1180 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1181 The LaTeX writer outputs polyglossia commands in the text but
1182 the `babel-newcommands` variable contains mappings for them
1183 to the corresponding babel.
1186: the base direction of the document, either `rtl` (right-to-left)
1187 or `ltr` (left-to-right).
1189 For bidirectional documents, native pandoc `span`s and `div`s
1190 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1191 override the base direction in some output formats.
1192 This may not always be necessary if the final renderer
1193 (e.g. the browser, when generating HTML) supports the
1194 [Unicode Bidirectional Algorithm].
1196 When using LaTeX for bidirectional documents, only the `xelatex` engine
1197 is fully supported (use `--latex-engine=xelatex`).
1199[BCP 47]: https://tools.ietf.org/html/bcp47
1200[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1205Variables are available for [producing slide shows with pandoc],
1206including all [reveal.js configuration options].
1209: base URL for Slidy documents (defaults to
1210 `http://www.w3.org/Talks/Tools/Slidy2`)
1213: base URL for Slideous documents (defaults to `slideous`)
1216: base URL for S5 documents (defaults to `s5/default`)
1219: base URL for reveal.js documents (defaults to `reveal.js`)
1221`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1222: themes for LaTeX [`beamer`] documents
1225: options for LaTeX beamer themes (a list).
1228: controls navigation symbols in `beamer` documents
1229 (default is `empty` for no navigation symbols; other valid values
1230 are `frame`, `vertical`, and `horizontal`).
1233: enables on "title pages" for new sections in `beamer`
1234 documents (default = true).
1237: when true, the `beamerarticle` package is loaded (for
1238 producing an article from beamer slides).
1241: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1242 `urlcolor`, or `toccolor` are set (for beamer only).
1244`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1245: color for internal links, citation links, external links, and links in table
1246 of contents: uses any of the [predefined LaTeX colors] (for beamer only).
1248[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1253LaTeX variables are used when [creating a PDF].
1256: paper size, e.g. `letter`, `A4`
1259: font size for body text (e.g. `10pt`, `12pt`)
1262: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1265: option for document class, e.g. `oneside`; may be repeated
1266 for multiple options
1269: option for [`geometry`] package, e.g. `margin=1in`;
1270 may be repeated for multiple options
1272`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1273: sets margins, if `geometry` is not used (otherwise `geometry`
1277: adjusts line spacing using the [`setspace`]
1278 package, e.g. `1.25`, `1.5`
1281: font package for use with `pdflatex`:
1282 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1283 The default is [Latin Modern][`lm`].
1286: options for package used as `fontfamily`: e.g. `osf,sc` with
1287 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1288 figures and true small caps; may be repeated for multiple options
1290`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1291: font families for use with `xelatex` or
1292 `lualatex`: take the name of any system font, using the
1293 [`fontspec`] package. Note that if `CJKmainfont` is used,
1294 the [`xecjk`] package must be available.
1296`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1297: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1298 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1299 available through [`fontspec`], such as the OpenType features
1300 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1303: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1304 default is `T1` (see guide to [LaTeX font encodings])
1307: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1308 `urlcolor`, or `toccolor` are set
1310`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1311: color for internal links, citation links, external links, and links in table of contents:
1312 uses any of the [predefined LaTeX colors]
1315: causes links to be printed as footnotes
1318: uses document class settings for indentation (the default LaTeX template
1319 otherwise removes indentation and adds space between paragraphs)
1322: disables default behavior of LaTeX template that redefines (sub)paragraphs
1323 as sections, changing the appearance of nested headings in some classes
1326: specifies contents of acknowledgments footnote after document title.
1329: include table of contents (can also be set using `--toc/--table-of-contents`)
1332: level of section to include in table of contents
1335: numbering depth for sections, if sections are numbered
1338: include list of figures, list of tables
1341: bibliography to use for resolving references
1344: bibliography style, when used with `--natbib` and `--biblatex`.
1347: bibliography title, when used with `--natbib` and `--biblatex`.
1350: list of options for biblatex.
1352[`article`]: https://ctan.org/pkg/article
1353[`report`]: https://ctan.org/pkg/report
1354[`book`]: https://ctan.org/pkg/book
1355[KOMA-Script]: https://ctan.org/pkg/koma-script
1356[`memoir`]: https://ctan.org/pkg/memoir
1357[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1358[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1359[`mathpazo`]: https://ctan.org/pkg/mathpazo
1360[LaTeX font encodings]: https://ctan.org/pkg/encguide
1362Variables for ConTeXt
1363---------------------
1366: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1367 may be repeated for multiple options
1370: options for page margins and text arrangement (see [ConTeXt Layout]);
1371 may be repeated for multiple options
1373`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1374: sets margins, if `layout` is not used (otherwise `layout`
1378: font size for body text (e.g. `10pt`, `12pt`)
1380`mainfont`, `sansfont`, `monofont`, `mathfont`
1381: font families: take the name of any system font (see [ConTeXt Font Switching])
1383`linkcolor`, `contrastcolor`
1384: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1387: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1390: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1391 may be repeated for multiple options
1394: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1397: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1398 may be repeated for multiple options
1400`headertext`, `footertext`
1401: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1402 may be repeated up to four times for different placement
1405: page number style and location (using [`setuppagenumbering`]);
1406 may be repeated for multiple options
1409: include table of contents (can also be set using `--toc/--table-of-contents`)
1412: include list of figures, list of tables
1414[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1415[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1416[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1417[ConTeXt Color]: http://wiki.contextgarden.net/Color
1418[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1419[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1420[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1421[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1422[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1424Variables for man pages
1425-----------------------
1428: section number in man pages
1431: header in man pages
1434: footer in man pages
1437: adjusts text to left (`l`), right (`r`), center (`c`),
1438 or both (`b`) margins
1441: if `true` (the default), hyphenation will be used
1443Using variables in templates
1444----------------------------
1446Variable names are sequences of alphanumerics, `-`, and `_`,
1447starting with a letter. A variable name surrounded by `$` signs
1448will be replaced by its value. For example, the string `$title$` in
1450 <title>$title$</title>
1452will be replaced by the document title.
1454To write a literal `$` in a template, use `$$`.
1456Templates may contain conditionals. The syntax is as follows:
1464This will include `X` in the template if `variable` has a non-null
1465value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1466any valid template text, and may include interpolated variables or other
1467conditionals. The `$else$` section may be omitted.
1469When variables can have multiple values (for example, `author` in
1470a multi-author document), you can use the `$for$` keyword:
1473 <meta name="author" content="$author$" />
1476You can optionally specify a separator to be used between
1479 $for(author)$$author$$sep$, $endfor$
1481A dot can be used to select a field of a variable that takes
1482an object as its value. So, for example:
1484 $author.name$ ($author.affiliation$)
1486If you use custom templates, you may need to revise them as pandoc
1487changes. We recommend tracking the changes in the default templates,
1488and modifying your custom templates accordingly. An easy way to do this
1489is to fork the [pandoc-templates] repository and merge in changes after each
1492[pandoc-templates]: https://github.com/jgm/pandoc-templates
1497Pandoc understands an extended and slightly revised version of
1498John Gruber's [Markdown] syntax. This document explains the syntax,
1499noting differences from standard Markdown. Except where noted, these
1500differences can be suppressed by using the `markdown_strict` format instead
1501of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1502to the format name and disabled by adding `-EXTENSION`. For example,
1503`markdown_strict+footnotes` is strict Markdown with footnotes
1504enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1505Markdown without footnotes or pipe tables.
1510Markdown is designed to be easy to write, and, even more importantly,
1513> A Markdown-formatted document should be publishable as-is, as plain
1514> text, without looking like it's been marked up with tags or formatting
1516> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1518This principle has guided pandoc's decisions in finding syntax for
1519tables, footnotes, and other extensions.
1521There is, however, one respect in which pandoc's aims are different
1522from the original aims of Markdown. Whereas Markdown was originally
1523designed with HTML generation in mind, pandoc is designed for multiple
1524output formats. Thus, while pandoc allows the embedding of raw HTML,
1525it discourages it, and provides other, non-HTMLish ways of representing
1526important document elements like definition lists, tables, mathematics, and
1532A paragraph is one or more lines of text followed by one or more blank lines.
1533Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1534If you need a hard line break, put two or more spaces at the end of a line.
1536#### Extension: `escaped_line_breaks` ####
1538A backslash followed by a newline is also a hard line break.
1539Note: in multiline and grid table cells, this is the only way
1540to create a hard line break, since trailing spaces in the cells
1546There are two kinds of headers: Setext and ATX.
1548### Setext-style headers ###
1550A setext-style header is a line of text "underlined" with a row of `=` signs
1551(for a level one header) or `-` signs (for a level two header):
1559The header text can contain inline formatting, such as emphasis (see
1560[Inline formatting], below).
1563### ATX-style headers ###
1565An ATX-style header consists of one to six `#` signs and a line of
1566text, optionally followed by any number of `#` signs. The number of
1567`#` signs at the beginning of the line is the header level:
1569 ## A level-two header
1571 ### A level-three header ###
1573As with setext-style headers, the header text can contain formatting:
1575 # A level-one header with a [link](/url) and *emphasis*
1577#### Extension: `blank_before_header` ####
1579Standard Markdown syntax does not require a blank line before a header.
1580Pandoc does require this (except, of course, at the beginning of the
1581document). The reason for the requirement is that it is all too easy for a
1582`#` to end up at the beginning of a line by accident (perhaps through line
1583wrapping). Consider, for example:
1585 I like several of their flavors of ice cream:
1586 #22, for example, and #5.
1589### Header identifiers ###
1591#### Extension: `header_attributes` ####
1593Headers can be assigned attributes using this syntax at the end
1594of the line containing the header text:
1596 {#identifier .class .class key=value key=value}
1598Thus, for example, the following headers will all be assigned the identifier
1603 ## My header ## {#foo}
1605 My other header {#foo}
1608(This syntax is compatible with [PHP Markdown Extra].)
1610Note that although this syntax allows assignment of classes and key/value
1611attributes, writers generally don't use all of this information. Identifiers,
1612classes, and key/value attributes are used in HTML and HTML-based formats such
1613as EPUB and slidy. Identifiers are used for labels and link anchors in the
1614LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1616Headers with the class `unnumbered` will not be numbered, even if
1617`--number-sections` is specified. A single hyphen (`-`) in an attribute
1618context is equivalent to `.unnumbered`, and preferable in non-English
1625 # My header {.unnumbered}
1627#### Extension: `auto_identifiers` ####
1629A header without an explicitly specified identifier will be
1630automatically assigned a unique identifier based on the header text.
1631To derive the identifier from the header text,
1633 - Remove all formatting, links, etc.
1634 - Remove all footnotes.
1635 - Remove all punctuation, except underscores, hyphens, and periods.
1636 - Replace all spaces and newlines with hyphens.
1637 - Convert all alphabetic characters to lowercase.
1638 - Remove everything up to the first letter (identifiers may
1639 not begin with a number or punctuation mark).
1640 - If nothing is left after this, use the identifier `section`.
1645 ------------------------------- ----------------------------
1646 `Header identifiers in HTML` `header-identifiers-in-html`
1647 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1648 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1649 `3. Applications` `applications`
1652These rules should, in most cases, allow one to determine the identifier
1653from the header text. The exception is when several headers have the
1654same text; in this case, the first will get an identifier as described
1655above; the second will get the same identifier with `-1` appended; the
1656third with `-2`; and so on.
1658These identifiers are used to provide link targets in the table of
1659contents generated by the `--toc|--table-of-contents` option. They
1660also make it easy to provide links from one section of a document to
1661another. A link to this section, for example, might look like this:
1664 [header identifiers](#header-identifiers-in-html-latex-and-context).
1666Note, however, that this method of providing links to sections works
1667only in HTML, LaTeX, and ConTeXt formats.
1669If the `--section-divs` option is specified, then each section will
1670be wrapped in a `div` (or a `section`, if `--html5` was specified),
1671and the identifier will be attached to the enclosing `<div>`
1672(or `<section>`) tag rather than the header itself. This allows entire
1673sections to be manipulated using javascript or treated differently in
1676#### Extension: `implicit_header_references` ####
1678Pandoc behaves as if reference links have been defined for each header.
1679So, to link to a header
1681 # Header identifiers in HTML
1685 [Header identifiers in HTML]
1689 [Header identifiers in HTML][]
1693 [the section on header identifiers][header identifiers in
1696instead of giving the identifier explicitly:
1698 [Header identifiers in HTML](#header-identifiers-in-html)
1700If there are multiple headers with identical text, the corresponding
1701reference will link to the first one only, and you will need to use explicit
1702links to link to the others, as described above.
1704Like regular reference links, these references are case-insensitive.
1706Explicit link reference definitions always take priority over
1707implicit header references. So, in the following example, the
1708link will point to `bar`, not to `#foo`:
1719Markdown uses email conventions for quoting blocks of text.
1720A block quotation is one or more paragraphs or other block elements
1721(such as lists or headers), with each line preceded by a `>` character
1722and an optional space. (The `>` need not start at the left margin, but
1723it should not be indented more than three spaces.)
1725 > This is a block quote. This
1726 > paragraph has two lines.
1728 > 1. This is a list inside a block quote.
1731A "lazy" form, which requires the `>` character only on the first
1732line of each block, is also allowed:
1734 > This is a block quote. This
1735 paragraph has two lines.
1737 > 1. This is a list inside a block quote.
1740Among the block elements that can be contained in a block quote are
1741other block quotes. That is, block quotes can be nested:
1743 > This is a block quote.
1745 > > A block quote within a block quote.
1747If the `>` character is followed by an optional space, that space
1748will be considered part of the block quote marker and not part of
1749the indentation of the contents. Thus, to put an indented code
1750block in a block quote, you need five spaces after the `>`:
1754#### Extension: `blank_before_blockquote` ####
1756Standard Markdown syntax does not require a blank line before a block
1757quote. Pandoc does require this (except, of course, at the beginning of the
1758document). The reason for the requirement is that it is all too easy for a
1759`>` to end up at the beginning of a line by accident (perhaps through line
1760wrapping). So, unless the `markdown_strict` format is used, the following does
1761not produce a nested block quote in pandoc:
1763 > This is a block quote.
1767Verbatim (code) blocks
1768----------------------
1770### Indented code blocks ###
1772A block of text indented four spaces (or one tab) is treated as verbatim
1773text: that is, special characters do not trigger special formatting,
1774and all spaces and line breaks are preserved. For example,
1777 moveShip(5 * gravity, DOWN);
1780The initial (four space or one tab) indentation is not considered part
1781of the verbatim text, and is removed in the output.
1783Note: blank lines in the verbatim text need not begin with four spaces.
1786### Fenced code blocks ###
1788#### Extension: `fenced_code_blocks` ####
1790In addition to standard indented code blocks, pandoc supports
1791*fenced* code blocks. These begin with a row of three or more
1792tildes (`~`) and end with a row of tildes that must be at least as long as
1793the starting row. Everything between these lines is treated as code. No
1794indentation is necessary:
1798 moveShip(5 * gravity, DOWN);
1802Like regular code blocks, fenced code blocks must be separated
1803from surrounding text by blank lines.
1805If the code itself contains a row of tildes or backticks, just use a longer
1806row of tildes or backticks at the start and end:
1810 code including tildes
1814#### Extension: `backtick_code_blocks` ####
1816Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1819#### Extension: `fenced_code_attributes` ####
1821Optionally, you may attach attributes to fenced or backtick code block using
1824 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1826 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1827 qsort (filter (>= x) xs)
1828 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1830Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1831`startFrom` is an attribute with value `100`. Some output formats can use this
1832information to do syntax highlighting. Currently, the only output formats
1833that uses this information are HTML and LaTeX. If highlighting is supported
1834for your output format and language, then the code block above will appear
1835highlighted, with numbered lines. (To see which languages are supported, do
1836`pandoc --version`.) Otherwise, the code block above will appear as follows:
1838 <pre id="mycode" class="haskell numberLines" startFrom="100">
1844A shortcut form can also be used for specifying the language of
1851This is equivalent to:
1857If the `fenced_code_attributes` extension is disabled, but
1858input contains class attribute(s) for the codeblock, the first
1859class attribute will be printed after the opening fence as a bare
1862To prevent all highlighting, use the `--no-highlight` flag.
1863To set the highlighting style, use `--highlight-style`.
1864For more information on highlighting, see [Syntax highlighting],
1870#### Extension: `line_blocks` ####
1872A line block is a sequence of lines beginning with a vertical bar (`|`)
1873followed by a space. The division into lines will be preserved in
1874the output, as will any leading spaces; otherwise, the lines will
1875be formatted as Markdown. This is useful for verse and addresses:
1877 | The limerick packs laughs anatomical
1878 | In space that is quite economical.
1879 | But the good ones I've seen
1880 | So seldom are clean
1881 | And the clean ones so seldom are comical
1884 | Berkeley, CA 94718
1886The lines can be hard-wrapped if needed, but the continuation
1887line must begin with a space.
1889 | The Right Honorable Most Venerable and Righteous Samuel L.
1892 | Berkeley, CA 94718
1894This syntax is borrowed from [reStructuredText].
1901A bullet list is a list of bulleted list items. A bulleted list
1902item begins with a bullet (`*`, `+`, or `-`). Here is a simple
1909This will produce a "compact" list. If you want a "loose" list, in which
1910each item is formatted as a paragraph, put spaces between the items:
1918The bullets need not be flush with the left margin; they may be
1919indented one, two, or three spaces. The bullet must be followed
1922List items look best if subsequent lines are flush with the first
1923line (after the bullet):
1929But Markdown also allows a "lazy" format:
1935### The four-space rule ###
1937A list item may contain multiple paragraphs and other block-level
1938content. However, subsequent paragraphs must be preceded by a blank line
1939and indented four spaces or a tab. The list will look better if the first
1940paragraph is aligned with the rest:
1946 * Second paragraph. With a code block, which must be indented
1951List items may include other lists. In this case the preceding blank
1952line is optional. The nested list must be indented four spaces or
1965As noted above, Markdown allows you to write list items "lazily," instead of
1966indenting continuation lines. However, if there are multiple paragraphs or
1967other blocks in a list item, the first line of each must be indented.
1969 + A lazy, lazy, list
1972 + Another one; this looks
1975 Second paragraph of second
1978**Note:** Although the four-space rule for continuation paragraphs
1979comes from the official [Markdown syntax guide], the reference implementation,
1980`Markdown.pl`, does not follow it. So pandoc will give different results than
1981`Markdown.pl` when authors have indented continuation paragraphs fewer than
1984The [Markdown syntax guide] is not explicit whether the four-space
1985rule applies to *all* block-level content in a list item; it only
1986mentions paragraphs and code blocks. But it implies that the rule
1987applies to all block-level content (including nested lists), and
1988pandoc interprets it that way.
1990 [Markdown syntax guide]:
1991 http://daringfireball.net/projects/markdown/syntax#list
1993### Ordered lists ###
1995Ordered lists work just like bulleted lists, except that the items
1996begin with enumerators rather than bullets.
1998In standard Markdown, enumerators are decimal numbers followed
1999by a period and a space. The numbers themselves are ignored, so
2000there is no difference between this list:
2012#### Extension: `fancy_lists` ####
2014Unlike standard Markdown, pandoc allows ordered list items to be marked
2015with uppercase and lowercase letters and roman numerals, in addition to
2016arabic numerals. List markers may be enclosed in parentheses or followed by a
2017single right-parentheses or period. They must be separated from the
2018text that follows by at least one space, and, if the list marker is a
2019capital letter with a period, by at least two spaces.[^2]
2021[^2]: The point of this rule is to ensure that normal paragraphs
2022 starting with people's initials, like
2024 B. Russell was an English philosopher.
2026 do not get treated as list items.
2028 This rule will not prevent
2032 from being interpreted as a list item. In this case, a backslash
2037The `fancy_lists` extension also allows '`#`' to be used as an
2038ordered list marker in place of a numeral:
2043#### Extension: `startnum` ####
2045Pandoc also pays attention to the type of list marker used, and to the
2046starting number, and both of these are preserved where possible in the
2047output format. Thus, the following yields a list with numbers followed
2048by a single parenthesis, starting with 9, and a sublist with lowercase
2058Pandoc will start a new list each time a different type of list
2059marker is used. So, the following will create three lists:
2066If default list markers are desired, use `#.`:
2073### Definition lists ###
2075#### Extension: `definition_lists` ####
2077Pandoc supports definition lists, using the syntax of
2078[PHP Markdown Extra] with some extensions.[^3]
2084 Term 2 with *inline markup*
2088 { some code, part of Definition 2 }
2090 Third paragraph of definition 2.
2092Each term must fit on one line, which may optionally be followed by
2093a blank line, and must be followed by one or more definitions.
2094A definition begins with a colon or tilde, which may be indented one
2097A term may have multiple definitions, and each definition may consist of one or
2098more block elements (paragraph, code block, list, etc.), each indented four
2099spaces or one tab stop. The body of the definition (including the first line,
2100aside from the colon or tilde) should be indented four spaces. However,
2101as with other Markdown lists, you can "lazily" omit indentation except
2102at the beginning of a paragraph or other block element:
2107 with lazy continuation.
2109 Second paragraph of the definition.
2111If you leave space before the definition (as in the example above),
2112the text of the definition will be treated as a paragraph. In some
2113output formats, this will mean greater spacing between term/definition
2114pairs. For a more compact definition list, omit the space before the
2124Note that space between items in a definition list is required.
2125(A variant that loosens this requirement, but disallows "lazy"
2126hard wrapping, can be activated with `compact_definition_lists`: see
2127[Non-pandoc extensions], below.)
2129[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2131### Numbered example lists ###
2133#### Extension: `example_lists` ####
2135The special list marker `@` can be used for sequentially numbered
2136examples. The first list item with a `@` marker will be numbered '1',
2137the next '2', and so on, throughout the document. The numbered examples
2138need not occur in a single list; each new list using `@` will take up
2139where the last stopped. So, for example:
2141 (@) My first example will be numbered (1).
2142 (@) My second example will be numbered (2).
2144 Explanation of examples.
2146 (@) My third example will be numbered (3).
2148Numbered examples can be labeled and referred to elsewhere in the
2151 (@good) This is a good example.
2153 As (@good) illustrates, ...
2155The label can be any string of alphanumeric characters, underscores,
2159### Compact and loose lists ###
2161Pandoc behaves differently from `Markdown.pl` on some "edge
2162cases" involving lists. Consider this source:
2172Pandoc transforms this into a "compact list" (with no `<p>` tags around
2173"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2174"Second" and "Third" (but not "First"), because of the blank space
2175around "Third". Pandoc follows a simple rule: if the text is followed by
2176a blank line, it is treated as a paragraph. Since "Second" is followed
2177by a list, and not a blank line, it isn't treated as a paragraph. The
2178fact that the list is followed by a blank line is irrelevant. (Note:
2179Pandoc works this way even when the `markdown_strict` format is specified. This
2180behavior is consistent with the official Markdown syntax description,
2181even though it is different from that of `Markdown.pl`.)
2184### Ending a list ###
2186What if you want to put an indented code block after a list?
2193Trouble! Here pandoc (like other Markdown implementations) will treat
2194`{ my code block }` as the second paragraph of item two, and not as
2197To "cut off" the list after item two, you can insert some non-indented
2198content, like an HTML comment, which won't produce visible output in
2204 <!-- end of list -->
2208You can use the same trick if you want two consecutive lists instead
2224A line containing a row of three or more `*`, `-`, or `_` characters
2225(optionally separated by spaces) produces a horizontal rule:
2235Four kinds of tables may be used. The first three kinds presuppose the use of
2236a fixed-width font, such as Courier. The fourth kind can be used with
2237proportionally spaced fonts, as it does not require lining up columns.
2239#### Extension: `table_captions` ####
2241A caption may optionally be provided with all 4 kinds of tables (as
2242illustrated in the examples below). A caption is a paragraph beginning
2243with the string `Table:` (or just `:`), which will be stripped off.
2244It may appear either before or after the table.
2246#### Extension: `simple_tables` ####
2248Simple tables look like this:
2250 Right Left Center Default
2251 ------- ------ ---------- -------
2256 Table: Demonstration of simple table syntax.
2258The headers and table rows must each fit on one line. Column
2259alignments are determined by the position of the header text relative
2260to the dashed line below it:[^4]
2262 - If the dashed line is flush with the header text on the right side
2263 but extends beyond it on the left, the column is right-aligned.
2264 - If the dashed line is flush with the header text on the left side
2265 but extends beyond it on the right, the column is left-aligned.
2266 - If the dashed line extends beyond the header text on both sides,
2267 the column is centered.
2268 - If the dashed line is flush with the header text on both sides,
2269 the default alignment is used (in most cases, this will be left).
2271[^4]: This scheme is due to Michel Fortin, who proposed it on the
2272 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2274The table must end with a blank line, or a line of dashes followed by
2277The column headers may be omitted, provided a dashed line is used
2278to end the table. For example:
2280 ------- ------ ---------- -------
2284 ------- ------ ---------- -------
2286When headers are omitted, column alignments are determined on the basis
2287of the first line of the table body. So, in the tables above, the columns
2288would be right, left, center, and right aligned, respectively.
2290#### Extension: `multiline_tables` ####
2292Multiline tables allow headers and table rows to span multiple lines
2293of text (but cells that span multiple columns or rows of the table are
2294not supported). Here is an example:
2296 -------------------------------------------------------------
2297 Centered Default Right Left
2298 Header Aligned Aligned Aligned
2299 ----------- ------- --------------- -------------------------
2300 First row 12.0 Example of a row that
2301 spans multiple lines.
2303 Second row 5.0 Here's another one. Note
2304 the blank line between
2306 -------------------------------------------------------------
2308 Table: Here's the caption. It, too, may span
2311These work like simple tables, but with the following differences:
2313 - They must begin with a row of dashes, before the header text
2314 (unless the headers are omitted).
2315 - They must end with a row of dashes, then a blank line.
2316 - The rows must be separated by blank lines.
2318In multiline tables, the table parser pays attention to the widths of
2319the columns, and the writers try to reproduce these relative widths in
2320the output. So, if you find that one of the columns is too narrow in the
2321output, try widening it in the Markdown source.
2323Headers may be omitted in multiline tables as well as simple tables:
2325 ----------- ------- --------------- -------------------------
2326 First row 12.0 Example of a row that
2327 spans multiple lines.
2329 Second row 5.0 Here's another one. Note
2330 the blank line between
2332 ----------- ------- --------------- -------------------------
2334 : Here's a multiline table without headers.
2336It is possible for a multiline table to have just one row, but the row
2337should be followed by a blank line (and then the row of dashes that ends
2338the table), or the table may be interpreted as a simple table.
2340#### Extension: `grid_tables` ####
2342Grid tables look like this:
2344 : Sample grid table.
2346 +---------------+---------------+--------------------+
2347 | Fruit | Price | Advantages |
2348 +===============+===============+====================+
2349 | Bananas | $1.34 | - built-in wrapper |
2350 | | | - bright color |
2351 +---------------+---------------+--------------------+
2352 | Oranges | $2.10 | - cures scurvy |
2354 +---------------+---------------+--------------------+
2356The row of `=`s separates the header from the table body, and can be
2357omitted for a headerless table. The cells of grid tables may contain
2358arbitrary block elements (multiple paragraphs, code blocks, lists,
2359etc.). Cells that span multiple columns or rows are not
2360supported. Grid tables can be created easily using [Emacs table mode].
2362[Emacs table mode]: http://table.sourceforge.net/
2364Alignments can be specified as with pipe tables, by putting
2365colons at the boundaries of the separator line after the
2368 +---------------+---------------+--------------------+
2369 | Right | Left | Centered |
2370 +==============:+:==============+:==================:+
2371 | Bananas | $1.34 | built-in wrapper |
2372 +---------------+---------------+--------------------+
2374For headerless tables, the colons go on the top line instead:
2376 +--------------:+:--------------+:------------------:+
2377 | Right | Left | Centered |
2378 +---------------+---------------+--------------------+
2381#### Extension: `pipe_tables` ####
2383Pipe tables look like this:
2385 | Right | Left | Default | Center |
2386 |------:|:-----|---------|:------:|
2387 | 12 | 12 | 12 | 12 |
2388 | 123 | 123 | 123 | 123 |
2391 : Demonstration of pipe table syntax.
2393The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2394ending pipe characters are optional, but pipes are required between all
2395columns. The colons indicate column alignment as shown. The header
2396cannot be omitted. To simulate a headerless table, include a header
2399Since the pipes indicate column boundaries, columns need not be vertically
2400aligned, as they are in the above example. So, this is a perfectly
2401legal (though ugly) pipe table:
2409The cells of pipe tables cannot contain block elements like paragraphs
2410and lists, and cannot span multiple lines. If a pipe table contains a
2411row whose printable content is wider than the column width (see
2412`--columns`), then the cell contents will wrap, with the
2413relative cell widths determined by the widths of the separator
2416Note: pandoc also recognizes pipe tables of the following
2417form, as can be produced by Emacs' orgtbl-mode:
2424The difference is that `+` is used instead of `|`. Other orgtbl features
2425are not supported. In particular, to get non-default column alignment,
2426you'll need to add colons as above.
2428[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2433#### Extension: `pandoc_title_block` ####
2435If the file begins with a title block
2438 % author(s) (separated by semicolons)
2441it will be parsed as bibliographic information, not regular text. (It
2442will be used, for example, in the title of standalone LaTeX or HTML
2443output.) The block may contain just a title, a title and an author,
2444or all three elements. If you want to include an author but no
2445title, or a title and a date but no author, you need a blank line:
2454The title may occupy multiple lines, but continuation lines must
2455begin with leading space, thus:
2460If a document has multiple authors, the authors may be put on
2461separate lines with leading space, or separated by semicolons, or
2462both. So, all of the following are equivalent:
2467 % Author One; Author Two
2472The date must fit on one line.
2474All three metadata fields may contain standard inline formatting
2475(italics, links, footnotes, etc.).
2477Title blocks will always be parsed, but they will affect the output only
2478when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2479will appear twice: once in the document head -- this is the title that
2480will appear at the top of the window in a browser -- and once at the
2481beginning of the document body. The title in the document head can have
2482an optional prefix attached (`--title-prefix` or `-T` option). The title
2483in the body appears as an H1 element with class "title", so it can be
2484suppressed or reformatted with CSS. If a title prefix is specified with
2485`-T` and no title block appears in the document, the title prefix will
2486be used by itself as the HTML title.
2488The man page writer extracts a title, man page section number, and
2489other header and footer information from the title line. The title
2490is assumed to be the first word on the title line, which may optionally
2491end with a (single-digit) section number in parentheses. (There should
2492be no space between the title and the parentheses.) Anything after
2493this is assumed to be additional footer and header text. A single pipe
2494character (`|`) should be used to separate the footer text from the header
2499will yield a man page with the title `PANDOC` and section 1.
2501 % PANDOC(1) Pandoc User Manuals
2503will also have "Pandoc User Manuals" in the footer.
2505 % PANDOC(1) Pandoc User Manuals | Version 4.0
2507will also have "Version 4.0" in the header.
2509#### Extension: `yaml_metadata_block` ####
2511A YAML metadata block is a valid YAML object, delimited by a line of three
2512hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2513(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2514document, but if it is not at the beginning, it must be preceded by a blank
2515line. (Note that, because of the way pandoc concatenates input files when
2516several are provided, you may also keep the metadata in a separate YAML file
2517and pass it to pandoc as an argument, along with your Markdown files:
2519 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2521Just be sure that the YAML file begins with `---` and ends with `---` or
2524Metadata will be taken from the fields of the YAML object and added to any
2525existing document metadata. Metadata can contain lists and objects (nested
2526arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2527with names ending in an underscore will be ignored by pandoc. (They may be
2528given a role by external processors.)
2530A document may contain multiple metadata blocks. The metadata fields will
2531be combined through a *left-biased union*: if two metadata blocks attempt
2532to set the same field, the value from the first block will be taken.
2534When pandoc is used with `-t markdown` to create a Markdown document,
2535a YAML metadata block will be produced only if the `-s/--standalone`
2536option is used. All of the metadata will appear in a single block
2537at the beginning of the document.
2539Note that YAML escaping rules must be followed. Thus, for example,
2540if a title contains a colon, it must be quoted. The pipe character
2541(`|`) can be used to begin an indented block that will be interpreted
2542literally, without need for escaping. This form is necessary
2543when the field contains blank lines:
2546 title: 'This is the title: it contains a colon'
2550 tags: [nothing, nothingness]
2552 This is the abstract.
2554 It consists of two paragraphs.
2557Template variables will be set automatically from the metadata. Thus, for
2558example, in writing HTML, the variable `abstract` will be set to the HTML
2559equivalent of the Markdown in the `abstract` field:
2561 <p>This is the abstract.</p>
2562 <p>It consists of two paragraphs.</p>
2564Variables can contain arbitrary YAML structures, but the template must match
2565this structure. The `author` variable in the default templates expects a
2566simple list or string, but can be changed to support more complicated
2567structures. The following combination, for example, would add an affiliation
2568to the author if one is given:
2571 title: The document title
2574 affiliation: University of Somewhere
2576 affiliation: University of Nowhere
2579To use the structured authors in the example above, you would need a custom
2584 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2594#### Extension: `all_symbols_escapable` ####
2596Except inside a code block or inline code, any punctuation or space
2597character preceded by a backslash will be treated literally, even if it
2598would normally indicate formatting. Thus, for example, if one writes
2608 <strong>hello</strong>
2610This rule is easier to remember than standard Markdown's rule,
2611which allows only the following characters to be backslash-escaped:
2615(However, if the `markdown_strict` format is used, the standard Markdown rule
2618A backslash-escaped space is parsed as a nonbreaking space. It will
2619appear in TeX output as `~` and in HTML and XML as `\ ` or
2622A backslash-escaped newline (i.e. a backslash occurring at the end of
2623a line) is parsed as a hard line break. It will appear in TeX output as
2624`\\` and in HTML as `<br />`. This is a nice alternative to
2625Markdown's "invisible" way of indicating hard line breaks using
2626two trailing spaces on a line.
2628Backslash escapes do not work in verbatim contexts.
2635If the `--smart` option is specified, pandoc will produce typographically
2636correct output, converting straight quotes to curly quotes, `---` to
2637em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces
2638are inserted after certain abbreviations, such as "Mr."
2640Note: if your LaTeX template or any included header file call for the
2641[`csquotes`] package, pandoc will detect this automatically and use
2642`\enquote{...}` for quoted text.
2649To *emphasize* some text, surround it with `*`s or `_`, like this:
2651 This text is _emphasized with underscores_, and this
2652 is *emphasized with asterisks*.
2654Double `*` or `_` produces **strong emphasis**:
2656 This is **strong emphasis** and __with underscores__.
2658A `*` or `_` character surrounded by spaces, or backslash-escaped,
2659will not trigger emphasis:
2661 This is * not emphasized *, and \*neither is this\*.
2663#### Extension: `intraword_underscores` ####
2665Because `_` is sometimes used inside words and identifiers,
2666pandoc does not interpret a `_` surrounded by alphanumeric
2667characters as an emphasis marker. If you want to emphasize
2668just part of a word, use `*`:
2670 feas*ible*, not feas*able*.
2675#### Extension: `strikeout` ####
2677To strikeout a section of text with a horizontal line, begin and end it
2678with `~~`. Thus, for example,
2680 This ~~is deleted text.~~
2683### Superscripts and subscripts ###
2685#### Extension: `superscript`, `subscript` ####
2687Superscripts may be written by surrounding the superscripted text by `^`
2688characters; subscripts may be written by surrounding the subscripted
2689text by `~` characters. Thus, for example,
2691 H~2~O is a liquid. 2^10^ is 1024.
2693If the superscripted or subscripted text contains spaces, these spaces
2694must be escaped with backslashes. (This is to prevent accidental
2695superscripting and subscripting through the ordinary use of `~` and `^`.)
2696Thus, if you want the letter P with 'a cat' in subscripts, use
2697`P~a\ cat~`, not `P~a cat~`.
2702To make a short span of text verbatim, put it inside backticks:
2704 What is the difference between `>>=` and `>>`?
2706If the verbatim text includes a backtick, use double backticks:
2708 Here is a literal backtick `` ` ``.
2710(The spaces after the opening backticks and before the closing
2711backticks will be ignored.)
2713The general rule is that a verbatim span starts with a string
2714of consecutive backticks (optionally followed by a space)
2715and ends with a string of the same number of backticks (optionally
2716preceded by a space).
2718Note that backslash-escapes (and other Markdown constructs) do not
2719work in verbatim contexts:
2721 This is a backslash followed by an asterisk: `\*`.
2723#### Extension: `inline_code_attributes` ####
2725Attributes can be attached to verbatim text, just as with
2726[fenced code blocks]:
2732To write small caps, you can use an HTML span tag:
2734 <span style="font-variant:small-caps;">Small caps</span>
2736(The semicolon is optional and there may be space after the
2737colon.) This will work in all output formats that support small caps.
2739Alternatively, you can also use the new `bracketed_spans` syntax:
2741 [Small caps]{style="font-variant:small-caps;"}
2746#### Extension: `tex_math_dollars` ####
2748Anything between two `$` characters will be treated as TeX math. The
2749opening `$` must have a non-space character immediately to its right,
2750while the closing `$` must have a non-space character immediately to its
2751left, and must not be followed immediately by a digit. Thus,
2752`$20,000 and $30,000` won't parse as math. If for some reason
2753you need to enclose text in literal `$` characters, backslash-escape
2754them and they won't be treated as math delimiters.
2756TeX math will be printed in all output formats. How it is rendered
2757depends on the output format:
2759Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2760 ~ It will appear verbatim between `$` characters.
2763 ~ It will be rendered using an [interpreted text role `:math:`].
2766 ~ It will be rendered as `latexmath:[...]`.
2769 ~ It will be rendered inside a `@math` command.
2772 ~ It will be rendered verbatim without `$`'s.
2775 ~ It will be rendered inside `<math>` tags.
2778 ~ It will be rendered inside `<span class="math">` tags.
2780RTF, OpenDocument, ODT
2781 ~ It will be rendered, if possible, using unicode characters,
2782 and will otherwise appear verbatim.
2785 ~ If the `--mathml` flag is used, it will be rendered using MathML
2786 in an `inlineequation` or `informalequation` tag. Otherwise it
2787 will be rendered, if possible, using unicode characters.
2790 ~ It will be rendered using OMML math markup.
2793 ~ If the `--webtex` option is used, formulas are rendered as images
2794 using CodeCogs or other compatible web service, downloaded
2795 and embedded in the e-book. Otherwise, they will appear verbatim.
2797HTML, Slidy, DZSlides, S5, EPUB
2798 ~ The way math is rendered in HTML will depend on the
2799 command-line options selected:
2801 1. The default is to render TeX math as far as possible using unicode
2802 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2803 are put inside a `span` with `class="math"`, so that they may be
2804 styled differently from the surrounding text if needed.
2806 2. If the `--latexmathml` option is used, TeX math will be displayed
2807 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2808 The [LaTeXMathML] script will be used to render it as formulas.
2809 (This trick does not work in all browsers, but it works in Firefox.
2810 In browsers that do not support LaTeXMathML, TeX math will appear
2811 verbatim between `$` characters.)
2813 3. If the `--jsmath` option is used, TeX math will be put inside
2814 `<span>` tags (for inline math) or `<div>` tags (for display math)
2815 with class `math`. The [jsMath] script will be used to render
2818 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2819 be called to generate images for each TeX formula. This should
2820 work in all browsers. The `--mimetex` option takes an optional URL
2821 as argument. If no URL is specified, it will be assumed that the
2822 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2824 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2825 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2826 be processed by [gladTeX], which will produce image files for each
2827 formula and an HTML file with links to these images. So, the
2830 pandoc -s --gladtex myfile.txt -o myfile.htex
2831 gladtex -d myfile-images myfile.htex
2832 # produces myfile.html and images in myfile-images
2834 6. If the `--webtex` option is used, TeX formulas will be converted
2835 to `<img>` tags that link to an external script that converts
2836 formulas to images. The formula will be URL-encoded and concatenated
2837 with the URL provided. If no URL is specified, the CodeCogs
2838 will be used (`https://latex.codecogs.com/png.latex?`).
2840 7. If the `--mathjax` option is used, TeX math will be displayed
2841 between `\(...\)` (for inline math) or `\[...\]` (for display
2842 math) and put in `<span>` tags with class `math`.
2843 The [MathJax] script will be used to render it as formulas.
2845[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2850#### Extension: `raw_html` ####
2852Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2853(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2854literally). (Technically this is not an extension, since standard
2855Markdown allows it, but it has been made an extension so that it can
2856be disabled if desired.)
2858The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2859DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
2862#### Extension: `markdown_in_html_blocks` ####
2864Standard Markdown allows you to include HTML "blocks": blocks
2865of HTML between balanced tags that are separated from the surrounding text
2866with blank lines, and start and end at the left margin. Within
2867these blocks, everything is interpreted as HTML, not Markdown;
2868so (for example), `*` does not signify emphasis.
2870Pandoc behaves this way when the `markdown_strict` format is used; but
2871by default, pandoc interprets material between HTML block tags as Markdown.
2872Thus, for example, pandoc will turn
2877 <td>[a link](http://google.com)</td>
2885 <td><em>one</em></td>
2886 <td><a href="http://google.com">a link</a></td>
2890whereas `Markdown.pl` will preserve it as is.
2892There is one exception to this rule: text between `<script>` and
2893`<style>` tags is not interpreted as Markdown.
2895This departure from standard Markdown should make it easier to mix
2896Markdown with HTML block elements. For example, one can surround
2897a block of Markdown text with `<div>` tags without preventing it
2898from being interpreted as Markdown.
2900#### Extension: `native_divs` ####
2902Use native pandoc `Div` blocks for content inside `<div>` tags.
2903For the most part this should give the same output as
2904`markdown_in_html_blocks`, but it makes it easier to write pandoc
2905filters to manipulate groups of blocks.
2907#### Extension: `native_spans` ####
2909Use native pandoc `Span` blocks for content inside `<span>` tags.
2910For the most part this should give the same output as `raw_html`,
2911but it makes it easier to write pandoc filters to manipulate groups
2917#### Extension: `raw_tex` ####
2919In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
2920included in a document. Inline TeX commands will be preserved and passed
2921unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
2922LaTeX to include BibTeX citations:
2924 This result was proved in \cite{jones.1967}.
2926Note that in LaTeX environments, like
2928 \begin{tabular}{|l|l|}\hline
2929 Age & Frequency \\ \hline
2932 36--45 & 22 \\ \hline
2935the material between the begin and end tags will be interpreted as raw
2936LaTeX, not as Markdown.
2938Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
2939Emacs Org mode, and ConTeXt.
2944#### Extension: `latex_macros` ####
2946For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
2947`\renewcommand` definitions and apply the resulting macros to all LaTeX
2948math. So, for example, the following will work in all output formats,
2951 \newcommand{\tuple}[1]{\langle #1 \rangle}
2955In LaTeX output, the `\newcommand` definition will simply be passed
2956unchanged to the output.
2962Markdown allows links to be specified in several ways.
2964### Automatic links ###
2966If you enclose a URL or email address in pointy brackets, it
2970 <sam@green.eggs.ham>
2974An inline link consists of the link text in square brackets,
2975followed by the URL in parentheses. (Optionally, the URL can
2976be followed by a link title, in quotes.)
2978 This is an [inline link](/url), and here's [one with
2979 a title](http://fsf.org "click here for a good time!").
2981There can be no space between the bracketed part and the parenthesized part.
2982The link text can contain formatting (such as emphasis), but the title cannot.
2984Email addresses in inline links are not autodetected, so they have to be
2985prefixed with `mailto`:
2987 [Write me!](mailto:sam@green.eggs.ham)
2989### Reference links ###
2991An *explicit* reference link has two parts, the link itself and the link
2992definition, which may occur elsewhere in the document (either
2993before or after the link).
2995The link consists of link text in square brackets, followed by a label in
2996square brackets. (There can be space between the two.) The link definition
2997consists of the bracketed label, followed by a colon and a space, followed by
2998the URL, and optionally (after a space) a link title either in quotes or in
2999parentheses. The label must not be parseable as a citation (assuming
3000the `citations` extension is enabled): citations take precedence over
3003Here are some examples:
3005 [my label 1]: /foo/bar.html "My title, optional"
3007 [my label 3]: http://fsf.org (The free software foundation)
3008 [my label 4]: /bar#special 'A title in single quotes'
3010The URL may optionally be surrounded by angle brackets:
3012 [my label 5]: <http://foo.bar.baz>
3014The title may go on the next line:
3016 [my label 3]: http://fsf.org
3017 "The free software foundation"
3019Note that link labels are not case sensitive. So, this will work:
3021 Here is [my link][FOO]
3025In an *implicit* reference link, the second pair of brackets is
3030 [my website]: http://foo.bar.baz
3032Note: In `Markdown.pl` and most other Markdown implementations,
3033reference link definitions cannot occur in nested constructions
3034such as list items or block quotes. Pandoc lifts this arbitrary
3035seeming restriction. So the following is fine in pandoc, though
3036not in most other implementations:
3042#### Extension: `shortcut_reference_links` ####
3044In a *shortcut* reference link, the second pair of brackets may
3049 [my website]: http://foo.bar.baz
3051### Internal links ###
3053To link to another section of the same document, use the automatically
3054generated identifier (see [Header identifiers]). For example:
3056 See the [Introduction](#introduction).
3060 See the [Introduction].
3062 [Introduction]: #introduction
3064Internal links are currently supported for HTML formats (including
3065HTML slide shows and EPUB), LaTeX, and ConTeXt.
3070A link immediately preceded by a `!` will be treated as an image.
3071The link text will be used as the image's alt text:
3073 
3077 [movie reel]: movie.gif
3079#### Extension: `implicit_figures` ####
3081An image occurring by itself in a paragraph will be rendered as
3082a figure with a caption.[^5] (In LaTeX, a figure environment will be
3083used; in HTML, the image will be placed in a `div` with class
3084`figure`, together with a caption in a `p` with class `caption`.)
3085The image's alt text will be used as the caption.
3087 
3089[^5]: This feature is not yet implemented for RTF, OpenDocument, or
3090 ODT. In those formats, you'll just get an image in a paragraph by
3091 itself, with no caption.
3093If you just want a regular inline image, just make sure it is not
3094the only thing in the paragraph. One way to do this is to insert a
3095nonbreaking space after the image:
3097 \
3099#### Extension: `link_attributes` ####
3101Attributes can be set on links and images:
3103 An inline {#id .class width=30 height=20px}
3104 and a reference ![image][ref] with attributes.
3106 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3108(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3109and `.class` are used.)
3111For HTML and EPUB, all attributes except `width` and `height` (but
3112including `srcset` and `sizes`) are passed through as is. The other
3113writers ignore attributes that are not supported by their output
3116The `width` and `height` attributes on images are treated specially. When
3117used without a unit, the unit is assumed to be pixels. However, any of
3118the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3119and `%`. There must not be any spaces between the number and the unit.
3123{ width=50% }
3126- Dimensions are converted to inches for output in page-based formats like
3127 LaTeX. Dimensions are converted to pixels for output in HTML-like
3128 formats. Use the `--dpi` option to specify the number of pixels per
3129 inch. The default is 96dpi.
3130- The `%` unit is generally relative to some available space.
3131 For example the above example will render to
3132 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3133 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3134 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3135- Some output formats have a notion of a class
3136 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3137 or a unique identifier (LaTeX `\caption`), or both (HTML).
3138- When no `width` or `height` attributes are specified, the fallback
3139 is to look at the image resolution and the dpi metadata embedded in
3145#### Extension: `bracketed_spans` ####
3147A bracketed sequence of inlines, as one would use to begin
3148a link, will be treated as a span with attributes if it is
3149followed immediately by attributes:
3151 [This is *some text*]{.class key="val"}
3156#### Extension: `footnotes` ####
3158Pandoc's Markdown allows footnotes, using the following syntax:
3160 Here is a footnote reference,[^1] and another.[^longnote]
3162 [^1]: Here is the footnote.
3164 [^longnote]: Here's one with multiple blocks.
3166 Subsequent paragraphs are indented to show that they
3167 belong to the previous footnote.
3171 The whole paragraph can be indented, or just the first
3172 line. In this way, multi-paragraph footnotes work like
3173 multi-paragraph list items.
3175 This paragraph won't be part of the note, because it
3178The identifiers in footnote references may not contain spaces, tabs,
3179or newlines. These identifiers are used only to correlate the
3180footnote reference with the note itself; in the output, footnotes
3181will be numbered sequentially.
3183The footnotes themselves need not be placed at the end of the
3184document. They may appear anywhere except inside other block elements
3185(lists, block quotes, tables, etc.).
3187#### Extension: `inline_notes` ####
3189Inline footnotes are also allowed (though, unlike regular notes,
3190they cannot contain multiple paragraphs). The syntax is as follows:
3192 Here is an inline note.^[Inlines notes are easier to write, since
3193 you don't have to pick an identifier and move down to type the
3196Inline and regular footnotes may be mixed freely.
3202#### Extension: `citations` ####
3204Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3205citations and a bibliography in a number of styles. Basic usage is
3207 pandoc --filter pandoc-citeproc myinput.txt
3209In order to use this feature, you will need to specify a bibliography file
3210using the `bibliography` metadata field in a YAML metadata section, or
3211`--bibliography` command line argument. You can supply multiple `--bibliography`
3212arguments or set `bibliography` metadata field to YAML array, if you want to
3213use multiple bibliography files. The bibliography may have any of these
3216 Format File extension
3217 ------------ --------------
3230Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3231use `.bibtex` to force BibTeX.
3233Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3234can produce `.json` and `.yaml` files from any of the supported formats.
3236In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3237a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3245`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3254`<span class="nocase">...</span>`
3255: prevent a phrase from being capitalized as title case
3257`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3258and CSL YAML formats as far as possible.
3260As an alternative to specifying a bibliography file using `--bibliography`
3261or the YAML metadata field `bibliography`, you can include
3262the citation data directly in the `references` field of the
3263document's YAML metadata. The field should contain an array of
3264YAML-encoded references, for example:
3268 - type: article-journal
3280 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3282 title-short: Molecular structure of nucleic acids
3283 container-title: Nature
3287 DOI: 10.1038/171737a0
3288 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3292(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3293of the supported formats.)
3295Citations and references can be formatted using any style supported by the
3296[Citation Style Language], listed in the [Zotero Style Repository].
3297These files are specified using the `--csl` option or the `csl` metadata field.
3298By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3299format. The CSL project provides further information on [finding and editing styles].
3301To make your citations hyperlinks to the corresponding bibliography
3302entries, add `link-citations: true` to your YAML metadata.
3304Citations go inside square brackets and are separated by semicolons.
3305Each citation must have a key, composed of '@' + the citation
3306identifier from the database, and may optionally have a prefix,
3307a locator, and a suffix. The citation key must begin with a letter, digit,
3308or `_`, and may contain alphanumerics, `_`, and internal punctuation
3309characters (`:.#$%&-+?<>~/`). Here are some examples:
3311 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3313 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3315 Blah blah [@smith04; @doe99].
3317`pandoc-citeproc` detects locator terms in the [CSL locale files].
3318Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3319locale, locator terms can be written in either singular or plural forms,
3320as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3321`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3322`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3323`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3324`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3325`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3326locator term is used, "page" is assumed.
3328A minus sign (`-`) before the `@` will suppress mention of
3329the author in the citation. This can be useful when the
3330author is already mentioned in the text:
3332 Smith says blah [-@smith04].
3334You can also write an in-text citation, as follows:
3338 @smith04 [p. 33] says blah.
3340If the style calls for a list of works cited, it will be placed
3341at the end of the document. Normally, you will want to end your
3342document with an appropriate header:
3348The bibliography will be inserted after this header. Note that
3349the `unnumbered` class will be added to this header, so that the
3350section will not be numbered.
3352If you want to include items in the bibliography without actually
3353citing them in the body text, you can define a dummy `nocite` metadata
3354field and put the citations there:
3363In this example, the document will contain a citation for `item3`
3364only, but the bibliography will contain entries for `item1`, `item2`, and
3367For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3368to render bibliography. In order to do so, specify bibliography files as
3369outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3370invocation. Bear in mind that bibliography files have to be in respective
3371format (either BibTeX or BibLaTeX).
3373For more information, see the [pandoc-citeproc man page].
3375[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3376[Chicago Manual of Style]: http://chicagomanualofstyle.org
3377[Citation Style Language]: http://citationstyles.org
3378[Zotero Style Repository]: https://www.zotero.org/styles
3379[finding and editing styles]: http://citationstyles.org/styles/
3380[CSL locale files]: https://github.com/citation-style-language/locales
3381[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3383Non-pandoc extensions
3384---------------------
3386The following Markdown syntax extensions are not enabled by default
3387in pandoc, but may be enabled by adding `+EXTENSION` to the format
3388name, where `EXTENSION` is the name of the extension. Thus, for
3389example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3391#### Extension: `angle_brackets_escapable` ####
3393Allow `<` and `>` to be backslash-escaped, as they can be in
3394GitHub flavored Markdown but not original Markdown. This is
3395implied by pandoc's default `all_symbols_escapable`.
3397#### Extension: `lists_without_preceding_blankline` ####
3399Allow a list to occur right after a paragraph, with no intervening
3402#### Extension: `hard_line_breaks` ####
3404Causes all newlines within a paragraph to be interpreted as hard line
3405breaks instead of spaces.
3407#### Extension: `ignore_line_breaks` ####
3409Causes newlines within a paragraph to be ignored, rather than being
3410treated as spaces or as hard line breaks. This option is intended for
3411use with East Asian languages where spaces are not used between words,
3412but text is divided into lines for readability.
3414#### Extension: `east_asian_line_breaks` ####
3416Causes newlines within a paragraph to be ignored, rather than
3417being treated as spaces or as hard line breaks, when they occur
3418between two East Asian wide characters. This is a better choice
3419than `ignore_line_breaks` for texts that include a mix of East
3420Asian wide characters and other characters.
3422##### Extension: `emoji` ####
3424Parses textual emojis like `:smile:` as Unicode emoticons.
3426#### Extension: `tex_math_single_backslash` ####
3428Causes anything between `\(` and `\)` to be interpreted as inline
3429TeX math, and anything between `\[` and `\]` to be interpreted
3430as display TeX math. Note: a drawback of this extension is that
3431it precludes escaping `(` and `[`.
3433#### Extension: `tex_math_double_backslash` ####
3435Causes anything between `\\(` and `\\)` to be interpreted as inline
3436TeX math, and anything between `\\[` and `\\]` to be interpreted
3439#### Extension: `markdown_attribute` ####
3441By default, pandoc interprets material inside block-level tags as Markdown.
3442This extension changes the behavior so that Markdown is only parsed
3443inside block-level tags if the tags have the attribute `markdown=1`.
3445#### Extension: `mmd_title_block` ####
3447Enables a [MultiMarkdown] style title block at the top of
3448the document, for example:
3452 Date: September 1, 2008
3453 Comment: This is a sample mmd title block, with
3454 a field spanning multiple lines.
3456See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3457`yaml_metadata_block` is enabled, it will take precedence over
3460#### Extension: `abbreviations` ####
3462Parses PHP Markdown Extra abbreviation keys, like
3464 *[HTML]: Hypertext Markup Language
3466Note that the pandoc document model does not support
3467abbreviations, so if this extension is enabled, abbreviation keys are
3468simply skipped (as opposed to being parsed as paragraphs).
3470#### Extension: `autolink_bare_uris` ####
3472Makes all absolute URIs into links, even when not surrounded by
3473pointy braces `<...>`.
3475#### Extension: `ascii_identifiers` ####
3477Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3478Accents are stripped off of accented latin letters, and non-latin
3481#### Extension: `mmd_link_attributes` ####
3483Parses multimarkdown style key-value attributes on link
3484and image references. This extension should not be confused with the
3485[`link_attributes`](#extension-link_attributes) extension.
3487 This is a reference ![image][ref] with multimarkdown attributes.
3489 [ref]: http://path.to/image "Image title" width=20px height=30px
3490 id=myId class="myClass1 myClass2"
3492#### Extension: `mmd_header_identifiers` ####
3494Parses multimarkdown style header identifiers (in square brackets,
3495after the header but before any trailing `#`s in an ATX header).
3497#### Extension: `compact_definition_lists` ####
3499Activates the definition list syntax of pandoc 1.12.x and earlier.
3500This syntax differs from the one described above under [Definition lists]
3503 - No blank line is required between consecutive items of the
3505 - To get a "tight" or "compact" list, omit space between consecutive
3506 items; the space between a term and its definition does not affect
3508 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3509 be indented four spaces.[^6]
3511[^6]: To see why laziness is incompatible with relaxing the requirement
3512 of a blank line between items, consider the following example:
3519 Is this a single list item with two definitions of "bar," the first of
3520 which is lazily wrapped, or two list items? To remove the ambiguity
3521 we must either disallow lazy wrapping or require a blank line between
3527In addition to pandoc's extended Markdown, the following Markdown
3528variants are supported:
3530`markdown_phpextra` (PHP Markdown Extra)
3531: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3532 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3533 `header_attributes`, `link_attributes`, `abbreviations`,
3534 `shortcut_reference_links`.
3536`markdown_github` (GitHub-Flavored Markdown)
3537: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3538 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3539 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3540 `shortcut_reference_links`, `angle_brackets_escapable`.
3542`markdown_mmd` (MultiMarkdown)
3543: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3544 `tex_math_double_backslash`, `intraword_underscores`,
3545 `mmd_title_block`, `footnotes`, `definition_lists`,
3546 `all_symbols_escapable`, `implicit_header_references`,
3547 `auto_identifiers`, `mmd_header_identifiers`,
3548 `shortcut_reference_links`.
3550`markdown_strict` (Markdown.pl)
3553Extensions with formats other than Markdown
3554-------------------------------------------
3556Some of the extensions discussed above can be used with formats
3559* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3560 and `textile` input (and is used by default).
3562* `tex_math_dollars`, `tex_math_single_backslash`, and
3563 `tex_math_double_backslash` can be used with `html` input.
3564 (This is handy for reading web pages formatted using MathJax,
3567Producing slide shows with pandoc
3568=================================
3570You can use pandoc to produce an HTML + javascript slide presentation
3571that can be viewed via a web browser. There are five ways to do this,
3572using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3573You can also produce a PDF slide show using LaTeX [`beamer`].
3575Here's the Markdown source for a simple slide show, `habits.txt`:
3602 
3609To produce an HTML/javascript slide show, simply type
3611 pandoc -t FORMAT -s habits.txt -o habits.html
3613where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3615For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3616`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3617assumed to be available at the relative path `s5/default` (for S5), `slideous`
3618(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3619`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3620`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3621above.) For DZSlides, the (relatively short) javascript and css are included in
3624With all HTML slide formats, the `--self-contained` option can be used to
3625produce a single file that contains all of the data necessary to display the
3626slide show, including linked scripts, stylesheets, images, and videos.
3628To produce a PDF slide show using beamer, type
3630 pandoc -t beamer habits.txt -o habits.pdf
3632Note that a reveal.js slide show can also be converted to a PDF
3633by printing it to a file from the browser.
3635Structuring the slide show
3636--------------------------
3638By default, the *slide level* is the highest header level in
3639the hierarchy that is followed immediately by content, and not another
3640header, somewhere in the document. In the example above, level 1 headers
3641are always followed by level 2 headers, which are followed by content,
3642so 2 is the slide level. This default can be overridden using
3643the `--slide-level` option.
3645The document is carved up into slides according to the following
3648 * A horizontal rule always starts a new slide.
3650 * A header at the slide level always starts a new slide.
3652 * Headers *below* the slide level in the hierarchy create
3653 headers *within* a slide.
3655 * Headers *above* the slide level in the hierarchy create
3656 "title slides," which just contain the section title
3657 and help to break the slide show into sections.
3659 * A title page is constructed automatically from the document's title
3660 block, if present. (In the case of beamer, this can be disabled
3661 by commenting out some lines in the default template.)
3663These rules are designed to support many different styles of slide show. If
3664you don't care about structuring your slides into sections and subsections,
3665you can just use level 1 headers for all each slide. (In that case, level 1
3666will be the slide level.) But you can also structure the slide show into
3667sections, as in the example above.
3669Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3670layout will be produced, with level 1 headers building horizontally
3671and level 2 headers building vertically. It is not recommended that
3672you use deeper nesting of section levels with reveal.js.
3677By default, these writers produce lists that display "all at once."
3678If you want your lists to display incrementally (one item at a time),
3679use the `-i` option. If you want a particular list to depart from the
3680default (that is, to display incrementally without the `-i` option and
3681all at once with the `-i` option), put it in a block quote:
3686In this way incremental and nonincremental lists can be mixed in
3692You can add "pauses" within a slide by including a paragraph containing
3693three dots, separated by spaces:
3695 # Slide with a pause
3697 content before the pause
3701 content after the pause
3706You can change the style of HTML slides by putting customized CSS files
3707in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3708or `$DATADIR/slideous` (for Slideous),
3709where `$DATADIR` is the user data directory (see `--data-dir`, above).
3710The originals may be found in pandoc's system data directory (generally
3711`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3712files it does not find in the user data directory.
3714For dzslides, the CSS is included in the HTML file itself, and may
3717All [reveal.js configuration options] can be set through variables.
3718For example, themes can be used by setting the `theme` variable:
3722Or you can specify a custom stylesheet using the `--css` option.
3724To style beamer slides, you can specify a `theme`, `colortheme`,
3725`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3727 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3729Note that header attributes will turn into slide attributes
3730(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3731to style individual slides. In beamer, the only header attribute
3732that affects slides is the `allowframebreaks` class, which sets the
3733`allowframebreaks` option, causing multiple slides to be created
3734if the content overfills the frame. This is recommended especially for
3737 # References {.allowframebreaks}
3742reveal.js has good support for speaker notes. You can add notes to your
3743Markdown document thus:
3748 - It can contain Markdown
3753To show the notes window, press `s` while viewing the presentation.
3754Notes are not yet supported for other slide formats, but the notes
3755will not appear on the slides themselves.
3757Frame attributes in beamer
3758--------------------------
3760Sometimes it is necessary to add the LaTeX `[fragile]` option to
3761a frame in beamer (for example, when using the `minted` environment).
3762This can be forced by adding the `fragile` class to the header
3763introducing the slide:
3765 # Fragile slide {.fragile}
3767All of the other frame attributes described in Section 8.1 of
3768the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3769`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3772Creating EPUBs with pandoc
3773==========================
3778EPUB metadata may be specified using the `--epub-metadata` option, but
3779if the source document is Markdown, it is better to use a [YAML metadata
3780block][Extension: `yaml_metadata_block`]. Here is an example:
3787 text: An investigation of metadata
3795 text: doi:10.234234.234/33
3797 rights: © 2007 John Smith, CC BY-NC
3800The following fields are recognized:
3803 ~ Either a string value or an object with fields `text` and
3804 `scheme`. Valid values for `scheme` are `ISBN-10`,
3805 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
3806 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
3807 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
3810 ~ Either a string value, or an object with fields `file-as` and
3811 `type`, or a list of such objects. Valid values for `type` are
3812 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
3815 ~ Either a string value, or an object with fields `role`, `file-as`,
3816 and `text`, or a list of such objects. Valid values for `role` are
3817 [MARC relators], but
3818 pandoc will attempt to translate the human-readable versions
3819 (like "author" and "editor") to the appropriate marc relators.
3822 ~ Same format as `creator`.
3825 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
3826 Pandoc will attempt to convert other common date formats.
3828`lang` (or legacy: `language`)
3829 ~ A string value in [BCP 47] format. Pandoc will default to the local
3830 language if nothing is specified.
3833 ~ A string value or a list of such values.
3854 ~ A string value (path to cover image).
3857 ~ A string value (path to CSS stylesheet).
3859`page-progression-direction`
3860 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
3861 attribute for the [`spine` element].
3863[MARC relators]: http://loc.gov/marc/relators/relaterm.html
3864[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
3869By default, pandoc will download linked media (including audio and
3870video) and include it in the EPUB container, yielding a completely
3871self-contained EPUB. If you want to link to external media resources
3872instead, use raw HTML in your source and add `data-external="1"` to the tag
3873with the `src` attribute. For example:
3875 <audio controls="1">
3876 <source src="http://example.com/music/toccata.mp3"
3877 data-external="1" type="audio/mpeg">
3881Literate Haskell support
3882========================
3884If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
3885format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
3886`beamer`, `html` or `html5` for output only), pandoc will treat the document as
3887literate Haskell source. This means that
3889 - In Markdown input, "bird track" sections will be parsed as Haskell
3890 code rather than block quotations. Text between `\begin{code}`
3891 and `\end{code}` will also be treated as Haskell code. For
3892 ATX-style headers the character '=' will be used instead of '#'.
3894 - In Markdown output, code blocks with classes `haskell` and `literate`
3895 will be rendered using bird tracks, and block quotations will be
3896 indented one space, so they will not be treated as Haskell code.
3897 In addition, headers will be rendered setext-style (with underlines)
3898 rather than ATX-style (with '#' characters). (This is because ghc
3899 treats '#' characters in column 1 as introducing line numbers.)
3901 - In restructured text input, "bird track" sections will be parsed
3904 - In restructured text output, code blocks with class `haskell` will
3905 be rendered using bird tracks.
3907 - In LaTeX input, text in `code` environments will be parsed as
3910 - In LaTeX output, code blocks with class `haskell` will be rendered
3911 inside `code` environments.
3913 - In HTML output, code blocks with class `haskell` will be rendered
3914 with class `literatehaskell` and bird tracks.
3918 pandoc -f markdown+lhs -t html
3920reads literate Haskell source formatted with Markdown conventions and writes
3921ordinary HTML (without bird tracks).
3923 pandoc -f markdown+lhs -t html+lhs
3925writes HTML with the Haskell code in bird tracks, so it can be copied
3926and pasted as literate Haskell source.
3931Pandoc will automatically highlight syntax in [fenced code blocks] that
3932are marked with a language name. The Haskell library [highlighting-kate] is used for
3933highlighting, which works in HTML, Docx, and LaTeX/PDF output.
3934The color scheme can be selected using the `--highlight-style` option.
3935The default color scheme is `pygments`, which imitates the default color
3936scheme used by the Python library pygments, but pygments is not actually
3937used to do the highlighting.
3939To see a list of language names that pandoc will recognize, type
3942To disable highlighting, use the `--no-highlight` option.
3944[highlighting-kate]: https://github.com/jgm/highlighting-kate
3946Custom Styles in Docx Output
3947============================
3949By default, pandoc's docx output applies a predefined set of styles for
3950blocks such as paragraphs and block quotes, and uses largely default
3951formatting (italics, bold) for inlines. This will work for most
3952purposes, especially alongside a `reference.docx` file. However, if you
3953need to apply your own styles to blocks, or match a preexisting set of
3954styles, pandoc allows you to define custom styles for blocks and text
3955using `div`s and `span`s, respecitively.
3957If you define a `div` or `span` with the attribute `custom-style`,
3958pandoc will apply your specified style to the contained elements. So,
3961 <span custom-style="Emphatically">Get out,</span> he said.
3963would produce a docx file with "Get out," styled with character
3964style `Emphatically`. Similarly,
3966 Dickinson starts the poem simply:
3968 <div custom-style="Poetry">
3969 | A Bird came down the Walk---
3970 | He did not know I saw---
3973would style the two contained lines with the `Poetry` paragraph style.
3975If the styles are not yet in your reference.docx, they will be defined
3976in the output file as inheriting from normal text. If they are already
3977defined, pandoc will not alter the definition.
3979This feature allows for greatest customization in conjunction with
3980[pandoc filters]. If you want all paragraphs after block quotes to be
3981indented, you can write a filter to apply the styles necessary. If you
3982want all italics to be transformed to the `Emphasis` character style
3983(perhaps to change their color), you can write a filter which will
3984transform all italicized inlines to inlines within an `Emphasis`
3987[pandoc filters]: http://pandoc.org/scripting.html
3992Pandoc can be extended with custom writers written in [lua]. (Pandoc
3993includes a lua interpreter, so lua need not be installed separately.)
3995To use a custom writer, simply specify the path to the lua script
3996in place of the output format. For example:
3998 pandoc -t data/sample.lua
4000Creating a custom writer requires writing a lua function for each
4001possible element in a pandoc document. To get a documented example
4002which you can modify according to your needs, do
4004 pandoc --print-default-data-file sample.lua
4006[lua]: http://www.lua.org
4011© 2006-2016 John MacFarlane (jgm@berkeley.edu). Released under the
4012[GPL], version 2 or greater. This software carries no warranty of
4013any kind. (See COPYRIGHT for full copyright and warranty notices.)
4021Alexander Kondratskiy,
4023Alexander V Vershilov,
4024Alfred Wechselberger,
4033Beni Cherniavsky-Paskin,
4044Christoffer Ackelman,
4082Jaime Marquínez Ferrándiz,
4119Matthias C. M. Troffaes,
4185[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