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[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org mode],
19[DocBook], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx];
20and it can write 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`, `wkhtmltopdf`,
31`prince`, or `weasyprint` is installed.
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[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
91[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
92[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
93[Haskell]: https://www.haskell.org
94[GNU Texinfo]: http://www.gnu.org/software/texinfo/
95[Emacs Org mode]: http://orgmode.org
96[AsciiDoc]: http://www.methods.co.nz/asciidoc/
97[DZSlides]: http://paulrouget.com/dzslides/
98[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
99[PDF]: https://www.adobe.com/pdf/
100[reveal.js]: http://lab.hakim.se/reveal-js/
101[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
102[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
103[TEI Simple]: https://github.com/TEIC/TEI-Simple
104[Muse]: https://amusewiki.org/library/manual
105[Vimwiki]: https://vimwiki.github.io
110If no *input-file* is specified, input is read from *stdin*.
111Otherwise, the *input-files* are concatenated (with a blank
112line between each) and used as input. Output goes to *stdout* by
113default (though output to the terminal is disabled for the
114`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
115forced using `-o -`). For output to a file, use the `-o`
118 pandoc -o output.html input.txt
120By default, pandoc produces a document fragment, not a standalone
121document with a proper header and footer. To produce a standalone
122document, use the `-s` or `--standalone` flag:
124 pandoc -s -o output.html input.txt
126For more information on how standalone documents are produced, see
129Instead of a file, an absolute URI may be given. In this case
130pandoc will fetch the content using HTTP:
132 pandoc -f html -t markdown http://www.fsf.org
134It is possible to supply a custom User-Agent string or other
135header when requesting a document from a URL:
137 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
140If multiple input files are given, `pandoc` will concatenate them all (with
141blank lines between them) before parsing. This feature is disabled for
142 binary input formats such as `EPUB`, `odt`, and `docx`.
144The format of the input and output can be specified explicitly using
145command-line options. The input format can be specified using the
146`-r/--read` or `-f/--from` options, the output format using the
147`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
148Markdown to LaTeX, you could type:
150 pandoc -f markdown -t latex hello.txt
152To convert `hello.html` from HTML to Markdown:
154 pandoc -f html -t markdown hello.html
156Supported output formats are listed below under the `-t/--to` option.
157Supported input formats are listed below under the `-f/--from` option. Note
158that the `rst`, `textile`, `latex`, and `html` readers are not complete;
159there are some constructs that they do not parse.
161If the input or output format is not specified explicitly, `pandoc`
162will attempt to guess it from the extensions of
163the input and output filenames. Thus, for example,
165 pandoc -o hello.tex hello.txt
167will convert `hello.txt` from Markdown to LaTeX. If no output file
168is specified (so that output goes to *stdout*), or if the output file's
169extension is unknown, the output format will default to HTML.
170If no input file is specified (so that input comes from *stdin*), or
171if the input files' extensions are unknown, the input format will
172be assumed to be Markdown unless explicitly specified.
174Pandoc uses the UTF-8 character encoding for both input and output.
175If your local character encoding is not UTF-8, you
176should pipe input and output through [`iconv`]:
178 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
180Note that in some output formats (such as HTML, LaTeX, ConTeXt,
181RTF, OPML, DocBook, and Texinfo), information about
182the character encoding is included in the document header, which
183will only be included if you use the `-s/--standalone` option.
185[`iconv`]: http://www.gnu.org/software/libiconv/
190To produce a PDF, specify an output file with a `.pdf` extension.
191By default, pandoc will use LaTeX to create the PDF:
193 pandoc test.txt -o test.pdf
195Production of a PDF requires that a LaTeX engine be installed (see
196`--pdf-engine`, below), and assumes that the following LaTeX packages
197are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
198[`ifxetex`], [`ifluatex`], [`listings`] (if the
199`--listings` option is used), [`fancyvrb`], [`longtable`],
200[`booktabs`], [`graphicx`] and [`grffile`] (if the document
201contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
202`geometry` variable set), [`setspace`] (with `linestretch`), and
203[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
204the LaTeX engine requires [`fontspec`]. `xelatex` uses
205[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
206`dir` variable set). If the `mathspec` variable is set,
207`xelatex` will use [`mathspec`] instead of [`unicode-math`].
208The [`upquote`] and [`microtype`] packages are used if
209available, and [`csquotes`] will be used for [typography]
210if added to the template or included in any header file. The
211[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
212optionally be used for [citation rendering]. These are included
213with all recent versions of [TeX Live].
215Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
216following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
217[`weasyprint`] or [`prince`].
218To do this, specify an output file with a `.pdf` extension, as before,
219but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
220to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
222PDF output can be controlled using [variables for LaTeX] (if
223LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
224When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
225If `wkhtmltopdf` is used, then the variables `margin-left`,
226`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
227will affect the output.
229[`amsfonts`]: https://ctan.org/pkg/amsfonts
230[`amsmath`]: https://ctan.org/pkg/amsmath
231[`lm`]: https://ctan.org/pkg/lm
232[`ifxetex`]: https://ctan.org/pkg/ifxetex
233[`ifluatex`]: https://ctan.org/pkg/ifluatex
234[`listings`]: https://ctan.org/pkg/listings
235[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
236[`longtable`]: https://ctan.org/pkg/longtable
237[`booktabs`]: https://ctan.org/pkg/booktabs
238[`graphicx`]: https://ctan.org/pkg/graphicx
239[`grffile`]: https://ctan.org/pkg/grffile
240[`geometry`]: https://ctan.org/pkg/geometry
241[`setspace`]: https://ctan.org/pkg/setspace
242[`xecjk`]: https://ctan.org/pkg/xecjk
243[`hyperref`]: https://ctan.org/pkg/hyperref
244[`ulem`]: https://ctan.org/pkg/ulem
245[`babel`]: https://ctan.org/pkg/babel
246[`bidi`]: https://ctan.org/pkg/bidi
247[`mathspec`]: https://ctan.org/pkg/mathspec
248[`unicode-math`]: https://ctan.org/pkg/unicode-math
249[`polyglossia`]: https://ctan.org/pkg/polyglossia
250[`fontspec`]: https://ctan.org/pkg/fontspec
251[`upquote`]: https://ctan.org/pkg/upquote
252[`microtype`]: https://ctan.org/pkg/microtype
253[`csquotes`]: https://ctan.org/pkg/csquotes
254[`natbib`]: https://ctan.org/pkg/natbib
255[`biblatex`]: https://ctan.org/pkg/biblatex
256[`bibtex`]: https://ctan.org/pkg/bibtex
257[`biber`]: https://ctan.org/pkg/biber
258[TeX Live]: http://www.tug.org/texlive/
259[`wkhtmltopdf`]: https://wkhtmltopdf.org
260[`weasyprint`]: http://weasyprint.org
261[`prince`]: https://www.princexml.com/
269`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
271: Specify input format. *FORMAT* can be `native` (native Haskell),
272 `json` (JSON version of native AST), `markdown` (pandoc's
273 extended Markdown), `markdown_strict` (original unextended
274 Markdown), `markdown_phpextra` (PHP Markdown Extra),
275 `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
276 `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
277 (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
278 (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
279 `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
280 markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
281 `haddock` (Haddock markup), or `latex` (LaTeX).
282 (`markdown_github` provides deprecated and less accurate suppport
283 for Github-Flavored Markdown; please use `gfm` instead, unless you
284 need to use extensions other than `smart`.)
285 If `+lhs` is appended to `markdown`, `rst`, `latex`, or
286 `html`, the input will be treated as literate Haskell source: see
287 [Literate Haskell support], below. Markdown
288 syntax extensions can be individually enabled or disabled by
289 appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
290 example, `markdown_strict+footnotes+definition_lists` is strict
291 Markdown with footnotes and definition lists enabled, and
292 `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
293 without pipe tables and with hard line breaks. See [Pandoc's
294 Markdown], below, for a list of extensions and
295 their names. See `--list-input-formats` and `--list-extensions`,
298`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
300: Specify output format. *FORMAT* can be `native` (native Haskell),
301 `json` (JSON version of native AST), `plain` (plain text),
302 `markdown` (pandoc's extended Markdown), `markdown_strict`
303 (original unextended Markdown), `markdown_phpextra` (PHP Markdown
304 Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
305 Markdown), `commonmark` (CommonMark Markdown), `rst`
306 (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
307 or `html5` (HTML5/XHTML [polyglot markup]), `latex`
308 (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
309 `man` (groff man), `mediawiki` (MediaWiki markup),
310 `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
311 `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
312 `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
313 (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
314 `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
315 (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
316 `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
317 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
318 Simple), `slidy` (Slidy HTML and JavaScript slide show),
319 `slideous` (Slideous HTML and JavaScript slide show),
320 `dzslides` (DZSlides HTML5 + JavaScript slide show),
321 `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
322 (S5 HTML and JavaScript slide show), or the path of a custom
323 lua writer (see [Custom writers], below). (`markdown_github`
324 provides deprecated and less accurate suppport for
325 Github-Flavored Markdown; please use `gfm` instead, unless
326 you use extensions that do not work with `gfm`.) Note that `odt`,
327 `epub`, and `epub3` output will not be directed to *stdout*;
328 an output filename must be specified using the `-o/--output`
329 option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
330 `beamer`, `html4`, or `html5`, the output will be rendered as
331 literate Haskell source: see [Literate Haskell support],
332 below. Markdown syntax extensions can be individually
333 enabled or disabled by appending `+EXTENSION` or
334 `-EXTENSION` to the format name, as described above under `-f`.
335 See `--list-output-formats` and `--list-extensions`, below.
337`-o` *FILE*, `--output=`*FILE*
339: Write output to *FILE* instead of *stdout*. If *FILE* is
340 `-`, output will go to *stdout*, even if a non-textual format
341 (`docx`, `odt`, `epub2`, `epub3`) is specified.
343`--data-dir=`*DIRECTORY*
345: Specify the user data directory to search for pandoc data files.
346 If this option is not specified, the default user data directory
347 will be used. This is, in UNIX:
353 C:\Documents And Settings\USERNAME\Application Data\pandoc
355 and in Windows Vista or later:
357 C:\Users\USERNAME\AppData\Roaming\pandoc
359 You can find the default user data directory on your system by
360 looking at the output of `pandoc --version`.
361 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
362 `slidy`, `slideous`, or `s5` directory
363 placed in this directory will override pandoc's normal defaults.
367: Generate a bash completion script. To enable bash completion
368 with pandoc, add this to your `.bashrc`:
370 eval "$(pandoc --bash-completion)"
374: Give verbose debugging output. Currently this only has an effect
379: Suppress warning messages.
383: Exit with error status if there are any warnings.
387: Write log messages in machine-readable JSON format to
388 *FILE*. All messages above DEBUG level will be written,
389 regardless of verbosity settings (`--verbose`, `--quiet`).
391`--list-input-formats`
393: List supported input formats, one per line.
395`--list-output-formats`
397: List supported output formats, one per line.
401: List supported Markdown extensions, one per line, followed
402 by a `+` or `-` indicating whether it is enabled by default
403 in pandoc's Markdown.
405`--list-highlight-languages`
407: List supported languages for syntax highlighting, one per
410`--list-highlight-styles`
412: List supported styles for syntax highlighting, one per line.
413 See `--highlight-style`.
426`--base-header-level=`*NUMBER*
428: Specify the base level for headers (defaults to 1).
430`--indented-code-classes=`*CLASSES*
432: Specify classes to use for indented code blocks--for example,
433 `perl,numberLines` or `haskell`. Multiple classes may be separated
436`--default-image-extension=`*EXTENSION*
438: Specify a default extension to use when image paths/URLs have no
439 extension. This allows you to use the same source for formats that
440 require different kinds of images. Currently this option only affects
441 the Markdown and LaTeX readers.
445: Parse each file individually before combining for multifile
446 documents. This will allow footnotes in different files with the
447 same identifiers to work as expected. If this option is set,
448 footnotes and links will not work across files. Reading binary
449 files (docx, odt, epub) implies `--file-scope`.
453: Specify an executable to be used as a filter transforming the
454 pandoc AST after the input is parsed and before the output is
455 written. The executable should read JSON from stdin and write
456 JSON to stdout. The JSON must be formatted like pandoc's own
457 JSON input and output. The name of the output format will be
458 passed to the filter as the first argument. Hence,
460 pandoc --filter ./caps.py -t latex
464 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
466 The latter form may be useful for debugging filters.
468 Filters may be written in any language. `Text.Pandoc.JSON`
469 exports `toJSONFilter` to facilitate writing filters in Haskell.
470 Those who would prefer to write filters in python can use the
471 module [`pandocfilters`], installable from PyPI. There are also
472 pandoc filter libraries in [PHP], [perl], and
473 [JavaScript/node.js].
475 In order of preference, pandoc will look for filters in
477 1. a specified full or relative path (executable or
480 2. `$DATADIR/filters` (executable or non-executable)
481 where `$DATADIR` is the user data directory (see
482 `--data-dir`, above).
484 3. `$PATH` (executable only)
486`--lua-filter=`*SCRIPT*
488: Transform the document in a similar fashion as JSON filters (see
489 `--filter`), but use pandoc's build-in lua filtering system. The given
490 lua script is expected to return a list of lua filters which will be
491 applied in order. Each lua filter must contain element-transforming
492 functions indexed by the name of the AST element on which the filter
493 function should be applied.
495 The `pandoc` lua module provides helper functions for element
496 creation. It is always loaded into the script's lua environment.
498 The following is an example lua script for macro-expansion:
500 function expand_hello_world(inline)
501 if inline.c == '{{helloworld}}' then
502 return pandoc.Emph{ pandoc.Str "Hello, World" }
508 return {{Str = expand_hello_world}}
511`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
513: Set the metadata field *KEY* to the value *VAL*. A value specified
514 on the command line overrides a value specified in the document.
515 Values will be parsed as YAML boolean or string values. If no value is
516 specified, the value will be treated as Boolean true. Like
517 `--variable`, `--metadata` causes template variables to be set.
518 But unlike `--variable`, `--metadata` affects the metadata of the
519 underlying document (which is accessible from filters and may be
520 printed in some output formats).
522`-p`, `--preserve-tabs`
524: Preserve tabs instead of converting them to spaces (the default).
525 Note that this will only affect tabs in literal code spans and code
526 blocks; tabs in regular text will be treated as spaces.
530: Specify the number of spaces per tab (default is 4).
532`--track-changes=accept`|`reject`|`all`
534: Specifies what to do with insertions, deletions, and comments
535 produced by the MS Word "Track Changes" feature. `accept` (the
536 default), inserts all insertions, and ignores all
537 deletions. `reject` inserts all deletions and ignores
538 insertions. Both `accept` and `reject` ignore comments. `all` puts
539 in insertions, deletions, and comments, wrapped in spans with
540 `insertion`, `deletion`, `comment-start`, and `comment-end`
541 classes, respectively. The author and time of change is
542 included. `all` is useful for scripting: only accepting changes
543 from a certain reviewer, say, or before a certain date. This
544 option only affects the docx reader.
546`--extract-media=`*DIR*
548: Extract images and other media contained in or linked from
549 the source document to the path *DIR*, creating it if
550 necessary, and adjust the images references in the document
551 so they point to the extracted files. If the source format is
552 a binary container (docx, epub, or odt), the media is
553 extracted from the container and the original
554 filenames are used. Otherwise the media is read from the
555 file system or downloaded, and new filenames are constructed
556 based on SHA1 hashes of the contents.
558`--abbreviations=`*FILE*
560: Specifies a custom abbreviations file, with abbreviations
561 one to a line. If this option is not specified, pandoc will
562 read the data file `abbreviations` from the user data
563 directory or fall back on a system default. To see the
565 `pandoc --print-default-data-file=abbreviations`. The only
566 use pandoc makes of this list is in the Markdown reader.
567 Strings ending in a period that are found in this list will
568 be followed by a nonbreaking space, so that the period will
569 not produce sentence-ending space in formats like LaTeX.
571[`pandocfilters`]: https://github.com/jgm/pandocfilters
572[PHP]: https://github.com/vinai/pandocfilters-php
573[perl]: https://metacpan.org/pod/Pandoc::Filter
574[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
576General writer options
577----------------------
581: Produce output with an appropriate header and footer (e.g. a
582 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
583 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
588: Use *FILE* as a custom template for the generated document. Implies
589 `--standalone`. See [Templates], below, for a description
590 of template syntax. If no extension is specified, an extension
591 corresponding to the writer will be added, so that `--template=special`
592 looks for `special.html` for HTML output. If the template is not
593 found, pandoc will search for it in the `templates` subdirectory of
594 the user data directory (see `--data-dir`). If this option is not used,
595 a default template appropriate for the output format will be used (see
596 `-D/--print-default-template`).
598`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
600: Set the template variable *KEY* to the value *VAL* when rendering the
601 document in standalone mode. This is generally only useful when the
602 `--template` option is used to specify a custom template, since
603 pandoc automatically sets the variables used in the default
604 templates. If no *VAL* is specified, the key will be given the
607`-D` *FORMAT*, `--print-default-template=`*FORMAT*
609: Print the system default template for an output *FORMAT*. (See `-t`
610 for a list of possible *FORMAT*s.) Templates in the user data
611 directory are ignored.
613`--print-default-data-file=`*FILE*
615: Print a system default data file. Files in the user data directory
618`--eol=crlf`|`lf`|`native`
620: Manually specify line endings: `crlf` (Windows), `lf`
621 (macOS/Linux/UNIX), or `native` (line endings appropriate
622 to the OS on which pandoc is being run). The default is
627: Specify the dpi (dots per inch) value for conversion from pixels
628 to inch/centimeters and vice versa. The default is 96dpi.
629 Technically, the correct term would be ppi (pixels per inch).
631`--wrap=auto`|`none`|`preserve`
633: Determine how text is wrapped in the output (the source
634 code, not the rendered version). With `auto` (the default),
635 pandoc will attempt to wrap lines to the column width specified by
636 `--columns` (default 72). With `none`, pandoc will not wrap
637 lines at all. With `preserve`, pandoc will attempt to
638 preserve the wrapping from the source document (that is,
639 where there are nonsemantic newlines in the source, there
640 will be nonsemantic newlines in the output as well).
641 Automatic wrapping does not currently work in HTML output.
645: Specify length of lines in characters. This affects text wrapping
646 in the generated source code (see `--wrap`). It also affects
647 calculation of column widths for plain text tables (see [Tables] below).
649`--toc`, `--table-of-contents`
651: Include an automatically generated table of contents (or, in
652 the case of `latex`, `context`, `docx`, `odt`,
653 `opendocument`, `rst`, or `ms`, an instruction to create
654 one) in the output document. This option has no effect on
655 `man`, `docbook4`, `docbook5`, or `jats` output.
657`--toc-depth=`*NUMBER*
659: Specify the number of section levels to include in the table
660 of contents. The default is 3 (which means that level 1, 2, and 3
661 headers will be listed in the contents).
665: Strip out HTML comments in the Markdown or Textile source,
666 rather than passing them on to Markdown, Textile or HTML
667 output as raw HTML. This does not apply to HTML comments
668 inside raw HTML blocks when the `markdown_in_html_blocks`
669 extension is not set.
673: Disables syntax highlighting for code blocks and inlines, even when
674 a language attribute is given.
676`--highlight-style=`*STYLE*|*FILE*
678: Specifies the coloring style to be used in highlighted source code.
679 Options are `pygments` (the default), `kate`, `monochrome`,
680 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
681 For more information on syntax highlighting in pandoc, see
682 [Syntax highlighting], below. See also
683 `--list-highlight-styles`.
685 Instead of a *STYLE* name, a JSON file with extension
686 `.theme` may be supplied. This will be parsed as a KDE
687 syntax highlighting theme and (if valid) used as the
688 highlighting style. To see a sample theme that can be
689 modified, `pandoc --print-default-data-file default.theme`.
691`--syntax-definition=`*FILE*
693: Instructs pandoc to load a KDE XML syntax definition file,
694 which will be used for syntax highlighting of appropriately
695 marked code blocks. This can be used to add support for
696 new languages or to use altered syntax definitions for
699`-H` *FILE*, `--include-in-header=`*FILE*
701: Include contents of *FILE*, verbatim, at the end of the header.
702 This can be used, for example, to include special
703 CSS or JavaScript in HTML documents. This option can be used
704 repeatedly to include multiple files in the header. They will be
705 included in the order specified. Implies `--standalone`.
707`-B` *FILE*, `--include-before-body=`*FILE*
709: Include contents of *FILE*, verbatim, at the beginning of the
710 document body (e.g. after the `<body>` tag in HTML, or the
711 `\begin{document}` command in LaTeX). This can be used to include
712 navigation bars or banners in HTML documents. This option can be
713 used repeatedly to include multiple files. They will be included in
714 the order specified. Implies `--standalone`.
716`-A` *FILE*, `--include-after-body=`*FILE*
718: Include contents of *FILE*, verbatim, at the end of the document
719 body (before the `</body>` tag in HTML, or the
720 `\end{document}` command in LaTeX). This option can be used
721 repeatedly to include multiple files. They will be included in the
722 order specified. Implies `--standalone`.
724`--resource-path=`*SEARCHPATH*
726: List of paths to search for images and other resources.
727 The paths should be separated by `:` on Linux, UNIX, and
728 macOS systems, and by `;` on Windows. If `--resource-path`
729 is not specified, the default resource path is the working
730 directory. Note that, if `--resource-path` is specified,
731 the working directory must be explicitly listed or it
732 will not be searched. For example:
733 `--resource-path=.:test` will search the working directory
734 and the `test` subdirectory, in that order.
736`--request-header=`*NAME*`:`*VAL*
738: Set the request header *NAME* to the value *VAL* when making
739 HTTP requests (for example, when a URL is given on the
740 command line, or when resources used in a document must be
743Options affecting specific writers
744----------------------------------
748: Produce a standalone HTML file with no external dependencies, using
749 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
750 images, and videos. The resulting file should be "self-contained,"
751 in the sense that it needs no external files and no net access to be
752 displayed properly by a browser. This option works only with HTML output
753 formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
754 `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
755 stylesheets at absolute URLs will be downloaded; those at relative URLs
756 will be sought relative to the working directory (if the first source
757 file is local) or relative to the base URL (if the first source
758 file is remote). Elements with the attribute
759 `data-external="1"` will be left alone; the documents they
760 link to will not be incorporated in the document.
761 Limitation: resources that are loaded dynamically through
762 JavaScript cannot be incorporated; as a result,
763 `--self-contained` does not work with `--mathjax`, and some
764 advanced features (e.g. zoom or speaker notes) may not work
765 in an offline "self-contained" `reveal.js` slide show.
769: Use `<q>` tags for quotes in HTML.
773: Use only ASCII characters in output. Currently supported only for
774 HTML and DocBook output (which uses numerical entities instead of
775 UTF-8 when this option is selected).
779: Use reference-style links, rather than inline links, in writing Markdown
780 or reStructuredText. By default inline links are used. The
781 placement of link references is affected by the
782 `--reference-location` option.
784`--reference-location = block`|`section`|`document`
786: Specify whether footnotes (and references, if `reference-links` is
787 set) are placed at the end of the current (top-level) block, the
788 current section, or the document. The default is
789 `document`. Currently only affects the markdown writer.
793: Use ATX-style headers in Markdown and AsciiDoc output. The default is
794 to use setext-style headers for levels 1-2, and then ATX headers.
796`--top-level-division=[default|section|chapter|part]`
798: Treat top-level headers as the given division type in LaTeX, ConTeXt,
799 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
800 all headers are shifted such that the top-level header becomes the specified
801 type. The default behavior is to determine the best division type via
802 heuristics: unless other conditions apply, `section` is chosen. When the
803 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
804 `article` option is specified), `chapter` is implied as the setting for this
805 option. If `beamer` is the output format, specifying either `chapter` or
806 `part` will cause top-level headers to become `\part{..}`, while
807 second-level headers remain as their default type.
809`-N`, `--number-sections`
811: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
812 By default, sections are not numbered. Sections with class
813 `unnumbered` will never be numbered, even if `--number-sections`
816`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
818: Offset for section headings in HTML output (ignored in other
819 output formats). The first number is added to the section number for
820 top-level headers, the second for second-level headers, and so on.
821 So, for example, if you want the first top-level header in your
822 document to be numbered "6", specify `--number-offset=5`.
823 If your document starts with a level-2 header which you want to
824 be numbered "1.5", specify `--number-offset=1,4`.
825 Offsets are 0 by default. Implies `--number-sections`.
829: Use the [`listings`] package for LaTeX code blocks
833: Make list items in slide shows display incrementally (one by one).
834 The default is for lists to be displayed all at once.
836`--slide-level=`*NUMBER*
838: Specifies that headers with the specified level create
839 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
840 above this level in the hierarchy are used to divide the
841 slide show into sections; headers below this level create
842 subheads within a slide. Note that content that is
843 not contained under slide-level headers will not appear in
844 the slide show. The default is to set the slide level based
845 on the contents of the document; see [Structuring the slide
850: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
851 and attach identifiers to the enclosing `<div>` (or `<section>`)
852 rather than the header itself. See
853 [Header identifiers], below.
855`--email-obfuscation=none`|`javascript`|`references`
857: Specify a method for obfuscating `mailto:` links in HTML documents.
858 `none` leaves `mailto:` links as they are. `javascript` obfuscates
859 them using JavaScript. `references` obfuscates them by printing their
860 letters as decimal or hexadecimal character references. The default
863`--id-prefix=`*STRING*
865: Specify a prefix to be added to all identifiers and internal links
866 in HTML and DocBook output, and to footnote numbers in Markdown
867 and Haddock output. This is useful for preventing duplicate
868 identifiers when generating fragments to be included in other pages.
870`-T` *STRING*, `--title-prefix=`*STRING*
872: Specify *STRING* as a prefix at the beginning of the title
873 that appears in the HTML header (but not in the title as it
874 appears at the beginning of the HTML body). Implies
877`-c` *URL*, `--css=`*URL*
879: Link to a CSS style sheet. This option can be used repeatedly to
880 include multiple files. They will be included in the order specified.
882 A stylesheet is required for generating EPUB. If none is
883 provided using this option (or the `stylesheet` metadata
884 field), pandoc will look for a file `epub.css` in the
885 user data directory (see `--data-dir`). If it is not
886 found there, sensible defaults will be used.
888`--reference-doc=`*FILE*
890: Use the specified file as a style reference in producing a
895 : For best results, the reference docx should be a modified
896 version of a docx file produced using pandoc. The contents
897 of the reference docx are ignored, but its stylesheets and
898 document properties (including margins, page size, header,
899 and footer) are used in the new docx. If no reference docx
900 is specified on the command line, pandoc will look for a
901 file `reference.docx` in the user data directory (see
902 `--data-dir`). If this is not found either, sensible
903 defaults will be used.
905 To produce a custom `reference.docx`, first get a copy of
906 the default `reference.docx`: `pandoc
907 --print-default-data-file reference.docx >
908 custom-reference.docx`. Then open `custom-reference.docx`
909 in Word, modify the styles as you wish, and save the file.
910 For best results, do not make changes to this file other
911 than modifying the styles used by pandoc: [paragraph]
912 Normal, Body Text, First Paragraph, Compact, Title,
913 Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
914 Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
915 Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
916 Definition Term, Definition, Caption, Table Caption,
917 Image Caption, Figure, Captioned Figure, TOC Heading;
918 [character] Default Paragraph Font, Body Text Char,
919 Verbatim Char, Footnote Reference, Hyperlink; [table]
924 : For best results, the reference ODT should be a modified
925 version of an ODT produced using pandoc. The contents of
926 the reference ODT are ignored, but its stylesheets are used
927 in the new ODT. If no reference ODT is specified on the
928 command line, pandoc will look for a file `reference.odt` in
929 the user data directory (see `--data-dir`). If this is not
930 found either, sensible defaults will be used.
932 To produce a custom `reference.odt`, first get a copy of
933 the default `reference.odt`: `pandoc
934 --print-default-data-file reference.odt >
935 custom-reference.odt`. Then open `custom-reference.odt` in
936 LibreOffice, modify the styles as you wish, and save the
939`--epub-cover-image=`*FILE*
941: Use the specified image as the EPUB cover. It is recommended
942 that the image be less than 1000px in width and height. Note that
943 in a Markdown source document you can also specify `cover-image`
944 in a YAML metadata block (see [EPUB Metadata], below).
946`--epub-metadata=`*FILE*
948: Look in the specified XML file for metadata for the EPUB.
949 The file should contain a series of [Dublin Core elements].
952 <dc:rights>Creative Commons</dc:rights>
953 <dc:language>es-AR</dc:language>
955 By default, pandoc will include the following metadata elements:
956 `<dc:title>` (from the document title), `<dc:creator>` (from the
957 document authors), `<dc:date>` (from the document date, which should
958 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
959 variable, or, if is not set, the locale), and `<dc:identifier
960 id="BookId">` (a randomly generated UUID). Any of these may be
961 overridden by elements in the metadata file.
963 Note: if the source document is Markdown, a YAML metadata block
964 in the document can be used instead. See below under
967`--epub-embed-font=`*FILE*
969: Embed the specified font in the EPUB. This option can be repeated
970 to embed multiple fonts. Wildcards can also be used: for example,
971 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
972 line, be sure to escape them or put the whole filename in single quotes,
973 to prevent them from being interpreted by the shell. To use the
974 embedded fonts, you will need to add declarations like the following
975 to your CSS (see `--css`):
978 font-family: DejaVuSans;
981 src:url("DejaVuSans-Regular.ttf");
984 font-family: DejaVuSans;
987 src:url("DejaVuSans-Bold.ttf");
990 font-family: DejaVuSans;
993 src:url("DejaVuSans-Oblique.ttf");
996 font-family: DejaVuSans;
999 src:url("DejaVuSans-BoldOblique.ttf");
1001 body { font-family: "DejaVuSans"; }
1003`--epub-chapter-level=`*NUMBER*
1005: Specify the header level at which to split the EPUB into separate
1006 "chapter" files. The default is to split into chapters at level 1
1007 headers. This option only affects the internal composition of the
1008 EPUB, not the way chapters and sections are displayed to users. Some
1009 readers may be slow if the chapter files are too large, so for large
1010 documents with few level 1 headers, one might want to use a chapter
1013`--epub-subdirectory=`*DIRNAME*
1015: Specify the subdirectory in the OCF container that is to hold
1016 the EPUB-specific contents. The default is `EPUB`. To put
1017 the EPUB contents in the top level, use an empty string.
1019`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1021: Use the specified engine when producing PDF output.
1022 The default is `pdflatex`. If the engine is not in your PATH,
1023 the full path of the engine may be specified here.
1025`--pdf-engine-opt=`*STRING*
1027: Use the given string as a command-line argument to the `pdf-engine`.
1028 If used multiple times, the arguments are provided with spaces between
1029 them. Note that no check for duplicate options is done.
1031[Dublin Core elements]: http://dublincore.org/documents/dces/
1032[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1037`--bibliography=`*FILE*
1039: Set the `bibliography` field in the document's metadata to *FILE*,
1040 overriding any value set in the metadata, and process citations
1041 using `pandoc-citeproc`. (This is equivalent to
1042 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1043 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1044 used, making this equivalent to `--metadata bibliography=FILE`.
1045 If you supply this argument multiple times, each *FILE* will be added
1050: Set the `csl` field in the document's metadata to *FILE*,
1051 overriding any value set in the metadata. (This is equivalent to
1052 `--metadata csl=FILE`.)
1053 This option is only relevant with `pandoc-citeproc`.
1055`--citation-abbreviations=`*FILE*
1057: Set the `citation-abbreviations` field in the document's metadata to
1058 *FILE*, overriding any value set in the metadata. (This is equivalent to
1059 `--metadata citation-abbreviations=FILE`.)
1060 This option is only relevant with `pandoc-citeproc`.
1064: Use [`natbib`] for citations in LaTeX output. This option is not for use
1065 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1066 use in producing a LaTeX file that can be processed with [`bibtex`].
1070: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1071 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1072 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1074Math rendering in HTML
1075----------------------
1077`-m` [*URL*], `--latexmathml`[`=`*URL*]
1079: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1080 To insert a link to a local copy of the `LaTeXMathML.js` script,
1081 provide a *URL*. If no *URL* is provided, the contents of the
1082 script will be inserted directly into the HTML header, preserving
1083 portability at the price of efficiency. If you plan to use math on
1084 several pages, it is much better to link to a copy of the script,
1085 so it can be cached.
1089: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1090 `html4` and `html5`). This is the default in `odt` output.
1094: Use [jsMath] to display embedded TeX math in HTML output.
1095 The *URL* should point to the jsMath load script (e.g.
1096 `jsMath/easy/load.js`); if provided, it will be linked to in
1097 the header of standalone HTML documents. If a *URL* is not provided,
1098 no link to the jsMath load script will be inserted; it is then
1099 up to the author to provide such a link in the HTML template.
1101`--mathjax`[`=`*URL*]
1103: Use [MathJax] to display embedded TeX math in HTML output.
1104 The *URL* should point to the `MathJax.js` load script.
1105 If a *URL* is not provided, a link to the MathJax CDN will
1110: Enclose TeX math in `<eq>` tags in HTML output. These can then
1111 be processed by [gladTeX] to produce links to images of the typeset
1114`--mimetex`[`=`*URL*]
1116: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1117 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1121: Render TeX formulas using an external script that converts TeX
1122 formulas to images. The formula will be concatenated with the URL
1123 provided. If *URL* is not specified, the CodeCogs will be used.
1124 Note: the `--webtex` option will affect Markdown output
1125 as well as HTML, which is useful if you're targeting a
1126 version of Markdown without native math support.
1130: Use [KaTeX] to display embedded TeX math in HTML output.
1131 The *URL* is the base URL for the KaTeX library. If a *URL* is
1132 not provided, a link to the KaTeX CDN will be inserted.
1133 Note: [KaTeX] seems to work best with `html5` output.
1135`--katex-stylesheet=`*URL*
1137: The *URL* should point to the `katex.css` stylesheet. If this option is
1138 not specified, a link to the KaTeX CDN will be inserted. Note that this
1139 option does not imply `--katex`.
1141[MathML]: http://www.w3.org/Math/
1142[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1143[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1144[MathJax]: https://www.mathjax.org
1145[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1146[mimeTeX]: http://www.forkosh.com/mimetex.html
1147[KaTeX]: https://github.com/Khan/KaTeX
1149Options for wrapper scripts
1150---------------------------
1154: Print information about command-line arguments to *stdout*, then exit.
1155 This option is intended primarily for use in wrapper scripts.
1156 The first line of output contains the name of the output file specified
1157 with the `-o` option, or `-` (for *stdout*) if no output file was
1158 specified. The remaining lines contain the command-line arguments,
1159 one per line, in the order they appear. These do not include regular
1160 pandoc options and their arguments, but do include any options appearing
1161 after a `--` separator at the end of the line.
1165: Ignore command-line arguments (for use in wrapper scripts).
1166 Regular pandoc options are not ignored. Thus, for example,
1168 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1172 pandoc -o foo.html -s
1177When the `-s/--standalone` option is used, pandoc uses a template to
1178add header and footer material that is needed for a self-standing
1179document. To see the default template that is used, just type
1183where *FORMAT* is the name of the output format. A custom template
1184can be specified using the `--template` option. You can also override
1185the system default templates for a given output format *FORMAT*
1186by putting a file `templates/default.*FORMAT*` in the user data
1187directory (see `--data-dir`, above). *Exceptions:*
1189- For `odt` output, customize the `default.opendocument`
1191- For `pdf` output, customize the `default.latex` template
1192 (or the `default.beamer` template, if you use `-t beamer`,
1193 or the `default.context` template, if you use `-t context`).
1194- `docx` has no template (however, you can use
1195 `--reference-doc` to customize the output).
1197Templates contain *variables*, which allow for the inclusion of
1198arbitrary information at any point in the file. Variables may be set
1199within the document using [YAML metadata blocks][Extension:
1200`yaml_metadata_block`]. They may also be set at the
1201command line using the `-V/--variable` option: variables set in this
1202way override metadata fields with the same name.
1204Variables set by pandoc
1205-----------------------
1207Some variables are set automatically by pandoc. These vary somewhat
1208depending on the output format, but include metadata fields as well
1211`sourcefile`, `outputfile`
1212: source and destination filenames, as given on the command line.
1213 `sourcefile` can also be a list if input comes from multiple files, or empty
1214 if input is from stdin. You can use the following snippet in your template
1215 to distinguish them:
1225 Similarly, `outputfile` can be `-` if output goes to the terminal.
1227`title`, `author`, `date`
1228: allow identification of basic aspects of the document. Included
1229 in PDF metadata through LaTeX and ConTeXt. These can be set
1230 through a [pandoc title block][Extension: `pandoc_title_block`],
1231 which allows for multiple authors, or through a YAML metadata block:
1240: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1241 renders in LaTeX only when using a document class that supports
1242 `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1243 `scrreprt`, `scrbook`).[^subtitle]
1246: author affiliations (in LaTeX and Beamer only). Can be a
1247 list, when there are multiple authors.
1250: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1253: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1254 may be repeated as for `author`, above
1257: contents specified by `-H/--include-in-header` (may have multiple
1261: non-null value if `--toc/--table-of-contents` was specified
1264: title of table of contents (works only with EPUB,
1265 opendocument, odt, docx)
1268: contents specified by `-B/--include-before-body` (may have
1272: contents specified by `-A/--include-after-body` (may have
1279: JSON representation of all of the document's metadata. Field
1280 values are transformed to the selected output format.
1282[^subtitle]: To make `subtitle` work with other LaTeX
1283 document classes, you can add the following to `header-includes`:
1285 \providecommand{\subtitle}[1]{%
1286 \usepackage{titling}
1288 \par\large#1\end{center}}
1295: identifies the main language of the document,
1296 using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1297 For some output formats, pandoc will convert it to an appropriate
1298 format stored in the additional variables `babel-lang`,
1299 `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1301 Native pandoc `span`s and `div`s with the lang attribute
1302 (value in BCP 47) can be used to switch the language in
1306: a list of other languages used in the document
1307 in the YAML metadata, according to [BCP 47]. For example:
1308 `otherlangs: [en-GB, fr]`.
1309 This is automatically generated from the `lang` attributes
1310 in all `span`s and `div`s but can be overridden.
1311 Currently only used by LaTeX through the generated
1312 `babel-otherlangs` and `polyglossia-otherlangs` variables.
1313 The LaTeX writer outputs polyglossia commands in the text but
1314 the `babel-newcommands` variable contains mappings for them
1315 to the corresponding babel.
1318: the base direction of the document, either `rtl` (right-to-left)
1319 or `ltr` (left-to-right).
1321 For bidirectional documents, native pandoc `span`s and `div`s
1322 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1323 override the base direction in some output formats.
1324 This may not always be necessary if the final renderer
1325 (e.g. the browser, when generating HTML) supports the
1326 [Unicode Bidirectional Algorithm].
1328 When using LaTeX for bidirectional documents, only the `xelatex` engine
1329 is fully supported (use `--pdf-engine=xelatex`).
1331[BCP 47]: https://tools.ietf.org/html/bcp47
1332[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1337Variables are available for [producing slide shows with pandoc],
1338including all [reveal.js configuration options].
1341: title graphic for Beamer documents
1344: logo for Beamer documents
1347: base URL for Slidy documents (defaults to
1348 `https://www.w3.org/Talks/Tools/Slidy2`)
1351: base URL for Slideous documents (defaults to `slideous`)
1354: base URL for S5 documents (defaults to `s5/default`)
1357: base URL for reveal.js documents (defaults to `reveal.js`)
1359`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1360: themes for LaTeX [`beamer`] documents
1363: options for LaTeX beamer themes (a list).
1366: controls navigation symbols in `beamer` documents
1367 (default is `empty` for no navigation symbols; other valid values
1368 are `frame`, `vertical`, and `horizontal`).
1371: enables on "title pages" for new sections in `beamer`
1372 documents (default = true).
1375: when true, the `beamerarticle` package is loaded (for
1376 producing an article from beamer slides).
1379: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1380 `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1381 default, and `32` for 3:2).
1383[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1388LaTeX variables are used when [creating a PDF].
1391: paper size, e.g. `letter`, `a4`
1394: font size for body text (e.g. `10pt`, `12pt`)
1397: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1400: option for document class, e.g. `oneside`; may be repeated
1401 for multiple options
1404: option for [`geometry`] package, e.g. `margin=1in`;
1405 may be repeated for multiple options
1407`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1408: sets margins, if `geometry` is not used (otherwise `geometry`
1412: adjusts line spacing using the [`setspace`]
1413 package, e.g. `1.25`, `1.5`
1416: font package for use with `pdflatex`:
1417 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1418 The default is [Latin Modern][`lm`].
1421: options for package used as `fontfamily`: e.g. `osf,sc` with
1422 `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1423 figures and true small caps; may be repeated for multiple options
1425`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1426: font families for use with `xelatex` or
1427 `lualatex`: take the name of any system font, using the
1428 [`fontspec`] package. Note that if `CJKmainfont` is used,
1429 the [`xecjk`] package must be available.
1431`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1432: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1433 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1434 available through [`fontspec`], such as the OpenType features
1435 `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1438: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1439 default is `T1` (see guide to [LaTeX font encodings])
1442: options to pass to the microtype package
1445: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1446 `urlcolor`, or `toccolor` are set
1448`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1449: color for internal links, citation links, external links, and links in table of contents:
1450 uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1453: causes links to be printed as footnotes
1456: uses document class settings for indentation (the default LaTeX template
1457 otherwise removes indentation and adds space between paragraphs)
1460: disables default behavior of LaTeX template that redefines (sub)paragraphs
1461 as sections, changing the appearance of nested headings in some classes
1464: specifies contents of acknowledgments footnote after document title.
1467: include table of contents (can also be set using `--toc/--table-of-contents`)
1470: level of section to include in table of contents
1473: numbering depth for sections, if sections are numbered
1476: include list of figures, list of tables
1479: bibliography to use for resolving references
1482: bibliography style, when used with `--natbib` and `--biblatex`.
1485: bibliography title, when used with `--natbib` and `--biblatex`.
1488: list of options for biblatex.
1491: list of options for natbib.
1493[`article`]: https://ctan.org/pkg/article
1494[`report`]: https://ctan.org/pkg/report
1495[`book`]: https://ctan.org/pkg/book
1496[KOMA-Script]: https://ctan.org/pkg/koma-script
1497[`memoir`]: https://ctan.org/pkg/memoir
1498[`xcolor`]: https://ctan.org/pkg/xcolor
1499[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1500[`mathpazo`]: https://ctan.org/pkg/mathpazo
1501[LaTeX font encodings]: https://ctan.org/pkg/encguide
1503Variables for ConTeXt
1504---------------------
1507: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1508 may be repeated for multiple options
1511: options for page margins and text arrangement (see [ConTeXt Layout]);
1512 may be repeated for multiple options
1514`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1515: sets margins, if `layout` is not used (otherwise `layout`
1519: font size for body text (e.g. `10pt`, `12pt`)
1521`mainfont`, `sansfont`, `monofont`, `mathfont`
1522: font families: take the name of any system font (see [ConTeXt Font Switching])
1524`linkcolor`, `contrastcolor`
1525: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1528: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1531: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1532 may be repeated for multiple options
1535: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1538: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1539 may be repeated for multiple options
1541`headertext`, `footertext`
1542: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1543 may be repeated up to four times for different placement
1546: page number style and location (using [`setuppagenumbering`]);
1547 may be repeated for multiple options
1550: include table of contents (can also be set using `--toc/--table-of-contents`)
1553: include list of figures, list of tables
1555[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1556[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1557[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1558[ConTeXt Color]: http://wiki.contextgarden.net/Color
1559[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1560[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1561[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1562[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1563[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1565Variables for man pages
1566-----------------------
1569: section number in man pages
1572: header in man pages
1575: footer in man pages
1578: adjusts text to left (`l`), right (`r`), center (`c`),
1579 or both (`b`) margins
1582: if `true` (the default), hyphenation will be used
1588: point size (e.g. `10p`)
1591: line height (e.g. `12p`)
1594: font family (e.g. `T` or `P`)
1597: paragraph indent (e.g. `2m`)
1599Using variables in templates
1600----------------------------
1602Variable names are sequences of alphanumerics, `-`, and `_`,
1603starting with a letter. A variable name surrounded by `$` signs
1604will be replaced by its value. For example, the string `$title$` in
1606 <title>$title$</title>
1608will be replaced by the document title.
1610To write a literal `$` in a template, use `$$`.
1612Templates may contain conditionals. The syntax is as follows:
1620This will include `X` in the template if `variable` has a non-null
1621value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1622any valid template text, and may include interpolated variables or other
1623conditionals. The `$else$` section may be omitted.
1625When variables can have multiple values (for example, `author` in
1626a multi-author document), you can use the `$for$` keyword:
1629 <meta name="author" content="$author$" />
1632You can optionally specify a separator to be used between
1635 $for(author)$$author$$sep$, $endfor$
1637A dot can be used to select a field of a variable that takes
1638an object as its value. So, for example:
1640 $author.name$ ($author.affiliation$)
1642If you use custom templates, you may need to revise them as pandoc
1643changes. We recommend tracking the changes in the default templates,
1644and modifying your custom templates accordingly. An easy way to do this
1645is to fork the [pandoc-templates] repository and merge in changes after each
1648Templates may contain comments: anything on a line after `$--`
1649will be treated as a comment and ignored.
1651[pandoc-templates]: https://github.com/jgm/pandoc-templates
1656Pandoc understands an extended and slightly revised version of
1657John Gruber's [Markdown] syntax. This document explains the syntax,
1658noting differences from standard Markdown. Except where noted, these
1659differences can be suppressed by using the `markdown_strict` format instead
1660of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1661to the format name and disabled by adding `-EXTENSION`. For example,
1662`markdown_strict+footnotes` is strict Markdown with footnotes
1663enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1664Markdown without footnotes or pipe tables.
1669Markdown is designed to be easy to write, and, even more importantly,
1672> A Markdown-formatted document should be publishable as-is, as plain
1673> text, without looking like it's been marked up with tags or formatting
1675> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
1677This principle has guided pandoc's decisions in finding syntax for
1678tables, footnotes, and other extensions.
1680There is, however, one respect in which pandoc's aims are different
1681from the original aims of Markdown. Whereas Markdown was originally
1682designed with HTML generation in mind, pandoc is designed for multiple
1683output formats. Thus, while pandoc allows the embedding of raw HTML,
1684it discourages it, and provides other, non-HTMLish ways of representing
1685important document elements like definition lists, tables, mathematics, and
1691A paragraph is one or more lines of text followed by one or more blank lines.
1692Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1693If you need a hard line break, put two or more spaces at the end of a line.
1695#### Extension: `escaped_line_breaks` ####
1697A backslash followed by a newline is also a hard line break.
1698Note: in multiline and grid table cells, this is the only way
1699to create a hard line break, since trailing spaces in the cells
1705There are two kinds of headers: Setext and ATX.
1707### Setext-style headers ###
1709A setext-style header is a line of text "underlined" with a row of `=` signs
1710(for a level one header) or `-` signs (for a level two header):
1718The header text can contain inline formatting, such as emphasis (see
1719[Inline formatting], below).
1722### ATX-style headers ###
1724An ATX-style header consists of one to six `#` signs and a line of
1725text, optionally followed by any number of `#` signs. The number of
1726`#` signs at the beginning of the line is the header level:
1728 ## A level-two header
1730 ### A level-three header ###
1732As with setext-style headers, the header text can contain formatting:
1734 # A level-one header with a [link](/url) and *emphasis*
1736#### Extension: `blank_before_header` ####
1738Standard Markdown syntax does not require a blank line before a header.
1739Pandoc does require this (except, of course, at the beginning of the
1740document). The reason for the requirement is that it is all too easy for a
1741`#` to end up at the beginning of a line by accident (perhaps through line
1742wrapping). Consider, for example:
1744 I like several of their flavors of ice cream:
1745 #22, for example, and #5.
1747#### Extension: `space_in_atx_header` ####
1749Many Markdown implementations do not require a space between the
1750opening `#`s of an ATX header and the header text, so that
1751`#5 bolt` and `#hashtag` count as headers. With this extension,
1752pandoc does require the space.
1754### Header identifiers ###
1756#### Extension: `header_attributes` ####
1758Headers can be assigned attributes using this syntax at the end
1759of the line containing the header text:
1761 {#identifier .class .class key=value key=value}
1763Thus, for example, the following headers will all be assigned the identifier
1768 ## My header ## {#foo}
1770 My other header {#foo}
1773(This syntax is compatible with [PHP Markdown Extra].)
1775Note that although this syntax allows assignment of classes and key/value
1776attributes, writers generally don't use all of this information. Identifiers,
1777classes, and key/value attributes are used in HTML and HTML-based formats such
1778as EPUB and slidy. Identifiers are used for labels and link anchors in the
1779LaTeX, ConTeXt, Textile, and AsciiDoc writers.
1781Headers with the class `unnumbered` will not be numbered, even if
1782`--number-sections` is specified. A single hyphen (`-`) in an attribute
1783context is equivalent to `.unnumbered`, and preferable in non-English
1790 # My header {.unnumbered}
1792#### Extension: `auto_identifiers` ####
1794A header without an explicitly specified identifier will be
1795automatically assigned a unique identifier based on the header text.
1796To derive the identifier from the header text,
1798 - Remove all formatting, links, etc.
1799 - Remove all footnotes.
1800 - Remove all punctuation, except underscores, hyphens, and periods.
1801 - Replace all spaces and newlines with hyphens.
1802 - Convert all alphabetic characters to lowercase.
1803 - Remove everything up to the first letter (identifiers may
1804 not begin with a number or punctuation mark).
1805 - If nothing is left after this, use the identifier `section`.
1810 ------------------------------- ----------------------------
1811 `Header identifiers in HTML` `header-identifiers-in-html`
1812 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1813 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1814 `3. Applications` `applications`
1817These rules should, in most cases, allow one to determine the identifier
1818from the header text. The exception is when several headers have the
1819same text; in this case, the first will get an identifier as described
1820above; the second will get the same identifier with `-1` appended; the
1821third with `-2`; and so on.
1823These identifiers are used to provide link targets in the table of
1824contents generated by the `--toc|--table-of-contents` option. They
1825also make it easy to provide links from one section of a document to
1826another. A link to this section, for example, might look like this:
1829 [header identifiers](#header-identifiers-in-html-latex-and-context).
1831Note, however, that this method of providing links to sections works
1832only in HTML, LaTeX, and ConTeXt formats.
1834If the `--section-divs` option is specified, then each section will
1835be wrapped in a `div` (or a `section`, if `html5` was specified),
1836and the identifier will be attached to the enclosing `<div>`
1837(or `<section>`) tag rather than the header itself. This allows entire
1838sections to be manipulated using JavaScript or treated differently in
1841#### Extension: `implicit_header_references` ####
1843Pandoc behaves as if reference links have been defined for each header.
1844So, to link to a header
1846 # Header identifiers in HTML
1850 [Header identifiers in HTML]
1854 [Header identifiers in HTML][]
1858 [the section on header identifiers][header identifiers in
1861instead of giving the identifier explicitly:
1863 [Header identifiers in HTML](#header-identifiers-in-html)
1865If there are multiple headers with identical text, the corresponding
1866reference will link to the first one only, and you will need to use explicit
1867links to link to the others, as described above.
1869Like regular reference links, these references are case-insensitive.
1871Explicit link reference definitions always take priority over
1872implicit header references. So, in the following example, the
1873link will point to `bar`, not to `#foo`:
1884Markdown uses email conventions for quoting blocks of text.
1885A block quotation is one or more paragraphs or other block elements
1886(such as lists or headers), with each line preceded by a `>` character
1887and an optional space. (The `>` need not start at the left margin, but
1888it should not be indented more than three spaces.)
1890 > This is a block quote. This
1891 > paragraph has two lines.
1893 > 1. This is a list inside a block quote.
1896A "lazy" form, which requires the `>` character only on the first
1897line of each block, is also allowed:
1899 > This is a block quote. This
1900 paragraph has two lines.
1902 > 1. This is a list inside a block quote.
1905Among the block elements that can be contained in a block quote are
1906other block quotes. That is, block quotes can be nested:
1908 > This is a block quote.
1910 > > A block quote within a block quote.
1912If the `>` character is followed by an optional space, that space
1913will be considered part of the block quote marker and not part of
1914the indentation of the contents. Thus, to put an indented code
1915block in a block quote, you need five spaces after the `>`:
1919#### Extension: `blank_before_blockquote` ####
1921Standard Markdown syntax does not require a blank line before a block
1922quote. Pandoc does require this (except, of course, at the beginning of the
1923document). The reason for the requirement is that it is all too easy for a
1924`>` to end up at the beginning of a line by accident (perhaps through line
1925wrapping). So, unless the `markdown_strict` format is used, the following does
1926not produce a nested block quote in pandoc:
1928 > This is a block quote.
1932Verbatim (code) blocks
1933----------------------
1935### Indented code blocks ###
1937A block of text indented four spaces (or one tab) is treated as verbatim
1938text: that is, special characters do not trigger special formatting,
1939and all spaces and line breaks are preserved. For example,
1942 moveShip(5 * gravity, DOWN);
1945The initial (four space or one tab) indentation is not considered part
1946of the verbatim text, and is removed in the output.
1948Note: blank lines in the verbatim text need not begin with four spaces.
1951### Fenced code blocks ###
1953#### Extension: `fenced_code_blocks` ####
1955In addition to standard indented code blocks, pandoc supports
1956*fenced* code blocks. These begin with a row of three or more
1957tildes (`~`) and end with a row of tildes that must be at least as long as
1958the starting row. Everything between these lines is treated as code. No
1959indentation is necessary:
1963 moveShip(5 * gravity, DOWN);
1967Like regular code blocks, fenced code blocks must be separated
1968from surrounding text by blank lines.
1970If the code itself contains a row of tildes or backticks, just use a longer
1971row of tildes or backticks at the start and end:
1975 code including tildes
1979#### Extension: `backtick_code_blocks` ####
1981Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
1984#### Extension: `fenced_code_attributes` ####
1986Optionally, you may attach attributes to fenced or backtick code block using
1989 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
1991 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
1992 qsort (filter (>= x) xs)
1993 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1995Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1996`startFrom` is an attribute with value `100`. Some output formats can use this
1997information to do syntax highlighting. Currently, the only output formats
1998that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
1999is supported for your output format and language, then the code block above
2000will appear highlighted, with numbered lines. (To see which languages are
2001supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2002block above will appear as follows:
2004 <pre id="mycode" class="haskell numberLines" startFrom="100">
2010A shortcut form can also be used for specifying the language of
2017This is equivalent to:
2023If the `fenced_code_attributes` extension is disabled, but
2024input contains class attribute(s) for the code block, the first
2025class attribute will be printed after the opening fence as a bare
2028To prevent all highlighting, use the `--no-highlight` flag.
2029To set the highlighting style, use `--highlight-style`.
2030For more information on highlighting, see [Syntax highlighting],
2036#### Extension: `line_blocks` ####
2038A line block is a sequence of lines beginning with a vertical bar (`|`)
2039followed by a space. The division into lines will be preserved in
2040the output, as will any leading spaces; otherwise, the lines will
2041be formatted as Markdown. This is useful for verse and addresses:
2043 | The limerick packs laughs anatomical
2044 | In space that is quite economical.
2045 | But the good ones I've seen
2046 | So seldom are clean
2047 | And the clean ones so seldom are comical
2050 | Berkeley, CA 94718
2052The lines can be hard-wrapped if needed, but the continuation
2053line must begin with a space.
2055 | The Right Honorable Most Venerable and Righteous Samuel L.
2058 | Berkeley, CA 94718
2060This syntax is borrowed from [reStructuredText].
2067A bullet list is a list of bulleted list items. A bulleted list
2068item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2075This will produce a "compact" list. If you want a "loose" list, in which
2076each item is formatted as a paragraph, put spaces between the items:
2084The bullets need not be flush with the left margin; they may be
2085indented one, two, or three spaces. The bullet must be followed
2088List items look best if subsequent lines are flush with the first
2089line (after the bullet):
2095But Markdown also allows a "lazy" format:
2101### Block content in list items ###
2103A list item may contain multiple paragraphs and other block-level
2104content. However, subsequent paragraphs must be preceded by a blank line
2105and indented to line up with the first non-space content after
2112 * Second paragraph. With a code block, which must be indented
2117Exception: if the list marker is followed by an indented code
2118block, which must begin 5 spaces after the list marker, then
2119subsequent paragraphs must begin two columns after the last
2120character of the list marker:
2124 continuation paragraph
2126List items may include other lists. In this case the preceding blank
2127line is optional. The nested list must be indented to line up with
2128the first non-space character after the list marker of the
2129containing list item.
2141As noted above, Markdown allows you to write list items "lazily," instead of
2142indenting continuation lines. However, if there are multiple paragraphs or
2143other blocks in a list item, the first line of each must be indented.
2145 + A lazy, lazy, list
2148 + Another one; this looks
2151 Second paragraph of second
2154### Ordered lists ###
2156Ordered lists work just like bulleted lists, except that the items
2157begin with enumerators rather than bullets.
2159In standard Markdown, enumerators are decimal numbers followed
2160by a period and a space. The numbers themselves are ignored, so
2161there is no difference between this list:
2173#### Extension: `fancy_lists` ####
2175Unlike standard Markdown, pandoc allows ordered list items to be marked
2176with uppercase and lowercase letters and roman numerals, in addition to
2177Arabic numerals. List markers may be enclosed in parentheses or followed by a
2178single right-parentheses or period. They must be separated from the
2179text that follows by at least one space, and, if the list marker is a
2180capital letter with a period, by at least two spaces.[^2]
2182[^2]: The point of this rule is to ensure that normal paragraphs
2183 starting with people's initials, like
2185 B. Russell was an English philosopher.
2187 do not get treated as list items.
2189 This rule will not prevent
2193 from being interpreted as a list item. In this case, a backslash
2198The `fancy_lists` extension also allows '`#`' to be used as an
2199ordered list marker in place of a numeral:
2204#### Extension: `startnum` ####
2206Pandoc also pays attention to the type of list marker used, and to the
2207starting number, and both of these are preserved where possible in the
2208output format. Thus, the following yields a list with numbers followed
2209by a single parenthesis, starting with 9, and a sublist with lowercase
2219Pandoc will start a new list each time a different type of list
2220marker is used. So, the following will create three lists:
2227If default list markers are desired, use `#.`:
2234### Definition lists ###
2236#### Extension: `definition_lists` ####
2238Pandoc supports definition lists, using the syntax of
2239[PHP Markdown Extra] with some extensions.[^3]
2245 Term 2 with *inline markup*
2249 { some code, part of Definition 2 }
2251 Third paragraph of definition 2.
2253Each term must fit on one line, which may optionally be followed by
2254a blank line, and must be followed by one or more definitions.
2255A definition begins with a colon or tilde, which may be indented one
2258A term may have multiple definitions, and each definition may consist of one or
2259more block elements (paragraph, code block, list, etc.), each indented four
2260spaces or one tab stop. The body of the definition (including the first line,
2261aside from the colon or tilde) should be indented four spaces. However,
2262as with other Markdown lists, you can "lazily" omit indentation except
2263at the beginning of a paragraph or other block element:
2268 with lazy continuation.
2270 Second paragraph of the definition.
2272If you leave space before the definition (as in the example above),
2273the text of the definition will be treated as a paragraph. In some
2274output formats, this will mean greater spacing between term/definition
2275pairs. For a more compact definition list, omit the space before the
2285Note that space between items in a definition list is required.
2286(A variant that loosens this requirement, but disallows "lazy"
2287hard wrapping, can be activated with `compact_definition_lists`: see
2288[Non-pandoc extensions], below.)
2290[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2292### Numbered example lists ###
2294#### Extension: `example_lists` ####
2296The special list marker `@` can be used for sequentially numbered
2297examples. The first list item with a `@` marker will be numbered '1',
2298the next '2', and so on, throughout the document. The numbered examples
2299need not occur in a single list; each new list using `@` will take up
2300where the last stopped. So, for example:
2302 (@) My first example will be numbered (1).
2303 (@) My second example will be numbered (2).
2305 Explanation of examples.
2307 (@) My third example will be numbered (3).
2309Numbered examples can be labeled and referred to elsewhere in the
2312 (@good) This is a good example.
2314 As (@good) illustrates, ...
2316The label can be any string of alphanumeric characters, underscores,
2320### Compact and loose lists ###
2322Pandoc behaves differently from `Markdown.pl` on some "edge
2323cases" involving lists. Consider this source:
2333Pandoc transforms this into a "compact list" (with no `<p>` tags around
2334"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2335"Second" and "Third" (but not "First"), because of the blank space
2336around "Third". Pandoc follows a simple rule: if the text is followed by
2337a blank line, it is treated as a paragraph. Since "Second" is followed
2338by a list, and not a blank line, it isn't treated as a paragraph. The
2339fact that the list is followed by a blank line is irrelevant. (Note:
2340Pandoc works this way even when the `markdown_strict` format is specified. This
2341behavior is consistent with the official Markdown syntax description,
2342even though it is different from that of `Markdown.pl`.)
2345### Ending a list ###
2347What if you want to put an indented code block after a list?
2354Trouble! Here pandoc (like other Markdown implementations) will treat
2355`{ my code block }` as the second paragraph of item two, and not as
2358To "cut off" the list after item two, you can insert some non-indented
2359content, like an HTML comment, which won't produce visible output in
2365 <!-- end of list -->
2369You can use the same trick if you want two consecutive lists instead
2385A line containing a row of three or more `*`, `-`, or `_` characters
2386(optionally separated by spaces) produces a horizontal rule:
2396Four kinds of tables may be used. The first three kinds presuppose the use of
2397a fixed-width font, such as Courier. The fourth kind can be used with
2398proportionally spaced fonts, as it does not require lining up columns.
2400#### Extension: `table_captions` ####
2402A caption may optionally be provided with all 4 kinds of tables (as
2403illustrated in the examples below). A caption is a paragraph beginning
2404with the string `Table:` (or just `:`), which will be stripped off.
2405It may appear either before or after the table.
2407#### Extension: `simple_tables` ####
2409Simple tables look like this:
2411 Right Left Center Default
2412 ------- ------ ---------- -------
2417 Table: Demonstration of simple table syntax.
2419The headers and table rows must each fit on one line. Column
2420alignments are determined by the position of the header text relative
2421to the dashed line below it:[^4]
2423 - If the dashed line is flush with the header text on the right side
2424 but extends beyond it on the left, the column is right-aligned.
2425 - If the dashed line is flush with the header text on the left side
2426 but extends beyond it on the right, the column is left-aligned.
2427 - If the dashed line extends beyond the header text on both sides,
2428 the column is centered.
2429 - If the dashed line is flush with the header text on both sides,
2430 the default alignment is used (in most cases, this will be left).
2432[^4]: This scheme is due to Michel Fortin, who proposed it on the
2433 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2435The table must end with a blank line, or a line of dashes followed by
2438The column headers may be omitted, provided a dashed line is used
2439to end the table. For example:
2441 ------- ------ ---------- -------
2445 ------- ------ ---------- -------
2447When headers are omitted, column alignments are determined on the basis
2448of the first line of the table body. So, in the tables above, the columns
2449would be right, left, center, and right aligned, respectively.
2451#### Extension: `multiline_tables` ####
2453Multiline tables allow headers and table rows to span multiple lines
2454of text (but cells that span multiple columns or rows of the table are
2455not supported). Here is an example:
2457 -------------------------------------------------------------
2458 Centered Default Right Left
2459 Header Aligned Aligned Aligned
2460 ----------- ------- --------------- -------------------------
2461 First row 12.0 Example of a row that
2462 spans multiple lines.
2464 Second row 5.0 Here's another one. Note
2465 the blank line between
2467 -------------------------------------------------------------
2469 Table: Here's the caption. It, too, may span
2472These work like simple tables, but with the following differences:
2474 - They must begin with a row of dashes, before the header text
2475 (unless the headers are omitted).
2476 - They must end with a row of dashes, then a blank line.
2477 - The rows must be separated by blank lines.
2479In multiline tables, the table parser pays attention to the widths of
2480the columns, and the writers try to reproduce these relative widths in
2481the output. So, if you find that one of the columns is too narrow in the
2482output, try widening it in the Markdown source.
2484Headers may be omitted in multiline tables as well as simple tables:
2486 ----------- ------- --------------- -------------------------
2487 First row 12.0 Example of a row that
2488 spans multiple lines.
2490 Second row 5.0 Here's another one. Note
2491 the blank line between
2493 ----------- ------- --------------- -------------------------
2495 : Here's a multiline table without headers.
2497It is possible for a multiline table to have just one row, but the row
2498should be followed by a blank line (and then the row of dashes that ends
2499the table), or the table may be interpreted as a simple table.
2501#### Extension: `grid_tables` ####
2503Grid tables look like this:
2505 : Sample grid table.
2507 +---------------+---------------+--------------------+
2508 | Fruit | Price | Advantages |
2509 +===============+===============+====================+
2510 | Bananas | $1.34 | - built-in wrapper |
2511 | | | - bright color |
2512 +---------------+---------------+--------------------+
2513 | Oranges | $2.10 | - cures scurvy |
2515 +---------------+---------------+--------------------+
2517The row of `=`s separates the header from the table body, and can be
2518omitted for a headerless table. The cells of grid tables may contain
2519arbitrary block elements (multiple paragraphs, code blocks, lists,
2520etc.). Cells that span multiple columns or rows are not
2521supported. Grid tables can be created easily using [Emacs table mode].
2523[Emacs table mode]: http://table.sourceforge.net/
2525Alignments can be specified as with pipe tables, by putting
2526colons at the boundaries of the separator line after the
2529 +---------------+---------------+--------------------+
2530 | Right | Left | Centered |
2531 +==============:+:==============+:==================:+
2532 | Bananas | $1.34 | built-in wrapper |
2533 +---------------+---------------+--------------------+
2535For headerless tables, the colons go on the top line instead:
2537 +--------------:+:--------------+:------------------:+
2538 | Right | Left | Centered |
2539 +---------------+---------------+--------------------+
2541##### Grid Table Limitations #####
2543Pandoc does not support grid tables with row spans or column spans.
2544This means that neither variable numbers of columns across rows nor
2545variable numbers of rows across columns are supported by Pandoc.
2546All grid tables must have the same number of columns in each row,
2547and the same number of rows in each column. For example, the
2548Docutils [sample grid tables] will not render as expected with
2551[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
2554#### Extension: `pipe_tables` ####
2556Pipe tables look like this:
2558 | Right | Left | Default | Center |
2559 |------:|:-----|---------|:------:|
2560 | 12 | 12 | 12 | 12 |
2561 | 123 | 123 | 123 | 123 |
2564 : Demonstration of pipe table syntax.
2566The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2567ending pipe characters are optional, but pipes are required between all
2568columns. The colons indicate column alignment as shown. The header
2569cannot be omitted. To simulate a headerless table, include a header
2572Since the pipes indicate column boundaries, columns need not be vertically
2573aligned, as they are in the above example. So, this is a perfectly
2574legal (though ugly) pipe table:
2582The cells of pipe tables cannot contain block elements like paragraphs
2583and lists, and cannot span multiple lines. If a pipe table contains a
2584row whose printable content is wider than the column width (see
2585`--columns`), then the cell contents will wrap, with the
2586relative cell widths determined by the widths of the separator
2589Note: pandoc also recognizes pipe tables of the following
2590form, as can be produced by Emacs' orgtbl-mode:
2597The difference is that `+` is used instead of `|`. Other orgtbl features
2598are not supported. In particular, to get non-default column alignment,
2599you'll need to add colons as above.
2601[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2606#### Extension: `pandoc_title_block` ####
2608If the file begins with a title block
2611 % author(s) (separated by semicolons)
2614it will be parsed as bibliographic information, not regular text. (It
2615will be used, for example, in the title of standalone LaTeX or HTML
2616output.) The block may contain just a title, a title and an author,
2617or all three elements. If you want to include an author but no
2618title, or a title and a date but no author, you need a blank line:
2627The title may occupy multiple lines, but continuation lines must
2628begin with leading space, thus:
2633If a document has multiple authors, the authors may be put on
2634separate lines with leading space, or separated by semicolons, or
2635both. So, all of the following are equivalent:
2640 % Author One; Author Two
2645The date must fit on one line.
2647All three metadata fields may contain standard inline formatting
2648(italics, links, footnotes, etc.).
2650Title blocks will always be parsed, but they will affect the output only
2651when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2652will appear twice: once in the document head -- this is the title that
2653will appear at the top of the window in a browser -- and once at the
2654beginning of the document body. The title in the document head can have
2655an optional prefix attached (`--title-prefix` or `-T` option). The title
2656in the body appears as an H1 element with class "title", so it can be
2657suppressed or reformatted with CSS. If a title prefix is specified with
2658`-T` and no title block appears in the document, the title prefix will
2659be used by itself as the HTML title.
2661The man page writer extracts a title, man page section number, and
2662other header and footer information from the title line. The title
2663is assumed to be the first word on the title line, which may optionally
2664end with a (single-digit) section number in parentheses. (There should
2665be no space between the title and the parentheses.) Anything after
2666this is assumed to be additional footer and header text. A single pipe
2667character (`|`) should be used to separate the footer text from the header
2672will yield a man page with the title `PANDOC` and section 1.
2674 % PANDOC(1) Pandoc User Manuals
2676will also have "Pandoc User Manuals" in the footer.
2678 % PANDOC(1) Pandoc User Manuals | Version 4.0
2680will also have "Version 4.0" in the header.
2682#### Extension: `yaml_metadata_block` ####
2684A YAML metadata block is a valid YAML object, delimited by a line of three
2685hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2686(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2687document, but if it is not at the beginning, it must be preceded by a blank
2688line. (Note that, because of the way pandoc concatenates input files when
2689several are provided, you may also keep the metadata in a separate YAML file
2690and pass it to pandoc as an argument, along with your Markdown files:
2692 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2694Just be sure that the YAML file begins with `---` and ends with `---` or
2697Metadata will be taken from the fields of the YAML object and added to any
2698existing document metadata. Metadata can contain lists and objects (nested
2699arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2700with names ending in an underscore will be ignored by pandoc. (They may be
2701given a role by external processors.)
2703A document may contain multiple metadata blocks. The metadata fields will
2704be combined through a *left-biased union*: if two metadata blocks attempt
2705to set the same field, the value from the first block will be taken.
2707When pandoc is used with `-t markdown` to create a Markdown document,
2708a YAML metadata block will be produced only if the `-s/--standalone`
2709option is used. All of the metadata will appear in a single block
2710at the beginning of the document.
2712Note that YAML escaping rules must be followed. Thus, for example,
2713if a title contains a colon, it must be quoted. The pipe character
2714(`|`) can be used to begin an indented block that will be interpreted
2715literally, without need for escaping. This form is necessary
2716when the field contains blank lines or block-level formatting:
2719 title: 'This is the title: it contains a colon'
2723 tags: [nothing, nothingness]
2725 This is the abstract.
2727 It consists of two paragraphs.
2730Template variables will be set automatically from the metadata. Thus, for
2731example, in writing HTML, the variable `abstract` will be set to the HTML
2732equivalent of the Markdown in the `abstract` field:
2734 <p>This is the abstract.</p>
2735 <p>It consists of two paragraphs.</p>
2737Variables can contain arbitrary YAML structures, but the template must match
2738this structure. The `author` variable in the default templates expects a
2739simple list or string, but can be changed to support more complicated
2740structures. The following combination, for example, would add an affiliation
2741to the author if one is given:
2744 title: The document title
2747 affiliation: University of Somewhere
2749 affiliation: University of Nowhere
2752To use the structured authors in the example above, you would need a custom
2757 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
2767#### Extension: `all_symbols_escapable` ####
2769Except inside a code block or inline code, any punctuation or space
2770character preceded by a backslash will be treated literally, even if it
2771would normally indicate formatting. Thus, for example, if one writes
2781 <strong>hello</strong>
2783This rule is easier to remember than standard Markdown's rule,
2784which allows only the following characters to be backslash-escaped:
2788(However, if the `markdown_strict` format is used, the standard Markdown rule
2791A backslash-escaped space is parsed as a nonbreaking space. It will
2792appear in TeX output as `~` and in HTML and XML as `\ ` or
2795A backslash-escaped newline (i.e. a backslash occurring at the end of
2796a line) is parsed as a hard line break. It will appear in TeX output as
2797`\\` and in HTML as `<br />`. This is a nice alternative to
2798Markdown's "invisible" way of indicating hard line breaks using
2799two trailing spaces on a line.
2801Backslash escapes do not work in verbatim contexts.
2808To *emphasize* some text, surround it with `*`s or `_`, like this:
2810 This text is _emphasized with underscores_, and this
2811 is *emphasized with asterisks*.
2813Double `*` or `_` produces **strong emphasis**:
2815 This is **strong emphasis** and __with underscores__.
2817A `*` or `_` character surrounded by spaces, or backslash-escaped,
2818will not trigger emphasis:
2820 This is * not emphasized *, and \*neither is this\*.
2822#### Extension: `intraword_underscores` ####
2824Because `_` is sometimes used inside words and identifiers,
2825pandoc does not interpret a `_` surrounded by alphanumeric
2826characters as an emphasis marker. If you want to emphasize
2827just part of a word, use `*`:
2829 feas*ible*, not feas*able*.
2834#### Extension: `strikeout` ####
2836To strikeout a section of text with a horizontal line, begin and end it
2837with `~~`. Thus, for example,
2839 This ~~is deleted text.~~
2842### Superscripts and subscripts ###
2844#### Extension: `superscript`, `subscript` ####
2846Superscripts may be written by surrounding the superscripted text by `^`
2847characters; subscripts may be written by surrounding the subscripted
2848text by `~` characters. Thus, for example,
2850 H~2~O is a liquid. 2^10^ is 1024.
2852If the superscripted or subscripted text contains spaces, these spaces
2853must be escaped with backslashes. (This is to prevent accidental
2854superscripting and subscripting through the ordinary use of `~` and `^`.)
2855Thus, if you want the letter P with 'a cat' in subscripts, use
2856`P~a\ cat~`, not `P~a cat~`.
2861To make a short span of text verbatim, put it inside backticks:
2863 What is the difference between `>>=` and `>>`?
2865If the verbatim text includes a backtick, use double backticks:
2867 Here is a literal backtick `` ` ``.
2869(The spaces after the opening backticks and before the closing
2870backticks will be ignored.)
2872The general rule is that a verbatim span starts with a string
2873of consecutive backticks (optionally followed by a space)
2874and ends with a string of the same number of backticks (optionally
2875preceded by a space).
2877Note that backslash-escapes (and other Markdown constructs) do not
2878work in verbatim contexts:
2880 This is a backslash followed by an asterisk: `\*`.
2882#### Extension: `inline_code_attributes` ####
2884Attributes can be attached to verbatim text, just as with
2885[fenced code blocks]:
2891To write small caps, use the `smallcaps` class:
2893 [Small caps]{.smallcaps}
2895Or, without the `bracketed_spans` extension:
2897 <span class="smallcaps">Small caps</span>
2899For compatibility with other Markdown flavors, CSS is also supported:
2901 <span style="font-variant:small-caps;">Small caps</span>
2903This will work in all output formats that support small caps.
2909#### Extension: `tex_math_dollars` ####
2911Anything between two `$` characters will be treated as TeX math. The
2912opening `$` must have a non-space character immediately to its right,
2913while the closing `$` must have a non-space character immediately to its
2914left, and must not be followed immediately by a digit. Thus,
2915`$20,000 and $30,000` won't parse as math. If for some reason
2916you need to enclose text in literal `$` characters, backslash-escape
2917them and they won't be treated as math delimiters.
2919TeX math will be printed in all output formats. How it is rendered
2920depends on the output format:
2922Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2923 ~ It will appear verbatim between `$` characters.
2926 ~ It will be rendered using an [interpreted text role `:math:`].
2929 ~ It will be rendered as `latexmath:[...]`.
2932 ~ It will be rendered inside a `@math` command.
2935 ~ It will be rendered verbatim without `$`'s.
2938 ~ It will be rendered inside `<math>` tags.
2941 ~ It will be rendered inside `<span class="math">` tags.
2944 ~ It will be rendered, if possible, using Unicode characters,
2945 and will otherwise appear verbatim.
2948 ~ It will be rendered, if possible, using MathML.
2951 ~ If the `--mathml` flag is used, it will be rendered using MathML
2952 in an `inlineequation` or `informalequation` tag. Otherwise it
2953 will be rendered, if possible, using Unicode characters.
2956 ~ It will be rendered using OMML math markup.
2959 ~ If the `--webtex` option is used, formulas are rendered as images
2960 using CodeCogs or other compatible web service, downloaded
2961 and embedded in the e-book. Otherwise, they will appear verbatim.
2963HTML, Slidy, DZSlides, S5, EPUB
2964 ~ The way math is rendered in HTML will depend on the
2965 command-line options selected:
2967 1. The default is to render TeX math as far as possible using Unicode
2968 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2969 are put inside a `span` with `class="math"`, so that they may be
2970 styled differently from the surrounding text if needed.
2972 2. If the `--latexmathml` option is used, TeX math will be displayed
2973 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2974 The [LaTeXMathML] script will be used to render it as formulas.
2975 (This trick does not work in all browsers, but it works in Firefox.
2976 In browsers that do not support LaTeXMathML, TeX math will appear
2977 verbatim between `$` characters.)
2979 3. If the `--jsmath` option is used, TeX math will be put inside
2980 `<span>` tags (for inline math) or `<div>` tags (for display math)
2981 with class `math`. The [jsMath] script will be used to render
2984 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2985 be called to generate images for each TeX formula. This should
2986 work in all browsers. The `--mimetex` option takes an optional URL
2987 as argument. If no URL is specified, it will be assumed that the
2988 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2990 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2991 in `<eq>` tags in the HTML output. The resulting `htex` file may then
2992 be processed by [gladTeX], which will produce image files for each
2993 formula and an HTML file with links to these images. So, the
2996 pandoc -s --gladtex myfile.txt -o myfile.htex
2997 gladtex -d myfile-images myfile.htex
2998 # produces myfile.html and images in myfile-images
3000 6. If the `--webtex` option is used, TeX formulas will be converted
3001 to `<img>` tags that link to an external script that converts
3002 formulas to images. The formula will be URL-encoded and concatenated
3003 with the URL provided. For SVG images you can for example use
3004 `--webtex https://latex.codecogs.com/svg.latex?`.
3005 If no URL is specified, the CodeCogs URL generating PNGs
3006 will be used (`https://latex.codecogs.com/png.latex?`).
3008 7. If the `--mathjax` option is used, TeX math will be displayed
3009 between `\(...\)` (for inline math) or `\[...\]` (for display
3010 math) and put in `<span>` tags with class `math`.
3011 The [MathJax] script will be used to render it as formulas.
3013[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3018#### Extension: `raw_html` ####
3020Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
3021(except verbatim contexts, where `<`, `>`, and `&` are interpreted
3022literally). (Technically this is not an extension, since standard
3023Markdown allows it, but it has been made an extension so that it can
3024be disabled if desired.)
3026The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3027DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3030#### Extension: `markdown_in_html_blocks` ####
3032Standard Markdown allows you to include HTML "blocks": blocks
3033of HTML between balanced tags that are separated from the surrounding text
3034with blank lines, and start and end at the left margin. Within
3035these blocks, everything is interpreted as HTML, not Markdown;
3036so (for example), `*` does not signify emphasis.
3038Pandoc behaves this way when the `markdown_strict` format is used; but
3039by default, pandoc interprets material between HTML block tags as Markdown.
3040Thus, for example, pandoc will turn
3045 <td>[a link](http://google.com)</td>
3053 <td><em>one</em></td>
3054 <td><a href="http://google.com">a link</a></td>
3058whereas `Markdown.pl` will preserve it as is.
3060There is one exception to this rule: text between `<script>` and
3061`<style>` tags is not interpreted as Markdown.
3063This departure from standard Markdown should make it easier to mix
3064Markdown with HTML block elements. For example, one can surround
3065a block of Markdown text with `<div>` tags without preventing it
3066from being interpreted as Markdown.
3068#### Extension: `native_divs` ####
3070Use native pandoc `Div` blocks for content inside `<div>` tags.
3071For the most part this should give the same output as
3072`markdown_in_html_blocks`, but it makes it easier to write pandoc
3073filters to manipulate groups of blocks.
3075#### Extension: `native_spans` ####
3077Use native pandoc `Span` blocks for content inside `<span>` tags.
3078For the most part this should give the same output as `raw_html`,
3079but it makes it easier to write pandoc filters to manipulate groups
3082#### Extension: `fenced_divs` ####
3084Allow special fenced syntax for native `Div` blocks. A Div
3085starts with a fence containing at least three consecutive
3086colons plus some attributes. The attributes may optionally
3087be followed by another string of consecutive colons.
3088The attribute syntax is exactly as in fenced code blocks (see
3089[Extension: `fenced_code_attributes`]). As with fenced
3090code blocks, one can use either attributes in curly braces
3091or a single unbraced word, which will be treated as a class
3092name. The Div ends with another line containing a string of at
3093least three consecutive colons. The fenced Div should be
3094separated by blank lines from preceding and following blocks.
3098 ::::: {#special .sidebar}
3099 Here is a paragraph.
3104Fenced divs can be nested. Opening fences are distinguished
3105because they *must* have attributes:
3111 This is a warning within a warning.
3115#### Extension: `raw_tex` ####
3117In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3118included in a document. Inline TeX commands will be preserved and passed
3119unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3120LaTeX to include BibTeX citations:
3122 This result was proved in \cite{jones.1967}.
3124Note that in LaTeX environments, like
3126 \begin{tabular}{|l|l|}\hline
3127 Age & Frequency \\ \hline
3130 36--45 & 22 \\ \hline
3133the material between the begin and end tags will be interpreted as raw
3134LaTeX, not as Markdown.
3136Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3137Emacs Org mode, and ConTeXt.
3139### Generic raw attribute ###
3141#### Extension: `raw_attribute` ####
3143Inline spans and fenced code blocks with a special
3144kind of attribute will be parsed as raw content with the
3145designated format. For example, the following produces a raw
3152And the following produces a raw `html` inline element:
3154 This is `<a>html</a>`{=html}
3156The format name should match the target format name (see
3157`-t/--to`, above, for a list, or use `pandoc
3158--list-output-formats`).
3160This extension presupposes that the relevant kind of
3161inline code or fenced code block is enabled. Thus, for
3162example, to use a raw attribute with a backtick code block,
3163`backtick_code_blocks` must be enabled.
3165The raw attribute cannot be combined with regular attributes.
3170#### Extension: `latex_macros` ####
3172For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
3173`\renewcommand` definitions and apply the resulting macros to all LaTeX
3174math. So, for example, the following will work in all output formats,
3177 \newcommand{\tuple}[1]{\langle #1 \rangle}
3181In LaTeX output, the `\newcommand` definition will simply be passed
3182unchanged to the output.
3188Markdown allows links to be specified in several ways.
3190### Automatic links ###
3192If you enclose a URL or email address in pointy brackets, it
3196 <sam@green.eggs.ham>
3200An inline link consists of the link text in square brackets,
3201followed by the URL in parentheses. (Optionally, the URL can
3202be followed by a link title, in quotes.)
3204 This is an [inline link](/url), and here's [one with
3205 a title](http://fsf.org "click here for a good time!").
3207There can be no space between the bracketed part and the parenthesized part.
3208The link text can contain formatting (such as emphasis), but the title cannot.
3210Email addresses in inline links are not autodetected, so they have to be
3211prefixed with `mailto`:
3213 [Write me!](mailto:sam@green.eggs.ham)
3215### Reference links ###
3217An *explicit* reference link has two parts, the link itself and the link
3218definition, which may occur elsewhere in the document (either
3219before or after the link).
3221The link consists of link text in square brackets, followed by a label in
3222square brackets. (There cannot be space between the two unless the
3223`spaced_reference_links` extension is enabled.) The link definition
3224consists of the bracketed label, followed by a colon and a space, followed by
3225the URL, and optionally (after a space) a link title either in quotes or in
3226parentheses. The label must not be parseable as a citation (assuming
3227the `citations` extension is enabled): citations take precedence over
3230Here are some examples:
3232 [my label 1]: /foo/bar.html "My title, optional"
3234 [my label 3]: http://fsf.org (The free software foundation)
3235 [my label 4]: /bar#special 'A title in single quotes'
3237The URL may optionally be surrounded by angle brackets:
3239 [my label 5]: <http://foo.bar.baz>
3241The title may go on the next line:
3243 [my label 3]: http://fsf.org
3244 "The free software foundation"
3246Note that link labels are not case sensitive. So, this will work:
3248 Here is [my link][FOO]
3252In an *implicit* reference link, the second pair of brackets is
3257 [my website]: http://foo.bar.baz
3259Note: In `Markdown.pl` and most other Markdown implementations,
3260reference link definitions cannot occur in nested constructions
3261such as list items or block quotes. Pandoc lifts this arbitrary
3262seeming restriction. So the following is fine in pandoc, though
3263not in most other implementations:
3269#### Extension: `shortcut_reference_links` ####
3271In a *shortcut* reference link, the second pair of brackets may
3276 [my website]: http://foo.bar.baz
3278### Internal links ###
3280To link to another section of the same document, use the automatically
3281generated identifier (see [Header identifiers]). For example:
3283 See the [Introduction](#introduction).
3287 See the [Introduction].
3289 [Introduction]: #introduction
3291Internal links are currently supported for HTML formats (including
3292HTML slide shows and EPUB), LaTeX, and ConTeXt.
3297A link immediately preceded by a `!` will be treated as an image.
3298The link text will be used as the image's alt text:
3300 
3304 [movie reel]: movie.gif
3306#### Extension: `implicit_figures` ####
3308An image with nonempty alt text, occurring by itself in a
3309paragraph, will be rendered as a figure with a caption. The
3310image's alt text will be used as the caption.
3312 
3314How this is rendered depends on the output format. Some output
3315formats (e.g. RTF) do not yet support figures. In those
3316formats, you'll just get an image in a paragraph by itself, with
3319If you just want a regular inline image, just make sure it is not
3320the only thing in the paragraph. One way to do this is to insert a
3321nonbreaking space after the image:
3323 \
3325Note that in reveal.js slide shows, an image in a paragraph
3326by itself that has the `stretch` class will fill the screen,
3327and the caption and figure tags will be omitted.
3329#### Extension: `link_attributes` ####
3331Attributes can be set on links and images:
3333 An inline {#id .class width=30 height=20px}
3334 and a reference ![image][ref] with attributes.
3336 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3338(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3339and `.class` are used.)
3341For HTML and EPUB, all attributes except `width` and `height` (but
3342including `srcset` and `sizes`) are passed through as is. The other
3343writers ignore attributes that are not supported by their output
3346The `width` and `height` attributes on images are treated specially. When
3347used without a unit, the unit is assumed to be pixels. However, any of
3348the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3349and `%`. There must not be any spaces between the number and the unit.
3353{ width=50% }
3356- Dimensions are converted to inches for output in page-based formats like
3357 LaTeX. Dimensions are converted to pixels for output in HTML-like
3358 formats. Use the `--dpi` option to specify the number of pixels per
3359 inch. The default is 96dpi.
3360- The `%` unit is generally relative to some available space.
3361 For example the above example will render to
3362 `<img href="file.jpg" style="width: 50%;" />` (HTML),
3363 `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3364 `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3365- Some output formats have a notion of a class
3366 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3367 or a unique identifier (LaTeX `\caption`), or both (HTML).
3368- When no `width` or `height` attributes are specified, the fallback
3369 is to look at the image resolution and the dpi metadata embedded in
3375#### Extension: `bracketed_spans` ####
3377A bracketed sequence of inlines, as one would use to begin
3378a link, will be treated as a span with attributes if it is
3379followed immediately by attributes:
3381 [This is *some text*]{.class key="val"}
3386#### Extension: `footnotes` ####
3388Pandoc's Markdown allows footnotes, using the following syntax:
3390 Here is a footnote reference,[^1] and another.[^longnote]
3392 [^1]: Here is the footnote.
3394 [^longnote]: Here's one with multiple blocks.
3396 Subsequent paragraphs are indented to show that they
3397 belong to the previous footnote.
3401 The whole paragraph can be indented, or just the first
3402 line. In this way, multi-paragraph footnotes work like
3403 multi-paragraph list items.
3405 This paragraph won't be part of the note, because it
3408The identifiers in footnote references may not contain spaces, tabs,
3409or newlines. These identifiers are used only to correlate the
3410footnote reference with the note itself; in the output, footnotes
3411will be numbered sequentially.
3413The footnotes themselves need not be placed at the end of the
3414document. They may appear anywhere except inside other block elements
3415(lists, block quotes, tables, etc.). Each footnote should be
3416separated from surrounding content (including other footnotes)
3419#### Extension: `inline_notes` ####
3421Inline footnotes are also allowed (though, unlike regular notes,
3422they cannot contain multiple paragraphs). The syntax is as follows:
3424 Here is an inline note.^[Inlines notes are easier to write, since
3425 you don't have to pick an identifier and move down to type the
3428Inline and regular footnotes may be mixed freely.
3433#### Extension: `smart` ####
3435Interpret straight quotes as curly quotes, `---` as em-dashes,
3436`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3437inserted after certain abbreviations, such as "Mr." This
3438option currently affects the input formats `markdown`,
3439`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3440and the output formats `markdown`, `latex`, and `context`.
3442Note: If you are *writing* Markdown, then the `smart` extension
3443has the reverse effect: what would have been curly quotes comes
3446In LaTeX, `smart` means to use the standard TeX ligatures
3447for quotation marks (` `` ` and ` '' ` for double quotes,
3448`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3449en-dash and `---` for em-dash). If `smart` is disabled,
3450then in reading LaTeX pandoc will parse these characters
3451literally. In writing LaTeX, enabling `smart` tells pandoc
3452to use the ligatures when possible; if `smart` is disabled
3453pandoc will use unicode quotation mark and dash characters.
3458#### Extension: `citations` ####
3460Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3461citations and a bibliography in a number of styles. Basic usage is
3463 pandoc --filter pandoc-citeproc myinput.txt
3465In order to use this feature, you will need to specify a bibliography file
3466using the `bibliography` metadata field in a YAML metadata section, or
3467`--bibliography` command line argument. You can supply multiple `--bibliography`
3468arguments or set `bibliography` metadata field to YAML array, if you want to
3469use multiple bibliography files. The bibliography may have any of these
3472 Format File extension
3473 ------------ --------------
3486Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3487use `.bibtex` to force BibTeX.
3489Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3490can produce `.json` and `.yaml` files from any of the supported formats.
3492In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3493a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
3501`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3510`<span class="nocase">...</span>`
3511: prevent a phrase from being capitalized as title case
3513`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3514and CSL YAML formats as far as possible.
3516As an alternative to specifying a bibliography file using `--bibliography`
3517or the YAML metadata field `bibliography`, you can include
3518the citation data directly in the `references` field of the
3519document's YAML metadata. The field should contain an array of
3520YAML-encoded references, for example:
3524 - type: article-journal
3536 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3538 title-short: Molecular structure of nucleic acids
3539 container-title: Nature
3543 DOI: 10.1038/171737a0
3544 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3548(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3549of the supported formats.)
3551Citations and references can be formatted using any style supported by the
3552[Citation Style Language], listed in the [Zotero Style Repository].
3553These files are specified using the `--csl` option or the `csl` metadata field.
3554By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3555format. The CSL project provides further information on [finding and editing styles].
3557To make your citations hyperlinks to the corresponding bibliography
3558entries, add `link-citations: true` to your YAML metadata.
3560Citations go inside square brackets and are separated by semicolons.
3561Each citation must have a key, composed of '@' + the citation
3562identifier from the database, and may optionally have a prefix,
3563a locator, and a suffix. The citation key must begin with a letter, digit,
3564or `_`, and may contain alphanumerics, `_`, and internal punctuation
3565characters (`:.#$%&-+?<>~/`). Here are some examples:
3567 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3569 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3571 Blah blah [@smith04; @doe99].
3573`pandoc-citeproc` detects locator terms in the [CSL locale files].
3574Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3575locale, locator terms can be written in either singular or plural forms,
3576as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3577`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3578`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3579`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3580`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3581`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3582locator term is used, "page" is assumed.
3584A minus sign (`-`) before the `@` will suppress mention of
3585the author in the citation. This can be useful when the
3586author is already mentioned in the text:
3588 Smith says blah [-@smith04].
3590You can also write an in-text citation, as follows:
3594 @smith04 [p. 33] says blah.
3596If the style calls for a list of works cited, it will be placed
3597at the end of the document. Normally, you will want to end your
3598document with an appropriate header:
3604The bibliography will be inserted after this header. Note that
3605the `unnumbered` class will be added to this header, so that the
3606section will not be numbered.
3608If you want to include items in the bibliography without actually
3609citing them in the body text, you can define a dummy `nocite` metadata
3610field and put the citations there:
3619In this example, the document will contain a citation for `item3`
3620only, but the bibliography will contain entries for `item1`, `item2`, and
3623It is possible to create a bibliography with all the citations,
3624whether or not they appear in the document, by using a wildcard:
3631For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3632to render bibliography. In order to do so, specify bibliography files as
3633outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3634invocation. Bear in mind that bibliography files have to be in respective
3635format (either BibTeX or BibLaTeX).
3637For more information, see the [pandoc-citeproc man page].
3639[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3640[Chicago Manual of Style]: http://chicagomanualofstyle.org
3641[Citation Style Language]: http://citationstyles.org
3642[Zotero Style Repository]: https://www.zotero.org/styles
3643[finding and editing styles]: http://citationstyles.org/styles/
3644[CSL locale files]: https://github.com/citation-style-language/locales
3645[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3647Non-pandoc extensions
3648---------------------
3650The following Markdown syntax extensions are not enabled by default
3651in pandoc, but may be enabled by adding `+EXTENSION` to the format
3652name, where `EXTENSION` is the name of the extension. Thus, for
3653example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3655#### Extension: `old_dashes` ####
3657Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3658`-` before a numeral is an en-dash, and `--` is an em-dash.
3659This option only has an effect if `smart` is enabled. It is
3660selected automatically for `textile` input.
3662#### Extension: `angle_brackets_escapable` ####
3664Allow `<` and `>` to be backslash-escaped, as they can be in
3665GitHub flavored Markdown but not original Markdown. This is
3666implied by pandoc's default `all_symbols_escapable`.
3668#### Extension: `lists_without_preceding_blankline` ####
3670Allow a list to occur right after a paragraph, with no intervening
3673#### Extension: `four_space_rule` ####
3675Selects the pandoc <= 2.0 behavior for parsing lists, so that
3676four spaces indent are needed for list item continuation
3679#### Extension: `spaced_reference_links` ####
3681Allow whitespace between the two components of a reference link,
3686#### Extension: `hard_line_breaks` ####
3688Causes all newlines within a paragraph to be interpreted as hard line
3689breaks instead of spaces.
3691#### Extension: `ignore_line_breaks` ####
3693Causes newlines within a paragraph to be ignored, rather than being
3694treated as spaces or as hard line breaks. This option is intended for
3695use with East Asian languages where spaces are not used between words,
3696but text is divided into lines for readability.
3698#### Extension: `east_asian_line_breaks` ####
3700Causes newlines within a paragraph to be ignored, rather than
3701being treated as spaces or as hard line breaks, when they occur
3702between two East Asian wide characters. This is a better choice
3703than `ignore_line_breaks` for texts that include a mix of East
3704Asian wide characters and other characters.
3706##### Extension: `emoji` ####
3708Parses textual emojis like `:smile:` as Unicode emoticons.
3710#### Extension: `tex_math_single_backslash` ####
3712Causes anything between `\(` and `\)` to be interpreted as inline
3713TeX math, and anything between `\[` and `\]` to be interpreted
3714as display TeX math. Note: a drawback of this extension is that
3715it precludes escaping `(` and `[`.
3717#### Extension: `tex_math_double_backslash` ####
3719Causes anything between `\\(` and `\\)` to be interpreted as inline
3720TeX math, and anything between `\\[` and `\\]` to be interpreted
3723#### Extension: `markdown_attribute` ####
3725By default, pandoc interprets material inside block-level tags as Markdown.
3726This extension changes the behavior so that Markdown is only parsed
3727inside block-level tags if the tags have the attribute `markdown=1`.
3729#### Extension: `mmd_title_block` ####
3731Enables a [MultiMarkdown] style title block at the top of
3732the document, for example:
3736 Date: September 1, 2008
3737 Comment: This is a sample mmd title block, with
3738 a field spanning multiple lines.
3740See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3741`yaml_metadata_block` is enabled, it will take precedence over
3744#### Extension: `abbreviations` ####
3746Parses PHP Markdown Extra abbreviation keys, like
3748 *[HTML]: Hypertext Markup Language
3750Note that the pandoc document model does not support
3751abbreviations, so if this extension is enabled, abbreviation keys are
3752simply skipped (as opposed to being parsed as paragraphs).
3754#### Extension: `autolink_bare_uris` ####
3756Makes all absolute URIs into links, even when not surrounded by
3757pointy braces `<...>`.
3759#### Extension: `ascii_identifiers` ####
3761Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3762Accents are stripped off of accented Latin letters, and non-Latin
3765#### Extension: `mmd_link_attributes` ####
3767Parses multimarkdown style key-value attributes on link
3768and image references. This extension should not be confused with the
3769[`link_attributes`](#extension-link_attributes) extension.
3771 This is a reference ![image][ref] with multimarkdown attributes.
3773 [ref]: http://path.to/image "Image title" width=20px height=30px
3774 id=myId class="myClass1 myClass2"
3776#### Extension: `mmd_header_identifiers` ####
3778Parses multimarkdown style header identifiers (in square brackets,
3779after the header but before any trailing `#`s in an ATX header).
3781#### Extension: `compact_definition_lists` ####
3783Activates the definition list syntax of pandoc 1.12.x and earlier.
3784This syntax differs from the one described above under [Definition lists]
3787 - No blank line is required between consecutive items of the
3789 - To get a "tight" or "compact" list, omit space between consecutive
3790 items; the space between a term and its definition does not affect
3792 - Lazy wrapping of paragraphs is not allowed: the entire definition must
3793 be indented four spaces.[^6]
3795[^6]: To see why laziness is incompatible with relaxing the requirement
3796 of a blank line between items, consider the following example:
3803 Is this a single list item with two definitions of "bar," the first of
3804 which is lazily wrapped, or two list items? To remove the ambiguity
3805 we must either disallow lazy wrapping or require a blank line between
3811In addition to pandoc's extended Markdown, the following Markdown
3812variants are supported:
3814`markdown_phpextra` (PHP Markdown Extra)
3815: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3816 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3817 `header_attributes`, `link_attributes`, `abbreviations`,
3818 `shortcut_reference_links`, `spaced_reference_links`.
3820`markdown_github` (deprecated GitHub-Flavored Markdown)
3821: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
3822 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3823 `space_in_atx_header`, `intraword_underscores`, `strikeout`,
3824 `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
3825 `lists_without_preceding_blankline`.
3827`markdown_mmd` (MultiMarkdown)
3828: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3829 `tex_math_double_backslash`, `intraword_underscores`,
3830 `mmd_title_block`, `footnotes`, `definition_lists`,
3831 `all_symbols_escapable`, `implicit_header_references`,
3832 `auto_identifiers`, `mmd_header_identifiers`,
3833 `shortcut_reference_links`, `implicit_figures`,
3834 `superscript`, `subscript`, `backtick_code_blocks`,
3835 `spaced_reference_links`, `raw_attribute`.
3837`markdown_strict` (Markdown.pl)
3838: `raw_html`, `shortcut_reference_links`,
3839 `spaced_reference_links`.
3841We also support `gfm` (GitHub-Flavored Markdown) as a set of
3842extensions on `commonmark`:
3844: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3845 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3846 `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3847 `shortcut_reference_links`, `angle_brackets_escapable`.
3849 These can all be individually disabled. Note, however, that
3850 `commonmark` and `gfm` have limited support for extensions:
3851 extensions other than those listed above (and `smart`) will have
3852 no effect on `commonmark` or `gfm`.
3854Extensions with formats other than Markdown
3855-------------------------------------------
3857Some of the extensions discussed above can be used with formats
3860* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3861 and `textile` input (and is used by default).
3863* `tex_math_dollars`, `tex_math_single_backslash`, and
3864 `tex_math_double_backslash` can be used with `html` input.
3865 (This is handy for reading web pages formatted using MathJax,
3868Producing slide shows with pandoc
3869=================================
3871You can use pandoc to produce an HTML + JavaScript slide presentation
3872that can be viewed via a web browser. There are five ways to do this,
3873using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3874You can also produce a PDF slide show using LaTeX [`beamer`].
3876Here's the Markdown source for a simple slide show, `habits.txt`:
3903 
3910To produce an HTML/JavaScript slide show, simply type
3912 pandoc -t FORMAT -s habits.txt -o habits.html
3914where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3916For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3917`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3918assumed to be available at the relative path `s5/default` (for S5), `slideous`
3919(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3920`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3921`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3922above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3925With all HTML slide formats, the `--self-contained` option can be used to
3926produce a single file that contains all of the data necessary to display the
3927slide show, including linked scripts, stylesheets, images, and videos.
3929To produce a PDF slide show using beamer, type
3931 pandoc -t beamer habits.txt -o habits.pdf
3933Note that a reveal.js slide show can also be converted to a PDF
3934by printing it to a file from the browser.
3936Structuring the slide show
3937--------------------------
3939By default, the *slide level* is the highest header level in
3940the hierarchy that is followed immediately by content, and not another
3941header, somewhere in the document. In the example above, level 1 headers
3942are always followed by level 2 headers, which are followed by content,
3943so 2 is the slide level. This default can be overridden using
3944the `--slide-level` option.
3946The document is carved up into slides according to the following
3949 * A horizontal rule always starts a new slide.
3951 * A header at the slide level always starts a new slide.
3953 * Headers *below* the slide level in the hierarchy create
3954 headers *within* a slide.
3956 * Headers *above* the slide level in the hierarchy create
3957 "title slides," which just contain the section title
3958 and help to break the slide show into sections.
3960 * Content *above* the slide level will not appear in the slide
3963 * A title page is constructed automatically from the document's title
3964 block, if present. (In the case of beamer, this can be disabled
3965 by commenting out some lines in the default template.)
3967These rules are designed to support many different styles of slide show. If
3968you don't care about structuring your slides into sections and subsections,
3969you can just use level 1 headers for all each slide. (In that case, level 1
3970will be the slide level.) But you can also structure the slide show into
3971sections, as in the example above.
3973Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3974layout will be produced, with level 1 headers building horizontally
3975and level 2 headers building vertically. It is not recommended that
3976you use deeper nesting of section levels with reveal.js.
3981By default, these writers produce lists that display "all at once."
3982If you want your lists to display incrementally (one item at a time),
3983use the `-i` option. If you want a particular list to depart from the
3984default (that is, to display incrementally without the `-i` option and
3985all at once with the `-i` option), put it in a block quote:
3990In this way incremental and nonincremental lists can be mixed in
3996You can add "pauses" within a slide by including a paragraph containing
3997three dots, separated by spaces:
3999 # Slide with a pause
4001 content before the pause
4005 content after the pause
4010You can change the style of HTML slides by putting customized CSS files
4011in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
4012or `$DATADIR/slideous` (for Slideous),
4013where `$DATADIR` is the user data directory (see `--data-dir`, above).
4014The originals may be found in pandoc's system data directory (generally
4015`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
4016files it does not find in the user data directory.
4018For dzslides, the CSS is included in the HTML file itself, and may
4021All [reveal.js configuration options] can be set through variables.
4022For example, themes can be used by setting the `theme` variable:
4026Or you can specify a custom stylesheet using the `--css` option.
4028To style beamer slides, you can specify a `theme`, `colortheme`,
4029`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
4031 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4033Note that header attributes will turn into slide attributes
4034(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4035to style individual slides. In beamer, the only header attribute
4036that affects slides is the `allowframebreaks` class, which sets the
4037`allowframebreaks` option, causing multiple slides to be created
4038if the content overfills the frame. This is recommended especially for
4041 # References {.allowframebreaks}
4046reveal.js has good support for speaker notes. You can add notes to your
4047Markdown document thus:
4053 - It can contain Markdown
4058To show the notes window, press `s` while viewing the presentation.
4059Notes are not yet supported for other slide formats, but the notes
4060will not appear on the slides themselves.
4065To put material in side by side columns, you can use a native
4066div container with class `columns`, containing two or more div
4067containers with class `column` and a `width` attribute:
4069 :::::::::::::: {.columns}
4070 ::: {.column width="40%"}
4073 ::: {.column width="60%"}
4078Frame attributes in beamer
4079--------------------------
4081Sometimes it is necessary to add the LaTeX `[fragile]` option to
4082a frame in beamer (for example, when using the `minted` environment).
4083This can be forced by adding the `fragile` class to the header
4084introducing the slide:
4086 # Fragile slide {.fragile}
4088All of the other frame attributes described in Section 8.1 of
4089the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4090`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4093Creating EPUBs with pandoc
4094==========================
4099EPUB metadata may be specified using the `--epub-metadata` option, but
4100if the source document is Markdown, it is better to use a [YAML metadata
4101block][Extension: `yaml_metadata_block`]. Here is an example:
4108 text: An investigation of metadata
4116 text: doi:10.234234.234/33
4118 rights: © 2007 John Smith, CC BY-NC
4123The following fields are recognized:
4126 ~ Either a string value or an object with fields `text` and
4127 `scheme`. Valid values for `scheme` are `ISBN-10`,
4128 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
4129 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
4130 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
4133 ~ Either a string value, or an object with fields `file-as` and
4134 `type`, or a list of such objects. Valid values for `type` are
4135 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
4138 ~ Either a string value, or an object with fields `role`, `file-as`,
4139 and `text`, or a list of such objects. Valid values for `role` are
4140 [MARC relators], but
4141 pandoc will attempt to translate the human-readable versions
4142 (like "author" and "editor") to the appropriate marc relators.
4145 ~ Same format as `creator`.
4148 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
4149 Pandoc will attempt to convert other common date formats.
4151`lang` (or legacy: `language`)
4152 ~ A string value in [BCP 47] format. Pandoc will default to the local
4153 language if nothing is specified.
4156 ~ A string value or a list of such values.
4177 ~ A string value (path to cover image).
4180 ~ A string value (path to CSS stylesheet).
4182`page-progression-direction`
4183 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
4184 attribute for the [`spine` element].
4187 ~ iBooks-specific metadata, with the following fields:
4189 - `version`: (string)
4190 - `specified-fonts`: `true`|`false` (default `false`)
4191 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
4192 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
4193 - `binding`: `true`|`false` (default `true`)
4194 - `scroll-axis`: `vertical`|`horizontal`|`default`
4196[MARC relators]: http://loc.gov/marc/relators/relaterm.html
4197[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4202By default, pandoc will download linked media (including audio and
4203video) and include it in the EPUB container, yielding a completely
4204self-contained EPUB. If you want to link to external media resources
4205instead, use raw HTML in your source and add `data-external="1"` to the tag
4206with the `src` attribute. For example:
4208 <audio controls="1">
4209 <source src="http://example.com/music/toccata.mp3"
4210 data-external="1" type="audio/mpeg">
4214Literate Haskell support
4215========================
4217If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4218format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4219`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4220literate Haskell source. This means that
4222 - In Markdown input, "bird track" sections will be parsed as Haskell
4223 code rather than block quotations. Text between `\begin{code}`
4224 and `\end{code}` will also be treated as Haskell code. For
4225 ATX-style headers the character '=' will be used instead of '#'.
4227 - In Markdown output, code blocks with classes `haskell` and `literate`
4228 will be rendered using bird tracks, and block quotations will be
4229 indented one space, so they will not be treated as Haskell code.
4230 In addition, headers will be rendered setext-style (with underlines)
4231 rather than ATX-style (with '#' characters). (This is because ghc
4232 treats '#' characters in column 1 as introducing line numbers.)
4234 - In restructured text input, "bird track" sections will be parsed
4237 - In restructured text output, code blocks with class `haskell` will
4238 be rendered using bird tracks.
4240 - In LaTeX input, text in `code` environments will be parsed as
4243 - In LaTeX output, code blocks with class `haskell` will be rendered
4244 inside `code` environments.
4246 - In HTML output, code blocks with class `haskell` will be rendered
4247 with class `literatehaskell` and bird tracks.
4251 pandoc -f markdown+lhs -t html
4253reads literate Haskell source formatted with Markdown conventions and writes
4254ordinary HTML (without bird tracks).
4256 pandoc -f markdown+lhs -t html+lhs
4258writes HTML with the Haskell code in bird tracks, so it can be copied
4259and pasted as literate Haskell source.
4261Note that GHC expects the bird tracks in the first column, so indentend literate
4262code blocks (e.g. inside an itemized environment) will not be picked up by the
4268Pandoc will automatically highlight syntax in [fenced code blocks] that
4269are marked with a language name. The Haskell library [skylighting] is
4270used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4271To see a list of language names that pandoc will recognize, type
4272`pandoc --list-highlight-languages`.
4274The color scheme can be selected using the `--highlight-style` option.
4275The default color scheme is `pygments`, which imitates the default color
4276scheme used by the Python library pygments (though pygments is not actually
4277used to do the highlighting). To see a list of highlight styles,
4278type `pandoc --list-highlight-styles`.
4280To disable highlighting, use the `--no-highlight` option.
4282[skylighting]: https://github.com/jgm/skylighting
4284Custom Styles in Docx Output
4285============================
4287By default, pandoc's docx output applies a predefined set of styles for
4288blocks such as paragraphs and block quotes, and uses largely default
4289formatting (italics, bold) for inlines. This will work for most
4290purposes, especially alongside a `reference.docx` file. However, if you
4291need to apply your own styles to blocks, or match a preexisting set of
4292styles, pandoc allows you to define custom styles for blocks and text
4293using `div`s and `span`s, respectively.
4295If you define a `div` or `span` with the attribute `custom-style`,
4296pandoc will apply your specified style to the contained elements. So,
4299 <span custom-style="Emphatically">Get out,</span> he said.
4301would produce a docx file with "Get out," styled with character
4302style `Emphatically`. Similarly,
4304 Dickinson starts the poem simply:
4306 <div custom-style="Poetry">
4307 | A Bird came down the Walk---
4308 | He did not know I saw---
4311would style the two contained lines with the `Poetry` paragraph style.
4313If the styles are not yet in your reference.docx, they will be defined
4314in the output file as inheriting from normal text. If they are already
4315defined, pandoc will not alter the definition.
4317This feature allows for greatest customization in conjunction with
4318[pandoc filters]. If you want all paragraphs after block quotes to be
4319indented, you can write a filter to apply the styles necessary. If you
4320want all italics to be transformed to the `Emphasis` character style
4321(perhaps to change their color), you can write a filter which will
4322transform all italicized inlines to inlines within an `Emphasis`
4325[pandoc filters]: http://pandoc.org/filters.html
4330Pandoc can be extended with custom writers written in [lua]. (Pandoc
4331includes a lua interpreter, so lua need not be installed separately.)
4333To use a custom writer, simply specify the path to the lua script
4334in place of the output format. For example:
4336 pandoc -t data/sample.lua
4338Creating a custom writer requires writing a lua function for each
4339possible element in a pandoc document. To get a documented example
4340which you can modify according to your needs, do
4342 pandoc --print-default-data-file sample.lua
4344[lua]: http://www.lua.org
4349Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
4350under the [GPL], version 2 or greater. This software carries no
4351warranty of any kind. (See COPYRIGHT for full copyright and
4352warranty notices.) For a full list of contributors, see the file
4353AUTHORS.md in the pandoc source code.
4355[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