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])
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. This is, in UNIX:
358 C:\Documents And Settings\USERNAME\Application Data\pandoc
360 and in Windows Vista or later:
362 C:\Users\USERNAME\AppData\Roaming\pandoc
364 You can find the default user data directory on your system by
365 looking at the output of `pandoc --version`.
366 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
367 `slidy`, `slideous`, or `s5` directory
368 placed in this directory will override pandoc's normal defaults.
372: Generate a bash completion script. To enable bash completion
373 with pandoc, add this to your `.bashrc`:
375 eval "$(pandoc --bash-completion)"
379: Give verbose debugging output. Currently this only has an effect
384: Suppress warning messages.
388: Exit with error status if there are any warnings.
392: Write log messages in machine-readable JSON format to
393 *FILE*. All messages above DEBUG level will be written,
394 regardless of verbosity settings (`--verbose`, `--quiet`).
396`--list-input-formats`
398: List supported input formats, one per line.
400`--list-output-formats`
402: List supported output formats, one per line.
404`--list-extensions`[`=`*FORMAT*]
406: List supported extensions, one per line, preceded
407 by a `+` or `-` indicating whether it is enabled by default
408 in *FORMAT*. If *FORMAT* is not specified, defaults for
409 pandoc's Markdown are given.
411`--list-highlight-languages`
413: List supported languages for syntax highlighting, one per
416`--list-highlight-styles`
418: List supported styles for syntax highlighting, one per line.
419 See `--highlight-style`.
429[Markdown]: http://daringfireball.net/projects/markdown/
430[CommonMark]: http://commonmark.org
431[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
432[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
433[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
434[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
435[S5]: http://meyerweb.com/eric/tools/s5/
436[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
437[Slideous]: http://goessner.net/articles/slideous/
438[HTML]: http://www.w3.org/html/
439[HTML5]: http://www.w3.org/TR/html5/
440[polyglot markup]: https://www.w3.org/TR/html-polyglot/
441[XHTML]: http://www.w3.org/TR/xhtml1/
442[LaTeX]: http://latex-project.org
443[`beamer`]: https://ctan.org/pkg/beamer
444[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
445[ConTeXt]: http://www.contextgarden.net/
446[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
447[DocBook]: http://docbook.org
448[JATS]: https://jats.nlm.nih.gov
449[txt2tags]: http://txt2tags.org
450[EPUB]: http://idpf.org/epub
451[OPML]: http://dev.opml.org/spec2.html
452[OpenDocument]: http://opendocument.xml.org
453[ODT]: http://en.wikipedia.org/wiki/OpenDocument
454[Textile]: http://redcloth.org/textile
455[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
456[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
457[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
458[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
459[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
460[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
461[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
462[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
463[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
464[Haskell]: https://www.haskell.org
465[GNU Texinfo]: http://www.gnu.org/software/texinfo/
466[Emacs Org mode]: http://orgmode.org
467[AsciiDoc]: http://www.methods.co.nz/asciidoc/
468[DZSlides]: http://paulrouget.com/dzslides/
469[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
470[PDF]: https://www.adobe.com/pdf/
471[reveal.js]: http://lab.hakim.se/reveal-js/
472[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
473[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
474[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
475[TEI Simple]: https://github.com/TEIC/TEI-Simple
476[Muse]: https://amusewiki.org/library/manual
477[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
478[Vimwiki]: https://vimwiki.github.io
480Reader options {.options}
483`--base-header-level=`*NUMBER*
485: Specify the base level for headers (defaults to 1).
487`--strip-empty-paragraphs`
489: *Deprecated. Use the `+empty_paragraphs` extension instead.*
490 Ignore paragraphs with no content. This option is useful
491 for converting word processing documents where users have
492 used empty paragraphs to create inter-paragraph space.
494`--indented-code-classes=`*CLASSES*
496: Specify classes to use for indented code blocks--for example,
497 `perl,numberLines` or `haskell`. Multiple classes may be separated
500`--default-image-extension=`*EXTENSION*
502: Specify a default extension to use when image paths/URLs have no
503 extension. This allows you to use the same source for formats that
504 require different kinds of images. Currently this option only affects
505 the Markdown and LaTeX readers.
509: Parse each file individually before combining for multifile
510 documents. This will allow footnotes in different files with the
511 same identifiers to work as expected. If this option is set,
512 footnotes and links will not work across files. Reading binary
513 files (docx, odt, epub) implies `--file-scope`.
515`-F` *PROGRAM*, `--filter=`*PROGRAM*
517: Specify an executable to be used as a filter transforming the
518 pandoc AST after the input is parsed and before the output is
519 written. The executable should read JSON from stdin and write
520 JSON to stdout. The JSON must be formatted like pandoc's own
521 JSON input and output. The name of the output format will be
522 passed to the filter as the first argument. Hence,
524 pandoc --filter ./caps.py -t latex
528 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
530 The latter form may be useful for debugging filters.
532 Filters may be written in any language. `Text.Pandoc.JSON`
533 exports `toJSONFilter` to facilitate writing filters in Haskell.
534 Those who would prefer to write filters in python can use the
535 module [`pandocfilters`], installable from PyPI. There are also
536 pandoc filter libraries in [PHP], [perl], and
537 [JavaScript/node.js].
539 In order of preference, pandoc will look for filters in
541 1. a specified full or relative path (executable or
544 2. `$DATADIR/filters` (executable or non-executable)
545 where `$DATADIR` is the user data directory (see
546 `--data-dir`, above).
548 3. `$PATH` (executable only)
550 Filters and lua-filters are applied in the order specified
553`--lua-filter=`*SCRIPT*
555: Transform the document in a similar fashion as JSON filters (see
556 `--filter`), but use pandoc's build-in lua filtering system. The given
557 lua script is expected to return a list of lua filters which will be
558 applied in order. Each lua filter must contain element-transforming
559 functions indexed by the name of the AST element on which the filter
560 function should be applied.
562 The `pandoc` lua module provides helper functions for element
563 creation. It is always loaded into the script's lua environment.
565 The following is an example lua script for macro-expansion:
567 function expand_hello_world(inline)
568 if inline.c == '{{helloworld}}' then
569 return pandoc.Emph{ pandoc.Str "Hello, World" }
575 return {{Str = expand_hello_world}}
577 In order of preference, pandoc will look for lua filters in
579 1. a specified full or relative path (executable or
582 2. `$DATADIR/filters` (executable or non-executable)
583 where `$DATADIR` is the user data directory (see
584 `--data-dir`, above).
586`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
588: Set the metadata field *KEY* to the value *VAL*. A value specified
589 on the command line overrides a value specified in the document
590 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
591 Values will be parsed as YAML boolean or string values. If no value is
592 specified, the value will be treated as Boolean true. Like
593 `--variable`, `--metadata` causes template variables to be set.
594 But unlike `--variable`, `--metadata` affects the metadata of the
595 underlying document (which is accessible from filters and may be
596 printed in some output formats) and metadata values will be escaped
597 when inserted into the template.
599`--metadata-file=`*FILE*
601: Read metadata from the supplied YAML (or JSON) file.
602 This option can be used with every input format, but string
603 scalars in the YAML file will always be parsed as Markdown.
604 Generally, the input will be handled the same as in
605 [YAML metadata blocks][Extension: `yaml_metadata_block`].
606 Metadata values specified inside the document, or by using `-M`,
607 overwrite values specified with this option.
609`-p`, `--preserve-tabs`
611: Preserve tabs instead of converting them to spaces (the default).
612 Note that this will only affect tabs in literal code spans and code
613 blocks; tabs in regular text will be treated as spaces.
617: Specify the number of spaces per tab (default is 4).
619`--track-changes=accept`|`reject`|`all`
621: Specifies what to do with insertions, deletions, and comments
622 produced by the MS Word "Track Changes" feature. `accept` (the
623 default), inserts all insertions, and ignores all
624 deletions. `reject` inserts all deletions and ignores
625 insertions. Both `accept` and `reject` ignore comments. `all` puts
626 in insertions, deletions, and comments, wrapped in spans with
627 `insertion`, `deletion`, `comment-start`, and `comment-end`
628 classes, respectively. The author and time of change is
629 included. `all` is useful for scripting: only accepting changes
630 from a certain reviewer, say, or before a certain date. If a
631 paragraph is inserted or deleted, `track-changes=all` produces a
632 span with the class `paragraph-insertion`/`paragraph-deletion`
633 before the affected paragraph break. This option only affects the
636`--extract-media=`*DIR*
638: Extract images and other media contained in or linked from
639 the source document to the path *DIR*, creating it if
640 necessary, and adjust the images references in the document
641 so they point to the extracted files. If the source format is
642 a binary container (docx, epub, or odt), the media is
643 extracted from the container and the original
644 filenames are used. Otherwise the media is read from the
645 file system or downloaded, and new filenames are constructed
646 based on SHA1 hashes of the contents.
648`--abbreviations=`*FILE*
650: Specifies a custom abbreviations file, with abbreviations
651 one to a line. If this option is not specified, pandoc will
652 read the data file `abbreviations` from the user data
653 directory or fall back on a system default. To see the
655 `pandoc --print-default-data-file=abbreviations`. The only
656 use pandoc makes of this list is in the Markdown reader.
657 Strings ending in a period that are found in this list will
658 be followed by a nonbreaking space, so that the period will
659 not produce sentence-ending space in formats like LaTeX.
661[`pandocfilters`]: https://github.com/jgm/pandocfilters
662[PHP]: https://github.com/vinai/pandocfilters-php
663[perl]: https://metacpan.org/pod/Pandoc::Filter
664[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
666General writer options {.options}
667----------------------
671: Produce output with an appropriate header and footer (e.g. a
672 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
673 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
674 output. For `native` output, this option causes metadata to
675 be included; otherwise, metadata is suppressed.
677`--template=`*FILE*|*URL*
679: Use the specified file as a custom template for the generated document.
680 Implies `--standalone`. See [Templates], below, for a description
681 of template syntax. If no extension is specified, an extension
682 corresponding to the writer will be added, so that `--template=special`
683 looks for `special.html` for HTML output. If the template is not
684 found, pandoc will search for it in the `templates` subdirectory of
685 the user data directory (see `--data-dir`). If this option is not used,
686 a default template appropriate for the output format will be used (see
687 `-D/--print-default-template`).
689`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
691: Set the template variable *KEY* to the value *VAL* when rendering the
692 document in standalone mode. This is generally only useful when the
693 `--template` option is used to specify a custom template, since
694 pandoc automatically sets the variables used in the default
695 templates. If no *VAL* is specified, the key will be given the
698`-D` *FORMAT*, `--print-default-template=`*FORMAT*
700: Print the system default template for an output *FORMAT*. (See `-t`
701 for a list of possible *FORMAT*s.) Templates in the user data
702 directory are ignored.
704`--print-default-data-file=`*FILE*
706: Print a system default data file. Files in the user data directory
709`--eol=crlf`|`lf`|`native`
711: Manually specify line endings: `crlf` (Windows), `lf`
712 (macOS/Linux/UNIX), or `native` (line endings appropriate
713 to the OS on which pandoc is being run). The default is
718: Specify the dpi (dots per inch) value for conversion from pixels
719 to inch/centimeters and vice versa. The default is 96dpi.
720 Technically, the correct term would be ppi (pixels per inch).
722`--wrap=auto`|`none`|`preserve`
724: Determine how text is wrapped in the output (the source
725 code, not the rendered version). With `auto` (the default),
726 pandoc will attempt to wrap lines to the column width specified by
727 `--columns` (default 72). With `none`, pandoc will not wrap
728 lines at all. With `preserve`, pandoc will attempt to
729 preserve the wrapping from the source document (that is,
730 where there are nonsemantic newlines in the source, there
731 will be nonsemantic newlines in the output as well).
732 Automatic wrapping does not currently work in HTML output.
733 In `ipynb` output, this option affects wrapping of the
734 contents of markdown cells.
738: Specify length of lines in characters. This affects text wrapping
739 in the generated source code (see `--wrap`). It also affects
740 calculation of column widths for plain text tables (see [Tables] below).
742`--toc`, `--table-of-contents`
744: Include an automatically generated table of contents (or, in
745 the case of `latex`, `context`, `docx`, `odt`,
746 `opendocument`, `rst`, or `ms`, an instruction to create
747 one) in the output document. This option has no effect
748 unless `-s/--standalone` is used, and it has no effect
749 on `man`, `docbook4`, `docbook5`, or `jats` output.
751`--toc-depth=`*NUMBER*
753: Specify the number of section levels to include in the table
754 of contents. The default is 3 (which means that level 1, 2, and 3
755 headers will be listed in the contents).
759: Strip out HTML comments in the Markdown or Textile source,
760 rather than passing them on to Markdown, Textile or HTML
761 output as raw HTML. This does not apply to HTML comments
762 inside raw HTML blocks when the `markdown_in_html_blocks`
763 extension is not set.
767: Disables syntax highlighting for code blocks and inlines, even when
768 a language attribute is given.
770`--highlight-style=`*STYLE*|*FILE*
772: Specifies the coloring style to be used in highlighted source code.
773 Options are `pygments` (the default), `kate`, `monochrome`,
774 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
775 For more information on syntax highlighting in pandoc, see
776 [Syntax highlighting], below. See also
777 `--list-highlight-styles`.
779 Instead of a *STYLE* name, a JSON file with extension
780 `.theme` may be supplied. This will be parsed as a KDE
781 syntax highlighting theme and (if valid) used as the
784 To generate the JSON version of an existing style,
785 use `--print-highlight-style`.
787`--print-highlight-style=`*STYLE*|*FILE*
789: Prints a JSON version of a highlighting style, which can
790 be modified, saved with a `.theme` extension, and used
791 with `--highlight-style`.
793`--syntax-definition=`*FILE*
795: Instructs pandoc to load a KDE XML syntax definition file,
796 which will be used for syntax highlighting of appropriately
797 marked code blocks. This can be used to add support for
798 new languages or to use altered syntax definitions for
801`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
803: Include contents of *FILE*, verbatim, at the end of the header.
804 This can be used, for example, to include special
805 CSS or JavaScript in HTML documents. This option can be used
806 repeatedly to include multiple files in the header. They will be
807 included in the order specified. Implies `--standalone`.
809`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
811: Include contents of *FILE*, verbatim, at the beginning of the
812 document body (e.g. after the `<body>` tag in HTML, or the
813 `\begin{document}` command in LaTeX). This can be used to include
814 navigation bars or banners in HTML documents. This option can be
815 used repeatedly to include multiple files. They will be included in
816 the order specified. Implies `--standalone`.
818`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
820: Include contents of *FILE*, verbatim, at the end of the document
821 body (before the `</body>` tag in HTML, or the
822 `\end{document}` command in LaTeX). This option can be used
823 repeatedly to include multiple files. They will be included in the
824 order specified. Implies `--standalone`.
826`--resource-path=`*SEARCHPATH*
828: List of paths to search for images and other resources.
829 The paths should be separated by `:` on Linux, UNIX, and
830 macOS systems, and by `;` on Windows. If `--resource-path`
831 is not specified, the default resource path is the working
832 directory. Note that, if `--resource-path` is specified,
833 the working directory must be explicitly listed or it
834 will not be searched. For example:
835 `--resource-path=.:test` will search the working directory
836 and the `test` subdirectory, in that order.
838 `--resource-path` only has an effect if (a) the output
839 format embeds images (for example, `docx`, `pdf`, or `html`
840 with `--self-contained`) or (b) it is used together with
843`--request-header=`*NAME*`:`*VAL*
845: Set the request header *NAME* to the value *VAL* when making
846 HTTP requests (for example, when a URL is given on the
847 command line, or when resources used in a document must be
848 downloaded). If you're behind a proxy, you also need to set
849 the environment variable `http_proxy` to `http://...`.
851Options affecting specific writers {.options}
852----------------------------------
856: Produce a standalone HTML file with no external dependencies, using
857 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
858 images, and videos. Implies `--standalone`. The resulting file should be
859 "self-contained," in the sense that it needs no external files and no net
860 access to be displayed properly by a browser. This option works only with
861 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
862 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
863 and stylesheets at absolute URLs will be downloaded; those at relative
864 URLs will be sought relative to the working directory (if the first source
865 file is local) or relative to the base URL (if the first source
866 file is remote). Elements with the attribute
867 `data-external="1"` will be left alone; the documents they
868 link to will not be incorporated in the document.
869 Limitation: resources that are loaded dynamically through
870 JavaScript cannot be incorporated; as a result,
871 `--self-contained` does not work with `--mathjax`, and some
872 advanced features (e.g. zoom or speaker notes) may not work
873 in an offline "self-contained" `reveal.js` slide show.
877: Use `<q>` tags for quotes in HTML.
881: Use only ASCII characters in output. Currently supported for XML
882 and HTML formats (which use entities instead of UTF-8 when this
883 option is selected), CommonMark, gfm, and Markdown (which use
884 entities), roff ms (which use hexadecimal escapes), and to a
885 limited degree LaTeX (which uses standard commands for accented
886 characters when possible). roff man output uses ASCII by default.
890: Use reference-style links, rather than inline links, in writing Markdown
891 or reStructuredText. By default inline links are used. The
892 placement of link references is affected by the
893 `--reference-location` option.
895`--reference-location = block`|`section`|`document`
897: Specify whether footnotes (and references, if `reference-links` is
898 set) are placed at the end of the current (top-level) block, the
899 current section, or the document. The default is
900 `document`. Currently only affects the markdown writer.
904: Use ATX-style headers in Markdown output. The default is
905 to use setext-style headers for levels 1-2, and then ATX headers.
906 (Note: for `gfm` output, ATX headers are always used.)
907 This option also affects markdown cells in `ipynb` output.
909`--top-level-division=[default|section|chapter|part]`
911: Treat top-level headers as the given division type in LaTeX, ConTeXt,
912 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
913 all headers are shifted such that the top-level header becomes the specified
914 type. The default behavior is to determine the best division type via
915 heuristics: unless other conditions apply, `section` is chosen. When the
916 LaTeX document class is set to `report`, `book`, or `memoir` (unless the
917 `article` option is specified), `chapter` is implied as the setting for this
918 option. If `beamer` is the output format, specifying either `chapter` or
919 `part` will cause top-level headers to become `\part{..}`, while
920 second-level headers remain as their default type.
922`-N`, `--number-sections`
924: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
925 By default, sections are not numbered. Sections with class
926 `unnumbered` will never be numbered, even if `--number-sections`
929`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
931: Offset for section headings in HTML output (ignored in other
932 output formats). The first number is added to the section number for
933 top-level headers, the second for second-level headers, and so on.
934 So, for example, if you want the first top-level header in your
935 document to be numbered "6", specify `--number-offset=5`.
936 If your document starts with a level-2 header which you want to
937 be numbered "1.5", specify `--number-offset=1,4`.
938 Offsets are 0 by default. Implies `--number-sections`.
942: Use the [`listings`] package for LaTeX code blocks. The package
943 does not support multi-byte encoding for source code. To handle UTF-8
944 you would need to use a custom template. This issue is fully
945 documented here: [Encoding issue with the listings package].
949: Make list items in slide shows display incrementally (one by one).
950 The default is for lists to be displayed all at once.
952`--slide-level=`*NUMBER*
954: Specifies that headers with the specified level create
955 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
956 above this level in the hierarchy are used to divide the
957 slide show into sections; headers below this level create
958 subheads within a slide. Note that content that is
959 not contained under slide-level headers will not appear in
960 the slide show. The default is to set the slide level based
961 on the contents of the document; see [Structuring the slide
966: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
967 and attach identifiers to the enclosing `<section>` (or `<div>`)
968 rather than the header itself. See
969 [Header identifiers], below.
971`--email-obfuscation=none`|`javascript`|`references`
973: Specify a method for obfuscating `mailto:` links in HTML documents.
974 `none` leaves `mailto:` links as they are. `javascript` obfuscates
975 them using JavaScript. `references` obfuscates them by printing their
976 letters as decimal or hexadecimal character references. The default
979`--id-prefix=`*STRING*
981: Specify a prefix to be added to all identifiers and internal links
982 in HTML and DocBook output, and to footnote numbers in Markdown
983 and Haddock output. This is useful for preventing duplicate
984 identifiers when generating fragments to be included in other pages.
986`-T` *STRING*, `--title-prefix=`*STRING*
988: Specify *STRING* as a prefix at the beginning of the title
989 that appears in the HTML header (but not in the title as it
990 appears at the beginning of the HTML body). Implies
993`-c` *URL*, `--css=`*URL*
995: Link to a CSS style sheet. This option can be used repeatedly to
996 include multiple files. They will be included in the order specified.
998 A stylesheet is required for generating EPUB. If none is
999 provided using this option (or the `css` or `stylesheet`
1000 metadata fields), pandoc will look for a file `epub.css` in the
1001 user data directory (see `--data-dir`). If it is not
1002 found there, sensible defaults will be used.
1004`--reference-doc=`*FILE*
1006: Use the specified file as a style reference in producing a
1011 : For best results, the reference docx should be a modified
1012 version of a docx file produced using pandoc. The contents
1013 of the reference docx are ignored, but its stylesheets and
1014 document properties (including margins, page size, header,
1015 and footer) are used in the new docx. If no reference docx
1016 is specified on the command line, pandoc will look for a
1017 file `reference.docx` in the user data directory (see
1018 `--data-dir`). If this is not found either, sensible
1019 defaults will be used.
1021 To produce a custom `reference.docx`, first get a copy of
1022 the default `reference.docx`: `pandoc
1023 --print-default-data-file reference.docx >
1024 custom-reference.docx`. Then open `custom-reference.docx`
1025 in Word, modify the styles as you wish, and save the file.
1026 For best results, do not make changes to this file other
1027 than modifying the styles used by pandoc:
1063 - Default Paragraph Font
1066 - Footnote Reference
1075 : For best results, the reference ODT should be a modified
1076 version of an ODT produced using pandoc. The contents of
1077 the reference ODT are ignored, but its stylesheets are used
1078 in the new ODT. If no reference ODT is specified on the
1079 command line, pandoc will look for a file `reference.odt` in
1080 the user data directory (see `--data-dir`). If this is not
1081 found either, sensible defaults will be used.
1083 To produce a custom `reference.odt`, first get a copy of
1084 the default `reference.odt`: `pandoc
1085 --print-default-data-file reference.odt >
1086 custom-reference.odt`. Then open `custom-reference.odt` in
1087 LibreOffice, modify the styles as you wish, and save the
1092 : Any template included with a recent install of Microsoft
1093 PowerPoint (either with `.pptx` or `.potx` extension) should
1094 work, as will most templates derived from these.
1096 The specific requirement is that the template should contain
1097 the following four layouts as its first four layouts:
1100 2. Title and Content
1104 All templates included with a recent version of MS PowerPoint
1105 will fit these criteria. (You can click on `Layout` under the
1106 `Home` menu to check.)
1108 You can also modify the default `reference.pptx`: first run
1109 `pandoc --print-default-data-file reference.pptx >
1110 custom-reference.pptx`, and then modify
1111 `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1112 first four layout slides, as mentioned above).
1114`--epub-cover-image=`*FILE*
1116: Use the specified image as the EPUB cover. It is recommended
1117 that the image be less than 1000px in width and height. Note that
1118 in a Markdown source document you can also specify `cover-image`
1119 in a YAML metadata block (see [EPUB Metadata], below).
1121`--epub-metadata=`*FILE*
1123: Look in the specified XML file for metadata for the EPUB.
1124 The file should contain a series of [Dublin Core elements].
1127 <dc:rights>Creative Commons</dc:rights>
1128 <dc:language>es-AR</dc:language>
1130 By default, pandoc will include the following metadata elements:
1131 `<dc:title>` (from the document title), `<dc:creator>` (from the
1132 document authors), `<dc:date>` (from the document date, which should
1133 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1134 variable, or, if is not set, the locale), and `<dc:identifier
1135 id="BookId">` (a randomly generated UUID). Any of these may be
1136 overridden by elements in the metadata file.
1138 Note: if the source document is Markdown, a YAML metadata block
1139 in the document can be used instead. See below under
1142`--epub-embed-font=`*FILE*
1144: Embed the specified font in the EPUB. This option can be repeated
1145 to embed multiple fonts. Wildcards can also be used: for example,
1146 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1147 line, be sure to escape them or put the whole filename in single quotes,
1148 to prevent them from being interpreted by the shell. To use the
1149 embedded fonts, you will need to add declarations like the following
1150 to your CSS (see `--css`):
1153 font-family: DejaVuSans;
1155 font-weight: normal;
1156 src:url("DejaVuSans-Regular.ttf");
1159 font-family: DejaVuSans;
1162 src:url("DejaVuSans-Bold.ttf");
1165 font-family: DejaVuSans;
1167 font-weight: normal;
1168 src:url("DejaVuSans-Oblique.ttf");
1171 font-family: DejaVuSans;
1174 src:url("DejaVuSans-BoldOblique.ttf");
1176 body { font-family: "DejaVuSans"; }
1178`--epub-chapter-level=`*NUMBER*
1180: Specify the header level at which to split the EPUB into separate
1181 "chapter" files. The default is to split into chapters at level 1
1182 headers. This option only affects the internal composition of the
1183 EPUB, not the way chapters and sections are displayed to users. Some
1184 readers may be slow if the chapter files are too large, so for large
1185 documents with few level 1 headers, one might want to use a chapter
1188`--epub-subdirectory=`*DIRNAME*
1190: Specify the subdirectory in the OCF container that is to hold
1191 the EPUB-specific contents. The default is `EPUB`. To put
1192 the EPUB contents in the top level, use an empty string.
1194`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1196: Use the specified engine when producing PDF output.
1197 The default is `pdflatex`. If the engine is not in your PATH,
1198 the full path of the engine may be specified here.
1200`--pdf-engine-opt=`*STRING*
1202: Use the given string as a command-line argument to the `pdf-engine`.
1203 If used multiple times, the arguments are provided with spaces between
1204 them. Note that no check for duplicate options is done.
1206[Dublin Core elements]: http://dublincore.org/documents/dces/
1207[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1208[Encoding issue with the listings package]:
1209 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1211Citation rendering {.options}
1214`--bibliography=`*FILE*
1216: Set the `bibliography` field in the document's metadata to *FILE*,
1217 overriding any value set in the metadata, and process citations
1218 using `pandoc-citeproc`. (This is equivalent to
1219 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1220 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1221 used, making this equivalent to `--metadata bibliography=FILE`.
1222 If you supply this argument multiple times, each *FILE* will be added
1227: Set the `csl` field in the document's metadata to *FILE*,
1228 overriding any value set in the metadata. (This is equivalent to
1229 `--metadata csl=FILE`.)
1230 This option is only relevant with `pandoc-citeproc`.
1232`--citation-abbreviations=`*FILE*
1234: Set the `citation-abbreviations` field in the document's metadata to
1235 *FILE*, overriding any value set in the metadata. (This is equivalent to
1236 `--metadata citation-abbreviations=FILE`.)
1237 This option is only relevant with `pandoc-citeproc`.
1241: Use [`natbib`] for citations in LaTeX output. This option is not for use
1242 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1243 use in producing a LaTeX file that can be processed with [`bibtex`].
1247: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1248 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1249 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1251Math rendering in HTML {.options}
1252----------------------
1254The default is to render TeX math as far as possible using Unicode characters.
1255Formulas are put inside a `span` with `class="math"`, so that they may be styled
1256differently from the surrounding text if needed. However, this gives acceptable
1257results only for basic math, usually you will want to use `--mathjax` or another
1258of the following options.
1260`--mathjax`[`=`*URL*]
1262: Use [MathJax] to display embedded TeX math in HTML output.
1263 TeX math will be put between `\(...\)` (for inline math)
1264 or `\[...\]` (for display math) and wrapped in `<span>` tags
1265 with class `math`. Then the MathJax JavaScript will render it.
1266 The *URL* should point to the `MathJax.js` load script.
1267 If a *URL* is not provided, a link to the Cloudflare CDN will
1272: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1273 `html4` and `html5`). This is the default in `odt` output. Note that
1274 currently only Firefox and Safari (and select e-book readers) natively
1279: Convert TeX formulas to `<img>` tags that link to an external script
1280 that converts formulas to images. The formula will be URL-encoded
1281 and concatenated with the URL provided. For SVG images you can for
1282 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1283 If no URL is specified, the CodeCogs URL generating PNGs
1284 will be used (`https://latex.codecogs.com/png.latex?`).
1285 Note: the `--webtex` option will affect Markdown output
1286 as well as HTML, which is useful if you're targeting a
1287 version of Markdown without native math support.
1291: Use [KaTeX] to display embedded TeX math in HTML output.
1292 The *URL* is the base URL for the KaTeX library. That directory
1293 should contain a `katex.min.js` and a `katex.min.css` file.
1294 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1298: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1299 can then be processed by [GladTeX] to produce images of the typeset
1300 formulas and an HTML file with links to these images.
1301 So, the procedure is:
1303 pandoc -s --gladtex input.md -o myfile.htex
1304 gladtex -d myfile-images myfile.htex
1305 # produces myfile.html and images in myfile-images
1307[MathML]: http://www.w3.org/Math/
1308[MathJax]: https://www.mathjax.org
1309[KaTeX]: https://github.com/Khan/KaTeX
1310[GladTeX]: http://humenda.github.io/GladTeX/
1312Options for wrapper scripts {.options}
1313---------------------------
1317: Print information about command-line arguments to *stdout*, then exit.
1318 This option is intended primarily for use in wrapper scripts.
1319 The first line of output contains the name of the output file specified
1320 with the `-o` option, or `-` (for *stdout*) if no output file was
1321 specified. The remaining lines contain the command-line arguments,
1322 one per line, in the order they appear. These do not include regular
1323 pandoc options and their arguments, but do include any options appearing
1324 after a `--` separator at the end of the line.
1328: Ignore command-line arguments (for use in wrapper scripts).
1329 Regular pandoc options are not ignored. Thus, for example,
1331 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1335 pandoc -o foo.html -s
1340When the `-s/--standalone` option is used, pandoc uses a template to
1341add header and footer material that is needed for a self-standing
1342document. To see the default template that is used, just type
1346where *FORMAT* is the name of the output format. A custom template
1347can be specified using the `--template` option. You can also override
1348the system default templates for a given output format *FORMAT*
1349by putting a file `templates/default.*FORMAT*` in the user data
1350directory (see `--data-dir`, above). *Exceptions:*
1352- For `odt` output, customize the `default.opendocument`
1354- For `pdf` output, customize the `default.latex` template
1355 (or the `default.context` template, if you use `-t context`,
1356 or the `default.ms` template, if you use `-t ms`, or the
1357 `default.html` template, if you use `-t html`).
1358- `docx` and `pptx` have no template (however, you can use
1359 `--reference-doc` to customize the output).
1361Templates contain *variables*, which allow for the inclusion of
1362arbitrary information at any point in the file. They may be set at the
1363command line using the `-V/--variable` option. If a variable is not set,
1364pandoc will look for the key in the document's metadata – which can be set
1365using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1366or with the `-M/--metadata` option.
1371`title`, `author`, `date`
1372: allow identification of basic aspects of the document. Included
1373 in PDF metadata through LaTeX and ConTeXt. These can be set
1374 through a [pandoc title block][Extension: `pandoc_title_block`],
1375 which allows for multiple authors, or through a YAML metadata block:
1384: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
1388: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
1392: list of keywords to be included in HTML, PDF, ODT, pptx, docx
1393 and AsciiDoc metadata; repeat as for `author`, above
1396: document subject, included in ODT, docx and pptx metadata
1399: document description, included in ODT, docx and pptx metadata. Some
1400 applications show this as `Comments` metadata.
1403: document category, included in docx and pptx metadata
1406any root-level string metadata, not included in ODT, docx
1407or pptx metadata is added as a *custom property*.
1408The following YAML metadata block for instance:
1411 title: 'This is the title'
1412 subtitle: "This is the subtitle"
1420 It consists of two paragraphs
1423will include `title`, `author` and `description` as standard document
1424properties and `subtitle` as a custom property when converting to docx,
1431: identifies the main language of the document using IETF language
1432 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
1433 The [Language subtag lookup] tool can look up or verify these tags.
1434 This affects most formats, and controls hyphenation in PDF output
1435 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
1437 Use native pandoc [Divs and Spans] with the `lang` attribute to
1438 switch the language:
1444 Text in the main document language (British English).
1447 > Cette citation est écrite en français canadien.
1450 More text in English. ['Zitat auf Deutsch.']{lang=de}
1453: the base script direction, either `rtl` (right-to-left)
1454 or `ltr` (left-to-right).
1456 For bidirectional documents, native pandoc `span`s and `div`s
1457 with the `dir` attribute (value `rtl` or `ltr`) can be used to
1458 override the base direction in some output formats.
1459 This may not always be necessary if the final renderer
1460 (e.g. the browser, when generating HTML) supports the
1461 [Unicode Bidirectional Algorithm].
1463 When using LaTeX for bidirectional documents, only the `xelatex` engine
1464 is fully supported (use `--pdf-engine=xelatex`).
1466[BCP 47]: https://tools.ietf.org/html/bcp47
1467[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1468[Language subtag lookup]: https://r12a.github.io/app-subtags/
1470Variables for HTML slides
1471-------------------------
1473These affect HTML output when [producing slide shows with pandoc].
1474All [reveal.js configuration options] are available as variables.
1477: base URL for reveal.js documents (defaults to `reveal.js`)
1480: base URL for S5 documents (defaults to `s5/default`)
1483: base URL for Slidy documents (defaults to
1484 `https://www.w3.org/Talks/Tools/Slidy2`)
1487: base URL for Slideous documents (defaults to `slideous`)
1489[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1491Variables for Beamer slides
1492---------------------------
1494These variables change the appearance of PDF slides using [`beamer`].
1497: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
1498 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
1502: produce an article from Beamer slides
1505: add extra beamer option with `\setbeameroption{}`
1508: author affiliations: can be a list when there are multiple authors
1511: logo image for slides
1514: controls navigation symbols (default is `empty` for no navigation
1515 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
1518: enables "title pages" for new sections (default is true)
1520`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1524: options for LaTeX beamer themes (a list).
1527: image for title slide
1532Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1537: option for document class, e.g. `oneside`; repeat for multiple options
1540: document class: usually one of the standard classes, [`article`], [`report`],
1541 and [`book`]; the [KOMA-Script] equivalents, `scrartcl`, `scrreprt`,
1542 and `scrbook`, which default to smaller margins; or [`memoir`]
1545: option for [`geometry`] package, e.g. `margin=1in`;
1546 repeat for multiple options
1549: uses document class settings for indentation (the default LaTeX template
1550 otherwise removes indentation and adds space between paragraphs)
1553: adjusts line spacing using the [`setspace`]
1554 package, e.g. `1.25`, `1.5`
1556`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1557: sets margins if `geometry` is not used (otherwise `geometry`
1561: control `\pagestyle{}`: the default article class
1562 supports `plain` (default), `empty` (no running heads or page numbers),
1563 and `headings` (section titles in running heads)
1566: paper size, e.g. `letter`, `a4`
1569: numbering depth for sections (with `--number-sections` option
1570 or `numbersections` variable)
1573: disables default behavior of LaTeX template that redefines (sub)paragraphs
1574 as sections, changing the appearance of nested headings in some classes
1579: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1580 default is `T1` (see [LaTeX font encodings guide])
1583: font package for use with `pdflatex`:
1584 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1585 The default is [Latin Modern][`lm`].
1588: options for package used as `fontfamily`; repeat for multiple options.
1589 For example, to use the Libertine font with proportional lowercase
1590 (old-style) figures through the [`libertinus`] package:
1593 fontfamily: libertinus
1600: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1601 To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1602 such as `scrartcl` or `scrbook`.
1604`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1605: font families for use with `xelatex` or
1606 `lualatex`: take the name of any system font, using the
1607 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
1609`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1610: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1611 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1612 available through [`fontspec`]; repeat for multiple options. For example,
1613 to use the [TeX Gyre] version of Palatino with lowercase figures:
1616 mainfont: TeX Gyre Pagella
1619 - Numbers=Proportional
1623: options to pass to the microtype package
1628: add color to link text; automatically enabled if any of
1629 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
1631`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1632: color for internal links, external links, citation links, linked
1633 URLs, and links in table of contents, respectively: uses options
1634 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1638: causes links to be printed as footnotes
1643: include list of figures, list of tables
1646: contents of acknowledgments footnote after document title
1649: include table of contents (can also be set using `--toc/--table-of-contents`)
1652: level of section to include in table of contents
1654### BibLaTeX Bibliographies
1656These variables function when using BibLaTeX for [citation rendering].
1659: list of options for biblatex
1662: bibliography style, when used with `--natbib` and `--biblatex`.
1665: bibliography title, when used with `--natbib` and `--biblatex`.
1668: bibliography to use for resolving references
1671: list of options for natbib
1673[KOMA-Script]: https://ctan.org/pkg/koma-script
1674[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1675[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
1676[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
1677[`article`]: https://ctan.org/pkg/article
1678[`book`]: https://ctan.org/pkg/book
1679[`libertinus`]: https://ctan.org/pkg/libertinus
1680[`memoir`]: https://ctan.org/pkg/memoir
1681[`report`]: https://ctan.org/pkg/report
1683Variables for ConTeXt
1684---------------------
1686Pandoc uses these variables when [creating a PDF] with ConTeXt.
1689: font size for body text (e.g. `10pt`, `12pt`)
1691`headertext`, `footertext`
1692: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1693 repeat up to four times for different placement
1696: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1697 repeat for multiple options
1700: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1701 repeat for multiple options
1704: options for page margins and text arrangement (see [ConTeXt Layout]);
1705 repeat for multiple options
1707`linkcolor`, `contrastcolor`
1708: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
1711: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
1714: include list of figures, list of tables
1716`mainfont`, `sansfont`, `monofont`, `mathfont`
1717: font families: take the name of any system font (see [ConTeXt Font Switching])
1719`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1720: sets margins, if `layout` is not used (otherwise `layout`
1724: page number style and location (using [`setuppagenumbering`]);
1725 repeat for multiple options
1728: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1729 repeat for multiple options
1732: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1733 To successfully generate PDF/A the required ICC color profiles have to
1734 be available and the content and all included files (such as images)
1735 have to be standard conforming. The ICC profiles can be obtained
1736 from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1740: include table of contents (can also be set using `--toc/--table-of-contents`)
1743: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1745[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1746[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
1747[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
1748[ConTeXt Color]: https://wiki.contextgarden.net/Color
1749[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
1750[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
1751[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
1752[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
1753[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
1754[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1755[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
1757Variables for `wkhtmltopdf`
1758---------------------------
1760Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
1761The `--css` option also affects the output.
1763`footer-html`, `header-html`
1764: add information to the header and footer
1766`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1767: set the page margins
1770: sets the PDF paper size
1772Variables for man pages
1773-----------------------
1776: adjusts text to left (`l`), right (`r`), center (`c`),
1777 or both (`b`) margins
1780: footer in man pages
1783: header in man pages
1786: if `true` (the default), hyphenation will be used
1789: section number in man pages
1795: font family (e.g. `T` or `P`)
1798: paragraph indent (e.g. `2m`)
1801: line height (e.g. `12p`)
1804: point size (e.g. `10p`)
1809Pandoc sets these variables automatically in response to [options] or
1810document contents; users can also modify them. These vary depending
1811on the output format, and include the following:
1817: the `date` variable converted to ISO 8601 YYYY-MM-DD,
1818 included in all HTML based formats (dzslides, epub,
1819 html, html4, html5, revealjs, s5, slideous, slidy).
1820 The recognized formats for `date` are: `mm/dd/yyyy`,
1821 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
1822 (e.g. either `02 Apr 2018` or `02 April 2018`),
1823 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
1824 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
1827: contents specified by `-H/--include-in-header` (may have multiple
1831: contents specified by `-B/--include-before-body` (may have
1835: contents specified by `-A/--include-after-body` (may have
1839: JSON representation of all of the document's metadata. Field
1840 values are transformed to the selected output format.
1843: non-null value if `-N/--number-sections` was specified
1845`sourcefile`, `outputfile`
1846: source and destination filenames, as given on the command line.
1847 `sourcefile` can also be a list if input comes from multiple files, or empty
1848 if input is from stdin. You can use the following snippet in your template
1849 to distinguish them:
1859 Similarly, `outputfile` can be `-` if output goes to the terminal.
1862: non-null value if `--toc/--table-of-contents` was specified
1865: title of table of contents (works only with EPUB,
1866 opendocument, odt, docx, pptx, beamer, LaTeX)
1868Using variables in templates
1869----------------------------
1871Variable names are sequences of alphanumerics, `-`, and `_`,
1872starting with a letter. A variable name surrounded by `$` signs
1873will be replaced by its value. For example, the string `$title$` in
1875 <title>$title$</title>
1877will be replaced by the document title.
1879To write a literal `$` in a template, use `$$`.
1881Templates may contain conditionals. The syntax is as follows:
1889This will include `X` in the template if `variable` has a truthy
1890value; otherwise it will include `Y`. Here a truthy value is any
1893- a string that is not entirely white space,
1894- a non-empty array where the first value is truthy,
1895- any number (including zero),
1897- the boolean `true` (to specify the boolean `true`
1898 value using YAML metadata or the `--metadata` flag,
1899 use `true`, `True`, or `TRUE`; with the `--variable`
1900 flag, simply omit a value for the variable, e.g.
1901 `--variable draft`).
1903`X` and `Y` are placeholders for any valid template text,
1904and may include interpolated variables or other conditionals.
1905The `$else$` section may be omitted.
1907When variables can have multiple values (for example, `author` in
1908a multi-author document), you can use the `$for$` keyword:
1911 <meta name="author" content="$author$" />
1914You can optionally specify a separator to be used between
1917 $for(author)$$author$$sep$, $endfor$
1919Note that the separator needs to be specified immediately before the `$endfor`
1922A dot can be used to select a field of a variable that takes
1923an object as its value. So, for example:
1925 $author.name$ ($author.affiliation$)
1927If you use custom templates, you may need to revise them as pandoc
1928changes. We recommend tracking the changes in the default templates,
1929and modifying your custom templates accordingly. An easy way to do this
1930is to fork the [pandoc-templates] repository and merge in changes after each
1933Templates may contain comments: anything on a line after `$--`
1934will be treated as a comment and ignored.
1936[pandoc-templates]: https://github.com/jgm/pandoc-templates
1941The behavior of some of the readers and writers can be adjusted by
1942enabling or disabling various extensions.
1944An extension can be enabled by adding `+EXTENSION`
1945to the format name and disabled by adding `-EXTENSION`. For example,
1946`--from markdown_strict+footnotes` is strict Markdown with footnotes
1947enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
1948Markdown without footnotes or pipe tables.
1950The markdown reader and writer make by far the most use of extensions.
1951Extensions only used by them are therefore covered in the
1952section [Pandoc's Markdown] below (See [Markdown variants] for
1953`commonmark` and `gfm`.) In the following, extensions that also work
1954for other formats are covered.
1956Note that markdown extensions added to the `ipynb` format
1957affect Markdown cells in Jupyter notebooks (as do command-line
1958options like `--atx-headers`).
1963#### Extension: `smart` ####
1965Interpret straight quotes as curly quotes, `---` as em-dashes,
1966`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
1967inserted after certain abbreviations, such as "Mr."
1969This extension can be enabled/disabled for the following formats:
1972: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
1975: `markdown`, `latex`, `context`, `rst`
1977enabled by default in
1978: `markdown`, `latex`, `context` (both input and output)
1980Note: If you are *writing* Markdown, then the `smart` extension
1981has the reverse effect: what would have been curly quotes comes
1984In LaTeX, `smart` means to use the standard TeX ligatures
1985for quotation marks (` `` ` and ` '' ` for double quotes,
1986`` ` `` and `` ' `` for single quotes) and dashes (`--` for
1987en-dash and `---` for em-dash). If `smart` is disabled,
1988then in reading LaTeX pandoc will parse these characters
1989literally. In writing LaTeX, enabling `smart` tells pandoc
1990to use the ligatures when possible; if `smart` is disabled
1991pandoc will use unicode quotation mark and dash characters.
1996#### Extension: `auto_identifiers` ####
1998A header without an explicitly specified identifier will be
1999automatically assigned a unique identifier based on the header text.
2001This extension can be enabled/disabled for the following formats:
2004: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2009enabled by default in
2012The default algorithm used to derive the identifier from the
2015 - Remove all formatting, links, etc.
2016 - Remove all footnotes.
2017 - Remove all non-alphanumeric characters,
2018 except underscores, hyphens, and periods.
2019 - Replace all spaces and newlines with hyphens.
2020 - Convert all alphabetic characters to lowercase.
2021 - Remove everything up to the first letter (identifiers may
2022 not begin with a number or punctuation mark).
2023 - If nothing is left after this, use the identifier `section`.
2028 ------------------------------- ----------------------------
2029 `Header identifiers in HTML` `header-identifiers-in-html`
2030 `Maître d'hôtel` `maître-dhôtel`
2031 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2032 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2033 `3. Applications` `applications`
2036These rules should, in most cases, allow one to determine the identifier
2037from the header text. The exception is when several headers have the
2038same text; in this case, the first will get an identifier as described
2039above; the second will get the same identifier with `-1` appended; the
2040third with `-2`; and so on.
2042(However, a different algorithm is used if
2043`gfm_auto_identifiers` is enabled; see below.)
2045These identifiers are used to provide link targets in the table of
2046contents generated by the `--toc|--table-of-contents` option. They
2047also make it easy to provide links from one section of a document to
2048another. A link to this section, for example, might look like this:
2051 [header identifiers](#header-identifiers-in-html-latex-and-context).
2053Note, however, that this method of providing links to sections works
2054only in HTML, LaTeX, and ConTeXt formats.
2056If the `--section-divs` option is specified, then each section will
2057be wrapped in a `section` (or a `div`, if `html4` was specified),
2058and the identifier will be attached to the enclosing `<section>`
2059(or `<div>`) tag rather than the header itself. This allows entire
2060sections to be manipulated using JavaScript or treated differently in
2063#### Extension: `ascii_identifiers` ####
2065Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2066Accents are stripped off of accented Latin letters, and non-Latin
2069#### Extension: `gfm_auto_identifiers` ####
2071Changes the algorithm used by `auto_identifiers` to conform to
2072GitHub's method. Spaces are converted to dashes (`-`),
2073uppercase characters to lowercase characters, and punctuation
2074characters other than `-` and `_` are removed.
2079The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2080[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2081[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2082are described in the section about Pandoc's Markdown.
2084However, they can also be used with HTML input. This is handy for
2085reading web pages formatted using MathJax, for example.
2090The following extensions (especially how they affect Markdown
2091input/output) are also described in more detail in their respective
2092sections of [Pandoc's Markdown].
2094#### Extension: `raw_html` {#raw_html}
2096When converting from HTML, parse elements to raw HTML which are not
2097representable in pandoc's AST.
2098By default, this is disabled for HTML input.
2100#### Extension: `raw_tex` {#raw_tex}
2102Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2104This extension can be enabled/disabled for the following formats
2105(in addition to `markdown`):
2108: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2109 `\eqref` only), `ipynb`
2112: `textile`, `commonmark`
2114Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2115only raw TeX in markdown cells, but data with mime type
2116`text/html` in output cells. Since the `ipynb` reader attempts
2117to preserve the richest possible outputs when several options
2118are given, you will get best results if you disable `raw_html`
2119and `raw_tex` when converting to formats like `docx` which don't
2120allow raw `html` or `tex`.
2122#### Extension: `native_divs` {#native_divs}
2124This extension is enabled by default for HTML input. This means that
2125`div`s are parsed to pandoc native elements. (Alternatively, you
2126can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2128When converting HTML to Markdown, for example, you may want to drop all
2131 pandoc -f html-native_divs-native_spans -t markdown
2133#### Extension: `native_spans` {#native_spans}
2135Analogous to `native_divs` above.
2138Literate Haskell support
2139------------------------
2141#### Extension: `literate_haskell` ####
2143Treat the document as literate Haskell source.
2145This extension can be enabled/disabled for the following formats:
2148: `markdown`, `rst`, `latex`
2151: `markdown`, `rst`, `latex`, `html`
2153If you append `+lhs` (or `+literate_haskell`) to one of the formats
2154above, pandoc will treat the document as literate Haskell source.
2157 - In Markdown input, "bird track" sections will be parsed as Haskell
2158 code rather than block quotations. Text between `\begin{code}`
2159 and `\end{code}` will also be treated as Haskell code. For
2160 ATX-style headers the character '=' will be used instead of '#'.
2162 - In Markdown output, code blocks with classes `haskell` and `literate`
2163 will be rendered using bird tracks, and block quotations will be
2164 indented one space, so they will not be treated as Haskell code.
2165 In addition, headers will be rendered setext-style (with underlines)
2166 rather than ATX-style (with '#' characters). (This is because ghc
2167 treats '#' characters in column 1 as introducing line numbers.)
2169 - In restructured text input, "bird track" sections will be parsed
2172 - In restructured text output, code blocks with class `haskell` will
2173 be rendered using bird tracks.
2175 - In LaTeX input, text in `code` environments will be parsed as
2178 - In LaTeX output, code blocks with class `haskell` will be rendered
2179 inside `code` environments.
2181 - In HTML output, code blocks with class `haskell` will be rendered
2182 with class `literatehaskell` and bird tracks.
2186 pandoc -f markdown+lhs -t html
2188reads literate Haskell source formatted with Markdown conventions and writes
2189ordinary HTML (without bird tracks).
2191 pandoc -f markdown+lhs -t html+lhs
2193writes HTML with the Haskell code in bird tracks, so it can be copied
2194and pasted as literate Haskell source.
2196Note that GHC expects the bird tracks in the first column, so indented
2197literate code blocks (e.g. inside an itemized environment) will not be
2198picked up by the Haskell compiler.
2203#### Extension: `empty_paragraphs` ####
2205Allows empty paragraphs. By default empty paragraphs are
2208This extension can be enabled/disabled for the following formats:
2214: `docx`, `odt`, `opendocument`, `html`
2216#### Extension: `styles` #### {#ext-styles}
2218Read all docx styles as divs (for paragraph styles) and spans (for
2219character styles) regardless of whether pandoc understands the meaning
2220of these styles. This can be used with [docx custom
2221styles](#custom-styles). Disabled by default.
2226#### Extension: `amuse` ####
2228In the `muse` input format, this enables Text::Amuse
2229extensions to Emacs Muse markup.
2231#### Extension: `citations` {#org-citations}
2233Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2236#### Extension: `ntb` ####
2238In the `context` output format this enables the use of [Natural Tables
2239(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2240[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2241Natural tables allow more fine-grained global customization but come
2242at a performance penalty compared to extreme tables.
2248Pandoc understands an extended and slightly revised version of
2249John Gruber's [Markdown] syntax. This document explains the syntax,
2250noting differences from standard Markdown. Except where noted, these
2251differences can be suppressed by using the `markdown_strict` format instead
2252of `markdown`. Extensions can be enabled or disabled to specify the
2253behavior more granularly. They are described in the following. See also
2254[Extensions] above, for extensions that work also on other formats.
2259Markdown is designed to be easy to write, and, even more importantly,
2262> A Markdown-formatted document should be publishable as-is, as plain
2263> text, without looking like it's been marked up with tags or formatting
2265> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2267This principle has guided pandoc's decisions in finding syntax for
2268tables, footnotes, and other extensions.
2270There is, however, one respect in which pandoc's aims are different
2271from the original aims of Markdown. Whereas Markdown was originally
2272designed with HTML generation in mind, pandoc is designed for multiple
2273output formats. Thus, while pandoc allows the embedding of raw HTML,
2274it discourages it, and provides other, non-HTMLish ways of representing
2275important document elements like definition lists, tables, mathematics, and
2281A paragraph is one or more lines of text followed by one or more blank lines.
2282Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2283If you need a hard line break, put two or more spaces at the end of a line.
2285#### Extension: `escaped_line_breaks` ####
2287A backslash followed by a newline is also a hard line break.
2288Note: in multiline and grid table cells, this is the only way
2289to create a hard line break, since trailing spaces in the cells
2295There are two kinds of headers: Setext and ATX.
2297### Setext-style headers ###
2299A setext-style header is a line of text "underlined" with a row of `=` signs
2300(for a level one header) or `-` signs (for a level two header):
2308The header text can contain inline formatting, such as emphasis (see
2309[Inline formatting], below).
2312### ATX-style headers ###
2314An ATX-style header consists of one to six `#` signs and a line of
2315text, optionally followed by any number of `#` signs. The number of
2316`#` signs at the beginning of the line is the header level:
2318 ## A level-two header
2320 ### A level-three header ###
2322As with setext-style headers, the header text can contain formatting:
2324 # A level-one header with a [link](/url) and *emphasis*
2326#### Extension: `blank_before_header` ####
2328Standard Markdown syntax does not require a blank line before a header.
2329Pandoc does require this (except, of course, at the beginning of the
2330document). The reason for the requirement is that it is all too easy for a
2331`#` to end up at the beginning of a line by accident (perhaps through line
2332wrapping). Consider, for example:
2334 I like several of their flavors of ice cream:
2335 #22, for example, and #5.
2337#### Extension: `space_in_atx_header` ####
2339Many Markdown implementations do not require a space between the
2340opening `#`s of an ATX header and the header text, so that
2341`#5 bolt` and `#hashtag` count as headers. With this extension,
2342pandoc does require the space.
2344### Header identifiers ###
2346See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2348#### Extension: `header_attributes` ####
2350Headers can be assigned attributes using this syntax at the end
2351of the line containing the header text:
2353 {#identifier .class .class key=value key=value}
2355Thus, for example, the following headers will all be assigned the identifier
2360 ## My header ## {#foo}
2362 My other header {#foo}
2365(This syntax is compatible with [PHP Markdown Extra].)
2367Note that although this syntax allows assignment of classes and key/value
2368attributes, writers generally don't use all of this information. Identifiers,
2369classes, and key/value attributes are used in HTML and HTML-based formats such
2370as EPUB and slidy. Identifiers are used for labels and link anchors in the
2371LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2373Headers with the class `unnumbered` will not be numbered, even if
2374`--number-sections` is specified. A single hyphen (`-`) in an attribute
2375context is equivalent to `.unnumbered`, and preferable in non-English
2382 # My header {.unnumbered}
2384#### Extension: `implicit_header_references` ####
2386Pandoc behaves as if reference links have been defined for each header.
2387So, to link to a header
2389 # Header identifiers in HTML
2393 [Header identifiers in HTML]
2397 [Header identifiers in HTML][]
2401 [the section on header identifiers][header identifiers in
2404instead of giving the identifier explicitly:
2406 [Header identifiers in HTML](#header-identifiers-in-html)
2408If there are multiple headers with identical text, the corresponding
2409reference will link to the first one only, and you will need to use explicit
2410links to link to the others, as described above.
2412Like regular reference links, these references are case-insensitive.
2414Explicit link reference definitions always take priority over
2415implicit header references. So, in the following example, the
2416link will point to `bar`, not to `#foo`:
2427Markdown uses email conventions for quoting blocks of text.
2428A block quotation is one or more paragraphs or other block elements
2429(such as lists or headers), with each line preceded by a `>` character
2430and an optional space. (The `>` need not start at the left margin, but
2431it should not be indented more than three spaces.)
2433 > This is a block quote. This
2434 > paragraph has two lines.
2436 > 1. This is a list inside a block quote.
2439A "lazy" form, which requires the `>` character only on the first
2440line of each block, is also allowed:
2442 > This is a block quote. This
2443 paragraph has two lines.
2445 > 1. This is a list inside a block quote.
2448Among the block elements that can be contained in a block quote are
2449other block quotes. That is, block quotes can be nested:
2451 > This is a block quote.
2453 > > A block quote within a block quote.
2455If the `>` character is followed by an optional space, that space
2456will be considered part of the block quote marker and not part of
2457the indentation of the contents. Thus, to put an indented code
2458block in a block quote, you need five spaces after the `>`:
2462#### Extension: `blank_before_blockquote` ####
2464Standard Markdown syntax does not require a blank line before a block
2465quote. Pandoc does require this (except, of course, at the beginning of the
2466document). The reason for the requirement is that it is all too easy for a
2467`>` to end up at the beginning of a line by accident (perhaps through line
2468wrapping). So, unless the `markdown_strict` format is used, the following does
2469not produce a nested block quote in pandoc:
2471 > This is a block quote.
2475Verbatim (code) blocks
2476----------------------
2478### Indented code blocks ###
2480A block of text indented four spaces (or one tab) is treated as verbatim
2481text: that is, special characters do not trigger special formatting,
2482and all spaces and line breaks are preserved. For example,
2485 moveShip(5 * gravity, DOWN);
2488The initial (four space or one tab) indentation is not considered part
2489of the verbatim text, and is removed in the output.
2491Note: blank lines in the verbatim text need not begin with four spaces.
2494### Fenced code blocks ###
2496#### Extension: `fenced_code_blocks` ####
2498In addition to standard indented code blocks, pandoc supports
2499*fenced* code blocks. These begin with a row of three or more
2500tildes (`~`) and end with a row of tildes that must be at least as long as
2501the starting row. Everything between these lines is treated as code. No
2502indentation is necessary:
2506 moveShip(5 * gravity, DOWN);
2510Like regular code blocks, fenced code blocks must be separated
2511from surrounding text by blank lines.
2513If the code itself contains a row of tildes or backticks, just use a longer
2514row of tildes or backticks at the start and end:
2518 code including tildes
2522#### Extension: `backtick_code_blocks` ####
2524Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
2527#### Extension: `fenced_code_attributes` ####
2529Optionally, you may attach attributes to fenced or backtick code block using
2532 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
2534 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
2535 qsort (filter (>= x) xs)
2536 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2538Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2539`startFrom` is an attribute with value `100`. Some output formats can use this
2540information to do syntax highlighting. Currently, the only output formats
2541that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2542highlighting is supported for your output format and language, then the code
2543block above will appear highlighted, with numbered lines. (To see which
2544languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2545the code block above will appear as follows:
2547 <pre id="mycode" class="haskell numberLines" startFrom="100">
2553The `numberLines` (or `number-lines`) class will cause the lines
2554of the code block to be numbered, starting with `1` or the value
2555of the `startFrom` attribute. The `lineAnchors` (or
2556`line-anchors`) class will cause the lines to be clickable
2557anchors in HTML output.
2559A shortcut form can also be used for specifying the language of
2566This is equivalent to:
2572If the `fenced_code_attributes` extension is disabled, but
2573input contains class attribute(s) for the code block, the first
2574class attribute will be printed after the opening fence as a bare
2577To prevent all highlighting, use the `--no-highlight` flag.
2578To set the highlighting style, use `--highlight-style`.
2579For more information on highlighting, see [Syntax highlighting],
2585#### Extension: `line_blocks` ####
2587A line block is a sequence of lines beginning with a vertical bar (`|`)
2588followed by a space. The division into lines will be preserved in
2589the output, as will any leading spaces; otherwise, the lines will
2590be formatted as Markdown. This is useful for verse and addresses:
2592 | The limerick packs laughs anatomical
2593 | In space that is quite economical.
2594 | But the good ones I've seen
2595 | So seldom are clean
2596 | And the clean ones so seldom are comical
2599 | Berkeley, CA 94718
2601The lines can be hard-wrapped if needed, but the continuation
2602line must begin with a space.
2604 | The Right Honorable Most Venerable and Righteous Samuel L.
2607 | Berkeley, CA 94718
2609This syntax is borrowed from [reStructuredText].
2616A bullet list is a list of bulleted list items. A bulleted list
2617item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2624This will produce a "compact" list. If you want a "loose" list, in which
2625each item is formatted as a paragraph, put spaces between the items:
2633The bullets need not be flush with the left margin; they may be
2634indented one, two, or three spaces. The bullet must be followed
2637List items look best if subsequent lines are flush with the first
2638line (after the bullet):
2644But Markdown also allows a "lazy" format:
2650### Block content in list items ###
2652A list item may contain multiple paragraphs and other block-level
2653content. However, subsequent paragraphs must be preceded by a blank line
2654and indented to line up with the first non-space content after
2661 * Second paragraph. With a code block, which must be indented
2666Exception: if the list marker is followed by an indented code
2667block, which must begin 5 spaces after the list marker, then
2668subsequent paragraphs must begin two columns after the last
2669character of the list marker:
2673 continuation paragraph
2675List items may include other lists. In this case the preceding blank
2676line is optional. The nested list must be indented to line up with
2677the first non-space character after the list marker of the
2678containing list item.
2690As noted above, Markdown allows you to write list items "lazily," instead of
2691indenting continuation lines. However, if there are multiple paragraphs or
2692other blocks in a list item, the first line of each must be indented.
2694 + A lazy, lazy, list
2697 + Another one; this looks
2700 Second paragraph of second
2703### Ordered lists ###
2705Ordered lists work just like bulleted lists, except that the items
2706begin with enumerators rather than bullets.
2708In standard Markdown, enumerators are decimal numbers followed
2709by a period and a space. The numbers themselves are ignored, so
2710there is no difference between this list:
2722#### Extension: `fancy_lists` ####
2724Unlike standard Markdown, pandoc allows ordered list items to be marked
2725with uppercase and lowercase letters and roman numerals, in addition to
2726Arabic numerals. List markers may be enclosed in parentheses or followed by a
2727single right-parentheses or period. They must be separated from the
2728text that follows by at least one space, and, if the list marker is a
2729capital letter with a period, by at least two spaces.[^2]
2731[^2]: The point of this rule is to ensure that normal paragraphs
2732 starting with people's initials, like
2734 B. Russell was an English philosopher.
2736 do not get treated as list items.
2738 This rule will not prevent
2742 from being interpreted as a list item. In this case, a backslash
2747The `fancy_lists` extension also allows '`#`' to be used as an
2748ordered list marker in place of a numeral:
2753#### Extension: `startnum` ####
2755Pandoc also pays attention to the type of list marker used, and to the
2756starting number, and both of these are preserved where possible in the
2757output format. Thus, the following yields a list with numbers followed
2758by a single parenthesis, starting with 9, and a sublist with lowercase
2768Pandoc will start a new list each time a different type of list
2769marker is used. So, the following will create three lists:
2776If default list markers are desired, use `#.`:
2782#### Extension: `task_lists` ####
2784Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
2786 - [ ] an unchecked task list item
2789### Definition lists ###
2791#### Extension: `definition_lists` ####
2793Pandoc supports definition lists, using the syntax of
2794[PHP Markdown Extra] with some extensions.[^3]
2800 Term 2 with *inline markup*
2804 { some code, part of Definition 2 }
2806 Third paragraph of definition 2.
2808Each term must fit on one line, which may optionally be followed by
2809a blank line, and must be followed by one or more definitions.
2810A definition begins with a colon or tilde, which may be indented one
2813A term may have multiple definitions, and each definition may consist of one or
2814more block elements (paragraph, code block, list, etc.), each indented four
2815spaces or one tab stop. The body of the definition (including the first line,
2816aside from the colon or tilde) should be indented four spaces. However,
2817as with other Markdown lists, you can "lazily" omit indentation except
2818at the beginning of a paragraph or other block element:
2823 with lazy continuation.
2825 Second paragraph of the definition.
2827If you leave space before the definition (as in the example above),
2828the text of the definition will be treated as a paragraph. In some
2829output formats, this will mean greater spacing between term/definition
2830pairs. For a more compact definition list, omit the space before the
2840Note that space between items in a definition list is required.
2841(A variant that loosens this requirement, but disallows "lazy"
2842hard wrapping, can be activated with `compact_definition_lists`: see
2843[Non-pandoc extensions], below.)
2845[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
2847### Numbered example lists ###
2849#### Extension: `example_lists` ####
2851The special list marker `@` can be used for sequentially numbered
2852examples. The first list item with a `@` marker will be numbered '1',
2853the next '2', and so on, throughout the document. The numbered examples
2854need not occur in a single list; each new list using `@` will take up
2855where the last stopped. So, for example:
2857 (@) My first example will be numbered (1).
2858 (@) My second example will be numbered (2).
2860 Explanation of examples.
2862 (@) My third example will be numbered (3).
2864Numbered examples can be labeled and referred to elsewhere in the
2867 (@good) This is a good example.
2869 As (@good) illustrates, ...
2871The label can be any string of alphanumeric characters, underscores,
2874Note: continuation paragraphs in example lists must always
2875be indented four spaces, regardless of the length of the
2876list marker. That is, example lists always behave as if the
2877`four_space_rule` extension is set. This is because example
2878labels tend to be long, and indenting content to the
2879first non-space character after the label would be awkward.
2881### Compact and loose lists ###
2883Pandoc behaves differently from `Markdown.pl` on some "edge
2884cases" involving lists. Consider this source:
2894Pandoc transforms this into a "compact list" (with no `<p>` tags around
2895"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2896"Second" and "Third" (but not "First"), because of the blank space
2897around "Third". Pandoc follows a simple rule: if the text is followed by
2898a blank line, it is treated as a paragraph. Since "Second" is followed
2899by a list, and not a blank line, it isn't treated as a paragraph. The
2900fact that the list is followed by a blank line is irrelevant. (Note:
2901Pandoc works this way even when the `markdown_strict` format is specified. This
2902behavior is consistent with the official Markdown syntax description,
2903even though it is different from that of `Markdown.pl`.)
2906### Ending a list ###
2908What if you want to put an indented code block after a list?
2915Trouble! Here pandoc (like other Markdown implementations) will treat
2916`{ my code block }` as the second paragraph of item two, and not as
2919To "cut off" the list after item two, you can insert some non-indented
2920content, like an HTML comment, which won't produce visible output in
2926 <!-- end of list -->
2930You can use the same trick if you want two consecutive lists instead
2946A line containing a row of three or more `*`, `-`, or `_` characters
2947(optionally separated by spaces) produces a horizontal rule:
2957Four kinds of tables may be used. The first three kinds presuppose the use of
2958a fixed-width font, such as Courier. The fourth kind can be used with
2959proportionally spaced fonts, as it does not require lining up columns.
2961#### Extension: `table_captions` ####
2963A caption may optionally be provided with all 4 kinds of tables (as
2964illustrated in the examples below). A caption is a paragraph beginning
2965with the string `Table:` (or just `:`), which will be stripped off.
2966It may appear either before or after the table.
2968#### Extension: `simple_tables` ####
2970Simple tables look like this:
2972 Right Left Center Default
2973 ------- ------ ---------- -------
2978 Table: Demonstration of simple table syntax.
2980The headers and table rows must each fit on one line. Column
2981alignments are determined by the position of the header text relative
2982to the dashed line below it:[^4]
2984 - If the dashed line is flush with the header text on the right side
2985 but extends beyond it on the left, the column is right-aligned.
2986 - If the dashed line is flush with the header text on the left side
2987 but extends beyond it on the right, the column is left-aligned.
2988 - If the dashed line extends beyond the header text on both sides,
2989 the column is centered.
2990 - If the dashed line is flush with the header text on both sides,
2991 the default alignment is used (in most cases, this will be left).
2993[^4]: This scheme is due to Michel Fortin, who proposed it on the
2994 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
2996The table must end with a blank line, or a line of dashes followed by
2999The column headers may be omitted, provided a dashed line is used
3000to end the table. For example:
3002 ------- ------ ---------- -------
3006 ------- ------ ---------- -------
3008When headers are omitted, column alignments are determined on the basis
3009of the first line of the table body. So, in the tables above, the columns
3010would be right, left, center, and right aligned, respectively.
3012#### Extension: `multiline_tables` ####
3014Multiline tables allow headers and table rows to span multiple lines
3015of text (but cells that span multiple columns or rows of the table are
3016not supported). Here is an example:
3018 -------------------------------------------------------------
3019 Centered Default Right Left
3020 Header Aligned Aligned Aligned
3021 ----------- ------- --------------- -------------------------
3022 First row 12.0 Example of a row that
3023 spans multiple lines.
3025 Second row 5.0 Here's another one. Note
3026 the blank line between
3028 -------------------------------------------------------------
3030 Table: Here's the caption. It, too, may span
3033These work like simple tables, but with the following differences:
3035 - They must begin with a row of dashes, before the header text
3036 (unless the headers are omitted).
3037 - They must end with a row of dashes, then a blank line.
3038 - The rows must be separated by blank lines.
3040In multiline tables, the table parser pays attention to the widths of
3041the columns, and the writers try to reproduce these relative widths in
3042the output. So, if you find that one of the columns is too narrow in the
3043output, try widening it in the Markdown source.
3045Headers may be omitted in multiline tables as well as simple tables:
3047 ----------- ------- --------------- -------------------------
3048 First row 12.0 Example of a row that
3049 spans multiple lines.
3051 Second row 5.0 Here's another one. Note
3052 the blank line between
3054 ----------- ------- --------------- -------------------------
3056 : Here's a multiline table without headers.
3058It is possible for a multiline table to have just one row, but the row
3059should be followed by a blank line (and then the row of dashes that ends
3060the table), or the table may be interpreted as a simple table.
3062#### Extension: `grid_tables` ####
3064Grid tables look like this:
3066 : Sample grid table.
3068 +---------------+---------------+--------------------+
3069 | Fruit | Price | Advantages |
3070 +===============+===============+====================+
3071 | Bananas | $1.34 | - built-in wrapper |
3072 | | | - bright color |
3073 +---------------+---------------+--------------------+
3074 | Oranges | $2.10 | - cures scurvy |
3076 +---------------+---------------+--------------------+
3078The row of `=`s separates the header from the table body, and can be
3079omitted for a headerless table. The cells of grid tables may contain
3080arbitrary block elements (multiple paragraphs, code blocks, lists,
3081etc.). Cells that span multiple columns or rows are not
3082supported. Grid tables can be created easily using [Emacs table mode].
3084[Emacs table mode]: http://table.sourceforge.net/
3086Alignments can be specified as with pipe tables, by putting
3087colons at the boundaries of the separator line after the
3090 +---------------+---------------+--------------------+
3091 | Right | Left | Centered |
3092 +==============:+:==============+:==================:+
3093 | Bananas | $1.34 | built-in wrapper |
3094 +---------------+---------------+--------------------+
3096For headerless tables, the colons go on the top line instead:
3098 +--------------:+:--------------+:------------------:+
3099 | Right | Left | Centered |
3100 +---------------+---------------+--------------------+
3102##### Grid Table Limitations #####
3104Pandoc does not support grid tables with row spans or column spans.
3105This means that neither variable numbers of columns across rows nor
3106variable numbers of rows across columns are supported by Pandoc.
3107All grid tables must have the same number of columns in each row,
3108and the same number of rows in each column. For example, the
3109Docutils [sample grid tables] will not render as expected with
3112[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3115#### Extension: `pipe_tables` ####
3117Pipe tables look like this:
3119 | Right | Left | Default | Center |
3120 |------:|:-----|---------|:------:|
3121 | 12 | 12 | 12 | 12 |
3122 | 123 | 123 | 123 | 123 |
3125 : Demonstration of pipe table syntax.
3127The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3128ending pipe characters are optional, but pipes are required between all
3129columns. The colons indicate column alignment as shown. The header
3130cannot be omitted. To simulate a headerless table, include a header
3133Since the pipes indicate column boundaries, columns need not be vertically
3134aligned, as they are in the above example. So, this is a perfectly
3135legal (though ugly) pipe table:
3143The cells of pipe tables cannot contain block elements like paragraphs
3144and lists, and cannot span multiple lines. If a pipe table contains a
3145row whose printable content is wider than the column width (see
3146`--columns`), then the table will take up the full text width and
3147the cell contents will wrap, with the relative cell widths determined
3148by the number of dashes in the line separating the table header from
3149the table body. (For example `---|-` would make the first column 3/4
3150and the second column 1/4 of the full text width.)
3151On the other hand, if no lines are wider than column width, then
3152cell contents will not be wrapped, and the cells will be sized
3155Note: pandoc also recognizes pipe tables of the following
3156form, as can be produced by Emacs' orgtbl-mode:
3163The difference is that `+` is used instead of `|`. Other orgtbl features
3164are not supported. In particular, to get non-default column alignment,
3165you'll need to add colons as above.
3167[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3172#### Extension: `pandoc_title_block` ####
3174If the file begins with a title block
3177 % author(s) (separated by semicolons)
3180it will be parsed as bibliographic information, not regular text. (It
3181will be used, for example, in the title of standalone LaTeX or HTML
3182output.) The block may contain just a title, a title and an author,
3183or all three elements. If you want to include an author but no
3184title, or a title and a date but no author, you need a blank line:
3193The title may occupy multiple lines, but continuation lines must
3194begin with leading space, thus:
3199If a document has multiple authors, the authors may be put on
3200separate lines with leading space, or separated by semicolons, or
3201both. So, all of the following are equivalent:
3206 % Author One; Author Two
3211The date must fit on one line.
3213All three metadata fields may contain standard inline formatting
3214(italics, links, footnotes, etc.).
3216Title blocks will always be parsed, but they will affect the output only
3217when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3218will appear twice: once in the document head -- this is the title that
3219will appear at the top of the window in a browser -- and once at the
3220beginning of the document body. The title in the document head can have
3221an optional prefix attached (`--title-prefix` or `-T` option). The title
3222in the body appears as an H1 element with class "title", so it can be
3223suppressed or reformatted with CSS. If a title prefix is specified with
3224`-T` and no title block appears in the document, the title prefix will
3225be used by itself as the HTML title.
3227The man page writer extracts a title, man page section number, and
3228other header and footer information from the title line. The title
3229is assumed to be the first word on the title line, which may optionally
3230end with a (single-digit) section number in parentheses. (There should
3231be no space between the title and the parentheses.) Anything after
3232this is assumed to be additional footer and header text. A single pipe
3233character (`|`) should be used to separate the footer text from the header
3238will yield a man page with the title `PANDOC` and section 1.
3240 % PANDOC(1) Pandoc User Manuals
3242will also have "Pandoc User Manuals" in the footer.
3244 % PANDOC(1) Pandoc User Manuals | Version 4.0
3246will also have "Version 4.0" in the header.
3248#### Extension: `yaml_metadata_block` ####
3250A YAML metadata block is a valid YAML object, delimited by a line of three
3251hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3252(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3253document, but if it is not at the beginning, it must be preceded by a blank
3254line. (Note that, because of the way pandoc concatenates input files when
3255several are provided, you may also keep the metadata in a separate YAML file
3256and pass it to pandoc as an argument, along with your Markdown files:
3258 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3260Just be sure that the YAML file begins with `---` and ends with `---` or
3261`...`.) Alternatively, you can use the `--metadata-file` option. Using
3262that approach however, you cannot reference content (like footnotes)
3263from the main markdown input document.
3265Metadata will be taken from the fields of the YAML object and added to any
3266existing document metadata. Metadata can contain lists and objects (nested
3267arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3268with names ending in an underscore will be ignored by pandoc. (They may be
3269given a role by external processors.) Field names must not be
3270interpretable as YAML numbers or boolean values (so, for
3271example, `yes`, `True`, and `15` cannot be used as field names).
3273A document may contain multiple metadata blocks. The metadata fields will
3274be combined through a *left-biased union*: if two metadata blocks attempt
3275to set the same field, the value from the first block will be taken.
3277When pandoc is used with `-t markdown` to create a Markdown document,
3278a YAML metadata block will be produced only if the `-s/--standalone`
3279option is used. All of the metadata will appear in a single block
3280at the beginning of the document.
3282Note that YAML escaping rules must be followed. Thus, for example,
3283if a title contains a colon, it must be quoted. The pipe character
3284(`|`) can be used to begin an indented block that will be interpreted
3285literally, without need for escaping. This form is necessary
3286when the field contains blank lines or block-level formatting:
3289 title: 'This is the title: it contains a colon'
3293 keywords: [nothing, nothingness]
3295 This is the abstract.
3297 It consists of two paragraphs.
3300Template variables will be set automatically from the metadata. Thus, for
3301example, in writing HTML, the variable `abstract` will be set to the HTML
3302equivalent of the Markdown in the `abstract` field:
3304 <p>This is the abstract.</p>
3305 <p>It consists of two paragraphs.</p>
3307Variables can contain arbitrary YAML structures, but the template must match
3308this structure. The `author` variable in the default templates expects a
3309simple list or string, but can be changed to support more complicated
3310structures. The following combination, for example, would add an affiliation
3311to the author if one is given:
3314 title: The document title
3317 affiliation: University of Somewhere
3319 affiliation: University of Nowhere
3322To use the structured authors in the example above, you would need a custom
3327 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3333Raw content to include in the document's header may be specified
3334using `header-includes`; however, it is important to mark up
3335this content as raw code for a particular output format, using
3336the [`raw_attribute` extension](#extension-raw_attribute)), or it
3337will be interpreted as markdown. For example:
3342 \let\oldsection\section
3343 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3349#### Extension: `all_symbols_escapable` ####
3351Except inside a code block or inline code, any punctuation or space
3352character preceded by a backslash will be treated literally, even if it
3353would normally indicate formatting. Thus, for example, if one writes
3363 <strong>hello</strong>
3365This rule is easier to remember than standard Markdown's rule,
3366which allows only the following characters to be backslash-escaped:
3370(However, if the `markdown_strict` format is used, the standard Markdown rule
3373A backslash-escaped space is parsed as a nonbreaking space. It will
3374appear in TeX output as `~` and in HTML and XML as `\ ` or
3377A backslash-escaped newline (i.e. a backslash occurring at the end of
3378a line) is parsed as a hard line break. It will appear in TeX output as
3379`\\` and in HTML as `<br />`. This is a nice alternative to
3380Markdown's "invisible" way of indicating hard line breaks using
3381two trailing spaces on a line.
3383Backslash escapes do not work in verbatim contexts.
3390To *emphasize* some text, surround it with `*`s or `_`, like this:
3392 This text is _emphasized with underscores_, and this
3393 is *emphasized with asterisks*.
3395Double `*` or `_` produces **strong emphasis**:
3397 This is **strong emphasis** and __with underscores__.
3399A `*` or `_` character surrounded by spaces, or backslash-escaped,
3400will not trigger emphasis:
3402 This is * not emphasized *, and \*neither is this\*.
3404#### Extension: `intraword_underscores` ####
3406Because `_` is sometimes used inside words and identifiers,
3407pandoc does not interpret a `_` surrounded by alphanumeric
3408characters as an emphasis marker. If you want to emphasize
3409just part of a word, use `*`:
3411 feas*ible*, not feas*able*.
3416#### Extension: `strikeout` ####
3418To strikeout a section of text with a horizontal line, begin and end it
3419with `~~`. Thus, for example,
3421 This ~~is deleted text.~~
3424### Superscripts and subscripts ###
3426#### Extension: `superscript`, `subscript` ####
3428Superscripts may be written by surrounding the superscripted text by `^`
3429characters; subscripts may be written by surrounding the subscripted
3430text by `~` characters. Thus, for example,
3432 H~2~O is a liquid. 2^10^ is 1024.
3434If the superscripted or subscripted text contains spaces, these spaces
3435must be escaped with backslashes. (This is to prevent accidental
3436superscripting and subscripting through the ordinary use of `~` and `^`.)
3437Thus, if you want the letter P with 'a cat' in subscripts, use
3438`P~a\ cat~`, not `P~a cat~`.
3443To make a short span of text verbatim, put it inside backticks:
3445 What is the difference between `>>=` and `>>`?
3447If the verbatim text includes a backtick, use double backticks:
3449 Here is a literal backtick `` ` ``.
3451(The spaces after the opening backticks and before the closing
3452backticks will be ignored.)
3454The general rule is that a verbatim span starts with a string
3455of consecutive backticks (optionally followed by a space)
3456and ends with a string of the same number of backticks (optionally
3457preceded by a space).
3459Note that backslash-escapes (and other Markdown constructs) do not
3460work in verbatim contexts:
3462 This is a backslash followed by an asterisk: `\*`.
3464#### Extension: `inline_code_attributes` ####
3466Attributes can be attached to verbatim text, just as with
3467[fenced code blocks]:
3473To write small caps, use the `smallcaps` class:
3475 [Small caps]{.smallcaps}
3477Or, without the `bracketed_spans` extension:
3479 <span class="smallcaps">Small caps</span>
3481For compatibility with other Markdown flavors, CSS is also supported:
3483 <span style="font-variant:small-caps;">Small caps</span>
3485This will work in all output formats that support small caps.
3491#### Extension: `tex_math_dollars` ####
3493Anything between two `$` characters will be treated as TeX math. The
3494opening `$` must have a non-space character immediately to its right,
3495while the closing `$` must have a non-space character immediately to its
3496left, and must not be followed immediately by a digit. Thus,
3497`$20,000 and $30,000` won't parse as math. If for some reason
3498you need to enclose text in literal `$` characters, backslash-escape
3499them and they won't be treated as math delimiters.
3501TeX math will be printed in all output formats. How it is rendered
3502depends on the output format:
3505 ~ It will appear verbatim surrounded by `\(...\)` (for inline
3506 math) or `\[...\]` (for display math).
3508Markdown, Emacs Org mode, ConTeXt, ZimWiki
3509 ~ It will appear verbatim surrounded by `$...$` (for inline
3510 math) or `$$...$$` (for display math).
3513 ~ It will be rendered using an [interpreted text role `:math:`].
3516 ~ It will be rendered as `latexmath:[...]`.
3519 ~ It will be rendered inside a `@math` command.
3522 ~ It will be rendered verbatim without `$`'s.
3525 ~ It will be rendered inside `<math>` tags.
3528 ~ It will be rendered inside `<span class="math">` tags.
3531 ~ It will be rendered, if possible, using Unicode characters,
3532 and will otherwise appear verbatim.
3535 ~ It will be rendered, if possible, using MathML.
3538 ~ If the `--mathml` flag is used, it will be rendered using MathML
3539 in an `inlineequation` or `informalequation` tag. Otherwise it
3540 will be rendered, if possible, using Unicode characters.
3543 ~ It will be rendered using OMML math markup.
3546 ~ If the `--webtex` option is used, formulas are rendered as images
3547 using CodeCogs or other compatible web service, downloaded
3548 and embedded in the e-book. Otherwise, they will appear verbatim.
3550HTML, Slidy, DZSlides, S5, EPUB
3551 ~ The way math is rendered in HTML will depend on the
3552 command-line options selected. Therefore see [Math rendering in HTML]
3555[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3560#### Extension: `raw_html` ####
3562Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
3563(except verbatim contexts, where `<`, `>`, and `&` are interpreted
3564literally). (Technically this is not an extension, since standard
3565Markdown allows it, but it has been made an extension so that it can
3566be disabled if desired.)
3568The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3569DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3570output, and suppressed in other formats.
3572For a more explicit way of including raw HTML in a Markdown
3573document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
3575In the CommonMark format, if `raw_html` is enabled, superscripts,
3576subscripts, strikeouts and small capitals will be represented as HTML.
3577Otherwise, plain-text fallbacks will be used. Note that even if
3578`raw_html` is disabled, tables will be rendered with HTML syntax if
3579they cannot use pipe syntax.
3581#### Extension: `markdown_in_html_blocks` ####
3583Standard Markdown allows you to include HTML "blocks": blocks
3584of HTML between balanced tags that are separated from the surrounding text
3585with blank lines, and start and end at the left margin. Within
3586these blocks, everything is interpreted as HTML, not Markdown;
3587so (for example), `*` does not signify emphasis.
3589Pandoc behaves this way when the `markdown_strict` format is used; but
3590by default, pandoc interprets material between HTML block tags as Markdown.
3591Thus, for example, pandoc will turn
3596 <td>[a link](http://google.com)</td>
3604 <td><em>one</em></td>
3605 <td><a href="http://google.com">a link</a></td>
3609whereas `Markdown.pl` will preserve it as is.
3611There is one exception to this rule: text between `<script>` and
3612`<style>` tags is not interpreted as Markdown.
3614This departure from standard Markdown should make it easier to mix
3615Markdown with HTML block elements. For example, one can surround
3616a block of Markdown text with `<div>` tags without preventing it
3617from being interpreted as Markdown.
3619#### Extension: `native_divs` ####
3621Use native pandoc `Div` blocks for content inside `<div>` tags.
3622For the most part this should give the same output as
3623`markdown_in_html_blocks`, but it makes it easier to write pandoc
3624filters to manipulate groups of blocks.
3626#### Extension: `native_spans` ####
3628Use native pandoc `Span` blocks for content inside `<span>` tags.
3629For the most part this should give the same output as `raw_html`,
3630but it makes it easier to write pandoc filters to manipulate groups
3633#### Extension: `raw_tex` ####
3635In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3636included in a document. Inline TeX commands will be preserved and passed
3637unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3638LaTeX to include BibTeX citations:
3640 This result was proved in \cite{jones.1967}.
3642Note that in LaTeX environments, like
3644 \begin{tabular}{|l|l|}\hline
3645 Age & Frequency \\ \hline
3648 36--45 & 22 \\ \hline
3651the material between the begin and end tags will be interpreted as raw
3652LaTeX, not as Markdown.
3654For a more explicit and flexible way of including raw TeX in a
3655Markdown document, see the [`raw_attribute`
3656extension][Extension: `raw_attribute`].
3658Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3659Emacs Org mode, and ConTeXt.
3661### Generic raw attribute ###
3663#### Extension: `raw_attribute` ####
3665Inline spans and fenced code blocks with a special
3666kind of attribute will be parsed as raw content with the
3667designated format. For example, the following produces a raw
3674And the following produces a raw `html` inline element:
3676 This is `<a>html</a>`{=html}
3678This can be useful to insert raw xml into `docx` documents, e.g.
3684 <w:br w:type="page"/>
3689The format name should match the target format name (see
3690`-t/--to`, above, for a list, or use `pandoc
3691--list-output-formats`). Use `openxml` for `docx` output,
3692`opendocument` for `odt` output, `html5` for `epub3` output,
3693`html4` for `epub2` output, and `latex`, `beamer`,
3694`ms`, or `html5` for `pdf` output (depending on what you
3695use for `--pdf-engine`).
3697This extension presupposes that the relevant kind of
3698inline code or fenced code block is enabled. Thus, for
3699example, to use a raw attribute with a backtick code block,
3700`backtick_code_blocks` must be enabled.
3702The raw attribute cannot be combined with regular attributes.
3707#### Extension: `latex_macros` ####
3709When this extension is enabled, pandoc will parse LaTeX
3710macro definitions and apply the resulting macros to all LaTeX
3711math and raw LaTeX. So, for example, the following will work in
3712all output formats, not just LaTeX:
3714 \newcommand{\tuple}[1]{\langle #1 \rangle}
3718Note that LaTeX macros will not be applied if they occur
3719inside inside a raw span or block marked with the
3720[`raw_attribute` extension](#extension-raw_attribute).
3722When `latex_macros` is disabled, the raw LaTeX and math will
3723not have macros applied. This is usually a better approach when
3724you are targeting LaTeX or PDF.
3726Whether or not `latex_macros` is enabled, the macro definitions
3727will still be passed through as raw LaTeX.
3732Markdown allows links to be specified in several ways.
3734### Automatic links ###
3736If you enclose a URL or email address in pointy brackets, it
3740 <sam@green.eggs.ham>
3744An inline link consists of the link text in square brackets,
3745followed by the URL in parentheses. (Optionally, the URL can
3746be followed by a link title, in quotes.)
3748 This is an [inline link](/url), and here's [one with
3749 a title](http://fsf.org "click here for a good time!").
3751There can be no space between the bracketed part and the parenthesized part.
3752The link text can contain formatting (such as emphasis), but the title cannot.
3754Email addresses in inline links are not autodetected, so they have to be
3755prefixed with `mailto`:
3757 [Write me!](mailto:sam@green.eggs.ham)
3759### Reference links ###
3761An *explicit* reference link has two parts, the link itself and the link
3762definition, which may occur elsewhere in the document (either
3763before or after the link).
3765The link consists of link text in square brackets, followed by a label in
3766square brackets. (There cannot be space between the two unless the
3767`spaced_reference_links` extension is enabled.) The link definition
3768consists of the bracketed label, followed by a colon and a space, followed by
3769the URL, and optionally (after a space) a link title either in quotes or in
3770parentheses. The label must not be parseable as a citation (assuming
3771the `citations` extension is enabled): citations take precedence over
3774Here are some examples:
3776 [my label 1]: /foo/bar.html "My title, optional"
3778 [my label 3]: http://fsf.org (The free software foundation)
3779 [my label 4]: /bar#special 'A title in single quotes'
3781The URL may optionally be surrounded by angle brackets:
3783 [my label 5]: <http://foo.bar.baz>
3785The title may go on the next line:
3787 [my label 3]: http://fsf.org
3788 "The free software foundation"
3790Note that link labels are not case sensitive. So, this will work:
3792 Here is [my link][FOO]
3796In an *implicit* reference link, the second pair of brackets is
3801 [my website]: http://foo.bar.baz
3803Note: In `Markdown.pl` and most other Markdown implementations,
3804reference link definitions cannot occur in nested constructions
3805such as list items or block quotes. Pandoc lifts this arbitrary
3806seeming restriction. So the following is fine in pandoc, though
3807not in most other implementations:
3813#### Extension: `shortcut_reference_links` ####
3815In a *shortcut* reference link, the second pair of brackets may
3820 [my website]: http://foo.bar.baz
3822### Internal links ###
3824To link to another section of the same document, use the automatically
3825generated identifier (see [Header identifiers]). For example:
3827 See the [Introduction](#introduction).
3831 See the [Introduction].
3833 [Introduction]: #introduction
3835Internal links are currently supported for HTML formats (including
3836HTML slide shows and EPUB), LaTeX, and ConTeXt.
3841A link immediately preceded by a `!` will be treated as an image.
3842The link text will be used as the image's alt text:
3844 
3848 [movie reel]: movie.gif
3850#### Extension: `implicit_figures` ####
3852An image with nonempty alt text, occurring by itself in a
3853paragraph, will be rendered as a figure with a caption. The
3854image's alt text will be used as the caption.
3856 
3858How this is rendered depends on the output format. Some output
3859formats (e.g. RTF) do not yet support figures. In those
3860formats, you'll just get an image in a paragraph by itself, with
3863If you just want a regular inline image, just make sure it is not
3864the only thing in the paragraph. One way to do this is to insert a
3865nonbreaking space after the image:
3867 \
3869Note that in reveal.js slide shows, an image in a paragraph
3870by itself that has the `stretch` class will fill the screen,
3871and the caption and figure tags will be omitted.
3873#### Extension: `link_attributes` ####
3875Attributes can be set on links and images:
3877 An inline {#id .class width=30 height=20px}
3878 and a reference ![image][ref] with attributes.
3880 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
3882(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3883and `.class` are used.)
3885For HTML and EPUB, all attributes except `width` and `height` (but
3886including `srcset` and `sizes`) are passed through as is. The other
3887writers ignore attributes that are not supported by their output
3890The `width` and `height` attributes on images are treated specially. When
3891used without a unit, the unit is assumed to be pixels. However, any of
3892the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3893and `%`. There must not be any spaces between the number and the unit.
3897{ width=50% }
3900- Dimensions are converted to inches for output in page-based formats like
3901 LaTeX. Dimensions are converted to pixels for output in HTML-like
3902 formats. Use the `--dpi` option to specify the number of pixels per
3903 inch. The default is 96dpi.
3904- The `%` unit is generally relative to some available space.
3905 For example the above example will render to the following.
3906 - HTML: `<img href="file.jpg" style="width: 50%;" />`
3907 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
3908 (If you're using a custom template, you need to configure `graphicx`
3909 as in the default template.)
3910 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3911- Some output formats have a notion of a class
3912 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3913 or a unique identifier (LaTeX `\caption`), or both (HTML).
3914- When no `width` or `height` attributes are specified, the fallback
3915 is to look at the image resolution and the dpi metadata embedded in
3921Using the `native_divs` and `native_spans` extensions
3922(see [above][Extension: `native_divs`]), HTML syntax can
3923be used as part of markdown to create native `Div` and `Span`
3924elements in the pandoc AST (as opposed to raw HTML).
3925However, there is also nicer syntax available:
3927#### Extension: `fenced_divs` ####
3929Allow special fenced syntax for native `Div` blocks. A Div
3930starts with a fence containing at least three consecutive
3931colons plus some attributes. The attributes may optionally
3932be followed by another string of consecutive colons.
3933The attribute syntax is exactly as in fenced code blocks (see
3934[Extension: `fenced_code_attributes`]). As with fenced
3935code blocks, one can use either attributes in curly braces
3936or a single unbraced word, which will be treated as a class
3937name. The Div ends with another line containing a string of at
3938least three consecutive colons. The fenced Div should be
3939separated by blank lines from preceding and following blocks.
3943 ::::: {#special .sidebar}
3944 Here is a paragraph.
3949Fenced divs can be nested. Opening fences are distinguished
3950because they *must* have attributes:
3956 This is a warning within a warning.
3960Fences without attributes are always closing fences. Unlike
3961with fenced code blocks, the number of colons in the closing
3962fence need not match the number in the opening fence. However,
3963it can be helpful for visual clarity to use fences of different
3964lengths to distinguish nested divs from their parents.
3967#### Extension: `bracketed_spans` ####
3969A bracketed sequence of inlines, as one would use to begin
3970a link, will be treated as a `Span` with attributes if it is
3971followed immediately by attributes:
3973 [This is *some text*]{.class key="val"}
3978#### Extension: `footnotes` ####
3980Pandoc's Markdown allows footnotes, using the following syntax:
3982 Here is a footnote reference,[^1] and another.[^longnote]
3984 [^1]: Here is the footnote.
3986 [^longnote]: Here's one with multiple blocks.
3988 Subsequent paragraphs are indented to show that they
3989 belong to the previous footnote.
3993 The whole paragraph can be indented, or just the first
3994 line. In this way, multi-paragraph footnotes work like
3995 multi-paragraph list items.
3997 This paragraph won't be part of the note, because it
4000The identifiers in footnote references may not contain spaces, tabs,
4001or newlines. These identifiers are used only to correlate the
4002footnote reference with the note itself; in the output, footnotes
4003will be numbered sequentially.
4005The footnotes themselves need not be placed at the end of the
4006document. They may appear anywhere except inside other block elements
4007(lists, block quotes, tables, etc.). Each footnote should be
4008separated from surrounding content (including other footnotes)
4011#### Extension: `inline_notes` ####
4013Inline footnotes are also allowed (though, unlike regular notes,
4014they cannot contain multiple paragraphs). The syntax is as follows:
4016 Here is an inline note.^[Inlines notes are easier to write, since
4017 you don't have to pick an identifier and move down to type the
4020Inline and regular footnotes may be mixed freely.
4025#### Extension: `citations` ####
4027Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4028citations and a bibliography in a number of styles. Basic usage is
4030 pandoc --filter pandoc-citeproc myinput.txt
4032In order to use this feature, you will need to specify a bibliography file
4033using the `bibliography` metadata field in a YAML metadata section, or
4034`--bibliography` command line argument. You can supply multiple `--bibliography`
4035arguments or set `bibliography` metadata field to YAML array, if you want to
4036use multiple bibliography files. The bibliography may have any of these
4039 Format File extension
4040 ------------ --------------
4053Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4054use `.bibtex` to force BibTeX.
4056Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4057can produce `.json` and `.yaml` files from any of the supported formats.
4059In-field markup: In BibTeX and BibLaTeX databases,
4060pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4061databases, pandoc Markdown; and in CSL JSON databases, an
4062[HTML-like markup][CSL markup specs]:
4070`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4079`<span class="nocase">...</span>`
4080: prevent a phrase from being capitalized as title case
4082`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4083and CSL YAML formats as far as possible.
4085As an alternative to specifying a bibliography file using `--bibliography`
4086or the YAML metadata field `bibliography`, you can include
4087the citation data directly in the `references` field of the
4088document's YAML metadata. The field should contain an array of
4089YAML-encoded references, for example:
4093 - type: article-journal
4105 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4107 title-short: Molecular structure of nucleic acids
4108 container-title: Nature
4112 DOI: 10.1038/171737a0
4113 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4117(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4118of the supported formats.)
4120Citations and references can be formatted using any style supported by the
4121[Citation Style Language], listed in the [Zotero Style Repository].
4122These files are specified using the `--csl` option or the `csl` metadata field.
4123By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4124format. The CSL project provides further information on [finding and editing styles].
4126To make your citations hyperlinks to the corresponding bibliography
4127entries, add `link-citations: true` to your YAML metadata.
4129Citations go inside square brackets and are separated by semicolons.
4130Each citation must have a key, composed of '@' + the citation
4131identifier from the database, and may optionally have a prefix,
4132a locator, and a suffix. The citation key must begin with a letter, digit,
4133or `_`, and may contain alphanumerics, `_`, and internal punctuation
4134characters (`:.#$%&-+?<>~/`). Here are some examples:
4136 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4138 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4140 Blah blah [@smith04; @doe99].
4142`pandoc-citeproc` detects locator terms in the [CSL locale files].
4143Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4144locale, locator terms can be written in either singular or plural forms,
4145as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4146`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4147`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4148`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4149`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4150`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4151locator term is used, "page" is assumed.
4153`pandoc-citeproc` will use heuristics to distinguish the locator
4154from the suffix. In complex cases, the locator can be enclosed
4155in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4157 [@smith{ii, A, D-Z}, with a suffix]
4158 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4160A minus sign (`-`) before the `@` will suppress mention of
4161the author in the citation. This can be useful when the
4162author is already mentioned in the text:
4164 Smith says blah [-@smith04].
4166You can also write an in-text citation, as follows:
4170 @smith04 [p. 33] says blah.
4172If the style calls for a list of works cited, it will be placed
4173in a div with id `refs`, if one exists:
4178Otherwise, it will be placed at the end of the document.
4179Generation of the bibliography can be suppressed by setting
4180`suppress-bibliography: true` in the YAML metadata.
4182If you wish the bibliography to have a section header, you can
4183set `reference-section-title` in the metadata, or put the header
4184at the beginning of the div with id `refs` (if you are using it)
4185or at the end of your document:
4191The bibliography will be inserted after this header. Note that
4192the `unnumbered` class will be added to this header, so that the
4193section will not be numbered.
4195If you want to include items in the bibliography without actually
4196citing them in the body text, you can define a dummy `nocite` metadata
4197field and put the citations there:
4206In this example, the document will contain a citation for `item3`
4207only, but the bibliography will contain entries for `item1`, `item2`, and
4210It is possible to create a bibliography with all the citations,
4211whether or not they appear in the document, by using a wildcard:
4218For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4219render the bibliography. In order to do so, specify bibliography
4220files as outlined above, and add `--natbib` or `--biblatex`
4221argument to `pandoc` invocation. Bear in mind that bibliography
4222files have to be in respective format (either BibTeX or
4225For more information, see the [pandoc-citeproc man page].
4227[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4228[Chicago Manual of Style]: http://chicagomanualofstyle.org
4229[Citation Style Language]: http://citationstyles.org
4230[Zotero Style Repository]: https://www.zotero.org/styles
4231[finding and editing styles]: https://citationstyles.org/authors/
4232[CSL locale files]: https://github.com/citation-style-language/locales
4233[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4235Non-pandoc extensions
4236---------------------
4238The following Markdown syntax extensions are not enabled by default
4239in pandoc, but may be enabled by adding `+EXTENSION` to the format
4240name, where `EXTENSION` is the name of the extension. Thus, for
4241example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4243#### Extension: `old_dashes` ####
4245Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4246`-` before a numeral is an en-dash, and `--` is an em-dash.
4247This option only has an effect if `smart` is enabled. It is
4248selected automatically for `textile` input.
4250#### Extension: `angle_brackets_escapable` ####
4252Allow `<` and `>` to be backslash-escaped, as they can be in
4253GitHub flavored Markdown but not original Markdown. This is
4254implied by pandoc's default `all_symbols_escapable`.
4256#### Extension: `lists_without_preceding_blankline` ####
4258Allow a list to occur right after a paragraph, with no intervening
4261#### Extension: `four_space_rule` ####
4263Selects the pandoc <= 2.0 behavior for parsing lists, so that
4264four spaces indent are needed for list item continuation
4267#### Extension: `spaced_reference_links` ####
4269Allow whitespace between the two components of a reference link,
4274#### Extension: `hard_line_breaks` ####
4276Causes all newlines within a paragraph to be interpreted as hard line
4277breaks instead of spaces.
4279#### Extension: `ignore_line_breaks` ####
4281Causes newlines within a paragraph to be ignored, rather than being
4282treated as spaces or as hard line breaks. This option is intended for
4283use with East Asian languages where spaces are not used between words,
4284but text is divided into lines for readability.
4286#### Extension: `east_asian_line_breaks` ####
4288Causes newlines within a paragraph to be ignored, rather than
4289being treated as spaces or as hard line breaks, when they occur
4290between two East Asian wide characters. This is a better choice
4291than `ignore_line_breaks` for texts that include a mix of East
4292Asian wide characters and other characters.
4294#### Extension: `emoji` ####
4296Parses textual emojis like `:smile:` as Unicode emoticons.
4298#### Extension: `tex_math_single_backslash` ####
4300Causes anything between `\(` and `\)` to be interpreted as inline
4301TeX math, and anything between `\[` and `\]` to be interpreted
4302as display TeX math. Note: a drawback of this extension is that
4303it precludes escaping `(` and `[`.
4305#### Extension: `tex_math_double_backslash` ####
4307Causes anything between `\\(` and `\\)` to be interpreted as inline
4308TeX math, and anything between `\\[` and `\\]` to be interpreted
4311#### Extension: `markdown_attribute` ####
4313By default, pandoc interprets material inside block-level tags as Markdown.
4314This extension changes the behavior so that Markdown is only parsed
4315inside block-level tags if the tags have the attribute `markdown=1`.
4317#### Extension: `mmd_title_block` ####
4319Enables a [MultiMarkdown] style title block at the top of
4320the document, for example:
4324 Date: September 1, 2008
4325 Comment: This is a sample mmd title block, with
4326 a field spanning multiple lines.
4328See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4329`yaml_metadata_block` is enabled, it will take precedence over
4332#### Extension: `abbreviations` ####
4334Parses PHP Markdown Extra abbreviation keys, like
4336 *[HTML]: Hypertext Markup Language
4338Note that the pandoc document model does not support
4339abbreviations, so if this extension is enabled, abbreviation keys are
4340simply skipped (as opposed to being parsed as paragraphs).
4342#### Extension: `autolink_bare_uris` ####
4344Makes all absolute URIs into links, even when not surrounded by
4345pointy braces `<...>`.
4347#### Extension: `mmd_link_attributes` ####
4349Parses multimarkdown style key-value attributes on link
4350and image references. This extension should not be confused with the
4351[`link_attributes`](#extension-link_attributes) extension.
4353 This is a reference ![image][ref] with multimarkdown attributes.
4355 [ref]: http://path.to/image "Image title" width=20px height=30px
4356 id=myId class="myClass1 myClass2"
4358#### Extension: `mmd_header_identifiers` ####
4360Parses multimarkdown style header identifiers (in square brackets,
4361after the header but before any trailing `#`s in an ATX header).
4363#### Extension: `compact_definition_lists` ####
4365Activates the definition list syntax of pandoc 1.12.x and earlier.
4366This syntax differs from the one described above under [Definition lists]
4369 - No blank line is required between consecutive items of the
4371 - To get a "tight" or "compact" list, omit space between consecutive
4372 items; the space between a term and its definition does not affect
4374 - Lazy wrapping of paragraphs is not allowed: the entire definition must
4375 be indented four spaces.[^6]
4377[^6]: To see why laziness is incompatible with relaxing the requirement
4378 of a blank line between items, consider the following example:
4385 Is this a single list item with two definitions of "bar," the first of
4386 which is lazily wrapped, or two list items? To remove the ambiguity
4387 we must either disallow lazy wrapping or require a blank line between
4393In addition to pandoc's extended Markdown, the following Markdown
4394variants are supported:
4396`markdown_phpextra` (PHP Markdown Extra)
4397: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4398 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4399 `header_attributes`, `link_attributes`, `abbreviations`,
4400 `shortcut_reference_links`, `spaced_reference_links`.
4402`markdown_github` (deprecated GitHub-Flavored Markdown)
4403: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4404 `gfm_auto_identifiers`, `backtick_code_blocks`,
4405 `autolink_bare_uris`, `space_in_atx_header`,
4406 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4407 `shortcut_reference_links`, `angle_brackets_escapable`,
4408 `lists_without_preceding_blankline`.
4410`markdown_mmd` (MultiMarkdown)
4411: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4412 `tex_math_double_backslash`, `intraword_underscores`,
4413 `mmd_title_block`, `footnotes`, `definition_lists`,
4414 `all_symbols_escapable`, `implicit_header_references`,
4415 `auto_identifiers`, `mmd_header_identifiers`,
4416 `shortcut_reference_links`, `implicit_figures`,
4417 `superscript`, `subscript`, `backtick_code_blocks`,
4418 `spaced_reference_links`, `raw_attribute`.
4420`markdown_strict` (Markdown.pl)
4421: `raw_html`, `shortcut_reference_links`,
4422 `spaced_reference_links`.
4424We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4425which is implemented as a set of extensions on `commonmark`).
4427Note, however, that `commonmark` and `gfm` have limited support
4428for extensions. Only those listed below (and `smart`,
4429`raw_tex`, and `hard_line_breaks`) will work. The extensions
4430can, however, all be individually disabled. Also, `raw_tex`
4431only affects `gfm` output, not input.
4433`gfm` (GitHub-Flavored Markdown)
4434: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4435 `gfm_auto_identifiers`, `backtick_code_blocks`,
4436 `autolink_bare_uris`, `space_in_atx_header`,
4437 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4438 `shortcut_reference_links`, `angle_brackets_escapable`,
4439 `lists_without_preceding_blankline`.
4442Producing slide shows with pandoc
4443=================================
4445You can use pandoc to produce an HTML + JavaScript slide presentation
4446that can be viewed via a web browser. There are five ways to do this,
4447using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
4448You can also produce a PDF slide show using LaTeX [`beamer`], or
4449slides shows in Microsoft [PowerPoint] format.
4451Here's the Markdown source for a simple slide show, `habits.txt`:
4478 
4485To produce an HTML/JavaScript slide show, simply type
4487 pandoc -t FORMAT -s habits.txt -o habits.html
4489where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
4491For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4492`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4493assumed to be available at the relative path `s5/default` (for S5), `slideous`
4494(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4495`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4496`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4497above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4500With all HTML slide formats, the `--self-contained` option can be used to
4501produce a single file that contains all of the data necessary to display the
4502slide show, including linked scripts, stylesheets, images, and videos.
4504To produce a PDF slide show using beamer, type
4506 pandoc -t beamer habits.txt -o habits.pdf
4508Note that a reveal.js slide show can also be converted to a PDF
4509by printing it to a file from the browser.
4511To produce a Powerpoint slide show, type
4513 pandoc habits.txt -o habits.pptx
4515Structuring the slide show
4516--------------------------
4518By default, the *slide level* is the highest header level in
4519the hierarchy that is followed immediately by content, and not another
4520header, somewhere in the document. In the example above, level 1 headers
4521are always followed by level 2 headers, which are followed by content,
4522so 2 is the slide level. This default can be overridden using
4523the `--slide-level` option.
4525The document is carved up into slides according to the following
4528 * A horizontal rule always starts a new slide.
4530 * A header at the slide level always starts a new slide.
4532 * Headers *below* the slide level in the hierarchy create
4533 headers *within* a slide.
4535 * Headers *above* the slide level in the hierarchy create
4536 "title slides," which just contain the section title
4537 and help to break the slide show into sections.
4539 * Content *above* the slide level will not appear in the slide
4542 * A title page is constructed automatically from the document's title
4543 block, if present. (In the case of beamer, this can be disabled
4544 by commenting out some lines in the default template.)
4546These rules are designed to support many different styles of slide show. If
4547you don't care about structuring your slides into sections and subsections,
4548you can just use level 1 headers for all each slide. (In that case, level 1
4549will be the slide level.) But you can also structure the slide show into
4550sections, as in the example above.
4552Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4553layout will be produced, with level 1 headers building horizontally
4554and level 2 headers building vertically. It is not recommended that
4555you use deeper nesting of section levels with reveal.js.
4560By default, these writers produce lists that display "all at once."
4561If you want your lists to display incrementally (one item at a time),
4562use the `-i` option. If you want a particular list to depart from the
4563default, put it in a `div` block with class `incremental` or
4564`nonincremental`. So, for example, using the `fenced div` syntax, the
4565following would be incremental regardless of the document default:
4583While using `incremental` and `nonincremental` divs are the
4584recommended method of setting incremental lists on a per-case basis,
4585an older method is also supported: putting lists inside a blockquote
4586will depart from the document default (that is, it will display
4587incrementally without the `-i` option and all at once with the `-i`
4593Both methods allow incremental and nonincremental lists to be mixed
4594in a single document.
4599You can add "pauses" within a slide by including a paragraph containing
4600three dots, separated by spaces:
4602 # Slide with a pause
4604 content before the pause
4608 content after the pause
4613You can change the style of HTML slides by putting customized CSS files
4614in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
4615or `$DATADIR/slideous` (for Slideous),
4616where `$DATADIR` is the user data directory (see `--data-dir`, above).
4617The originals may be found in pandoc's system data directory (generally
4618`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
4619files it does not find in the user data directory.
4621For dzslides, the CSS is included in the HTML file itself, and may
4624All [reveal.js configuration options] can be set through variables.
4625For example, themes can be used by setting the `theme` variable:
4629Or you can specify a custom stylesheet using the `--css` option.
4631To style beamer slides, you can specify a `theme`, `colortheme`,
4632`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
4634 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4636Note that header attributes will turn into slide attributes
4637(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4638to style individual slides. In beamer, the only header attribute
4639that affects slides is the `allowframebreaks` class, which sets the
4640`allowframebreaks` option, causing multiple slides to be created
4641if the content overfills the frame. This is recommended especially for
4644 # References {.allowframebreaks}
4649Speaker notes are supported in reveal.js and PowerPoint (pptx)
4650output. You can add notes to your Markdown document thus:
4656 - It can contain Markdown
4661To show the notes window in reveal.js, press `s` while viewing the
4662presentation. Speaker notes in PowerPoint will be available, as usual,
4663in handouts and presenter view.
4665Notes are not yet supported for other slide formats, but the notes
4666will not appear on the slides themselves.
4671To put material in side by side columns, you can use a native
4672div container with class `columns`, containing two or more div
4673containers with class `column` and a `width` attribute:
4675 :::::::::::::: {.columns}
4676 ::: {.column width="40%"}
4679 ::: {.column width="60%"}
4684Frame attributes in beamer
4685--------------------------
4687Sometimes it is necessary to add the LaTeX `[fragile]` option to
4688a frame in beamer (for example, when using the `minted` environment).
4689This can be forced by adding the `fragile` class to the header
4690introducing the slide:
4692 # Fragile slide {.fragile}
4694All of the other frame attributes described in Section 8.1 of
4695the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4696`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4697`shrink`, `standout`, `noframenumbering`.
4699Background in reveal.js and beamer
4700----------------------------------
4702Background images can be added to self-contained reveal.js slideshows and
4703to beamer slideshows.
4705For the same image on every slide, use the configuration
4706option `background-image` either in the YAML metadata block
4707or as a command-line variable. (There are no other options in
4708beamer and the rest of this section concerns reveal.js slideshows.)
4710For reveal.js, you can instead use the reveal.js-native option
4711`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4712and `parallaxBackgroundVertical` the same way and must also set
4713`parallaxBackgroundSize` to have your values take effect.
4715To set an image for a particular reveal.js slide, add
4716`{data-background-image="/path/to/image"}`
4717to the first slide-level header on the slide (which may even be empty).
4719In reveal.js's overview mode, the parallaxBackgroundImage will show up
4720only on the first slide.
4722Other reveal.js background settings also work on individual slides, including
4723`data-background-size`, `data-background-repeat`, `data-background-color`,
4724`data-transition`, and `data-transition-speed`.
4727documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4730For example in reveal.js:
4735parallaxBackgroundImage: /path/to/my/background_image.png
4740Slide 1 has background_image.png as its background.
4742## {data-background-image="/path/to/special_image.jpg"}
4744Slide 2 has a special image for its background, even though the header has no content.
4747Creating EPUBs with pandoc
4748==========================
4753EPUB metadata may be specified using the `--epub-metadata` option, but
4754if the source document is Markdown, it is better to use a [YAML metadata
4755block][Extension: `yaml_metadata_block`]. Here is an example:
4762 text: An investigation of metadata
4770 text: doi:10.234234.234/33
4772 rights: © 2007 John Smith, CC BY-NC
4777The following fields are recognized:
4780 ~ Either a string value or an object with fields `text` and
4781 `scheme`. Valid values for `scheme` are `ISBN-10`,
4782 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
4783 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
4784 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
4787 ~ Either a string value, or an object with fields `file-as` and
4788 `type`, or a list of such objects. Valid values for `type` are
4789 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
4792 ~ Either a string value, or an object with fields `role`, `file-as`,
4793 and `text`, or a list of such objects. Valid values for `role` are
4794 [MARC relators], but
4795 pandoc will attempt to translate the human-readable versions
4796 (like "author" and "editor") to the appropriate marc relators.
4799 ~ Same format as `creator`.
4802 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
4803 Pandoc will attempt to convert other common date formats.
4805`lang` (or legacy: `language`)
4806 ~ A string value in [BCP 47] format. Pandoc will default to the local
4807 language if nothing is specified.
4810 ~ A string value or a list of such values.
4831 ~ A string value (path to cover image).
4833`css` (or legacy: `stylesheet`)
4834 ~ A string value (path to CSS stylesheet).
4836`page-progression-direction`
4837 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
4838 attribute for the [`spine` element].
4841 ~ iBooks-specific metadata, with the following fields:
4843 - `version`: (string)
4844 - `specified-fonts`: `true`|`false` (default `false`)
4845 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
4846 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
4847 - `binding`: `true`|`false` (default `true`)
4848 - `scroll-axis`: `vertical`|`horizontal`|`default`
4850[MARC relators]: http://loc.gov/marc/relators/relaterm.html
4851[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4853The `epub:type` attribute
4854-------------------------
4856For `epub3` output, you can mark up the header that corresponds to an EPUB
4857chapter using the [`epub:type` attribute][epub-type]. For example, to set
4858the attribute to the value `prologue`, use this markdown:
4860 # My chapter {epub:type=prologue}
4862Which will result in:
4864 <body epub:type="frontmatter">
4865 <section epub:type="prologue">
4868Pandoc will output `<body epub:type="bodymatter">`, unless
4869you use one of the following values, in which case either
4870`frontmatter` or `backmatter` will be output.
4872`epub:type` of first section `epub:type` of body
4873---------------------------- ------------------
4876acknowledgments frontmatter
4877copyright-page frontmatter
4878dedication frontmatter
4880halftitle, frontmatter
4881introduction frontmatter
4883seriespage frontmatter
4884titlepage frontmatter
4888conclusion backmatter
4891[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
4896By default, pandoc will download media referenced from any `<img>`, `<audio>`,
4897`<video>` or `<source>` element present in the generated EPUB,
4898and include it in the EPUB container, yielding a completely
4899self-contained EPUB. If you want to link to external media resources
4900instead, use raw HTML in your source and add `data-external="1"` to the tag
4901with the `src` attribute. For example:
4903 <audio controls="1">
4904 <source src="http://example.com/music/toccata.mp3"
4905 data-external="1" type="audio/mpeg">
4909Creating Jupyter notebooks with pandoc
4910======================================
4912When creating a [Jupyter notebook], pandoc will try to infer the
4913notebook structure. Code blocks with the class `code` will be
4914taken as code cells, and intervening content will be taken as
4915Markdown cells. Attachments will automatically be created for
4916images in Markdown cells. Metadata will be taken from the
4917`jupyter` metadata field. For example:
4926 display_name: Python 2
4933 file_extension: ".py"
4934 mimetype: "text/x-python"
4936 nbconvert_exporter: "python"
4937 pygments_lexer: "ipython2"
4943**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
4944bibendum felis dictum sodales.
4953from IPython.display import HTML
4956console.log("hello");
4964This image  will be
4965included as a cell attachment.
4968If you want to add cell attributes, group cells differently, or
4969add output to code cells, then you need to include divs to
4970indicate the structure. You can use either [fenced
4971divs][Extension: `fenced_divs`] or [native divs][Extension:
4972`native_divs`] for this. Here is an example:
4975:::::: {.cell .markdown}
4978**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
4979bibendum felis dictum sodales.
4982:::::: {.cell .code execution_count=1}
4987::: {.output .stream .stdout}
4994:::::: {.cell .code execution_count=2}
4996from IPython.display import HTML
4999console.log("hello");
5005::: {.output .execute_result execution_count=2}
5008console.log("hello");
5020Pandoc will automatically highlight syntax in [fenced code blocks] that
5021are marked with a language name. The Haskell library [skylighting] is
5022used for highlighting. Currently highlighting is supported only for
5023HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5024that pandoc will recognize, type `pandoc --list-highlight-languages`.
5026The color scheme can be selected using the `--highlight-style` option.
5027The default color scheme is `pygments`, which imitates the default color
5028scheme used by the Python library pygments (though pygments is not actually
5029used to do the highlighting). To see a list of highlight styles,
5030type `pandoc --list-highlight-styles`.
5032If you are not satisfied with the predefined styles, you can
5033use `--print-highlight-style` to generate a JSON `.theme` file which
5034can be modified and used as the argument to `--highlight-style`. To
5035get a JSON version of the `pygments` style, for example:
5037 pandoc --print-highlight-style pygments > my.theme
5039Then edit `my.theme` and use it like this:
5041 pandoc --highlight-style my.theme
5043If you are not satisfied with the built-in highlighting, or you
5044want highlight a language that isn't supported, you can use the
5045`--syntax-definition` option to load a [KDE-style XML syntax definition
5046file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5047Before writing your own, have a look at KDE's [repository of syntax
5048definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5050To disable highlighting, use the `--no-highlight` option.
5052[skylighting]: https://github.com/jgm/skylighting
5057Custom styles can be used in the docx and ICML formats.
5062The docx reader, by default, only reads those styles that it can
5063convert into pandoc elements, either by direct conversion or
5064interpreting the derivation of the input document's styles.
5066By enabling the [`styles` extension](#ext-styles) in the docx reader
5067(`-f docx+styles`), you can produce output that maintains the styles
5068of the input document, using the `custom-style` class. Paragraph
5069styles are interpreted as divs, while character styles are interpreted
5072For example, using the `custom-style-reference.docx` file in the test
5073directory, we have the following different outputs:
5075Without the `+styles` extension:
5077 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5080 This is text with an *emphasized* text style. And this is text with a
5081 **strengthened** text style.
5083 > Here is a styled paragraph that inherits from Block Text.
5085And with the extension:
5087 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5089 ::: {custom-style="FirstParagraph"}
5093 ::: {custom-style="BodyText"}
5094 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5095 And this is text with a [strengthened]{custom-style="Strengthened"}
5099 ::: {custom-style="MyBlockStyle"}
5100 > Here is a styled paragraph that inherits from Block Text.
5103With these custom styles, you can use your input document as a
5104reference-doc while creating docx output (see below), and maintain the
5105same styles in your input and output files.
5110By default, pandoc's docx and ICML output applies a predefined set of styles
5111for blocks such as paragraphs and block quotes, and uses largely default
5112formatting (italics, bold) for inlines. This will work for most
5113purposes, especially alongside a `reference.docx` file. However, if you
5114need to apply your own styles to blocks, or match a preexisting set of
5115styles, pandoc allows you to define custom styles for blocks and text
5116using `div`s and `span`s, respectively.
5118If you define a `div` or `span` with the attribute `custom-style`,
5119pandoc will apply your specified style to the contained elements. So,
5120for example using the `bracketed_spans` syntax,
5122 [Get out]{custom-style="Emphatically"}, he said.
5124would produce a docx file with "Get out" styled with character
5125style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5127 Dickinson starts the poem simply:
5129 ::: {custom-style="Poetry"}
5130 | A Bird came down the Walk---
5131 | He did not know I saw---
5134would style the two contained lines with the `Poetry` paragraph style.
5136For docx output, styles will be defined in the output file as inheriting
5137from normal text, if the styles are not yet in your reference.docx.
5138If they are already defined, pandoc will not alter the definition.
5140This feature allows for greatest customization in conjunction with
5141[pandoc filters]. If you want all paragraphs after block quotes to be
5142indented, you can write a filter to apply the styles necessary. If you
5143want all italics to be transformed to the `Emphasis` character style
5144(perhaps to change their color), you can write a filter which will
5145transform all italicized inlines to inlines within an `Emphasis`
5148[pandoc filters]: http://pandoc.org/filters.html
5153Pandoc can be extended with custom writers written in [lua]. (Pandoc
5154includes a lua interpreter, so lua need not be installed separately.)
5156To use a custom writer, simply specify the path to the lua script
5157in place of the output format. For example:
5159 pandoc -t data/sample.lua
5161Creating a custom writer requires writing a lua function for each
5162possible element in a pandoc document. To get a documented example
5163which you can modify according to your needs, do
5165 pandoc --print-default-data-file sample.lua
5167[lua]: http://www.lua.org
5172If you use pandoc to convert user-contributed content in a web
5173application, here are some things to keep in mind:
51751. Although pandoc itself will not create or modify any files other
5176 than those you explicitly ask it create (with the exception
5177 of temporary files used in producing PDFs), a filter or custom
5178 writer could in principle do anything on your file system. Please
5179 audit filters and custom writers very carefully before using them.
51812. If your application uses pandoc as a Haskell library (rather than
5182 shelling out to the executable), it is possible to use it in a mode
5183 that fully isolates pandoc from your file system, by running the
5184 pandoc operations in the `PandocPure` monad. See the document
5185 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
51883. Pandoc's parsers can exhibit pathological performance on some
5189 corner cases. It is wise to put any pandoc operations under
5190 a timeout, to avoid DOS attacks that exploit these issues.
5191 If you are using the pandoc executable, you can add the
5192 command line options `+RTS -M512M -RTS` (for example) to limit
5193 the heap size to 512MB.
51954. The HTML generated by pandoc is not guaranteed to be safe.
5196 If `raw_html` is enabled for the Markdown input, users can
5197 inject arbitrary HTML. Even if `raw_html` is disabled,
5198 users can include dangerous content in attributes for
5199 headers, spans, and code blocks. To be safe, you should
5200 run all the generated HTML through an HTML sanitizer.
5205Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5206under the [GPL], version 2 or greater. This software carries no
5207warranty of any kind. (See COPYRIGHT for full copyright and
5208warranty notices.) For a full list of contributors, see the file
5209AUTHORS.md in the pandoc source code.
5211[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