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
16Markdown], [MultiMarkdown], and (subsets of) [Textile],
17[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
18[Haddock markup], [OPML], [Emacs Org mode], [DocBook], [Muse], [txt2tags],
19[Vimwiki], [EPUB], [ODT], and [Word docx]; and it can
20write plain text, [Markdown], [CommonMark], [PHP Markdown
21Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
22[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
23[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
24[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
25markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
26[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
29or [S5] HTML slide shows. It can also produce [PDF] output on
30systems where LaTeX, ConTeXt, `pdfroff`, or `wkhtmltopdf` is
33Pandoc's enhanced version of Markdown includes syntax for [footnotes],
34[tables], flexible [ordered lists], [definition lists], [fenced code
35blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
36automatic tables of contents, embedded LaTeX [math], [citations], and
37[Markdown inside HTML block elements][Extension:
38`markdown_in_html_blocks`]. (These enhancements, described further under
39[Pandoc's Markdown], can be disabled using the `markdown_strict` input
42In contrast to most existing tools for converting Markdown to HTML, which
43use regex substitutions, pandoc has a modular design: it consists of a
44set of readers, which parse text in a given format and produce a native
45representation of the document, and a set of writers, which convert
46this native representation into a target format. Thus, adding an input
47or output format requires only adding a reader or writer.
49Because pandoc's intermediate representation of a document is less
50expressive than many of the formats it converts between, one should
51not expect perfect conversions between every format and every other.
52Pandoc attempts to preserve the structural elements of a document, but
53not formatting details such as margin size. And some document elements,
54such as complex tables, may not fit into pandoc's simple document
55model. While conversions from pandoc's Markdown to all formats aspire
56to be perfect, conversions from formats more expressive than pandoc's
57Markdown can be expected to be lossy.
59[Markdown]: http://daringfireball.net/projects/markdown/
60[CommonMark]: http://commonmark.org
61[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65[S5]: http://meyerweb.com/eric/tools/s5/
66[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67[Slideous]: http://goessner.net/articles/slideous/
68[HTML]: http://www.w3.org/html/
69[HTML5]: http://www.w3.org/TR/html5/
70[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71[XHTML]: http://www.w3.org/TR/xhtml1/
72[LaTeX]: http://latex-project.org
73[`beamer`]: https://ctan.org/pkg/beamer
74[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75[ConTeXt]: http://www.contextgarden.net/
76[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77[DocBook]: http://docbook.org
78[txt2tags]: http://txt2tags.org
79[EPUB]: http://idpf.org/epub
80[OPML]: http://dev.opml.org/spec2.html
81[OpenDocument]: http://opendocument.xml.org
82[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83[Textile]: http://redcloth.org/textile
84[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
89[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
90[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
91[Haskell]: https://www.haskell.org
92[GNU Texinfo]: http://www.gnu.org/software/texinfo/
93[Emacs Org mode]: http://orgmode.org
94[AsciiDoc]: http://www.methods.co.nz/asciidoc/
95[DZSlides]: http://paulrouget.com/dzslides/
96[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
97[PDF]: https://www.adobe.com/pdf/
98[reveal.js]: http://lab.hakim.se/reveal-js/
99[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
100[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
101[TEI Simple]: https://github.com/TEIC/TEI-Simple
102[Muse]: https://amusewiki.org/library/manual
103[Vimwiki]: https://vimwiki.github.io
108If no *input-file* is specified, input is read from *stdin*.
109Otherwise, the *input-files* are concatenated (with a blank
110line between each) and used as input. Output goes to *stdout* by
111default (though output to *stdout* is disabled for the `odt`, `docx`,
112`epub2`, and `epub3` output formats). For output to a file, use the
115 pandoc -o output.html input.txt
117By default, pandoc produces a document fragment, not a standalone
118document with a proper header and footer. To produce a standalone
119document, use the `-s` or `--standalone` flag:
121 pandoc -s -o output.html input.txt
123For more information on how standalone documents are produced, see
126Instead of a file, an absolute URI may be given. In this case
127pandoc will fetch the content using HTTP:
129 pandoc -f html -t markdown http://www.fsf.org
131It is possible to supply a custom User-Agent string when requesting a
132document from a URL, by setting an environment variable:
134 USER_AGENT="Mozilla/5.0" pandoc -f html -t markdown http://www.fsf.org
136If multiple input files are given, `pandoc` will concatenate them all (with
137blank lines between them) before parsing. This feature is disabled for
138 binary input formats such as `EPUB`, `odt`, and `docx`.
140The format of the input and output can be specified explicitly using
141command-line options. The input format can be specified using the
142`-r/--read` or `-f/--from` options, the output format using the
143`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
144Markdown to LaTeX, you could type:
146 pandoc -f markdown -t latex hello.txt
148To convert `hello.html` from HTML to Markdown:
150 pandoc -f html -t markdown hello.html
152Supported output formats are listed below under the `-t/--to` option.
153Supported input formats are listed below under the `-f/--from` option. Note
154that the `rst`, `textile`, `latex`, and `html` readers are not complete;
155there are some constructs that they do not parse.
157If the input or output format is not specified explicitly, `pandoc`
158will attempt to guess it from the extensions of
159the input and output filenames. Thus, for example,
161 pandoc -o hello.tex hello.txt
163will convert `hello.txt` from Markdown to LaTeX. If no output file
164is specified (so that output goes to *stdout*), or if the output file's
165extension is unknown, the output format will default to HTML.
166If no input file is specified (so that input comes from *stdin*), or
167if the input files' extensions are unknown, the input format will
168be assumed to be Markdown unless explicitly specified.
170Pandoc uses the UTF-8 character encoding for both input and output.
171If your local character encoding is not UTF-8, you
172should pipe input and output through [`iconv`]:
174 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
176Note that in some output formats (such as HTML, LaTeX, ConTeXt,
177RTF, OPML, DocBook, and Texinfo), information about
178the character encoding is included in the document header, which
179will only be included if you use the `-s/--standalone` option.
181[`iconv`]: http://www.gnu.org/software/libiconv/
186To produce a PDF, specify an output file with a `.pdf` extension.
187By default, pandoc will use LaTeX to convert it to PDF:
189 pandoc test.txt -o test.pdf
191Production of a PDF requires that a LaTeX engine be installed (see
192`--latex-engine`, below), and assumes that the following LaTeX packages
193are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
194[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
195`--listings` option is used), [`fancyvrb`], [`longtable`],
196[`booktabs`], [`graphicx`] and [`grffile`] (if the document
197contains images), [`hyperref`], [`ulem`], [`geometry`] (with the
198`geometry` variable set), [`setspace`] (with `linestretch`), and
199[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
200the LaTeX engine requires [`fontspec`]. `xelatex` uses
201[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
202`dir` variable set). If the `mathspec` variable is set,
203`xelatex` will use [`mathspec`] instead of [`unicode-math`].
204The [`upquote`] and [`microtype`] packages are used if
205available, and [`csquotes`] will be used for [smart punctuation]
206if added to the template or included in any header file. The
207[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
208optionally be used for [citation rendering]. These are included
209with all recent versions of [TeX Live].
211Alternatively, pandoc can use ConTeXt, `wkhtmltopdf`, or
212`pdfroff` to create a PDF. To do this, specify an output file
213with a `.pdf` extension, as before, but add `-t context`, `-t
214html5`, or `-t ms` to the command line.
216PDF output can be controlled using [variables for LaTeX] (if
217LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
218If `wkhtmltopdf` is used, then the variables `margin-left`,
219`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
220will affect the output, as will `--css`.
222[`amsfonts`]: https://ctan.org/pkg/amsfonts
223[`amsmath`]: https://ctan.org/pkg/amsmath
224[`lm`]: https://ctan.org/pkg/lm
225[`ifxetex`]: https://ctan.org/pkg/ifxetex
226[`ifluatex`]: https://ctan.org/pkg/ifluatex
227[`eurosym`]: https://ctan.org/pkg/eurosym
228[`listings`]: https://ctan.org/pkg/listings
229[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
230[`longtable`]: https://ctan.org/pkg/longtable
231[`booktabs`]: https://ctan.org/pkg/booktabs
232[`graphicx`]: https://ctan.org/pkg/graphicx
233[`grffile`]: https://ctan.org/pkg/grffile
234[`geometry`]: https://ctan.org/pkg/geometry
235[`setspace`]: https://ctan.org/pkg/setspace
236[`xecjk`]: https://ctan.org/pkg/xecjk
237[`hyperref`]: https://ctan.org/pkg/hyperref
238[`ulem`]: https://ctan.org/pkg/ulem
239[`babel`]: https://ctan.org/pkg/babel
240[`bidi`]: https://ctan.org/pkg/bidi
241[`mathspec`]: https://ctan.org/pkg/mathspec
242[`unicode-math`]: https://ctan.org/pkg/unicode-math
243[`polyglossia`]: https://ctan.org/pkg/polyglossia
244[`fontspec`]: https://ctan.org/pkg/fontspec
245[`upquote`]: https://ctan.org/pkg/upquote
246[`microtype`]: https://ctan.org/pkg/microtype
247[`csquotes`]: https://ctan.org/pkg/csquotes
248[`natbib`]: https://ctan.org/pkg/natbib
249[`biblatex`]: https://ctan.org/pkg/biblatex
250[`bibtex`]: https://ctan.org/pkg/bibtex
251[`biber`]: https://ctan.org/pkg/biber
252[TeX Live]: http://www.tug.org/texlive/
260`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
262: Specify input format. *FORMAT* can be `native` (native Haskell),
263 `json` (JSON version of native AST), `markdown` (pandoc's
264 extended Markdown), `markdown_strict` (original unextended
265 Markdown), `markdown_phpextra` (PHP Markdown Extra), `markdown_github`
266 (GitHub-Flavored Markdown), `markdown_mmd` (MultiMarkdown),
267 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
268 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
269 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
270 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
271 markup), `haddock` (Haddock markup), or `latex` (LaTeX). If
272 `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
273 input will be treated as literate Haskell source: see [Literate
274 Haskell support], below. Markdown
275 syntax extensions can be individually enabled or disabled by
276 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
277 example, `markdown_strict+footnotes+definition_lists` is strict
278 Markdown with footnotes and definition lists enabled, and
279 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
280 without pipe tables and with hard line breaks. See [Pandoc's
281 Markdown], below, for a list of extensions and
282 their names. See `--list-input-formats` and `--list-extensions`,
285`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
287: Specify output format. *FORMAT* can be `native` (native Haskell),
288 `json` (JSON version of native AST), `plain` (plain text),
289 `markdown` (pandoc's extended Markdown), `markdown_strict`
290 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
291 Extra), `markdown_github` (GitHub-Flavored Markdown), `markdown_mmd`
292 (MultiMarkdown), `commonmark` (CommonMark Markdown), `rst`
293 (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
294 or `html5` (HTML5/XHTML [polyglot markup]), `latex`
295 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
296 `man` (groff man), `mediawiki` (MediaWiki markup),
297 `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
298 `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
299 `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
300 (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
301 `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
302 (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
303 `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
304 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
305 Simple), `slidy` (Slidy HTML and JavaScript slide show),
306 `slideous` (Slideous HTML and JavaScript slide show),
307 `dzslides` (DZSlides HTML5 + JavaScript slide show),
308 `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
309 (S5 HTML and JavaScript slide show), or the path of a custom
310 lua writer (see [Custom writers], below). Note that `odt`,
311 `epub`, and `epub3` output will not be directed to *stdout*;
312 an output filename must be specified using the `-o/--output`
313 option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
314 `beamer`, `html4`, or `html5`, the output will be rendered as
315 literate Haskell source: see [Literate Haskell support],
316 below. Markdown syntax extensions can be individually
317 enabled or disabled by appending `+EXTENSION` or
318 `-EXTENSION` to the format name, as described above under `-f`.
319 See `--list-output-formats` and `--list-extensions`, below.
321`-o` *FILE*, `--output=`*FILE*
323: Write output to *FILE* instead of *stdout*. If *FILE* is
324 `-`, output will go to *stdout*. (Exception: if the output
325 format is `odt`, `docx`, `epub`, or `epub3`, output to stdout is disabled.)
327`--data-dir=`*DIRECTORY*
329: Specify the user data directory to search for pandoc data files.
330 If this option is not specified, the default user data directory
331 will be used. This is, in Unix:
337 C:\Documents And Settings\USERNAME\Application Data\pandoc
339 and in Windows Vista or later:
341 C:\Users\USERNAME\AppData\Roaming\pandoc
343 You can find the default user data directory on your system by
344 looking at the output of `pandoc --version`.
345 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
346 `slidy`, `slideous`, or `s5` directory
347 placed in this directory will override pandoc's normal defaults.
351: Generate a bash completion script. To enable bash completion
352 with pandoc, add this to your `.bashrc`:
354 eval "$(pandoc --bash-completion)"
358: Give verbose debugging output. Currently this only has an effect
363: Suppress warning messages.
367: Exit with error status if there are any warnings.
371: Write log messages in machine-readable JSON format to
372 *FILE*. All messages above DEBUG level will be written,
373 regardless of verbosity settings (`--verbose`, `--quiet`).
375`--list-input-formats`
377: List supported input formats, one per line.
379`--list-output-formats`
381: List supported output formats, one per line.
385: List supported Markdown extensions, one per line, followed
386 by a `+` or `-` indicating whether it is enabled by default
387 in pandoc's Markdown.
389`--list-highlight-languages`
391: List supported languages for syntax highlighting, one per
394`--list-highlight-styles`
396: List supported styles for syntax highlighting, one per line.
397 See `--highlight-style`.
410`--base-header-level=`*NUMBER*
412: Specify the base level for headers (defaults to 1).
414`--indented-code-classes=`*CLASSES*
416: Specify classes to use for indented code blocks--for example,
417 `perl,numberLines` or `haskell`. Multiple classes may be separated
420`--default-image-extension=`*EXTENSION*
422: Specify a default extension to use when image paths/URLs have no
423 extension. This allows you to use the same source for formats that
424 require different kinds of images. Currently this option only affects
425 the Markdown and LaTeX readers.
429: Parse each file individually before combining for multifile
430 documents. This will allow footnotes in different files with the
431 same identifiers to work as expected. If this option is set,
432 footnotes and links will not work across files. Reading binary
433 files (docx, odt, epub) implies `--file-scope`.
437: Specify an executable to be used as a filter transforming the
438 pandoc AST after the input is parsed and before the output is
439 written. The executable should read JSON from stdin and write
440 JSON to stdout. The JSON must be formatted like pandoc's own
441 JSON input and output. The name of the output format will be
442 passed to the filter as the first argument. Hence,
444 pandoc --filter ./caps.py -t latex
448 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
450 The latter form may be useful for debugging filters.
452 Filters may be written in any language. `Text.Pandoc.JSON`
453 exports `toJSONFilter` to facilitate writing filters in Haskell.
454 Those who would prefer to write filters in python can use the
455 module [`pandocfilters`], installable from PyPI. There are also
456 pandoc filter libraries in [PHP], [perl], and
457 [javascript/node.js].
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`--lua-filter=`*SCRIPT*
470: Transform the document in a similar fashion as JSON filters (see
471 `--filter`), but use pandoc's build-in lua filtering system. The given
472 lua script is expected to return a list of lua filters which will be
473 applied in order. Each lua filter must contain element-transforming
474 functions indexed by the name of the AST element on which the filter
475 function should be applied.
477 The `pandoc` lua module provides helper functions for element
478 creation. It is always loaded into the script's lua environment.
480 The following is an example lua script for macro-expansion:
482 function expand_hello_world(inline)
483 if inline.c == '{{helloworld}}' then
484 return pandoc.Emph{ pandoc.Str "Hello, World" }
490 return {{Str = expand_hello_world}}
493`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
495: Set the metadata field *KEY* to the value *VAL*. A value specified
496 on the command line overrides a value specified in the document.
497 Values will be parsed as YAML boolean or string values. If no value is
498 specified, the value will be treated as Boolean true. Like
499 `--variable`, `--metadata` causes template variables to be set.
500 But unlike `--variable`, `--metadata` affects the metadata of the
501 underlying document (which is accessible from filters and may be
502 printed in some output formats).
504`-p`, `--preserve-tabs`
506: Preserve tabs instead of converting them to spaces (the default).
507 Note that this will only affect tabs in literal code spans and code
508 blocks; tabs in regular text will be treated as spaces.
512: Specify the number of spaces per tab (default is 4).
514`--track-changes=accept`|`reject`|`all`
516: Specifies what to do with insertions, deletions, and comments
517 produced by the MS Word "Track Changes" feature. `accept` (the
518 default), inserts all insertions, and ignores all
519 deletions. `reject` inserts all deletions and ignores
520 insertions. Both `accept` and `reject` ignore comments. `all` puts
521 in insertions, deletions, and comments, wrapped in spans with
522 `insertion`, `deletion`, `comment-start`, and `comment-end`
523 classes, respectively. The author and time of change is
524 included. `all` is useful for scripting: only accepting changes
525 from a certain reviewer, say, or before a certain date. This
526 option only affects the docx reader.
528`--extract-media=`*DIR*
530: Extract images and other media contained in or linked from
531 the source document to the path *DIR*, creating it if
532 necessary, and adjust the images references in the document
533 so they point to the extracted files. If the source format is
534 a binary container (docx, epub, or odt), the media is
535 extracted from the container and the original
536 filenames are used. Otherwise the media is read from the
537 file system or downloaded, and new filenames are constructed
538 based on SHA1 hashes of the contents.
540`--abbreviations=`*FILE*
542: Specifies a custom abbreviations file, with abbreviations
543 one to a line. If this option is not specified, pandoc will
544 read the data file `abbreviations` from the user data
545 directory or fall back on a system default. To see the
547 `pandoc --print-default-data-file=abbreviations`. The only
548 use pandoc makes of this list is in the Markdown reader.
549 Strings ending in a period that are found in this list will
550 be followed by a nonbreaking space, so that the period will
551 not produce sentence-ending space in formats like LaTeX.
553[`pandocfilters`]: https://github.com/jgm/pandocfilters
554[PHP]: https://github.com/vinai/pandocfilters-php
555[perl]: https://metacpan.org/pod/Pandoc::Filter
556[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
558General writer options
559----------------------
563: Produce output with an appropriate header and footer (e.g. a
564 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
565 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
570: Use *FILE* as a custom template for the generated document. Implies
571 `--standalone`. See [Templates], below, for a description
572 of template syntax. If no extension is specified, an extension
573 corresponding to the writer will be added, so that `--template=special`
574 looks for `special.html` for HTML output. If the template is not
575 found, pandoc will search for it in the `templates` subdirectory of
576 the user data directory (see `--data-dir`). If this option is not used,
577 a default template appropriate for the output format will be used (see
578 `-D/--print-default-template`).
580`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
582: Set the template variable *KEY* to the value *VAL* when rendering the
583 document in standalone mode. This is generally only useful when the
584 `--template` option is used to specify a custom template, since
585 pandoc automatically sets the variables used in the default
586 templates. If no *VAL* is specified, the key will be given the
589`-D` *FORMAT*, `--print-default-template=`*FORMAT*
591: Print the system default template for an output *FORMAT*. (See `-t`
592 for a list of possible *FORMAT*s.) Templates in the user data
593 directory are ignored.
595`--print-default-data-file=`*FILE*
597: Print a system default data file. Files in the user data directory
600`--eol=crlf`|`lf`|`native`
602: Manually specify line endings: `crlf` (Windows), `lf`
603 (MacOS/linux/unix), or `native` (line endings appropriate
604 to the OS on which pandoc is being run). The default is
609: Specify the dpi (dots per inch) value for conversion from pixels
610 to inch/centimeters and vice versa. The default is 96dpi.
611 Technically, the correct term would be ppi (pixels per inch).
613`--wrap=auto`|`none`|`preserve`
615: Determine how text is wrapped in the output (the source
616 code, not the rendered version). With `auto` (the default),
617 pandoc will attempt to wrap lines to the column width specified by
618 `--columns` (default 72). With `none`, pandoc will not wrap
619 lines at all. With `preserve`, pandoc will attempt to
620 preserve the wrapping from the source document (that is,
621 where there are nonsemantic newlines in the source, there
622 will be nonsemantic newlines in the output as well).
623 Automatic wrapping does not currently work in HTML output.
627: Specify length of lines in characters. This affects text wrapping
628 in the generated source code (see `--wrap`). It also affects
629 calculation of column widths for plain text tables (see [Tables] below).
631`--toc`, `--table-of-contents`
633: Include an automatically generated table of contents (or, in
634 the case of `latex`, `context`, `docx`, `odt`,
635 `opendocument`, `rst`, or `ms`, an instruction to create
636 one) in the output document. This option has no effect on
637 `man`, `docbook4`, `docbook5`, or `jats` output.
639`--toc-depth=`*NUMBER*
641: Specify the number of section levels to include in the table
642 of contents. The default is 3 (which means that level 1, 2, and 3
643 headers will be listed in the contents).
647: Disables syntax highlighting for code blocks and inlines, even when
648 a language attribute is given.
650`--highlight-style=`*STYLE*|*FILE*
652: Specifies the coloring style to be used in highlighted source code.
653 Options are `pygments` (the default), `kate`, `monochrome`,
654 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
655 For more information on syntax highlighting in pandoc, see
656 [Syntax highlighting], below. See also
657 `--list-highlight-styles`.
659 Instead of a *STYLE* name, a JSON file with extension
660 `.theme` may be supplied. This will be parsed as a KDE
661 syntax highlighting theme and (if valid) used as the
662 highlighting style. To see a sample theme that can be
663 modified, `pandoc --print-default-data-file default.theme`.
665`--syntax-definition=`*FILE*
667: Instructs pandoc to load a KDE XML syntax definition file,
668 which will be used for syntax highlighting of appropriately
669 marked code blocks. This can be used to add support for
670 new languages or to use altered syntax definitions for
673`-H` *FILE*, `--include-in-header=`*FILE*
675: Include contents of *FILE*, verbatim, at the end of the header.
676 This can be used, for example, to include special
677 CSS or JavaScript in HTML documents. This option can be used
678 repeatedly to include multiple files in the header. They will be
679 included in the order specified. Implies `--standalone`.
681`-B` *FILE*, `--include-before-body=`*FILE*
683: Include contents of *FILE*, verbatim, at the beginning of the
684 document body (e.g. after the `<body>` tag in HTML, or the
685 `\begin{document}` command in LaTeX). This can be used to include
686 navigation bars or banners in HTML documents. This option can be
687 used repeatedly to include multiple files. They will be included in
688 the order specified. Implies `--standalone`.
690`-A` *FILE*, `--include-after-body=`*FILE*
692: Include contents of *FILE*, verbatim, at the end of the document
693 body (before the `</body>` tag in HTML, or the
694 `\end{document}` command in LaTeX). This option can be used
695 repeatedly to include multiple files. They will be included in the
696 order specified. Implies `--standalone`.
698`--resource-path=`*SEARCHPATH*
700: List of paths to search for images and other resources.
701 The paths should be separated by `:` on linux, unix, and
702 MacOS systems, and by `;` on Windows. If `--resource-path`
703 is not specified, the default resource path is the working
704 directory. Note that, if `--resource-path` is specified,
705 the working directory must be explicitly listed or it
706 will not be searched. For example:
707 `--resource-path=.:test` will search the working directory
708 and the `test` subdirectory, in that order.
710Options affecting specific writers
711----------------------------------
715: Produce a standalone HTML file with no external dependencies, using
716 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
717 images, and videos. The resulting file should be "self-contained,"
718 in the sense that it needs no external files and no net access to be
719 displayed properly by a browser. This option works only with HTML output
720 formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
721 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
722 stylesheets at absolute URLs will be downloaded; those at relative URLs
723 will be sought relative to the working directory (if the first source
724 file is local) or relative to the base URL (if the first source
725 file is remote). Elements with the attribute
726 `data-external="1"` will be left alone; the documents they
727 link to will not be incorporated in the document.
728 Limitation: resources that are loaded dynamically through
729 JavaScript cannot be incorporated; as a result,
730 `--self-contained` does not work with `--mathjax`, and some
731 advanced features (e.g. zoom or speaker notes) may not work
732 in an offline "self-contained" `reveal.js` slide show.
736: Use `<q>` tags for quotes in HTML.
740: Use only ASCII characters in output. Currently supported only for
741 HTML and DocBook output (which uses numerical entities instead of
742 UTF-8 when this option is selected).
746: Use reference-style links, rather than inline links, in writing Markdown
747 or reStructuredText. By default inline links are used. The
748 placement of link references is affected by the
749 `--reference-location` option.
751`--reference-location = block`|`section`|`document`
753: Specify whether footnotes (and references, if `reference-links` is
754 set) are placed at the end of the current (top-level) block, the
755 current section, or the document. The default is
756 `document`. Currently only affects the markdown writer.
760: Use ATX-style headers in Markdown and AsciiDoc output. The default is
761 to use setext-style headers for levels 1-2, and then ATX headers.
763`--top-level-division=[default|section|chapter|part]`
765: Treat top-level headers as the given division type in LaTeX, ConTeXt,
766 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
767 all headers are shifted such that the top-level header becomes the specified
768 type. The default behavior is to determine the best division type via
769 heuristics: unless other conditions apply, `section` is chosen. When the
770 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
771 `article` option is specified), `chapter` is implied as the setting for this
772 option. If `beamer` is the output format, specifying either `chapter` or
773 `part` will cause top-level headers to become `\part{..}`, while
774 second-level headers remain as their default type.
776`-N`, `--number-sections`
778: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
779 By default, sections are not numbered. Sections with class
780 `unnumbered` will never be numbered, even if `--number-sections`
783`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
785: Offset for section headings in HTML output (ignored in other
786 output formats). The first number is added to the section number for
787 top-level headers, the second for second-level headers, and so on.
788 So, for example, if you want the first top-level header in your
789 document to be numbered "6", specify `--number-offset=5`.
790 If your document starts with a level-2 header which you want to
791 be numbered "1.5", specify `--number-offset=1,4`.
792 Offsets are 0 by default. Implies `--number-sections`.
796: Use the [`listings`] package for LaTeX code blocks
800: Make list items in slide shows display incrementally (one by one).
801 The default is for lists to be displayed all at once.
803`--slide-level=`*NUMBER*
805: Specifies that headers with the specified level create
806 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
807 above this level in the hierarchy are used to divide the
808 slide show into sections; headers below this level create
809 subheads within a slide. Note that content that is
810 not contained under slide-level headers will not appear in
811 the slide show. The default is to set the slide level based
812 on the contents of the document; see [Structuring the slide
817: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
818 and attach identifiers to the enclosing `<div>` (or `<section>`)
819 rather than the header itself. See
820 [Header identifiers], below.
822`--email-obfuscation=none`|`javascript`|`references`
824: Specify a method for obfuscating `mailto:` links in HTML documents.
825 `none` leaves `mailto:` links as they are. `javascript` obfuscates
826 them using JavaScript. `references` obfuscates them by printing their
827 letters as decimal or hexadecimal character references. The default
830`--id-prefix=`*STRING*
832: Specify a prefix to be added to all identifiers and internal links
833 in HTML and DocBook output, and to footnote numbers in Markdown
834 and Haddock output. This is useful for preventing duplicate
835 identifiers when generating fragments to be included in other pages.
837`-T` *STRING*, `--title-prefix=`*STRING*
839: Specify *STRING* as a prefix at the beginning of the title
840 that appears in the HTML header (but not in the title as it
841 appears at the beginning of the HTML body). Implies
844`-c` *URL*, `--css=`*URL*
846: Link to a CSS style sheet. This option can be used repeatedly to
847 include multiple files. They will be included in the order specified.
849 A stylesheet is required for generating EPUB. If none is
850 provided using this option (or the `stylesheet` metadata
851 field), pandoc will look for a file `epub.css` in the
852 user data directory (see `--data-dir`). If it is not
853 found there, sensible defaults will be used.
855`--reference-doc=`*FILE*
857: Use the specified file as a style reference in producing a
862 : For best results, the reference docx should be a modified
863 version of a docx file produced using pandoc. The contents
864 of the reference docx are ignored, but its stylesheets and
865 document properties (including margins, page size, header,
866 and footer) are used in the new docx. If no reference docx
867 is specified on the command line, pandoc will look for a
868 file `reference.docx` in the user data directory (see
869 `--data-dir`). If this is not found either, sensible
870 defaults will be used.
872 To produce a custom `reference.docx`, first get a copy of
873 the default `reference.docx`: `pandoc
874 --print-default-data-file reference.docx >
875 custom-reference.docx`. Then open `custom-reference.docx`
876 in Word, modify the styles as you wish, and save the file.
877 For best results, do not make changes to this file other
878 than modifying the styles used by pandoc: [paragraph]
879 Normal, Body Text, First Paragraph, Compact, Title,
880 Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
881 Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
882 Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
883 Definition Term, Definition, Caption, Table Caption,
884 Image Caption, Figure, Captioned Figure, TOC Heading;
885 [character] Default Paragraph Font, Body Text Char,
886 Verbatim Char, Footnote Reference, Hyperlink; [table]
891 : For best results, the reference ODT should be a modified
892 version of an ODT produced using pandoc. The contents of
893 the reference ODT are ignored, but its stylesheets are used
894 in the new ODT. If no reference ODT is specified on the
895 command line, pandoc will look for a file `reference.odt` in
896 the user data directory (see `--data-dir`). If this is not
897 found either, sensible defaults will be used.
899 To produce a custom `reference.odt`, first get a copy of
900 the default `reference.odt`: `pandoc
901 --print-default-data-file reference.odt >
902 custom-reference.odt`. Then open `custom-reference.odt` in
903 LibreOffice, modify the styles as you wish, and save the
906`--epub-cover-image=`*FILE*
908: Use the specified image as the EPUB cover. It is recommended
909 that the image be less than 1000px in width and height. Note that
910 in a Markdown source document you can also specify `cover-image`
911 in a YAML metadata block (see [EPUB Metadata], below).
913`--epub-metadata=`*FILE*
915: Look in the specified XML file for metadata for the EPUB.
916 The file should contain a series of [Dublin Core elements].
919 <dc:rights>Creative Commons</dc:rights>
920 <dc:language>es-AR</dc:language>
922 By default, pandoc will include the following metadata elements:
923 `<dc:title>` (from the document title), `<dc:creator>` (from the
924 document authors), `<dc:date>` (from the document date, which should
925 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
926 variable, or, if is not set, the locale), and `<dc:identifier
927 id="BookId">` (a randomly generated UUID). Any of these may be
928 overridden by elements in the metadata file.
930 Note: if the source document is Markdown, a YAML metadata block
931 in the document can be used instead. See below under
934`--epub-embed-font=`*FILE*
936: Embed the specified font in the EPUB. This option can be repeated
937 to embed multiple fonts. Wildcards can also be used: for example,
938 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
939 line, be sure to escape them or put the whole filename in single quotes,
940 to prevent them from being interpreted by the shell. To use the
941 embedded fonts, you will need to add declarations like the following
942 to your CSS (see `--css`):
945 font-family: DejaVuSans;
948 src:url("DejaVuSans-Regular.ttf");
951 font-family: DejaVuSans;
954 src:url("DejaVuSans-Bold.ttf");
957 font-family: DejaVuSans;
960 src:url("DejaVuSans-Oblique.ttf");
963 font-family: DejaVuSans;
966 src:url("DejaVuSans-BoldOblique.ttf");
968 body { font-family: "DejaVuSans"; }
970`--epub-chapter-level=`*NUMBER*
972: Specify the header level at which to split the EPUB into separate
973 "chapter" files. The default is to split into chapters at level 1
974 headers. This option only affects the internal composition of the
975 EPUB, not the way chapters and sections are displayed to users. Some
976 readers may be slow if the chapter files are too large, so for large
977 documents with few level 1 headers, one might want to use a chapter
980`--epub-subdirectory=`*DIRNAME*
982: Specify the subdirectory in the OCF container that is to hold
983 the EPUB-specific contents. The default is `EPUB`. To put
984 the EPUB contents in the top level, use an empty string.
986`--latex-engine=pdflatex`|`lualatex`|`xelatex`
988: Use the specified LaTeX engine when producing PDF output.
989 The default is `pdflatex`. If the engine is not in your PATH,
990 the full path of the engine may be specified here.
992`--latex-engine-opt=`*STRING*
994: Use the given string as a command-line argument to the `latex-engine`.
995 If used multiple times, the arguments are provided with spaces between
996 them. Note that no check for duplicate options is done.
998[Dublin Core elements]: http://dublincore.org/documents/dces/
999[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1004`--bibliography=`*FILE*
1006: Set the `bibliography` field in the document's metadata to *FILE*,
1007 overriding any value set in the metadata, and process citations
1008 using `pandoc-citeproc`. (This is equivalent to
1009 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1010 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1011 used, making this equivalent to `--metadata bibliography=FILE`.
1012 If you supply this argument multiple times, each *FILE* will be added
1017: Set the `csl` field in the document's metadata to *FILE*,
1018 overriding any value set in the metadata. (This is equivalent to
1019 `--metadata csl=FILE`.)
1020 This option is only relevant with `pandoc-citeproc`.
1022`--citation-abbreviations=`*FILE*
1024: Set the `citation-abbreviations` field in the document's metadata to
1025 *FILE*, overriding any value set in the metadata. (This is equivalent to
1026 `--metadata citation-abbreviations=FILE`.)
1027 This option is only relevant with `pandoc-citeproc`.
1031: Use [`natbib`] for citations in LaTeX output. This option is not for use
1032 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1033 use in producing a LaTeX file that can be processed with [`bibtex`].
1037: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1038 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1039 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1041Math rendering in HTML
1042----------------------
1044`-m` [*URL*], `--latexmathml`[`=`*URL*]
1046: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1047 To insert a link to a local copy of the `LaTeXMathML.js` script,
1048 provide a *URL*. If no *URL* is provided, the contents of the
1049 script will be inserted directly into the HTML header, preserving
1050 portability at the price of efficiency. If you plan to use math on
1051 several pages, it is much better to link to a copy of the script,
1052 so it can be cached.
1056: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1057 `html4` and `html5`).
1061: Use [jsMath] to display embedded TeX math in HTML output.
1062 The *URL* should point to the jsMath load script (e.g.
1063 `jsMath/easy/load.js`); if provided, it will be linked to in
1064 the header of standalone HTML documents. If a *URL* is not provided,
1065 no link to the jsMath load script will be inserted; it is then
1066 up to the author to provide such a link in the HTML template.
1068`--mathjax`[`=`*URL*]
1070: Use [MathJax] to display embedded TeX math in HTML output.
1071 The *URL* should point to the `MathJax.js` load script.
1072 If a *URL* is not provided, a link to the MathJax CDN will
1077: Enclose TeX math in `<eq>` tags in HTML output. These can then
1078 be processed by [gladTeX] to produce links to images of the typeset
1081`--mimetex`[`=`*URL*]
1083: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1084 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1088: Render TeX formulas using an external script that converts TeX
1089 formulas to images. The formula will be concatenated with the URL
1090 provided. If *URL* is not specified, the CodeCogs will be used.
1091 Note: the `--webtex` option will affect Markdown output
1092 as well as HTML, which is useful if you're targeting a
1093 version of Markdown without native math support.
1097: Use [KaTeX] to display embedded TeX math in HTML output.
1098 The *URL* should point to the `katex.js` load script. If a *URL* is
1099 not provided, a link to the KaTeX CDN will be inserted.
1100 Note: [KaTeX] seems to work best with `html5` output.
1102`--katex-stylesheet=`*URL*
1104: The *URL* should point to the `katex.css` stylesheet. If this option is
1105 not specified, a link to the KaTeX CDN will be inserted. Note that this
1106 option does not imply `--katex`.
1108[MathML]: http://www.w3.org/Math/
1109[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1110[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1111[MathJax]: https://www.mathjax.org
1112[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1113[mimeTeX]: http://www.forkosh.com/mimetex.html
1114[KaTeX]: https://github.com/Khan/KaTeX
1116Options for wrapper scripts
1117---------------------------
1121: Print information about command-line arguments to *stdout*, then exit.
1122 This option is intended primarily for use in wrapper scripts.
1123 The first line of output contains the name of the output file specified
1124 with the `-o` option, or `-` (for *stdout*) if no output file was
1125 specified. The remaining lines contain the command-line arguments,
1126 one per line, in the order they appear. These do not include regular
1127 pandoc options and their arguments, but do include any options appearing
1128 after a `--` separator at the end of the line.
1132: Ignore command-line arguments (for use in wrapper scripts).
1133 Regular pandoc options are not ignored. Thus, for example,
1135 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1139 pandoc -o foo.html -s
1144When the `-s/--standalone` option is used, pandoc uses a template to
1145add header and footer material that is needed for a self-standing
1146document. To see the default template that is used, just type
1150where *FORMAT* is the name of the output format. A custom template
1151can be specified using the `--template` option. You can also override
1152the system default templates for a given output format *FORMAT*
1153by putting a file `templates/default.*FORMAT*` in the user data
1154directory (see `--data-dir`, above). *Exceptions:*
1156- For `odt` output, customize the `default.opendocument`
1158- For `pdf` output, customize the `default.latex` template
1159 (or the `default.beamer` template, if you use `-t beamer`,
1160 or the `default.context` template, if you use `-t context`).
1161- `docx` has no template (however, you can use
1162 `--reference-doc` to customize the output).
1164Templates contain *variables*, which allow for the inclusion of
1165arbitrary information at any point in the file. Variables may be set
1166within the document using [YAML metadata blocks][Extension:
1167`yaml_metadata_block`]. They may also be set at the
1168command line using the `-V/--variable` option: variables set in this
1169way override metadata fields with the same name.
1171Variables set by pandoc
1172-----------------------
1174Some variables are set automatically by pandoc. These vary somewhat
1175depending on the output format, but include metadata fields as well
1178`sourcefile`, `outputfile`
1179: source and destination filenames, as given on the command line.
1180 `sourcefile` can also be a list if input comes from multiple files, or empty
1181 if input is from stdin. You can use the following snippet in your template
1182 to distinguish them:
1192 Similarly, `outputfile` can be `-` if output goes to the terminal.
1194`title`, `author`, `date`
1195: allow identification of basic aspects of the document. Included
1196 in PDF metadata through LaTeX and ConTeXt. These can be set
1197 through a [pandoc title block][Extension: `pandoc_title_block`],
1198 which allows for multiple authors, or through a YAML metadata block:
1207: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1208 renders in LaTeX only when using a document class that supports
1209 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1210 `scrreprt`, `scrbook`).[^subtitle]
1213: author affiliations (in LaTeX and Beamer only). Can be a
1214 list, when there are multiple authors.
1217: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1220: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1221 may be repeated as for `author`, above
1224: contents specified by `-H/--include-in-header` (may have multiple
1228: non-null value if `--toc/--table-of-contents` was specified
1231: title of table of contents (works only with EPUB,
1232 opendocument, odt, docx)
1235: contents specified by `-B/--include-before-body` (may have
1239: contents specified by `-A/--include-after-body` (may have
1246: JSON representation of all of the document's metadata. Field
1247 values are transformed to the selected output format.
1249[^subtitle]: To make `subtitle` work with other LaTeX
1250 document classes, you can add the following to `header-includes`:
1252 \providecommand{\subtitle}[1]{%
1253 \usepackage{titling}
1255 \par\large#1\end{center}}
1262: identifies the main language of the document,
1263 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1264 For some output formats, pandoc will convert it to an appropriate
1265 format stored in the additional variables `babel-lang`,
1266 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1268 Native pandoc `span`s and `div`s with the lang attribute
1269 (value in BCP 47) can be used to switch the language in
1273: a list of other languages used in the document
1274 in the YAML metadata, according to [BCP 47]. For example:
1275 `otherlangs: [en-GB, fr]`.
1276 This is automatically generated from the `lang` attributes
1277 in all `span`s and `div`s but can be overridden.
1278 Currently only used by LaTeX through the generated
1279 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1280 The LaTeX writer outputs polyglossia commands in the text but
1281 the `babel-newcommands` variable contains mappings for them
1282 to the corresponding babel.
1285: the base direction of the document, either `rtl` (right-to-left)
1286 or `ltr` (left-to-right).
1288 For bidirectional documents, native pandoc `span`s and `div`s
1289 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1290 override the base direction in some output formats.
1291 This may not always be necessary if the final renderer
1292 (e.g. the browser, when generating HTML) supports the
1293 [Unicode Bidirectional Algorithm].
1295 When using LaTeX for bidirectional documents, only the `xelatex` engine
1296 is fully supported (use `--latex-engine=xelatex`).
1298[BCP 47]: https://tools.ietf.org/html/bcp47
1299[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1304Variables are available for [producing slide shows with pandoc],
1305including all [reveal.js configuration options].
1308: title graphic for Beamer documents
1311: logo for Beamer documents
1314: base URL for Slidy documents (defaults to
1315 `http://www.w3.org/Talks/Tools/Slidy2`)
1318: base URL for Slideous documents (defaults to `slideous`)
1321: base URL for S5 documents (defaults to `s5/default`)
1324: base URL for reveal.js documents (defaults to `reveal.js`)
1326`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1327: themes for LaTeX [`beamer`] documents
1330: options for LaTeX beamer themes (a list).
1333: controls navigation symbols in `beamer` documents
1334 (default is `empty` for no navigation symbols; other valid values
1335 are `frame`, `vertical`, and `horizontal`).
1338: enables on "title pages" for new sections in `beamer`
1339 documents (default = true).
1342: when true, the `beamerarticle` package is loaded (for
1343 producing an article from beamer slides).
1346: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1347 `urlcolor`, or `toccolor` are set (for beamer only).
1349`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1350: color for internal links, citation links, external links, and links in table
1351 of contents: uses any of the [predefined LaTeX colors] (for beamer only).
1354: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1355 `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1356 default, and `32` for 3:2).
1358[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1363LaTeX variables are used when [creating a PDF].
1366: paper size, e.g. `letter`, `a4`
1369: font size for body text (e.g. `10pt`, `12pt`)
1372: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1375: option for document class, e.g. `oneside`; may be repeated
1376 for multiple options
1379: option for [`geometry`] package, e.g. `margin=1in`;
1380 may be repeated for multiple options
1382`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1383: sets margins, if `geometry` is not used (otherwise `geometry`
1387: adjusts line spacing using the [`setspace`]
1388 package, e.g. `1.25`, `1.5`
1391: font package for use with `pdflatex`:
1392 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1393 The default is [Latin Modern][`lm`].
1396: options for package used as `fontfamily`: e.g. `osf,sc` with
1397 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1398 figures and true small caps; may be repeated for multiple options
1400`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1401: font families for use with `xelatex` or
1402 `lualatex`: take the name of any system font, using the
1403 [`fontspec`] package. Note that if `CJKmainfont` is used,
1404 the [`xecjk`] package must be available.
1406`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1407: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1408 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1409 available through [`fontspec`], such as the OpenType features
1410 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1413: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1414 default is `T1` (see guide to [LaTeX font encodings])
1417: options to pass to the microtype package
1420: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1421 `urlcolor`, or `toccolor` are set
1423`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1424: color for internal links, citation links, external links, and links in table of contents:
1425 uses any of the [predefined LaTeX colors]
1428: causes links to be printed as footnotes
1431: uses document class settings for indentation (the default LaTeX template
1432 otherwise removes indentation and adds space between paragraphs)
1435: disables default behavior of LaTeX template that redefines (sub)paragraphs
1436 as sections, changing the appearance of nested headings in some classes
1439: specifies contents of acknowledgments footnote after document title.
1442: include table of contents (can also be set using `--toc/--table-of-contents`)
1445: level of section to include in table of contents
1448: numbering depth for sections, if sections are numbered
1451: include list of figures, list of tables
1454: bibliography to use for resolving references
1457: bibliography style, when used with `--natbib` and `--biblatex`.
1460: bibliography title, when used with `--natbib` and `--biblatex`.
1463: list of options for biblatex.
1466: list of options for natbib.
1468[`article`]: https://ctan.org/pkg/article
1469[`report`]: https://ctan.org/pkg/report
1470[`book`]: https://ctan.org/pkg/book
1471[KOMA-Script]: https://ctan.org/pkg/koma-script
1472[`memoir`]: https://ctan.org/pkg/memoir
1473[predefined LaTeX colors]: https://en.wikibooks.org/wiki/LaTeX/Colors#Predefined_colors
1474[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1475[`mathpazo`]: https://ctan.org/pkg/mathpazo
1476[LaTeX font encodings]: https://ctan.org/pkg/encguide
1478Variables for ConTeXt
1479---------------------
1482: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1483 may be repeated for multiple options
1486: options for page margins and text arrangement (see [ConTeXt Layout]);
1487 may be repeated for multiple options
1489`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1490: sets margins, if `layout` is not used (otherwise `layout`
1494: font size for body text (e.g. `10pt`, `12pt`)
1496`mainfont`, `sansfont`, `monofont`, `mathfont`
1497: font families: take the name of any system font (see [ConTeXt Font Switching])
1499`linkcolor`, `contrastcolor`
1500: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1503: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1506: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1507 may be repeated for multiple options
1510: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1513: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1514 may be repeated for multiple options
1516`headertext`, `footertext`
1517: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1518 may be repeated up to four times for different placement
1521: page number style and location (using [`setuppagenumbering`]);
1522 may be repeated for multiple options
1525: include table of contents (can also be set using `--toc/--table-of-contents`)
1528: include list of figures, list of tables
1530[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1531[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1532[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1533[ConTeXt Color]: http://wiki.contextgarden.net/Color
1534[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1535[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1536[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1537[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1538[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1540Variables for man pages
1541-----------------------
1544: section number in man pages
1547: header in man pages
1550: footer in man pages
1553: adjusts text to left (`l`), right (`r`), center (`c`),
1554 or both (`b`) margins
1557: if `true` (the default), hyphenation will be used
1563: point size (e.g. `10p`)
1566: line height (e.g. `12p`)
1569: font family (e.g. `T` or `P`)
1572: paragraph indent (e.g. `2m`)
1574Using variables in templates
1575----------------------------
1577Variable names are sequences of alphanumerics, `-`, and `_`,
1578starting with a letter. A variable name surrounded by `$` signs
1579will be replaced by its value. For example, the string `$title$` in
1581 <title>$title$</title>
1583will be replaced by the document title.
1585To write a literal `$` in a template, use `$$`.
1587Templates may contain conditionals. The syntax is as follows:
1595This will include `X` in the template if `variable` has a non-null
1596value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1597any valid template text, and may include interpolated variables or other
1598conditionals. The `$else$` section may be omitted.
1600When variables can have multiple values (for example, `author` in
1601a multi-author document), you can use the `$for$` keyword:
1604 <meta name="author" content="$author$" />
1607You can optionally specify a separator to be used between
1610 $for(author)$$author$$sep$, $endfor$
1612A dot can be used to select a field of a variable that takes
1613an object as its value. So, for example:
1615 $author.name$ ($author.affiliation$)
1617If you use custom templates, you may need to revise them as pandoc
1618changes. We recommend tracking the changes in the default templates,
1619and modifying your custom templates accordingly. An easy way to do this
1620is to fork the [pandoc-templates] repository and merge in changes after each
1623[pandoc-templates]: https://github.com/jgm/pandoc-templates
1628Pandoc understands an extended and slightly revised version of
1629John Gruber's [Markdown] syntax. This document explains the syntax,
1630noting differences from standard Markdown. Except where noted, these
1631differences can be suppressed by using the `markdown_strict` format instead
1632of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1633to the format name and disabled by adding `-EXTENSION`. For example,
1634`markdown_strict+footnotes` is strict Markdown with footnotes
1635enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1636Markdown without footnotes or pipe tables.
1641Markdown is designed to be easy to write, and, even more importantly,
1644> A Markdown-formatted document should be publishable as-is, as plain
1645> text, without looking like it's been marked up with tags or formatting
1647> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1649This principle has guided pandoc's decisions in finding syntax for
1650tables, footnotes, and other extensions.
1652There is, however, one respect in which pandoc's aims are different
1653from the original aims of Markdown. Whereas Markdown was originally
1654designed with HTML generation in mind, pandoc is designed for multiple
1655output formats. Thus, while pandoc allows the embedding of raw HTML,
1656it discourages it, and provides other, non-HTMLish ways of representing
1657important document elements like definition lists, tables, mathematics, and
1663A paragraph is one or more lines of text followed by one or more blank lines.
1664Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1665If you need a hard line break, put two or more spaces at the end of a line.
1667#### Extension: `escaped_line_breaks` ####
1669A backslash followed by a newline is also a hard line break.
1670Note: in multiline and grid table cells, this is the only way
1671to create a hard line break, since trailing spaces in the cells
1677There are two kinds of headers: Setext and ATX.
1679### Setext-style headers ###
1681A setext-style header is a line of text "underlined" with a row of `=` signs
1682(for a level one header) or `-` signs (for a level two header):
1690The header text can contain inline formatting, such as emphasis (see
1691[Inline formatting], below).
1694### ATX-style headers ###
1696An ATX-style header consists of one to six `#` signs and a line of
1697text, optionally followed by any number of `#` signs. The number of
1698`#` signs at the beginning of the line is the header level:
1700 ## A level-two header
1702 ### A level-three header ###
1704As with setext-style headers, the header text can contain formatting:
1706 # A level-one header with a [link](/url) and *emphasis*
1708#### Extension: `blank_before_header` ####
1710Standard Markdown syntax does not require a blank line before a header.
1711Pandoc does require this (except, of course, at the beginning of the
1712document). The reason for the requirement is that it is all too easy for a
1713`#` to end up at the beginning of a line by accident (perhaps through line
1714wrapping). Consider, for example:
1716 I like several of their flavors of ice cream:
1717 #22, for example, and #5.
1719#### Extension: `space_in_atx_header` ####
1721Many Markdown implementations do not require a space between the
1722opening `#`s of an ATX header and the header text, so that
1723`#5 bolt` and `#hashtag` count as headers. With this extension,
1724pandoc does require the space.
1726### Header identifiers ###
1728#### Extension: `header_attributes` ####
1730Headers can be assigned attributes using this syntax at the end
1731of the line containing the header text:
1733 {#identifier .class .class key=value key=value}
1735Thus, for example, the following headers will all be assigned the identifier
1740 ## My header ## {#foo}
1742 My other header {#foo}
1745(This syntax is compatible with [PHP Markdown Extra].)
1747Note that although this syntax allows assignment of classes and key/value
1748attributes, writers generally don't use all of this information. Identifiers,
1749classes, and key/value attributes are used in HTML and HTML-based formats such
1750as EPUB and slidy. Identifiers are used for labels and link anchors in the
1751LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1753Headers with the class `unnumbered` will not be numbered, even if
1754`--number-sections` is specified. A single hyphen (`-`) in an attribute
1755context is equivalent to `.unnumbered`, and preferable in non-English
1762 # My header {.unnumbered}
1764#### Extension: `auto_identifiers` ####
1766A header without an explicitly specified identifier will be
1767automatically assigned a unique identifier based on the header text.
1768To derive the identifier from the header text,
1770 - Remove all formatting, links, etc.
1771 - Remove all footnotes.
1772 - Remove all punctuation, except underscores, hyphens, and periods.
1773 - Replace all spaces and newlines with hyphens.
1774 - Convert all alphabetic characters to lowercase.
1775 - Remove everything up to the first letter (identifiers may
1776 not begin with a number or punctuation mark).
1777 - If nothing is left after this, use the identifier `section`.
1782 ------------------------------- ----------------------------
1783 `Header identifiers in HTML` `header-identifiers-in-html`
1784 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1785 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1786 `3. Applications` `applications`
1789These rules should, in most cases, allow one to determine the identifier
1790from the header text. The exception is when several headers have the
1791same text; in this case, the first will get an identifier as described
1792above; the second will get the same identifier with `-1` appended; the
1793third with `-2`; and so on.
1795These identifiers are used to provide link targets in the table of
1796contents generated by the `--toc|--table-of-contents` option. They
1797also make it easy to provide links from one section of a document to
1798another. A link to this section, for example, might look like this:
1801 [header identifiers](#header-identifiers-in-html-latex-and-context).
1803Note, however, that this method of providing links to sections works
1804only in HTML, LaTeX, and ConTeXt formats.
1806If the `--section-divs` option is specified, then each section will
1807be wrapped in a `div` (or a `section`, if `html5` was specified),
1808and the identifier will be attached to the enclosing `<div>`
1809(or `<section>`) tag rather than the header itself. This allows entire
1810sections to be manipulated using JavaScript or treated differently in
1813#### Extension: `implicit_header_references` ####
1815Pandoc behaves as if reference links have been defined for each header.
1816So, to link to a header
1818 # Header identifiers in HTML
1822 [Header identifiers in HTML]
1826 [Header identifiers in HTML][]
1830 [the section on header identifiers][header identifiers in
1833instead of giving the identifier explicitly:
1835 [Header identifiers in HTML](#header-identifiers-in-html)
1837If there are multiple headers with identical text, the corresponding
1838reference will link to the first one only, and you will need to use explicit
1839links to link to the others, as described above.
1841Like regular reference links, these references are case-insensitive.
1843Explicit link reference definitions always take priority over
1844implicit header references. So, in the following example, the
1845link will point to `bar`, not to `#foo`:
1856Markdown uses email conventions for quoting blocks of text.
1857A block quotation is one or more paragraphs or other block elements
1858(such as lists or headers), with each line preceded by a `>` character
1859and an optional space. (The `>` need not start at the left margin, but
1860it should not be indented more than three spaces.)
1862 > This is a block quote. This
1863 > paragraph has two lines.
1865 > 1. This is a list inside a block quote.
1868A "lazy" form, which requires the `>` character only on the first
1869line of each block, is also allowed:
1871 > This is a block quote. This
1872 paragraph has two lines.
1874 > 1. This is a list inside a block quote.
1877Among the block elements that can be contained in a block quote are
1878other block quotes. That is, block quotes can be nested:
1880 > This is a block quote.
1882 > > A block quote within a block quote.
1884If the `>` character is followed by an optional space, that space
1885will be considered part of the block quote marker and not part of
1886the indentation of the contents. Thus, to put an indented code
1887block in a block quote, you need five spaces after the `>`:
1891#### Extension: `blank_before_blockquote` ####
1893Standard Markdown syntax does not require a blank line before a block
1894quote. Pandoc does require this (except, of course, at the beginning of the
1895document). The reason for the requirement is that it is all too easy for a
1896`>` to end up at the beginning of a line by accident (perhaps through line
1897wrapping). So, unless the `markdown_strict` format is used, the following does
1898not produce a nested block quote in pandoc:
1900 > This is a block quote.
1904Verbatim (code) blocks
1905----------------------
1907### Indented code blocks ###
1909A block of text indented four spaces (or one tab) is treated as verbatim
1910text: that is, special characters do not trigger special formatting,
1911and all spaces and line breaks are preserved. For example,
1914 moveShip(5 * gravity, DOWN);
1917The initial (four space or one tab) indentation is not considered part
1918of the verbatim text, and is removed in the output.
1920Note: blank lines in the verbatim text need not begin with four spaces.
1923### Fenced code blocks ###
1925#### Extension: `fenced_code_blocks` ####
1927In addition to standard indented code blocks, pandoc supports
1928*fenced* code blocks. These begin with a row of three or more
1929tildes (`~`) and end with a row of tildes that must be at least as long as
1930the starting row. Everything between these lines is treated as code. No
1931indentation is necessary:
1935 moveShip(5 * gravity, DOWN);
1939Like regular code blocks, fenced code blocks must be separated
1940from surrounding text by blank lines.
1942If the code itself contains a row of tildes or backticks, just use a longer
1943row of tildes or backticks at the start and end:
1947 code including tildes
1951#### Extension: `backtick_code_blocks` ####
1953Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1956#### Extension: `fenced_code_attributes` ####
1958Optionally, you may attach attributes to fenced or backtick code block using
1961 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1963 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1964 qsort (filter (>= x) xs)
1965 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1967Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1968`startFrom` is an attribute with value `100`. Some output formats can use this
1969information to do syntax highlighting. Currently, the only output formats
1970that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
1971is supported for your output format and language, then the code block above
1972will appear highlighted, with numbered lines. (To see which languages are
1973supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
1974block above will appear as follows:
1976 <pre id="mycode" class="haskell numberLines" startFrom="100">
1982A shortcut form can also be used for specifying the language of
1989This is equivalent to:
1995If the `fenced_code_attributes` extension is disabled, but
1996input contains class attribute(s) for the code block, the first
1997class attribute will be printed after the opening fence as a bare
2000To prevent all highlighting, use the `--no-highlight` flag.
2001To set the highlighting style, use `--highlight-style`.
2002For more information on highlighting, see [Syntax highlighting],
2008#### Extension: `line_blocks` ####
2010A line block is a sequence of lines beginning with a vertical bar (`|`)
2011followed by a space. The division into lines will be preserved in
2012the output, as will any leading spaces; otherwise, the lines will
2013be formatted as Markdown. This is useful for verse and addresses:
2015 | The limerick packs laughs anatomical
2016 | In space that is quite economical.
2017 | But the good ones I've seen
2018 | So seldom are clean
2019 | And the clean ones so seldom are comical
2022 | Berkeley, CA 94718
2024The lines can be hard-wrapped if needed, but the continuation
2025line must begin with a space.
2027 | The Right Honorable Most Venerable and Righteous Samuel L.
2030 | Berkeley, CA 94718
2032This syntax is borrowed from [reStructuredText].
2039A bullet list is a list of bulleted list items. A bulleted list
2040item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2047This will produce a "compact" list. If you want a "loose" list, in which
2048each item is formatted as a paragraph, put spaces between the items:
2056The bullets need not be flush with the left margin; they may be
2057indented one, two, or three spaces. The bullet must be followed
2060List items look best if subsequent lines are flush with the first
2061line (after the bullet):
2067But Markdown also allows a "lazy" format:
2073### The four-space rule ###
2075A list item may contain multiple paragraphs and other block-level
2076content. However, subsequent paragraphs must be preceded by a blank line
2077and indented four spaces or a tab. The list will look better if the first
2078paragraph is aligned with the rest:
2084 * Second paragraph. With a code block, which must be indented
2089List items may include other lists. In this case the preceding blank
2090line is optional. The nested list must be indented four spaces or
2103As noted above, Markdown allows you to write list items "lazily," instead of
2104indenting continuation lines. However, if there are multiple paragraphs or
2105other blocks in a list item, the first line of each must be indented.
2107 + A lazy, lazy, list
2110 + Another one; this looks
2113 Second paragraph of second
2116**Note:** Although the four-space rule for continuation paragraphs
2117comes from the official [Markdown syntax guide], the reference implementation,
2118`Markdown.pl`, does not follow it. So pandoc will give different results than
2119`Markdown.pl` when authors have indented continuation paragraphs fewer than
2122The [Markdown syntax guide] is not explicit whether the four-space
2123rule applies to *all* block-level content in a list item; it only
2124mentions paragraphs and code blocks. But it implies that the rule
2125applies to all block-level content (including nested lists), and
2126pandoc interprets it that way.
2128 [Markdown syntax guide]:
2129 http://daringfireball.net/projects/markdown/syntax#list
2131### Ordered lists ###
2133Ordered lists work just like bulleted lists, except that the items
2134begin with enumerators rather than bullets.
2136In standard Markdown, enumerators are decimal numbers followed
2137by a period and a space. The numbers themselves are ignored, so
2138there is no difference between this list:
2150#### Extension: `fancy_lists` ####
2152Unlike standard Markdown, pandoc allows ordered list items to be marked
2153with uppercase and lowercase letters and roman numerals, in addition to
2154Arabic numerals. List markers may be enclosed in parentheses or followed by a
2155single right-parentheses or period. They must be separated from the
2156text that follows by at least one space, and, if the list marker is a
2157capital letter with a period, by at least two spaces.[^2]
2159[^2]: The point of this rule is to ensure that normal paragraphs
2160 starting with people's initials, like
2162 B. Russell was an English philosopher.
2164 do not get treated as list items.
2166 This rule will not prevent
2170 from being interpreted as a list item. In this case, a backslash
2175The `fancy_lists` extension also allows '`#`' to be used as an
2176ordered list marker in place of a numeral:
2181#### Extension: `startnum` ####
2183Pandoc also pays attention to the type of list marker used, and to the
2184starting number, and both of these are preserved where possible in the
2185output format. Thus, the following yields a list with numbers followed
2186by a single parenthesis, starting with 9, and a sublist with lowercase
2196Pandoc will start a new list each time a different type of list
2197marker is used. So, the following will create three lists:
2204If default list markers are desired, use `#.`:
2211### Definition lists ###
2213#### Extension: `definition_lists` ####
2215Pandoc supports definition lists, using the syntax of
2216[PHP Markdown Extra] with some extensions.[^3]
2222 Term 2 with *inline markup*
2226 { some code, part of Definition 2 }
2228 Third paragraph of definition 2.
2230Each term must fit on one line, which may optionally be followed by
2231a blank line, and must be followed by one or more definitions.
2232A definition begins with a colon or tilde, which may be indented one
2235A term may have multiple definitions, and each definition may consist of one or
2236more block elements (paragraph, code block, list, etc.), each indented four
2237spaces or one tab stop. The body of the definition (including the first line,
2238aside from the colon or tilde) should be indented four spaces. However,
2239as with other Markdown lists, you can "lazily" omit indentation except
2240at the beginning of a paragraph or other block element:
2245 with lazy continuation.
2247 Second paragraph of the definition.
2249If you leave space before the definition (as in the example above),
2250the text of the definition will be treated as a paragraph. In some
2251output formats, this will mean greater spacing between term/definition
2252pairs. For a more compact definition list, omit the space before the
2262Note that space between items in a definition list is required.
2263(A variant that loosens this requirement, but disallows "lazy"
2264hard wrapping, can be activated with `compact_definition_lists`: see
2265[Non-pandoc extensions], below.)
2267[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2269### Numbered example lists ###
2271#### Extension: `example_lists` ####
2273The special list marker `@` can be used for sequentially numbered
2274examples. The first list item with a `@` marker will be numbered '1',
2275the next '2', and so on, throughout the document. The numbered examples
2276need not occur in a single list; each new list using `@` will take up
2277where the last stopped. So, for example:
2279 (@) My first example will be numbered (1).
2280 (@) My second example will be numbered (2).
2282 Explanation of examples.
2284 (@) My third example will be numbered (3).
2286Numbered examples can be labeled and referred to elsewhere in the
2289 (@good) This is a good example.
2291 As (@good) illustrates, ...
2293The label can be any string of alphanumeric characters, underscores,
2297### Compact and loose lists ###
2299Pandoc behaves differently from `Markdown.pl` on some "edge
2300cases" involving lists. Consider this source:
2310Pandoc transforms this into a "compact list" (with no `<p>` tags around
2311"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2312"Second" and "Third" (but not "First"), because of the blank space
2313around "Third". Pandoc follows a simple rule: if the text is followed by
2314a blank line, it is treated as a paragraph. Since "Second" is followed
2315by a list, and not a blank line, it isn't treated as a paragraph. The
2316fact that the list is followed by a blank line is irrelevant. (Note:
2317Pandoc works this way even when the `markdown_strict` format is specified. This
2318behavior is consistent with the official Markdown syntax description,
2319even though it is different from that of `Markdown.pl`.)
2322### Ending a list ###
2324What if you want to put an indented code block after a list?
2331Trouble! Here pandoc (like other Markdown implementations) will treat
2332`{ my code block }` as the second paragraph of item two, and not as
2335To "cut off" the list after item two, you can insert some non-indented
2336content, like an HTML comment, which won't produce visible output in
2342 <!-- end of list -->
2346You can use the same trick if you want two consecutive lists instead
2362A line containing a row of three or more `*`, `-`, or `_` characters
2363(optionally separated by spaces) produces a horizontal rule:
2373Four kinds of tables may be used. The first three kinds presuppose the use of
2374a fixed-width font, such as Courier. The fourth kind can be used with
2375proportionally spaced fonts, as it does not require lining up columns.
2377#### Extension: `table_captions` ####
2379A caption may optionally be provided with all 4 kinds of tables (as
2380illustrated in the examples below). A caption is a paragraph beginning
2381with the string `Table:` (or just `:`), which will be stripped off.
2382It may appear either before or after the table.
2384#### Extension: `simple_tables` ####
2386Simple tables look like this:
2388 Right Left Center Default
2389 ------- ------ ---------- -------
2394 Table: Demonstration of simple table syntax.
2396The headers and table rows must each fit on one line. Column
2397alignments are determined by the position of the header text relative
2398to the dashed line below it:[^4]
2400 - If the dashed line is flush with the header text on the right side
2401 but extends beyond it on the left, the column is right-aligned.
2402 - If the dashed line is flush with the header text on the left side
2403 but extends beyond it on the right, the column is left-aligned.
2404 - If the dashed line extends beyond the header text on both sides,
2405 the column is centered.
2406 - If the dashed line is flush with the header text on both sides,
2407 the default alignment is used (in most cases, this will be left).
2409[^4]: This scheme is due to Michel Fortin, who proposed it on the
2410 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2412The table must end with a blank line, or a line of dashes followed by
2415The column headers may be omitted, provided a dashed line is used
2416to end the table. For example:
2418 ------- ------ ---------- -------
2422 ------- ------ ---------- -------
2424When headers are omitted, column alignments are determined on the basis
2425of the first line of the table body. So, in the tables above, the columns
2426would be right, left, center, and right aligned, respectively.
2428#### Extension: `multiline_tables` ####
2430Multiline tables allow headers and table rows to span multiple lines
2431of text (but cells that span multiple columns or rows of the table are
2432not supported). Here is an example:
2434 -------------------------------------------------------------
2435 Centered Default Right Left
2436 Header Aligned Aligned Aligned
2437 ----------- ------- --------------- -------------------------
2438 First row 12.0 Example of a row that
2439 spans multiple lines.
2441 Second row 5.0 Here's another one. Note
2442 the blank line between
2444 -------------------------------------------------------------
2446 Table: Here's the caption. It, too, may span
2449These work like simple tables, but with the following differences:
2451 - They must begin with a row of dashes, before the header text
2452 (unless the headers are omitted).
2453 - They must end with a row of dashes, then a blank line.
2454 - The rows must be separated by blank lines.
2456In multiline tables, the table parser pays attention to the widths of
2457the columns, and the writers try to reproduce these relative widths in
2458the output. So, if you find that one of the columns is too narrow in the
2459output, try widening it in the Markdown source.
2461Headers may be omitted in multiline tables as well as simple tables:
2463 ----------- ------- --------------- -------------------------
2464 First row 12.0 Example of a row that
2465 spans multiple lines.
2467 Second row 5.0 Here's another one. Note
2468 the blank line between
2470 ----------- ------- --------------- -------------------------
2472 : Here's a multiline table without headers.
2474It is possible for a multiline table to have just one row, but the row
2475should be followed by a blank line (and then the row of dashes that ends
2476the table), or the table may be interpreted as a simple table.
2478#### Extension: `grid_tables` ####
2480Grid tables look like this:
2482 : Sample grid table.
2484 +---------------+---------------+--------------------+
2485 | Fruit | Price | Advantages |
2486 +===============+===============+====================+
2487 | Bananas | $1.34 | - built-in wrapper |
2488 | | | - bright color |
2489 +---------------+---------------+--------------------+
2490 | Oranges | $2.10 | - cures scurvy |
2492 +---------------+---------------+--------------------+
2494The row of `=`s separates the header from the table body, and can be
2495omitted for a headerless table. The cells of grid tables may contain
2496arbitrary block elements (multiple paragraphs, code blocks, lists,
2497etc.). Cells that span multiple columns or rows are not
2498supported. Grid tables can be created easily using [Emacs table mode].
2500[Emacs table mode]: http://table.sourceforge.net/
2502Alignments can be specified as with pipe tables, by putting
2503colons at the boundaries of the separator line after the
2506 +---------------+---------------+--------------------+
2507 | Right | Left | Centered |
2508 +==============:+:==============+:==================:+
2509 | Bananas | $1.34 | built-in wrapper |
2510 +---------------+---------------+--------------------+
2512For headerless tables, the colons go on the top line instead:
2514 +--------------:+:--------------+:------------------:+
2515 | Right | Left | Centered |
2516 +---------------+---------------+--------------------+
2519#### Extension: `pipe_tables` ####
2521Pipe tables look like this:
2523 | Right | Left | Default | Center |
2524 |------:|:-----|---------|:------:|
2525 | 12 | 12 | 12 | 12 |
2526 | 123 | 123 | 123 | 123 |
2529 : Demonstration of pipe table syntax.
2531The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2532ending pipe characters are optional, but pipes are required between all
2533columns. The colons indicate column alignment as shown. The header
2534cannot be omitted. To simulate a headerless table, include a header
2537Since the pipes indicate column boundaries, columns need not be vertically
2538aligned, as they are in the above example. So, this is a perfectly
2539legal (though ugly) pipe table:
2547The cells of pipe tables cannot contain block elements like paragraphs
2548and lists, and cannot span multiple lines. If a pipe table contains a
2549row whose printable content is wider than the column width (see
2550`--columns`), then the cell contents will wrap, with the
2551relative cell widths determined by the widths of the separator
2554Note: pandoc also recognizes pipe tables of the following
2555form, as can be produced by Emacs' orgtbl-mode:
2562The difference is that `+` is used instead of `|`. Other orgtbl features
2563are not supported. In particular, to get non-default column alignment,
2564you'll need to add colons as above.
2566[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2571#### Extension: `pandoc_title_block` ####
2573If the file begins with a title block
2576 % author(s) (separated by semicolons)
2579it will be parsed as bibliographic information, not regular text. (It
2580will be used, for example, in the title of standalone LaTeX or HTML
2581output.) The block may contain just a title, a title and an author,
2582or all three elements. If you want to include an author but no
2583title, or a title and a date but no author, you need a blank line:
2592The title may occupy multiple lines, but continuation lines must
2593begin with leading space, thus:
2598If a document has multiple authors, the authors may be put on
2599separate lines with leading space, or separated by semicolons, or
2600both. So, all of the following are equivalent:
2605 % Author One; Author Two
2610The date must fit on one line.
2612All three metadata fields may contain standard inline formatting
2613(italics, links, footnotes, etc.).
2615Title blocks will always be parsed, but they will affect the output only
2616when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2617will appear twice: once in the document head -- this is the title that
2618will appear at the top of the window in a browser -- and once at the
2619beginning of the document body. The title in the document head can have
2620an optional prefix attached (`--title-prefix` or `-T` option). The title
2621in the body appears as an H1 element with class "title", so it can be
2622suppressed or reformatted with CSS. If a title prefix is specified with
2623`-T` and no title block appears in the document, the title prefix will
2624be used by itself as the HTML title.
2626The man page writer extracts a title, man page section number, and
2627other header and footer information from the title line. The title
2628is assumed to be the first word on the title line, which may optionally
2629end with a (single-digit) section number in parentheses. (There should
2630be no space between the title and the parentheses.) Anything after
2631this is assumed to be additional footer and header text. A single pipe
2632character (`|`) should be used to separate the footer text from the header
2637will yield a man page with the title `PANDOC` and section 1.
2639 % PANDOC(1) Pandoc User Manuals
2641will also have "Pandoc User Manuals" in the footer.
2643 % PANDOC(1) Pandoc User Manuals | Version 4.0
2645will also have "Version 4.0" in the header.
2647#### Extension: `yaml_metadata_block` ####
2649A YAML metadata block is a valid YAML object, delimited by a line of three
2650hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2651(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2652document, but if it is not at the beginning, it must be preceded by a blank
2653line. (Note that, because of the way pandoc concatenates input files when
2654several are provided, you may also keep the metadata in a separate YAML file
2655and pass it to pandoc as an argument, along with your Markdown files:
2657 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2659Just be sure that the YAML file begins with `---` and ends with `---` or
2662Metadata will be taken from the fields of the YAML object and added to any
2663existing document metadata. Metadata can contain lists and objects (nested
2664arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2665with names ending in an underscore will be ignored by pandoc. (They may be
2666given a role by external processors.)
2668A document may contain multiple metadata blocks. The metadata fields will
2669be combined through a *left-biased union*: if two metadata blocks attempt
2670to set the same field, the value from the first block will be taken.
2672When pandoc is used with `-t markdown` to create a Markdown document,
2673a YAML metadata block will be produced only if the `-s/--standalone`
2674option is used. All of the metadata will appear in a single block
2675at the beginning of the document.
2677Note that YAML escaping rules must be followed. Thus, for example,
2678if a title contains a colon, it must be quoted. The pipe character
2679(`|`) can be used to begin an indented block that will be interpreted
2680literally, without need for escaping. This form is necessary
2681when the field contains blank lines or block-level formatting:
2684 title: 'This is the title: it contains a colon'
2688 tags: [nothing, nothingness]
2690 This is the abstract.
2692 It consists of two paragraphs.
2695Template variables will be set automatically from the metadata. Thus, for
2696example, in writing HTML, the variable `abstract` will be set to the HTML
2697equivalent of the Markdown in the `abstract` field:
2699 <p>This is the abstract.</p>
2700 <p>It consists of two paragraphs.</p>
2702Variables can contain arbitrary YAML structures, but the template must match
2703this structure. The `author` variable in the default templates expects a
2704simple list or string, but can be changed to support more complicated
2705structures. The following combination, for example, would add an affiliation
2706to the author if one is given:
2709 title: The document title
2712 affiliation: University of Somewhere
2714 affiliation: University of Nowhere
2717To use the structured authors in the example above, you would need a custom
2722 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2732#### Extension: `all_symbols_escapable` ####
2734Except inside a code block or inline code, any punctuation or space
2735character preceded by a backslash will be treated literally, even if it
2736would normally indicate formatting. Thus, for example, if one writes
2746 <strong>hello</strong>
2748This rule is easier to remember than standard Markdown's rule,
2749which allows only the following characters to be backslash-escaped:
2753(However, if the `markdown_strict` format is used, the standard Markdown rule
2756A backslash-escaped space is parsed as a nonbreaking space. It will
2757appear in TeX output as `~` and in HTML and XML as `\ ` or
2760A backslash-escaped newline (i.e. a backslash occurring at the end of
2761a line) is parsed as a hard line break. It will appear in TeX output as
2762`\\` and in HTML as `<br />`. This is a nice alternative to
2763Markdown's "invisible" way of indicating hard line breaks using
2764two trailing spaces on a line.
2766Backslash escapes do not work in verbatim contexts.
2773To *emphasize* some text, surround it with `*`s or `_`, like this:
2775 This text is _emphasized with underscores_, and this
2776 is *emphasized with asterisks*.
2778Double `*` or `_` produces **strong emphasis**:
2780 This is **strong emphasis** and __with underscores__.
2782A `*` or `_` character surrounded by spaces, or backslash-escaped,
2783will not trigger emphasis:
2785 This is * not emphasized *, and \*neither is this\*.
2787#### Extension: `intraword_underscores` ####
2789Because `_` is sometimes used inside words and identifiers,
2790pandoc does not interpret a `_` surrounded by alphanumeric
2791characters as an emphasis marker. If you want to emphasize
2792just part of a word, use `*`:
2794 feas*ible*, not feas*able*.
2799#### Extension: `strikeout` ####
2801To strikeout a section of text with a horizontal line, begin and end it
2802with `~~`. Thus, for example,
2804 This ~~is deleted text.~~
2807### Superscripts and subscripts ###
2809#### Extension: `superscript`, `subscript` ####
2811Superscripts may be written by surrounding the superscripted text by `^`
2812characters; subscripts may be written by surrounding the subscripted
2813text by `~` characters. Thus, for example,
2815 H~2~O is a liquid. 2^10^ is 1024.
2817If the superscripted or subscripted text contains spaces, these spaces
2818must be escaped with backslashes. (This is to prevent accidental
2819superscripting and subscripting through the ordinary use of `~` and `^`.)
2820Thus, if you want the letter P with 'a cat' in subscripts, use
2821`P~a\ cat~`, not `P~a cat~`.
2826To make a short span of text verbatim, put it inside backticks:
2828 What is the difference between `>>=` and `>>`?
2830If the verbatim text includes a backtick, use double backticks:
2832 Here is a literal backtick `` ` ``.
2834(The spaces after the opening backticks and before the closing
2835backticks will be ignored.)
2837The general rule is that a verbatim span starts with a string
2838of consecutive backticks (optionally followed by a space)
2839and ends with a string of the same number of backticks (optionally
2840preceded by a space).
2842Note that backslash-escapes (and other Markdown constructs) do not
2843work in verbatim contexts:
2845 This is a backslash followed by an asterisk: `\*`.
2847#### Extension: `inline_code_attributes` ####
2849Attributes can be attached to verbatim text, just as with
2850[fenced code blocks]:
2856To write small caps, you can use an HTML span tag:
2858 <span style="font-variant:small-caps;">Small caps</span>
2860(The semicolon is optional and there may be space after the
2861colon.) This will work in all output formats that support small caps.
2863Alternatively, you can also use the new `bracketed_spans` syntax:
2865 [Small caps]{style="font-variant:small-caps;"}
2870#### Extension: `tex_math_dollars` ####
2872Anything between two `$` characters will be treated as TeX math. The
2873opening `$` must have a non-space character immediately to its right,
2874while the closing `$` must have a non-space character immediately to its
2875left, and must not be followed immediately by a digit. Thus,
2876`$20,000 and $30,000` won't parse as math. If for some reason
2877you need to enclose text in literal `$` characters, backslash-escape
2878them and they won't be treated as math delimiters.
2880TeX math will be printed in all output formats. How it is rendered
2881depends on the output format:
2883Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2884 ~ It will appear verbatim between `$` characters.
2887 ~ It will be rendered using an [interpreted text role `:math:`].
2890 ~ It will be rendered as `latexmath:[...]`.
2893 ~ It will be rendered inside a `@math` command.
2896 ~ It will be rendered verbatim without `$`'s.
2899 ~ It will be rendered inside `<math>` tags.
2902 ~ It will be rendered inside `<span class="math">` tags.
2904RTF, OpenDocument, ODT
2905 ~ It will be rendered, if possible, using Unicode characters,
2906 and will otherwise appear verbatim.
2909 ~ If the `--mathml` flag is used, it will be rendered using MathML
2910 in an `inlineequation` or `informalequation` tag. Otherwise it
2911 will be rendered, if possible, using Unicode characters.
2914 ~ It will be rendered using OMML math markup.
2917 ~ If the `--webtex` option is used, formulas are rendered as images
2918 using CodeCogs or other compatible web service, downloaded
2919 and embedded in the e-book. Otherwise, they will appear verbatim.
2921HTML, Slidy, DZSlides, S5, EPUB
2922 ~ The way math is rendered in HTML will depend on the
2923 command-line options selected:
2925 1. The default is to render TeX math as far as possible using Unicode
2926 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2927 are put inside a `span` with `class="math"`, so that they may be
2928 styled differently from the surrounding text if needed.
2930 2. If the `--latexmathml` option is used, TeX math will be displayed
2931 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2932 The [LaTeXMathML] script will be used to render it as formulas.
2933 (This trick does not work in all browsers, but it works in Firefox.
2934 In browsers that do not support LaTeXMathML, TeX math will appear
2935 verbatim between `$` characters.)
2937 3. If the `--jsmath` option is used, TeX math will be put inside
2938 `<span>` tags (for inline math) or `<div>` tags (for display math)
2939 with class `math`. The [jsMath] script will be used to render
2942 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2943 be called to generate images for each TeX formula. This should
2944 work in all browsers. The `--mimetex` option takes an optional URL
2945 as argument. If no URL is specified, it will be assumed that the
2946 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2948 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2949 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2950 be processed by [gladTeX], which will produce image files for each
2951 formula and an HTML file with links to these images. So, the
2954 pandoc -s --gladtex myfile.txt -o myfile.htex
2955 gladtex -d myfile-images myfile.htex
2956 # produces myfile.html and images in myfile-images
2958 6. If the `--webtex` option is used, TeX formulas will be converted
2959 to `<img>` tags that link to an external script that converts
2960 formulas to images. The formula will be URL-encoded and concatenated
2961 with the URL provided. For SVG images you can for example use
2962 `--webtex https://latex.codecogs.com/svg.latex?`.
2963 If no URL is specified, the CodeCogs URL generating PNGs
2964 will be used (`https://latex.codecogs.com/png.latex?`).
2966 7. If the `--mathjax` option is used, TeX math will be displayed
2967 between `\(...\)` (for inline math) or `\[...\]` (for display
2968 math) and put in `<span>` tags with class `math`.
2969 The [MathJax] script will be used to render it as formulas.
2971[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2976#### Extension: `raw_html` ####
2978Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
2979(except verbatim contexts, where `<`, `>`, and `&` are interpreted
2980literally). (Technically this is not an extension, since standard
2981Markdown allows it, but it has been made an extension so that it can
2982be disabled if desired.)
2984The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2985DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
2988#### Extension: `markdown_in_html_blocks` ####
2990Standard Markdown allows you to include HTML "blocks": blocks
2991of HTML between balanced tags that are separated from the surrounding text
2992with blank lines, and start and end at the left margin. Within
2993these blocks, everything is interpreted as HTML, not Markdown;
2994so (for example), `*` does not signify emphasis.
2996Pandoc behaves this way when the `markdown_strict` format is used; but
2997by default, pandoc interprets material between HTML block tags as Markdown.
2998Thus, for example, pandoc will turn
3003 <td>[a link](http://google.com)</td>
3011 <td><em>one</em></td>
3012 <td><a href="http://google.com">a link</a></td>
3016whereas `Markdown.pl` will preserve it as is.
3018There is one exception to this rule: text between `<script>` and
3019`<style>` tags is not interpreted as Markdown.
3021This departure from standard Markdown should make it easier to mix
3022Markdown with HTML block elements. For example, one can surround
3023a block of Markdown text with `<div>` tags without preventing it
3024from being interpreted as Markdown.
3026#### Extension: `native_divs` ####
3028Use native pandoc `Div` blocks for content inside `<div>` tags.
3029For the most part this should give the same output as
3030`markdown_in_html_blocks`, but it makes it easier to write pandoc
3031filters to manipulate groups of blocks.
3033#### Extension: `native_spans` ####
3035Use native pandoc `Span` blocks for content inside `<span>` tags.
3036For the most part this should give the same output as `raw_html`,
3037but it makes it easier to write pandoc filters to manipulate groups
3040#### Extension: `raw_tex` ####
3042In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3043included in a document. Inline TeX commands will be preserved and passed
3044unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3045LaTeX to include BibTeX citations:
3047 This result was proved in \cite{jones.1967}.
3049Note that in LaTeX environments, like
3051 \begin{tabular}{|l|l|}\hline
3052 Age & Frequency \\ \hline
3055 36--45 & 22 \\ \hline
3058the material between the begin and end tags will be interpreted as raw
3059LaTeX, not as Markdown.
3061Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3062Emacs Org mode, and ConTeXt.
3064### Generic raw attribute ###
3066#### Extension: `raw_attribute` ####
3068Inline spans and fenced code blocks with a special
3069kind of attribute will be parsed as raw content with the
3070designated format. For example, the following produces a raw
3077And the following produces a raw `html` inline element:
3079 This is `<a>html</a>`{=html}
3081The format name should match the target format name (see
3082`-t/--to`, above, for a list, or use `pandoc
3083--list-output-formats`).
3085This extension presupposes that the relevant kind of
3086inline code or fenced code block is enabled. Thus, for
3087example, to use a raw attribute with a backtick code block,
3088`backtick_code_blocks` must be enabled.
3090The raw attribute cannot be combined with regular attributes.
3095#### Extension: `latex_macros` ####
3097For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
3098`\renewcommand` definitions and apply the resulting macros to all LaTeX
3099math. So, for example, the following will work in all output formats,
3102 \newcommand{\tuple}[1]{\langle #1 \rangle}
3106In LaTeX output, the `\newcommand` definition will simply be passed
3107unchanged to the output.
3113Markdown allows links to be specified in several ways.
3115### Automatic links ###
3117If you enclose a URL or email address in pointy brackets, it
3121 <sam@green.eggs.ham>
3125An inline link consists of the link text in square brackets,
3126followed by the URL in parentheses. (Optionally, the URL can
3127be followed by a link title, in quotes.)
3129 This is an [inline link](/url), and here's [one with
3130 a title](http://fsf.org "click here for a good time!").
3132There can be no space between the bracketed part and the parenthesized part.
3133The link text can contain formatting (such as emphasis), but the title cannot.
3135Email addresses in inline links are not autodetected, so they have to be
3136prefixed with `mailto`:
3138 [Write me!](mailto:sam@green.eggs.ham)
3140### Reference links ###
3142An *explicit* reference link has two parts, the link itself and the link
3143definition, which may occur elsewhere in the document (either
3144before or after the link).
3146The link consists of link text in square brackets, followed by a label in
3147square brackets. (There cannot be space between the two unless the
3148`spaced_reference_links` extension is enabled.) The link definition
3149consists of the bracketed label, followed by a colon and a space, followed by
3150the URL, and optionally (after a space) a link title either in quotes or in
3151parentheses. The label must not be parseable as a citation (assuming
3152the `citations` extension is enabled): citations take precedence over
3155Here are some examples:
3157 [my label 1]: /foo/bar.html "My title, optional"
3159 [my label 3]: http://fsf.org (The free software foundation)
3160 [my label 4]: /bar#special 'A title in single quotes'
3162The URL may optionally be surrounded by angle brackets:
3164 [my label 5]: <http://foo.bar.baz>
3166The title may go on the next line:
3168 [my label 3]: http://fsf.org
3169 "The free software foundation"
3171Note that link labels are not case sensitive. So, this will work:
3173 Here is [my link][FOO]
3177In an *implicit* reference link, the second pair of brackets is
3182 [my website]: http://foo.bar.baz
3184Note: In `Markdown.pl` and most other Markdown implementations,
3185reference link definitions cannot occur in nested constructions
3186such as list items or block quotes. Pandoc lifts this arbitrary
3187seeming restriction. So the following is fine in pandoc, though
3188not in most other implementations:
3194#### Extension: `shortcut_reference_links` ####
3196In a *shortcut* reference link, the second pair of brackets may
3201 [my website]: http://foo.bar.baz
3203### Internal links ###
3205To link to another section of the same document, use the automatically
3206generated identifier (see [Header identifiers]). For example:
3208 See the [Introduction](#introduction).
3212 See the [Introduction].
3214 [Introduction]: #introduction
3216Internal links are currently supported for HTML formats (including
3217HTML slide shows and EPUB), LaTeX, and ConTeXt.
3222A link immediately preceded by a `!` will be treated as an image.
3223The link text will be used as the image's alt text:
3225 
3229 [movie reel]: movie.gif
3231#### Extension: `implicit_figures` ####
3233An image with nonempty alt text, occurring by itself in a
3234paragraph, will be rendered as a figure with a caption. The
3235image's alt text will be used as the caption.
3237 
3239How this is rendered depends on the output format. Some output
3240formats (e.g. RTF) do not yet support figures. In those
3241formats, you'll just get an image in a paragraph by itself, with
3244If you just want a regular inline image, just make sure it is not
3245the only thing in the paragraph. One way to do this is to insert a
3246nonbreaking space after the image:
3248 \
3250Note that in reveal.js slide shows, an image in a paragraph
3251by itself that has the `stretch` class will fill the screen,
3252and the caption and figure tags will be omitted.
3254#### Extension: `link_attributes` ####
3256Attributes can be set on links and images:
3258 An inline {#id .class width=30 height=20px}
3259 and a reference ![image][ref] with attributes.
3261 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3263(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3264and `.class` are used.)
3266For HTML and EPUB, all attributes except `width` and `height` (but
3267including `srcset` and `sizes`) are passed through as is. The other
3268writers ignore attributes that are not supported by their output
3271The `width` and `height` attributes on images are treated specially. When
3272used without a unit, the unit is assumed to be pixels. However, any of
3273the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3274and `%`. There must not be any spaces between the number and the unit.
3278{ width=50% }
3281- Dimensions are converted to inches for output in page-based formats like
3282 LaTeX. Dimensions are converted to pixels for output in HTML-like
3283 formats. Use the `--dpi` option to specify the number of pixels per
3284 inch. The default is 96dpi.
3285- The `%` unit is generally relative to some available space.
3286 For example the above example will render to
3287 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3288 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3289 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3290- Some output formats have a notion of a class
3291 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3292 or a unique identifier (LaTeX `\caption`), or both (HTML).
3293- When no `width` or `height` attributes are specified, the fallback
3294 is to look at the image resolution and the dpi metadata embedded in
3300#### Extension: `bracketed_spans` ####
3302A bracketed sequence of inlines, as one would use to begin
3303a link, will be treated as a span with attributes if it is
3304followed immediately by attributes:
3306 [This is *some text*]{.class key="val"}
3311#### Extension: `footnotes` ####
3313Pandoc's Markdown allows footnotes, using the following syntax:
3315 Here is a footnote reference,[^1] and another.[^longnote]
3317 [^1]: Here is the footnote.
3319 [^longnote]: Here's one with multiple blocks.
3321 Subsequent paragraphs are indented to show that they
3322 belong to the previous footnote.
3326 The whole paragraph can be indented, or just the first
3327 line. In this way, multi-paragraph footnotes work like
3328 multi-paragraph list items.
3330 This paragraph won't be part of the note, because it
3333The identifiers in footnote references may not contain spaces, tabs,
3334or newlines. These identifiers are used only to correlate the
3335footnote reference with the note itself; in the output, footnotes
3336will be numbered sequentially.
3338The footnotes themselves need not be placed at the end of the
3339document. They may appear anywhere except inside other block elements
3340(lists, block quotes, tables, etc.). Each footnote should be
3341separated from surrounding content (including other footnotes)
3344#### Extension: `inline_notes` ####
3346Inline footnotes are also allowed (though, unlike regular notes,
3347they cannot contain multiple paragraphs). The syntax is as follows:
3349 Here is an inline note.^[Inlines notes are easier to write, since
3350 you don't have to pick an identifier and move down to type the
3353Inline and regular footnotes may be mixed freely.
3358#### Extension: `smart` ####
3360Interpret straight quotes as curly quotes, `---` as em-dashes,
3361`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3362inserted after certain abbreviations, such as "Mr." This
3363option currently affects the input formats `markdown`,
3364`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3365and the output formats `markdown`, `latex`, and `context`.
3367Note: If you are *writing* Markdown, then the `smart` extension
3368has the reverse effect: what would have been curly quotes comes
3371In LaTeX, `smart` means to use the standard TeX ligatures
3372for quotation marks (` `` ` and ` '' ` for double quotes,
3373`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3374en-dash and `---` for em-dash). If `smart` is disabled,
3375then in reading LaTeX pandoc will parse these characters
3376literally. In writing LaTeX, enabling `smart` tells pandoc
3377to use the ligatures when possible; if `smart` is disabled
3378pandoc will use unicode quotation mark and dash characters.
3383#### Extension: `citations` ####
3385Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3386citations and a bibliography in a number of styles. Basic usage is
3388 pandoc --filter pandoc-citeproc myinput.txt
3390In order to use this feature, you will need to specify a bibliography file
3391using the `bibliography` metadata field in a YAML metadata section, or
3392`--bibliography` command line argument. You can supply multiple `--bibliography`
3393arguments or set `bibliography` metadata field to YAML array, if you want to
3394use multiple bibliography files. The bibliography may have any of these
3397 Format File extension
3398 ------------ --------------
3411Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3412use `.bibtex` to force BibTeX.
3414Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3415can produce `.json` and `.yaml` files from any of the supported formats.
3417In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3418a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3426`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3435`<span class="nocase">...</span>`
3436: prevent a phrase from being capitalized as title case
3438`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3439and CSL YAML formats as far as possible.
3441As an alternative to specifying a bibliography file using `--bibliography`
3442or the YAML metadata field `bibliography`, you can include
3443the citation data directly in the `references` field of the
3444document's YAML metadata. The field should contain an array of
3445YAML-encoded references, for example:
3449 - type: article-journal
3461 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3463 title-short: Molecular structure of nucleic acids
3464 container-title: Nature
3468 DOI: 10.1038/171737a0
3469 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3473(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3474of the supported formats.)
3476Citations and references can be formatted using any style supported by the
3477[Citation Style Language], listed in the [Zotero Style Repository].
3478These files are specified using the `--csl` option or the `csl` metadata field.
3479By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3480format. The CSL project provides further information on [finding and editing styles].
3482To make your citations hyperlinks to the corresponding bibliography
3483entries, add `link-citations: true` to your YAML metadata.
3485Citations go inside square brackets and are separated by semicolons.
3486Each citation must have a key, composed of '@' + the citation
3487identifier from the database, and may optionally have a prefix,
3488a locator, and a suffix. The citation key must begin with a letter, digit,
3489or `_`, and may contain alphanumerics, `_`, and internal punctuation
3490characters (`:.#$%&-+?<>~/`). Here are some examples:
3492 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3494 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3496 Blah blah [@smith04; @doe99].
3498`pandoc-citeproc` detects locator terms in the [CSL locale files].
3499Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3500locale, locator terms can be written in either singular or plural forms,
3501as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3502`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3503`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3504`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3505`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3506`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3507locator term is used, "page" is assumed.
3509A minus sign (`-`) before the `@` will suppress mention of
3510the author in the citation. This can be useful when the
3511author is already mentioned in the text:
3513 Smith says blah [-@smith04].
3515You can also write an in-text citation, as follows:
3519 @smith04 [p. 33] says blah.
3521If the style calls for a list of works cited, it will be placed
3522at the end of the document. Normally, you will want to end your
3523document with an appropriate header:
3529The bibliography will be inserted after this header. Note that
3530the `unnumbered` class will be added to this header, so that the
3531section will not be numbered.
3533If you want to include items in the bibliography without actually
3534citing them in the body text, you can define a dummy `nocite` metadata
3535field and put the citations there:
3544In this example, the document will contain a citation for `item3`
3545only, but the bibliography will contain entries for `item1`, `item2`, and
3548It is possible to create a bibliography with all the citations,
3549whether or not they appear in the document, by using a wildcard:
3556For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3557to render bibliography. In order to do so, specify bibliography files as
3558outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3559invocation. Bear in mind that bibliography files have to be in respective
3560format (either BibTeX or BibLaTeX).
3562For more information, see the [pandoc-citeproc man page].
3564[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3565[Chicago Manual of Style]: http://chicagomanualofstyle.org
3566[Citation Style Language]: http://citationstyles.org
3567[Zotero Style Repository]: https://www.zotero.org/styles
3568[finding and editing styles]: http://citationstyles.org/styles/
3569[CSL locale files]: https://github.com/citation-style-language/locales
3570[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3572Non-pandoc extensions
3573---------------------
3575The following Markdown syntax extensions are not enabled by default
3576in pandoc, but may be enabled by adding `+EXTENSION` to the format
3577name, where `EXTENSION` is the name of the extension. Thus, for
3578example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3580#### Extension: `old_dashes` ####
3582Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3583`-` before a numeral is an en-dash, and `--` is an em-dash.
3584This option only has an effect if `smart` is enabled. It is
3585selected automatically for `textile` input.
3587#### Extension: `angle_brackets_escapable` ####
3589Allow `<` and `>` to be backslash-escaped, as they can be in
3590GitHub flavored Markdown but not original Markdown. This is
3591implied by pandoc's default `all_symbols_escapable`.
3593#### Extension: `lists_without_preceding_blankline` ####
3595Allow a list to occur right after a paragraph, with no intervening
3598#### Extension: `spaced_reference_links` ####
3600Allow whitespace between the two components of a reference link,
3605#### Extension: `hard_line_breaks` ####
3607Causes all newlines within a paragraph to be interpreted as hard line
3608breaks instead of spaces.
3610#### Extension: `ignore_line_breaks` ####
3612Causes newlines within a paragraph to be ignored, rather than being
3613treated as spaces or as hard line breaks. This option is intended for
3614use with East Asian languages where spaces are not used between words,
3615but text is divided into lines for readability.
3617#### Extension: `east_asian_line_breaks` ####
3619Causes newlines within a paragraph to be ignored, rather than
3620being treated as spaces or as hard line breaks, when they occur
3621between two East Asian wide characters. This is a better choice
3622than `ignore_line_breaks` for texts that include a mix of East
3623Asian wide characters and other characters.
3625##### Extension: `emoji` ####
3627Parses textual emojis like `:smile:` as Unicode emoticons.
3629#### Extension: `tex_math_single_backslash` ####
3631Causes anything between `\(` and `\)` to be interpreted as inline
3632TeX math, and anything between `\[` and `\]` to be interpreted
3633as display TeX math. Note: a drawback of this extension is that
3634it precludes escaping `(` and `[`.
3636#### Extension: `tex_math_double_backslash` ####
3638Causes anything between `\\(` and `\\)` to be interpreted as inline
3639TeX math, and anything between `\\[` and `\\]` to be interpreted
3642#### Extension: `markdown_attribute` ####
3644By default, pandoc interprets material inside block-level tags as Markdown.
3645This extension changes the behavior so that Markdown is only parsed
3646inside block-level tags if the tags have the attribute `markdown=1`.
3648#### Extension: `mmd_title_block` ####
3650Enables a [MultiMarkdown] style title block at the top of
3651the document, for example:
3655 Date: September 1, 2008
3656 Comment: This is a sample mmd title block, with
3657 a field spanning multiple lines.
3659See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3660`yaml_metadata_block` is enabled, it will take precedence over
3663#### Extension: `abbreviations` ####
3665Parses PHP Markdown Extra abbreviation keys, like
3667 *[HTML]: Hypertext Markup Language
3669Note that the pandoc document model does not support
3670abbreviations, so if this extension is enabled, abbreviation keys are
3671simply skipped (as opposed to being parsed as paragraphs).
3673#### Extension: `autolink_bare_uris` ####
3675Makes all absolute URIs into links, even when not surrounded by
3676pointy braces `<...>`.
3678#### Extension: `ascii_identifiers` ####
3680Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3681Accents are stripped off of accented Latin letters, and non-Latin
3684#### Extension: `mmd_link_attributes` ####
3686Parses multimarkdown style key-value attributes on link
3687and image references. This extension should not be confused with the
3688[`link_attributes`](#extension-link_attributes) extension.
3690 This is a reference ![image][ref] with multimarkdown attributes.
3692 [ref]: http://path.to/image "Image title" width=20px height=30px
3693 id=myId class="myClass1 myClass2"
3695#### Extension: `mmd_header_identifiers` ####
3697Parses multimarkdown style header identifiers (in square brackets,
3698after the header but before any trailing `#`s in an ATX header).
3700#### Extension: `compact_definition_lists` ####
3702Activates the definition list syntax of pandoc 1.12.x and earlier.
3703This syntax differs from the one described above under [Definition lists]
3706 - No blank line is required between consecutive items of the
3708 - To get a "tight" or "compact" list, omit space between consecutive
3709 items; the space between a term and its definition does not affect
3711 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3712 be indented four spaces.[^6]
3714[^6]: To see why laziness is incompatible with relaxing the requirement
3715 of a blank line between items, consider the following example:
3722 Is this a single list item with two definitions of "bar," the first of
3723 which is lazily wrapped, or two list items? To remove the ambiguity
3724 we must either disallow lazy wrapping or require a blank line between
3730In addition to pandoc's extended Markdown, the following Markdown
3731variants are supported:
3733`markdown_phpextra` (PHP Markdown Extra)
3734: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3735 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3736 `header_attributes`, `link_attributes`, `abbreviations`,
3737 `shortcut_reference_links`.
3739`markdown_github` (GitHub-Flavored Markdown)
3740: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3741 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3742 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3743 `shortcut_reference_links`, `angle_brackets_escapable`.
3745`markdown_mmd` (MultiMarkdown)
3746: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3747 `tex_math_double_backslash`, `intraword_underscores`,
3748 `mmd_title_block`, `footnotes`, `definition_lists`,
3749 `all_symbols_escapable`, `implicit_header_references`,
3750 `auto_identifiers`, `mmd_header_identifiers`,
3751 `shortcut_reference_links`.
3753`markdown_strict` (Markdown.pl)
3756Extensions with formats other than Markdown
3757-------------------------------------------
3759Some of the extensions discussed above can be used with formats
3762* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3763 and `textile` input (and is used by default).
3765* `tex_math_dollars`, `tex_math_single_backslash`, and
3766 `tex_math_double_backslash` can be used with `html` input.
3767 (This is handy for reading web pages formatted using MathJax,
3770Producing slide shows with pandoc
3771=================================
3773You can use pandoc to produce an HTML + JavaScript slide presentation
3774that can be viewed via a web browser. There are five ways to do this,
3775using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3776You can also produce a PDF slide show using LaTeX [`beamer`].
3778Here's the Markdown source for a simple slide show, `habits.txt`:
3805 
3812To produce an HTML/JavaScript slide show, simply type
3814 pandoc -t FORMAT -s habits.txt -o habits.html
3816where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3818For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3819`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3820assumed to be available at the relative path `s5/default` (for S5), `slideous`
3821(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3822`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3823`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3824above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3827With all HTML slide formats, the `--self-contained` option can be used to
3828produce a single file that contains all of the data necessary to display the
3829slide show, including linked scripts, stylesheets, images, and videos.
3831To produce a PDF slide show using beamer, type
3833 pandoc -t beamer habits.txt -o habits.pdf
3835Note that a reveal.js slide show can also be converted to a PDF
3836by printing it to a file from the browser.
3838Structuring the slide show
3839--------------------------
3841By default, the *slide level* is the highest header level in
3842the hierarchy that is followed immediately by content, and not another
3843header, somewhere in the document. In the example above, level 1 headers
3844are always followed by level 2 headers, which are followed by content,
3845so 2 is the slide level. This default can be overridden using
3846the `--slide-level` option.
3848The document is carved up into slides according to the following
3851 * A horizontal rule always starts a new slide.
3853 * A header at the slide level always starts a new slide.
3855 * Headers *below* the slide level in the hierarchy create
3856 headers *within* a slide.
3858 * Headers *above* the slide level in the hierarchy create
3859 "title slides," which just contain the section title
3860 and help to break the slide show into sections.
3862 * Content *above* the slide level will not appear in the slide
3865 * A title page is constructed automatically from the document's title
3866 block, if present. (In the case of beamer, this can be disabled
3867 by commenting out some lines in the default template.)
3869These rules are designed to support many different styles of slide show. If
3870you don't care about structuring your slides into sections and subsections,
3871you can just use level 1 headers for all each slide. (In that case, level 1
3872will be the slide level.) But you can also structure the slide show into
3873sections, as in the example above.
3875Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3876layout will be produced, with level 1 headers building horizontally
3877and level 2 headers building vertically. It is not recommended that
3878you use deeper nesting of section levels with reveal.js.
3883By default, these writers produce lists that display "all at once."
3884If you want your lists to display incrementally (one item at a time),
3885use the `-i` option. If you want a particular list to depart from the
3886default (that is, to display incrementally without the `-i` option and
3887all at once with the `-i` option), put it in a block quote:
3892In this way incremental and nonincremental lists can be mixed in
3898You can add "pauses" within a slide by including a paragraph containing
3899three dots, separated by spaces:
3901 # Slide with a pause
3903 content before the pause
3907 content after the pause
3912You can change the style of HTML slides by putting customized CSS files
3913in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3914or `$DATADIR/slideous` (for Slideous),
3915where `$DATADIR` is the user data directory (see `--data-dir`, above).
3916The originals may be found in pandoc's system data directory (generally
3917`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
3918files it does not find in the user data directory.
3920For dzslides, the CSS is included in the HTML file itself, and may
3923All [reveal.js configuration options] can be set through variables.
3924For example, themes can be used by setting the `theme` variable:
3928Or you can specify a custom stylesheet using the `--css` option.
3930To style beamer slides, you can specify a `theme`, `colortheme`,
3931`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
3933 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3935Note that header attributes will turn into slide attributes
3936(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3937to style individual slides. In beamer, the only header attribute
3938that affects slides is the `allowframebreaks` class, which sets the
3939`allowframebreaks` option, causing multiple slides to be created
3940if the content overfills the frame. This is recommended especially for
3943 # References {.allowframebreaks}
3948reveal.js has good support for speaker notes. You can add notes to your
3949Markdown document thus:
3954 - It can contain Markdown
3959To show the notes window, press `s` while viewing the presentation.
3960Notes are not yet supported for other slide formats, but the notes
3961will not appear on the slides themselves.
3963Frame attributes in beamer
3964--------------------------
3966Sometimes it is necessary to add the LaTeX `[fragile]` option to
3967a frame in beamer (for example, when using the `minted` environment).
3968This can be forced by adding the `fragile` class to the header
3969introducing the slide:
3971 # Fragile slide {.fragile}
3973All of the other frame attributes described in Section 8.1 of
3974the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
3975`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3978Creating EPUBs with pandoc
3979==========================
3984EPUB metadata may be specified using the `--epub-metadata` option, but
3985if the source document is Markdown, it is better to use a [YAML metadata
3986block][Extension: `yaml_metadata_block`]. Here is an example:
3993 text: An investigation of metadata
4001 text: doi:10.234234.234/33
4003 rights: © 2007 John Smith, CC BY-NC
4008The following fields are recognized:
4011 ~ Either a string value or an object with fields `text` and
4012 `scheme`. Valid values for `scheme` are `ISBN-10`,
4013 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
4014 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
4015 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
4018 ~ Either a string value, or an object with fields `file-as` and
4019 `type`, or a list of such objects. Valid values for `type` are
4020 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
4023 ~ Either a string value, or an object with fields `role`, `file-as`,
4024 and `text`, or a list of such objects. Valid values for `role` are
4025 [MARC relators], but
4026 pandoc will attempt to translate the human-readable versions
4027 (like "author" and "editor") to the appropriate marc relators.
4030 ~ Same format as `creator`.
4033 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
4034 Pandoc will attempt to convert other common date formats.
4036`lang` (or legacy: `language`)
4037 ~ A string value in [BCP 47] format. Pandoc will default to the local
4038 language if nothing is specified.
4041 ~ A string value or a list of such values.
4062 ~ A string value (path to cover image).
4065 ~ A string value (path to CSS stylesheet).
4067`page-progression-direction`
4068 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
4069 attribute for the [`spine` element].
4072 ~ iBooks-specific metadata, with the following fields:
4074 - `version`: (string)
4075 - `specified-fonts`: `true`|`false` (default `false`)
4076 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
4077 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
4078 - `binding`: `true`|`false` (default `true`)
4079 - `scroll-axis`: `vertical`|`horizontal`|`default`
4081[MARC relators]: http://loc.gov/marc/relators/relaterm.html
4082[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4087By default, pandoc will download linked media (including audio and
4088video) and include it in the EPUB container, yielding a completely
4089self-contained EPUB. If you want to link to external media resources
4090instead, use raw HTML in your source and add `data-external="1"` to the tag
4091with the `src` attribute. For example:
4093 <audio controls="1">
4094 <source src="http://example.com/music/toccata.mp3"
4095 data-external="1" type="audio/mpeg">
4099Literate Haskell support
4100========================
4102If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4103format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4104`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4105literate Haskell source. This means that
4107 - In Markdown input, "bird track" sections will be parsed as Haskell
4108 code rather than block quotations. Text between `\begin{code}`
4109 and `\end{code}` will also be treated as Haskell code. For
4110 ATX-style headers the character '=' will be used instead of '#'.
4112 - In Markdown output, code blocks with classes `haskell` and `literate`
4113 will be rendered using bird tracks, and block quotations will be
4114 indented one space, so they will not be treated as Haskell code.
4115 In addition, headers will be rendered setext-style (with underlines)
4116 rather than ATX-style (with '#' characters). (This is because ghc
4117 treats '#' characters in column 1 as introducing line numbers.)
4119 - In restructured text input, "bird track" sections will be parsed
4122 - In restructured text output, code blocks with class `haskell` will
4123 be rendered using bird tracks.
4125 - In LaTeX input, text in `code` environments will be parsed as
4128 - In LaTeX output, code blocks with class `haskell` will be rendered
4129 inside `code` environments.
4131 - In HTML output, code blocks with class `haskell` will be rendered
4132 with class `literatehaskell` and bird tracks.
4136 pandoc -f markdown+lhs -t html
4138reads literate Haskell source formatted with Markdown conventions and writes
4139ordinary HTML (without bird tracks).
4141 pandoc -f markdown+lhs -t html+lhs
4143writes HTML with the Haskell code in bird tracks, so it can be copied
4144and pasted as literate Haskell source.
4146Note that GHC expects the bird tracks in the first column, so indentend literate
4147code blocks (e.g. inside an itemized environment) will not be picked up by the
4153Pandoc will automatically highlight syntax in [fenced code blocks] that
4154are marked with a language name. The Haskell library [skylighting] is
4155used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4156To see a list of language names that pandoc will recognize, type
4157`pandoc --list-highlight-languages`.
4159The color scheme can be selected using the `--highlight-style` option.
4160The default color scheme is `pygments`, which imitates the default color
4161scheme used by the Python library pygments (though pygments is not actually
4162used to do the highlighting). To see a list of highlight styles,
4163type `pandoc --list-highlight-styles`.
4165To disable highlighting, use the `--no-highlight` option.
4167[skylighting]: https://github.com/jgm/skylighting
4169Custom Styles in Docx Output
4170============================
4172By default, pandoc's docx output applies a predefined set of styles for
4173blocks such as paragraphs and block quotes, and uses largely default
4174formatting (italics, bold) for inlines. This will work for most
4175purposes, especially alongside a `reference.docx` file. However, if you
4176need to apply your own styles to blocks, or match a preexisting set of
4177styles, pandoc allows you to define custom styles for blocks and text
4178using `div`s and `span`s, respectively.
4180If you define a `div` or `span` with the attribute `custom-style`,
4181pandoc will apply your specified style to the contained elements. So,
4184 <span custom-style="Emphatically">Get out,</span> he said.
4186would produce a docx file with "Get out," styled with character
4187style `Emphatically`. Similarly,
4189 Dickinson starts the poem simply:
4191 <div custom-style="Poetry">
4192 | A Bird came down the Walk---
4193 | He did not know I saw---
4196would style the two contained lines with the `Poetry` paragraph style.
4198If the styles are not yet in your reference.docx, they will be defined
4199in the output file as inheriting from normal text. If they are already
4200defined, pandoc will not alter the definition.
4202This feature allows for greatest customization in conjunction with
4203[pandoc filters]. If you want all paragraphs after block quotes to be
4204indented, you can write a filter to apply the styles necessary. If you
4205want all italics to be transformed to the `Emphasis` character style
4206(perhaps to change their color), you can write a filter which will
4207transform all italicized inlines to inlines within an `Emphasis`
4210[pandoc filters]: http://pandoc.org/scripting.html
4215Pandoc can be extended with custom writers written in [lua]. (Pandoc
4216includes a lua interpreter, so lua need not be installed separately.)
4218To use a custom writer, simply specify the path to the lua script
4219in place of the output format. For example:
4221 pandoc -t data/sample.lua
4223Creating a custom writer requires writing a lua function for each
4224possible element in a pandoc document. To get a documented example
4225which you can modify according to your needs, do
4227 pandoc --print-default-data-file sample.lua
4229[lua]: http://www.lua.org
4234© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
4235[GPL], version 2 or greater. This software carries no warranty of
4236any kind. (See COPYRIGHT for full copyright and warranty notices.)
4244Alexander Kondratskiy,
4246Alexander V Vershilov,
4247Alfred Wechselberger,
4256Beni Cherniavsky-Paskin,
4267Christoffer Ackelman,
4305Jaime Marquínez Ferrándiz,
4342Matthias C. M. Troffaes,
4412[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