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.
16Pandoc can convert between numerous markup and word processing formats,
17including, but not limited to, various flavors of [Markdown], [HTML],
18[LaTeX] and [Word docx]. For the full lists of input and output formats,
19see the `--from` and `--to` [options below][General options].
20Pandoc can also produce [PDF] output: see [creating a PDF], below.
22Pandoc's enhanced version of Markdown includes syntax for [tables],
23[definition lists], [metadata blocks], [footnotes], [citations], [math],
24and much more. See below under [Pandoc's Markdown].
26Pandoc has a modular design: it consists of a set of readers, which parse
27text in a given format and produce a native representation of the document
28(an _abstract syntax tree_ or AST), and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
30or output format requires only adding a reader or writer. Users can also
31run custom [pandoc filters] to modify the intermediate AST.
33Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
35not expect perfect conversions between every format and every other.
36Pandoc attempts to preserve the structural elements of a document, but
37not formatting details such as margin size. And some document elements,
38such as complex tables, may not fit into pandoc's simple document
39model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
46If no *input-files* are specified, input is read from *stdin*.
47Output goes to *stdout* by default. For output to a file,
50 pandoc -o output.html input.txt
52By default, pandoc produces a document fragment. To produce a standalone
53document (e.g. a valid HTML file including `<head>` and `<body>`),
54use the `-s` or `--standalone` flag:
56 pandoc -s -o output.html input.txt
58For more information on how standalone documents are produced, see
61If multiple input files are given, `pandoc` will concatenate them all (with
62blank lines between them) before parsing. (Use `--file-scope` to parse files
68The format of the input and output can be specified explicitly using
69command-line options. The input format can be specified using the
70`-f/--from` option, the output format using the `-t/--to` option.
71Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
73 pandoc -f markdown -t latex hello.txt
75To convert `hello.html` from HTML to Markdown:
77 pandoc -f html -t markdown hello.html
79Supported input and output formats are listed below under [Options]
80(see `-f` for input formats and `-t` for output formats). You
81can also use `pandoc --list-input-formats` and
82`pandoc --list-output-formats` to print lists of supported
85If the input or output format is not specified explicitly, `pandoc`
86will attempt to guess it from the extensions of the filenames.
89 pandoc -o hello.tex hello.txt
91will convert `hello.txt` from Markdown to LaTeX. If no output file
92is specified (so that output goes to *stdout*), or if the output file's
93extension is unknown, the output format will default to HTML.
94If no input file is specified (so that input comes from *stdin*), or
95if the input files' extensions are unknown, the input format will
96be assumed to be Markdown.
101Pandoc uses the UTF-8 character encoding for both input and output.
102If your local character encoding is not UTF-8, you
103should pipe input and output through [`iconv`]:
105 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
107Note that in some output formats (such as HTML, LaTeX, ConTeXt,
108RTF, OPML, DocBook, and Texinfo), information about
109the character encoding is included in the document header, which
110will only be included if you use the `-s/--standalone` option.
112[`iconv`]: http://www.gnu.org/software/libiconv/
117To produce a PDF, specify an output file with a `.pdf` extension:
119 pandoc test.txt -o test.pdf
121By default, pandoc will use LaTeX to create the PDF, which requires
122that a LaTeX engine be installed (see `--pdf-engine` below).
124Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126[`weasyprint`] or [`prince`].
127To do this, specify an output file with a `.pdf` extension, as before,
128but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
131PDF output uses [variables for LaTeX] (with a LaTeX engine);
132[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
133(an HTML/CSS-to-PDF engine; `--css` also affects the output).
135To debug the PDF creation, it can be useful to look at the intermediate
136representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
137to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
139When using LaTeX, the following packages need to be available
140(they are included with all recent versions of [TeX Live]):
141[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
142[`ifxetex`], [`ifluatex`], [`listings`] (if the
143`--listings` option is used), [`fancyvrb`], [`longtable`],
144[`booktabs`], [`graphicx`] and [`grffile`] (if the document
145contains images), [`hyperref`], [`xcolor`],
146[`ulem`], [`geometry`] (with the `geometry` variable set),
147[`setspace`] (with `linestretch`), and
148[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
149the PDF engine requires [`fontspec`]. `xelatex` uses
150[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
151`dir` variable set). If the `mathspec` variable is set,
152`xelatex` will use [`mathspec`] instead of [`unicode-math`].
153The [`upquote`] and [`microtype`] packages are used if
154available, and [`csquotes`] will be used for [typography]
155if `\usepackage{csquotes}` is present in the template or
156included via `/H/--include-in-header`. The [`natbib`],
157[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
158be used for [citation rendering]. The following packages
159will be used to improve output quality if present, but
160pandoc does not require them to be present:
161[`upquote`] (for straight quotes in verbatim environments),
162[`microtype`] (for better spacing adjustments),
163[`parskip`] (for better inter-paragraph spaces),
164[`xurl`] (for better line breaks in URLs),
165[`bookmark`] (for better PDF bookmarks),
166and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
168[TeX Live]: http://www.tug.org/texlive/
169[`amsfonts`]: https://ctan.org/pkg/amsfonts
170[`amsmath`]: https://ctan.org/pkg/amsmath
171[`babel`]: https://ctan.org/pkg/babel
172[`biber`]: https://ctan.org/pkg/biber
173[`biblatex`]: https://ctan.org/pkg/biblatex
174[`bibtex`]: https://ctan.org/pkg/bibtex
175[`bidi`]: https://ctan.org/pkg/bidi
176[`bookmark`]: https://ctan.org/pkg/bookmark
177[`booktabs`]: https://ctan.org/pkg/booktabs
178[`csquotes`]: https://ctan.org/pkg/csquotes
179[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
180[`fontspec`]: https://ctan.org/pkg/fontspec
181[`footnote`]: https://ctan.org/pkg/footnote
182[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
183[`geometry`]: https://ctan.org/pkg/geometry
184[`graphicx`]: https://ctan.org/pkg/graphicx
185[`grffile`]: https://ctan.org/pkg/grffile
186[`hyperref`]: https://ctan.org/pkg/hyperref
187[`ifluatex`]: https://ctan.org/pkg/ifluatex
188[`ifxetex`]: https://ctan.org/pkg/ifxetex
189[`listings`]: https://ctan.org/pkg/listings
190[`lm`]: https://ctan.org/pkg/lm
191[`longtable`]: https://ctan.org/pkg/longtable
192[`mathspec`]: https://ctan.org/pkg/mathspec
193[`microtype`]: https://ctan.org/pkg/microtype
194[`natbib`]: https://ctan.org/pkg/natbib
195[`parskip`]: https://ctan.org/pkg/parskip
196[`polyglossia`]: https://ctan.org/pkg/polyglossia
197[`prince`]: https://www.princexml.com/
198[`setspace`]: https://ctan.org/pkg/setspace
199[`ulem`]: https://ctan.org/pkg/ulem
200[`unicode-math`]: https://ctan.org/pkg/unicode-math
201[`upquote`]: https://ctan.org/pkg/upquote
202[`weasyprint`]: http://weasyprint.org
203[`wkhtmltopdf`]: https://wkhtmltopdf.org
204[`xcolor`]: https://ctan.org/pkg/xcolor
205[`xecjk`]: https://ctan.org/pkg/xecjk
206[`xurl`]: https://ctan.org/pkg/xurl
213Instead of an input file, an absolute URI may be given. In this case
214pandoc will fetch the content using HTTP:
216 pandoc -f html -t markdown http://www.fsf.org
218It is possible to supply a custom User-Agent string or other
219header when requesting a document from a URL:
221 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
227General options {.options}
230`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
232: Specify input format. *FORMAT* can be:
235 - `commonmark` ([CommonMark] Markdown)
236 - `creole` ([Creole 1.0])
237 - `docbook` ([DocBook])
238 - `docx` ([Word docx])
239 - `dokuwiki` ([DokuWiki markup])
241 - `fb2` ([FictionBook2] e-book)
242 - `gfm` ([GitHub-Flavored Markdown]),
243 or the deprecated and less accurate `markdown_github`;
244 use [`markdown_github`](#markdown-variants) only
245 if you need extensions not supported in [`gfm`](#markdown-variants).
246 - `haddock` ([Haddock markup])
248 - `ipynb` ([Jupyter notebook])
249 - `jats` ([JATS] XML)
250 - `json` (JSON version of native AST)
252 - `markdown` ([Pandoc's Markdown])
253 - `markdown_mmd` ([MultiMarkdown])
254 - `markdown_phpextra` ([PHP Markdown Extra])
255 - `markdown_strict` (original unextended [Markdown])
256 - `mediawiki` ([MediaWiki markup])
259 - `native` (native Haskell)
262 - `org` ([Emacs Org mode])
263 - `rst` ([reStructuredText])
265 - `textile` ([Textile])
266 - `tikiwiki` ([TikiWiki markup])
267 - `twiki` ([TWiki markup])
268 - `vimwiki` ([Vimwiki])
271 Extensions can be individually enabled or disabled by
272 appending `+EXTENSION` or `-EXTENSION` to the format name.
273 See [Extensions] below, for a list of extensions and
274 their names. See `--list-input-formats` and `--list-extensions`,
277`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
279: Specify output format. *FORMAT* can be:
281 ::: {#output-formats}
282 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283 - `beamer` ([LaTeX beamer][`beamer`] slide show)
284 - `commonmark` ([CommonMark] Markdown)
285 - `context` ([ConTeXt])
286 - `docbook` or `docbook4` ([DocBook] 4)
287 - `docbook5` (DocBook 5)
288 - `docx` ([Word docx])
289 - `dokuwiki` ([DokuWiki markup])
290 - `epub` or `epub3` ([EPUB] v3 book)
292 - `fb2` ([FictionBook2] e-book)
293 - `gfm` ([GitHub-Flavored Markdown]),
294 or the deprecated and less accurate `markdown_github`;
295 use [`markdown_github`](#markdown-variants) only
296 if you need extensions not supported in [`gfm`](#markdown-variants).
297 - `haddock` ([Haddock markup])
298 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
299 - `html4` ([XHTML] 1.0 Transitional)
300 - `icml` ([InDesign ICML])
301 - `ipynb` ([Jupyter notebook])
302 - `jats` ([JATS] XML)
303 - `json` (JSON version of native AST)
306 - `markdown` ([Pandoc's Markdown])
307 - `markdown_mmd` ([MultiMarkdown])
308 - `markdown_phpextra` ([PHP Markdown Extra])
309 - `markdown_strict` (original unextended [Markdown])
310 - `mediawiki` ([MediaWiki markup])
313 - `native` (native Haskell),
314 - `odt` ([OpenOffice text document][ODT])
316 - `opendocument` ([OpenDocument])
317 - `org` ([Emacs Org mode])
318 - `plain` (plain text),
319 - `pptx` ([PowerPoint] slide show)
320 - `rst` ([reStructuredText])
321 - `rtf` ([Rich Text Format])
322 - `texinfo` ([GNU Texinfo])
323 - `textile` ([Textile])
324 - `slideous` ([Slideous] HTML and JavaScript slide show)
325 - `slidy` ([Slidy] HTML and JavaScript slide show)
326 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
327 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
328 - `s5` ([S5] HTML and JavaScript slide show)
329 - `tei` ([TEI Simple])
330 - `zimwiki` ([ZimWiki markup])
331 - the path of a custom lua writer, see [Custom writers] below
334 Note that `odt`, `docx`, and `epub` output will not be directed
335 to *stdout* unless forced with `-o -`.
337 Extensions can be individually enabled or
338 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
339 name. See [Extensions] below, for a list of extensions and their
340 names. See `--list-output-formats` and `--list-extensions`, below.
342`-o` *FILE*, `--output=`*FILE*
344: Write output to *FILE* instead of *stdout*. If *FILE* is
345 `-`, output will go to *stdout*, even if a non-textual format
346 (`docx`, `odt`, `epub2`, `epub3`) is specified.
348`--data-dir=`*DIRECTORY*
350: Specify the user data directory to search for pandoc data files.
351 If this option is not specified, the default user data directory
352 will be used. On \*nix and macOS systems this will be the `pandoc`
353 subdirectory of the XDG data directory (by default,
354 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
355 environment variable). If that directory does not exist,
356 `$HOME/.pandoc` will be used (for backwards compatibility).
357 In Windows the default user data directory is
358 `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.
399`--list-extensions`[`=`*FORMAT*]
401: List supported extensions, one per line, preceded
402 by a `+` or `-` indicating whether it is enabled by default
403 in *FORMAT*. If *FORMAT* is not specified, defaults for
404 pandoc's Markdown are given.
406`--list-highlight-languages`
408: List supported languages for syntax highlighting, one per
411`--list-highlight-styles`
413: List supported styles for syntax highlighting, one per line.
414 See `--highlight-style`.
424[Markdown]: http://daringfireball.net/projects/markdown/
425[CommonMark]: http://commonmark.org
426[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
427[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
428[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
429[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
430[S5]: http://meyerweb.com/eric/tools/s5/
431[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
432[Slideous]: http://goessner.net/articles/slideous/
433[HTML]: http://www.w3.org/html/
434[HTML5]: http://www.w3.org/TR/html5/
435[polyglot markup]: https://www.w3.org/TR/html-polyglot/
436[XHTML]: http://www.w3.org/TR/xhtml1/
437[LaTeX]: http://latex-project.org
438[`beamer`]: https://ctan.org/pkg/beamer
439[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
440[ConTeXt]: http://www.contextgarden.net/
441[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
442[DocBook]: http://docbook.org
443[JATS]: https://jats.nlm.nih.gov
444[txt2tags]: http://txt2tags.org
445[EPUB]: http://idpf.org/epub
446[OPML]: http://dev.opml.org/spec2.html
447[OpenDocument]: http://opendocument.xml.org
448[ODT]: http://en.wikipedia.org/wiki/OpenDocument
449[Textile]: http://redcloth.org/textile
450[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
451[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
452[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
453[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
454[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
455[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
456[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
457[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
458[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
459[Haskell]: https://www.haskell.org
460[GNU Texinfo]: http://www.gnu.org/software/texinfo/
461[Emacs Org mode]: http://orgmode.org
462[AsciiDoc]: http://www.methods.co.nz/asciidoc/
463[AsciiDoctor]: https://asciidoctor.org/
464[DZSlides]: http://paulrouget.com/dzslides/
465[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
466[PDF]: https://www.adobe.com/pdf/
467[reveal.js]: http://lab.hakim.se/reveal-js/
468[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
469[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
470[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
471[TEI Simple]: https://github.com/TEIC/TEI-Simple
472[Muse]: https://amusewiki.org/library/manual
473[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
474[Vimwiki]: https://vimwiki.github.io
476Reader options {.options}
479`--base-header-level=`*NUMBER*
481: Specify the base level for headers (defaults to 1).
483`--strip-empty-paragraphs`
485: *Deprecated. Use the `+empty_paragraphs` extension instead.*
486 Ignore paragraphs with no content. This option is useful
487 for converting word processing documents where users have
488 used empty paragraphs to create inter-paragraph space.
490`--indented-code-classes=`*CLASSES*
492: Specify classes to use for indented code blocks--for example,
493 `perl,numberLines` or `haskell`. Multiple classes may be separated
496`--default-image-extension=`*EXTENSION*
498: Specify a default extension to use when image paths/URLs have no
499 extension. This allows you to use the same source for formats that
500 require different kinds of images. Currently this option only affects
501 the Markdown and LaTeX readers.
505: Parse each file individually before combining for multifile
506 documents. This will allow footnotes in different files with the
507 same identifiers to work as expected. If this option is set,
508 footnotes and links will not work across files. Reading binary
509 files (docx, odt, epub) implies `--file-scope`.
511`-F` *PROGRAM*, `--filter=`*PROGRAM*
513: Specify an executable to be used as a filter transforming the
514 pandoc AST after the input is parsed and before the output is
515 written. The executable should read JSON from stdin and write
516 JSON to stdout. The JSON must be formatted like pandoc's own
517 JSON input and output. The name of the output format will be
518 passed to the filter as the first argument. Hence,
520 pandoc --filter ./caps.py -t latex
524 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
526 The latter form may be useful for debugging filters.
528 Filters may be written in any language. `Text.Pandoc.JSON`
529 exports `toJSONFilter` to facilitate writing filters in Haskell.
530 Those who would prefer to write filters in python can use the
531 module [`pandocfilters`], installable from PyPI. There are also
532 pandoc filter libraries in [PHP], [perl], and
533 [JavaScript/node.js].
535 In order of preference, pandoc will look for filters in
537 1. a specified full or relative path (executable or
540 2. `$DATADIR/filters` (executable or non-executable)
541 where `$DATADIR` is the user data directory (see
542 `--data-dir`, above).
544 3. `$PATH` (executable only)
546 Filters and lua-filters are applied in the order specified
549`--lua-filter=`*SCRIPT*
551: Transform the document in a similar fashion as JSON filters (see
552 `--filter`), but use pandoc's build-in lua filtering system. The given
553 lua script is expected to return a list of lua filters which will be
554 applied in order. Each lua filter must contain element-transforming
555 functions indexed by the name of the AST element on which the filter
556 function should be applied.
558 The `pandoc` lua module provides helper functions for element
559 creation. It is always loaded into the script's lua environment.
561 The following is an example lua script for macro-expansion:
563 function expand_hello_world(inline)
564 if inline.c == '{{helloworld}}' then
565 return pandoc.Emph{ pandoc.Str "Hello, World" }
571 return {{Str = expand_hello_world}}
573 In order of preference, pandoc will look for lua filters in
575 1. a specified full or relative path (executable or
578 2. `$DATADIR/filters` (executable or non-executable)
579 where `$DATADIR` is the user data directory (see
580 `--data-dir`, above).
582`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
584: Set the metadata field *KEY* to the value *VAL*. A value specified
585 on the command line overrides a value specified in the document
586 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
587 Values will be parsed as YAML boolean or string values. If no value is
588 specified, the value will be treated as Boolean true. Like
589 `--variable`, `--metadata` causes template variables to be set.
590 But unlike `--variable`, `--metadata` affects the metadata of the
591 underlying document (which is accessible from filters and may be
592 printed in some output formats) and metadata values will be escaped
593 when inserted into the template.
595`--metadata-file=`*FILE*
597: Read metadata from the supplied YAML (or JSON) file.
598 This option can be used with every input format, but string
599 scalars in the YAML file will always be parsed as Markdown.
600 Generally, the input will be handled the same as in
601 [YAML metadata blocks][Extension: `yaml_metadata_block`].
602 Metadata values specified inside the document, or by using `-M`,
603 overwrite values specified with this option.
605`-p`, `--preserve-tabs`
607: Preserve tabs instead of converting them to spaces (the default).
608 Note that this will only affect tabs in literal code spans and code
609 blocks; tabs in regular text will be treated as spaces.
613: Specify the number of spaces per tab (default is 4).
615`--track-changes=accept`|`reject`|`all`
617: Specifies what to do with insertions, deletions, and comments
618 produced by the MS Word "Track Changes" feature. `accept` (the
619 default), inserts all insertions, and ignores all
620 deletions. `reject` inserts all deletions and ignores
621 insertions. Both `accept` and `reject` ignore comments. `all` puts
622 in insertions, deletions, and comments, wrapped in spans with
623 `insertion`, `deletion`, `comment-start`, and `comment-end`
624 classes, respectively. The author and time of change is
625 included. `all` is useful for scripting: only accepting changes
626 from a certain reviewer, say, or before a certain date. If a
627 paragraph is inserted or deleted, `track-changes=all` produces a
628 span with the class `paragraph-insertion`/`paragraph-deletion`
629 before the affected paragraph break. This option only affects the
632`--extract-media=`*DIR*
634: Extract images and other media contained in or linked from
635 the source document to the path *DIR*, creating it if
636 necessary, and adjust the images references in the document
637 so they point to the extracted files. If the source format is
638 a binary container (docx, epub, or odt), the media is
639 extracted from the container and the original
640 filenames are used. Otherwise the media is read from the
641 file system or downloaded, and new filenames are constructed
642 based on SHA1 hashes of the contents.
644`--abbreviations=`*FILE*
646: Specifies a custom abbreviations file, with abbreviations
647 one to a line. If this option is not specified, pandoc will
648 read the data file `abbreviations` from the user data
649 directory or fall back on a system default. To see the
651 `pandoc --print-default-data-file=abbreviations`. The only
652 use pandoc makes of this list is in the Markdown reader.
653 Strings ending in a period that are found in this list will
654 be followed by a nonbreaking space, so that the period will
655 not produce sentence-ending space in formats like LaTeX.
657[`pandocfilters`]: https://github.com/jgm/pandocfilters
658[PHP]: https://github.com/vinai/pandocfilters-php
659[perl]: https://metacpan.org/pod/Pandoc::Filter
660[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
662General writer options {.options}
663----------------------
667: Produce output with an appropriate header and footer (e.g. a
668 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
669 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
670 output. For `native` output, this option causes metadata to
671 be included; otherwise, metadata is suppressed.
673`--template=`*FILE*|*URL*
675: Use the specified file as a custom template for the generated document.
676 Implies `--standalone`. See [Templates], below, for a description
677 of template syntax. If no extension is specified, an extension
678 corresponding to the writer will be added, so that `--template=special`
679 looks for `special.html` for HTML output. If the template is not
680 found, pandoc will search for it in the `templates` subdirectory of
681 the user data directory (see `--data-dir`). If this option is not used,
682 a default template appropriate for the output format will be used (see
683 `-D/--print-default-template`).
685`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
687: Set the template variable *KEY* to the value *VAL* when rendering the
688 document in standalone mode. This is generally only useful when the
689 `--template` option is used to specify a custom template, since
690 pandoc automatically sets the variables used in the default
691 templates. If no *VAL* is specified, the key will be given the
694`-D` *FORMAT*, `--print-default-template=`*FORMAT*
696: Print the system default template for an output *FORMAT*. (See `-t`
697 for a list of possible *FORMAT*s.) Templates in the user data
698 directory are ignored. This option may be used with
699 `-o`/`--output` to redirect output to a file, but
700 `-o`/`--output` must come before `--print-default-template`
703`--print-default-data-file=`*FILE*
705: Print a system default data file. Files in the user data directory
706 are ignored. This option may be used with `-o`/`--output` to
707 redirect output to a file, but `-o`/`--output` must come before
708 `--print-default-data-file` on the command line.
710`--eol=crlf`|`lf`|`native`
712: Manually specify line endings: `crlf` (Windows), `lf`
713 (macOS/Linux/UNIX), or `native` (line endings appropriate
714 to the OS on which pandoc is being run). The default is
719: Specify the dpi (dots per inch) value for conversion from pixels
720 to inch/centimeters and vice versa. The default is 96dpi.
721 Technically, the correct term would be ppi (pixels per inch).
723`--wrap=auto`|`none`|`preserve`
725: Determine how text is wrapped in the output (the source
726 code, not the rendered version). With `auto` (the default),
727 pandoc will attempt to wrap lines to the column width specified by
728 `--columns` (default 72). With `none`, pandoc will not wrap
729 lines at all. With `preserve`, pandoc will attempt to
730 preserve the wrapping from the source document (that is,
731 where there are nonsemantic newlines in the source, there
732 will be nonsemantic newlines in the output as well).
733 Automatic wrapping does not currently work in HTML output.
734 In `ipynb` output, this option affects wrapping of the
735 contents of markdown cells.
739: Specify length of lines in characters. This affects text wrapping
740 in the generated source code (see `--wrap`). It also affects
741 calculation of column widths for plain text tables (see [Tables] below).
743`--toc`, `--table-of-contents`
745: Include an automatically generated table of contents (or, in
746 the case of `latex`, `context`, `docx`, `odt`,
747 `opendocument`, `rst`, or `ms`, an instruction to create
748 one) in the output document. This option has no effect
749 unless `-s/--standalone` is used, and it has no effect
750 on `man`, `docbook4`, `docbook5`, or `jats` output.
752`--toc-depth=`*NUMBER*
754: Specify the number of section levels to include in the table
755 of contents. The default is 3 (which means that level 1, 2, and 3
756 headers will be listed in the contents).
760: Strip out HTML comments in the Markdown or Textile source,
761 rather than passing them on to Markdown, Textile or HTML
762 output as raw HTML. This does not apply to HTML comments
763 inside raw HTML blocks when the `markdown_in_html_blocks`
764 extension is not set.
768: Disables syntax highlighting for code blocks and inlines, even when
769 a language attribute is given.
771`--highlight-style=`*STYLE*|*FILE*
773: Specifies the coloring style to be used in highlighted source code.
774 Options are `pygments` (the default), `kate`, `monochrome`,
775 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
776 For more information on syntax highlighting in pandoc, see
777 [Syntax highlighting], below. See also
778 `--list-highlight-styles`.
780 Instead of a *STYLE* name, a JSON file with extension
781 `.theme` may be supplied. This will be parsed as a KDE
782 syntax highlighting theme and (if valid) used as the
785 To generate the JSON version of an existing style,
786 use `--print-highlight-style`.
788`--print-highlight-style=`*STYLE*|*FILE*
790: Prints a JSON version of a highlighting style, which can
791 be modified, saved with a `.theme` extension, and used
792 with `--highlight-style`. This option may be used with
793 `-o`/`--output` to redirect output to a file, but
794 `-o`/`--output` must come before `--print-highlight-style`
797`--syntax-definition=`*FILE*
799: Instructs pandoc to load a KDE XML syntax definition file,
800 which will be used for syntax highlighting of appropriately
801 marked code blocks. This can be used to add support for
802 new languages or to use altered syntax definitions for
805`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
807: Include contents of *FILE*, verbatim, at the end of the header.
808 This can be used, for example, to include special
809 CSS or JavaScript in HTML documents. This option can be used
810 repeatedly to include multiple files in the header. They will be
811 included in the order specified. Implies `--standalone`.
813`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
815: Include contents of *FILE*, verbatim, at the beginning of the
816 document body (e.g. after the `<body>` tag in HTML, or the
817 `\begin{document}` command in LaTeX). This can be used to include
818 navigation bars or banners in HTML documents. This option can be
819 used repeatedly to include multiple files. They will be included in
820 the order specified. Implies `--standalone`.
822`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
824: Include contents of *FILE*, verbatim, at the end of the document
825 body (before the `</body>` tag in HTML, or the
826 `\end{document}` command in LaTeX). This option can be used
827 repeatedly to include multiple files. They will be included in the
828 order specified. Implies `--standalone`.
830`--resource-path=`*SEARCHPATH*
832: List of paths to search for images and other resources.
833 The paths should be separated by `:` on Linux, UNIX, and
834 macOS systems, and by `;` on Windows. If `--resource-path`
835 is not specified, the default resource path is the working
836 directory. Note that, if `--resource-path` is specified,
837 the working directory must be explicitly listed or it
838 will not be searched. For example:
839 `--resource-path=.:test` will search the working directory
840 and the `test` subdirectory, in that order.
842 `--resource-path` only has an effect if (a) the output
843 format embeds images (for example, `docx`, `pdf`, or `html`
844 with `--self-contained`) or (b) it is used together with
847`--request-header=`*NAME*`:`*VAL*
849: Set the request header *NAME* to the value *VAL* when making
850 HTTP requests (for example, when a URL is given on the
851 command line, or when resources used in a document must be
852 downloaded). If you're behind a proxy, you also need to set
853 the environment variable `http_proxy` to `http://...`.
855Options affecting specific writers {.options}
856----------------------------------
860: Produce a standalone HTML file with no external dependencies, using
861 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
862 images, and videos. Implies `--standalone`. The resulting file should be
863 "self-contained," in the sense that it needs no external files and no net
864 access to be displayed properly by a browser. This option works only with
865 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
866 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
867 and stylesheets at absolute URLs will be downloaded; those at relative
868 URLs will be sought relative to the working directory (if the first source
869 file is local) or relative to the base URL (if the first source
870 file is remote). Elements with the attribute
871 `data-external="1"` will be left alone; the documents they
872 link to will not be incorporated in the document.
873 Limitation: resources that are loaded dynamically through
874 JavaScript cannot be incorporated; as a result,
875 `--self-contained` does not work with `--mathjax`, and some
876 advanced features (e.g. zoom or speaker notes) may not work
877 in an offline "self-contained" `reveal.js` slide show.
881: Use `<q>` tags for quotes in HTML.
885: Use only ASCII characters in output. Currently supported for XML
886 and HTML formats (which use entities instead of UTF-8 when this
887 option is selected), CommonMark, gfm, and Markdown (which use
888 entities), roff ms (which use hexadecimal escapes), and to a
889 limited degree LaTeX (which uses standard commands for accented
890 characters when possible). roff man output uses ASCII by default.
894: Use reference-style links, rather than inline links, in writing Markdown
895 or reStructuredText. By default inline links are used. The
896 placement of link references is affected by the
897 `--reference-location` option.
899`--reference-location = block`|`section`|`document`
901: Specify whether footnotes (and references, if `reference-links` is
902 set) are placed at the end of the current (top-level) block, the
903 current section, or the document. The default is
904 `document`. Currently only affects the markdown writer.
908: Use ATX-style headers in Markdown output. The default is
909 to use setext-style headers for levels 1-2, and then ATX headers.
910 (Note: for `gfm` output, ATX headers are always used.)
911 This option also affects markdown cells in `ipynb` output.
913`--top-level-division=[default|section|chapter|part]`
915: Treat top-level headers as the given division type in LaTeX, ConTeXt,
916 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
917 all headers are shifted such that the top-level header becomes the specified
918 type. The default behavior is to determine the best division type via
919 heuristics: unless other conditions apply, `section` is chosen. When the
920 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
921 `article` option is specified), `chapter` is implied as the setting for this
922 option. If `beamer` is the output format, specifying either `chapter` or
923 `part` will cause top-level headers to become `\part{..}`, while
924 second-level headers remain as their default type.
926`-N`, `--number-sections`
928: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
929 By default, sections are not numbered. Sections with class
930 `unnumbered` will never be numbered, even if `--number-sections`
933`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
935: Offset for section headings in HTML output (ignored in other
936 output formats). The first number is added to the section number for
937 top-level headers, the second for second-level headers, and so on.
938 So, for example, if you want the first top-level header in your
939 document to be numbered "6", specify `--number-offset=5`.
940 If your document starts with a level-2 header which you want to
941 be numbered "1.5", specify `--number-offset=1,4`.
942 Offsets are 0 by default. Implies `--number-sections`.
946: Use the [`listings`] package for LaTeX code blocks. The package
947 does not support multi-byte encoding for source code. To handle UTF-8
948 you would need to use a custom template. This issue is fully
949 documented here: [Encoding issue with the listings package].
953: Make list items in slide shows display incrementally (one by one).
954 The default is for lists to be displayed all at once.
956`--slide-level=`*NUMBER*
958: Specifies that headers with the specified level create
959 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
960 above this level in the hierarchy are used to divide the
961 slide show into sections; headers below this level create
962 subheads within a slide. Note that content that is
963 not contained under slide-level headers will not appear in
964 the slide show. The default is to set the slide level based
965 on the contents of the document; see [Structuring the slide
970: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
971 and attach identifiers to the enclosing `<section>` (or `<div>`)
972 rather than the header itself. See
973 [Header identifiers], below.
975`--email-obfuscation=none`|`javascript`|`references`
977: Specify a method for obfuscating `mailto:` links in HTML documents.
978 `none` leaves `mailto:` links as they are. `javascript` obfuscates
979 them using JavaScript. `references` obfuscates them by printing their
980 letters as decimal or hexadecimal character references. The default
983`--id-prefix=`*STRING*
985: Specify a prefix to be added to all identifiers and internal links
986 in HTML and DocBook output, and to footnote numbers in Markdown
987 and Haddock output. This is useful for preventing duplicate
988 identifiers when generating fragments to be included in other pages.
990`-T` *STRING*, `--title-prefix=`*STRING*
992: Specify *STRING* as a prefix at the beginning of the title
993 that appears in the HTML header (but not in the title as it
994 appears at the beginning of the HTML body). Implies
997`-c` *URL*, `--css=`*URL*
999: Link to a CSS style sheet. This option can be used repeatedly to
1000 include multiple files. They will be included in the order specified.
1002 A stylesheet is required for generating EPUB. If none is
1003 provided using this option (or the `css` or `stylesheet`
1004 metadata fields), pandoc will look for a file `epub.css` in the
1005 user data directory (see `--data-dir`). If it is not
1006 found there, sensible defaults will be used.
1008`--reference-doc=`*FILE*
1010: Use the specified file as a style reference in producing a
1015 : For best results, the reference docx should be a modified
1016 version of a docx file produced using pandoc. The contents
1017 of the reference docx are ignored, but its stylesheets and
1018 document properties (including margins, page size, header,
1019 and footer) are used in the new docx. If no reference docx
1020 is specified on the command line, pandoc will look for a
1021 file `reference.docx` in the user data directory (see
1022 `--data-dir`). If this is not found either, sensible
1023 defaults will be used.
1025 To produce a custom `reference.docx`, first get a copy of
1026 the default `reference.docx`: `pandoc
1027 -o custom-reference.docx --print-default-data-file reference.docx`.
1028 Then open `custom-reference.docx` in Word, modify the
1029 styles as you wish, and save the file. For best
1030 results, do not make changes to this file other than
1031 modifying the styles used by pandoc:
1067 - Default Paragraph Font
1070 - Footnote Reference
1079 : For best results, the reference ODT should be a modified
1080 version of an ODT produced using pandoc. The contents of
1081 the reference ODT are ignored, but its stylesheets are used
1082 in the new ODT. If no reference ODT is specified on the
1083 command line, pandoc will look for a file `reference.odt` in
1084 the user data directory (see `--data-dir`). If this is not
1085 found either, sensible defaults will be used.
1087 To produce a custom `reference.odt`, first get a copy of
1088 the default `reference.odt`: `pandoc
1089 -o custom-reference.odt --print-default-data-file reference.odt`.
1090 Then open `custom-reference.odt` in LibreOffice, modify
1091 the styles as you wish, and save the file.
1095 : Any template included with a recent install of Microsoft
1096 PowerPoint (either with `.pptx` or `.potx` extension) should
1097 work, as will most templates derived from these.
1099 The specific requirement is that the template should contain
1100 the following four layouts as its first four layouts:
1103 2. Title and Content
1107 All templates included with a recent version of MS PowerPoint
1108 will fit these criteria. (You can click on `Layout` under the
1109 `Home` menu to check.)
1111 You can also modify the default `reference.pptx`: first run
1112 `pandoc -o custom-reference.pptx --print-default-data-file
1113 reference.pptx`, and then modify `custom-reference.pptx`
1114 in MS PowerPoint (pandoc will use the first four layout
1115 slides, as mentioned above).
1117`--epub-cover-image=`*FILE*
1119: Use the specified image as the EPUB cover. It is recommended
1120 that the image be less than 1000px in width and height. Note that
1121 in a Markdown source document you can also specify `cover-image`
1122 in a YAML metadata block (see [EPUB Metadata], below).
1124`--epub-metadata=`*FILE*
1126: Look in the specified XML file for metadata for the EPUB.
1127 The file should contain a series of [Dublin Core elements].
1130 <dc:rights>Creative Commons</dc:rights>
1131 <dc:language>es-AR</dc:language>
1133 By default, pandoc will include the following metadata elements:
1134 `<dc:title>` (from the document title), `<dc:creator>` (from the
1135 document authors), `<dc:date>` (from the document date, which should
1136 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1137 variable, or, if is not set, the locale), and `<dc:identifier
1138 id="BookId">` (a randomly generated UUID). Any of these may be
1139 overridden by elements in the metadata file.
1141 Note: if the source document is Markdown, a YAML metadata block
1142 in the document can be used instead. See below under
1145`--epub-embed-font=`*FILE*
1147: Embed the specified font in the EPUB. This option can be repeated
1148 to embed multiple fonts. Wildcards can also be used: for example,
1149 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1150 line, be sure to escape them or put the whole filename in single quotes,
1151 to prevent them from being interpreted by the shell. To use the
1152 embedded fonts, you will need to add declarations like the following
1153 to your CSS (see `--css`):
1156 font-family: DejaVuSans;
1158 font-weight: normal;
1159 src:url("DejaVuSans-Regular.ttf");
1162 font-family: DejaVuSans;
1165 src:url("DejaVuSans-Bold.ttf");
1168 font-family: DejaVuSans;
1170 font-weight: normal;
1171 src:url("DejaVuSans-Oblique.ttf");
1174 font-family: DejaVuSans;
1177 src:url("DejaVuSans-BoldOblique.ttf");
1179 body { font-family: "DejaVuSans"; }
1181`--epub-chapter-level=`*NUMBER*
1183: Specify the header level at which to split the EPUB into separate
1184 "chapter" files. The default is to split into chapters at level 1
1185 headers. This option only affects the internal composition of the
1186 EPUB, not the way chapters and sections are displayed to users. Some
1187 readers may be slow if the chapter files are too large, so for large
1188 documents with few level 1 headers, one might want to use a chapter
1191`--epub-subdirectory=`*DIRNAME*
1193: Specify the subdirectory in the OCF container that is to hold
1194 the EPUB-specific contents. The default is `EPUB`. To put
1195 the EPUB contents in the top level, use an empty string.
1197`--ipynb-output=all|none|best`
1199: Determines how ipynb output cells are treated. `all` means
1200 that all of the data formats included in the original are
1201 preserved. `none` means that the contents of data cells
1202 are omitted. `best` causes pandoc to try to pick the
1203 richest data block in each output cell that is compatible
1204 with the output format. The default is `best`.
1206`--pdf-engine=`*PROGRAM*
1208: Use the specified engine when producing PDF output.
1209 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1210 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1211 and `pdfroff`. The default is `pdflatex`. If the engine is
1212 not in your PATH, the full path of the engine may be specified here.
1214`--pdf-engine-opt=`*STRING*
1216: Use the given string as a command-line argument to the `pdf-engine`.
1217 For example, to use a persistent directory `foo` for `latexmk`'s
1218 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1219 Note that no check for duplicate options is done.
1221[Dublin Core elements]: http://dublincore.org/documents/dces/
1222[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1223[Encoding issue with the listings package]:
1224 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1226Citation rendering {.options}
1229`--bibliography=`*FILE*
1231: Set the `bibliography` field in the document's metadata to *FILE*,
1232 overriding any value set in the metadata, and process citations
1233 using `pandoc-citeproc`. (This is equivalent to
1234 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1235 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1236 used, making this equivalent to `--metadata bibliography=FILE`.
1237 If you supply this argument multiple times, each *FILE* will be added
1242: Set the `csl` field in the document's metadata to *FILE*,
1243 overriding any value set in the metadata. (This is equivalent to
1244 `--metadata csl=FILE`.)
1245 This option is only relevant with `pandoc-citeproc`.
1247`--citation-abbreviations=`*FILE*
1249: Set the `citation-abbreviations` field in the document's metadata to
1250 *FILE*, overriding any value set in the metadata. (This is equivalent to
1251 `--metadata citation-abbreviations=FILE`.)
1252 This option is only relevant with `pandoc-citeproc`.
1256: Use [`natbib`] for citations in LaTeX output. This option is not for use
1257 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1258 use in producing a LaTeX file that can be processed with [`bibtex`].
1262: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1263 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1264 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1266Math rendering in HTML {.options}
1267----------------------
1269The default is to render TeX math as far as possible using Unicode characters.
1270Formulas are put inside a `span` with `class="math"`, so that they may be styled
1271differently from the surrounding text if needed. However, this gives acceptable
1272results only for basic math, usually you will want to use `--mathjax` or another
1273of the following options.
1275`--mathjax`[`=`*URL*]
1277: Use [MathJax] to display embedded TeX math in HTML output.
1278 TeX math will be put between `\(...\)` (for inline math)
1279 or `\[...\]` (for display math) and wrapped in `<span>` tags
1280 with class `math`. Then the MathJax JavaScript will render it.
1281 The *URL* should point to the `MathJax.js` load script.
1282 If a *URL* is not provided, a link to the Cloudflare CDN will
1287: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1288 `html4` and `html5`). This is the default in `odt` output. Note that
1289 currently only Firefox and Safari (and select e-book readers) natively
1294: Convert TeX formulas to `<img>` tags that link to an external script
1295 that converts formulas to images. The formula will be URL-encoded
1296 and concatenated with the URL provided. For SVG images you can for
1297 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1298 If no URL is specified, the CodeCogs URL generating PNGs
1299 will be used (`https://latex.codecogs.com/png.latex?`).
1300 Note: the `--webtex` option will affect Markdown output
1301 as well as HTML, which is useful if you're targeting a
1302 version of Markdown without native math support.
1306: Use [KaTeX] to display embedded TeX math in HTML output.
1307 The *URL* is the base URL for the KaTeX library. That directory
1308 should contain a `katex.min.js` and a `katex.min.css` file.
1309 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1313: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1314 can then be processed by [GladTeX] to produce images of the typeset
1315 formulas and an HTML file with links to these images.
1316 So, the procedure is:
1318 pandoc -s --gladtex input.md -o myfile.htex
1319 gladtex -d myfile-images myfile.htex
1320 # produces myfile.html and images in myfile-images
1322[MathML]: http://www.w3.org/Math/
1323[MathJax]: https://www.mathjax.org
1324[KaTeX]: https://github.com/Khan/KaTeX
1325[GladTeX]: http://humenda.github.io/GladTeX/
1327Options for wrapper scripts {.options}
1328---------------------------
1332: Print information about command-line arguments to *stdout*, then exit.
1333 This option is intended primarily for use in wrapper scripts.
1334 The first line of output contains the name of the output file specified
1335 with the `-o` option, or `-` (for *stdout*) if no output file was
1336 specified. The remaining lines contain the command-line arguments,
1337 one per line, in the order they appear. These do not include regular
1338 pandoc options and their arguments, but do include any options appearing
1339 after a `--` separator at the end of the line.
1343: Ignore command-line arguments (for use in wrapper scripts).
1344 Regular pandoc options are not ignored. Thus, for example,
1346 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1350 pandoc -o foo.html -s
1355When the `-s/--standalone` option is used, pandoc uses a template to
1356add header and footer material that is needed for a self-standing
1357document. To see the default template that is used, just type
1361where *FORMAT* is the name of the output format. A custom template
1362can be specified using the `--template` option. You can also override
1363the system default templates for a given output format *FORMAT*
1364by putting a file `templates/default.*FORMAT*` in the user data
1365directory (see `--data-dir`, above). *Exceptions:*
1367- For `odt` output, customize the `default.opendocument`
1369- For `pdf` output, customize the `default.latex` template
1370 (or the `default.context` template, if you use `-t context`,
1371 or the `default.ms` template, if you use `-t ms`, or the
1372 `default.html` template, if you use `-t html`).
1373- `docx` and `pptx` have no template (however, you can use
1374 `--reference-doc` to customize the output).
1376Templates contain *variables*, which allow for the inclusion of
1377arbitrary information at any point in the file. They may be set at the
1378command line using the `-V/--variable` option. If a variable is not set,
1379pandoc will look for the key in the document's metadata – which can be set
1380using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1381or with the `-M/--metadata` option.
1386`title`, `author`, `date`
1387: allow identification of basic aspects of the document. Included
1388 in PDF metadata through LaTeX and ConTeXt. These can be set
1389 through a [pandoc title block][Extension: `pandoc_title_block`],
1390 which allows for multiple authors, or through a YAML metadata block:
1399: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
1403: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
1407: list of keywords to be included in HTML, PDF, ODT, pptx, docx
1408 and AsciiDoc metadata; repeat as for `author`, above
1411: document subject, included in ODT, PDF, docx and pptx metadata
1414: document description, included in ODT, docx and pptx metadata. Some
1415 applications show this as `Comments` metadata.
1418: document category, included in docx and pptx metadata
1421any root-level string metadata, not included in ODT, docx
1422or pptx metadata is added as a *custom property*.
1423The following YAML metadata block for instance:
1426 title: 'This is the title'
1427 subtitle: "This is the subtitle"
1435 It consists of two paragraphs
1438will include `title`, `author` and `description` as standard document
1439properties and `subtitle` as a custom property when converting to docx,
1446: identifies the main language of the document using IETF language
1447 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
1448 The [Language subtag lookup] tool can look up or verify these tags.
1449 This affects most formats, and controls hyphenation in PDF output
1450 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
1452 Use native pandoc [Divs and Spans] with the `lang` attribute to
1453 switch the language:
1459 Text in the main document language (British English).
1462 > Cette citation est écrite en français canadien.
1465 More text in English. ['Zitat auf Deutsch.']{lang=de}
1468: the base script direction, either `rtl` (right-to-left)
1469 or `ltr` (left-to-right).
1471 For bidirectional documents, native pandoc `span`s and `div`s
1472 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1473 override the base direction in some output formats.
1474 This may not always be necessary if the final renderer
1475 (e.g. the browser, when generating HTML) supports the
1476 [Unicode Bidirectional Algorithm].
1478 When using LaTeX for bidirectional documents, only the `xelatex` engine
1479 is fully supported (use `--pdf-engine=xelatex`).
1481[BCP 47]: https://tools.ietf.org/html/bcp47
1482[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1483[Language subtag lookup]: https://r12a.github.io/app-subtags/
1485Variables for HTML slides
1486-------------------------
1488These affect HTML output when [producing slide shows with pandoc].
1489All [reveal.js configuration options] are available as variables.
1492: base URL for reveal.js documents (defaults to `reveal.js`)
1495: base URL for S5 documents (defaults to `s5/default`)
1498: base URL for Slidy documents (defaults to
1499 `https://www.w3.org/Talks/Tools/Slidy2`)
1502: base URL for Slideous documents (defaults to `slideous`)
1504[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1506Variables for Beamer slides
1507---------------------------
1509These variables change the appearance of PDF slides using [`beamer`].
1512: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
1513 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
1517: produce an article from Beamer slides
1520: add extra beamer option with `\setbeameroption{}`
1523: author affiliations: can be a list when there are multiple authors
1526: logo image for slides
1529: controls navigation symbols (default is `empty` for no navigation
1530 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
1533: enables "title pages" for new sections (default is true)
1535`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1539: options for LaTeX beamer themes (a list).
1542: image for title slide
1547Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1552: option for document class, e.g. `oneside`; repeat for multiple options
1555: document class: usually one of the standard classes, [`article`], [`report`],
1556 and [`book`]; the [KOMA-Script] equivalents, `scrartcl`, `scrreprt`,
1557 and `scrbook`, which default to smaller margins; or [`memoir`]
1560: option for [`geometry`] package, e.g. `margin=1in`;
1561 repeat for multiple options
1564: uses document class settings for indentation (the default LaTeX template
1565 otherwise removes indentation and adds space between paragraphs)
1568: adjusts line spacing using the [`setspace`]
1569 package, e.g. `1.25`, `1.5`
1571`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1572: sets margins if `geometry` is not used (otherwise `geometry`
1576: control `\pagestyle{}`: the default article class
1577 supports `plain` (default), `empty` (no running heads or page numbers),
1578 and `headings` (section titles in running heads)
1581: paper size, e.g. `letter`, `a4`
1584: numbering depth for sections (with `--number-sections` option
1585 or `numbersections` variable)
1588: disables default behavior of LaTeX template that redefines (sub)paragraphs
1589 as sections, changing the appearance of nested headings in some classes
1594: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1595 default is `T1` (see [LaTeX font encodings guide])
1598: font package for use with `pdflatex`:
1599 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1600 The default is [Latin Modern][`lm`].
1603: options for package used as `fontfamily`; repeat for multiple options.
1604 For example, to use the Libertine font with proportional lowercase
1605 (old-style) figures through the [`libertinus`] package:
1608 fontfamily: libertinus
1615: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1616 To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1617 such as `scrartcl` or `scrbook`.
1619`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1620: font families for use with `xelatex` or
1621 `lualatex`: take the name of any system font, using the
1622 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
1624`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1625: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1626 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1627 available through [`fontspec`]; repeat for multiple options. For example,
1628 to use the [TeX Gyre] version of Palatino with lowercase figures:
1631 mainfont: TeX Gyre Pagella
1634 - Numbers=Proportional
1638: options to pass to the microtype package
1643: add color to link text; automatically enabled if any of
1644 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
1646`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1647: color for internal links, external links, citation links, linked
1648 URLs, and links in table of contents, respectively: uses options
1649 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1653: causes links to be printed as footnotes
1658: include list of figures, list of tables
1661: contents of acknowledgments footnote after document title
1664: include table of contents (can also be set using `--toc/--table-of-contents`)
1667: level of section to include in table of contents
1669### BibLaTeX Bibliographies
1671These variables function when using BibLaTeX for [citation rendering].
1674: list of options for biblatex
1677: bibliography style, when used with `--natbib` and `--biblatex`.
1680: bibliography title, when used with `--natbib` and `--biblatex`.
1683: bibliography to use for resolving references
1686: list of options for natbib
1688[KOMA-Script]: https://ctan.org/pkg/koma-script
1689[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1690[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
1691[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
1692[`article`]: https://ctan.org/pkg/article
1693[`book`]: https://ctan.org/pkg/book
1694[`libertinus`]: https://ctan.org/pkg/libertinus
1695[`memoir`]: https://ctan.org/pkg/memoir
1696[`report`]: https://ctan.org/pkg/report
1698Variables for ConTeXt
1699---------------------
1701Pandoc uses these variables when [creating a PDF] with ConTeXt.
1704: font size for body text (e.g. `10pt`, `12pt`)
1706`headertext`, `footertext`
1707: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1708 repeat up to four times for different placement
1711: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1712 repeat for multiple options
1715: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1716 repeat for multiple options
1719: options for page margins and text arrangement (see [ConTeXt Layout]);
1720 repeat for multiple options
1722`linkcolor`, `contrastcolor`
1723: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1726: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1729: include list of figures, list of tables
1731`mainfont`, `sansfont`, `monofont`, `mathfont`
1732: font families: take the name of any system font (see [ConTeXt Font Switching])
1734`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1735: sets margins, if `layout` is not used (otherwise `layout`
1739: page number style and location (using [`setuppagenumbering`]);
1740 repeat for multiple options
1743: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1744 repeat for multiple options
1747: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1748 To successfully generate PDF/A the required ICC color profiles have to
1749 be available and the content and all included files (such as images)
1750 have to be standard conforming. The ICC profiles can be obtained
1751 from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1755: include table of contents (can also be set using `--toc/--table-of-contents`)
1758: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1760[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1761[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
1762[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
1763[ConTeXt Color]: https://wiki.contextgarden.net/Color
1764[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
1765[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
1766[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
1767[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
1768[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
1769[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1770[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
1772Variables for `wkhtmltopdf`
1773---------------------------
1775Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
1776The `--css` option also affects the output.
1778`footer-html`, `header-html`
1779: add information to the header and footer
1781`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1782: set the page margins
1785: sets the PDF paper size
1787Variables for man pages
1788-----------------------
1791: adjusts text to left (`l`), right (`r`), center (`c`),
1792 or both (`b`) margins
1795: footer in man pages
1798: header in man pages
1801: if `true` (the default), hyphenation will be used
1804: section number in man pages
1810: font family (e.g. `T` or `P`)
1813: paragraph indent (e.g. `2m`)
1816: line height (e.g. `12p`)
1819: point size (e.g. `10p`)
1824Pandoc sets these variables automatically in response to [options] or
1825document contents; users can also modify them. These vary depending
1826on the output format, and include the following:
1832: the `date` variable converted to ISO 8601 YYYY-MM-DD,
1833 included in all HTML based formats (dzslides, epub,
1834 html, html4, html5, revealjs, s5, slideous, slidy).
1835 The recognized formats for `date` are: `mm/dd/yyyy`,
1836 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
1837 (e.g. either `02 Apr 2018` or `02 April 2018`),
1838 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
1839 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
1842: contents specified by `-H/--include-in-header` (may have multiple
1846: contents specified by `-B/--include-before-body` (may have
1850: contents specified by `-A/--include-after-body` (may have
1854: JSON representation of all of the document's metadata. Field
1855 values are transformed to the selected output format.
1858: non-null value if `-N/--number-sections` was specified
1860`sourcefile`, `outputfile`
1861: source and destination filenames, as given on the command line.
1862 `sourcefile` can also be a list if input comes from multiple files, or empty
1863 if input is from stdin. You can use the following snippet in your template
1864 to distinguish them:
1874 Similarly, `outputfile` can be `-` if output goes to the terminal.
1877: non-null value if `--toc/--table-of-contents` was specified
1880: title of table of contents (works only with EPUB,
1881 opendocument, odt, docx, pptx, beamer, LaTeX)
1883Using variables in templates
1884----------------------------
1886Variable names are sequences of alphanumerics, `-`, and `_`,
1887starting with a letter. A variable name surrounded by `$` signs
1888will be replaced by its value. For example, the string `$title$` in
1890 <title>$title$</title>
1892will be replaced by the document title.
1894To write a literal `$` in a template, use `$$`.
1896Templates may contain conditionals. The syntax is as follows:
1904This will include `X` in the template if `variable` has a truthy
1905value; otherwise it will include `Y`. Here a truthy value is any
1908- a string that is not entirely white space,
1909- a non-empty array where the first value is truthy,
1910- any number (including zero),
1912- the boolean `true` (to specify the boolean `true`
1913 value using YAML metadata or the `--metadata` flag,
1914 use `true`, `True`, or `TRUE`; with the `--variable`
1915 flag, simply omit a value for the variable, e.g.
1916 `--variable draft`).
1918`X` and `Y` are placeholders for any valid template text,
1919and may include interpolated variables or other conditionals.
1920The `$else$` section may be omitted.
1922When variables can have multiple values (for example, `author` in
1923a multi-author document), you can use the `$for$` keyword:
1926 <meta name="author" content="$author$" />
1929You can optionally specify a separator to be used between
1932 $for(author)$$author$$sep$, $endfor$
1934Note that the separator needs to be specified immediately before the `$endfor`
1937A dot can be used to select a field of a variable that takes
1938an object as its value. So, for example:
1940 $author.name$ ($author.affiliation$)
1942The value of a variable will be indented to the same level as the variable.
1944If you use custom templates, you may need to revise them as pandoc
1945changes. We recommend tracking the changes in the default templates,
1946and modifying your custom templates accordingly. An easy way to do this
1947is to fork the [pandoc-templates] repository and merge in changes after each
1950Templates may contain comments: anything on a line after `$--`
1951will be treated as a comment and ignored.
1953[pandoc-templates]: https://github.com/jgm/pandoc-templates
1958The behavior of some of the readers and writers can be adjusted by
1959enabling or disabling various extensions.
1961An extension can be enabled by adding `+EXTENSION`
1962to the format name and disabled by adding `-EXTENSION`. For example,
1963`--from markdown_strict+footnotes` is strict Markdown with footnotes
1964enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
1965Markdown without footnotes or pipe tables.
1967The markdown reader and writer make by far the most use of extensions.
1968Extensions only used by them are therefore covered in the
1969section [Pandoc's Markdown] below (See [Markdown variants] for
1970`commonmark` and `gfm`.) In the following, extensions that also work
1971for other formats are covered.
1973Note that markdown extensions added to the `ipynb` format
1974affect Markdown cells in Jupyter notebooks (as do command-line
1975options like `--atx-headers`).
1980#### Extension: `smart` ####
1982Interpret straight quotes as curly quotes, `---` as em-dashes,
1983`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
1984inserted after certain abbreviations, such as "Mr."
1986This extension can be enabled/disabled for the following formats:
1989: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
1992: `markdown`, `latex`, `context`, `rst`
1994enabled by default in
1995: `markdown`, `latex`, `context` (both input and output)
1997Note: If you are *writing* Markdown, then the `smart` extension
1998has the reverse effect: what would have been curly quotes comes
2001In LaTeX, `smart` means to use the standard TeX ligatures
2002for quotation marks (` `` ` and ` '' ` for double quotes,
2003`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2004en-dash and `---` for em-dash). If `smart` is disabled,
2005then in reading LaTeX pandoc will parse these characters
2006literally. In writing LaTeX, enabling `smart` tells pandoc
2007to use the ligatures when possible; if `smart` is disabled
2008pandoc will use unicode quotation mark and dash characters.
2013#### Extension: `auto_identifiers` ####
2015A header without an explicitly specified identifier will be
2016automatically assigned a unique identifier based on the header text.
2018This extension can be enabled/disabled for the following formats:
2021: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2026enabled by default in
2029The default algorithm used to derive the identifier from the
2032 - Remove all formatting, links, etc.
2033 - Remove all footnotes.
2034 - Remove all non-alphanumeric characters,
2035 except underscores, hyphens, and periods.
2036 - Replace all spaces and newlines with hyphens.
2037 - Convert all alphabetic characters to lowercase.
2038 - Remove everything up to the first letter (identifiers may
2039 not begin with a number or punctuation mark).
2040 - If nothing is left after this, use the identifier `section`.
2045 ------------------------------- ----------------------------
2046 `Header identifiers in HTML` `header-identifiers-in-html`
2047 `Maître d'hôtel` `maître-dhôtel`
2048 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2049 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2050 `3. Applications` `applications`
2053These rules should, in most cases, allow one to determine the identifier
2054from the header text. The exception is when several headers have the
2055same text; in this case, the first will get an identifier as described
2056above; the second will get the same identifier with `-1` appended; the
2057third with `-2`; and so on.
2059(However, a different algorithm is used if
2060`gfm_auto_identifiers` is enabled; see below.)
2062These identifiers are used to provide link targets in the table of
2063contents generated by the `--toc|--table-of-contents` option. They
2064also make it easy to provide links from one section of a document to
2065another. A link to this section, for example, might look like this:
2068 [header identifiers](#header-identifiers-in-html-latex-and-context).
2070Note, however, that this method of providing links to sections works
2071only in HTML, LaTeX, and ConTeXt formats.
2073If the `--section-divs` option is specified, then each section will
2074be wrapped in a `section` (or a `div`, if `html4` was specified),
2075and the identifier will be attached to the enclosing `<section>`
2076(or `<div>`) tag rather than the header itself. This allows entire
2077sections to be manipulated using JavaScript or treated differently in
2080#### Extension: `ascii_identifiers` ####
2082Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2083Accents are stripped off of accented Latin letters, and non-Latin
2086#### Extension: `gfm_auto_identifiers` ####
2088Changes the algorithm used by `auto_identifiers` to conform to
2089GitHub's method. Spaces are converted to dashes (`-`),
2090uppercase characters to lowercase characters, and punctuation
2091characters other than `-` and `_` are removed.
2096The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2097[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2098[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2099are described in the section about Pandoc's Markdown.
2101However, they can also be used with HTML input. This is handy for
2102reading web pages formatted using MathJax, for example.
2107The following extensions (especially how they affect Markdown
2108input/output) are also described in more detail in their respective
2109sections of [Pandoc's Markdown].
2111#### Extension: `raw_html` {#raw_html}
2113When converting from HTML, parse elements to raw HTML which are not
2114representable in pandoc's AST.
2115By default, this is disabled for HTML input.
2117#### Extension: `raw_tex` {#raw_tex}
2119Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2121This extension can be enabled/disabled for the following formats
2122(in addition to `markdown`):
2125: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2126 `\eqref` only), `ipynb`
2129: `textile`, `commonmark`
2131Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2132only raw TeX in markdown cells, but data with mime type
2133`text/html` in output cells. Since the `ipynb` reader attempts
2134to preserve the richest possible outputs when several options
2135are given, you will get best results if you disable `raw_html`
2136and `raw_tex` when converting to formats like `docx` which don't
2137allow raw `html` or `tex`.
2139#### Extension: `native_divs` {#native_divs}
2141This extension is enabled by default for HTML input. This means that
2142`div`s are parsed to pandoc native elements. (Alternatively, you
2143can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2145When converting HTML to Markdown, for example, you may want to drop all
2148 pandoc -f html-native_divs-native_spans -t markdown
2150#### Extension: `native_spans` {#native_spans}
2152Analogous to `native_divs` above.
2155Literate Haskell support
2156------------------------
2158#### Extension: `literate_haskell` ####
2160Treat the document as literate Haskell source.
2162This extension can be enabled/disabled for the following formats:
2165: `markdown`, `rst`, `latex`
2168: `markdown`, `rst`, `latex`, `html`
2170If you append `+lhs` (or `+literate_haskell`) to one of the formats
2171above, pandoc will treat the document as literate Haskell source.
2174 - In Markdown input, "bird track" sections will be parsed as Haskell
2175 code rather than block quotations. Text between `\begin{code}`
2176 and `\end{code}` will also be treated as Haskell code. For
2177 ATX-style headers the character '=' will be used instead of '#'.
2179 - In Markdown output, code blocks with classes `haskell` and `literate`
2180 will be rendered using bird tracks, and block quotations will be
2181 indented one space, so they will not be treated as Haskell code.
2182 In addition, headers will be rendered setext-style (with underlines)
2183 rather than ATX-style (with '#' characters). (This is because ghc
2184 treats '#' characters in column 1 as introducing line numbers.)
2186 - In restructured text input, "bird track" sections will be parsed
2189 - In restructured text output, code blocks with class `haskell` will
2190 be rendered using bird tracks.
2192 - In LaTeX input, text in `code` environments will be parsed as
2195 - In LaTeX output, code blocks with class `haskell` will be rendered
2196 inside `code` environments.
2198 - In HTML output, code blocks with class `haskell` will be rendered
2199 with class `literatehaskell` and bird tracks.
2203 pandoc -f markdown+lhs -t html
2205reads literate Haskell source formatted with Markdown conventions and writes
2206ordinary HTML (without bird tracks).
2208 pandoc -f markdown+lhs -t html+lhs
2210writes HTML with the Haskell code in bird tracks, so it can be copied
2211and pasted as literate Haskell source.
2213Note that GHC expects the bird tracks in the first column, so indented
2214literate code blocks (e.g. inside an itemized environment) will not be
2215picked up by the Haskell compiler.
2220#### Extension: `empty_paragraphs` ####
2222Allows empty paragraphs. By default empty paragraphs are
2225This extension can be enabled/disabled for the following formats:
2231: `docx`, `odt`, `opendocument`, `html`
2233#### Extension: `styles` #### {#ext-styles}
2235When converting from docx, read all docx styles as divs (for
2236paragraph styles) and spans (for character styles) regardless
2237of whether pandoc understands the meaning of these styles.
2238This can be used with [docx custom styles](#custom-styles).
2244#### Extension: `amuse` ####
2246In the `muse` input format, this enables Text::Amuse
2247extensions to Emacs Muse markup.
2249#### Extension: `citations` {#org-citations}
2251Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2254#### Extension: `ntb` ####
2256In the `context` output format this enables the use of [Natural Tables
2257(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2258[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2259Natural tables allow more fine-grained global customization but come
2260at a performance penalty compared to extreme tables.
2266Pandoc understands an extended and slightly revised version of
2267John Gruber's [Markdown] syntax. This document explains the syntax,
2268noting differences from standard Markdown. Except where noted, these
2269differences can be suppressed by using the `markdown_strict` format instead
2270of `markdown`. Extensions can be enabled or disabled to specify the
2271behavior more granularly. They are described in the following. See also
2272[Extensions] above, for extensions that work also on other formats.
2277Markdown is designed to be easy to write, and, even more importantly,
2280> A Markdown-formatted document should be publishable as-is, as plain
2281> text, without looking like it's been marked up with tags or formatting
2283> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2285This principle has guided pandoc's decisions in finding syntax for
2286tables, footnotes, and other extensions.
2288There is, however, one respect in which pandoc's aims are different
2289from the original aims of Markdown. Whereas Markdown was originally
2290designed with HTML generation in mind, pandoc is designed for multiple
2291output formats. Thus, while pandoc allows the embedding of raw HTML,
2292it discourages it, and provides other, non-HTMLish ways of representing
2293important document elements like definition lists, tables, mathematics, and
2299A paragraph is one or more lines of text followed by one or more blank lines.
2300Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2301If you need a hard line break, put two or more spaces at the end of a line.
2303#### Extension: `escaped_line_breaks` ####
2305A backslash followed by a newline is also a hard line break.
2306Note: in multiline and grid table cells, this is the only way
2307to create a hard line break, since trailing spaces in the cells
2313There are two kinds of headers: Setext and ATX.
2315### Setext-style headers ###
2317A setext-style header is a line of text "underlined" with a row of `=` signs
2318(for a level one header) or `-` signs (for a level two header):
2326The header text can contain inline formatting, such as emphasis (see
2327[Inline formatting], below).
2330### ATX-style headers ###
2332An ATX-style header consists of one to six `#` signs and a line of
2333text, optionally followed by any number of `#` signs. The number of
2334`#` signs at the beginning of the line is the header level:
2336 ## A level-two header
2338 ### A level-three header ###
2340As with setext-style headers, the header text can contain formatting:
2342 # A level-one header with a [link](/url) and *emphasis*
2344#### Extension: `blank_before_header` ####
2346Standard Markdown syntax does not require a blank line before a header.
2347Pandoc does require this (except, of course, at the beginning of the
2348document). The reason for the requirement is that it is all too easy for a
2349`#` to end up at the beginning of a line by accident (perhaps through line
2350wrapping). Consider, for example:
2352 I like several of their flavors of ice cream:
2353 #22, for example, and #5.
2355#### Extension: `space_in_atx_header` ####
2357Many Markdown implementations do not require a space between the
2358opening `#`s of an ATX header and the header text, so that
2359`#5 bolt` and `#hashtag` count as headers. With this extension,
2360pandoc does require the space.
2362### Header identifiers ###
2364See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2366#### Extension: `header_attributes` ####
2368Headers can be assigned attributes using this syntax at the end
2369of the line containing the header text:
2371 {#identifier .class .class key=value key=value}
2373Thus, for example, the following headers will all be assigned the identifier
2378 ## My header ## {#foo}
2380 My other header {#foo}
2383(This syntax is compatible with [PHP Markdown Extra].)
2385Note that although this syntax allows assignment of classes and key/value
2386attributes, writers generally don't use all of this information. Identifiers,
2387classes, and key/value attributes are used in HTML and HTML-based formats such
2388as EPUB and slidy. Identifiers are used for labels and link anchors in the
2389LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2391Headers with the class `unnumbered` will not be numbered, even if
2392`--number-sections` is specified. A single hyphen (`-`) in an attribute
2393context is equivalent to `.unnumbered`, and preferable in non-English
2400 # My header {.unnumbered}
2402#### Extension: `implicit_header_references` ####
2404Pandoc behaves as if reference links have been defined for each header.
2405So, to link to a header
2407 # Header identifiers in HTML
2411 [Header identifiers in HTML]
2415 [Header identifiers in HTML][]
2419 [the section on header identifiers][header identifiers in
2422instead of giving the identifier explicitly:
2424 [Header identifiers in HTML](#header-identifiers-in-html)
2426If there are multiple headers with identical text, the corresponding
2427reference will link to the first one only, and you will need to use explicit
2428links to link to the others, as described above.
2430Like regular reference links, these references are case-insensitive.
2432Explicit link reference definitions always take priority over
2433implicit header references. So, in the following example, the
2434link will point to `bar`, not to `#foo`:
2445Markdown uses email conventions for quoting blocks of text.
2446A block quotation is one or more paragraphs or other block elements
2447(such as lists or headers), with each line preceded by a `>` character
2448and an optional space. (The `>` need not start at the left margin, but
2449it should not be indented more than three spaces.)
2451 > This is a block quote. This
2452 > paragraph has two lines.
2454 > 1. This is a list inside a block quote.
2457A "lazy" form, which requires the `>` character only on the first
2458line of each block, is also allowed:
2460 > This is a block quote. This
2461 paragraph has two lines.
2463 > 1. This is a list inside a block quote.
2466Among the block elements that can be contained in a block quote are
2467other block quotes. That is, block quotes can be nested:
2469 > This is a block quote.
2471 > > A block quote within a block quote.
2473If the `>` character is followed by an optional space, that space
2474will be considered part of the block quote marker and not part of
2475the indentation of the contents. Thus, to put an indented code
2476block in a block quote, you need five spaces after the `>`:
2480#### Extension: `blank_before_blockquote` ####
2482Standard Markdown syntax does not require a blank line before a block
2483quote. Pandoc does require this (except, of course, at the beginning of the
2484document). The reason for the requirement is that it is all too easy for a
2485`>` to end up at the beginning of a line by accident (perhaps through line
2486wrapping). So, unless the `markdown_strict` format is used, the following does
2487not produce a nested block quote in pandoc:
2489 > This is a block quote.
2493Verbatim (code) blocks
2494----------------------
2496### Indented code blocks ###
2498A block of text indented four spaces (or one tab) is treated as verbatim
2499text: that is, special characters do not trigger special formatting,
2500and all spaces and line breaks are preserved. For example,
2503 moveShip(5 * gravity, DOWN);
2506The initial (four space or one tab) indentation is not considered part
2507of the verbatim text, and is removed in the output.
2509Note: blank lines in the verbatim text need not begin with four spaces.
2512### Fenced code blocks ###
2514#### Extension: `fenced_code_blocks` ####
2516In addition to standard indented code blocks, pandoc supports
2517*fenced* code blocks. These begin with a row of three or more
2518tildes (`~`) and end with a row of tildes that must be at least as long as
2519the starting row. Everything between these lines is treated as code. No
2520indentation is necessary:
2524 moveShip(5 * gravity, DOWN);
2528Like regular code blocks, fenced code blocks must be separated
2529from surrounding text by blank lines.
2531If the code itself contains a row of tildes or backticks, just use a longer
2532row of tildes or backticks at the start and end:
2536 code including tildes
2540#### Extension: `backtick_code_blocks` ####
2542Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
2545#### Extension: `fenced_code_attributes` ####
2547Optionally, you may attach attributes to fenced or backtick code block using
2550 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
2552 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
2553 qsort (filter (>= x) xs)
2554 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2556Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2557`startFrom` is an attribute with value `100`. Some output formats can use this
2558information to do syntax highlighting. Currently, the only output formats
2559that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2560highlighting is supported for your output format and language, then the code
2561block above will appear highlighted, with numbered lines. (To see which
2562languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2563the code block above will appear as follows:
2565 <pre id="mycode" class="haskell numberLines" startFrom="100">
2571The `numberLines` (or `number-lines`) class will cause the lines
2572of the code block to be numbered, starting with `1` or the value
2573of the `startFrom` attribute. The `lineAnchors` (or
2574`line-anchors`) class will cause the lines to be clickable
2575anchors in HTML output.
2577A shortcut form can also be used for specifying the language of
2584This is equivalent to:
2590If the `fenced_code_attributes` extension is disabled, but
2591input contains class attribute(s) for the code block, the first
2592class attribute will be printed after the opening fence as a bare
2595To prevent all highlighting, use the `--no-highlight` flag.
2596To set the highlighting style, use `--highlight-style`.
2597For more information on highlighting, see [Syntax highlighting],
2603#### Extension: `line_blocks` ####
2605A line block is a sequence of lines beginning with a vertical bar (`|`)
2606followed by a space. The division into lines will be preserved in
2607the output, as will any leading spaces; otherwise, the lines will
2608be formatted as Markdown. This is useful for verse and addresses:
2610 | The limerick packs laughs anatomical
2611 | In space that is quite economical.
2612 | But the good ones I've seen
2613 | So seldom are clean
2614 | And the clean ones so seldom are comical
2617 | Berkeley, CA 94718
2619The lines can be hard-wrapped if needed, but the continuation
2620line must begin with a space.
2622 | The Right Honorable Most Venerable and Righteous Samuel L.
2625 | Berkeley, CA 94718
2627This syntax is borrowed from [reStructuredText].
2634A bullet list is a list of bulleted list items. A bulleted list
2635item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2642This will produce a "compact" list. If you want a "loose" list, in which
2643each item is formatted as a paragraph, put spaces between the items:
2651The bullets need not be flush with the left margin; they may be
2652indented one, two, or three spaces. The bullet must be followed
2655List items look best if subsequent lines are flush with the first
2656line (after the bullet):
2662But Markdown also allows a "lazy" format:
2668### Block content in list items ###
2670A list item may contain multiple paragraphs and other block-level
2671content. However, subsequent paragraphs must be preceded by a blank line
2672and indented to line up with the first non-space content after
2679 * Second paragraph. With a code block, which must be indented
2684Exception: if the list marker is followed by an indented code
2685block, which must begin 5 spaces after the list marker, then
2686subsequent paragraphs must begin two columns after the last
2687character of the list marker:
2691 continuation paragraph
2693List items may include other lists. In this case the preceding blank
2694line is optional. The nested list must be indented to line up with
2695the first non-space character after the list marker of the
2696containing list item.
2708As noted above, Markdown allows you to write list items "lazily," instead of
2709indenting continuation lines. However, if there are multiple paragraphs or
2710other blocks in a list item, the first line of each must be indented.
2712 + A lazy, lazy, list
2715 + Another one; this looks
2718 Second paragraph of second
2721### Ordered lists ###
2723Ordered lists work just like bulleted lists, except that the items
2724begin with enumerators rather than bullets.
2726In standard Markdown, enumerators are decimal numbers followed
2727by a period and a space. The numbers themselves are ignored, so
2728there is no difference between this list:
2740#### Extension: `fancy_lists` ####
2742Unlike standard Markdown, pandoc allows ordered list items to be marked
2743with uppercase and lowercase letters and roman numerals, in addition to
2744Arabic numerals. List markers may be enclosed in parentheses or followed by a
2745single right-parentheses or period. They must be separated from the
2746text that follows by at least one space, and, if the list marker is a
2747capital letter with a period, by at least two spaces.[^2]
2749[^2]: The point of this rule is to ensure that normal paragraphs
2750 starting with people's initials, like
2752 B. Russell was an English philosopher.
2754 do not get treated as list items.
2756 This rule will not prevent
2760 from being interpreted as a list item. In this case, a backslash
2765The `fancy_lists` extension also allows '`#`' to be used as an
2766ordered list marker in place of a numeral:
2771#### Extension: `startnum` ####
2773Pandoc also pays attention to the type of list marker used, and to the
2774starting number, and both of these are preserved where possible in the
2775output format. Thus, the following yields a list with numbers followed
2776by a single parenthesis, starting with 9, and a sublist with lowercase
2786Pandoc will start a new list each time a different type of list
2787marker is used. So, the following will create three lists:
2794If default list markers are desired, use `#.`:
2800#### Extension: `task_lists` ####
2802Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
2804 - [ ] an unchecked task list item
2807### Definition lists ###
2809#### Extension: `definition_lists` ####
2811Pandoc supports definition lists, using the syntax of
2812[PHP Markdown Extra] with some extensions.[^3]
2818 Term 2 with *inline markup*
2822 { some code, part of Definition 2 }
2824 Third paragraph of definition 2.
2826Each term must fit on one line, which may optionally be followed by
2827a blank line, and must be followed by one or more definitions.
2828A definition begins with a colon or tilde, which may be indented one
2831A term may have multiple definitions, and each definition may consist of one or
2832more block elements (paragraph, code block, list, etc.), each indented four
2833spaces or one tab stop. The body of the definition (including the first line,
2834aside from the colon or tilde) should be indented four spaces. However,
2835as with other Markdown lists, you can "lazily" omit indentation except
2836at the beginning of a paragraph or other block element:
2841 with lazy continuation.
2843 Second paragraph of the definition.
2845If you leave space before the definition (as in the example above),
2846the text of the definition will be treated as a paragraph. In some
2847output formats, this will mean greater spacing between term/definition
2848pairs. For a more compact definition list, omit the space before the
2858Note that space between items in a definition list is required.
2859(A variant that loosens this requirement, but disallows "lazy"
2860hard wrapping, can be activated with `compact_definition_lists`: see
2861[Non-pandoc extensions], below.)
2863[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2865### Numbered example lists ###
2867#### Extension: `example_lists` ####
2869The special list marker `@` can be used for sequentially numbered
2870examples. The first list item with a `@` marker will be numbered '1',
2871the next '2', and so on, throughout the document. The numbered examples
2872need not occur in a single list; each new list using `@` will take up
2873where the last stopped. So, for example:
2875 (@) My first example will be numbered (1).
2876 (@) My second example will be numbered (2).
2878 Explanation of examples.
2880 (@) My third example will be numbered (3).
2882Numbered examples can be labeled and referred to elsewhere in the
2885 (@good) This is a good example.
2887 As (@good) illustrates, ...
2889The label can be any string of alphanumeric characters, underscores,
2892Note: continuation paragraphs in example lists must always
2893be indented four spaces, regardless of the length of the
2894list marker. That is, example lists always behave as if the
2895`four_space_rule` extension is set. This is because example
2896labels tend to be long, and indenting content to the
2897first non-space character after the label would be awkward.
2899### Compact and loose lists ###
2901Pandoc behaves differently from `Markdown.pl` on some "edge
2902cases" involving lists. Consider this source:
2912Pandoc transforms this into a "compact list" (with no `<p>` tags around
2913"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2914"Second" and "Third" (but not "First"), because of the blank space
2915around "Third". Pandoc follows a simple rule: if the text is followed by
2916a blank line, it is treated as a paragraph. Since "Second" is followed
2917by a list, and not a blank line, it isn't treated as a paragraph. The
2918fact that the list is followed by a blank line is irrelevant. (Note:
2919Pandoc works this way even when the `markdown_strict` format is specified. This
2920behavior is consistent with the official Markdown syntax description,
2921even though it is different from that of `Markdown.pl`.)
2924### Ending a list ###
2926What if you want to put an indented code block after a list?
2933Trouble! Here pandoc (like other Markdown implementations) will treat
2934`{ my code block }` as the second paragraph of item two, and not as
2937To "cut off" the list after item two, you can insert some non-indented
2938content, like an HTML comment, which won't produce visible output in
2944 <!-- end of list -->
2948You can use the same trick if you want two consecutive lists instead
2964A line containing a row of three or more `*`, `-`, or `_` characters
2965(optionally separated by spaces) produces a horizontal rule:
2975Four kinds of tables may be used. The first three kinds presuppose the use of
2976a fixed-width font, such as Courier. The fourth kind can be used with
2977proportionally spaced fonts, as it does not require lining up columns.
2979#### Extension: `table_captions` ####
2981A caption may optionally be provided with all 4 kinds of tables (as
2982illustrated in the examples below). A caption is a paragraph beginning
2983with the string `Table:` (or just `:`), which will be stripped off.
2984It may appear either before or after the table.
2986#### Extension: `simple_tables` ####
2988Simple tables look like this:
2990 Right Left Center Default
2991 ------- ------ ---------- -------
2996 Table: Demonstration of simple table syntax.
2998The headers and table rows must each fit on one line. Column
2999alignments are determined by the position of the header text relative
3000to the dashed line below it:[^4]
3002 - If the dashed line is flush with the header text on the right side
3003 but extends beyond it on the left, the column is right-aligned.
3004 - If the dashed line is flush with the header text on the left side
3005 but extends beyond it on the right, the column is left-aligned.
3006 - If the dashed line extends beyond the header text on both sides,
3007 the column is centered.
3008 - If the dashed line is flush with the header text on both sides,
3009 the default alignment is used (in most cases, this will be left).
3011[^4]: This scheme is due to Michel Fortin, who proposed it on the
3012 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3014The table must end with a blank line, or a line of dashes followed by
3017The column headers may be omitted, provided a dashed line is used
3018to end the table. For example:
3020 ------- ------ ---------- -------
3024 ------- ------ ---------- -------
3026When headers are omitted, column alignments are determined on the basis
3027of the first line of the table body. So, in the tables above, the columns
3028would be right, left, center, and right aligned, respectively.
3030#### Extension: `multiline_tables` ####
3032Multiline tables allow headers and table rows to span multiple lines
3033of text (but cells that span multiple columns or rows of the table are
3034not supported). Here is an example:
3036 -------------------------------------------------------------
3037 Centered Default Right Left
3038 Header Aligned Aligned Aligned
3039 ----------- ------- --------------- -------------------------
3040 First row 12.0 Example of a row that
3041 spans multiple lines.
3043 Second row 5.0 Here's another one. Note
3044 the blank line between
3046 -------------------------------------------------------------
3048 Table: Here's the caption. It, too, may span
3051These work like simple tables, but with the following differences:
3053 - They must begin with a row of dashes, before the header text
3054 (unless the headers are omitted).
3055 - They must end with a row of dashes, then a blank line.
3056 - The rows must be separated by blank lines.
3058In multiline tables, the table parser pays attention to the widths of
3059the columns, and the writers try to reproduce these relative widths in
3060the output. So, if you find that one of the columns is too narrow in the
3061output, try widening it in the Markdown source.
3063Headers may be omitted in multiline tables as well as simple tables:
3065 ----------- ------- --------------- -------------------------
3066 First row 12.0 Example of a row that
3067 spans multiple lines.
3069 Second row 5.0 Here's another one. Note
3070 the blank line between
3072 ----------- ------- --------------- -------------------------
3074 : Here's a multiline table without headers.
3076It is possible for a multiline table to have just one row, but the row
3077should be followed by a blank line (and then the row of dashes that ends
3078the table), or the table may be interpreted as a simple table.
3080#### Extension: `grid_tables` ####
3082Grid tables look like this:
3084 : Sample grid table.
3086 +---------------+---------------+--------------------+
3087 | Fruit | Price | Advantages |
3088 +===============+===============+====================+
3089 | Bananas | $1.34 | - built-in wrapper |
3090 | | | - bright color |
3091 +---------------+---------------+--------------------+
3092 | Oranges | $2.10 | - cures scurvy |
3094 +---------------+---------------+--------------------+
3096The row of `=`s separates the header from the table body, and can be
3097omitted for a headerless table. The cells of grid tables may contain
3098arbitrary block elements (multiple paragraphs, code blocks, lists,
3099etc.). Cells that span multiple columns or rows are not
3100supported. Grid tables can be created easily using [Emacs table mode].
3102[Emacs table mode]: http://table.sourceforge.net/
3104Alignments can be specified as with pipe tables, by putting
3105colons at the boundaries of the separator line after the
3108 +---------------+---------------+--------------------+
3109 | Right | Left | Centered |
3110 +==============:+:==============+:==================:+
3111 | Bananas | $1.34 | built-in wrapper |
3112 +---------------+---------------+--------------------+
3114For headerless tables, the colons go on the top line instead:
3116 +--------------:+:--------------+:------------------:+
3117 | Right | Left | Centered |
3118 +---------------+---------------+--------------------+
3120##### Grid Table Limitations #####
3122Pandoc does not support grid tables with row spans or column spans.
3123This means that neither variable numbers of columns across rows nor
3124variable numbers of rows across columns are supported by Pandoc.
3125All grid tables must have the same number of columns in each row,
3126and the same number of rows in each column. For example, the
3127Docutils [sample grid tables] will not render as expected with
3130[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3133#### Extension: `pipe_tables` ####
3135Pipe tables look like this:
3137 | Right | Left | Default | Center |
3138 |------:|:-----|---------|:------:|
3139 | 12 | 12 | 12 | 12 |
3140 | 123 | 123 | 123 | 123 |
3143 : Demonstration of pipe table syntax.
3145The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3146ending pipe characters are optional, but pipes are required between all
3147columns. The colons indicate column alignment as shown. The header
3148cannot be omitted. To simulate a headerless table, include a header
3151Since the pipes indicate column boundaries, columns need not be vertically
3152aligned, as they are in the above example. So, this is a perfectly
3153legal (though ugly) pipe table:
3161The cells of pipe tables cannot contain block elements like paragraphs
3162and lists, and cannot span multiple lines. If a pipe table contains a
3163row whose printable content is wider than the column width (see
3164`--columns`), then the table will take up the full text width and
3165the cell contents will wrap, with the relative cell widths determined
3166by the number of dashes in the line separating the table header from
3167the table body. (For example `---|-` would make the first column 3/4
3168and the second column 1/4 of the full text width.)
3169On the other hand, if no lines are wider than column width, then
3170cell contents will not be wrapped, and the cells will be sized
3173Note: pandoc also recognizes pipe tables of the following
3174form, as can be produced by Emacs' orgtbl-mode:
3181The difference is that `+` is used instead of `|`. Other orgtbl features
3182are not supported. In particular, to get non-default column alignment,
3183you'll need to add colons as above.
3185[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3190#### Extension: `pandoc_title_block` ####
3192If the file begins with a title block
3195 % author(s) (separated by semicolons)
3198it will be parsed as bibliographic information, not regular text. (It
3199will be used, for example, in the title of standalone LaTeX or HTML
3200output.) The block may contain just a title, a title and an author,
3201or all three elements. If you want to include an author but no
3202title, or a title and a date but no author, you need a blank line:
3211The title may occupy multiple lines, but continuation lines must
3212begin with leading space, thus:
3217If a document has multiple authors, the authors may be put on
3218separate lines with leading space, or separated by semicolons, or
3219both. So, all of the following are equivalent:
3224 % Author One; Author Two
3229The date must fit on one line.
3231All three metadata fields may contain standard inline formatting
3232(italics, links, footnotes, etc.).
3234Title blocks will always be parsed, but they will affect the output only
3235when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3236will appear twice: once in the document head -- this is the title that
3237will appear at the top of the window in a browser -- and once at the
3238beginning of the document body. The title in the document head can have
3239an optional prefix attached (`--title-prefix` or `-T` option). The title
3240in the body appears as an H1 element with class "title", so it can be
3241suppressed or reformatted with CSS. If a title prefix is specified with
3242`-T` and no title block appears in the document, the title prefix will
3243be used by itself as the HTML title.
3245The man page writer extracts a title, man page section number, and
3246other header and footer information from the title line. The title
3247is assumed to be the first word on the title line, which may optionally
3248end with a (single-digit) section number in parentheses. (There should
3249be no space between the title and the parentheses.) Anything after
3250this is assumed to be additional footer and header text. A single pipe
3251character (`|`) should be used to separate the footer text from the header
3256will yield a man page with the title `PANDOC` and section 1.
3258 % PANDOC(1) Pandoc User Manuals
3260will also have "Pandoc User Manuals" in the footer.
3262 % PANDOC(1) Pandoc User Manuals | Version 4.0
3264will also have "Version 4.0" in the header.
3266#### Extension: `yaml_metadata_block` ####
3268A YAML metadata block is a valid YAML object, delimited by a line of three
3269hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3270(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3271document, but if it is not at the beginning, it must be preceded by a blank
3272line. (Note that, because of the way pandoc concatenates input files when
3273several are provided, you may also keep the metadata in a separate YAML file
3274and pass it to pandoc as an argument, along with your Markdown files:
3276 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3278Just be sure that the YAML file begins with `---` and ends with `---` or
3279`...`.) Alternatively, you can use the `--metadata-file` option. Using
3280that approach however, you cannot reference content (like footnotes)
3281from the main markdown input document.
3283Metadata will be taken from the fields of the YAML object and added to any
3284existing document metadata. Metadata can contain lists and objects (nested
3285arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3286with names ending in an underscore will be ignored by pandoc. (They may be
3287given a role by external processors.) Field names must not be
3288interpretable as YAML numbers or boolean values (so, for
3289example, `yes`, `True`, and `15` cannot be used as field names).
3291A document may contain multiple metadata blocks. The metadata fields will
3292be combined through a *left-biased union*: if two metadata blocks attempt
3293to set the same field, the value from the first block will be taken.
3295When pandoc is used with `-t markdown` to create a Markdown document,
3296a YAML metadata block will be produced only if the `-s/--standalone`
3297option is used. All of the metadata will appear in a single block
3298at the beginning of the document.
3300Note that YAML escaping rules must be followed. Thus, for example,
3301if a title contains a colon, it must be quoted. The pipe character
3302(`|`) can be used to begin an indented block that will be interpreted
3303literally, without need for escaping. This form is necessary
3304when the field contains blank lines or block-level formatting:
3307 title: 'This is the title: it contains a colon'
3311 keywords: [nothing, nothingness]
3313 This is the abstract.
3315 It consists of two paragraphs.
3318Template variables will be set automatically from the metadata. Thus, for
3319example, in writing HTML, the variable `abstract` will be set to the HTML
3320equivalent of the Markdown in the `abstract` field:
3322 <p>This is the abstract.</p>
3323 <p>It consists of two paragraphs.</p>
3325Variables can contain arbitrary YAML structures, but the template must match
3326this structure. The `author` variable in the default templates expects a
3327simple list or string, but can be changed to support more complicated
3328structures. The following combination, for example, would add an affiliation
3329to the author if one is given:
3332 title: The document title
3335 affiliation: University of Somewhere
3337 affiliation: University of Nowhere
3340To use the structured authors in the example above, you would need a custom
3345 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3351Raw content to include in the document's header may be specified
3352using `header-includes`; however, it is important to mark up
3353this content as raw code for a particular output format, using
3354the [`raw_attribute` extension](#extension-raw_attribute)), or it
3355will be interpreted as markdown. For example:
3360 \let\oldsection\section
3361 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3367#### Extension: `all_symbols_escapable` ####
3369Except inside a code block or inline code, any punctuation or space
3370character preceded by a backslash will be treated literally, even if it
3371would normally indicate formatting. Thus, for example, if one writes
3381 <strong>hello</strong>
3383This rule is easier to remember than standard Markdown's rule,
3384which allows only the following characters to be backslash-escaped:
3388(However, if the `markdown_strict` format is used, the standard Markdown rule
3391A backslash-escaped space is parsed as a nonbreaking space. It will
3392appear in TeX output as `~` and in HTML and XML as `\ ` or
3395A backslash-escaped newline (i.e. a backslash occurring at the end of
3396a line) is parsed as a hard line break. It will appear in TeX output as
3397`\\` and in HTML as `<br />`. This is a nice alternative to
3398Markdown's "invisible" way of indicating hard line breaks using
3399two trailing spaces on a line.
3401Backslash escapes do not work in verbatim contexts.
3408To *emphasize* some text, surround it with `*`s or `_`, like this:
3410 This text is _emphasized with underscores_, and this
3411 is *emphasized with asterisks*.
3413Double `*` or `_` produces **strong emphasis**:
3415 This is **strong emphasis** and __with underscores__.
3417A `*` or `_` character surrounded by spaces, or backslash-escaped,
3418will not trigger emphasis:
3420 This is * not emphasized *, and \*neither is this\*.
3422#### Extension: `intraword_underscores` ####
3424Because `_` is sometimes used inside words and identifiers,
3425pandoc does not interpret a `_` surrounded by alphanumeric
3426characters as an emphasis marker. If you want to emphasize
3427just part of a word, use `*`:
3429 feas*ible*, not feas*able*.
3434#### Extension: `strikeout` ####
3436To strikeout a section of text with a horizontal line, begin and end it
3437with `~~`. Thus, for example,
3439 This ~~is deleted text.~~
3442### Superscripts and subscripts ###
3444#### Extension: `superscript`, `subscript` ####
3446Superscripts may be written by surrounding the superscripted text by `^`
3447characters; subscripts may be written by surrounding the subscripted
3448text by `~` characters. Thus, for example,
3450 H~2~O is a liquid. 2^10^ is 1024.
3452If the superscripted or subscripted text contains spaces, these spaces
3453must be escaped with backslashes. (This is to prevent accidental
3454superscripting and subscripting through the ordinary use of `~` and `^`.)
3455Thus, if you want the letter P with 'a cat' in subscripts, use
3456`P~a\ cat~`, not `P~a cat~`.
3461To make a short span of text verbatim, put it inside backticks:
3463 What is the difference between `>>=` and `>>`?
3465If the verbatim text includes a backtick, use double backticks:
3467 Here is a literal backtick `` ` ``.
3469(The spaces after the opening backticks and before the closing
3470backticks will be ignored.)
3472The general rule is that a verbatim span starts with a string
3473of consecutive backticks (optionally followed by a space)
3474and ends with a string of the same number of backticks (optionally
3475preceded by a space).
3477Note that backslash-escapes (and other Markdown constructs) do not
3478work in verbatim contexts:
3480 This is a backslash followed by an asterisk: `\*`.
3482#### Extension: `inline_code_attributes` ####
3484Attributes can be attached to verbatim text, just as with
3485[fenced code blocks]:
3491To write small caps, use the `smallcaps` class:
3493 [Small caps]{.smallcaps}
3495Or, without the `bracketed_spans` extension:
3497 <span class="smallcaps">Small caps</span>
3499For compatibility with other Markdown flavors, CSS is also supported:
3501 <span style="font-variant:small-caps;">Small caps</span>
3503This will work in all output formats that support small caps.
3509#### Extension: `tex_math_dollars` ####
3511Anything between two `$` characters will be treated as TeX math. The
3512opening `$` must have a non-space character immediately to its right,
3513while the closing `$` must have a non-space character immediately to its
3514left, and must not be followed immediately by a digit. Thus,
3515`$20,000 and $30,000` won't parse as math. If for some reason
3516you need to enclose text in literal `$` characters, backslash-escape
3517them and they won't be treated as math delimiters.
3519TeX math will be printed in all output formats. How it is rendered
3520depends on the output format:
3523 ~ It will appear verbatim surrounded by `\(...\)` (for inline
3524 math) or `\[...\]` (for display math).
3526Markdown, Emacs Org mode, ConTeXt, ZimWiki
3527 ~ It will appear verbatim surrounded by `$...$` (for inline
3528 math) or `$$...$$` (for display math).
3531 ~ It will be rendered using an [interpreted text role `:math:`].
3534 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
3535 surrounded by `latexmath:[$...$]` (for inline math) or
3536 `[latexmath]++++\[...\]+++` (for display math).
3537 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
3538 (`$..$` and `\[..\]`) are omitted.
3541 ~ It will be rendered inside a `@math` command.
3544 ~ It will be rendered verbatim without `$`'s.
3547 ~ It will be rendered inside `<math>` tags.
3550 ~ It will be rendered inside `<span class="math">` tags.
3553 ~ It will be rendered, if possible, using Unicode characters,
3554 and will otherwise appear verbatim.
3557 ~ It will be rendered, if possible, using MathML.
3560 ~ If the `--mathml` flag is used, it will be rendered using MathML
3561 in an `inlineequation` or `informalequation` tag. Otherwise it
3562 will be rendered, if possible, using Unicode characters.
3565 ~ It will be rendered using OMML math markup.
3568 ~ If the `--webtex` option is used, formulas are rendered as images
3569 using CodeCogs or other compatible web service, downloaded
3570 and embedded in the e-book. Otherwise, they will appear verbatim.
3572HTML, Slidy, DZSlides, S5, EPUB
3573 ~ The way math is rendered in HTML will depend on the
3574 command-line options selected. Therefore see [Math rendering in HTML]
3577[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3582#### Extension: `raw_html` ####
3584Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
3585(except verbatim contexts, where `<`, `>`, and `&` are interpreted
3586literally). (Technically this is not an extension, since standard
3587Markdown allows it, but it has been made an extension so that it can
3588be disabled if desired.)
3590The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3591DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3592output, and suppressed in other formats.
3594For a more explicit way of including raw HTML in a Markdown
3595document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
3597In the CommonMark format, if `raw_html` is enabled, superscripts,
3598subscripts, strikeouts and small capitals will be represented as HTML.
3599Otherwise, plain-text fallbacks will be used. Note that even if
3600`raw_html` is disabled, tables will be rendered with HTML syntax if
3601they cannot use pipe syntax.
3603#### Extension: `markdown_in_html_blocks` ####
3605Standard Markdown allows you to include HTML "blocks": blocks
3606of HTML between balanced tags that are separated from the surrounding text
3607with blank lines, and start and end at the left margin. Within
3608these blocks, everything is interpreted as HTML, not Markdown;
3609so (for example), `*` does not signify emphasis.
3611Pandoc behaves this way when the `markdown_strict` format is used; but
3612by default, pandoc interprets material between HTML block tags as Markdown.
3613Thus, for example, pandoc will turn
3618 <td>[a link](http://google.com)</td>
3626 <td><em>one</em></td>
3627 <td><a href="http://google.com">a link</a></td>
3631whereas `Markdown.pl` will preserve it as is.
3633There is one exception to this rule: text between `<script>` and
3634`<style>` tags is not interpreted as Markdown.
3636This departure from standard Markdown should make it easier to mix
3637Markdown with HTML block elements. For example, one can surround
3638a block of Markdown text with `<div>` tags without preventing it
3639from being interpreted as Markdown.
3641#### Extension: `native_divs` ####
3643Use native pandoc `Div` blocks for content inside `<div>` tags.
3644For the most part this should give the same output as
3645`markdown_in_html_blocks`, but it makes it easier to write pandoc
3646filters to manipulate groups of blocks.
3648#### Extension: `native_spans` ####
3650Use native pandoc `Span` blocks for content inside `<span>` tags.
3651For the most part this should give the same output as `raw_html`,
3652but it makes it easier to write pandoc filters to manipulate groups
3655#### Extension: `raw_tex` ####
3657In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3658included in a document. Inline TeX commands will be preserved and passed
3659unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3660LaTeX to include BibTeX citations:
3662 This result was proved in \cite{jones.1967}.
3664Note that in LaTeX environments, like
3666 \begin{tabular}{|l|l|}\hline
3667 Age & Frequency \\ \hline
3670 36--45 & 22 \\ \hline
3673the material between the begin and end tags will be interpreted as raw
3674LaTeX, not as Markdown.
3676For a more explicit and flexible way of including raw TeX in a
3677Markdown document, see the [`raw_attribute`
3678extension][Extension: `raw_attribute`].
3680Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3681Emacs Org mode, and ConTeXt.
3683### Generic raw attribute ###
3685#### Extension: `raw_attribute` ####
3687Inline spans and fenced code blocks with a special
3688kind of attribute will be parsed as raw content with the
3689designated format. For example, the following produces a raw
3696And the following produces a raw `html` inline element:
3698 This is `<a>html</a>`{=html}
3700This can be useful to insert raw xml into `docx` documents, e.g.
3706 <w:br w:type="page"/>
3711The format name should match the target format name (see
3712`-t/--to`, above, for a list, or use `pandoc
3713--list-output-formats`). Use `openxml` for `docx` output,
3714`opendocument` for `odt` output, `html5` for `epub3` output,
3715`html4` for `epub2` output, and `latex`, `beamer`,
3716`ms`, or `html5` for `pdf` output (depending on what you
3717use for `--pdf-engine`).
3719This extension presupposes that the relevant kind of
3720inline code or fenced code block is enabled. Thus, for
3721example, to use a raw attribute with a backtick code block,
3722`backtick_code_blocks` must be enabled.
3724The raw attribute cannot be combined with regular attributes.
3729#### Extension: `latex_macros` ####
3731When this extension is enabled, pandoc will parse LaTeX
3732macro definitions and apply the resulting macros to all LaTeX
3733math and raw LaTeX. So, for example, the following will work in
3734all output formats, not just LaTeX:
3736 \newcommand{\tuple}[1]{\langle #1 \rangle}
3740Note that LaTeX macros will not be applied if they occur
3741inside inside a raw span or block marked with the
3742[`raw_attribute` extension](#extension-raw_attribute).
3744When `latex_macros` is disabled, the raw LaTeX and math will
3745not have macros applied. This is usually a better approach when
3746you are targeting LaTeX or PDF.
3748Whether or not `latex_macros` is enabled, the macro definitions
3749will still be passed through as raw LaTeX.
3754Markdown allows links to be specified in several ways.
3756### Automatic links ###
3758If you enclose a URL or email address in pointy brackets, it
3762 <sam@green.eggs.ham>
3766An inline link consists of the link text in square brackets,
3767followed by the URL in parentheses. (Optionally, the URL can
3768be followed by a link title, in quotes.)
3770 This is an [inline link](/url), and here's [one with
3771 a title](http://fsf.org "click here for a good time!").
3773There can be no space between the bracketed part and the parenthesized part.
3774The link text can contain formatting (such as emphasis), but the title cannot.
3776Email addresses in inline links are not autodetected, so they have to be
3777prefixed with `mailto`:
3779 [Write me!](mailto:sam@green.eggs.ham)
3781### Reference links ###
3783An *explicit* reference link has two parts, the link itself and the link
3784definition, which may occur elsewhere in the document (either
3785before or after the link).
3787The link consists of link text in square brackets, followed by a label in
3788square brackets. (There cannot be space between the two unless the
3789`spaced_reference_links` extension is enabled.) The link definition
3790consists of the bracketed label, followed by a colon and a space, followed by
3791the URL, and optionally (after a space) a link title either in quotes or in
3792parentheses. The label must not be parseable as a citation (assuming
3793the `citations` extension is enabled): citations take precedence over
3796Here are some examples:
3798 [my label 1]: /foo/bar.html "My title, optional"
3800 [my label 3]: http://fsf.org (The free software foundation)
3801 [my label 4]: /bar#special 'A title in single quotes'
3803The URL may optionally be surrounded by angle brackets:
3805 [my label 5]: <http://foo.bar.baz>
3807The title may go on the next line:
3809 [my label 3]: http://fsf.org
3810 "The free software foundation"
3812Note that link labels are not case sensitive. So, this will work:
3814 Here is [my link][FOO]
3818In an *implicit* reference link, the second pair of brackets is
3823 [my website]: http://foo.bar.baz
3825Note: In `Markdown.pl` and most other Markdown implementations,
3826reference link definitions cannot occur in nested constructions
3827such as list items or block quotes. Pandoc lifts this arbitrary
3828seeming restriction. So the following is fine in pandoc, though
3829not in most other implementations:
3835#### Extension: `shortcut_reference_links` ####
3837In a *shortcut* reference link, the second pair of brackets may
3842 [my website]: http://foo.bar.baz
3844### Internal links ###
3846To link to another section of the same document, use the automatically
3847generated identifier (see [Header identifiers]). For example:
3849 See the [Introduction](#introduction).
3853 See the [Introduction].
3855 [Introduction]: #introduction
3857Internal links are currently supported for HTML formats (including
3858HTML slide shows and EPUB), LaTeX, and ConTeXt.
3863A link immediately preceded by a `!` will be treated as an image.
3864The link text will be used as the image's alt text:
3866 
3870 [movie reel]: movie.gif
3872#### Extension: `implicit_figures` ####
3874An image with nonempty alt text, occurring by itself in a
3875paragraph, will be rendered as a figure with a caption. The
3876image's alt text will be used as the caption.
3878 
3880How this is rendered depends on the output format. Some output
3881formats (e.g. RTF) do not yet support figures. In those
3882formats, you'll just get an image in a paragraph by itself, with
3885If you just want a regular inline image, just make sure it is not
3886the only thing in the paragraph. One way to do this is to insert a
3887nonbreaking space after the image:
3889 \
3891Note that in reveal.js slide shows, an image in a paragraph
3892by itself that has the `stretch` class will fill the screen,
3893and the caption and figure tags will be omitted.
3895#### Extension: `link_attributes` ####
3897Attributes can be set on links and images:
3899 An inline {#id .class width=30 height=20px}
3900 and a reference ![image][ref] with attributes.
3902 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3904(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3905and `.class` are used.)
3907For HTML and EPUB, all attributes except `width` and `height` (but
3908including `srcset` and `sizes`) are passed through as is. The other
3909writers ignore attributes that are not supported by their output
3912The `width` and `height` attributes on images are treated specially. When
3913used without a unit, the unit is assumed to be pixels. However, any of
3914the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3915and `%`. There must not be any spaces between the number and the unit.
3919{ width=50% }
3922- Dimensions are converted to inches for output in page-based formats like
3923 LaTeX. Dimensions are converted to pixels for output in HTML-like
3924 formats. Use the `--dpi` option to specify the number of pixels per
3925 inch. The default is 96dpi.
3926- The `%` unit is generally relative to some available space.
3927 For example the above example will render to the following.
3928 - HTML: `<img href="file.jpg" style="width: 50%;" />`
3929 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
3930 (If you're using a custom template, you need to configure `graphicx`
3931 as in the default template.)
3932 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3933- Some output formats have a notion of a class
3934 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3935 or a unique identifier (LaTeX `\caption`), or both (HTML).
3936- When no `width` or `height` attributes are specified, the fallback
3937 is to look at the image resolution and the dpi metadata embedded in
3943Using the `native_divs` and `native_spans` extensions
3944(see [above][Extension: `native_divs`]), HTML syntax can
3945be used as part of markdown to create native `Div` and `Span`
3946elements in the pandoc AST (as opposed to raw HTML).
3947However, there is also nicer syntax available:
3949#### Extension: `fenced_divs` ####
3951Allow special fenced syntax for native `Div` blocks. A Div
3952starts with a fence containing at least three consecutive
3953colons plus some attributes. The attributes may optionally
3954be followed by another string of consecutive colons.
3955The attribute syntax is exactly as in fenced code blocks (see
3956[Extension: `fenced_code_attributes`]). As with fenced
3957code blocks, one can use either attributes in curly braces
3958or a single unbraced word, which will be treated as a class
3959name. The Div ends with another line containing a string of at
3960least three consecutive colons. The fenced Div should be
3961separated by blank lines from preceding and following blocks.
3965 ::::: {#special .sidebar}
3966 Here is a paragraph.
3971Fenced divs can be nested. Opening fences are distinguished
3972because they *must* have attributes:
3978 This is a warning within a warning.
3982Fences without attributes are always closing fences. Unlike
3983with fenced code blocks, the number of colons in the closing
3984fence need not match the number in the opening fence. However,
3985it can be helpful for visual clarity to use fences of different
3986lengths to distinguish nested divs from their parents.
3989#### Extension: `bracketed_spans` ####
3991A bracketed sequence of inlines, as one would use to begin
3992a link, will be treated as a `Span` with attributes if it is
3993followed immediately by attributes:
3995 [This is *some text*]{.class key="val"}
4000#### Extension: `footnotes` ####
4002Pandoc's Markdown allows footnotes, using the following syntax:
4004 Here is a footnote reference,[^1] and another.[^longnote]
4006 [^1]: Here is the footnote.
4008 [^longnote]: Here's one with multiple blocks.
4010 Subsequent paragraphs are indented to show that they
4011 belong to the previous footnote.
4015 The whole paragraph can be indented, or just the first
4016 line. In this way, multi-paragraph footnotes work like
4017 multi-paragraph list items.
4019 This paragraph won't be part of the note, because it
4022The identifiers in footnote references may not contain spaces, tabs,
4023or newlines. These identifiers are used only to correlate the
4024footnote reference with the note itself; in the output, footnotes
4025will be numbered sequentially.
4027The footnotes themselves need not be placed at the end of the
4028document. They may appear anywhere except inside other block elements
4029(lists, block quotes, tables, etc.). Each footnote should be
4030separated from surrounding content (including other footnotes)
4033#### Extension: `inline_notes` ####
4035Inline footnotes are also allowed (though, unlike regular notes,
4036they cannot contain multiple paragraphs). The syntax is as follows:
4038 Here is an inline note.^[Inlines notes are easier to write, since
4039 you don't have to pick an identifier and move down to type the
4042Inline and regular footnotes may be mixed freely.
4047#### Extension: `citations` ####
4049Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4050citations and a bibliography in a number of styles. Basic usage is
4052 pandoc --filter pandoc-citeproc myinput.txt
4054In order to use this feature, you will need to specify a bibliography file
4055using the `bibliography` metadata field in a YAML metadata section, or
4056`--bibliography` command line argument. You can supply multiple `--bibliography`
4057arguments or set `bibliography` metadata field to YAML array, if you want to
4058use multiple bibliography files. The bibliography may have any of these
4061 Format File extension
4062 ------------ --------------
4075Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4076use `.bibtex` to force BibTeX.
4078Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4079can produce `.json` and `.yaml` files from any of the supported formats.
4081In-field markup: In BibTeX and BibLaTeX databases,
4082pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4083databases, pandoc Markdown; and in CSL JSON databases, an
4084[HTML-like markup][CSL markup specs]:
4092`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4101`<span class="nocase">...</span>`
4102: prevent a phrase from being capitalized as title case
4104`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4105and CSL YAML formats as far as possible.
4107As an alternative to specifying a bibliography file using `--bibliography`
4108or the YAML metadata field `bibliography`, you can include
4109the citation data directly in the `references` field of the
4110document's YAML metadata. The field should contain an array of
4111YAML-encoded references, for example:
4115 - type: article-journal
4127 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4129 title-short: Molecular structure of nucleic acids
4130 container-title: Nature
4134 DOI: 10.1038/171737a0
4135 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4139(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4140of the supported formats.)
4142Citations and references can be formatted using any style supported by the
4143[Citation Style Language], listed in the [Zotero Style Repository].
4144These files are specified using the `--csl` option or the `csl` metadata field.
4145By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4146format. The CSL project provides further information on [finding and editing styles].
4148To make your citations hyperlinks to the corresponding bibliography
4149entries, add `link-citations: true` to your YAML metadata.
4151Citations go inside square brackets and are separated by semicolons.
4152Each citation must have a key, composed of '@' + the citation
4153identifier from the database, and may optionally have a prefix,
4154a locator, and a suffix. The citation key must begin with a letter, digit,
4155or `_`, and may contain alphanumerics, `_`, and internal punctuation
4156characters (`:.#$%&-+?<>~/`). Here are some examples:
4158 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4160 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4162 Blah blah [@smith04; @doe99].
4164`pandoc-citeproc` detects locator terms in the [CSL locale files].
4165Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4166locale, locator terms can be written in either singular or plural forms,
4167as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4168`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4169`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4170`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4171`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4172`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4173locator term is used, "page" is assumed.
4175`pandoc-citeproc` will use heuristics to distinguish the locator
4176from the suffix. In complex cases, the locator can be enclosed
4177in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4179 [@smith{ii, A, D-Z}, with a suffix]
4180 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4182A minus sign (`-`) before the `@` will suppress mention of
4183the author in the citation. This can be useful when the
4184author is already mentioned in the text:
4186 Smith says blah [-@smith04].
4188You can also write an in-text citation, as follows:
4192 @smith04 [p. 33] says blah.
4194If the style calls for a list of works cited, it will be placed
4195in a div with id `refs`, if one exists:
4200Otherwise, it will be placed at the end of the document.
4201Generation of the bibliography can be suppressed by setting
4202`suppress-bibliography: true` in the YAML metadata.
4204If you wish the bibliography to have a section header, you can
4205set `reference-section-title` in the metadata, or put the header
4206at the beginning of the div with id `refs` (if you are using it)
4207or at the end of your document:
4213The bibliography will be inserted after this header. Note that
4214the `unnumbered` class will be added to this header, so that the
4215section will not be numbered.
4217If you want to include items in the bibliography without actually
4218citing them in the body text, you can define a dummy `nocite` metadata
4219field and put the citations there:
4228In this example, the document will contain a citation for `item3`
4229only, but the bibliography will contain entries for `item1`, `item2`, and
4232It is possible to create a bibliography with all the citations,
4233whether or not they appear in the document, by using a wildcard:
4240For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4241render the bibliography. In order to do so, specify bibliography
4242files as outlined above, and add `--natbib` or `--biblatex`
4243argument to `pandoc` invocation. Bear in mind that bibliography
4244files have to be in respective format (either BibTeX or
4247For more information, see the [pandoc-citeproc man page].
4249[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4250[Chicago Manual of Style]: http://chicagomanualofstyle.org
4251[Citation Style Language]: http://citationstyles.org
4252[Zotero Style Repository]: https://www.zotero.org/styles
4253[finding and editing styles]: https://citationstyles.org/authors/
4254[CSL locale files]: https://github.com/citation-style-language/locales
4255[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4257Non-pandoc extensions
4258---------------------
4260The following Markdown syntax extensions are not enabled by default
4261in pandoc, but may be enabled by adding `+EXTENSION` to the format
4262name, where `EXTENSION` is the name of the extension. Thus, for
4263example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4265#### Extension: `old_dashes` ####
4267Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4268`-` before a numeral is an en-dash, and `--` is an em-dash.
4269This option only has an effect if `smart` is enabled. It is
4270selected automatically for `textile` input.
4272#### Extension: `angle_brackets_escapable` ####
4274Allow `<` and `>` to be backslash-escaped, as they can be in
4275GitHub flavored Markdown but not original Markdown. This is
4276implied by pandoc's default `all_symbols_escapable`.
4278#### Extension: `lists_without_preceding_blankline` ####
4280Allow a list to occur right after a paragraph, with no intervening
4283#### Extension: `four_space_rule` ####
4285Selects the pandoc <= 2.0 behavior for parsing lists, so that
4286four spaces indent are needed for list item continuation
4289#### Extension: `spaced_reference_links` ####
4291Allow whitespace between the two components of a reference link,
4296#### Extension: `hard_line_breaks` ####
4298Causes all newlines within a paragraph to be interpreted as hard line
4299breaks instead of spaces.
4301#### Extension: `ignore_line_breaks` ####
4303Causes newlines within a paragraph to be ignored, rather than being
4304treated as spaces or as hard line breaks. This option is intended for
4305use with East Asian languages where spaces are not used between words,
4306but text is divided into lines for readability.
4308#### Extension: `east_asian_line_breaks` ####
4310Causes newlines within a paragraph to be ignored, rather than
4311being treated as spaces or as hard line breaks, when they occur
4312between two East Asian wide characters. This is a better choice
4313than `ignore_line_breaks` for texts that include a mix of East
4314Asian wide characters and other characters.
4316#### Extension: `emoji` ####
4318Parses textual emojis like `:smile:` as Unicode emoticons.
4320#### Extension: `tex_math_single_backslash` ####
4322Causes anything between `\(` and `\)` to be interpreted as inline
4323TeX math, and anything between `\[` and `\]` to be interpreted
4324as display TeX math. Note: a drawback of this extension is that
4325it precludes escaping `(` and `[`.
4327#### Extension: `tex_math_double_backslash` ####
4329Causes anything between `\\(` and `\\)` to be interpreted as inline
4330TeX math, and anything between `\\[` and `\\]` to be interpreted
4333#### Extension: `markdown_attribute` ####
4335By default, pandoc interprets material inside block-level tags as Markdown.
4336This extension changes the behavior so that Markdown is only parsed
4337inside block-level tags if the tags have the attribute `markdown=1`.
4339#### Extension: `mmd_title_block` ####
4341Enables a [MultiMarkdown] style title block at the top of
4342the document, for example:
4346 Date: September 1, 2008
4347 Comment: This is a sample mmd title block, with
4348 a field spanning multiple lines.
4350See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4351`yaml_metadata_block` is enabled, it will take precedence over
4354#### Extension: `abbreviations` ####
4356Parses PHP Markdown Extra abbreviation keys, like
4358 *[HTML]: Hypertext Markup Language
4360Note that the pandoc document model does not support
4361abbreviations, so if this extension is enabled, abbreviation keys are
4362simply skipped (as opposed to being parsed as paragraphs).
4364#### Extension: `autolink_bare_uris` ####
4366Makes all absolute URIs into links, even when not surrounded by
4367pointy braces `<...>`.
4369#### Extension: `mmd_link_attributes` ####
4371Parses multimarkdown style key-value attributes on link
4372and image references. This extension should not be confused with the
4373[`link_attributes`](#extension-link_attributes) extension.
4375 This is a reference ![image][ref] with multimarkdown attributes.
4377 [ref]: http://path.to/image "Image title" width=20px height=30px
4378 id=myId class="myClass1 myClass2"
4380#### Extension: `mmd_header_identifiers` ####
4382Parses multimarkdown style header identifiers (in square brackets,
4383after the header but before any trailing `#`s in an ATX header).
4385#### Extension: `compact_definition_lists` ####
4387Activates the definition list syntax of pandoc 1.12.x and earlier.
4388This syntax differs from the one described above under [Definition lists]
4391 - No blank line is required between consecutive items of the
4393 - To get a "tight" or "compact" list, omit space between consecutive
4394 items; the space between a term and its definition does not affect
4396 - Lazy wrapping of paragraphs is not allowed: the entire definition must
4397 be indented four spaces.[^6]
4399[^6]: To see why laziness is incompatible with relaxing the requirement
4400 of a blank line between items, consider the following example:
4407 Is this a single list item with two definitions of "bar," the first of
4408 which is lazily wrapped, or two list items? To remove the ambiguity
4409 we must either disallow lazy wrapping or require a blank line between
4415In addition to pandoc's extended Markdown, the following Markdown
4416variants are supported:
4418`markdown_phpextra` (PHP Markdown Extra)
4419: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4420 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4421 `header_attributes`, `link_attributes`, `abbreviations`,
4422 `shortcut_reference_links`, `spaced_reference_links`.
4424`markdown_github` (deprecated GitHub-Flavored Markdown)
4425: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4426 `gfm_auto_identifiers`, `backtick_code_blocks`,
4427 `autolink_bare_uris`, `space_in_atx_header`,
4428 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4429 `shortcut_reference_links`, `angle_brackets_escapable`,
4430 `lists_without_preceding_blankline`.
4432`markdown_mmd` (MultiMarkdown)
4433: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4434 `tex_math_double_backslash`, `intraword_underscores`,
4435 `mmd_title_block`, `footnotes`, `definition_lists`,
4436 `all_symbols_escapable`, `implicit_header_references`,
4437 `auto_identifiers`, `mmd_header_identifiers`,
4438 `shortcut_reference_links`, `implicit_figures`,
4439 `superscript`, `subscript`, `backtick_code_blocks`,
4440 `spaced_reference_links`, `raw_attribute`.
4442`markdown_strict` (Markdown.pl)
4443: `raw_html`, `shortcut_reference_links`,
4444 `spaced_reference_links`.
4446We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4447which is implemented as a set of extensions on `commonmark`).
4449Note, however, that `commonmark` and `gfm` have limited support
4450for extensions. Only those listed below (and `smart`,
4451`raw_tex`, and `hard_line_breaks`) will work. The extensions
4452can, however, all be individually disabled. Also, `raw_tex`
4453only affects `gfm` output, not input.
4455`gfm` (GitHub-Flavored Markdown)
4456: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4457 `gfm_auto_identifiers`, `backtick_code_blocks`,
4458 `autolink_bare_uris`, `space_in_atx_header`,
4459 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4460 `shortcut_reference_links`, `angle_brackets_escapable`,
4461 `lists_without_preceding_blankline`.
4464Producing slide shows with pandoc
4465=================================
4467You can use pandoc to produce an HTML + JavaScript slide presentation
4468that can be viewed via a web browser. There are five ways to do this,
4469using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
4470You can also produce a PDF slide show using LaTeX [`beamer`], or
4471slides shows in Microsoft [PowerPoint] format.
4473Here's the Markdown source for a simple slide show, `habits.txt`:
4500 
4507To produce an HTML/JavaScript slide show, simply type
4509 pandoc -t FORMAT -s habits.txt -o habits.html
4511where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
4513For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4514`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4515assumed to be available at the relative path `s5/default` (for S5), `slideous`
4516(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4517`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4518`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4519above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4522With all HTML slide formats, the `--self-contained` option can be used to
4523produce a single file that contains all of the data necessary to display the
4524slide show, including linked scripts, stylesheets, images, and videos.
4526To produce a PDF slide show using beamer, type
4528 pandoc -t beamer habits.txt -o habits.pdf
4530Note that a reveal.js slide show can also be converted to a PDF
4531by printing it to a file from the browser.
4533To produce a Powerpoint slide show, type
4535 pandoc habits.txt -o habits.pptx
4537Structuring the slide show
4538--------------------------
4540By default, the *slide level* is the highest header level in
4541the hierarchy that is followed immediately by content, and not another
4542header, somewhere in the document. In the example above, level 1 headers
4543are always followed by level 2 headers, which are followed by content,
4544so 2 is the slide level. This default can be overridden using
4545the `--slide-level` option.
4547The document is carved up into slides according to the following
4550 * A horizontal rule always starts a new slide.
4552 * A header at the slide level always starts a new slide.
4554 * Headers *below* the slide level in the hierarchy create
4555 headers *within* a slide.
4557 * Headers *above* the slide level in the hierarchy create
4558 "title slides," which just contain the section title
4559 and help to break the slide show into sections.
4560 Non-slide content under these headers will be included
4561 on the title slide (for HTML slide shows) or in a
4562 subsequent slide with the same title (for beamer).
4564 * A title page is constructed automatically from the document's title
4565 block, if present. (In the case of beamer, this can be disabled
4566 by commenting out some lines in the default template.)
4568These rules are designed to support many different styles of slide show. If
4569you don't care about structuring your slides into sections and subsections,
4570you can just use level 1 headers for all each slide. (In that case, level 1
4571will be the slide level.) But you can also structure the slide show into
4572sections, as in the example above.
4574Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4575layout will be produced, with level 1 headers building horizontally
4576and level 2 headers building vertically. It is not recommended that
4577you use deeper nesting of section levels with reveal.js.
4582By default, these writers produce lists that display "all at once."
4583If you want your lists to display incrementally (one item at a time),
4584use the `-i` option. If you want a particular list to depart from the
4585default, put it in a `div` block with class `incremental` or
4586`nonincremental`. So, for example, using the `fenced div` syntax, the
4587following would be incremental regardless of the document default:
4605While using `incremental` and `nonincremental` divs are the
4606recommended method of setting incremental lists on a per-case basis,
4607an older method is also supported: putting lists inside a blockquote
4608will depart from the document default (that is, it will display
4609incrementally without the `-i` option and all at once with the `-i`
4615Both methods allow incremental and nonincremental lists to be mixed
4616in a single document.
4621You can add "pauses" within a slide by including a paragraph containing
4622three dots, separated by spaces:
4624 # Slide with a pause
4626 content before the pause
4630 content after the pause
4635You can change the style of HTML slides by putting customized CSS files
4636in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
4637or `$DATADIR/slideous` (for Slideous),
4638where `$DATADIR` is the user data directory (see `--data-dir`, above).
4639The originals may be found in pandoc's system data directory (generally
4640`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
4641files it does not find in the user data directory.
4643For dzslides, the CSS is included in the HTML file itself, and may
4646All [reveal.js configuration options] can be set through variables.
4647For example, themes can be used by setting the `theme` variable:
4651Or you can specify a custom stylesheet using the `--css` option.
4653To style beamer slides, you can specify a `theme`, `colortheme`,
4654`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
4656 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4658Note that header attributes will turn into slide attributes
4659(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4660to style individual slides. In beamer, the only header attribute
4661that affects slides is the `allowframebreaks` class, which sets the
4662`allowframebreaks` option, causing multiple slides to be created
4663if the content overfills the frame. This is recommended especially for
4666 # References {.allowframebreaks}
4671Speaker notes are supported in reveal.js and PowerPoint (pptx)
4672output. You can add notes to your Markdown document thus:
4678 - It can contain Markdown
4683To show the notes window in reveal.js, press `s` while viewing the
4684presentation. Speaker notes in PowerPoint will be available, as usual,
4685in handouts and presenter view.
4687Notes are not yet supported for other slide formats, but the notes
4688will not appear on the slides themselves.
4693To put material in side by side columns, you can use a native
4694div container with class `columns`, containing two or more div
4695containers with class `column` and a `width` attribute:
4697 :::::::::::::: {.columns}
4698 ::: {.column width="40%"}
4701 ::: {.column width="60%"}
4706Frame attributes in beamer
4707--------------------------
4709Sometimes it is necessary to add the LaTeX `[fragile]` option to
4710a frame in beamer (for example, when using the `minted` environment).
4711This can be forced by adding the `fragile` class to the header
4712introducing the slide:
4714 # Fragile slide {.fragile}
4716All of the other frame attributes described in Section 8.1 of
4717the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4718`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4719`shrink`, `standout`, `noframenumbering`.
4721Background in reveal.js and beamer
4722----------------------------------
4724Background images can be added to self-contained reveal.js slideshows and
4725to beamer slideshows.
4727For the same image on every slide, use the configuration
4728option `background-image` either in the YAML metadata block
4729or as a command-line variable. (There are no other options in
4730beamer and the rest of this section concerns reveal.js slideshows.)
4732For reveal.js, you can instead use the reveal.js-native option
4733`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4734and `parallaxBackgroundVertical` the same way and must also set
4735`parallaxBackgroundSize` to have your values take effect.
4737To set an image for a particular reveal.js slide, add
4738`{data-background-image="/path/to/image"}`
4739to the first slide-level header on the slide (which may even be empty).
4741In reveal.js's overview mode, the parallaxBackgroundImage will show up
4742only on the first slide.
4744Other reveal.js background settings also work on individual slides, including
4745`data-background-size`, `data-background-repeat`, `data-background-color`,
4746`data-transition`, and `data-transition-speed`.
4749documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4752For example in reveal.js:
4757parallaxBackgroundImage: /path/to/my/background_image.png
4762Slide 1 has background_image.png as its background.
4764## {data-background-image="/path/to/special_image.jpg"}
4766Slide 2 has a special image for its background, even though the header has no content.
4769Creating EPUBs with pandoc
4770==========================
4775EPUB metadata may be specified using the `--epub-metadata` option, but
4776if the source document is Markdown, it is better to use a [YAML metadata
4777block][Extension: `yaml_metadata_block`]. Here is an example:
4784 text: An investigation of metadata
4792 text: doi:10.234234.234/33
4794 rights: © 2007 John Smith, CC BY-NC
4799The following fields are recognized:
4802 ~ Either a string value or an object with fields `text` and
4803 `scheme`. Valid values for `scheme` are `ISBN-10`,
4804 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
4805 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
4806 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
4809 ~ Either a string value, or an object with fields `file-as` and
4810 `type`, or a list of such objects. Valid values for `type` are
4811 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
4814 ~ Either a string value, or an object with fields `role`, `file-as`,
4815 and `text`, or a list of such objects. Valid values for `role` are
4816 [MARC relators], but
4817 pandoc will attempt to translate the human-readable versions
4818 (like "author" and "editor") to the appropriate marc relators.
4821 ~ Same format as `creator`.
4824 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
4825 Pandoc will attempt to convert other common date formats.
4827`lang` (or legacy: `language`)
4828 ~ A string value in [BCP 47] format. Pandoc will default to the local
4829 language if nothing is specified.
4832 ~ A string value or a list of such values.
4853 ~ A string value (path to cover image).
4855`css` (or legacy: `stylesheet`)
4856 ~ A string value (path to CSS stylesheet).
4858`page-progression-direction`
4859 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
4860 attribute for the [`spine` element].
4863 ~ iBooks-specific metadata, with the following fields:
4865 - `version`: (string)
4866 - `specified-fonts`: `true`|`false` (default `false`)
4867 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
4868 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
4869 - `binding`: `true`|`false` (default `true`)
4870 - `scroll-axis`: `vertical`|`horizontal`|`default`
4872[MARC relators]: http://loc.gov/marc/relators/relaterm.html
4873[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4875The `epub:type` attribute
4876-------------------------
4878For `epub3` output, you can mark up the header that corresponds to an EPUB
4879chapter using the [`epub:type` attribute][epub-type]. For example, to set
4880the attribute to the value `prologue`, use this markdown:
4882 # My chapter {epub:type=prologue}
4884Which will result in:
4886 <body epub:type="frontmatter">
4887 <section epub:type="prologue">
4890Pandoc will output `<body epub:type="bodymatter">`, unless
4891you use one of the following values, in which case either
4892`frontmatter` or `backmatter` will be output.
4894`epub:type` of first section `epub:type` of body
4895---------------------------- ------------------
4898acknowledgments frontmatter
4899copyright-page frontmatter
4900dedication frontmatter
4902halftitle, frontmatter
4903introduction frontmatter
4905seriespage frontmatter
4906titlepage frontmatter
4910conclusion backmatter
4913[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
4918By default, pandoc will download media referenced from any `<img>`, `<audio>`,
4919`<video>` or `<source>` element present in the generated EPUB,
4920and include it in the EPUB container, yielding a completely
4921self-contained EPUB. If you want to link to external media resources
4922instead, use raw HTML in your source and add `data-external="1"` to the tag
4923with the `src` attribute. For example:
4925 <audio controls="1">
4926 <source src="http://example.com/music/toccata.mp3"
4927 data-external="1" type="audio/mpeg">
4931Creating Jupyter notebooks with pandoc
4932======================================
4934When creating a [Jupyter notebook], pandoc will try to infer the
4935notebook structure. Code blocks with the class `code` will be
4936taken as code cells, and intervening content will be taken as
4937Markdown cells. Attachments will automatically be created for
4938images in Markdown cells. Metadata will be taken from the
4939`jupyter` metadata field. For example:
4948 display_name: Python 2
4955 file_extension: ".py"
4956 mimetype: "text/x-python"
4958 nbconvert_exporter: "python"
4959 pygments_lexer: "ipython2"
4965**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
4966bibendum felis dictum sodales.
4975from IPython.display import HTML
4978console.log("hello");
4986This image  will be
4987included as a cell attachment.
4990If you want to add cell attributes, group cells differently, or
4991add output to code cells, then you need to include divs to
4992indicate the structure. You can use either [fenced
4993divs][Extension: `fenced_divs`] or [native divs][Extension:
4994`native_divs`] for this. Here is an example:
4997:::::: {.cell .markdown}
5000**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5001bibendum felis dictum sodales.
5004:::::: {.cell .code execution_count=1}
5009::: {.output .stream .stdout}
5016:::::: {.cell .code execution_count=2}
5018from IPython.display import HTML
5021console.log("hello");
5027::: {.output .execute_result execution_count=2}
5030console.log("hello");
5039If you include raw HTML or TeX in an output cell, use the
5040[raw attribute][Extension: `fenced_attribute`], as shown
5041in the last cell of the example above. Although pandoc can
5042process "bare" raw HTML and TeX, the result is often
5043interspersed raw elements and normal textual elements, and
5044in an output cell pandoc expects a single, connected raw
5045block. To avoid using raw HTML or TeX except when
5046marked explicitly using raw attributes, we recommend
5047specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5048translating between Markdown and ipynb notebooks.
5054Pandoc will automatically highlight syntax in [fenced code blocks] that
5055are marked with a language name. The Haskell library [skylighting] is
5056used for highlighting. Currently highlighting is supported only for
5057HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5058that pandoc will recognize, type `pandoc --list-highlight-languages`.
5060The color scheme can be selected using the `--highlight-style` option.
5061The default color scheme is `pygments`, which imitates the default color
5062scheme used by the Python library pygments (though pygments is not actually
5063used to do the highlighting). To see a list of highlight styles,
5064type `pandoc --list-highlight-styles`.
5066If you are not satisfied with the predefined styles, you can
5067use `--print-highlight-style` to generate a JSON `.theme` file which
5068can be modified and used as the argument to `--highlight-style`. To
5069get a JSON version of the `pygments` style, for example:
5071 pandoc --print-highlight-style pygments > my.theme
5073Then edit `my.theme` and use it like this:
5075 pandoc --highlight-style my.theme
5077If you are not satisfied with the built-in highlighting, or you
5078want highlight a language that isn't supported, you can use the
5079`--syntax-definition` option to load a [KDE-style XML syntax definition
5080file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5081Before writing your own, have a look at KDE's [repository of syntax
5082definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5084To disable highlighting, use the `--no-highlight` option.
5086[skylighting]: https://github.com/jgm/skylighting
5091Custom styles can be used in the docx and ICML formats.
5096By default, pandoc's docx and ICML output applies a predefined set of styles
5097for blocks such as paragraphs and block quotes, and uses largely default
5098formatting (italics, bold) for inlines. This will work for most
5099purposes, especially alongside a `reference.docx` file. However, if you
5100need to apply your own styles to blocks, or match a preexisting set of
5101styles, pandoc allows you to define custom styles for blocks and text
5102using `div`s and `span`s, respectively.
5104If you define a `div` or `span` with the attribute `custom-style`,
5105pandoc will apply your specified style to the contained elements. So,
5106for example using the `bracketed_spans` syntax,
5108 [Get out]{custom-style="Emphatically"}, he said.
5110would produce a docx file with "Get out" styled with character
5111style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5113 Dickinson starts the poem simply:
5115 ::: {custom-style="Poetry"}
5116 | A Bird came down the Walk---
5117 | He did not know I saw---
5120would style the two contained lines with the `Poetry` paragraph style.
5122For docx output, styles will be defined in the output file as inheriting
5123from normal text, if the styles are not yet in your reference.docx.
5124If they are already defined, pandoc will not alter the definition.
5126This feature allows for greatest customization in conjunction with
5127[pandoc filters]. If you want all paragraphs after block quotes to be
5128indented, you can write a filter to apply the styles necessary. If you
5129want all italics to be transformed to the `Emphasis` character style
5130(perhaps to change their color), you can write a filter which will
5131transform all italicized inlines to inlines within an `Emphasis`
5134For docx output, you don't need to enable any extensions for
5135custom styles to work.
5137[pandoc filters]: http://pandoc.org/filters.html
5142The docx reader, by default, only reads those styles that it can
5143convert into pandoc elements, either by direct conversion or
5144interpreting the derivation of the input document's styles.
5146By enabling the [`styles` extension](#ext-styles) in the docx reader
5147(`-f docx+styles`), you can produce output that maintains the styles
5148of the input document, using the `custom-style` class. Paragraph
5149styles are interpreted as divs, while character styles are interpreted
5152For example, using the `custom-style-reference.docx` file in the test
5153directory, we have the following different outputs:
5155Without the `+styles` extension:
5157 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5160 This is text with an *emphasized* text style. And this is text with a
5161 **strengthened** text style.
5163 > Here is a styled paragraph that inherits from Block Text.
5165And with the extension:
5167 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5169 ::: {custom-style="FirstParagraph"}
5173 ::: {custom-style="BodyText"}
5174 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5175 And this is text with a [strengthened]{custom-style="Strengthened"}
5179 ::: {custom-style="MyBlockStyle"}
5180 > Here is a styled paragraph that inherits from Block Text.
5183With these custom styles, you can use your input document as a
5184reference-doc while creating docx output (see below), and maintain the
5185same styles in your input and output files.
5190Pandoc can be extended with custom writers written in [lua]. (Pandoc
5191includes a lua interpreter, so lua need not be installed separately.)
5193To use a custom writer, simply specify the path to the lua script
5194in place of the output format. For example:
5196 pandoc -t data/sample.lua
5198Creating a custom writer requires writing a lua function for each
5199possible element in a pandoc document. To get a documented example
5200which you can modify according to your needs, do
5202 pandoc --print-default-data-file sample.lua
5204[lua]: http://www.lua.org
5209If you use pandoc to convert user-contributed content in a web
5210application, here are some things to keep in mind:
52121. Although pandoc itself will not create or modify any files other
5213 than those you explicitly ask it create (with the exception
5214 of temporary files used in producing PDFs), a filter or custom
5215 writer could in principle do anything on your file system. Please
5216 audit filters and custom writers very carefully before using them.
52182. If your application uses pandoc as a Haskell library (rather than
5219 shelling out to the executable), it is possible to use it in a mode
5220 that fully isolates pandoc from your file system, by running the
5221 pandoc operations in the `PandocPure` monad. See the document
5222 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
52253. Pandoc's parsers can exhibit pathological performance on some
5226 corner cases. It is wise to put any pandoc operations under
5227 a timeout, to avoid DOS attacks that exploit these issues.
5228 If you are using the pandoc executable, you can add the
5229 command line options `+RTS -M512M -RTS` (for example) to limit
5230 the heap size to 512MB.
52324. The HTML generated by pandoc is not guaranteed to be safe.
5233 If `raw_html` is enabled for the Markdown input, users can
5234 inject arbitrary HTML. Even if `raw_html` is disabled,
5235 users can include dangerous content in attributes for
5236 headers, spans, and code blocks. To be safe, you should
5237 run all the generated HTML through an HTML sanitizer.
5242Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5243under the [GPL], version 2 or greater. This software carries no
5244warranty of any kind. (See COPYRIGHT for full copyright and
5245warranty notices.) For a full list of contributors, see the file
5246AUTHORS.md in the pandoc source code.
5248[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