2title: Pandoc User's Guide
9`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.
45If no *input-files* are specified, input is read from *stdin*.
46Output goes to *stdout* by default. For output to a file,
49 pandoc -o output.html input.txt
51By default, pandoc produces a document fragment. To produce a standalone
52document (e.g. a valid HTML file including `<head>` and `<body>`),
53use the `-s` or `--standalone` flag:
55 pandoc -s -o output.html input.txt
57For more information on how standalone documents are produced, see
60If multiple input files are given, `pandoc` will concatenate them all (with
61blank lines between them) before parsing. (Use `--file-scope` to parse files
66The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
68`-f/--from` option, the output format using the `-t/--to` option.
69Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
71 pandoc -f markdown -t latex hello.txt
73To convert `hello.html` from HTML to Markdown:
75 pandoc -f html -t markdown hello.html
77Supported input and output formats are listed below under [Options]
78(see `-f` for input formats and `-t` for output formats). You
79can also use `pandoc --list-input-formats` and
80`pandoc --list-output-formats` to print lists of supported
83If the input or output format is not specified explicitly, `pandoc`
84will attempt to guess it from the extensions of the filenames.
87 pandoc -o hello.tex hello.txt
89will convert `hello.txt` from Markdown to LaTeX. If no output file
90is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
94be assumed to be Markdown.
98Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
100should pipe input and output through [`iconv`]:
102 iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
104Note that in some output formats (such as HTML, LaTeX, ConTeXt,
105RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
109[`iconv`]: http://www.gnu.org/software/libiconv/
113To produce a PDF, specify an output file with a `.pdf` extension:
115 pandoc test.txt -o test.pdf
117By default, pandoc will use LaTeX to create the PDF, which requires
118that a LaTeX engine be installed (see `--pdf-engine` below).
119Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120intermediate format. To do this, specify an output file with a
121`.pdf` extension, as before, but add the `--pdf-engine` option
122or `-t context`, `-t html`, or `-t ms` to the command line.
123The tool used to generate the PDF from the intermediate format
124may be specified using `--pdf-engine`.
126You can control the PDF style using variables, depending on
127the intermediate format used: see [variables for LaTeX],
128[variables for ConTeXt], [variables for `wkhtmltopdf`],
129[variables for ms]. When HTML is used as an intermediate
130format, the output can be styled using `--css`.
132To debug the PDF creation, it can be useful to look at the intermediate
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139[`ifxetex`], [`ifluatex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146the PDF engine requires [`fontspec`]. `xelatex` uses
147[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
148`dir` variable set). If the `mathspec` variable is set,
149`xelatex` will use [`mathspec`] instead of [`unicode-math`].
150The [`upquote`] and [`microtype`] packages are used if
151available, and [`csquotes`] will be used for [typography]
152if the `csquotes` variable or metadata field is set to a
153true value. The [`natbib`], [`biblatex`], [`bibtex`], and
154[`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
158environments), [`microtype`] (for better spacing adjustments),
159[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
164[TeX Live]: http://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
168[`biber`]: https://ctan.org/pkg/biber
169[`biblatex`]: https://ctan.org/pkg/biblatex
170[`bibtex`]: https://ctan.org/pkg/bibtex
171[`bidi`]: https://ctan.org/pkg/bidi
172[`bookmark`]: https://ctan.org/pkg/bookmark
173[`booktabs`]: https://ctan.org/pkg/booktabs
174[`csquotes`]: https://ctan.org/pkg/csquotes
175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176[`fontspec`]: https://ctan.org/pkg/fontspec
177[`footnote`]: https://ctan.org/pkg/footnote
178[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179[`geometry`]: https://ctan.org/pkg/geometry
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
183[`ifluatex`]: https://ctan.org/pkg/ifluatex
184[`ifxetex`]: https://ctan.org/pkg/ifxetex
185[`listings`]: https://ctan.org/pkg/listings
186[`lm`]: https://ctan.org/pkg/lm
187[`longtable`]: https://ctan.org/pkg/longtable
188[`mathspec`]: https://ctan.org/pkg/mathspec
189[`microtype`]: https://ctan.org/pkg/microtype
190[`natbib`]: https://ctan.org/pkg/natbib
191[`parskip`]: https://ctan.org/pkg/parskip
192[`polyglossia`]: https://ctan.org/pkg/polyglossia
193[`prince`]: https://www.princexml.com/
194[`setspace`]: https://ctan.org/pkg/setspace
195[`ulem`]: https://ctan.org/pkg/ulem
196[`unicode-math`]: https://ctan.org/pkg/unicode-math
197[`upquote`]: https://ctan.org/pkg/upquote
198[`weasyprint`]: http://weasyprint.org
199[`wkhtmltopdf`]: https://wkhtmltopdf.org
200[`xcolor`]: https://ctan.org/pkg/xcolor
201[`xecjk`]: https://ctan.org/pkg/xecjk
202[`xurl`]: https://ctan.org/pkg/xurl
206## Reading from the Web
208Instead of an input file, an absolute URI may be given. In this case
209pandoc will fetch the content using HTTP:
211 pandoc -f html -t markdown http://www.fsf.org
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
221## General options {.options}
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
225: Specify input format. *FORMAT* can be:
228 - `commonmark` ([CommonMark] Markdown)
229 - `creole` ([Creole 1.0])
230 - `docbook` ([DocBook])
231 - `docx` ([Word docx])
232 - `dokuwiki` ([DokuWiki markup])
234 - `fb2` ([FictionBook2] e-book)
235 - `gfm` ([GitHub-Flavored Markdown]),
236 or the deprecated and less accurate `markdown_github`;
237 use [`markdown_github`](#markdown-variants) only
238 if you need extensions not supported in [`gfm`](#markdown-variants).
239 - `haddock` ([Haddock markup])
241 - `ipynb` ([Jupyter notebook])
242 - `jats` ([JATS] XML)
243 - `jira` ([Jira] wiki markup)
244 - `json` (JSON version of native AST)
246 - `markdown` ([Pandoc's Markdown])
247 - `markdown_mmd` ([MultiMarkdown])
248 - `markdown_phpextra` ([PHP Markdown Extra])
249 - `markdown_strict` (original unextended [Markdown])
250 - `mediawiki` ([MediaWiki markup])
253 - `native` (native Haskell)
256 - `org` ([Emacs Org mode])
257 - `rst` ([reStructuredText])
259 - `textile` ([Textile])
260 - `tikiwiki` ([TikiWiki markup])
261 - `twiki` ([TWiki markup])
262 - `vimwiki` ([Vimwiki])
265 Extensions can be individually enabled or disabled by
266 appending `+EXTENSION` or `-EXTENSION` to the format name.
267 See [Extensions] below, for a list of extensions and
268 their names. See `--list-input-formats` and `--list-extensions`,
271`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
273: Specify output format. *FORMAT* can be:
275 ::: {#output-formats}
276 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
277 - `beamer` ([LaTeX beamer][`beamer`] slide show)
278 - `commonmark` ([CommonMark] Markdown)
279 - `context` ([ConTeXt])
280 - `docbook` or `docbook4` ([DocBook] 4)
281 - `docbook5` (DocBook 5)
282 - `docx` ([Word docx])
283 - `dokuwiki` ([DokuWiki markup])
284 - `epub` or `epub3` ([EPUB] v3 book)
286 - `fb2` ([FictionBook2] e-book)
287 - `gfm` ([GitHub-Flavored Markdown]),
288 or the deprecated and less accurate `markdown_github`;
289 use [`markdown_github`](#markdown-variants) only
290 if you need extensions not supported in [`gfm`](#markdown-variants).
291 - `haddock` ([Haddock markup])
292 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
293 - `html4` ([XHTML] 1.0 Transitional)
294 - `icml` ([InDesign ICML])
295 - `ipynb` ([Jupyter notebook])
296 - `jats` ([JATS] XML)
297 - `jira` ([Jira] wiki markup)
298 - `json` (JSON version of native AST)
301 - `markdown` ([Pandoc's Markdown])
302 - `markdown_mmd` ([MultiMarkdown])
303 - `markdown_phpextra` ([PHP Markdown Extra])
304 - `markdown_strict` (original unextended [Markdown])
305 - `mediawiki` ([MediaWiki markup])
308 - `native` (native Haskell),
309 - `odt` ([OpenOffice text document][ODT])
311 - `opendocument` ([OpenDocument])
312 - `org` ([Emacs Org mode])
314 - `plain` (plain text),
315 - `pptx` ([PowerPoint] slide show)
316 - `rst` ([reStructuredText])
317 - `rtf` ([Rich Text Format])
318 - `texinfo` ([GNU Texinfo])
319 - `textile` ([Textile])
320 - `slideous` ([Slideous] HTML and JavaScript slide show)
321 - `slidy` ([Slidy] HTML and JavaScript slide show)
322 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
323 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
324 - `s5` ([S5] HTML and JavaScript slide show)
325 - `tei` ([TEI Simple])
326 - `xwiki` ([XWiki markup])
327 - `zimwiki` ([ZimWiki markup])
328 - the path of a custom lua writer, see [Custom writers] below
331 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
332 to *stdout* unless forced with `-o -`.
334 Extensions can be individually enabled or
335 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
336 name. See [Extensions] below, for a list of extensions and their
337 names. See `--list-output-formats` and `--list-extensions`, below.
339`-o` *FILE*, `--output=`*FILE*
341: Write output to *FILE* instead of *stdout*. If *FILE* is
342 `-`, output will go to *stdout*, even if a non-textual format
343 (`docx`, `odt`, `epub2`, `epub3`) is specified.
345`--data-dir=`*DIRECTORY*
347: Specify the user data directory to search for pandoc data files.
348 If this option is not specified, the default user data directory
349 will be used. On \*nix and macOS systems this will be the `pandoc`
350 subdirectory of the XDG data directory (by default,
351 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
352 environment variable). If that directory does not exist,
353 `$HOME/.pandoc` will be used (for backwards compatibility).
354 In Windows the default user data directory is
355 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
356 You can find the default user data directory on your system by
357 looking at the output of `pandoc --version`.
358 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
359 `slidy`, `slideous`, or `s5` directory
360 placed in this directory will override pandoc's normal defaults.
362`-d` *FILE*, `--defaults=`*FILE*
364: Specify a set of default option settings. *FILE* is a YAML
365 file whose fields correspond to command-line option
366 settings. All options for document conversion, including input
367 and output files, can be set using a defaults file. The file will
368 be searched for first in the working directory, and then in
369 the `defaults` subdirectory of the user data directory
370 (see `--data-dir`). The `.yaml` extension may be omitted.
371 See the section [Default files] for more information on the
372 file format. Settings from the defaults file may be
373 overridden or extended by subsequent options on the command
378: Generate a bash completion script. To enable bash completion
379 with pandoc, add this to your `.bashrc`:
381 eval "$(pandoc --bash-completion)"
385: Give verbose debugging output. Currently this only has an effect
390: Suppress warning messages.
394: Exit with error status if there are any warnings.
398: Write log messages in machine-readable JSON format to
399 *FILE*. All messages above DEBUG level will be written,
400 regardless of verbosity settings (`--verbose`, `--quiet`).
402`--list-input-formats`
404: List supported input formats, one per line.
406`--list-output-formats`
408: List supported output formats, one per line.
410`--list-extensions`[`=`*FORMAT*]
412: List supported extensions for *FORMAT*, one per line, preceded
413 by a `+` or `-` indicating whether it is enabled by default
414 in *FORMAT*. If *FORMAT* is not specified, defaults for
415 pandoc's Markdown are given.
417`--list-highlight-languages`
419: List supported languages for syntax highlighting, one per
422`--list-highlight-styles`
424: List supported styles for syntax highlighting, one per line.
425 See `--highlight-style`.
435[Markdown]: http://daringfireball.net/projects/markdown/
436[CommonMark]: http://commonmark.org
437[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
438[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
439[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
440[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
441[S5]: http://meyerweb.com/eric/tools/s5/
442[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
443[Slideous]: http://goessner.net/articles/slideous/
444[HTML]: http://www.w3.org/html/
445[HTML5]: http://www.w3.org/TR/html5/
446[polyglot markup]: https://www.w3.org/TR/html-polyglot/
447[XHTML]: http://www.w3.org/TR/xhtml1/
448[LaTeX]: http://latex-project.org
449[`beamer`]: https://ctan.org/pkg/beamer
450[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
451[ConTeXt]: http://www.contextgarden.net/
452[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
453[DocBook]: http://docbook.org
454[JATS]: https://jats.nlm.nih.gov
455[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
456[txt2tags]: http://txt2tags.org
457[EPUB]: http://idpf.org/epub
458[OPML]: http://dev.opml.org/spec2.html
459[OpenDocument]: http://opendocument.xml.org
460[ODT]: http://en.wikipedia.org/wiki/OpenDocument
461[Textile]: http://redcloth.org/textile
462[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
463[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
464[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
465[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
466[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
467[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
468[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
469[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
470[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
471[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
472[Haskell]: https://www.haskell.org
473[GNU Texinfo]: http://www.gnu.org/software/texinfo/
474[Emacs Org mode]: http://orgmode.org
475[AsciiDoc]: http://www.methods.co.nz/asciidoc/
476[AsciiDoctor]: https://asciidoctor.org/
477[DZSlides]: http://paulrouget.com/dzslides/
478[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
479[PDF]: https://www.adobe.com/pdf/
480[reveal.js]: http://lab.hakim.se/reveal-js/
481[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
482[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
483[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
484[TEI Simple]: https://github.com/TEIC/TEI-Simple
485[Muse]: https://amusewiki.org/library/manual
486[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
487[Vimwiki]: https://vimwiki.github.io
489## Reader options {.options}
491`--shift-heading-level-by=`*NUMBER*
493: Shift heading levels by a positive or negative integer.
494 For example, with `--shift-heading-level-by=-1`, level 2
495 headings become level 1 headings, and level 3 headings
496 become level 2 headings. Headings cannot have a level
497 less than 1, so a heading that would be shifted below level 1
498 becomes a regular paragraph. Exception: with a shift of -N,
499 a level-N heading at the beginning of the document
500 replaces the metadata title. `--shift-heading-level-by=-1`
501 is a good choice when converting HTML or Markdown documents that
502 use an initial level-1 heading for the document title and
503 level-2+ headings for sections. `--shift-heading-level-by=1`
504 may be a good choice for converting Markdown documents that
505 use level-1 headings for sections to HTML, since pandoc uses
506 a level-1 heading to render the document title.
508`--base-header-level=`*NUMBER*
510: *Deprecated. Use `--shift-heading-level-by`=X instead,
511 where X = NUMBER - 1.* Specify the base level for headings
514`--strip-empty-paragraphs`
516: *Deprecated. Use the `+empty_paragraphs` extension instead.*
517 Ignore paragraphs with no content. This option is useful
518 for converting word processing documents where users have
519 used empty paragraphs to create inter-paragraph space.
521`--indented-code-classes=`*CLASSES*
523: Specify classes to use for indented code blocks--for example,
524 `perl,numberLines` or `haskell`. Multiple classes may be separated
527`--default-image-extension=`*EXTENSION*
529: Specify a default extension to use when image paths/URLs have no
530 extension. This allows you to use the same source for formats that
531 require different kinds of images. Currently this option only affects
532 the Markdown and LaTeX readers.
536: Parse each file individually before combining for multifile
537 documents. This will allow footnotes in different files with the
538 same identifiers to work as expected. If this option is set,
539 footnotes and links will not work across files. Reading binary
540 files (docx, odt, epub) implies `--file-scope`.
542`-F` *PROGRAM*, `--filter=`*PROGRAM*
544: Specify an executable to be used as a filter transforming the
545 pandoc AST after the input is parsed and before the output is
546 written. The executable should read JSON from stdin and write
547 JSON to stdout. The JSON must be formatted like pandoc's own
548 JSON input and output. The name of the output format will be
549 passed to the filter as the first argument. Hence,
551 pandoc --filter ./caps.py -t latex
555 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
557 The latter form may be useful for debugging filters.
559 Filters may be written in any language. `Text.Pandoc.JSON`
560 exports `toJSONFilter` to facilitate writing filters in Haskell.
561 Those who would prefer to write filters in python can use the
562 module [`pandocfilters`], installable from PyPI. There are also
563 pandoc filter libraries in [PHP], [perl], and
564 [JavaScript/node.js].
566 In order of preference, pandoc will look for filters in
568 1. a specified full or relative path (executable or
571 2. `$DATADIR/filters` (executable or non-executable)
572 where `$DATADIR` is the user data directory (see
573 `--data-dir`, above).
575 3. `$PATH` (executable only)
577 Filters and lua-filters are applied in the order specified
580`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
582: Transform the document in a similar fashion as JSON filters (see
583 `--filter`), but use pandoc's build-in lua filtering system. The given
584 lua script is expected to return a list of lua filters which will be
585 applied in order. Each lua filter must contain element-transforming
586 functions indexed by the name of the AST element on which the filter
587 function should be applied.
589 The `pandoc` lua module provides helper functions for element
590 creation. It is always loaded into the script's lua environment.
592 The following is an example lua script for macro-expansion:
594 function expand_hello_world(inline)
595 if inline.c == '{{helloworld}}' then
596 return pandoc.Emph{ pandoc.Str "Hello, World" }
602 return {{Str = expand_hello_world}}
604 In order of preference, pandoc will look for lua filters in
606 1. a specified full or relative path (executable or
609 2. `$DATADIR/filters` (executable or non-executable)
610 where `$DATADIR` is the user data directory (see
611 `--data-dir`, above).
613`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
615: Set the metadata field *KEY* to the value *VAL*. A value specified
616 on the command line overrides a value specified in the document
617 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
618 Values will be parsed as YAML boolean or string values. If no value is
619 specified, the value will be treated as Boolean true. Like
620 `--variable`, `--metadata` causes template variables to be set.
621 But unlike `--variable`, `--metadata` affects the metadata of the
622 underlying document (which is accessible from filters and may be
623 printed in some output formats) and metadata values will be escaped
624 when inserted into the template.
626`--metadata-file=`*FILE*
628: Read metadata from the supplied YAML (or JSON) file. This
629 option can be used with every input format, but string scalars
630 in the YAML file will always be parsed as Markdown. Generally,
631 the input will be handled the same as in [YAML metadata
632 blocks][Extension: `yaml_metadata_block`]. This option can be
633 used repeatedly to include multiple metadata files; values in
634 files specified later on the command line will be preferred
635 over those specified in earlier files. Metadata values
636 specified inside the document, or by using `-M`, overwrite
637 values specified with this option.
639`-p`, `--preserve-tabs`
641: Preserve tabs instead of converting them to spaces. (By default, pandoc
642 converts tabs to spaces before parsing its input.) Note that this will
643 only affect tabs in literal code spans and code blocks. Tabs in regular
644 text are always treated as spaces.
648: Specify the number of spaces per tab (default is 4).
650`--track-changes=accept`|`reject`|`all`
652: Specifies what to do with insertions, deletions, and comments
653 produced by the MS Word "Track Changes" feature. `accept` (the
654 default), inserts all insertions, and ignores all
655 deletions. `reject` inserts all deletions and ignores
656 insertions. Both `accept` and `reject` ignore comments. `all` puts
657 in insertions, deletions, and comments, wrapped in spans with
658 `insertion`, `deletion`, `comment-start`, and `comment-end`
659 classes, respectively. The author and time of change is
660 included. `all` is useful for scripting: only accepting changes
661 from a certain reviewer, say, or before a certain date. If a
662 paragraph is inserted or deleted, `track-changes=all` produces a
663 span with the class `paragraph-insertion`/`paragraph-deletion`
664 before the affected paragraph break. This option only affects the
667`--extract-media=`*DIR*
669: Extract images and other media contained in or linked from
670 the source document to the path *DIR*, creating it if
671 necessary, and adjust the images references in the document
672 so they point to the extracted files. If the source format is
673 a binary container (docx, epub, or odt), the media is
674 extracted from the container and the original
675 filenames are used. Otherwise the media is read from the
676 file system or downloaded, and new filenames are constructed
677 based on SHA1 hashes of the contents.
679`--abbreviations=`*FILE*
681: Specifies a custom abbreviations file, with abbreviations
682 one to a line. If this option is not specified, pandoc will
683 read the data file `abbreviations` from the user data
684 directory or fall back on a system default. To see the
686 `pandoc --print-default-data-file=abbreviations`. The only
687 use pandoc makes of this list is in the Markdown reader.
688 Strings ending in a period that are found in this list will
689 be followed by a nonbreaking space, so that the period will
690 not produce sentence-ending space in formats like LaTeX.
692[`pandocfilters`]: https://github.com/jgm/pandocfilters
693[PHP]: https://github.com/vinai/pandocfilters-php
694[perl]: https://metacpan.org/pod/Pandoc::Filter
695[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
697## General writer options {.options}
701: Produce output with an appropriate header and footer (e.g. a
702 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
703 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
704 output. For `native` output, this option causes metadata to
705 be included; otherwise, metadata is suppressed.
707`--template=`*FILE*|*URL*
709: Use the specified file as a custom template for the generated document.
710 Implies `--standalone`. See [Templates], below, for a description
711 of template syntax. If no extension is specified, an extension
712 corresponding to the writer will be added, so that `--template=special`
713 looks for `special.html` for HTML output. If the template is not
714 found, pandoc will search for it in the `templates` subdirectory of
715 the user data directory (see `--data-dir`). If this option is not used,
716 a default template appropriate for the output format will be used (see
717 `-D/--print-default-template`).
719`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
721: Set the template variable *KEY* to the value *VAL* when rendering the
722 document in standalone mode. If no *VAL* is specified, the
723 key will be given the value `true`.
725`-D` *FORMAT*, `--print-default-template=`*FORMAT*
727: Print the system default template for an output *FORMAT*. (See `-t`
728 for a list of possible *FORMAT*s.) Templates in the user data
729 directory are ignored. This option may be used with
730 `-o`/`--output` to redirect output to a file, but
731 `-o`/`--output` must come before `--print-default-template`
734 Note that some of the default templates use partials, for
735 example `styles.html`. To print the partials, use
736 `--print-default-data-file`: for example,
737 `--print-default-data-file=templates/styles.html`.
739`--print-default-data-file=`*FILE*
741: Print a system default data file. Files in the user data directory
742 are ignored. This option may be used with `-o`/`--output` to
743 redirect output to a file, but `-o`/`--output` must come before
744 `--print-default-data-file` on the command line.
746`--eol=crlf`|`lf`|`native`
748: Manually specify line endings: `crlf` (Windows), `lf`
749 (macOS/Linux/UNIX), or `native` (line endings appropriate
750 to the OS on which pandoc is being run). The default is
755: Specify the default dpi (dots per inch) value for conversion
756 from pixels to inch/centimeters and vice versa. (Technically,
757 the correct term would be ppi: pixels per inch.) The default
758 is 96dpi. When images contain information about dpi
759 internally, the encoded value is used instead of the default
760 specified by this option.
762`--wrap=auto`|`none`|`preserve`
764: Determine how text is wrapped in the output (the source
765 code, not the rendered version). With `auto` (the default),
766 pandoc will attempt to wrap lines to the column width specified by
767 `--columns` (default 72). With `none`, pandoc will not wrap
768 lines at all. With `preserve`, pandoc will attempt to
769 preserve the wrapping from the source document (that is,
770 where there are nonsemantic newlines in the source, there
771 will be nonsemantic newlines in the output as well).
772 Automatic wrapping does not currently work in HTML output.
773 In `ipynb` output, this option affects wrapping of the
774 contents of markdown cells.
778: Specify length of lines in characters. This affects text wrapping
779 in the generated source code (see `--wrap`). It also affects
780 calculation of column widths for plain text tables (see [Tables] below).
782`--toc`, `--table-of-contents`
784: Include an automatically generated table of contents (or, in
785 the case of `latex`, `context`, `docx`, `odt`,
786 `opendocument`, `rst`, or `ms`, an instruction to create
787 one) in the output document. This option has no effect
788 unless `-s/--standalone` is used, and it has no effect
789 on `man`, `docbook4`, `docbook5`, or `jats` output.
791 Note that if you are producing a PDF via `ms`, the table
792 of contents will appear at the beginning of the
793 document, before the title. If you would prefer it to
794 be at the end of the document, use the option
795 `--pdf-engine-opt=--no-toc-relocation`.
797`--toc-depth=`*NUMBER*
799: Specify the number of section levels to include in the table
800 of contents. The default is 3 (which means that level-1, 2, and 3
801 headings will be listed in the contents).
805: Strip out HTML comments in the Markdown or Textile source,
806 rather than passing them on to Markdown, Textile or HTML
807 output as raw HTML. This does not apply to HTML comments
808 inside raw HTML blocks when the `markdown_in_html_blocks`
809 extension is not set.
813: Disables syntax highlighting for code blocks and inlines, even when
814 a language attribute is given.
816`--highlight-style=`*STYLE*|*FILE*
818: Specifies the coloring style to be used in highlighted source code.
819 Options are `pygments` (the default), `kate`, `monochrome`,
820 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
821 For more information on syntax highlighting in pandoc, see
822 [Syntax highlighting], below. See also
823 `--list-highlight-styles`.
825 Instead of a *STYLE* name, a JSON file with extension
826 `.theme` may be supplied. This will be parsed as a KDE
827 syntax highlighting theme and (if valid) used as the
830 To generate the JSON version of an existing style,
831 use `--print-highlight-style`.
833`--print-highlight-style=`*STYLE*|*FILE*
835: Prints a JSON version of a highlighting style, which can
836 be modified, saved with a `.theme` extension, and used
837 with `--highlight-style`. This option may be used with
838 `-o`/`--output` to redirect output to a file, but
839 `-o`/`--output` must come before `--print-highlight-style`
842`--syntax-definition=`*FILE*
844: Instructs pandoc to load a KDE XML syntax definition file,
845 which will be used for syntax highlighting of appropriately
846 marked code blocks. This can be used to add support for
847 new languages or to use altered syntax definitions for
848 existing languages. This option may be repeated to add
849 multiple syntax definitions.
851`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
853: Include contents of *FILE*, verbatim, at the end of the header.
854 This can be used, for example, to include special
855 CSS or JavaScript in HTML documents. This option can be used
856 repeatedly to include multiple files in the header. They will be
857 included in the order specified. Implies `--standalone`.
859`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
861: Include contents of *FILE*, verbatim, at the beginning of the
862 document body (e.g. after the `<body>` tag in HTML, or the
863 `\begin{document}` command in LaTeX). This can be used to include
864 navigation bars or banners in HTML documents. This option can be
865 used repeatedly to include multiple files. They will be included in
866 the order specified. Implies `--standalone`.
868`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
870: Include contents of *FILE*, verbatim, at the end of the document
871 body (before the `</body>` tag in HTML, or the
872 `\end{document}` command in LaTeX). This option can be used
873 repeatedly to include multiple files. They will be included in the
874 order specified. Implies `--standalone`.
876`--resource-path=`*SEARCHPATH*
878: List of paths to search for images and other resources.
879 The paths should be separated by `:` on Linux, UNIX, and
880 macOS systems, and by `;` on Windows. If `--resource-path`
881 is not specified, the default resource path is the working
882 directory. Note that, if `--resource-path` is specified,
883 the working directory must be explicitly listed or it
884 will not be searched. For example:
885 `--resource-path=.:test` will search the working directory
886 and the `test` subdirectory, in that order.
888 `--resource-path` only has an effect if (a) the output
889 format embeds images (for example, `docx`, `pdf`, or `html`
890 with `--self-contained`) or (b) it is used together with
893`--request-header=`*NAME*`:`*VAL*
895: Set the request header *NAME* to the value *VAL* when making
896 HTTP requests (for example, when a URL is given on the
897 command line, or when resources used in a document must be
898 downloaded). If you're behind a proxy, you also need to set
899 the environment variable `http_proxy` to `http://...`.
901## Options affecting specific writers {.options}
905: Produce a standalone HTML file with no external dependencies, using
906 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
907 images, and videos. Implies `--standalone`. The resulting file should be
908 "self-contained," in the sense that it needs no external files and no net
909 access to be displayed properly by a browser. This option works only with
910 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
911 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
912 and stylesheets at absolute URLs will be downloaded; those at relative
913 URLs will be sought relative to the working directory (if the first source
914 file is local) or relative to the base URL (if the first source
915 file is remote). Elements with the attribute
916 `data-external="1"` will be left alone; the documents they
917 link to will not be incorporated in the document.
918 Limitation: resources that are loaded dynamically through
919 JavaScript cannot be incorporated; as a result,
920 `--self-contained` does not work with `--mathjax`, and some
921 advanced features (e.g. zoom or speaker notes) may not work
922 in an offline "self-contained" `reveal.js` slide show.
926: Use `<q>` tags for quotes in HTML.
930: Use only ASCII characters in output. Currently supported for XML
931 and HTML formats (which use entities instead of UTF-8 when this
932 option is selected), CommonMark, gfm, and Markdown (which use
933 entities), roff ms (which use hexadecimal escapes), and to a
934 limited degree LaTeX (which uses standard commands for accented
935 characters when possible). roff man output uses ASCII by default.
939: Use reference-style links, rather than inline links, in writing Markdown
940 or reStructuredText. By default inline links are used. The
941 placement of link references is affected by the
942 `--reference-location` option.
944`--reference-location = block`|`section`|`document`
946: Specify whether footnotes (and references, if `reference-links` is
947 set) are placed at the end of the current (top-level) block, the
948 current section, or the document. The default is
949 `document`. Currently only affects the markdown writer.
953: Use ATX-style headings in Markdown output. The default is
954 to use setext-style headings for levels 1 to 2, and then ATX headings.
955 (Note: for `gfm` output, ATX headings are always used.)
956 This option also affects markdown cells in `ipynb` output.
958`--top-level-division=[default|section|chapter|part]`
960: Treat top-level headings as the given division type in LaTeX, ConTeXt,
961 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
962 all headings are shifted such that the top-level heading becomes the specified
963 type. The default behavior is to determine the best division type via
964 heuristics: unless other conditions apply, `section` is chosen. When the
965 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
966 `article` option is specified), `chapter` is implied as the setting for this
967 option. If `beamer` is the output format, specifying either `chapter` or
968 `part` will cause top-level headings to become `\part{..}`, while
969 second-level headings remain as their default type.
971`-N`, `--number-sections`
973: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
974 By default, sections are not numbered. Sections with class
975 `unnumbered` will never be numbered, even if `--number-sections`
978`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
980: Offset for section headings in HTML output (ignored in other
981 output formats). The first number is added to the section number for
982 top-level headings, the second for second-level headings, and so on.
983 So, for example, if you want the first top-level heading in your
984 document to be numbered "6", specify `--number-offset=5`.
985 If your document starts with a level-2 heading which you want to
986 be numbered "1.5", specify `--number-offset=1,4`.
987 Offsets are 0 by default. Implies `--number-sections`.
991: Use the [`listings`] package for LaTeX code blocks. The package
992 does not support multi-byte encoding for source code. To handle UTF-8
993 you would need to use a custom template. This issue is fully
994 documented here: [Encoding issue with the listings package].
998: Make list items in slide shows display incrementally (one by one).
999 The default is for lists to be displayed all at once.
1001`--slide-level=`*NUMBER*
1003: Specifies that headings with the specified level create
1004 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1005 above this level in the hierarchy are used to divide the
1006 slide show into sections; headings below this level create
1007 subheads within a slide. Note that content that is
1008 not contained under slide-level headings will not appear in
1009 the slide show. The default is to set the slide level based
1010 on the contents of the document; see [Structuring the slide
1015: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1016 and attach identifiers to the enclosing `<section>` (or `<div>`)
1017 rather than the heading itself. See
1018 [Heading identifiers], below.
1020`--email-obfuscation=none`|`javascript`|`references`
1022: Specify a method for obfuscating `mailto:` links in HTML documents.
1023 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1024 them using JavaScript. `references` obfuscates them by printing their
1025 letters as decimal or hexadecimal character references. The default
1028`--id-prefix=`*STRING*
1030: Specify a prefix to be added to all identifiers and internal links
1031 in HTML and DocBook output, and to footnote numbers in Markdown
1032 and Haddock output. This is useful for preventing duplicate
1033 identifiers when generating fragments to be included in other pages.
1035`-T` *STRING*, `--title-prefix=`*STRING*
1037: Specify *STRING* as a prefix at the beginning of the title
1038 that appears in the HTML header (but not in the title as it
1039 appears at the beginning of the HTML body). Implies `--standalone`.
1041`-c` *URL*, `--css=`*URL*
1043: Link to a CSS style sheet. This option can be used repeatedly to
1044 include multiple files. They will be included in the order specified.
1046 A stylesheet is required for generating EPUB. If none is
1047 provided using this option (or the `css` or `stylesheet`
1048 metadata fields), pandoc will look for a file `epub.css` in the
1049 user data directory (see `--data-dir`). If it is not
1050 found there, sensible defaults will be used.
1052`--reference-doc=`*FILE*
1054: Use the specified file as a style reference in producing a
1059 : For best results, the reference docx should be a modified
1060 version of a docx file produced using pandoc. The contents
1061 of the reference docx are ignored, but its stylesheets and
1062 document properties (including margins, page size, header,
1063 and footer) are used in the new docx. If no reference docx
1064 is specified on the command line, pandoc will look for a
1065 file `reference.docx` in the user data directory (see
1066 `--data-dir`). If this is not found either, sensible
1067 defaults will be used.
1069 To produce a custom `reference.docx`, first get a copy of
1070 the default `reference.docx`: `pandoc
1071 -o custom-reference.docx --print-default-data-file reference.docx`.
1072 Then open `custom-reference.docx` in Word, modify the
1073 styles as you wish, and save the file. For best
1074 results, do not make changes to this file other than
1075 modifying the styles used by pandoc:
1111 - Default Paragraph Font
1114 - Footnote Reference
1123 : For best results, the reference ODT should be a modified
1124 version of an ODT produced using pandoc. The contents of
1125 the reference ODT are ignored, but its stylesheets are used
1126 in the new ODT. If no reference ODT is specified on the
1127 command line, pandoc will look for a file `reference.odt` in
1128 the user data directory (see `--data-dir`). If this is not
1129 found either, sensible defaults will be used.
1131 To produce a custom `reference.odt`, first get a copy of
1132 the default `reference.odt`: `pandoc
1133 -o custom-reference.odt --print-default-data-file reference.odt`.
1134 Then open `custom-reference.odt` in LibreOffice, modify
1135 the styles as you wish, and save the file.
1139 : Templates included with Microsoft PowerPoint 2013 (either with
1140 `.pptx` or `.potx` extension) are known to work, as are most
1141 templates derived from these.
1143 The specific requirement is that the template should begin with
1144 the following first four layouts:
1147 2. Title and Content
1151 All templates included with a recent version of MS PowerPoint
1152 will fit these criteria. (You can click on `Layout` under the
1153 `Home` menu to check.)
1155 You can also modify the default `reference.pptx`: first run
1156 `pandoc -o custom-reference.pptx --print-default-data-file
1157 reference.pptx`, and then modify `custom-reference.pptx`
1158 in MS PowerPoint (pandoc will use the first four layout
1159 slides, as mentioned above).
1161`--epub-cover-image=`*FILE*
1163: Use the specified image as the EPUB cover. It is recommended
1164 that the image be less than 1000px in width and height. Note that
1165 in a Markdown source document you can also specify `cover-image`
1166 in a YAML metadata block (see [EPUB Metadata], below).
1168`--epub-metadata=`*FILE*
1170: Look in the specified XML file for metadata for the EPUB.
1171 The file should contain a series of [Dublin Core elements].
1174 <dc:rights>Creative Commons</dc:rights>
1175 <dc:language>es-AR</dc:language>
1177 By default, pandoc will include the following metadata elements:
1178 `<dc:title>` (from the document title), `<dc:creator>` (from the
1179 document authors), `<dc:date>` (from the document date, which should
1180 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1181 variable, or, if is not set, the locale), and `<dc:identifier
1182 id="BookId">` (a randomly generated UUID). Any of these may be
1183 overridden by elements in the metadata file.
1185 Note: if the source document is Markdown, a YAML metadata block
1186 in the document can be used instead. See below under
1189`--epub-embed-font=`*FILE*
1191: Embed the specified font in the EPUB. This option can be repeated
1192 to embed multiple fonts. Wildcards can also be used: for example,
1193 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1194 line, be sure to escape them or put the whole filename in single quotes,
1195 to prevent them from being interpreted by the shell. To use the
1196 embedded fonts, you will need to add declarations like the following
1197 to your CSS (see `--css`):
1200 font-family: DejaVuSans;
1202 font-weight: normal;
1203 src:url("DejaVuSans-Regular.ttf");
1206 font-family: DejaVuSans;
1209 src:url("DejaVuSans-Bold.ttf");
1212 font-family: DejaVuSans;
1214 font-weight: normal;
1215 src:url("DejaVuSans-Oblique.ttf");
1218 font-family: DejaVuSans;
1221 src:url("DejaVuSans-BoldOblique.ttf");
1223 body { font-family: "DejaVuSans"; }
1225`--epub-chapter-level=`*NUMBER*
1227: Specify the heading level at which to split the EPUB into separate
1228 "chapter" files. The default is to split into chapters at level-1
1229 headings. This option only affects the internal composition of the
1230 EPUB, not the way chapters and sections are displayed to users. Some
1231 readers may be slow if the chapter files are too large, so for large
1232 documents with few level-1 headings, one might want to use a chapter
1235`--epub-subdirectory=`*DIRNAME*
1237: Specify the subdirectory in the OCF container that is to hold
1238 the EPUB-specific contents. The default is `EPUB`. To put
1239 the EPUB contents in the top level, use an empty string.
1241`--ipynb-output=all|none|best`
1243: Determines how ipynb output cells are treated. `all` means
1244 that all of the data formats included in the original are
1245 preserved. `none` means that the contents of data cells
1246 are omitted. `best` causes pandoc to try to pick the
1247 richest data block in each output cell that is compatible
1248 with the output format. The default is `best`.
1250`--pdf-engine=`*PROGRAM*
1252: Use the specified engine when producing PDF output.
1253 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1254 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1255 and `pdfroff`. If the engine is not in your PATH, the full
1256 path of the engine may be specified here. If this option
1257 is not specified, pandoc uses the following defaults
1258 depending on the output format specified using `-t/--to`:
1260 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1261 `tectonic`, `latexmk`)
1262 - `-t context`: `context`
1263 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`)
1264 - `-t ms`: `pdfroff`
1266`--pdf-engine-opt=`*STRING*
1268: Use the given string as a command-line argument to the `pdf-engine`.
1269 For example, to use a persistent directory `foo` for `latexmk`'s
1270 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1271 Note that no check for duplicate options is done.
1273[Dublin Core elements]: http://dublincore.org/documents/dces/
1274[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1275[Encoding issue with the listings package]:
1276 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1278## Citation rendering {.options}
1280`--bibliography=`*FILE*
1282: Set the `bibliography` field in the document's metadata to *FILE*,
1283 overriding any value set in the metadata, and process citations
1284 using `pandoc-citeproc`. (This is equivalent to
1285 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1286 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1287 used, making this equivalent to `--metadata bibliography=FILE`.
1288 If you supply this argument multiple times, each *FILE* will be added
1293: Set the `csl` field in the document's metadata to *FILE*,
1294 overriding any value set in the metadata. (This is equivalent to
1295 `--metadata csl=FILE`.)
1296 This option is only relevant with `pandoc-citeproc`.
1298`--citation-abbreviations=`*FILE*
1300: Set the `citation-abbreviations` field in the document's metadata to
1301 *FILE*, overriding any value set in the metadata. (This is equivalent to
1302 `--metadata citation-abbreviations=FILE`.)
1303 This option is only relevant with `pandoc-citeproc`.
1307: Use [`natbib`] for citations in LaTeX output. This option is not for use
1308 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1309 use in producing a LaTeX file that can be processed with [`bibtex`].
1313: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1314 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1315 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1317## Math rendering in HTML {.options}
1319The default is to render TeX math as far as possible using Unicode characters.
1320Formulas are put inside a `span` with `class="math"`, so that they may be styled
1321differently from the surrounding text if needed. However, this gives acceptable
1322results only for basic math, usually you will want to use `--mathjax` or another
1323of the following options.
1325`--mathjax`[`=`*URL*]
1327: Use [MathJax] to display embedded TeX math in HTML output.
1328 TeX math will be put between `\(...\)` (for inline math)
1329 or `\[...\]` (for display math) and wrapped in `<span>` tags
1330 with class `math`. Then the MathJax JavaScript will render it.
1331 The *URL* should point to the `MathJax.js` load script.
1332 If a *URL* is not provided, a link to the Cloudflare CDN will
1337: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1338 `html4` and `html5`). This is the default in `odt` output. Note that
1339 currently only Firefox and Safari (and select e-book readers) natively
1344: Convert TeX formulas to `<img>` tags that link to an external script
1345 that converts formulas to images. The formula will be URL-encoded
1346 and concatenated with the URL provided. For SVG images you can for
1347 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1348 If no URL is specified, the CodeCogs URL generating PNGs
1349 will be used (`https://latex.codecogs.com/png.latex?`).
1350 Note: the `--webtex` option will affect Markdown output
1351 as well as HTML, which is useful if you're targeting a
1352 version of Markdown without native math support.
1356: Use [KaTeX] to display embedded TeX math in HTML output.
1357 The *URL* is the base URL for the KaTeX library. That directory
1358 should contain a `katex.min.js` and a `katex.min.css` file.
1359 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1363: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1364 can then be processed by [GladTeX] to produce images of the typeset
1365 formulas and an HTML file with links to these images.
1366 So, the procedure is:
1368 pandoc -s --gladtex input.md -o myfile.htex
1369 gladtex -d myfile-images myfile.htex
1370 # produces myfile.html and images in myfile-images
1372[MathML]: http://www.w3.org/Math/
1373[MathJax]: https://www.mathjax.org
1374[KaTeX]: https://github.com/Khan/KaTeX
1375[GladTeX]: http://humenda.github.io/GladTeX/
1377## Options for wrapper scripts {.options}
1381: Print information about command-line arguments to *stdout*, then exit.
1382 This option is intended primarily for use in wrapper scripts.
1383 The first line of output contains the name of the output file specified
1384 with the `-o` option, or `-` (for *stdout*) if no output file was
1385 specified. The remaining lines contain the command-line arguments,
1386 one per line, in the order they appear. These do not include regular
1387 pandoc options and their arguments, but do include any options appearing
1388 after a `--` separator at the end of the line.
1392: Ignore command-line arguments (for use in wrapper scripts).
1393 Regular pandoc options are not ignored. Thus, for example,
1395 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1399 pandoc -o foo.html -s
1403If pandoc completes successfully, it will return exit code 0.
1404Nonzero exit codes have the following meanings:
1407----- ------------------------------------
1408 3 PandocFailOnWarningError
1410 5 PandocTemplateError
1412 21 PandocUnknownReaderError
1413 22 PandocUnknownWriterError
1414 23 PandocUnsupportedExtensionError
1415 31 PandocEpubSubdirectoryError
1417 47 PandocPDFProgramNotFoundError
1419 62 PandocShouldNeverHappenError
1422 65 PandocParsecError
1423 66 PandocMakePDFError
1424 67 PandocSyntaxMapError
1425 83 PandocFilterError
1427 92 PandocUTF8DecodingError
1428 93 PandocIpynbDecodingError
1429 97 PandocCouldNotFindDataFileError
1430 99 PandocResourceNotFound
1431----- ------------------------------------
1435The `--defaults` option may be used to specify a package
1436of options. Here is a sample defaults file demonstrating all of
1437the fields that may be used:
1441# reader: may be used instead of from:
1443# writer: may be used instead of to:
1445# leave blank for output to stdout:
1447# leave blank for input from stdin, use [] for no input:
1451# or you may use input-file: with a single value
1455self-contained: false
1457# note that structured variables may be specified:
1464# metadata values specified here are parsed as literal
1465# string text, not markdown:
1472# or you may use metadata-file: with a single value
1474# Note that these take files, not their contents:
1475include-before-body: []
1476include-after-body: []
1477include-in-header: []
1480# filters will be assumed to be lua filters if they have
1481# the .lua extension, and json filters otherwise. But
1482# the filter type can also be specified explicitly, as shown:
1493# ERROR, WARNING, or INFO
1497# citeproc, natbib, or biblatex
1498cite-method: citeproc
1499# part, chapter, section, or default:
1500top-level-division: chapter
1506# you may also use pdf-engine-opt: with a single option
1507# pdf-engine-opt: "-shell-escape"
1509# auto, preserve, or none
1514extract-media: mediadir
1516table-of-contents: true
1518number-sections: false
1519# a list of offsets at each heading level
1520number-offset: [0,0,0,0,0,0]
1521# toc: may also be used instead of table-of-contents:
1522shift-heading-level-by: 1
1524identifier-prefix: foo
1526strip-empty-paragraphs: true
1527# lf, crlf, or native
1529strip-comments: false
1530indented-code-classes: []
1532default-image-extension: ".jpg"
1534# either a style name of a style definition file:
1535highlight-style: pygments
1538# or you may use syntax-definition: with a single value
1541reference-doc: myref.docx
1543# method is plain, webtex, gladtex, mathml, mathjax, katex
1544# you may specify a url with webtex, mathjax, katex
1547 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1548# none, references, or javascript
1549email-obfuscation: javascript
1557epub-subdirectory: EPUB
1558epub-metadata: meta.xml
1561epub-chapter-level: 1
1562epub-cover-image: cover.jpg
1564reference-links: true
1565# block, section, or document
1566reference-location: block
1569# accept, reject, or all
1570track-changes: accept
1579# A list of two-element lists
1581- ["User-Agent", "Mozilla/5.0"]
1583fail-if-warnings: false
1589Fields that are omitted will just have their regular
1590default values. So a defaults file can be as simple as
1597Default files can be placed in the `defaults` subdirectory of
1598the user data directory and used from any directory. For
1599example, one could create a file specifying defaults for writing
1600letters, save it as `letter.yaml` in the `defaults` subdirectory
1601of the user data directory, and then invoke these defaults
1602from any directory using `pandoc --defaults letter`
1603or `pandoc -dletter`.
1605When multiple defaults are used, their contents will be combined.
1607Note that, where command-line arguments may be repeated
1608(`--metadata-file`, `--css`, `--include-in-header`,
1609`--include-before-body`, `--include-after-body`, `--variable`,
1610`--metadata`, `--syntax-definition`), the values specified on
1611the command line will combine with values specified in the
1612defaults file, rather than replacing them.
1616When the `-s/--standalone` option is used, pandoc uses a template to
1617add header and footer material that is needed for a self-standing
1618document. To see the default template that is used, just type
1622where *FORMAT* is the name of the output format. A custom template
1623can be specified using the `--template` option. You can also override
1624the system default templates for a given output format *FORMAT*
1625by putting a file `templates/default.*FORMAT*` in the user data
1626directory (see `--data-dir`, above). *Exceptions:*
1628- For `odt` output, customize the `default.opendocument`
1630- For `pdf` output, customize the `default.latex` template
1631 (or the `default.context` template, if you use `-t context`,
1632 or the `default.ms` template, if you use `-t ms`, or the
1633 `default.html` template, if you use `-t html`).
1634- `docx` and `pptx` have no template (however, you can use
1635 `--reference-doc` to customize the output).
1637Templates contain *variables*, which allow for the inclusion of
1638arbitrary information at any point in the file. They may be set at the
1639command line using the `-V/--variable` option. If a variable is not set,
1640pandoc will look for the key in the document's metadata, which can be set
1641using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1642or with the `-M/--metadata` option. In addition, some variables
1643are given default values by pandoc. See [Variables] below for
1644a list of variables used in pandoc's default templates.
1646If you use custom templates, you may need to revise them as pandoc
1647changes. We recommend tracking the changes in the default templates,
1648and modifying your custom templates accordingly. An easy way to do this
1649is to fork the [pandoc-templates] repository and merge in
1650changes after each pandoc release.
1652 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1658Anything between the sequence `$--` and the end of the
1659line will be treated as a comment and omitted from the output.
1663To mark variables and control structures in the template,
1664either `$`...`$` or `${`...`}` may be used as delimiters.
1665The styles may also be mixed in the same template, but the
1666opening and closing delimiter must match in each case. The
1667opening delimiter may be followed by one or more spaces
1668or tabs, which will be ignored. The closing delimiter may
1669be followed by one or more spaces or tabs, which will be
1672To include a literal `$` in the document, use `$$`.
1674### Interpolated variables
1676A slot for an interpolated variable is a variable name surrounded
1677by matched delimiters. Variable names must begin with a letter
1678and can contain letters, numbers, `_`, `-`, and `.`. The
1679keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1680not be used as variable names. Examples:
1693Variable names with periods are used to get at structured
1694variable values. So, for example, `employee.salary` will return the
1695value of the `salary` field of the object that is the value of
1696the `employee` field.
1698- If the value of the variable is simple value, it will be
1699 rendered verbatim. (Note that no escaping is done;
1700 the assumption is that the calling program will escape
1701 the strings appropriately for the output format.)
1702- If the value is a list, the values will be concatenated.
1703- If the value is a map, the string `true` will be rendered.
1704- Every other value will be rendered as the empty string.
1708A conditional begins with `if(variable)` (enclosed in
1709matched delimiters) and ends with `endif` (enclosed in matched
1710delimiters). It may optionally contain an `else` (enclosed in
1711matched delimiters). The `if` section is used if
1712`variable` has a non-empty value, otherwise the `else`
1713section is used (if present). Examples:
1728${if(foo)}bar${endif}
1741The keyword `elseif` may be used to simplify complex nested
1756A for loop begins with `for(variable)` (enclosed in
1757matched delimiters) and ends with `endfor` (enclosed in matched
1760- If `variable` is an array, the material inside the loop will
1761 be evaluated repeatedly, with `variable` being set to each
1762 value of the array in turn, and concatenated.
1763- If `variable` is a map, the material inside will be set to
1765- If the value of the associated variable is not an array or
1766 a map, a single iteration will be performed on its value.
1771$for(foo)$$foo$$sep$, $endfor$
1774 - $foo.last$, $foo.first$
1778 - ${ foo.bar.last }, ${ foo.bar.first }
1782$it.name$: $it.office$
1786You may optionally specify a separator between consecutive
1787values using `sep` (enclosed in matched delimiters). The
1788material between `sep` and the `endfor` is the separator.
1791${ for(foo) }${ foo }${ sep }, ${ endfor }
1794Instead of using `variable` inside the loop, the special
1795anaphoric keyword `it` may be used.
1799 - ${ it.last }, ${ it.first }
1805Partials (subtemplates stored in different files) may be
1806included using the syntax
1812Partials will be sought in the directory containing
1813the main template, and will be assumed to have the
1814same extension as the main template if they lack
1815an explicit extension. (If the partials are not
1816found here, they will also be sought in the `templates`
1817subdirectory of the user data directory.)
1819Partials may optionally be applied to variables using
1825${ articles:bibentry() }
1828If `articles` is an array, this will iterate over its
1829values, applying the partial `bibentry()` to each one. So the
1830second example above is equivalent to
1838Note that the anaphoric keyword `it` must be used when
1839iterating over partials. In the above examples,
1840the `bibentry` partial should contain `it.title`
1841(and so on) instead of `articles.title`.
1843Final newlines are omitted from included partials.
1845Partials may include other partials.
1847A separator between values of an array may be specified
1848in square brackets, immediately after the variable name
1854${articles:bibentry()[; ]$
1857The separator in this case is literal and (unlike with `sep`
1858in an explicit `for` loop) cannot contain interpolated
1859variables or other template directives.
1863To ensure that content is "nested," that is, subsequent lines
1864indented, use the `^` directive:
1867$item.number$ $^$$item.description$ ($item.price$)
1870In this example, if `item.description` has multiple lines,
1871they will all be indented to line up with the first line:
187400123 A fine bottle of 18-year old
1875 Oban whiskey. ($148)
1878To nest multiple lines to the same level, align them
1879with the `^` directive in the template. For example:
1882$item.number$ $^$$item.description$ ($item.price$)
1883 (Available til $item.sellby$.)
188900123 A fine bottle of 18-year old
1890 Oban whiskey. ($148)
1891 (Available til March 30, 2020.)
1894If a variable occurs by itself on a line, preceded by whitespace
1895and not followed by further text or directives on the same line,
1896and the variable's value contains multiple lines, it will be
1897nested automatically.
1901Normally, spaces in the template itself (as opposed to values of
1902the interpolated variables) are not breakable, but they can be
1903made breakable in part of the template by using the `~` keyword
1904(ended with another `~`).
1907$~$This long line may break if the document is rendered
1908with a short line length.$~$
1913A pipe transforms the value of a variable or partial. Pipes are
1914specified using a slash (`/`) between the variable name (or partial)
1915and the pipe name. Example:
1922$for(metadata/pairs)$
1923- $it.key$: $it.value$
1926$employee:name()/uppercase$
1929Pipes may be chained:
1932$for(employees/pairs)$
1933$it.key/alpha/uppercase$. $it.name$
1937Some pipes take parameters:
1940|----------------------|------------|
1942$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1944|----------------------|------------|
1947Currently the following pipes are predefined:
1949- `pairs`: Converts a map or array to an array of maps,
1950 each with `key` and `value` fields. If the original
1951 value was an array, the `key` will be the array index,
1954- `uppercase`: Converts text to uppercase.
1956- `lowercase`: Converts text to lowercase.
1958- `length`: Returns the length of the value: number
1959 of characters for a textual value, number of elements
1962- `reverse`: Reverses a textual value or array,
1963 and has no effect on other values.
1965- `chomp`: Removes trailing newlines (and breakable space).
1967- `nowrap`: Disables line wrapping on breakable spaces.
1969- `alpha`: Converts textual values that can be
1970 read as an integer into lowercase alphabetic
1971 characters `a..z` (mod 26). This can be used to get lettered
1972 enumeration from array indices. To get uppercase
1973 letters, chain with `uppercase`.
1975- `roman`: Converts textual values that can be
1976 read as an integer into lowercase roman numerials.
1977 This can be used to get lettered enumeration from array indices.
1978 To get uppercase roman, chain with `uppercase`.
1980- `left n "leftborder" "rightborder"`: Renders a textual value
1981 in a block of width `n`, aligned to the left, with an optional
1982 left and right border. Has no effect on other values. This
1983 can be used to align material in tables. Widths are positive
1984 integers indicating the number of characters. Borders
1985 are strings inside double quotes; literal `"` and `\` characters
1986 must be backslash-escaped.
1988- `right n "leftborder" "rightborder"`: Renders a textual value
1989 in a block of width `n`, aligned to the right, and has no
1990 effect on other values.
1992- `center n "leftborder" "rightborder"`: Renders a textual
1993 value in a block of width `n`, aligned to the center, and has
1994 no effect on other values.
1999### Metadata variables
2001`title`, `author`, `date`
2002: allow identification of basic aspects of the document. Included
2003 in PDF metadata through LaTeX and ConTeXt. These can be set
2004 through a [pandoc title block][Extension: `pandoc_title_block`],
2005 which allows for multiple authors, or through a
2006 [YAML metadata block][Extension: `yaml_metadata_block`]:
2014 Note that if you just want to set PDF or HTML metadata, without
2015 including a title block in the document itself, you can
2016 set the `title-meta`, `author-meta`, and `date-meta`
2017 variables. (By default these are set automatically, based
2018 on `title`, `author`, and `date`.)
2021: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2025: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2029: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2030 and AsciiDoc metadata; repeat as for `author`, above
2033: document subject, included in ODT, PDF, docx and pptx metadata
2036: document description, included in ODT, docx and pptx metadata. Some
2037 applications show this as `Comments` metadata.
2040: document category, included in docx and pptx metadata
2043any root-level string metadata, not included in ODT, docx
2044or pptx metadata is added as a *custom property*.
2045The following [YAML] metadata block for instance:
2048 title: 'This is the title'
2049 subtitle: "This is the subtitle"
2057 It consists of two paragraphs
2060will include `title`, `author` and `description` as standard document
2061properties and `subtitle` as a custom property when converting to docx,
2064### Language variables
2067: identifies the main language of the document using IETF language
2068 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2069 The [Language subtag lookup] tool can look up or verify these tags.
2070 This affects most formats, and controls hyphenation in PDF output
2071 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2073 Use native pandoc [Divs and Spans] with the `lang` attribute to
2074 switch the language:
2080 Text in the main document language (British English).
2083 > Cette citation est écrite en français canadien.
2086 More text in English. ['Zitat auf Deutsch.']{lang=de}
2089: the base script direction, either `rtl` (right-to-left)
2090 or `ltr` (left-to-right).
2092 For bidirectional documents, native pandoc `span`s and `div`s
2093 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2094 override the base direction in some output formats.
2095 This may not always be necessary if the final renderer
2096 (e.g. the browser, when generating HTML) supports the
2097 [Unicode Bidirectional Algorithm].
2099 When using LaTeX for bidirectional documents, only the `xelatex` engine
2100 is fully supported (use `--pdf-engine=xelatex`).
2102[BCP 47]: https://tools.ietf.org/html/bcp47
2103[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2104[Language subtag lookup]: https://r12a.github.io/app-subtags/
2106### Variables for HTML math
2109: when using [KaTeX](#option--katex), you can render display math equations
2110 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2112### Variables for HTML slides
2114These affect HTML output when [producing slide shows with pandoc].
2116All [reveal.js configuration options] are available as variables.
2117To turn off boolean flags that default to true in reveal.js, use `0`.
2120: base URL for reveal.js documents (defaults to `reveal.js`)
2123: base URL for S5 documents (defaults to `s5/default`)
2126: base URL for Slidy documents (defaults to
2127 `https://www.w3.org/Talks/Tools/Slidy2`)
2130: base URL for Slideous documents (defaults to `slideous`)
2132`title-slide-attributes`
2133: additional attributes for the title slide of reveal.js slide shows.
2134 See [background in reveal.js and beamer] for an example.
2136[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2138### Variables for Beamer slides
2140These variables change the appearance of PDF slides using [`beamer`].
2143: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2144 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2148: produce an article from Beamer slides
2151: add extra beamer option with `\setbeameroption{}`
2154: author affiliations: can be a list when there are multiple authors
2157: logo image for slides
2160: controls navigation symbols (default is `empty` for no navigation
2161 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2164: enables "title pages" for new sections (default is true)
2166`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2170: options for LaTeX beamer themes (a list).
2173: image for title slide
2175### Variables for PowerPoint
2177These variables control the visual aspects of a slide show that
2178are not easily controlled via templates.
2181: font to use for code.
2183### Variables for LaTeX
2185Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2190: make `\paragraph` and `\subparagraph` (fourth- and
2191 fifth-level headings, or fifth- and sixth-level with book
2192 classes) free-standing rather than run-in; requires further
2193 formatting to distinguish from `\subsubsection` (third- or
2194 fourth-level headings). Instead of using this option,
2195 [KOMA-Script] can adjust headings more extensively:
2198 documentclass: scrartcl
2200 \RedeclareSectionCommand[
2201 beforeskip=-10pt plus -2pt minus -1pt,
2202 afterskip=1sp plus -1sp minus 1sp,
2203 font=\normalfont\itshape]{paragraph}
2204 \RedeclareSectionCommand[
2205 beforeskip=-10pt plus -2pt minus -1pt,
2206 afterskip=1sp plus -1sp minus 1sp,
2207 font=\normalfont\scshape,
2208 indent=0pt]{subparagraph}
2212: option for document class, e.g. `oneside`; repeat for multiple options:
2221: document class: usually one of the standard classes, [`article`], [`book`],
2222 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2223 and `scrreprt`, which default to smaller margins; or [`memoir`]
2226: option for [`geometry`] package, e.g. `margin=1in`;
2227 repeat for multiple options:
2237: option for [`hyperref`] package, e.g. `linktoc=all`;
2238 repeat for multiple options:
2244 - pdfpagemode=FullScreen
2248: uses document class settings for indentation (the default LaTeX template
2249 otherwise removes indentation and adds space between paragraphs)
2252: adjusts line spacing using the [`setspace`]
2253 package, e.g. `1.25`, `1.5`
2255`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2256: sets margins if `geometry` is not used (otherwise `geometry`
2260: control `\pagestyle{}`: the default article class
2261 supports `plain` (default), `empty` (no running heads or page numbers),
2262 and `headings` (section titles in running heads)
2265: paper size, e.g. `letter`, `a4`
2268: numbering depth for sections (with `--number-sections` option
2269 or `numbersections` variable)
2274: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2275 default is `T1` (see [LaTeX font encodings guide])
2278: font package for use with `pdflatex`:
2279 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2280 The default is [Latin Modern][`lm`].
2283: options for package used as `fontfamily`; repeat for multiple options.
2284 For example, to use the Libertine font with proportional lowercase
2285 (old-style) figures through the [`libertinus`] package:
2288 fontfamily: libertinus
2295: font size for body text. The standard classes allow 10pt, 11pt, and
2296 12pt. To use another size, set `documentclass` to one of
2297 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2299`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2300: font families for use with `xelatex` or
2301 `lualatex`: take the name of any system font, using the
2302 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2304`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2305: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2306 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2307 choices available through [`fontspec`]; repeat for multiple
2308 options. For example, to use the [TeX Gyre] version of
2309 Palatino with lowercase figures:
2312 mainfont: TeX Gyre Pagella
2315 - Numbers=Proportional
2319: options to pass to the microtype package
2324: add color to link text; automatically enabled if any of
2325 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2327`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2328: color for internal links, external links, citation links, linked
2329 URLs, and links in table of contents, respectively: uses options
2330 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2334: causes links to be printed as footnotes
2339: include list of figures, list of tables
2342: contents of acknowledgments footnote after document title
2345: include table of contents (can also be set using `--toc/--table-of-contents`)
2348: level of section to include in table of contents
2350#### BibLaTeX Bibliographies
2352These variables function when using BibLaTeX for [citation rendering].
2355: list of options for biblatex
2358: bibliography style, when used with `--natbib` and `--biblatex`.
2361: bibliography title, when used with `--natbib` and `--biblatex`.
2364: bibliography to use for resolving references
2367: list of options for natbib
2369[KOMA-Script]: https://ctan.org/pkg/koma-script
2370[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2371[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2372[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2373[`article`]: https://ctan.org/pkg/article
2374[`book`]: https://ctan.org/pkg/book
2375[`libertinus`]: https://ctan.org/pkg/libertinus
2376[`memoir`]: https://ctan.org/pkg/memoir
2377[`report`]: https://ctan.org/pkg/report
2379### Variables for ConTeXt
2381Pandoc uses these variables when [creating a PDF] with ConTeXt.
2384: font size for body text (e.g. `10pt`, `12pt`)
2386`headertext`, `footertext`
2387: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2388 repeat up to four times for different placement
2391: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2392 repeat for multiple options
2395: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2396 repeat for multiple options
2399: options for page margins and text arrangement (see [ConTeXt Layout]);
2400 repeat for multiple options
2402`linkcolor`, `contrastcolor`
2403: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2406: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2409: include list of figures, list of tables
2411`mainfont`, `sansfont`, `monofont`, `mathfont`
2412: font families: take the name of any system font (see [ConTeXt Font Switching])
2414`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2415: sets margins, if `layout` is not used (otherwise `layout`
2419: page number style and location (using [`setuppagenumbering`]);
2420 repeat for multiple options
2423: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2424 repeat for multiple options
2427: adds to the preamble the setup necessary to generate PDF/A of the type
2428 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2429 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2430 block), `1b:2005` will be used as default, for reasons of backwards
2431 compatibility. Using `--variable=pdfa` without specified value is not supported.
2432 To successfully generate PDF/A the required ICC color profiles have to
2433 be available and the content and all included files (such as images)
2434 have to be standard conforming. The ICC profiles and output intent
2435 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2436 See also [ConTeXt PDFA] for more details.
2439: when used in conjunction with `pdfa`, specifies the ICC profile to use
2440 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2441 used as default. May be repeated to include multiple profiles. Note that
2442 the profiles have to be available on the system. They can be obtained
2443 from [ConTeXt ICC Profiles].
2446: when used in conjunction with `pdfa`, specifies the output intent for
2447 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2448 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2451: include table of contents (can also be set using `--toc/--table-of-contents`)
2454: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2457: include all source documents as file attachments in the PDF file
2459[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2460[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2461[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2462[ConTeXt Color]: https://wiki.contextgarden.net/Color
2463[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2464[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2465[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2466[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2467[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2468[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2469[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2471### Variables for `wkhtmltopdf`
2473Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2474The `--css` option also affects the output.
2476`footer-html`, `header-html`
2477: add information to the header and footer
2479`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2480: set the page margins
2483: sets the PDF paper size
2485### Variables for man pages
2488: adjusts text to left (`l`), right (`r`), center (`c`),
2489 or both (`b`) margins
2492: footer in man pages
2495: header in man pages
2498: if `true` (the default), hyphenation will be used
2501: section number in man pages
2506: font family (e.g. `T` or `P`)
2509: paragraph indent (e.g. `2m`)
2512: line height (e.g. `12p`)
2515: point size (e.g. `10p`)
2517### Variables set automatically
2519Pandoc sets these variables automatically in response to [options] or
2520document contents; users can also modify them. These vary depending
2521on the output format, and include the following:
2527: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2528 included in all HTML based formats (dzslides, epub,
2529 html, html4, html5, revealjs, s5, slideous, slidy).
2530 The recognized formats for `date` are: `mm/dd/yyyy`,
2531 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2532 (e.g. either `02 Apr 2018` or `02 April 2018`),
2533 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2534 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2537: contents specified by `-H/--include-in-header` (may have multiple
2541: contents specified by `-B/--include-before-body` (may have
2545: contents specified by `-A/--include-after-body` (may have
2549: JSON representation of all of the document's metadata. Field
2550 values are transformed to the selected output format.
2553: non-null value if `-N/--number-sections` was specified
2555`sourcefile`, `outputfile`
2556: source and destination filenames, as given on the command line.
2557 `sourcefile` can also be a list if input comes from multiple files,
2558 or empty if input is from stdin. You can use the following snippet in
2559 your template to distinguish them:
2569 Similarly, `outputfile` can be `-` if output goes to the terminal.
2571 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2574: working directory from which pandoc is run.
2577: non-null value if `--toc/--table-of-contents` was specified
2580: title of table of contents (works only with EPUB,
2581 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2583[pandoc-templates]: https://github.com/jgm/pandoc-templates
2587The behavior of some of the readers and writers can be adjusted by
2588enabling or disabling various extensions.
2590An extension can be enabled by adding `+EXTENSION`
2591to the format name and disabled by adding `-EXTENSION`. For example,
2592`--from markdown_strict+footnotes` is strict Markdown with footnotes
2593enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2594Markdown without footnotes or pipe tables.
2596The markdown reader and writer make by far the most use of extensions.
2597Extensions only used by them are therefore covered in the
2598section [Pandoc's Markdown] below (See [Markdown variants] for
2599`commonmark` and `gfm`.) In the following, extensions that also work
2600for other formats are covered.
2602Note that markdown extensions added to the `ipynb` format
2603affect Markdown cells in Jupyter notebooks (as do command-line
2604options like `--atx-headers`).
2608#### Extension: `smart` ####
2610Interpret straight quotes as curly quotes, `---` as em-dashes,
2611`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2612inserted after certain abbreviations, such as "Mr."
2614This extension can be enabled/disabled for the following formats:
2617: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2620: `markdown`, `latex`, `context`, `rst`
2622enabled by default in
2623: `markdown`, `latex`, `context` (both input and output)
2625Note: If you are *writing* Markdown, then the `smart` extension
2626has the reverse effect: what would have been curly quotes comes
2629In LaTeX, `smart` means to use the standard TeX ligatures
2630for quotation marks (` `` ` and ` '' ` for double quotes,
2631`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2632en-dash and `---` for em-dash). If `smart` is disabled,
2633then in reading LaTeX pandoc will parse these characters
2634literally. In writing LaTeX, enabling `smart` tells pandoc
2635to use the ligatures when possible; if `smart` is disabled
2636pandoc will use unicode quotation mark and dash characters.
2638## Headings and sections
2640#### Extension: `auto_identifiers` ####
2642A heading without an explicitly specified identifier will be
2643automatically assigned a unique identifier based on the heading text.
2645This extension can be enabled/disabled for the following formats:
2648: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2653enabled by default in
2656The default algorithm used to derive the identifier from the
2659 - Remove all formatting, links, etc.
2660 - Remove all footnotes.
2661 - Remove all non-alphanumeric characters,
2662 except underscores, hyphens, and periods.
2663 - Replace all spaces and newlines with hyphens.
2664 - Convert all alphabetic characters to lowercase.
2665 - Remove everything up to the first letter (identifiers may
2666 not begin with a number or punctuation mark).
2667 - If nothing is left after this, use the identifier `section`.
2672 ------------------------------- ----------------------------
2673 `Heading identifiers in HTML` `heading-identifiers-in-html`
2674 `Maître d'hôtel` `maître-dhôtel`
2675 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2676 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2677 `3. Applications` `applications`
2680These rules should, in most cases, allow one to determine the identifier
2681from the heading text. The exception is when several headings have the
2682same text; in this case, the first will get an identifier as described
2683above; the second will get the same identifier with `-1` appended; the
2684third with `-2`; and so on.
2686(However, a different algorithm is used if
2687`gfm_auto_identifiers` is enabled; see below.)
2689These identifiers are used to provide link targets in the table of
2690contents generated by the `--toc|--table-of-contents` option. They
2691also make it easy to provide links from one section of a document to
2692another. A link to this section, for example, might look like this:
2695 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2697Note, however, that this method of providing links to sections works
2698only in HTML, LaTeX, and ConTeXt formats.
2700If the `--section-divs` option is specified, then each section will
2701be wrapped in a `section` (or a `div`, if `html4` was specified),
2702and the identifier will be attached to the enclosing `<section>`
2703(or `<div>`) tag rather than the heading itself. This allows entire
2704sections to be manipulated using JavaScript or treated differently in
2707#### Extension: `ascii_identifiers` ####
2709Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2710Accents are stripped off of accented Latin letters, and non-Latin
2713#### Extension: `gfm_auto_identifiers` ####
2715Changes the algorithm used by `auto_identifiers` to conform to
2716GitHub's method. Spaces are converted to dashes (`-`),
2717uppercase characters to lowercase characters, and punctuation
2718characters other than `-` and `_` are removed.
2719Emojis are replaced by their names.
2723The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2724[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2725[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2726are described in the section about Pandoc's Markdown.
2728However, they can also be used with HTML input. This is handy for
2729reading web pages formatted using MathJax, for example.
2733The following extensions (especially how they affect Markdown
2734input/output) are also described in more detail in their respective
2735sections of [Pandoc's Markdown].
2737#### Extension: `raw_html` {#raw_html}
2739When converting from HTML, parse elements to raw HTML which are not
2740representable in pandoc's AST.
2741By default, this is disabled for HTML input.
2743#### Extension: `raw_tex` {#raw_tex}
2745Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2747This extension can be enabled/disabled for the following formats
2748(in addition to `markdown`):
2751: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2752 `\eqref` only), `ipynb`
2755: `textile`, `commonmark`
2757Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2758only raw TeX in markdown cells, but data with mime type
2759`text/html` in output cells. Since the `ipynb` reader attempts
2760to preserve the richest possible outputs when several options
2761are given, you will get best results if you disable `raw_html`
2762and `raw_tex` when converting to formats like `docx` which don't
2763allow raw `html` or `tex`.
2765#### Extension: `native_divs` {#native_divs}
2767This extension is enabled by default for HTML input. This means that
2768`div`s are parsed to pandoc native elements. (Alternatively, you
2769can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2771When converting HTML to Markdown, for example, you may want to drop all
2774 pandoc -f html-native_divs-native_spans -t markdown
2776#### Extension: `native_spans` {#native_spans}
2778Analogous to `native_divs` above.
2781## Literate Haskell support
2783#### Extension: `literate_haskell` ####
2785Treat the document as literate Haskell source.
2787This extension can be enabled/disabled for the following formats:
2790: `markdown`, `rst`, `latex`
2793: `markdown`, `rst`, `latex`, `html`
2795If you append `+lhs` (or `+literate_haskell`) to one of the formats
2796above, pandoc will treat the document as literate Haskell source.
2799 - In Markdown input, "bird track" sections will be parsed as Haskell
2800 code rather than block quotations. Text between `\begin{code}`
2801 and `\end{code}` will also be treated as Haskell code. For
2802 ATX-style headings the character '=' will be used instead of '#'.
2804 - In Markdown output, code blocks with classes `haskell` and `literate`
2805 will be rendered using bird tracks, and block quotations will be
2806 indented one space, so they will not be treated as Haskell code.
2807 In addition, headings will be rendered setext-style (with underlines)
2808 rather than ATX-style (with '#' characters). (This is because ghc
2809 treats '#' characters in column 1 as introducing line numbers.)
2811 - In restructured text input, "bird track" sections will be parsed
2814 - In restructured text output, code blocks with class `haskell` will
2815 be rendered using bird tracks.
2817 - In LaTeX input, text in `code` environments will be parsed as
2820 - In LaTeX output, code blocks with class `haskell` will be rendered
2821 inside `code` environments.
2823 - In HTML output, code blocks with class `haskell` will be rendered
2824 with class `literatehaskell` and bird tracks.
2828 pandoc -f markdown+lhs -t html
2830reads literate Haskell source formatted with Markdown conventions and writes
2831ordinary HTML (without bird tracks).
2833 pandoc -f markdown+lhs -t html+lhs
2835writes HTML with the Haskell code in bird tracks, so it can be copied
2836and pasted as literate Haskell source.
2838Note that GHC expects the bird tracks in the first column, so indented
2839literate code blocks (e.g. inside an itemized environment) will not be
2840picked up by the Haskell compiler.
2844#### Extension: `empty_paragraphs` ####
2846Allows empty paragraphs. By default empty paragraphs are
2849This extension can be enabled/disabled for the following formats:
2855: `docx`, `odt`, `opendocument`, `html`
2857#### Extension: `native_numbering` ####
2859Enables native numbering of figures and tables. Enumeration
2862This extension can be enabled/disabled for the following formats:
2865: `odt`, `opendocument`
2867#### Extension: `styles` #### {#ext-styles}
2869When converting from docx, read all docx styles as divs (for
2870paragraph styles) and spans (for character styles) regardless
2871of whether pandoc understands the meaning of these styles.
2872This can be used with [docx custom styles](#custom-styles).
2878#### Extension: `amuse` ####
2880In the `muse` input format, this enables Text::Amuse
2881extensions to Emacs Muse markup.
2883#### Extension: `citations` {#org-citations}
2885Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2888#### Extension: `ntb` ####
2890In the `context` output format this enables the use of [Natural Tables
2891(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2892[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2893Natural tables allow more fine-grained global customization but come
2894at a performance penalty compared to extreme tables.
2899Pandoc understands an extended and slightly revised version of
2900John Gruber's [Markdown] syntax. This document explains the syntax,
2901noting differences from standard Markdown. Except where noted, these
2902differences can be suppressed by using the `markdown_strict` format instead
2903of `markdown`. Extensions can be enabled or disabled to specify the
2904behavior more granularly. They are described in the following. See also
2905[Extensions] above, for extensions that work also on other formats.
2909Markdown is designed to be easy to write, and, even more importantly,
2912> A Markdown-formatted document should be publishable as-is, as plain
2913> text, without looking like it's been marked up with tags or formatting
2915> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2917This principle has guided pandoc's decisions in finding syntax for
2918tables, footnotes, and other extensions.
2920There is, however, one respect in which pandoc's aims are different
2921from the original aims of Markdown. Whereas Markdown was originally
2922designed with HTML generation in mind, pandoc is designed for multiple
2923output formats. Thus, while pandoc allows the embedding of raw HTML,
2924it discourages it, and provides other, non-HTMLish ways of representing
2925important document elements like definition lists, tables, mathematics, and
2930A paragraph is one or more lines of text followed by one or more blank lines.
2931Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2932If you need a hard line break, put two or more spaces at the end of a line.
2934#### Extension: `escaped_line_breaks` ####
2936A backslash followed by a newline is also a hard line break.
2937Note: in multiline and grid table cells, this is the only way
2938to create a hard line break, since trailing spaces in the cells
2943There are two kinds of headings: Setext and ATX.
2945### Setext-style headings ###
2947A setext-style heading is a line of text "underlined" with a row of `=` signs
2948(for a level-one heading) or `-` signs (for a level-two heading):
2956The heading text can contain inline formatting, such as emphasis (see
2957[Inline formatting], below).
2960### ATX-style headings ###
2962An ATX-style heading consists of one to six `#` signs and a line of
2963text, optionally followed by any number of `#` signs. The number of
2964`#` signs at the beginning of the line is the heading level:
2966 ## A level-two heading
2968 ### A level-three heading ###
2970As with setext-style headings, the heading text can contain formatting:
2972 # A level-one heading with a [link](/url) and *emphasis*
2974#### Extension: `blank_before_header` ####
2976Standard Markdown syntax does not require a blank line before a heading.
2977Pandoc does require this (except, of course, at the beginning of the
2978document). The reason for the requirement is that it is all too easy for a
2979`#` to end up at the beginning of a line by accident (perhaps through line
2980wrapping). Consider, for example:
2982 I like several of their flavors of ice cream:
2983 #22, for example, and #5.
2985#### Extension: `space_in_atx_header` ####
2987Many Markdown implementations do not require a space between the
2988opening `#`s of an ATX heading and the heading text, so that
2989`#5 bolt` and `#hashtag` count as headings. With this extension,
2990pandoc does require the space.
2992### Heading identifiers ###
2994See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2996#### Extension: `header_attributes` ####
2998Headings can be assigned attributes using this syntax at the end
2999of the line containing the heading text:
3001 {#identifier .class .class key=value key=value}
3003Thus, for example, the following headings will all be assigned the identifier
3008 ## My heading ## {#foo}
3010 My other heading {#foo}
3013(This syntax is compatible with [PHP Markdown Extra].)
3015Note that although this syntax allows assignment of classes and key/value
3016attributes, writers generally don't use all of this information. Identifiers,
3017classes, and key/value attributes are used in HTML and HTML-based formats such
3018as EPUB and slidy. Identifiers are used for labels and link anchors in the
3019LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3021Headings with the class `unnumbered` will not be numbered, even if
3022`--number-sections` is specified. A single hyphen (`-`) in an attribute
3023context is equivalent to `.unnumbered`, and preferable in non-English
3030 # My heading {.unnumbered}
3032If the `unlisted` class is present in addition to `unnumbered`,
3033the heading will not be included in a table of contents.
3034(Currently this feature is only implemented for certain
3035formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3037#### Extension: `implicit_header_references` ####
3039Pandoc behaves as if reference links have been defined for each heading.
3040So, to link to a heading
3042 # Heading identifiers in HTML
3046 [Heading identifiers in HTML]
3050 [Heading identifiers in HTML][]
3054 [the section on heading identifiers][heading identifiers in
3057instead of giving the identifier explicitly:
3059 [Heading identifiers in HTML](#heading-identifiers-in-html)
3061If there are multiple headings with identical text, the corresponding
3062reference will link to the first one only, and you will need to use explicit
3063links to link to the others, as described above.
3065Like regular reference links, these references are case-insensitive.
3067Explicit link reference definitions always take priority over
3068implicit heading references. So, in the following example, the
3069link will point to `bar`, not to `#foo`:
3079Markdown uses email conventions for quoting blocks of text.
3080A block quotation is one or more paragraphs or other block elements
3081(such as lists or headings), with each line preceded by a `>` character
3082and an optional space. (The `>` need not start at the left margin, but
3083it should not be indented more than three spaces.)
3085 > This is a block quote. This
3086 > paragraph has two lines.
3088 > 1. This is a list inside a block quote.
3091A "lazy" form, which requires the `>` character only on the first
3092line of each block, is also allowed:
3094 > This is a block quote. This
3095 paragraph has two lines.
3097 > 1. This is a list inside a block quote.
3100Among the block elements that can be contained in a block quote are
3101other block quotes. That is, block quotes can be nested:
3103 > This is a block quote.
3105 > > A block quote within a block quote.
3107If the `>` character is followed by an optional space, that space
3108will be considered part of the block quote marker and not part of
3109the indentation of the contents. Thus, to put an indented code
3110block in a block quote, you need five spaces after the `>`:
3114#### Extension: `blank_before_blockquote` ####
3116Standard Markdown syntax does not require a blank line before a block
3117quote. Pandoc does require this (except, of course, at the beginning of the
3118document). The reason for the requirement is that it is all too easy for a
3119`>` to end up at the beginning of a line by accident (perhaps through line
3120wrapping). So, unless the `markdown_strict` format is used, the following does
3121not produce a nested block quote in pandoc:
3123 > This is a block quote.
3127## Verbatim (code) blocks
3129### Indented code blocks ###
3131A block of text indented four spaces (or one tab) is treated as verbatim
3132text: that is, special characters do not trigger special formatting,
3133and all spaces and line breaks are preserved. For example,
3136 moveShip(5 * gravity, DOWN);
3139The initial (four space or one tab) indentation is not considered part
3140of the verbatim text, and is removed in the output.
3142Note: blank lines in the verbatim text need not begin with four spaces.
3145### Fenced code blocks ###
3147#### Extension: `fenced_code_blocks` ####
3149In addition to standard indented code blocks, pandoc supports
3150*fenced* code blocks. These begin with a row of three or more
3151tildes (`~`) and end with a row of tildes that must be at least as long as
3152the starting row. Everything between these lines is treated as code. No
3153indentation is necessary:
3157 moveShip(5 * gravity, DOWN);
3161Like regular code blocks, fenced code blocks must be separated
3162from surrounding text by blank lines.
3164If the code itself contains a row of tildes or backticks, just use a longer
3165row of tildes or backticks at the start and end:
3169 code including tildes
3173#### Extension: `backtick_code_blocks` ####
3175Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3178#### Extension: `fenced_code_attributes` ####
3180Optionally, you may attach attributes to fenced or backtick code block using
3183 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3185 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3186 qsort (filter (>= x) xs)
3187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3189Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3190`startFrom` is an attribute with value `100`. Some output formats can use this
3191information to do syntax highlighting. Currently, the only output formats
3192that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3193highlighting is supported for your output format and language, then the code
3194block above will appear highlighted, with numbered lines. (To see which
3195languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3196the code block above will appear as follows:
3198 <pre id="mycode" class="haskell numberLines" startFrom="100">
3204The `numberLines` (or `number-lines`) class will cause the lines
3205of the code block to be numbered, starting with `1` or the value
3206of the `startFrom` attribute. The `lineAnchors` (or
3207`line-anchors`) class will cause the lines to be clickable
3208anchors in HTML output.
3210A shortcut form can also be used for specifying the language of
3217This is equivalent to:
3223If the `fenced_code_attributes` extension is disabled, but
3224input contains class attribute(s) for the code block, the first
3225class attribute will be printed after the opening fence as a bare
3228To prevent all highlighting, use the `--no-highlight` flag.
3229To set the highlighting style, use `--highlight-style`.
3230For more information on highlighting, see [Syntax highlighting],
3235#### Extension: `line_blocks` ####
3237A line block is a sequence of lines beginning with a vertical bar (`|`)
3238followed by a space. The division into lines will be preserved in
3239the output, as will any leading spaces; otherwise, the lines will
3240be formatted as Markdown. This is useful for verse and addresses:
3242 | The limerick packs laughs anatomical
3243 | In space that is quite economical.
3244 | But the good ones I've seen
3245 | So seldom are clean
3246 | And the clean ones so seldom are comical
3249 | Berkeley, CA 94718
3251The lines can be hard-wrapped if needed, but the continuation
3252line must begin with a space.
3254 | The Right Honorable Most Venerable and Righteous Samuel L.
3257 | Berkeley, CA 94718
3259This syntax is borrowed from [reStructuredText].
3265A bullet list is a list of bulleted list items. A bulleted list
3266item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3273This will produce a "compact" list. If you want a "loose" list, in which
3274each item is formatted as a paragraph, put spaces between the items:
3282The bullets need not be flush with the left margin; they may be
3283indented one, two, or three spaces. The bullet must be followed
3286List items look best if subsequent lines are flush with the first
3287line (after the bullet):
3293But Markdown also allows a "lazy" format:
3299### Block content in list items ###
3301A list item may contain multiple paragraphs and other block-level
3302content. However, subsequent paragraphs must be preceded by a blank line
3303and indented to line up with the first non-space content after
3310 * Second paragraph. With a code block, which must be indented
3315Exception: if the list marker is followed by an indented code
3316block, which must begin 5 spaces after the list marker, then
3317subsequent paragraphs must begin two columns after the last
3318character of the list marker:
3322 continuation paragraph
3324List items may include other lists. In this case the preceding blank
3325line is optional. The nested list must be indented to line up with
3326the first non-space character after the list marker of the
3327containing list item.
3339As noted above, Markdown allows you to write list items "lazily," instead of
3340indenting continuation lines. However, if there are multiple paragraphs or
3341other blocks in a list item, the first line of each must be indented.
3343 + A lazy, lazy, list
3346 + Another one; this looks
3349 Second paragraph of second
3352### Ordered lists ###
3354Ordered lists work just like bulleted lists, except that the items
3355begin with enumerators rather than bullets.
3357In standard Markdown, enumerators are decimal numbers followed
3358by a period and a space. The numbers themselves are ignored, so
3359there is no difference between this list:
3371#### Extension: `fancy_lists` ####
3373Unlike standard Markdown, pandoc allows ordered list items to be marked
3374with uppercase and lowercase letters and roman numerals, in addition to
3375Arabic numerals. List markers may be enclosed in parentheses or followed by a
3376single right-parentheses or period. They must be separated from the
3377text that follows by at least one space, and, if the list marker is a
3378capital letter with a period, by at least two spaces.[^2]
3380[^2]: The point of this rule is to ensure that normal paragraphs
3381 starting with people's initials, like
3383 B. Russell was an English philosopher.
3385 do not get treated as list items.
3387 This rule will not prevent
3391 from being interpreted as a list item. In this case, a backslash
3396The `fancy_lists` extension also allows '`#`' to be used as an
3397ordered list marker in place of a numeral:
3402#### Extension: `startnum` ####
3404Pandoc also pays attention to the type of list marker used, and to the
3405starting number, and both of these are preserved where possible in the
3406output format. Thus, the following yields a list with numbers followed
3407by a single parenthesis, starting with 9, and a sublist with lowercase
3417Pandoc will start a new list each time a different type of list
3418marker is used. So, the following will create three lists:
3425If default list markers are desired, use `#.`:
3431#### Extension: `task_lists` ####
3433Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3435 - [ ] an unchecked task list item
3438### Definition lists ###
3440#### Extension: `definition_lists` ####
3442Pandoc supports definition lists, using the syntax of
3443[PHP Markdown Extra] with some extensions.[^3]
3449 Term 2 with *inline markup*
3453 { some code, part of Definition 2 }
3455 Third paragraph of definition 2.
3457Each term must fit on one line, which may optionally be followed by
3458a blank line, and must be followed by one or more definitions.
3459A definition begins with a colon or tilde, which may be indented one
3462A term may have multiple definitions, and each definition may consist of one or
3463more block elements (paragraph, code block, list, etc.), each indented four
3464spaces or one tab stop. The body of the definition (including the first line,
3465aside from the colon or tilde) should be indented four spaces. However,
3466as with other Markdown lists, you can "lazily" omit indentation except
3467at the beginning of a paragraph or other block element:
3472 with lazy continuation.
3474 Second paragraph of the definition.
3476If you leave space before the definition (as in the example above),
3477the text of the definition will be treated as a paragraph. In some
3478output formats, this will mean greater spacing between term/definition
3479pairs. For a more compact definition list, omit the space before the
3489Note that space between items in a definition list is required.
3490(A variant that loosens this requirement, but disallows "lazy"
3491hard wrapping, can be activated with `compact_definition_lists`: see
3492[Non-pandoc extensions], below.)
3494[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3496### Numbered example lists ###
3498#### Extension: `example_lists` ####
3500The special list marker `@` can be used for sequentially numbered
3501examples. The first list item with a `@` marker will be numbered '1',
3502the next '2', and so on, throughout the document. The numbered examples
3503need not occur in a single list; each new list using `@` will take up
3504where the last stopped. So, for example:
3506 (@) My first example will be numbered (1).
3507 (@) My second example will be numbered (2).
3509 Explanation of examples.
3511 (@) My third example will be numbered (3).
3513Numbered examples can be labeled and referred to elsewhere in the
3516 (@good) This is a good example.
3518 As (@good) illustrates, ...
3520The label can be any string of alphanumeric characters, underscores,
3523Note: continuation paragraphs in example lists must always
3524be indented four spaces, regardless of the length of the
3525list marker. That is, example lists always behave as if the
3526`four_space_rule` extension is set. This is because example
3527labels tend to be long, and indenting content to the
3528first non-space character after the label would be awkward.
3530### Compact and loose lists ###
3532Pandoc behaves differently from `Markdown.pl` on some "edge
3533cases" involving lists. Consider this source:
3543Pandoc transforms this into a "compact list" (with no `<p>` tags around
3544"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3545"Second" and "Third" (but not "First"), because of the blank space
3546around "Third". Pandoc follows a simple rule: if the text is followed by
3547a blank line, it is treated as a paragraph. Since "Second" is followed
3548by a list, and not a blank line, it isn't treated as a paragraph. The
3549fact that the list is followed by a blank line is irrelevant. (Note:
3550Pandoc works this way even when the `markdown_strict` format is specified. This
3551behavior is consistent with the official Markdown syntax description,
3552even though it is different from that of `Markdown.pl`.)
3555### Ending a list ###
3557What if you want to put an indented code block after a list?
3564Trouble! Here pandoc (like other Markdown implementations) will treat
3565`{ my code block }` as the second paragraph of item two, and not as
3568To "cut off" the list after item two, you can insert some non-indented
3569content, like an HTML comment, which won't produce visible output in
3575 <!-- end of list -->
3579You can use the same trick if you want two consecutive lists instead
3594A line containing a row of three or more `*`, `-`, or `_` characters
3595(optionally separated by spaces) produces a horizontal rule:
3604Four kinds of tables may be used. The first three kinds presuppose the use of
3605a fixed-width font, such as Courier. The fourth kind can be used with
3606proportionally spaced fonts, as it does not require lining up columns.
3608#### Extension: `table_captions` ####
3610A caption may optionally be provided with all 4 kinds of tables (as
3611illustrated in the examples below). A caption is a paragraph beginning
3612with the string `Table:` (or just `:`), which will be stripped off.
3613It may appear either before or after the table.
3615#### Extension: `simple_tables` ####
3617Simple tables look like this:
3619 Right Left Center Default
3620 ------- ------ ---------- -------
3625 Table: Demonstration of simple table syntax.
3627The header and table rows must each fit on one line. Column
3628alignments are determined by the position of the header text relative
3629to the dashed line below it:[^4]
3631 - If the dashed line is flush with the header text on the right side
3632 but extends beyond it on the left, the column is right-aligned.
3633 - If the dashed line is flush with the header text on the left side
3634 but extends beyond it on the right, the column is left-aligned.
3635 - If the dashed line extends beyond the header text on both sides,
3636 the column is centered.
3637 - If the dashed line is flush with the header text on both sides,
3638 the default alignment is used (in most cases, this will be left).
3640[^4]: This scheme is due to Michel Fortin, who proposed it on the
3641 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3643The table must end with a blank line, or a line of dashes followed by
3646The column header row may be omitted, provided a dashed line is used
3647to end the table. For example:
3649 ------- ------ ---------- -------
3653 ------- ------ ---------- -------
3655When the header row is omitted, column alignments are determined on the basis
3656of the first line of the table body. So, in the tables above, the columns
3657would be right, left, center, and right aligned, respectively.
3659#### Extension: `multiline_tables` ####
3661Multiline tables allow header and table rows to span multiple lines
3662of text (but cells that span multiple columns or rows of the table are
3663not supported). Here is an example:
3665 -------------------------------------------------------------
3666 Centered Default Right Left
3667 Header Aligned Aligned Aligned
3668 ----------- ------- --------------- -------------------------
3669 First row 12.0 Example of a row that
3670 spans multiple lines.
3672 Second row 5.0 Here's another one. Note
3673 the blank line between
3675 -------------------------------------------------------------
3677 Table: Here's the caption. It, too, may span
3680These work like simple tables, but with the following differences:
3682 - They must begin with a row of dashes, before the header text
3683 (unless the header row is omitted).
3684 - They must end with a row of dashes, then a blank line.
3685 - The rows must be separated by blank lines.
3687In multiline tables, the table parser pays attention to the widths of
3688the columns, and the writers try to reproduce these relative widths in
3689the output. So, if you find that one of the columns is too narrow in the
3690output, try widening it in the Markdown source.
3692The header may be omitted in multiline tables as well as simple tables:
3694 ----------- ------- --------------- -------------------------
3695 First row 12.0 Example of a row that
3696 spans multiple lines.
3698 Second row 5.0 Here's another one. Note
3699 the blank line between
3701 ----------- ------- --------------- -------------------------
3703 : Here's a multiline table without a header.
3705It is possible for a multiline table to have just one row, but the row
3706should be followed by a blank line (and then the row of dashes that ends
3707the table), or the table may be interpreted as a simple table.
3709#### Extension: `grid_tables` ####
3711Grid tables look like this:
3713 : Sample grid table.
3715 +---------------+---------------+--------------------+
3716 | Fruit | Price | Advantages |
3717 +===============+===============+====================+
3718 | Bananas | $1.34 | - built-in wrapper |
3719 | | | - bright color |
3720 +---------------+---------------+--------------------+
3721 | Oranges | $2.10 | - cures scurvy |
3723 +---------------+---------------+--------------------+
3725The row of `=`s separates the header from the table body, and can be
3726omitted for a headerless table. The cells of grid tables may contain
3727arbitrary block elements (multiple paragraphs, code blocks, lists,
3728etc.). Cells that span multiple columns or rows are not
3729supported. Grid tables can be created easily using Emacs' table-mode
3730(`M-x table-insert`).
3732Alignments can be specified as with pipe tables, by putting
3733colons at the boundaries of the separator line after the
3736 +---------------+---------------+--------------------+
3737 | Right | Left | Centered |
3738 +==============:+:==============+:==================:+
3739 | Bananas | $1.34 | built-in wrapper |
3740 +---------------+---------------+--------------------+
3742For headerless tables, the colons go on the top line instead:
3744 +--------------:+:--------------+:------------------:+
3745 | Right | Left | Centered |
3746 +---------------+---------------+--------------------+
3748##### Grid Table Limitations #####
3750Pandoc does not support grid tables with row spans or column spans.
3751This means that neither variable numbers of columns across rows nor
3752variable numbers of rows across columns are supported by Pandoc.
3753All grid tables must have the same number of columns in each row,
3754and the same number of rows in each column. For example, the
3755Docutils [sample grid tables] will not render as expected with
3758[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3761#### Extension: `pipe_tables` ####
3763Pipe tables look like this:
3765 | Right | Left | Default | Center |
3766 |------:|:-----|---------|:------:|
3767 | 12 | 12 | 12 | 12 |
3768 | 123 | 123 | 123 | 123 |
3771 : Demonstration of pipe table syntax.
3773The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3774ending pipe characters are optional, but pipes are required between all
3775columns. The colons indicate column alignment as shown. The header
3776cannot be omitted. To simulate a headerless table, include a header
3779Since the pipes indicate column boundaries, columns need not be vertically
3780aligned, as they are in the above example. So, this is a perfectly
3781legal (though ugly) pipe table:
3789The cells of pipe tables cannot contain block elements like paragraphs
3790and lists, and cannot span multiple lines. If a pipe table contains a
3791row whose printable content is wider than the column width (see
3792`--columns`), then the table will take up the full text width and
3793the cell contents will wrap, with the relative cell widths determined
3794by the number of dashes in the line separating the table header from
3795the table body. (For example `---|-` would make the first column 3/4
3796and the second column 1/4 of the full text width.)
3797On the other hand, if no lines are wider than column width, then
3798cell contents will not be wrapped, and the cells will be sized
3801Note: pandoc also recognizes pipe tables of the following
3802form, as can be produced by Emacs' orgtbl-mode:
3809The difference is that `+` is used instead of `|`. Other orgtbl features
3810are not supported. In particular, to get non-default column alignment,
3811you'll need to add colons as above.
3813[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3817#### Extension: `pandoc_title_block` ####
3819If the file begins with a title block
3822 % author(s) (separated by semicolons)
3825it will be parsed as bibliographic information, not regular text. (It
3826will be used, for example, in the title of standalone LaTeX or HTML
3827output.) The block may contain just a title, a title and an author,
3828or all three elements. If you want to include an author but no
3829title, or a title and a date but no author, you need a blank line:
3838The title may occupy multiple lines, but continuation lines must
3839begin with leading space, thus:
3844If a document has multiple authors, the authors may be put on
3845separate lines with leading space, or separated by semicolons, or
3846both. So, all of the following are equivalent:
3851 % Author One; Author Two
3856The date must fit on one line.
3858All three metadata fields may contain standard inline formatting
3859(italics, links, footnotes, etc.).
3861Title blocks will always be parsed, but they will affect the output only
3862when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3863will appear twice: once in the document head -- this is the title that
3864will appear at the top of the window in a browser -- and once at the
3865beginning of the document body. The title in the document head can have
3866an optional prefix attached (`--title-prefix` or `-T` option). The title
3867in the body appears as an H1 element with class "title", so it can be
3868suppressed or reformatted with CSS. If a title prefix is specified with
3869`-T` and no title block appears in the document, the title prefix will
3870be used by itself as the HTML title.
3872The man page writer extracts a title, man page section number, and
3873other header and footer information from the title line. The title
3874is assumed to be the first word on the title line, which may optionally
3875end with a (single-digit) section number in parentheses. (There should
3876be no space between the title and the parentheses.) Anything after
3877this is assumed to be additional footer and header text. A single pipe
3878character (`|`) should be used to separate the footer text from the header
3883will yield a man page with the title `PANDOC` and section 1.
3885 % PANDOC(1) Pandoc User Manuals
3887will also have "Pandoc User Manuals" in the footer.
3889 % PANDOC(1) Pandoc User Manuals | Version 4.0
3891will also have "Version 4.0" in the header.
3893#### Extension: `yaml_metadata_block` ####
3895A [YAML] metadata block is a valid YAML object, delimited by a line of three
3896hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3897(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3898document, but if it is not at the beginning, it must be preceded by a blank
3899line. (Note that, because of the way pandoc concatenates input files when
3900several are provided, you may also keep the metadata in a separate YAML file
3901and pass it to pandoc as an argument, along with your Markdown files:
3903 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3905Just be sure that the YAML file begins with `---` and ends with `---` or
3906`...`.) Alternatively, you can use the `--metadata-file` option. Using
3907that approach however, you cannot reference content (like footnotes)
3908from the main markdown input document.
3910Metadata will be taken from the fields of the YAML object and added to any
3911existing document metadata. Metadata can contain lists and objects (nested
3912arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3913with names ending in an underscore will be ignored by pandoc. (They may be
3914given a role by external processors.) Field names must not be
3915interpretable as YAML numbers or boolean values (so, for
3916example, `yes`, `True`, and `15` cannot be used as field names).
3918A document may contain multiple metadata blocks. If two
3919metadata blocks attempt to set the same field, the value from
3920the second block will be taken.
3922When pandoc is used with `-t markdown` to create a Markdown document,
3923a YAML metadata block will be produced only if the `-s/--standalone`
3924option is used. All of the metadata will appear in a single block
3925at the beginning of the document.
3927Note that [YAML] escaping rules must be followed. Thus, for example,
3928if a title contains a colon, it must be quoted. The pipe character
3929(`|`) can be used to begin an indented block that will be interpreted
3930literally, without need for escaping. This form is necessary
3931when the field contains blank lines or block-level formatting:
3934 title: 'This is the title: it contains a colon'
3938 keywords: [nothing, nothingness]
3940 This is the abstract.
3942 It consists of two paragraphs.
3945Template variables will be set automatically from the metadata. Thus, for
3946example, in writing HTML, the variable `abstract` will be set to the HTML
3947equivalent of the Markdown in the `abstract` field:
3949 <p>This is the abstract.</p>
3950 <p>It consists of two paragraphs.</p>
3952Variables can contain arbitrary YAML structures, but the template must match
3953this structure. The `author` variable in the default templates expects a
3954simple list or string, but can be changed to support more complicated
3955structures. The following combination, for example, would add an affiliation
3956to the author if one is given:
3959 title: The document title
3962 affiliation: University of Somewhere
3964 affiliation: University of Nowhere
3967To use the structured authors in the example above, you would need a custom
3972 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3978Raw content to include in the document's header may be specified
3979using `header-includes`; however, it is important to mark up
3980this content as raw code for a particular output format, using
3981the [`raw_attribute` extension](#extension-raw_attribute)), or it
3982will be interpreted as markdown. For example:
3987 \let\oldsection\section
3988 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3993#### Extension: `all_symbols_escapable` ####
3995Except inside a code block or inline code, any punctuation or space
3996character preceded by a backslash will be treated literally, even if it
3997would normally indicate formatting. Thus, for example, if one writes
4007 <strong>hello</strong>
4009This rule is easier to remember than standard Markdown's rule,
4010which allows only the following characters to be backslash-escaped:
4014(However, if the `markdown_strict` format is used, the standard Markdown rule
4017A backslash-escaped space is parsed as a nonbreaking space. It will
4018appear in TeX output as `~` and in HTML and XML as `\ ` or
4021A backslash-escaped newline (i.e. a backslash occurring at the end of
4022a line) is parsed as a hard line break. It will appear in TeX output as
4023`\\` and in HTML as `<br />`. This is a nice alternative to
4024Markdown's "invisible" way of indicating hard line breaks using
4025two trailing spaces on a line.
4027Backslash escapes do not work in verbatim contexts.
4033To *emphasize* some text, surround it with `*`s or `_`, like this:
4035 This text is _emphasized with underscores_, and this
4036 is *emphasized with asterisks*.
4038Double `*` or `_` produces **strong emphasis**:
4040 This is **strong emphasis** and __with underscores__.
4042A `*` or `_` character surrounded by spaces, or backslash-escaped,
4043will not trigger emphasis:
4045 This is * not emphasized *, and \*neither is this\*.
4047#### Extension: `intraword_underscores` ####
4049Because `_` is sometimes used inside words and identifiers,
4050pandoc does not interpret a `_` surrounded by alphanumeric
4051characters as an emphasis marker. If you want to emphasize
4052just part of a word, use `*`:
4054 feas*ible*, not feas*able*.
4059#### Extension: `strikeout` ####
4061To strikeout a section of text with a horizontal line, begin and end it
4062with `~~`. Thus, for example,
4064 This ~~is deleted text.~~
4067### Superscripts and subscripts ###
4069#### Extension: `superscript`, `subscript` ####
4071Superscripts may be written by surrounding the superscripted text by `^`
4072characters; subscripts may be written by surrounding the subscripted
4073text by `~` characters. Thus, for example,
4075 H~2~O is a liquid. 2^10^ is 1024.
4077The text between `^...^` or `~...~` may not contain spaces or
4078newlines. If the superscripted or subscripted text contains
4079spaces, these spaces must be escaped with backslashes. (This is
4080to prevent accidental superscripting and subscripting through
4081the ordinary use of `~` and `^`, and also bad interactions with
4082footnotes.) Thus, if you want the letter P with 'a cat' in
4083subscripts, use `P~a\ cat~`, not `P~a cat~`.
4087To make a short span of text verbatim, put it inside backticks:
4089 What is the difference between `>>=` and `>>`?
4091If the verbatim text includes a backtick, use double backticks:
4093 Here is a literal backtick `` ` ``.
4095(The spaces after the opening backticks and before the closing
4096backticks will be ignored.)
4098The general rule is that a verbatim span starts with a string
4099of consecutive backticks (optionally followed by a space)
4100and ends with a string of the same number of backticks (optionally
4101preceded by a space).
4103Note that backslash-escapes (and other Markdown constructs) do not
4104work in verbatim contexts:
4106 This is a backslash followed by an asterisk: `\*`.
4108#### Extension: `inline_code_attributes` ####
4110Attributes can be attached to verbatim text, just as with
4111[fenced code blocks]:
4117To write small caps, use the `smallcaps` class:
4119 [Small caps]{.smallcaps}
4121Or, without the `bracketed_spans` extension:
4123 <span class="smallcaps">Small caps</span>
4125For compatibility with other Markdown flavors, CSS is also supported:
4127 <span style="font-variant:small-caps;">Small caps</span>
4129This will work in all output formats that support small caps.
4134#### Extension: `tex_math_dollars` ####
4136Anything between two `$` characters will be treated as TeX math. The
4137opening `$` must have a non-space character immediately to its right,
4138while the closing `$` must have a non-space character immediately to its
4139left, and must not be followed immediately by a digit. Thus,
4140`$20,000 and $30,000` won't parse as math. If for some reason
4141you need to enclose text in literal `$` characters, backslash-escape
4142them and they won't be treated as math delimiters.
4144For display math, use `$$` delimiters. (In this case, the delimiters
4145may be separated from the formula by whitespace.)
4147TeX math will be printed in all output formats. How it is rendered
4148depends on the output format:
4151 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4152 math) or `\[...\]` (for display math).
4154Markdown, Emacs Org mode, ConTeXt, ZimWiki
4155 ~ It will appear verbatim surrounded by `$...$` (for inline
4156 math) or `$$...$$` (for display math).
4159 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4162 ~ It will be rendered using an [interpreted text role `:math:`].
4165 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4166 surrounded by `latexmath:[$...$]` (for inline math) or
4167 `[latexmath]++++\[...\]+++` (for display math).
4168 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4169 (`$..$` and `\[..\]`) are omitted.
4172 ~ It will be rendered inside a `@math` command.
4174roff man, Jira markup
4175 ~ It will be rendered verbatim without `$`'s.
4178 ~ It will be rendered inside `<math>` tags.
4181 ~ It will be rendered inside `<span class="math">` tags.
4184 ~ It will be rendered, if possible, using Unicode characters,
4185 and will otherwise appear verbatim.
4188 ~ It will be rendered, if possible, using MathML.
4191 ~ If the `--mathml` flag is used, it will be rendered using MathML
4192 in an `inlineequation` or `informalequation` tag. Otherwise it
4193 will be rendered, if possible, using Unicode characters.
4196 ~ It will be rendered using OMML math markup.
4199 ~ If the `--webtex` option is used, formulas are rendered as images
4200 using CodeCogs or other compatible web service, downloaded
4201 and embedded in the e-book. Otherwise, they will appear verbatim.
4203HTML, Slidy, DZSlides, S5, EPUB
4204 ~ The way math is rendered in HTML will depend on the
4205 command-line options selected. Therefore see [Math rendering in HTML]
4208[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4212#### Extension: `raw_html` ####
4214Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4215(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4216literally). (Technically this is not an extension, since standard
4217Markdown allows it, but it has been made an extension so that it can
4218be disabled if desired.)
4220The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4221DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4222output, and suppressed in other formats.
4224For a more explicit way of including raw HTML in a Markdown
4225document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4227In the CommonMark format, if `raw_html` is enabled, superscripts,
4228subscripts, strikeouts and small capitals will be represented as HTML.
4229Otherwise, plain-text fallbacks will be used. Note that even if
4230`raw_html` is disabled, tables will be rendered with HTML syntax if
4231they cannot use pipe syntax.
4233#### Extension: `markdown_in_html_blocks` ####
4235Standard Markdown allows you to include HTML "blocks": blocks
4236of HTML between balanced tags that are separated from the surrounding text
4237with blank lines, and start and end at the left margin. Within
4238these blocks, everything is interpreted as HTML, not Markdown;
4239so (for example), `*` does not signify emphasis.
4241Pandoc behaves this way when the `markdown_strict` format is used; but
4242by default, pandoc interprets material between HTML block tags as Markdown.
4243Thus, for example, pandoc will turn
4248 <td>[a link](http://google.com)</td>
4256 <td><em>one</em></td>
4257 <td><a href="http://google.com">a link</a></td>
4261whereas `Markdown.pl` will preserve it as is.
4263There is one exception to this rule: text between `<script>` and
4264`<style>` tags is not interpreted as Markdown.
4266This departure from standard Markdown should make it easier to mix
4267Markdown with HTML block elements. For example, one can surround
4268a block of Markdown text with `<div>` tags without preventing it
4269from being interpreted as Markdown.
4271#### Extension: `native_divs` ####
4273Use native pandoc `Div` blocks for content inside `<div>` tags.
4274For the most part this should give the same output as
4275`markdown_in_html_blocks`, but it makes it easier to write pandoc
4276filters to manipulate groups of blocks.
4278#### Extension: `native_spans` ####
4280Use native pandoc `Span` blocks for content inside `<span>` tags.
4281For the most part this should give the same output as `raw_html`,
4282but it makes it easier to write pandoc filters to manipulate groups
4285#### Extension: `raw_tex` ####
4287In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4288included in a document. Inline TeX commands will be preserved and passed
4289unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4290LaTeX to include BibTeX citations:
4292 This result was proved in \cite{jones.1967}.
4294Note that in LaTeX environments, like
4296 \begin{tabular}{|l|l|}\hline
4297 Age & Frequency \\ \hline
4300 36--45 & 22 \\ \hline
4303the material between the begin and end tags will be interpreted as raw
4304LaTeX, not as Markdown.
4306For a more explicit and flexible way of including raw TeX in a
4307Markdown document, see the [`raw_attribute`
4308extension][Extension: `raw_attribute`].
4310Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4311Emacs Org mode, and ConTeXt.
4313### Generic raw attribute ###
4315#### Extension: `raw_attribute` ####
4317Inline spans and fenced code blocks with a special
4318kind of attribute will be parsed as raw content with the
4319designated format. For example, the following produces a raw
4326And the following produces a raw `html` inline element:
4328 This is `<a>html</a>`{=html}
4330This can be useful to insert raw xml into `docx` documents, e.g.
4336 <w:br w:type="page"/>
4341The format name should match the target format name (see
4342`-t/--to`, above, for a list, or use `pandoc
4343--list-output-formats`). Use `openxml` for `docx` output,
4344`opendocument` for `odt` output, `html5` for `epub3` output,
4345`html4` for `epub2` output, and `latex`, `beamer`,
4346`ms`, or `html5` for `pdf` output (depending on what you
4347use for `--pdf-engine`).
4349This extension presupposes that the relevant kind of
4350inline code or fenced code block is enabled. Thus, for
4351example, to use a raw attribute with a backtick code block,
4352`backtick_code_blocks` must be enabled.
4354The raw attribute cannot be combined with regular attributes.
4358#### Extension: `latex_macros` ####
4360When this extension is enabled, pandoc will parse LaTeX
4361macro definitions and apply the resulting macros to all LaTeX
4362math and raw LaTeX. So, for example, the following will work in
4363all output formats, not just LaTeX:
4365 \newcommand{\tuple}[1]{\langle #1 \rangle}
4369Note that LaTeX macros will not be applied if they occur
4370inside a raw span or block marked with the
4371[`raw_attribute` extension](#extension-raw_attribute).
4373When `latex_macros` is disabled, the raw LaTeX and math will
4374not have macros applied. This is usually a better approach when
4375you are targeting LaTeX or PDF.
4377Macro definitions in LaTeX will be passed through as raw LaTeX
4378only if `latex_macros` is not enabled. Macro definitions in
4379Markdown source (or other formats allowing `raw_tex`) will
4380be passed through regardless of whether `latex_macros` is
4385Markdown allows links to be specified in several ways.
4387### Automatic links ###
4389If you enclose a URL or email address in pointy brackets, it
4393 <sam@green.eggs.ham>
4397An inline link consists of the link text in square brackets,
4398followed by the URL in parentheses. (Optionally, the URL can
4399be followed by a link title, in quotes.)
4401 This is an [inline link](/url), and here's [one with
4402 a title](http://fsf.org "click here for a good time!").
4404There can be no space between the bracketed part and the parenthesized part.
4405The link text can contain formatting (such as emphasis), but the title cannot.
4407Email addresses in inline links are not autodetected, so they have to be
4408prefixed with `mailto`:
4410 [Write me!](mailto:sam@green.eggs.ham)
4412### Reference links ###
4414An *explicit* reference link has two parts, the link itself and the link
4415definition, which may occur elsewhere in the document (either
4416before or after the link).
4418The link consists of link text in square brackets, followed by a label in
4419square brackets. (There cannot be space between the two unless the
4420`spaced_reference_links` extension is enabled.) The link definition
4421consists of the bracketed label, followed by a colon and a space, followed by
4422the URL, and optionally (after a space) a link title either in quotes or in
4423parentheses. The label must not be parseable as a citation (assuming
4424the `citations` extension is enabled): citations take precedence over
4427Here are some examples:
4429 [my label 1]: /foo/bar.html "My title, optional"
4431 [my label 3]: http://fsf.org (The free software foundation)
4432 [my label 4]: /bar#special 'A title in single quotes'
4434The URL may optionally be surrounded by angle brackets:
4436 [my label 5]: <http://foo.bar.baz>
4438The title may go on the next line:
4440 [my label 3]: http://fsf.org
4441 "The free software foundation"
4443Note that link labels are not case sensitive. So, this will work:
4445 Here is [my link][FOO]
4449In an *implicit* reference link, the second pair of brackets is
4454 [my website]: http://foo.bar.baz
4456Note: In `Markdown.pl` and most other Markdown implementations,
4457reference link definitions cannot occur in nested constructions
4458such as list items or block quotes. Pandoc lifts this arbitrary
4459seeming restriction. So the following is fine in pandoc, though
4460not in most other implementations:
4466#### Extension: `shortcut_reference_links` ####
4468In a *shortcut* reference link, the second pair of brackets may
4473 [my website]: http://foo.bar.baz
4475### Internal links ###
4477To link to another section of the same document, use the automatically
4478generated identifier (see [Heading identifiers]). For example:
4480 See the [Introduction](#introduction).
4484 See the [Introduction].
4486 [Introduction]: #introduction
4488Internal links are currently supported for HTML formats (including
4489HTML slide shows and EPUB), LaTeX, and ConTeXt.
4493A link immediately preceded by a `!` will be treated as an image.
4494The link text will be used as the image's alt text:
4496 
4500 [movie reel]: movie.gif
4502#### Extension: `implicit_figures` ####
4504An image with nonempty alt text, occurring by itself in a
4505paragraph, will be rendered as a figure with a caption. The
4506image's alt text will be used as the caption.
4508 
4510How this is rendered depends on the output format. Some output
4511formats (e.g. RTF) do not yet support figures. In those
4512formats, you'll just get an image in a paragraph by itself, with
4515If you just want a regular inline image, just make sure it is not
4516the only thing in the paragraph. One way to do this is to insert a
4517nonbreaking space after the image:
4519 \
4521Note that in reveal.js slide shows, an image in a paragraph
4522by itself that has the `stretch` class will fill the screen,
4523and the caption and figure tags will be omitted.
4525#### Extension: `link_attributes` ####
4527Attributes can be set on links and images:
4529 An inline {#id .class width=30 height=20px}
4530 and a reference ![image][ref] with attributes.
4532 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4534(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4535and `.class` are used.)
4537For HTML and EPUB, all known HTML5 attributes except `width` and
4538`height` (but including `srcset` and `sizes`) are passed through
4539as is. Unknown attributes are passed through as custom
4540attributes, with `data-` prepended. The other writers ignore
4541attributes that are not specifically supported by their output format.
4543The `width` and `height` attributes on images are treated specially. When
4544used without a unit, the unit is assumed to be pixels. However, any of
4545the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4546and `%`. There must not be any spaces between the number and the unit.
4550{ width=50% }
4553- Dimensions are converted to inches for output in page-based formats like
4554 LaTeX. Dimensions are converted to pixels for output in HTML-like
4555 formats. Use the `--dpi` option to specify the number of pixels per
4556 inch. The default is 96dpi.
4557- The `%` unit is generally relative to some available space.
4558 For example the above example will render to the following.
4559 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4560 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4561 (If you're using a custom template, you need to configure `graphicx`
4562 as in the default template.)
4563 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4564- Some output formats have a notion of a class
4565 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4566 or a unique identifier (LaTeX `\caption`), or both (HTML).
4567- When no `width` or `height` attributes are specified, the fallback
4568 is to look at the image resolution and the dpi metadata embedded in
4573Using the `native_divs` and `native_spans` extensions
4574(see [above][Extension: `native_divs`]), HTML syntax can
4575be used as part of markdown to create native `Div` and `Span`
4576elements in the pandoc AST (as opposed to raw HTML).
4577However, there is also nicer syntax available:
4579#### Extension: `fenced_divs` ####
4581Allow special fenced syntax for native `Div` blocks. A Div
4582starts with a fence containing at least three consecutive
4583colons plus some attributes. The attributes may optionally
4584be followed by another string of consecutive colons.
4585The attribute syntax is exactly as in fenced code blocks (see
4586[Extension: `fenced_code_attributes`]). As with fenced
4587code blocks, one can use either attributes in curly braces
4588or a single unbraced word, which will be treated as a class
4589name. The Div ends with another line containing a string of at
4590least three consecutive colons. The fenced Div should be
4591separated by blank lines from preceding and following blocks.
4595 ::::: {#special .sidebar}
4596 Here is a paragraph.
4601Fenced divs can be nested. Opening fences are distinguished
4602because they *must* have attributes:
4608 This is a warning within a warning.
4612Fences without attributes are always closing fences. Unlike
4613with fenced code blocks, the number of colons in the closing
4614fence need not match the number in the opening fence. However,
4615it can be helpful for visual clarity to use fences of different
4616lengths to distinguish nested divs from their parents.
4619#### Extension: `bracketed_spans` ####
4621A bracketed sequence of inlines, as one would use to begin
4622a link, will be treated as a `Span` with attributes if it is
4623followed immediately by attributes:
4625 [This is *some text*]{.class key="val"}
4629#### Extension: `footnotes` ####
4631Pandoc's Markdown allows footnotes, using the following syntax:
4633 Here is a footnote reference,[^1] and another.[^longnote]
4635 [^1]: Here is the footnote.
4637 [^longnote]: Here's one with multiple blocks.
4639 Subsequent paragraphs are indented to show that they
4640 belong to the previous footnote.
4644 The whole paragraph can be indented, or just the first
4645 line. In this way, multi-paragraph footnotes work like
4646 multi-paragraph list items.
4648 This paragraph won't be part of the note, because it
4651The identifiers in footnote references may not contain spaces, tabs,
4652or newlines. These identifiers are used only to correlate the
4653footnote reference with the note itself; in the output, footnotes
4654will be numbered sequentially.
4656The footnotes themselves need not be placed at the end of the
4657document. They may appear anywhere except inside other block elements
4658(lists, block quotes, tables, etc.). Each footnote should be
4659separated from surrounding content (including other footnotes)
4662#### Extension: `inline_notes` ####
4664Inline footnotes are also allowed (though, unlike regular notes,
4665they cannot contain multiple paragraphs). The syntax is as follows:
4667 Here is an inline note.^[Inlines notes are easier to write, since
4668 you don't have to pick an identifier and move down to type the
4671Inline and regular footnotes may be mixed freely.
4675#### Extension: `citations` ####
4677Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4678citations and a bibliography in a number of styles. Basic usage is
4680 pandoc --filter pandoc-citeproc myinput.txt
4682In order to use this feature, you will need to specify a bibliography file
4683using the `bibliography` metadata field in a YAML metadata section, or
4684`--bibliography` command line argument. You can supply multiple `--bibliography`
4685arguments or set `bibliography` metadata field to YAML array, if you want to
4686use multiple bibliography files. The bibliography may have any of these
4689 Format File extension
4690 ------------ --------------
4703Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4704use `.bibtex` to force BibTeX.
4706Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4707can produce `.json` and `.yaml` files from any of the supported formats.
4709In-field markup: In BibTeX and BibLaTeX databases,
4710pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4711databases, pandoc Markdown; and in CSL JSON databases, an
4712[HTML-like markup][CSL markup specs]:
4720`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4729`<span class="nocase">...</span>`
4730: prevent a phrase from being capitalized as title case
4732`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4733and CSL YAML formats as far as possible.
4735As an alternative to specifying a bibliography file using `--bibliography`
4736or the YAML metadata field `bibliography`, you can include
4737the citation data directly in the `references` field of the
4738document's YAML metadata. The field should contain an array of
4739YAML-encoded references, for example:
4743 - type: article-journal
4755 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4757 title-short: Molecular structure of nucleic acids
4758 container-title: Nature
4762 DOI: 10.1038/171737a0
4763 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4767(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4768of the supported formats.)
4770Citations and references can be formatted using any style supported by the
4771[Citation Style Language], listed in the [Zotero Style Repository].
4772These files are specified using the `--csl` option or the `csl` metadata field.
4773By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4774format. The CSL project provides further information on [finding and editing styles].
4776To make your citations hyperlinks to the corresponding bibliography
4777entries, add `link-citations: true` to your YAML metadata.
4779Citations go inside square brackets and are separated by semicolons.
4780Each citation must have a key, composed of '@' + the citation
4781identifier from the database, and may optionally have a prefix,
4782a locator, and a suffix. The citation key must begin with a letter, digit,
4783or `_`, and may contain alphanumerics, `_`, and internal punctuation
4784characters (`:.#$%&-+?<>~/`). Here are some examples:
4786 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4788 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4790 Blah blah [@smith04; @doe99].
4792`pandoc-citeproc` detects locator terms in the [CSL locale files].
4793Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4794locale, locator terms can be written in either singular or plural forms,
4795as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4796`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4797`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4798`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4799`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4800`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4801locator term is used, "page" is assumed.
4803`pandoc-citeproc` will use heuristics to distinguish the locator
4804from the suffix. In complex cases, the locator can be enclosed
4805in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4807 [@smith{ii, A, D-Z}, with a suffix]
4808 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4810A minus sign (`-`) before the `@` will suppress mention of
4811the author in the citation. This can be useful when the
4812author is already mentioned in the text:
4814 Smith says blah [-@smith04].
4816You can also write an in-text citation, as follows:
4820 @smith04 [p. 33] says blah.
4822If the style calls for a list of works cited, it will be placed
4823in a div with id `refs`, if one exists:
4828Otherwise, it will be placed at the end of the document.
4829Generation of the bibliography can be suppressed by setting
4830`suppress-bibliography: true` in the YAML metadata.
4832If you wish the bibliography to have a section heading, you can
4833set `reference-section-title` in the metadata, or put the heading
4834at the beginning of the div with id `refs` (if you are using it)
4835or at the end of your document:
4841The bibliography will be inserted after this heading. Note that
4842the `unnumbered` class will be added to this heading, so that the
4843section will not be numbered.
4845If you want to include items in the bibliography without actually
4846citing them in the body text, you can define a dummy `nocite` metadata
4847field and put the citations there:
4856In this example, the document will contain a citation for `item3`
4857only, but the bibliography will contain entries for `item1`, `item2`, and
4860It is possible to create a bibliography with all the citations,
4861whether or not they appear in the document, by using a wildcard:
4868For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4869render the bibliography. In order to do so, specify bibliography
4870files as outlined above, and add `--natbib` or `--biblatex`
4871argument to `pandoc` invocation. Bear in mind that bibliography
4872files have to be in respective format (either BibTeX or
4875For more information, see the [pandoc-citeproc man page].
4877[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4878[Chicago Manual of Style]: http://chicagomanualofstyle.org
4879[Citation Style Language]: http://citationstyles.org
4880[Zotero Style Repository]: https://www.zotero.org/styles
4881[finding and editing styles]: https://citationstyles.org/authors/
4882[CSL locale files]: https://github.com/citation-style-language/locales
4883[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4885## Non-pandoc extensions
4887The following Markdown syntax extensions are not enabled by default
4888in pandoc, but may be enabled by adding `+EXTENSION` to the format
4889name, where `EXTENSION` is the name of the extension. Thus, for
4890example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4892#### Extension: `old_dashes` ####
4894Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4895`-` before a numeral is an en-dash, and `--` is an em-dash.
4896This option only has an effect if `smart` is enabled. It is
4897selected automatically for `textile` input.
4899#### Extension: `angle_brackets_escapable` ####
4901Allow `<` and `>` to be backslash-escaped, as they can be in
4902GitHub flavored Markdown but not original Markdown. This is
4903implied by pandoc's default `all_symbols_escapable`.
4905#### Extension: `lists_without_preceding_blankline` ####
4907Allow a list to occur right after a paragraph, with no intervening
4910#### Extension: `four_space_rule` ####
4912Selects the pandoc <= 2.0 behavior for parsing lists, so that
4913four spaces indent are needed for list item continuation
4916#### Extension: `spaced_reference_links` ####
4918Allow whitespace between the two components of a reference link,
4923#### Extension: `hard_line_breaks` ####
4925Causes all newlines within a paragraph to be interpreted as hard line
4926breaks instead of spaces.
4928#### Extension: `ignore_line_breaks` ####
4930Causes newlines within a paragraph to be ignored, rather than being
4931treated as spaces or as hard line breaks. This option is intended for
4932use with East Asian languages where spaces are not used between words,
4933but text is divided into lines for readability.
4935#### Extension: `east_asian_line_breaks` ####
4937Causes newlines within a paragraph to be ignored, rather than
4938being treated as spaces or as hard line breaks, when they occur
4939between two East Asian wide characters. This is a better choice
4940than `ignore_line_breaks` for texts that include a mix of East
4941Asian wide characters and other characters.
4943#### Extension: `emoji` ####
4945Parses textual emojis like `:smile:` as Unicode emoticons.
4947#### Extension: `tex_math_single_backslash` ####
4949Causes anything between `\(` and `\)` to be interpreted as inline
4950TeX math, and anything between `\[` and `\]` to be interpreted
4951as display TeX math. Note: a drawback of this extension is that
4952it precludes escaping `(` and `[`.
4954#### Extension: `tex_math_double_backslash` ####
4956Causes anything between `\\(` and `\\)` to be interpreted as inline
4957TeX math, and anything between `\\[` and `\\]` to be interpreted
4960#### Extension: `markdown_attribute` ####
4962By default, pandoc interprets material inside block-level tags as Markdown.
4963This extension changes the behavior so that Markdown is only parsed
4964inside block-level tags if the tags have the attribute `markdown=1`.
4966#### Extension: `mmd_title_block` ####
4968Enables a [MultiMarkdown] style title block at the top of
4969the document, for example:
4973 Date: September 1, 2008
4974 Comment: This is a sample mmd title block, with
4975 a field spanning multiple lines.
4977See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4978`yaml_metadata_block` is enabled, it will take precedence over
4981#### Extension: `abbreviations` ####
4983Parses PHP Markdown Extra abbreviation keys, like
4985 *[HTML]: Hypertext Markup Language
4987Note that the pandoc document model does not support
4988abbreviations, so if this extension is enabled, abbreviation keys are
4989simply skipped (as opposed to being parsed as paragraphs).
4991#### Extension: `autolink_bare_uris` ####
4993Makes all absolute URIs into links, even when not surrounded by
4994pointy braces `<...>`.
4996#### Extension: `mmd_link_attributes` ####
4998Parses multimarkdown style key-value attributes on link
4999and image references. This extension should not be confused with the
5000[`link_attributes`](#extension-link_attributes) extension.
5002 This is a reference ![image][ref] with multimarkdown attributes.
5004 [ref]: http://path.to/image "Image title" width=20px height=30px
5005 id=myId class="myClass1 myClass2"
5007#### Extension: `mmd_header_identifiers` ####
5009Parses multimarkdown style heading identifiers (in square brackets,
5010after the heading but before any trailing `#`s in an ATX heading).
5012#### Extension: `compact_definition_lists` ####
5014Activates the definition list syntax of pandoc 1.12.x and earlier.
5015This syntax differs from the one described above under [Definition lists]
5018 - No blank line is required between consecutive items of the
5020 - To get a "tight" or "compact" list, omit space between consecutive
5021 items; the space between a term and its definition does not affect
5023 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5024 be indented four spaces.[^6]
5026[^6]: To see why laziness is incompatible with relaxing the requirement
5027 of a blank line between items, consider the following example:
5034 Is this a single list item with two definitions of "bar," the first of
5035 which is lazily wrapped, or two list items? To remove the ambiguity
5036 we must either disallow lazy wrapping or require a blank line between
5039#### Extension: `gutenberg` ####
5041Use [Project Gutenberg] conventions for `plain` output:
5042all-caps for strong emphasis, surround by underscores
5043for regular emphasis, add extra blank space around headings.
5045 [Project Gutenberg]: https://www.gutenberg.org
5049In addition to pandoc's extended Markdown, the following Markdown
5050variants are supported:
5052`markdown_phpextra` (PHP Markdown Extra)
5053: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5054 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5055 `header_attributes`, `link_attributes`, `abbreviations`,
5056 `shortcut_reference_links`, `spaced_reference_links`.
5058`markdown_github` (deprecated GitHub-Flavored Markdown)
5059: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5060 `gfm_auto_identifiers`, `backtick_code_blocks`,
5061 `autolink_bare_uris`, `space_in_atx_header`,
5062 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5063 `shortcut_reference_links`, `angle_brackets_escapable`,
5064 `lists_without_preceding_blankline`.
5066`markdown_mmd` (MultiMarkdown)
5067: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5068 `tex_math_double_backslash`, `intraword_underscores`,
5069 `mmd_title_block`, `footnotes`, `definition_lists`,
5070 `all_symbols_escapable`, `implicit_header_references`,
5071 `auto_identifiers`, `mmd_header_identifiers`,
5072 `shortcut_reference_links`, `implicit_figures`,
5073 `superscript`, `subscript`, `backtick_code_blocks`,
5074 `spaced_reference_links`, `raw_attribute`.
5076`markdown_strict` (Markdown.pl)
5077: `raw_html`, `shortcut_reference_links`,
5078 `spaced_reference_links`.
5080We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5081which is implemented as a set of extensions on `commonmark`).
5083Note, however, that `commonmark` and `gfm` have limited support
5084for extensions. Only those listed below (and `smart`,
5085`raw_tex`, and `hard_line_breaks`) will work. The extensions
5086can, however, all be individually disabled. Also, `raw_tex`
5087only affects `gfm` output, not input.
5089`gfm` (GitHub-Flavored Markdown)
5090: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5091 `gfm_auto_identifiers`, `backtick_code_blocks`,
5092 `autolink_bare_uris`, `space_in_atx_header`,
5093 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5094 `shortcut_reference_links`, `angle_brackets_escapable`,
5095 `lists_without_preceding_blankline`.
5098# Producing slide shows with pandoc
5100You can use pandoc to produce an HTML + JavaScript slide presentation
5101that can be viewed via a web browser. There are five ways to do this,
5102using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5103You can also produce a PDF slide show using LaTeX [`beamer`], or
5104slides shows in Microsoft [PowerPoint] format.
5106Here's the Markdown source for a simple slide show, `habits.txt`:
5133 
5140To produce an HTML/JavaScript slide show, simply type
5142 pandoc -t FORMAT -s habits.txt -o habits.html
5144where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5146For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5147`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5148assumed to be available at the relative path `s5/default` (for S5), `slideous`
5149(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5150`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5151`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5152above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5155With all HTML slide formats, the `--self-contained` option can be used to
5156produce a single file that contains all of the data necessary to display the
5157slide show, including linked scripts, stylesheets, images, and videos.
5159To produce a PDF slide show using beamer, type
5161 pandoc -t beamer habits.txt -o habits.pdf
5163Note that a reveal.js slide show can also be converted to a PDF
5164by printing it to a file from the browser.
5166To produce a Powerpoint slide show, type
5168 pandoc habits.txt -o habits.pptx
5170## Structuring the slide show
5172By default, the *slide level* is the highest heading level in
5173the hierarchy that is followed immediately by content, and not another
5174heading, somewhere in the document. In the example above, level-1 headings
5175are always followed by level-2 headings, which are followed by content,
5176so the slide level is 2. This default can be overridden using
5177the `--slide-level` option.
5179The document is carved up into slides according to the following
5182 * A horizontal rule always starts a new slide.
5184 * A heading at the slide level always starts a new slide.
5186 * Headings *below* the slide level in the hierarchy create
5187 headings *within* a slide.
5189 * Headings *above* the slide level in the hierarchy create
5190 "title slides," which just contain the section title
5191 and help to break the slide show into sections.
5192 Non-slide content under these headings will be included
5193 on the title slide (for HTML slide shows) or in a
5194 subsequent slide with the same title (for beamer).
5196 * A title page is constructed automatically from the document's title
5197 block, if present. (In the case of beamer, this can be disabled
5198 by commenting out some lines in the default template.)
5200These rules are designed to support many different styles of slide show. If
5201you don't care about structuring your slides into sections and subsections,
5202you can just use level-1 headings for all each slide. (In that case, level-1
5203will be the slide level.) But you can also structure the slide show into
5204sections, as in the example above.
5206Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5207layout will be produced, with level-1 headings building horizontally
5208and level-2 headings building vertically. It is not recommended that
5209you use deeper nesting of section levels with reveal.js.
5213By default, these writers produce lists that display "all at once."
5214If you want your lists to display incrementally (one item at a time),
5215use the `-i` option. If you want a particular list to depart from the
5216default, put it in a `div` block with class `incremental` or
5217`nonincremental`. So, for example, using the `fenced div` syntax, the
5218following would be incremental regardless of the document default:
5236While using `incremental` and `nonincremental` divs are the
5237recommended method of setting incremental lists on a per-case basis,
5238an older method is also supported: putting lists inside a blockquote
5239will depart from the document default (that is, it will display
5240incrementally without the `-i` option and all at once with the `-i`
5246Both methods allow incremental and nonincremental lists to be mixed
5247in a single document.
5249Note: Neither the `-i/--incremental` option nor any of the
5250methods described here currently works for PowerPoint output.
5254You can add "pauses" within a slide by including a paragraph containing
5255three dots, separated by spaces:
5257 # Slide with a pause
5259 content before the pause
5263 content after the pause
5265Note: this feature is not yet implemented for PowerPoint output.
5267## Styling the slides
5269You can change the style of HTML slides by putting customized CSS files
5270in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5271or `$DATADIR/slideous` (for Slideous),
5272where `$DATADIR` is the user data directory (see `--data-dir`, above).
5273The originals may be found in pandoc's system data directory (generally
5274`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5275files it does not find in the user data directory.
5277For dzslides, the CSS is included in the HTML file itself, and may
5280All [reveal.js configuration options] can be set through variables.
5281For example, themes can be used by setting the `theme` variable:
5285Or you can specify a custom stylesheet using the `--css` option.
5287To style beamer slides, you can specify a `theme`, `colortheme`,
5288`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5290 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5292Note that heading attributes will turn into slide attributes
5293(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5294to style individual slides. In beamer, the only heading attribute
5295that affects slides is the `allowframebreaks` class, which sets the
5296`allowframebreaks` option, causing multiple slides to be created
5297if the content overfills the frame. This is recommended especially for
5300 # References {.allowframebreaks}
5304Speaker notes are supported in reveal.js and PowerPoint (pptx)
5305output. You can add notes to your Markdown document thus:
5311 - It can contain Markdown
5316To show the notes window in reveal.js, press `s` while viewing the
5317presentation. Speaker notes in PowerPoint will be available, as usual,
5318in handouts and presenter view.
5320Notes are not yet supported for other slide formats, but the notes
5321will not appear on the slides themselves.
5325To put material in side by side columns, you can use a native
5326div container with class `columns`, containing two or more div
5327containers with class `column` and a `width` attribute:
5329 :::::::::::::: {.columns}
5330 ::: {.column width="40%"}
5333 ::: {.column width="60%"}
5338## Frame attributes in beamer
5340Sometimes it is necessary to add the LaTeX `[fragile]` option to
5341a frame in beamer (for example, when using the `minted` environment).
5342This can be forced by adding the `fragile` class to the heading
5343introducing the slide:
5345 # Fragile slide {.fragile}
5347All of the other frame attributes described in Section 8.1 of
5348the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5349`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5350`shrink`, `standout`, `noframenumbering`.
5352## Background in reveal.js and beamer
5354Background images can be added to self-contained reveal.js slideshows and
5355to beamer slideshows.
5357For the same image on every slide, use the configuration
5358option `background-image` either in the YAML metadata block
5359or as a command-line variable. (There are no other options in
5360beamer and the rest of this section concerns reveal.js slideshows.)
5362For reveal.js, you can instead use the reveal.js-native option
5363`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5364and `parallaxBackgroundVertical` the same way and must also set
5365`parallaxBackgroundSize` to have your values take effect.
5367To set an image for a particular reveal.js slide, add
5368`{data-background-image="/path/to/image"}`
5369to the first slide-level heading on the slide (which may even be empty).
5371In reveal.js's overview mode, the parallaxBackgroundImage will show up
5372only on the first slide.
5374Other reveal.js background settings also work on individual slides, including
5375`data-background-size`, `data-background-repeat`, `data-background-color`,
5376`data-transition`, and `data-transition-speed`.
5378To add a background image to the automatically generated title slide, use the
5379`title-slide-attributes` variable in the YAML metadata block. It must contain
5380a map of attribute names and values.
5383documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5386For example in reveal.js:
5391parallaxBackgroundImage: /path/to/my/background_image.png
5392title-slide-attributes:
5393 data-background-image: /path/to/title_image.png
5394 data-background-size: contain
5399Slide 1 has background_image.png as its background.
5401## {data-background-image="/path/to/special_image.jpg"}
5403Slide 2 has a special image for its background, even though the heading has no content.
5406# Creating EPUBs with pandoc
5410EPUB metadata may be specified using the `--epub-metadata` option, but
5411if the source document is Markdown, it is better to use a [YAML metadata
5412block][Extension: `yaml_metadata_block`]. Here is an example:
5419 text: An investigation of metadata
5427 text: doi:10.234234.234/33
5429 rights: © 2007 John Smith, CC BY-NC
5434The following fields are recognized:
5437 ~ Either a string value or an object with fields `text` and
5438 `scheme`. Valid values for `scheme` are `ISBN-10`,
5439 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5440 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5441 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5444 ~ Either a string value, or an object with fields `file-as` and
5445 `type`, or a list of such objects. Valid values for `type` are
5446 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5449 ~ Either a string value, or an object with fields `role`, `file-as`,
5450 and `text`, or a list of such objects. Valid values for `role` are
5451 [MARC relators], but
5452 pandoc will attempt to translate the human-readable versions
5453 (like "author" and "editor") to the appropriate marc relators.
5456 ~ Same format as `creator`.
5459 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5460 Pandoc will attempt to convert other common date formats.
5462`lang` (or legacy: `language`)
5463 ~ A string value in [BCP 47] format. Pandoc will default to the local
5464 language if nothing is specified.
5467 ~ A string value or a list of such values.
5488 ~ A string value (path to cover image).
5490`css` (or legacy: `stylesheet`)
5491 ~ A string value (path to CSS stylesheet).
5493`page-progression-direction`
5494 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5495 attribute for the [`spine` element].
5498 ~ iBooks-specific metadata, with the following fields:
5500 - `version`: (string)
5501 - `specified-fonts`: `true`|`false` (default `false`)
5502 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5503 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5504 - `binding`: `true`|`false` (default `true`)
5505 - `scroll-axis`: `vertical`|`horizontal`|`default`
5507[MARC relators]: http://loc.gov/marc/relators/relaterm.html
5508[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5510## The `epub:type` attribute
5512For `epub3` output, you can mark up the heading that corresponds to an EPUB
5513chapter using the [`epub:type` attribute][epub-type]. For example, to set
5514the attribute to the value `prologue`, use this markdown:
5516 # My chapter {epub:type=prologue}
5518Which will result in:
5520 <body epub:type="frontmatter">
5521 <section epub:type="prologue">
5524Pandoc will output `<body epub:type="bodymatter">`, unless
5525you use one of the following values, in which case either
5526`frontmatter` or `backmatter` will be output.
5528`epub:type` of first section `epub:type` of body
5529---------------------------- ------------------
5532acknowledgments frontmatter
5533copyright-page frontmatter
5534dedication frontmatter
5538contributors frontmatter
5539other-credits frontmatter
5541revision-history frontmatter
5542titlepage frontmatter
5543halftitlepage frontmatter
5544seriespage frontmatter
5547seriespage frontmatter
5548titlepage frontmatter
5551bibliography backmatter
5554[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5558By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5559`<video>` or `<source>` element present in the generated EPUB,
5560and include it in the EPUB container, yielding a completely
5561self-contained EPUB. If you want to link to external media resources
5562instead, use raw HTML in your source and add `data-external="1"` to the tag
5563with the `src` attribute. For example:
5565 <audio controls="1">
5566 <source src="http://example.com/music/toccata.mp3"
5567 data-external="1" type="audio/mpeg">
5571# Creating Jupyter notebooks with pandoc
5573When creating a [Jupyter notebook], pandoc will try to infer the
5574notebook structure. Code blocks with the class `code` will be
5575taken as code cells, and intervening content will be taken as
5576Markdown cells. Attachments will automatically be created for
5577images in Markdown cells. Metadata will be taken from the
5578`jupyter` metadata field. For example:
5587 display_name: Python 2
5594 file_extension: ".py"
5595 mimetype: "text/x-python"
5597 nbconvert_exporter: "python"
5598 pygments_lexer: "ipython2"
5604**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5605bibendum felis dictum sodales.
5614from IPython.display import HTML
5617console.log("hello");
5625This image  will be
5626included as a cell attachment.
5629If you want to add cell attributes, group cells differently, or
5630add output to code cells, then you need to include divs to
5631indicate the structure. You can use either [fenced
5632divs][Extension: `fenced_divs`] or [native divs][Extension:
5633`native_divs`] for this. Here is an example:
5636:::::: {.cell .markdown}
5639**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5640bibendum felis dictum sodales.
5643:::::: {.cell .code execution_count=1}
5648::: {.output .stream .stdout}
5655:::::: {.cell .code execution_count=2}
5657from IPython.display import HTML
5660console.log("hello");
5666::: {.output .execute_result execution_count=2}
5669console.log("hello");
5678If you include raw HTML or TeX in an output cell, use the
5679[raw attribute][Extension: `fenced_attribute`], as shown
5680in the last cell of the example above. Although pandoc can
5681process "bare" raw HTML and TeX, the result is often
5682interspersed raw elements and normal textual elements, and
5683in an output cell pandoc expects a single, connected raw
5684block. To avoid using raw HTML or TeX except when
5685marked explicitly using raw attributes, we recommend
5686specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5687translating between Markdown and ipynb notebooks.
5689Note that options and extensions that affect reading and
5690writing of Markdown will also affect Markdown cells in ipynb
5691notebooks. For example, `--wrap=preserve` will preserve
5692soft line breaks in Markdown cells; `--atx-headers` will
5693cause ATX-style headings to be used; and `--preserve-tabs` will
5694prevent tabs from being turned to spaces.
5696# Syntax highlighting
5698Pandoc will automatically highlight syntax in [fenced code blocks] that
5699are marked with a language name. The Haskell library [skylighting] is
5700used for highlighting. Currently highlighting is supported only for
5701HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5702that pandoc will recognize, type `pandoc --list-highlight-languages`.
5704The color scheme can be selected using the `--highlight-style` option.
5705The default color scheme is `pygments`, which imitates the default color
5706scheme used by the Python library pygments (though pygments is not actually
5707used to do the highlighting). To see a list of highlight styles,
5708type `pandoc --list-highlight-styles`.
5710If you are not satisfied with the predefined styles, you can
5711use `--print-highlight-style` to generate a JSON `.theme` file which
5712can be modified and used as the argument to `--highlight-style`. To
5713get a JSON version of the `pygments` style, for example:
5715 pandoc --print-highlight-style pygments > my.theme
5717Then edit `my.theme` and use it like this:
5719 pandoc --highlight-style my.theme
5721If you are not satisfied with the built-in highlighting, or you
5722want highlight a language that isn't supported, you can use the
5723`--syntax-definition` option to load a [KDE-style XML syntax definition
5724file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5725Before writing your own, have a look at KDE's [repository of syntax
5726definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5728To disable highlighting, use the `--no-highlight` option.
5730[skylighting]: https://github.com/jgm/skylighting
5734Custom styles can be used in the docx and ICML formats.
5738By default, pandoc's docx and ICML output applies a predefined set of styles
5739for blocks such as paragraphs and block quotes, and uses largely default
5740formatting (italics, bold) for inlines. This will work for most
5741purposes, especially alongside a `reference.docx` file. However, if you
5742need to apply your own styles to blocks, or match a preexisting set of
5743styles, pandoc allows you to define custom styles for blocks and text
5744using `div`s and `span`s, respectively.
5746If you define a `div` or `span` with the attribute `custom-style`,
5747pandoc will apply your specified style to the contained elements (with
5748the exception of elements whose function depends on a style, like
5749headings, code blocks, block quotes, or links). So, for example, using
5750the `bracketed_spans` syntax,
5752 [Get out]{custom-style="Emphatically"}, he said.
5754would produce a docx file with "Get out" styled with character
5755style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5757 Dickinson starts the poem simply:
5759 ::: {custom-style="Poetry"}
5760 | A Bird came down the Walk---
5761 | He did not know I saw---
5764would style the two contained lines with the `Poetry` paragraph style.
5766For docx output, styles will be defined in the output file as inheriting
5767from normal text, if the styles are not yet in your reference.docx.
5768If they are already defined, pandoc will not alter the definition.
5770This feature allows for greatest customization in conjunction with
5771[pandoc filters]. If you want all paragraphs after block quotes to be
5772indented, you can write a filter to apply the styles necessary. If you
5773want all italics to be transformed to the `Emphasis` character style
5774(perhaps to change their color), you can write a filter which will
5775transform all italicized inlines to inlines within an `Emphasis`
5778For docx output, you don't need to enable any extensions for
5779custom styles to work.
5781[pandoc filters]: http://pandoc.org/filters.html
5785The docx reader, by default, only reads those styles that it can
5786convert into pandoc elements, either by direct conversion or
5787interpreting the derivation of the input document's styles.
5789By enabling the [`styles` extension](#ext-styles) in the docx reader
5790(`-f docx+styles`), you can produce output that maintains the styles
5791of the input document, using the `custom-style` class. Paragraph
5792styles are interpreted as divs, while character styles are interpreted
5795For example, using the `custom-style-reference.docx` file in the test
5796directory, we have the following different outputs:
5798Without the `+styles` extension:
5800 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5803 This is text with an *emphasized* text style. And this is text with a
5804 **strengthened** text style.
5806 > Here is a styled paragraph that inherits from Block Text.
5808And with the extension:
5810 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5812 ::: {custom-style="First Paragraph"}
5816 ::: {custom-style="Body Text"}
5817 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5818 And this is text with a [strengthened]{custom-style="Strengthened"}
5822 ::: {custom-style="My Block Style"}
5823 > Here is a styled paragraph that inherits from Block Text.
5826With these custom styles, you can use your input document as a
5827reference-doc while creating docx output (see below), and maintain the
5828same styles in your input and output files.
5832Pandoc can be extended with custom writers written in [lua]. (Pandoc
5833includes a lua interpreter, so lua need not be installed separately.)
5835To use a custom writer, simply specify the path to the lua script
5836in place of the output format. For example:
5838 pandoc -t data/sample.lua
5840Creating a custom writer requires writing a lua function for each
5841possible element in a pandoc document. To get a documented example
5842which you can modify according to your needs, do
5844 pandoc --print-default-data-file sample.lua
5846Note that custom writers have no default template. If you want
5847to use `--standalone` with a custom writer, you will need to
5848specify a template manually using `--template` or add a new
5849default template with the name
5850`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5851subdirectory of your user data directory (see [Templates]).
5853[lua]: http://www.lua.org
5857If you use pandoc to convert user-contributed content in a web
5858application, here are some things to keep in mind:
58601. Although pandoc itself will not create or modify any files other
5861 than those you explicitly ask it create (with the exception
5862 of temporary files used in producing PDFs), a filter or custom
5863 writer could in principle do anything on your file system. Please
5864 audit filters and custom writers very carefully before using them.
58662. If your application uses pandoc as a Haskell library (rather than
5867 shelling out to the executable), it is possible to use it in a mode
5868 that fully isolates pandoc from your file system, by running the
5869 pandoc operations in the `PandocPure` monad. See the document
5870 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
58733. Pandoc's parsers can exhibit pathological performance on some
5874 corner cases. It is wise to put any pandoc operations under
5875 a timeout, to avoid DOS attacks that exploit these issues.
5876 If you are using the pandoc executable, you can add the
5877 command line options `+RTS -M512M -RTS` (for example) to limit
5878 the heap size to 512MB.
58804. The HTML generated by pandoc is not guaranteed to be safe.
5881 If `raw_html` is enabled for the Markdown input, users can
5882 inject arbitrary HTML. Even if `raw_html` is disabled,
5883 users can include dangerous content in attributes for
5884 headings, spans, and code blocks. To be safe, you should
5885 run all the generated HTML through an HTML sanitizer.
5889Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5890under the [GPL], version 2 or greater. This software carries no
5891warranty of any kind. (See COPYRIGHT for full copyright and
5892warranty notices.) For a full list of contributors, see the file
5893AUTHORS.md in the pandoc source code.
5895[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5896[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"
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