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 - `json` (JSON version of native AST)
245 - `markdown` ([Pandoc's Markdown])
246 - `markdown_mmd` ([MultiMarkdown])
247 - `markdown_phpextra` ([PHP Markdown Extra])
248 - `markdown_strict` (original unextended [Markdown])
249 - `mediawiki` ([MediaWiki markup])
252 - `native` (native Haskell)
255 - `org` ([Emacs Org mode])
256 - `rst` ([reStructuredText])
258 - `textile` ([Textile])
259 - `tikiwiki` ([TikiWiki markup])
260 - `twiki` ([TWiki markup])
261 - `vimwiki` ([Vimwiki])
264 Extensions can be individually enabled or disabled by
265 appending `+EXTENSION` or `-EXTENSION` to the format name.
266 See [Extensions] below, for a list of extensions and
267 their names. See `--list-input-formats` and `--list-extensions`,
270`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
272: Specify output format. *FORMAT* can be:
274 ::: {#output-formats}
275 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
276 - `beamer` ([LaTeX beamer][`beamer`] slide show)
277 - `commonmark` ([CommonMark] Markdown)
278 - `context` ([ConTeXt])
279 - `docbook` or `docbook4` ([DocBook] 4)
280 - `docbook5` (DocBook 5)
281 - `docx` ([Word docx])
282 - `dokuwiki` ([DokuWiki markup])
283 - `epub` or `epub3` ([EPUB] v3 book)
285 - `fb2` ([FictionBook2] e-book)
286 - `gfm` ([GitHub-Flavored Markdown]),
287 or the deprecated and less accurate `markdown_github`;
288 use [`markdown_github`](#markdown-variants) only
289 if you need extensions not supported in [`gfm`](#markdown-variants).
290 - `haddock` ([Haddock markup])
291 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
292 - `html4` ([XHTML] 1.0 Transitional)
293 - `icml` ([InDesign ICML])
294 - `ipynb` ([Jupyter notebook])
295 - `jats` ([JATS] XML)
296 - `jira` ([Jira] wiki markup)
297 - `json` (JSON version of native AST)
300 - `markdown` ([Pandoc's Markdown])
301 - `markdown_mmd` ([MultiMarkdown])
302 - `markdown_phpextra` ([PHP Markdown Extra])
303 - `markdown_strict` (original unextended [Markdown])
304 - `mediawiki` ([MediaWiki markup])
307 - `native` (native Haskell),
308 - `odt` ([OpenOffice text document][ODT])
310 - `opendocument` ([OpenDocument])
311 - `org` ([Emacs Org mode])
313 - `plain` (plain text),
314 - `pptx` ([PowerPoint] slide show)
315 - `rst` ([reStructuredText])
316 - `rtf` ([Rich Text Format])
317 - `texinfo` ([GNU Texinfo])
318 - `textile` ([Textile])
319 - `slideous` ([Slideous] HTML and JavaScript slide show)
320 - `slidy` ([Slidy] HTML and JavaScript slide show)
321 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
322 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
323 - `s5` ([S5] HTML and JavaScript slide show)
324 - `tei` ([TEI Simple])
325 - `xwiki` ([XWiki markup])
326 - `zimwiki` ([ZimWiki markup])
327 - the path of a custom lua writer, see [Custom writers] below
330 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
331 to *stdout* unless forced with `-o -`.
333 Extensions can be individually enabled or
334 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
335 name. See [Extensions] below, for a list of extensions and their
336 names. See `--list-output-formats` and `--list-extensions`, below.
338`-o` *FILE*, `--output=`*FILE*
340: Write output to *FILE* instead of *stdout*. If *FILE* is
341 `-`, output will go to *stdout*, even if a non-textual format
342 (`docx`, `odt`, `epub2`, `epub3`) is specified.
344`--data-dir=`*DIRECTORY*
346: Specify the user data directory to search for pandoc data files.
347 If this option is not specified, the default user data directory
348 will be used. On \*nix and macOS systems this will be the `pandoc`
349 subdirectory of the XDG data directory (by default,
350 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
351 environment variable). If that directory does not exist,
352 `$HOME/.pandoc` will be used (for backwards compatibility).
353 In Windows the default user data directory is
354 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
355 You can find the default user data directory on your system by
356 looking at the output of `pandoc --version`.
357 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
358 `slidy`, `slideous`, or `s5` directory
359 placed in this directory will override pandoc's normal defaults.
361`-d` *FILE*, `--defaults=`*FILE*
363: Specify a set of default option settings. *FILE* is a YAML
364 file whose fields correspond to command-line option
365 settings. All options for document conversion, including input
366 and output files, can be set using a defaults file. The file will
367 be searched for first in the working directory, and then in
368 the `defaults` subdirectory of the user data directory
369 (see `--data-dir`). The `.yaml` extension may be omitted.
370 See the section [Default files] for more information on the
371 file format. Settings from the defaults file may be
372 overridden or extended by subsequent options on the command
377: Generate a bash completion script. To enable bash completion
378 with pandoc, add this to your `.bashrc`:
380 eval "$(pandoc --bash-completion)"
384: Give verbose debugging output. Currently this only has an effect
389: Suppress warning messages.
393: Exit with error status if there are any warnings.
397: Write log messages in machine-readable JSON format to
398 *FILE*. All messages above DEBUG level will be written,
399 regardless of verbosity settings (`--verbose`, `--quiet`).
401`--list-input-formats`
403: List supported input formats, one per line.
405`--list-output-formats`
407: List supported output formats, one per line.
409`--list-extensions`[`=`*FORMAT*]
411: List supported extensions for *FORMAT*, one per line, preceded
412 by a `+` or `-` indicating whether it is enabled by default
413 in *FORMAT*. If *FORMAT* is not specified, defaults for
414 pandoc's Markdown are given.
416`--list-highlight-languages`
418: List supported languages for syntax highlighting, one per
421`--list-highlight-styles`
423: List supported styles for syntax highlighting, one per line.
424 See `--highlight-style`.
434[Markdown]: http://daringfireball.net/projects/markdown/
435[CommonMark]: http://commonmark.org
436[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
437[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
438[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
439[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
440[S5]: http://meyerweb.com/eric/tools/s5/
441[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
442[Slideous]: http://goessner.net/articles/slideous/
443[HTML]: http://www.w3.org/html/
444[HTML5]: http://www.w3.org/TR/html5/
445[polyglot markup]: https://www.w3.org/TR/html-polyglot/
446[XHTML]: http://www.w3.org/TR/xhtml1/
447[LaTeX]: http://latex-project.org
448[`beamer`]: https://ctan.org/pkg/beamer
449[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
450[ConTeXt]: http://www.contextgarden.net/
451[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
452[DocBook]: http://docbook.org
453[JATS]: https://jats.nlm.nih.gov
454[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
455[txt2tags]: http://txt2tags.org
456[EPUB]: http://idpf.org/epub
457[OPML]: http://dev.opml.org/spec2.html
458[OpenDocument]: http://opendocument.xml.org
459[ODT]: http://en.wikipedia.org/wiki/OpenDocument
460[Textile]: http://redcloth.org/textile
461[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
462[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
463[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
464[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
465[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
466[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
467[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
468[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
469[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
470[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
471[Haskell]: https://www.haskell.org
472[GNU Texinfo]: http://www.gnu.org/software/texinfo/
473[Emacs Org mode]: http://orgmode.org
474[AsciiDoc]: http://www.methods.co.nz/asciidoc/
475[AsciiDoctor]: https://asciidoctor.org/
476[DZSlides]: http://paulrouget.com/dzslides/
477[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
478[PDF]: https://www.adobe.com/pdf/
479[reveal.js]: http://lab.hakim.se/reveal-js/
480[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
481[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
482[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
483[TEI Simple]: https://github.com/TEIC/TEI-Simple
484[Muse]: https://amusewiki.org/library/manual
485[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
486[Vimwiki]: https://vimwiki.github.io
488## Reader options {.options}
490`--shift-heading-level-by=`*NUMBER*
492: Shift heading levels by a positive or negative integer.
493 For example, with `--shift-heading-level-by=-1`, level 2
494 headings become level 1 headings, and level 3 headings
495 become level 2 headings. Headings cannot have a level
496 less than 1, so a heading that would be shifted below level 1
497 becomes a regular paragraph. Exception: with a shift of -N,
498 a level-N heading at the beginning of the document
499 replaces the metadata title. `--shift-heading-level-by=-1`
500 is a good choice when converting HTML or Markdown documents that
501 use an initial level-1 heading for the document title and
502 level-2+ headings for sections. `--shift-heading-level-by=1`
503 may be a good choice for converting Markdown documents that
504 use level-1 headings for sections to HTML, since pandoc uses
505 a level-1 heading to render the document title.
507`--base-header-level=`*NUMBER*
509: *Deprecated. Use `--shift-heading-level-by` instead.*
510 Specify the base level for headings (defaults to 1).
512`--strip-empty-paragraphs`
514: *Deprecated. Use the `+empty_paragraphs` extension instead.*
515 Ignore paragraphs with no content. This option is useful
516 for converting word processing documents where users have
517 used empty paragraphs to create inter-paragraph space.
519`--indented-code-classes=`*CLASSES*
521: Specify classes to use for indented code blocks--for example,
522 `perl,numberLines` or `haskell`. Multiple classes may be separated
525`--default-image-extension=`*EXTENSION*
527: Specify a default extension to use when image paths/URLs have no
528 extension. This allows you to use the same source for formats that
529 require different kinds of images. Currently this option only affects
530 the Markdown and LaTeX readers.
534: Parse each file individually before combining for multifile
535 documents. This will allow footnotes in different files with the
536 same identifiers to work as expected. If this option is set,
537 footnotes and links will not work across files. Reading binary
538 files (docx, odt, epub) implies `--file-scope`.
540`-F` *PROGRAM*, `--filter=`*PROGRAM*
542: Specify an executable to be used as a filter transforming the
543 pandoc AST after the input is parsed and before the output is
544 written. The executable should read JSON from stdin and write
545 JSON to stdout. The JSON must be formatted like pandoc's own
546 JSON input and output. The name of the output format will be
547 passed to the filter as the first argument. Hence,
549 pandoc --filter ./caps.py -t latex
553 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
555 The latter form may be useful for debugging filters.
557 Filters may be written in any language. `Text.Pandoc.JSON`
558 exports `toJSONFilter` to facilitate writing filters in Haskell.
559 Those who would prefer to write filters in python can use the
560 module [`pandocfilters`], installable from PyPI. There are also
561 pandoc filter libraries in [PHP], [perl], and
562 [JavaScript/node.js].
564 In order of preference, pandoc will look for filters in
566 1. a specified full or relative path (executable or
569 2. `$DATADIR/filters` (executable or non-executable)
570 where `$DATADIR` is the user data directory (see
571 `--data-dir`, above).
573 3. `$PATH` (executable only)
575 Filters and lua-filters are applied in the order specified
578`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
580: Transform the document in a similar fashion as JSON filters (see
581 `--filter`), but use pandoc's build-in lua filtering system. The given
582 lua script is expected to return a list of lua filters which will be
583 applied in order. Each lua filter must contain element-transforming
584 functions indexed by the name of the AST element on which the filter
585 function should be applied.
587 The `pandoc` lua module provides helper functions for element
588 creation. It is always loaded into the script's lua environment.
590 The following is an example lua script for macro-expansion:
592 function expand_hello_world(inline)
593 if inline.c == '{{helloworld}}' then
594 return pandoc.Emph{ pandoc.Str "Hello, World" }
600 return {{Str = expand_hello_world}}
602 In order of preference, pandoc will look for lua filters in
604 1. a specified full or relative path (executable or
607 2. `$DATADIR/filters` (executable or non-executable)
608 where `$DATADIR` is the user data directory (see
609 `--data-dir`, above).
611`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
613: Set the metadata field *KEY* to the value *VAL*. A value specified
614 on the command line overrides a value specified in the document
615 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
616 Values will be parsed as YAML boolean or string values. If no value is
617 specified, the value will be treated as Boolean true. Like
618 `--variable`, `--metadata` causes template variables to be set.
619 But unlike `--variable`, `--metadata` affects the metadata of the
620 underlying document (which is accessible from filters and may be
621 printed in some output formats) and metadata values will be escaped
622 when inserted into the template.
624`--metadata-file=`*FILE*
626: Read metadata from the supplied YAML (or JSON) file. This
627 option can be used with every input format, but string scalars
628 in the YAML file will always be parsed as Markdown. Generally,
629 the input will be handled the same as in [YAML metadata
630 blocks][Extension: `yaml_metadata_block`]. This option can be
631 used repeatedly to include multiple metadata files; values in
632 files specified later on the command line will be preferred
633 over those specified in earlier files. Metadata values
634 specified inside the document, or by using `-M`, overwrite
635 values specified with this option.
637`-p`, `--preserve-tabs`
639: Preserve tabs instead of converting them to spaces. (By default, pandoc
640 converts tabs to spaces before parsing its input.) Note that this will
641 only affect tabs in literal code spans and code blocks. Tabs in regular
642 text are always treated as spaces.
646: Specify the number of spaces per tab (default is 4).
648`--track-changes=accept`|`reject`|`all`
650: Specifies what to do with insertions, deletions, and comments
651 produced by the MS Word "Track Changes" feature. `accept` (the
652 default), inserts all insertions, and ignores all
653 deletions. `reject` inserts all deletions and ignores
654 insertions. Both `accept` and `reject` ignore comments. `all` puts
655 in insertions, deletions, and comments, wrapped in spans with
656 `insertion`, `deletion`, `comment-start`, and `comment-end`
657 classes, respectively. The author and time of change is
658 included. `all` is useful for scripting: only accepting changes
659 from a certain reviewer, say, or before a certain date. If a
660 paragraph is inserted or deleted, `track-changes=all` produces a
661 span with the class `paragraph-insertion`/`paragraph-deletion`
662 before the affected paragraph break. This option only affects the
665`--extract-media=`*DIR*
667: Extract images and other media contained in or linked from
668 the source document to the path *DIR*, creating it if
669 necessary, and adjust the images references in the document
670 so they point to the extracted files. If the source format is
671 a binary container (docx, epub, or odt), the media is
672 extracted from the container and the original
673 filenames are used. Otherwise the media is read from the
674 file system or downloaded, and new filenames are constructed
675 based on SHA1 hashes of the contents.
677`--abbreviations=`*FILE*
679: Specifies a custom abbreviations file, with abbreviations
680 one to a line. If this option is not specified, pandoc will
681 read the data file `abbreviations` from the user data
682 directory or fall back on a system default. To see the
684 `pandoc --print-default-data-file=abbreviations`. The only
685 use pandoc makes of this list is in the Markdown reader.
686 Strings ending in a period that are found in this list will
687 be followed by a nonbreaking space, so that the period will
688 not produce sentence-ending space in formats like LaTeX.
690[`pandocfilters`]: https://github.com/jgm/pandocfilters
691[PHP]: https://github.com/vinai/pandocfilters-php
692[perl]: https://metacpan.org/pod/Pandoc::Filter
693[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
695## General writer options {.options}
699: Produce output with an appropriate header and footer (e.g. a
700 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
701 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
702 output. For `native` output, this option causes metadata to
703 be included; otherwise, metadata is suppressed.
705`--template=`*FILE*|*URL*
707: Use the specified file as a custom template for the generated document.
708 Implies `--standalone`. See [Templates], below, for a description
709 of template syntax. If no extension is specified, an extension
710 corresponding to the writer will be added, so that `--template=special`
711 looks for `special.html` for HTML output. If the template is not
712 found, pandoc will search for it in the `templates` subdirectory of
713 the user data directory (see `--data-dir`). If this option is not used,
714 a default template appropriate for the output format will be used (see
715 `-D/--print-default-template`).
717`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
719: Set the template variable *KEY* to the value *VAL* when rendering the
720 document in standalone mode. If no *VAL* is specified, the
721 key will be given the value `true`.
723`-D` *FORMAT*, `--print-default-template=`*FORMAT*
725: Print the system default template for an output *FORMAT*. (See `-t`
726 for a list of possible *FORMAT*s.) Templates in the user data
727 directory are ignored. This option may be used with
728 `-o`/`--output` to redirect output to a file, but
729 `-o`/`--output` must come before `--print-default-template`
732 Note that some of the default templates use partials, for
733 example `styles.html`. To print the partials, use
734 `--print-default-data-file`: for example,
735 `--print-default-data-file=templates/styles.html`.
737`--print-default-data-file=`*FILE*
739: Print a system default data file. Files in the user data directory
740 are ignored. This option may be used with `-o`/`--output` to
741 redirect output to a file, but `-o`/`--output` must come before
742 `--print-default-data-file` on the command line.
744`--eol=crlf`|`lf`|`native`
746: Manually specify line endings: `crlf` (Windows), `lf`
747 (macOS/Linux/UNIX), or `native` (line endings appropriate
748 to the OS on which pandoc is being run). The default is
753: Specify the default dpi (dots per inch) value for conversion
754 from pixels to inch/centimeters and vice versa. (Technically,
755 the correct term would be ppi: pixels per inch.) The default
756 is 96dpi. When images contain information about dpi
757 internally, the encoded value is used instead of the default
758 specified by this option.
760`--wrap=auto`|`none`|`preserve`
762: Determine how text is wrapped in the output (the source
763 code, not the rendered version). With `auto` (the default),
764 pandoc will attempt to wrap lines to the column width specified by
765 `--columns` (default 72). With `none`, pandoc will not wrap
766 lines at all. With `preserve`, pandoc will attempt to
767 preserve the wrapping from the source document (that is,
768 where there are nonsemantic newlines in the source, there
769 will be nonsemantic newlines in the output as well).
770 Automatic wrapping does not currently work in HTML output.
771 In `ipynb` output, this option affects wrapping of the
772 contents of markdown cells.
776: Specify length of lines in characters. This affects text wrapping
777 in the generated source code (see `--wrap`). It also affects
778 calculation of column widths for plain text tables (see [Tables] below).
780`--toc`, `--table-of-contents`
782: Include an automatically generated table of contents (or, in
783 the case of `latex`, `context`, `docx`, `odt`,
784 `opendocument`, `rst`, or `ms`, an instruction to create
785 one) in the output document. This option has no effect
786 unless `-s/--standalone` is used, and it has no effect
787 on `man`, `docbook4`, `docbook5`, or `jats` output.
789 Note that if you are producing a PDF via `ms`, the table
790 of contents will appear at the beginning of the
791 document, before the title. If you would prefer it to
792 be at the end of the document, use the option
793 `--pdf-engine-opt=--no-toc-relocation`.
795`--toc-depth=`*NUMBER*
797: Specify the number of section levels to include in the table
798 of contents. The default is 3 (which means that level-1, 2, and 3
799 headings will be listed in the contents).
803: Strip out HTML comments in the Markdown or Textile source,
804 rather than passing them on to Markdown, Textile or HTML
805 output as raw HTML. This does not apply to HTML comments
806 inside raw HTML blocks when the `markdown_in_html_blocks`
807 extension is not set.
811: Disables syntax highlighting for code blocks and inlines, even when
812 a language attribute is given.
814`--highlight-style=`*STYLE*|*FILE*
816: Specifies the coloring style to be used in highlighted source code.
817 Options are `pygments` (the default), `kate`, `monochrome`,
818 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
819 For more information on syntax highlighting in pandoc, see
820 [Syntax highlighting], below. See also
821 `--list-highlight-styles`.
823 Instead of a *STYLE* name, a JSON file with extension
824 `.theme` may be supplied. This will be parsed as a KDE
825 syntax highlighting theme and (if valid) used as the
828 To generate the JSON version of an existing style,
829 use `--print-highlight-style`.
831`--print-highlight-style=`*STYLE*|*FILE*
833: Prints a JSON version of a highlighting style, which can
834 be modified, saved with a `.theme` extension, and used
835 with `--highlight-style`. This option may be used with
836 `-o`/`--output` to redirect output to a file, but
837 `-o`/`--output` must come before `--print-highlight-style`
840`--syntax-definition=`*FILE*
842: Instructs pandoc to load a KDE XML syntax definition file,
843 which will be used for syntax highlighting of appropriately
844 marked code blocks. This can be used to add support for
845 new languages or to use altered syntax definitions for
846 existing languages. This option may be repeated to add
847 multiple syntax definitions.
849`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
851: Include contents of *FILE*, verbatim, at the end of the header.
852 This can be used, for example, to include special
853 CSS or JavaScript in HTML documents. This option can be used
854 repeatedly to include multiple files in the header. They will be
855 included in the order specified. Implies `--standalone`.
857`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
859: Include contents of *FILE*, verbatim, at the beginning of the
860 document body (e.g. after the `<body>` tag in HTML, or the
861 `\begin{document}` command in LaTeX). This can be used to include
862 navigation bars or banners in HTML documents. This option can be
863 used repeatedly to include multiple files. They will be included in
864 the order specified. Implies `--standalone`.
866`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
868: Include contents of *FILE*, verbatim, at the end of the document
869 body (before the `</body>` tag in HTML, or the
870 `\end{document}` command in LaTeX). This option can be used
871 repeatedly to include multiple files. They will be included in the
872 order specified. Implies `--standalone`.
874`--resource-path=`*SEARCHPATH*
876: List of paths to search for images and other resources.
877 The paths should be separated by `:` on Linux, UNIX, and
878 macOS systems, and by `;` on Windows. If `--resource-path`
879 is not specified, the default resource path is the working
880 directory. Note that, if `--resource-path` is specified,
881 the working directory must be explicitly listed or it
882 will not be searched. For example:
883 `--resource-path=.:test` will search the working directory
884 and the `test` subdirectory, in that order.
886 `--resource-path` only has an effect if (a) the output
887 format embeds images (for example, `docx`, `pdf`, or `html`
888 with `--self-contained`) or (b) it is used together with
891`--request-header=`*NAME*`:`*VAL*
893: Set the request header *NAME* to the value *VAL* when making
894 HTTP requests (for example, when a URL is given on the
895 command line, or when resources used in a document must be
896 downloaded). If you're behind a proxy, you also need to set
897 the environment variable `http_proxy` to `http://...`.
899## Options affecting specific writers {.options}
903: Produce a standalone HTML file with no external dependencies, using
904 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
905 images, and videos. Implies `--standalone`. The resulting file should be
906 "self-contained," in the sense that it needs no external files and no net
907 access to be displayed properly by a browser. This option works only with
908 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
909 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
910 and stylesheets at absolute URLs will be downloaded; those at relative
911 URLs will be sought relative to the working directory (if the first source
912 file is local) or relative to the base URL (if the first source
913 file is remote). Elements with the attribute
914 `data-external="1"` will be left alone; the documents they
915 link to will not be incorporated in the document.
916 Limitation: resources that are loaded dynamically through
917 JavaScript cannot be incorporated; as a result,
918 `--self-contained` does not work with `--mathjax`, and some
919 advanced features (e.g. zoom or speaker notes) may not work
920 in an offline "self-contained" `reveal.js` slide show.
924: Use `<q>` tags for quotes in HTML.
928: Use only ASCII characters in output. Currently supported for XML
929 and HTML formats (which use entities instead of UTF-8 when this
930 option is selected), CommonMark, gfm, and Markdown (which use
931 entities), roff ms (which use hexadecimal escapes), and to a
932 limited degree LaTeX (which uses standard commands for accented
933 characters when possible). roff man output uses ASCII by default.
937: Use reference-style links, rather than inline links, in writing Markdown
938 or reStructuredText. By default inline links are used. The
939 placement of link references is affected by the
940 `--reference-location` option.
942`--reference-location = block`|`section`|`document`
944: Specify whether footnotes (and references, if `reference-links` is
945 set) are placed at the end of the current (top-level) block, the
946 current section, or the document. The default is
947 `document`. Currently only affects the markdown writer.
951: Use ATX-style headings in Markdown output. The default is
952 to use setext-style headings for levels 1 to 2, and then ATX headings.
953 (Note: for `gfm` output, ATX headings are always used.)
954 This option also affects markdown cells in `ipynb` output.
956`--top-level-division=[default|section|chapter|part]`
958: Treat top-level headings as the given division type in LaTeX, ConTeXt,
959 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
960 all headings are shifted such that the top-level heading becomes the specified
961 type. The default behavior is to determine the best division type via
962 heuristics: unless other conditions apply, `section` is chosen. When the
963 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
964 `article` option is specified), `chapter` is implied as the setting for this
965 option. If `beamer` is the output format, specifying either `chapter` or
966 `part` will cause top-level headings to become `\part{..}`, while
967 second-level headings remain as their default type.
969`-N`, `--number-sections`
971: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
972 By default, sections are not numbered. Sections with class
973 `unnumbered` will never be numbered, even if `--number-sections`
976`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
978: Offset for section headings in HTML output (ignored in other
979 output formats). The first number is added to the section number for
980 top-level headings, the second for second-level headings, and so on.
981 So, for example, if you want the first top-level heading in your
982 document to be numbered "6", specify `--number-offset=5`.
983 If your document starts with a level-2 heading which you want to
984 be numbered "1.5", specify `--number-offset=1,4`.
985 Offsets are 0 by default. Implies `--number-sections`.
989: Use the [`listings`] package for LaTeX code blocks. The package
990 does not support multi-byte encoding for source code. To handle UTF-8
991 you would need to use a custom template. This issue is fully
992 documented here: [Encoding issue with the listings package].
996: Make list items in slide shows display incrementally (one by one).
997 The default is for lists to be displayed all at once.
999`--slide-level=`*NUMBER*
1001: Specifies that headings with the specified level create
1002 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1003 above this level in the hierarchy are used to divide the
1004 slide show into sections; headings below this level create
1005 subheads within a slide. Note that content that is
1006 not contained under slide-level headings will not appear in
1007 the slide show. The default is to set the slide level based
1008 on the contents of the document; see [Structuring the slide
1013: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1014 and attach identifiers to the enclosing `<section>` (or `<div>`)
1015 rather than the heading itself. See
1016 [Heading identifiers], below.
1018`--email-obfuscation=none`|`javascript`|`references`
1020: Specify a method for obfuscating `mailto:` links in HTML documents.
1021 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1022 them using JavaScript. `references` obfuscates them by printing their
1023 letters as decimal or hexadecimal character references. The default
1026`--id-prefix=`*STRING*
1028: Specify a prefix to be added to all identifiers and internal links
1029 in HTML and DocBook output, and to footnote numbers in Markdown
1030 and Haddock output. This is useful for preventing duplicate
1031 identifiers when generating fragments to be included in other pages.
1033`-T` *STRING*, `--title-prefix=`*STRING*
1035: Specify *STRING* as a prefix at the beginning of the title
1036 that appears in the HTML header (but not in the title as it
1037 appears at the beginning of the HTML body). Implies `--standalone`.
1039`-c` *URL*, `--css=`*URL*
1041: Link to a CSS style sheet. This option can be used repeatedly to
1042 include multiple files. They will be included in the order specified.
1044 A stylesheet is required for generating EPUB. If none is
1045 provided using this option (or the `css` or `stylesheet`
1046 metadata fields), pandoc will look for a file `epub.css` in the
1047 user data directory (see `--data-dir`). If it is not
1048 found there, sensible defaults will be used.
1050`--reference-doc=`*FILE*
1052: Use the specified file as a style reference in producing a
1057 : For best results, the reference docx should be a modified
1058 version of a docx file produced using pandoc. The contents
1059 of the reference docx are ignored, but its stylesheets and
1060 document properties (including margins, page size, header,
1061 and footer) are used in the new docx. If no reference docx
1062 is specified on the command line, pandoc will look for a
1063 file `reference.docx` in the user data directory (see
1064 `--data-dir`). If this is not found either, sensible
1065 defaults will be used.
1067 To produce a custom `reference.docx`, first get a copy of
1068 the default `reference.docx`: `pandoc
1069 -o custom-reference.docx --print-default-data-file reference.docx`.
1070 Then open `custom-reference.docx` in Word, modify the
1071 styles as you wish, and save the file. For best
1072 results, do not make changes to this file other than
1073 modifying the styles used by pandoc:
1109 - Default Paragraph Font
1112 - Footnote Reference
1121 : For best results, the reference ODT should be a modified
1122 version of an ODT produced using pandoc. The contents of
1123 the reference ODT are ignored, but its stylesheets are used
1124 in the new ODT. If no reference ODT is specified on the
1125 command line, pandoc will look for a file `reference.odt` in
1126 the user data directory (see `--data-dir`). If this is not
1127 found either, sensible defaults will be used.
1129 To produce a custom `reference.odt`, first get a copy of
1130 the default `reference.odt`: `pandoc
1131 -o custom-reference.odt --print-default-data-file reference.odt`.
1132 Then open `custom-reference.odt` in LibreOffice, modify
1133 the styles as you wish, and save the file.
1137 : Templates included with Microsoft PowerPoint 2013 (either with
1138 `.pptx` or `.potx` extension) are known to work, as are most
1139 templates derived from these.
1141 The specific requirement is that the template should begin with
1142 the following first four layouts:
1145 2. Title and Content
1149 All templates included with a recent version of MS PowerPoint
1150 will fit these criteria. (You can click on `Layout` under the
1151 `Home` menu to check.)
1153 You can also modify the default `reference.pptx`: first run
1154 `pandoc -o custom-reference.pptx --print-default-data-file
1155 reference.pptx`, and then modify `custom-reference.pptx`
1156 in MS PowerPoint (pandoc will use the first four layout
1157 slides, as mentioned above).
1159`--epub-cover-image=`*FILE*
1161: Use the specified image as the EPUB cover. It is recommended
1162 that the image be less than 1000px in width and height. Note that
1163 in a Markdown source document you can also specify `cover-image`
1164 in a YAML metadata block (see [EPUB Metadata], below).
1166`--epub-metadata=`*FILE*
1168: Look in the specified XML file for metadata for the EPUB.
1169 The file should contain a series of [Dublin Core elements].
1172 <dc:rights>Creative Commons</dc:rights>
1173 <dc:language>es-AR</dc:language>
1175 By default, pandoc will include the following metadata elements:
1176 `<dc:title>` (from the document title), `<dc:creator>` (from the
1177 document authors), `<dc:date>` (from the document date, which should
1178 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1179 variable, or, if is not set, the locale), and `<dc:identifier
1180 id="BookId">` (a randomly generated UUID). Any of these may be
1181 overridden by elements in the metadata file.
1183 Note: if the source document is Markdown, a YAML metadata block
1184 in the document can be used instead. See below under
1187`--epub-embed-font=`*FILE*
1189: Embed the specified font in the EPUB. This option can be repeated
1190 to embed multiple fonts. Wildcards can also be used: for example,
1191 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1192 line, be sure to escape them or put the whole filename in single quotes,
1193 to prevent them from being interpreted by the shell. To use the
1194 embedded fonts, you will need to add declarations like the following
1195 to your CSS (see `--css`):
1198 font-family: DejaVuSans;
1200 font-weight: normal;
1201 src:url("DejaVuSans-Regular.ttf");
1204 font-family: DejaVuSans;
1207 src:url("DejaVuSans-Bold.ttf");
1210 font-family: DejaVuSans;
1212 font-weight: normal;
1213 src:url("DejaVuSans-Oblique.ttf");
1216 font-family: DejaVuSans;
1219 src:url("DejaVuSans-BoldOblique.ttf");
1221 body { font-family: "DejaVuSans"; }
1223`--epub-chapter-level=`*NUMBER*
1225: Specify the heading level at which to split the EPUB into separate
1226 "chapter" files. The default is to split into chapters at level-1
1227 headings. This option only affects the internal composition of the
1228 EPUB, not the way chapters and sections are displayed to users. Some
1229 readers may be slow if the chapter files are too large, so for large
1230 documents with few level-1 headings, one might want to use a chapter
1233`--epub-subdirectory=`*DIRNAME*
1235: Specify the subdirectory in the OCF container that is to hold
1236 the EPUB-specific contents. The default is `EPUB`. To put
1237 the EPUB contents in the top level, use an empty string.
1239`--ipynb-output=all|none|best`
1241: Determines how ipynb output cells are treated. `all` means
1242 that all of the data formats included in the original are
1243 preserved. `none` means that the contents of data cells
1244 are omitted. `best` causes pandoc to try to pick the
1245 richest data block in each output cell that is compatible
1246 with the output format. The default is `best`.
1248`--pdf-engine=`*PROGRAM*
1250: Use the specified engine when producing PDF output.
1251 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1252 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1253 and `pdfroff`. If the engine is not in your PATH, the full
1254 path of the engine may be specified here. If this option
1255 is not specified, pandoc uses the following defaults
1256 depending on the output format specified using `-t/--to`:
1258 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1259 `tectonic`, `latexmk`)
1260 - `-t context`: `context`
1261 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`)
1262 - `-t ms`: `pdfroff`
1264`--pdf-engine-opt=`*STRING*
1266: Use the given string as a command-line argument to the `pdf-engine`.
1267 For example, to use a persistent directory `foo` for `latexmk`'s
1268 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1269 Note that no check for duplicate options is done.
1271[Dublin Core elements]: http://dublincore.org/documents/dces/
1272[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1273[Encoding issue with the listings package]:
1274 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1276## Citation rendering {.options}
1278`--bibliography=`*FILE*
1280: Set the `bibliography` field in the document's metadata to *FILE*,
1281 overriding any value set in the metadata, and process citations
1282 using `pandoc-citeproc`. (This is equivalent to
1283 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1284 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1285 used, making this equivalent to `--metadata bibliography=FILE`.
1286 If you supply this argument multiple times, each *FILE* will be added
1291: Set the `csl` field in the document's metadata to *FILE*,
1292 overriding any value set in the metadata. (This is equivalent to
1293 `--metadata csl=FILE`.)
1294 This option is only relevant with `pandoc-citeproc`.
1296`--citation-abbreviations=`*FILE*
1298: Set the `citation-abbreviations` field in the document's metadata to
1299 *FILE*, overriding any value set in the metadata. (This is equivalent to
1300 `--metadata citation-abbreviations=FILE`.)
1301 This option is only relevant with `pandoc-citeproc`.
1305: Use [`natbib`] for citations in LaTeX output. This option is not for use
1306 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1307 use in producing a LaTeX file that can be processed with [`bibtex`].
1311: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1312 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1313 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1315## Math rendering in HTML {.options}
1317The default is to render TeX math as far as possible using Unicode characters.
1318Formulas are put inside a `span` with `class="math"`, so that they may be styled
1319differently from the surrounding text if needed. However, this gives acceptable
1320results only for basic math, usually you will want to use `--mathjax` or another
1321of the following options.
1323`--mathjax`[`=`*URL*]
1325: Use [MathJax] to display embedded TeX math in HTML output.
1326 TeX math will be put between `\(...\)` (for inline math)
1327 or `\[...\]` (for display math) and wrapped in `<span>` tags
1328 with class `math`. Then the MathJax JavaScript will render it.
1329 The *URL* should point to the `MathJax.js` load script.
1330 If a *URL* is not provided, a link to the Cloudflare CDN will
1335: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1336 `html4` and `html5`). This is the default in `odt` output. Note that
1337 currently only Firefox and Safari (and select e-book readers) natively
1342: Convert TeX formulas to `<img>` tags that link to an external script
1343 that converts formulas to images. The formula will be URL-encoded
1344 and concatenated with the URL provided. For SVG images you can for
1345 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1346 If no URL is specified, the CodeCogs URL generating PNGs
1347 will be used (`https://latex.codecogs.com/png.latex?`).
1348 Note: the `--webtex` option will affect Markdown output
1349 as well as HTML, which is useful if you're targeting a
1350 version of Markdown without native math support.
1354: Use [KaTeX] to display embedded TeX math in HTML output.
1355 The *URL* is the base URL for the KaTeX library. That directory
1356 should contain a `katex.min.js` and a `katex.min.css` file.
1357 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1361: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1362 can then be processed by [GladTeX] to produce images of the typeset
1363 formulas and an HTML file with links to these images.
1364 So, the procedure is:
1366 pandoc -s --gladtex input.md -o myfile.htex
1367 gladtex -d myfile-images myfile.htex
1368 # produces myfile.html and images in myfile-images
1370[MathML]: http://www.w3.org/Math/
1371[MathJax]: https://www.mathjax.org
1372[KaTeX]: https://github.com/Khan/KaTeX
1373[GladTeX]: http://humenda.github.io/GladTeX/
1375## Options for wrapper scripts {.options}
1379: Print information about command-line arguments to *stdout*, then exit.
1380 This option is intended primarily for use in wrapper scripts.
1381 The first line of output contains the name of the output file specified
1382 with the `-o` option, or `-` (for *stdout*) if no output file was
1383 specified. The remaining lines contain the command-line arguments,
1384 one per line, in the order they appear. These do not include regular
1385 pandoc options and their arguments, but do include any options appearing
1386 after a `--` separator at the end of the line.
1390: Ignore command-line arguments (for use in wrapper scripts).
1391 Regular pandoc options are not ignored. Thus, for example,
1393 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1397 pandoc -o foo.html -s
1401If pandoc completes successfully, it will return exit code 0.
1402Nonzero exit codes have the following meanings:
1405----- ------------------------------------
1406 3 PandocFailOnWarningError
1408 5 PandocTemplateError
1410 21 PandocUnknownReaderError
1411 22 PandocUnknownWriterError
1412 23 PandocUnsupportedExtensionError
1413 31 PandocEpubSubdirectoryError
1415 47 PandocPDFProgramNotFoundError
1417 62 PandocShouldNeverHappenError
1420 65 PandocParsecError
1421 66 PandocMakePDFError
1422 67 PandocSyntaxMapError
1423 83 PandocFilterError
1425 92 PandocUTF8DecodingError
1426 93 PandocIpynbDecodingError
1427 97 PandocCouldNotFindDataFileError
1428 99 PandocResourceNotFound
1429----- ------------------------------------
1433The `--defaults` option may be used to specify a package
1434of options. Here is a sample defaults file demonstrating all of
1435the fields that may be used:
1439# reader: may be used instead of from:
1441# writer: may be used instead of to:
1443# leave blank for output to stdout:
1445# leave blank for input from stdin, use [] for no input:
1449# or you may use input-file: with a single value
1453self-contained: false
1455# note that structured variables may be specified:
1462# metadata values specified here are parsed as literal
1463# string text, not markdown:
1470# or you may use metadata-file: with a single value
1472# Note that these take files, not their contents:
1473include-before-body: []
1474include-after-body: []
1475include-in-header: []
1478# filters will be assumed to be lua filters if they have
1479# the .lua extension, and json filters otherwise. But
1480# the filter type can also be specified explicitly, as shown:
1491# ERROR, WARNING, or INFO
1495# citeproc, natbib, or biblatex
1496cite-method: citeproc
1497# part, chapter, section, or default:
1498top-level-division: chapter
1504# you may also use pdf-engine-opt: with a single option
1505# pdf-engine-opt: "-shell-escape"
1507# auto, preserve, or none
1512extract-media: mediadir
1514table-of-contents: true
1516number-sections: false
1517# a list of offsets at each heading level
1518number-offset: [0,0,0,0,0,0]
1519# toc: may also be used instead of table-of-contents:
1520shift-heading-level-by: 1
1522identifier-prefix: foo
1524strip-empty-paragraphs: true
1525# lf, crlf, or native
1527strip-comments: false
1528indented-code-classes: []
1530default-image-extension: ".jpg"
1532# either a style name of a style definition file:
1533highlight-style: pygments
1536# or you may use syntax-definition: with a single value
1539reference-doc: myref.docx
1541# method is plain, webtex, gladtex, mathml, mathjax, katex
1542# you may specify a url with webtex, mathjax, katex
1545 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1546# none, references, or javascript
1547email-obfuscation: javascript
1555epub-subdirectory: EPUB
1556epub-metadata: meta.xml
1559epub-chapter-level: 1
1560epub-cover-image: cover.jpg
1562reference-links: true
1563# block, section, or document
1564reference-location: block
1567# accept, reject, or all
1568track-changes: accept
1577# A list of two-element lists
1579- ["User-Agent", "Mozilla/5.0"]
1581fail-if-warnings: false
1587Fields that are omitted will just have their regular
1588default values. So a defaults file can be as simple as
1595Default files can be placed in the `defaults` subdirectory of
1596the user data directory and used from any directory. For
1597example, one could create a file specifying defaults for writing
1598letters, save it as `letter.yaml` in the `defaults` subdirectory
1599of the user data directory, and then invoke these defaults
1600from any directory using `pandoc --defaults letter`
1601or `pandoc -dletter`.
1603When multiple defaults are used, their contents will be combined.
1605Note that, where command-line arguments may be repeated
1606(`--metadata-file`, `--css`, `--include-in-header`,
1607`--include-before-body`, `--include-after-body`, `--variable`,
1608`--metadata`, `--syntax-definition`), the values specified on
1609the command line will combine with values specified in the
1610defaults file, rather than replacing them.
1614When the `-s/--standalone` option is used, pandoc uses a template to
1615add header and footer material that is needed for a self-standing
1616document. To see the default template that is used, just type
1620where *FORMAT* is the name of the output format. A custom template
1621can be specified using the `--template` option. You can also override
1622the system default templates for a given output format *FORMAT*
1623by putting a file `templates/default.*FORMAT*` in the user data
1624directory (see `--data-dir`, above). *Exceptions:*
1626- For `odt` output, customize the `default.opendocument`
1628- For `pdf` output, customize the `default.latex` template
1629 (or the `default.context` template, if you use `-t context`,
1630 or the `default.ms` template, if you use `-t ms`, or the
1631 `default.html` template, if you use `-t html`).
1632- `docx` and `pptx` have no template (however, you can use
1633 `--reference-doc` to customize the output).
1635Templates contain *variables*, which allow for the inclusion of
1636arbitrary information at any point in the file. They may be set at the
1637command line using the `-V/--variable` option. If a variable is not set,
1638pandoc will look for the key in the document's metadata, which can be set
1639using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1640or with the `-M/--metadata` option. In addition, some variables
1641are given default values by pandoc. See [Variables] below for
1642a list of variables used in pandoc's default templates.
1644If you use custom templates, you may need to revise them as pandoc
1645changes. We recommend tracking the changes in the default templates,
1646and modifying your custom templates accordingly. An easy way to do this
1647is to fork the [pandoc-templates] repository and merge in
1648changes after each pandoc release.
1650 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1656Anything between the sequence `$--` and the end of the
1657line will be treated as a comment and omitted from the output.
1661To mark variables and control structures in the template,
1662either `$`...`$` or `${`...`}` may be used as delimiters.
1663The styles may also be mixed in the same template, but the
1664opening and closing delimiter must match in each case. The
1665opening delimiter may be followed by one or more spaces
1666or tabs, which will be ignored. The closing delimiter may
1667be followed by one or more spaces or tabs, which will be
1670To include a literal `$` in the document, use `$$`.
1672### Interpolated variables
1674A slot for an interpolated variable is a variable name surrounded
1675by matched delimiters. Variable names must begin with a letter
1676and can contain letters, numbers, `_`, `-`, and `.`. The
1677keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1678not be used as variable names. Examples:
1691Variable names with periods are used to get at structured
1692variable values. So, for example, `employee.salary` will return the
1693value of the `salary` field of the object that is the value of
1694the `employee` field.
1696- If the value of the variable is simple value, it will be
1697 rendered verbatim. (Note that no escaping is done;
1698 the assumption is that the calling program will escape
1699 the strings appropriately for the output format.)
1700- If the value is a list, the values will be concatenated.
1701- If the value is a map, the string `true` will be rendered.
1702- Every other value will be rendered as the empty string.
1706A conditional begins with `if(variable)` (enclosed in
1707matched delimiters) and ends with `endif` (enclosed in matched
1708delimiters). It may optionally contain an `else` (enclosed in
1709matched delimiters). The `if` section is used if
1710`variable` has a non-empty value, otherwise the `else`
1711section is used (if present). Examples:
1726${if(foo)}bar${endif}
1739The keyword `elseif` may be used to simplify complex nested
1754A for loop begins with `for(variable)` (enclosed in
1755matched delimiters) and ends with `endfor` (enclosed in matched
1758- If `variable` is an array, the material inside the loop will
1759 be evaluated repeatedly, with `variable` being set to each
1760 value of the array in turn, and concatenated.
1761- If `variable` is a map, the material inside will be set to
1763- If the value of the associated variable is not an array or
1764 a map, a single iteration will be performed on its value.
1769$for(foo)$$foo$$sep$, $endfor$
1772 - $foo.last$, $foo.first$
1776 - ${ foo.bar.last }, ${ foo.bar.first }
1780$it.name$: $it.office$
1784You may optionally specify a separator between consecutive
1785values using `sep` (enclosed in matched delimiters). The
1786material between `sep` and the `endfor` is the separator.
1789${ for(foo) }${ foo }${ sep }, ${ endfor }
1792Instead of using `variable` inside the loop, the special
1793anaphoric keyword `it` may be used.
1797 - ${ it.last }, ${ it.first }
1803Partials (subtemplates stored in different files) may be
1804included using the syntax
1810Partials will be sought in the directory containing
1811the main template, and will be assumed to have the
1812same extension as the main template if they lack
1813an explicit extension. (If the partials are not
1814found here, they will also be sought in the `templates`
1815subdirectory of the user data directory.)
1817Partials may optionally be applied to variables using
1823${ articles:bibentry() }
1826If `articles` is an array, this will iterate over its
1827values, applying the partial `bibentry()` to each one. So the
1828second example above is equivalent to
1836Note that the anaphoric keyword `it` must be used when
1837iterating over partials. In the above examples,
1838the `bibentry` partial should contain `it.title`
1839(and so on) instead of `articles.title`.
1841Final newlines are omitted from included partials.
1843Partials may include other partials.
1845A separator between values of an array may be specified
1846in square brackets, immediately after the variable name
1852${articles:bibentry()[; ]$
1855The separator in this case is literal and (unlike with `sep`
1856in an explicit `for` loop) cannot contain interpolated
1857variables or other template directives.
1861To ensure that content is "nested," that is, subsequent lines
1862indented, use the `^` directive:
1865$item.number$ $^$$item.description$ ($item.price$)
1868In this example, if `item.description` has multiple lines,
1869they will all be indented to line up with the first line:
187200123 A fine bottle of 18-year old
1873 Oban whiskey. ($148)
1876To nest multiple lines to the same level, align them
1877with the `^` directive in the template. For example:
1880$item.number$ $^$$item.description$ ($item.price$)
1881 (Available til $item.sellby$.)
188700123 A fine bottle of 18-year old
1888 Oban whiskey. ($148)
1889 (Available til March 30, 2020.)
1892If a variable occurs by itself on a line, preceded by whitespace
1893and not followed by further text or directives on the same line,
1894and the variable's value contains multiple lines, it will be
1895nested automatically.
1899Normally, spaces in the template itself (as opposed to values of
1900the interpolated variables) are not breakable, but they can be
1901made breakable in part of the template by using the `~` keyword
1902(ended with another `~`).
1905$~$This long line may break if the document is rendered
1906with a short line length.$~$
1911A filter transforms the value of a variable or partial. Filters are
1912specified using a slash (`/`) between the variable name (or partial)
1913and the filter name. Example:
1920$for(metadata/pairs)$
1921- $it.key$: $it.value$
1924$employee:name()/uppercase$
1927Filters may be chained:
1930$for(employees/pairs)$
1931$it.key/alpha/uppercase$. $it.name$
1935Some filters take parameters:
1938|----------------------|------------|
1940$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1942|----------------------|------------|
1945Currently the following filters are predefined:
1947- `pairs`: Converts a map or array to an array of maps,
1948 each with `key` and `value` fields. If the original
1949 value was an array, the `key` will be the array index,
1952- `uppercase`: Converts text to uppercase.
1954- `lowercase`: Converts text to lowercase.
1956- `length`: Returns the length of the value: number
1957 of characters for a textual value, number of elements
1960- `reverse`: Reverses a textual value or array,
1961 and has no effect on other values.
1963- `chomp`: Removes trailing newlines (and breakable space).
1965- `nowrap`: Disables line wrapping on breakable spaces.
1967- `alpha`: Converts textual values that can be
1968 read as an integer into lowercase alphabetic
1969 characters `a..z` (mod 26). This can be used to get lettered
1970 enumeration from array indices. To get uppercase
1971 letters, chain with `uppercase`.
1973- `roman`: Converts textual values that can be
1974 read as an integer into lowercase roman numerials.
1975 This can be used to get lettered enumeration from array indices.
1976 To get uppercase roman, chain with `uppercase`.
1978- `left n "leftborder" "rightborder"`: Renders a textual value
1979 in a block of width `n`, aligned to the left, with an optional
1980 left and right border. Has no effect on other values. This
1981 can be used to align material in tables. Widths are positive
1982 integers indicating the number of characters. Borders
1983 are strings inside double quotes; literal `"` and `\` characters
1984 must be backslash-escaped.
1986- `right n "leftborder" "rightborder"`: Renders a textual value
1987 in a block of width `n`, aligned to the right, and has no
1988 effect on other values.
1990- `center n "leftborder" "rightborder"`: Renders a textual
1991 value in a block of width `n`, aligned to the center, and has
1992 no effect on other values.
1997### Metadata variables
1999`title`, `author`, `date`
2000: allow identification of basic aspects of the document. Included
2001 in PDF metadata through LaTeX and ConTeXt. These can be set
2002 through a [pandoc title block][Extension: `pandoc_title_block`],
2003 which allows for multiple authors, or through a
2004 [YAML metadata block][Extension: `yaml_metadata_block`]:
2012 Note that if you just want to set PDF or HTML metadata, without
2013 including a title block in the document itself, you can
2014 set the `title-meta`, `author-meta`, and `date-meta`
2015 variables. (By default these are set automatically, based
2016 on `title`, `author`, and `date`.)
2019: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2023: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2027: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2028 and AsciiDoc metadata; repeat as for `author`, above
2031: document subject, included in ODT, PDF, docx and pptx metadata
2034: document description, included in ODT, docx and pptx metadata. Some
2035 applications show this as `Comments` metadata.
2038: document category, included in docx and pptx metadata
2041any root-level string metadata, not included in ODT, docx
2042or pptx metadata is added as a *custom property*.
2043The following [YAML] metadata block for instance:
2046 title: 'This is the title'
2047 subtitle: "This is the subtitle"
2055 It consists of two paragraphs
2058will include `title`, `author` and `description` as standard document
2059properties and `subtitle` as a custom property when converting to docx,
2062### Language variables
2065: identifies the main language of the document using IETF language
2066 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2067 The [Language subtag lookup] tool can look up or verify these tags.
2068 This affects most formats, and controls hyphenation in PDF output
2069 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2071 Use native pandoc [Divs and Spans] with the `lang` attribute to
2072 switch the language:
2078 Text in the main document language (British English).
2081 > Cette citation est écrite en français canadien.
2084 More text in English. ['Zitat auf Deutsch.']{lang=de}
2087: the base script direction, either `rtl` (right-to-left)
2088 or `ltr` (left-to-right).
2090 For bidirectional documents, native pandoc `span`s and `div`s
2091 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2092 override the base direction in some output formats.
2093 This may not always be necessary if the final renderer
2094 (e.g. the browser, when generating HTML) supports the
2095 [Unicode Bidirectional Algorithm].
2097 When using LaTeX for bidirectional documents, only the `xelatex` engine
2098 is fully supported (use `--pdf-engine=xelatex`).
2100[BCP 47]: https://tools.ietf.org/html/bcp47
2101[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2102[Language subtag lookup]: https://r12a.github.io/app-subtags/
2104### Variables for HTML math
2107: when using [KaTeX](#option--katex), you can render display math equations
2108 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2110### Variables for HTML slides
2112These affect HTML output when [producing slide shows with pandoc].
2114All [reveal.js configuration options] are available as variables.
2115To turn off boolean flags that default to true in reveal.js, use `0`.
2118: base URL for reveal.js documents (defaults to `reveal.js`)
2121: base URL for S5 documents (defaults to `s5/default`)
2124: base URL for Slidy documents (defaults to
2125 `https://www.w3.org/Talks/Tools/Slidy2`)
2128: base URL for Slideous documents (defaults to `slideous`)
2130[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2132### Variables for Beamer slides
2134These variables change the appearance of PDF slides using [`beamer`].
2137: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2138 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2142: produce an article from Beamer slides
2145: add extra beamer option with `\setbeameroption{}`
2148: author affiliations: can be a list when there are multiple authors
2151: logo image for slides
2154: controls navigation symbols (default is `empty` for no navigation
2155 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2158: enables "title pages" for new sections (default is true)
2160`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2164: options for LaTeX beamer themes (a list).
2167: image for title slide
2169### Variables for PowerPoint
2171These variables control the visual aspects of a slide show that
2172are not easily controlled via templates.
2175: font to use for code.
2177### Variables for LaTeX
2179Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2184: make `\paragraph` and `\subparagraph` (fourth- and
2185 fifth-level headings, or fifth- and sixth-level with book
2186 classes) free-standing rather than run-in; requires further
2187 formatting to distinguish from `\subsubsection` (third- or
2188 fourth-level headings). Instead of using this option,
2189 [KOMA-Script] can adjust headings more extensively:
2192 documentclass: scrartcl
2194 \RedeclareSectionCommand[
2195 beforeskip=-10pt plus -2pt minus -1pt,
2196 afterskip=1sp plus -1sp minus 1sp,
2197 font=\normalfont\itshape]{paragraph}
2198 \RedeclareSectionCommand[
2199 beforeskip=-10pt plus -2pt minus -1pt,
2200 afterskip=1sp plus -1sp minus 1sp,
2201 font=\normalfont\scshape,
2202 indent=0pt]{subparagraph}
2206: option for document class, e.g. `oneside`; repeat for multiple options:
2215: document class: usually one of the standard classes, [`article`], [`book`],
2216 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2217 and `scrreprt`, which default to smaller margins; or [`memoir`]
2220: option for [`geometry`] package, e.g. `margin=1in`;
2221 repeat for multiple options:
2231: option for [`hyperref`] package, e.g. `linktoc=all`;
2232 repeat for multiple options:
2238 - pdfpagemode=FullScreen
2242: uses document class settings for indentation (the default LaTeX template
2243 otherwise removes indentation and adds space between paragraphs)
2246: adjusts line spacing using the [`setspace`]
2247 package, e.g. `1.25`, `1.5`
2249`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2250: sets margins if `geometry` is not used (otherwise `geometry`
2254: control `\pagestyle{}`: the default article class
2255 supports `plain` (default), `empty` (no running heads or page numbers),
2256 and `headings` (section titles in running heads)
2259: paper size, e.g. `letter`, `a4`
2262: numbering depth for sections (with `--number-sections` option
2263 or `numbersections` variable)
2268: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2269 default is `T1` (see [LaTeX font encodings guide])
2272: font package for use with `pdflatex`:
2273 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2274 The default is [Latin Modern][`lm`].
2277: options for package used as `fontfamily`; repeat for multiple options.
2278 For example, to use the Libertine font with proportional lowercase
2279 (old-style) figures through the [`libertinus`] package:
2282 fontfamily: libertinus
2289: font size for body text. The standard classes allow 10pt, 11pt, and
2290 12pt. To use another size, set `documentclass` to one of
2291 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2293`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2294: font families for use with `xelatex` or
2295 `lualatex`: take the name of any system font, using the
2296 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2298`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2299: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2300 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2301 choices available through [`fontspec`]; repeat for multiple
2302 options. For example, to use the [TeX Gyre] version of
2303 Palatino with lowercase figures:
2306 mainfont: TeX Gyre Pagella
2309 - Numbers=Proportional
2313: options to pass to the microtype package
2318: add color to link text; automatically enabled if any of
2319 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2321`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2322: color for internal links, external links, citation links, linked
2323 URLs, and links in table of contents, respectively: uses options
2324 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2328: causes links to be printed as footnotes
2333: include list of figures, list of tables
2336: contents of acknowledgments footnote after document title
2339: include table of contents (can also be set using `--toc/--table-of-contents`)
2342: level of section to include in table of contents
2344#### BibLaTeX Bibliographies
2346These variables function when using BibLaTeX for [citation rendering].
2349: list of options for biblatex
2352: bibliography style, when used with `--natbib` and `--biblatex`.
2355: bibliography title, when used with `--natbib` and `--biblatex`.
2358: bibliography to use for resolving references
2361: list of options for natbib
2363[KOMA-Script]: https://ctan.org/pkg/koma-script
2364[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2365[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2366[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2367[`article`]: https://ctan.org/pkg/article
2368[`book`]: https://ctan.org/pkg/book
2369[`libertinus`]: https://ctan.org/pkg/libertinus
2370[`memoir`]: https://ctan.org/pkg/memoir
2371[`report`]: https://ctan.org/pkg/report
2373### Variables for ConTeXt
2375Pandoc uses these variables when [creating a PDF] with ConTeXt.
2378: font size for body text (e.g. `10pt`, `12pt`)
2380`headertext`, `footertext`
2381: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2382 repeat up to four times for different placement
2385: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2386 repeat for multiple options
2389: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2390 repeat for multiple options
2393: options for page margins and text arrangement (see [ConTeXt Layout]);
2394 repeat for multiple options
2396`linkcolor`, `contrastcolor`
2397: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2400: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2403: include list of figures, list of tables
2405`mainfont`, `sansfont`, `monofont`, `mathfont`
2406: font families: take the name of any system font (see [ConTeXt Font Switching])
2408`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2409: sets margins, if `layout` is not used (otherwise `layout`
2413: page number style and location (using [`setuppagenumbering`]);
2414 repeat for multiple options
2417: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2418 repeat for multiple options
2421: adds to the preamble the setup necessary to generate PDF/A of the type
2422 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2423 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2424 block), `1b:2005` will be used as default, for reasons of backwards
2425 compatibility. Using `--variable=pdfa` without specified value is not supported.
2426 To successfully generate PDF/A the required ICC color profiles have to
2427 be available and the content and all included files (such as images)
2428 have to be standard conforming. The ICC profiles and output intent
2429 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2430 See also [ConTeXt PDFA] for more details.
2433: when used in conjunction with `pdfa`, specifies the ICC profile to use
2434 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2435 used as default. May be repeated to include multiple profiles. Note that
2436 the profiles have to be available on the system. They can be obtained
2437 from [ConTeXt ICC Profiles].
2440: when used in conjunction with `pdfa`, specifies the output intent for
2441 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2442 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2445: include table of contents (can also be set using `--toc/--table-of-contents`)
2448: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2451: include all source documents as file attachments in the PDF file
2453[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2454[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2455[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2456[ConTeXt Color]: https://wiki.contextgarden.net/Color
2457[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2458[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2459[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2460[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2461[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2462[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2463[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2465### Variables for `wkhtmltopdf`
2467Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2468The `--css` option also affects the output.
2470`footer-html`, `header-html`
2471: add information to the header and footer
2473`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2474: set the page margins
2477: sets the PDF paper size
2479### Variables for man pages
2482: adjusts text to left (`l`), right (`r`), center (`c`),
2483 or both (`b`) margins
2486: footer in man pages
2489: header in man pages
2492: if `true` (the default), hyphenation will be used
2495: section number in man pages
2500: font family (e.g. `T` or `P`)
2503: paragraph indent (e.g. `2m`)
2506: line height (e.g. `12p`)
2509: point size (e.g. `10p`)
2511### Variables set automatically
2513Pandoc sets these variables automatically in response to [options] or
2514document contents; users can also modify them. These vary depending
2515on the output format, and include the following:
2521: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2522 included in all HTML based formats (dzslides, epub,
2523 html, html4, html5, revealjs, s5, slideous, slidy).
2524 The recognized formats for `date` are: `mm/dd/yyyy`,
2525 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2526 (e.g. either `02 Apr 2018` or `02 April 2018`),
2527 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2528 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2531: contents specified by `-H/--include-in-header` (may have multiple
2535: contents specified by `-B/--include-before-body` (may have
2539: contents specified by `-A/--include-after-body` (may have
2543: JSON representation of all of the document's metadata. Field
2544 values are transformed to the selected output format.
2547: non-null value if `-N/--number-sections` was specified
2549`sourcefile`, `outputfile`
2550: source and destination filenames, as given on the command line.
2551 `sourcefile` can also be a list if input comes from multiple files,
2552 or empty if input is from stdin. You can use the following snippet in
2553 your template to distinguish them:
2563 Similarly, `outputfile` can be `-` if output goes to the terminal.
2565 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2568: working directory from which pandoc is run.
2571: non-null value if `--toc/--table-of-contents` was specified
2574: title of table of contents (works only with EPUB,
2575 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2577[pandoc-templates]: https://github.com/jgm/pandoc-templates
2581The behavior of some of the readers and writers can be adjusted by
2582enabling or disabling various extensions.
2584An extension can be enabled by adding `+EXTENSION`
2585to the format name and disabled by adding `-EXTENSION`. For example,
2586`--from markdown_strict+footnotes` is strict Markdown with footnotes
2587enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2588Markdown without footnotes or pipe tables.
2590The markdown reader and writer make by far the most use of extensions.
2591Extensions only used by them are therefore covered in the
2592section [Pandoc's Markdown] below (See [Markdown variants] for
2593`commonmark` and `gfm`.) In the following, extensions that also work
2594for other formats are covered.
2596Note that markdown extensions added to the `ipynb` format
2597affect Markdown cells in Jupyter notebooks (as do command-line
2598options like `--atx-headers`).
2602#### Extension: `smart` ####
2604Interpret straight quotes as curly quotes, `---` as em-dashes,
2605`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2606inserted after certain abbreviations, such as "Mr."
2608This extension can be enabled/disabled for the following formats:
2611: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2614: `markdown`, `latex`, `context`, `rst`
2616enabled by default in
2617: `markdown`, `latex`, `context` (both input and output)
2619Note: If you are *writing* Markdown, then the `smart` extension
2620has the reverse effect: what would have been curly quotes comes
2623In LaTeX, `smart` means to use the standard TeX ligatures
2624for quotation marks (` `` ` and ` '' ` for double quotes,
2625`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2626en-dash and `---` for em-dash). If `smart` is disabled,
2627then in reading LaTeX pandoc will parse these characters
2628literally. In writing LaTeX, enabling `smart` tells pandoc
2629to use the ligatures when possible; if `smart` is disabled
2630pandoc will use unicode quotation mark and dash characters.
2632## Headings and sections
2634#### Extension: `auto_identifiers` ####
2636A heading without an explicitly specified identifier will be
2637automatically assigned a unique identifier based on the heading text.
2639This extension can be enabled/disabled for the following formats:
2642: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2647enabled by default in
2650The default algorithm used to derive the identifier from the
2653 - Remove all formatting, links, etc.
2654 - Remove all footnotes.
2655 - Remove all non-alphanumeric characters,
2656 except underscores, hyphens, and periods.
2657 - Replace all spaces and newlines with hyphens.
2658 - Convert all alphabetic characters to lowercase.
2659 - Remove everything up to the first letter (identifiers may
2660 not begin with a number or punctuation mark).
2661 - If nothing is left after this, use the identifier `section`.
2666 ------------------------------- ----------------------------
2667 `Heading identifiers in HTML` `heading-identifiers-in-html`
2668 `Maître d'hôtel` `maître-dhôtel`
2669 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2670 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2671 `3. Applications` `applications`
2674These rules should, in most cases, allow one to determine the identifier
2675from the heading text. The exception is when several headings have the
2676same text; in this case, the first will get an identifier as described
2677above; the second will get the same identifier with `-1` appended; the
2678third with `-2`; and so on.
2680(However, a different algorithm is used if
2681`gfm_auto_identifiers` is enabled; see below.)
2683These identifiers are used to provide link targets in the table of
2684contents generated by the `--toc|--table-of-contents` option. They
2685also make it easy to provide links from one section of a document to
2686another. A link to this section, for example, might look like this:
2689 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2691Note, however, that this method of providing links to sections works
2692only in HTML, LaTeX, and ConTeXt formats.
2694If the `--section-divs` option is specified, then each section will
2695be wrapped in a `section` (or a `div`, if `html4` was specified),
2696and the identifier will be attached to the enclosing `<section>`
2697(or `<div>`) tag rather than the heading itself. This allows entire
2698sections to be manipulated using JavaScript or treated differently in
2701#### Extension: `ascii_identifiers` ####
2703Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2704Accents are stripped off of accented Latin letters, and non-Latin
2707#### Extension: `gfm_auto_identifiers` ####
2709Changes the algorithm used by `auto_identifiers` to conform to
2710GitHub's method. Spaces are converted to dashes (`-`),
2711uppercase characters to lowercase characters, and punctuation
2712characters other than `-` and `_` are removed.
2713Emojis are replaced by their names.
2717The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2718[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2719[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2720are described in the section about Pandoc's Markdown.
2722However, they can also be used with HTML input. This is handy for
2723reading web pages formatted using MathJax, for example.
2727The following extensions (especially how they affect Markdown
2728input/output) are also described in more detail in their respective
2729sections of [Pandoc's Markdown].
2731#### Extension: `raw_html` {#raw_html}
2733When converting from HTML, parse elements to raw HTML which are not
2734representable in pandoc's AST.
2735By default, this is disabled for HTML input.
2737#### Extension: `raw_tex` {#raw_tex}
2739Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2741This extension can be enabled/disabled for the following formats
2742(in addition to `markdown`):
2745: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2746 `\eqref` only), `ipynb`
2749: `textile`, `commonmark`
2751Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2752only raw TeX in markdown cells, but data with mime type
2753`text/html` in output cells. Since the `ipynb` reader attempts
2754to preserve the richest possible outputs when several options
2755are given, you will get best results if you disable `raw_html`
2756and `raw_tex` when converting to formats like `docx` which don't
2757allow raw `html` or `tex`.
2759#### Extension: `native_divs` {#native_divs}
2761This extension is enabled by default for HTML input. This means that
2762`div`s are parsed to pandoc native elements. (Alternatively, you
2763can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2765When converting HTML to Markdown, for example, you may want to drop all
2768 pandoc -f html-native_divs-native_spans -t markdown
2770#### Extension: `native_spans` {#native_spans}
2772Analogous to `native_divs` above.
2775## Literate Haskell support
2777#### Extension: `literate_haskell` ####
2779Treat the document as literate Haskell source.
2781This extension can be enabled/disabled for the following formats:
2784: `markdown`, `rst`, `latex`
2787: `markdown`, `rst`, `latex`, `html`
2789If you append `+lhs` (or `+literate_haskell`) to one of the formats
2790above, pandoc will treat the document as literate Haskell source.
2793 - In Markdown input, "bird track" sections will be parsed as Haskell
2794 code rather than block quotations. Text between `\begin{code}`
2795 and `\end{code}` will also be treated as Haskell code. For
2796 ATX-style headings the character '=' will be used instead of '#'.
2798 - In Markdown output, code blocks with classes `haskell` and `literate`
2799 will be rendered using bird tracks, and block quotations will be
2800 indented one space, so they will not be treated as Haskell code.
2801 In addition, headings will be rendered setext-style (with underlines)
2802 rather than ATX-style (with '#' characters). (This is because ghc
2803 treats '#' characters in column 1 as introducing line numbers.)
2805 - In restructured text input, "bird track" sections will be parsed
2808 - In restructured text output, code blocks with class `haskell` will
2809 be rendered using bird tracks.
2811 - In LaTeX input, text in `code` environments will be parsed as
2814 - In LaTeX output, code blocks with class `haskell` will be rendered
2815 inside `code` environments.
2817 - In HTML output, code blocks with class `haskell` will be rendered
2818 with class `literatehaskell` and bird tracks.
2822 pandoc -f markdown+lhs -t html
2824reads literate Haskell source formatted with Markdown conventions and writes
2825ordinary HTML (without bird tracks).
2827 pandoc -f markdown+lhs -t html+lhs
2829writes HTML with the Haskell code in bird tracks, so it can be copied
2830and pasted as literate Haskell source.
2832Note that GHC expects the bird tracks in the first column, so indented
2833literate code blocks (e.g. inside an itemized environment) will not be
2834picked up by the Haskell compiler.
2838#### Extension: `empty_paragraphs` ####
2840Allows empty paragraphs. By default empty paragraphs are
2843This extension can be enabled/disabled for the following formats:
2849: `docx`, `odt`, `opendocument`, `html`
2851#### Extension: `native_numbering` ####
2853Enables native numbering of figures and tables. Enumeration
2856This extension can be enabled/disabled for the following formats:
2859: `odt`, `opendocument`
2861#### Extension: `styles` #### {#ext-styles}
2863When converting from docx, read all docx styles as divs (for
2864paragraph styles) and spans (for character styles) regardless
2865of whether pandoc understands the meaning of these styles.
2866This can be used with [docx custom styles](#custom-styles).
2872#### Extension: `amuse` ####
2874In the `muse` input format, this enables Text::Amuse
2875extensions to Emacs Muse markup.
2877#### Extension: `citations` {#org-citations}
2879Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2882#### Extension: `ntb` ####
2884In the `context` output format this enables the use of [Natural Tables
2885(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2886[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
2887Natural tables allow more fine-grained global customization but come
2888at a performance penalty compared to extreme tables.
2893Pandoc understands an extended and slightly revised version of
2894John Gruber's [Markdown] syntax. This document explains the syntax,
2895noting differences from standard Markdown. Except where noted, these
2896differences can be suppressed by using the `markdown_strict` format instead
2897of `markdown`. Extensions can be enabled or disabled to specify the
2898behavior more granularly. They are described in the following. See also
2899[Extensions] above, for extensions that work also on other formats.
2903Markdown is designed to be easy to write, and, even more importantly,
2906> A Markdown-formatted document should be publishable as-is, as plain
2907> text, without looking like it's been marked up with tags or formatting
2909> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2911This principle has guided pandoc's decisions in finding syntax for
2912tables, footnotes, and other extensions.
2914There is, however, one respect in which pandoc's aims are different
2915from the original aims of Markdown. Whereas Markdown was originally
2916designed with HTML generation in mind, pandoc is designed for multiple
2917output formats. Thus, while pandoc allows the embedding of raw HTML,
2918it discourages it, and provides other, non-HTMLish ways of representing
2919important document elements like definition lists, tables, mathematics, and
2924A paragraph is one or more lines of text followed by one or more blank lines.
2925Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2926If you need a hard line break, put two or more spaces at the end of a line.
2928#### Extension: `escaped_line_breaks` ####
2930A backslash followed by a newline is also a hard line break.
2931Note: in multiline and grid table cells, this is the only way
2932to create a hard line break, since trailing spaces in the cells
2937There are two kinds of headings: Setext and ATX.
2939### Setext-style headings ###
2941A setext-style heading is a line of text "underlined" with a row of `=` signs
2942(for a level-one heading) or `-` signs (for a level-two heading):
2950The heading text can contain inline formatting, such as emphasis (see
2951[Inline formatting], below).
2954### ATX-style headings ###
2956An ATX-style heading consists of one to six `#` signs and a line of
2957text, optionally followed by any number of `#` signs. The number of
2958`#` signs at the beginning of the line is the heading level:
2960 ## A level-two heading
2962 ### A level-three heading ###
2964As with setext-style headings, the heading text can contain formatting:
2966 # A level-one heading with a [link](/url) and *emphasis*
2968#### Extension: `blank_before_header` ####
2970Standard Markdown syntax does not require a blank line before a heading.
2971Pandoc does require this (except, of course, at the beginning of the
2972document). The reason for the requirement is that it is all too easy for a
2973`#` to end up at the beginning of a line by accident (perhaps through line
2974wrapping). Consider, for example:
2976 I like several of their flavors of ice cream:
2977 #22, for example, and #5.
2979#### Extension: `space_in_atx_header` ####
2981Many Markdown implementations do not require a space between the
2982opening `#`s of an ATX heading and the heading text, so that
2983`#5 bolt` and `#hashtag` count as headings. With this extension,
2984pandoc does require the space.
2986### Heading identifiers ###
2988See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2990#### Extension: `header_attributes` ####
2992Headings can be assigned attributes using this syntax at the end
2993of the line containing the heading text:
2995 {#identifier .class .class key=value key=value}
2997Thus, for example, the following headings will all be assigned the identifier
3002 ## My heading ## {#foo}
3004 My other heading {#foo}
3007(This syntax is compatible with [PHP Markdown Extra].)
3009Note that although this syntax allows assignment of classes and key/value
3010attributes, writers generally don't use all of this information. Identifiers,
3011classes, and key/value attributes are used in HTML and HTML-based formats such
3012as EPUB and slidy. Identifiers are used for labels and link anchors in the
3013LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3015Headings with the class `unnumbered` will not be numbered, even if
3016`--number-sections` is specified. A single hyphen (`-`) in an attribute
3017context is equivalent to `.unnumbered`, and preferable in non-English
3024 # My heading {.unnumbered}
3026If the `unlisted` class is present in addition to `unnumbered`,
3027the heading will not be included in a table of contents.
3028(Currently this feature is only implemented for certain
3029formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3031#### Extension: `implicit_header_references` ####
3033Pandoc behaves as if reference links have been defined for each heading.
3034So, to link to a heading
3036 # Heading identifiers in HTML
3040 [Heading identifiers in HTML]
3044 [Heading identifiers in HTML][]
3048 [the section on heading identifiers][heading identifiers in
3051instead of giving the identifier explicitly:
3053 [Heading identifiers in HTML](#heading-identifiers-in-html)
3055If there are multiple headings with identical text, the corresponding
3056reference will link to the first one only, and you will need to use explicit
3057links to link to the others, as described above.
3059Like regular reference links, these references are case-insensitive.
3061Explicit link reference definitions always take priority over
3062implicit heading references. So, in the following example, the
3063link will point to `bar`, not to `#foo`:
3073Markdown uses email conventions for quoting blocks of text.
3074A block quotation is one or more paragraphs or other block elements
3075(such as lists or headings), with each line preceded by a `>` character
3076and an optional space. (The `>` need not start at the left margin, but
3077it should not be indented more than three spaces.)
3079 > This is a block quote. This
3080 > paragraph has two lines.
3082 > 1. This is a list inside a block quote.
3085A "lazy" form, which requires the `>` character only on the first
3086line of each block, is also allowed:
3088 > This is a block quote. This
3089 paragraph has two lines.
3091 > 1. This is a list inside a block quote.
3094Among the block elements that can be contained in a block quote are
3095other block quotes. That is, block quotes can be nested:
3097 > This is a block quote.
3099 > > A block quote within a block quote.
3101If the `>` character is followed by an optional space, that space
3102will be considered part of the block quote marker and not part of
3103the indentation of the contents. Thus, to put an indented code
3104block in a block quote, you need five spaces after the `>`:
3108#### Extension: `blank_before_blockquote` ####
3110Standard Markdown syntax does not require a blank line before a block
3111quote. Pandoc does require this (except, of course, at the beginning of the
3112document). The reason for the requirement is that it is all too easy for a
3113`>` to end up at the beginning of a line by accident (perhaps through line
3114wrapping). So, unless the `markdown_strict` format is used, the following does
3115not produce a nested block quote in pandoc:
3117 > This is a block quote.
3121## Verbatim (code) blocks
3123### Indented code blocks ###
3125A block of text indented four spaces (or one tab) is treated as verbatim
3126text: that is, special characters do not trigger special formatting,
3127and all spaces and line breaks are preserved. For example,
3130 moveShip(5 * gravity, DOWN);
3133The initial (four space or one tab) indentation is not considered part
3134of the verbatim text, and is removed in the output.
3136Note: blank lines in the verbatim text need not begin with four spaces.
3139### Fenced code blocks ###
3141#### Extension: `fenced_code_blocks` ####
3143In addition to standard indented code blocks, pandoc supports
3144*fenced* code blocks. These begin with a row of three or more
3145tildes (`~`) and end with a row of tildes that must be at least as long as
3146the starting row. Everything between these lines is treated as code. No
3147indentation is necessary:
3151 moveShip(5 * gravity, DOWN);
3155Like regular code blocks, fenced code blocks must be separated
3156from surrounding text by blank lines.
3158If the code itself contains a row of tildes or backticks, just use a longer
3159row of tildes or backticks at the start and end:
3163 code including tildes
3167#### Extension: `backtick_code_blocks` ####
3169Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3172#### Extension: `fenced_code_attributes` ####
3174Optionally, you may attach attributes to fenced or backtick code block using
3177 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3179 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3180 qsort (filter (>= x) xs)
3181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3183Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3184`startFrom` is an attribute with value `100`. Some output formats can use this
3185information to do syntax highlighting. Currently, the only output formats
3186that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3187highlighting is supported for your output format and language, then the code
3188block above will appear highlighted, with numbered lines. (To see which
3189languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3190the code block above will appear as follows:
3192 <pre id="mycode" class="haskell numberLines" startFrom="100">
3198The `numberLines` (or `number-lines`) class will cause the lines
3199of the code block to be numbered, starting with `1` or the value
3200of the `startFrom` attribute. The `lineAnchors` (or
3201`line-anchors`) class will cause the lines to be clickable
3202anchors in HTML output.
3204A shortcut form can also be used for specifying the language of
3211This is equivalent to:
3217If the `fenced_code_attributes` extension is disabled, but
3218input contains class attribute(s) for the code block, the first
3219class attribute will be printed after the opening fence as a bare
3222To prevent all highlighting, use the `--no-highlight` flag.
3223To set the highlighting style, use `--highlight-style`.
3224For more information on highlighting, see [Syntax highlighting],
3229#### Extension: `line_blocks` ####
3231A line block is a sequence of lines beginning with a vertical bar (`|`)
3232followed by a space. The division into lines will be preserved in
3233the output, as will any leading spaces; otherwise, the lines will
3234be formatted as Markdown. This is useful for verse and addresses:
3236 | The limerick packs laughs anatomical
3237 | In space that is quite economical.
3238 | But the good ones I've seen
3239 | So seldom are clean
3240 | And the clean ones so seldom are comical
3243 | Berkeley, CA 94718
3245The lines can be hard-wrapped if needed, but the continuation
3246line must begin with a space.
3248 | The Right Honorable Most Venerable and Righteous Samuel L.
3251 | Berkeley, CA 94718
3253This syntax is borrowed from [reStructuredText].
3259A bullet list is a list of bulleted list items. A bulleted list
3260item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3267This will produce a "compact" list. If you want a "loose" list, in which
3268each item is formatted as a paragraph, put spaces between the items:
3276The bullets need not be flush with the left margin; they may be
3277indented one, two, or three spaces. The bullet must be followed
3280List items look best if subsequent lines are flush with the first
3281line (after the bullet):
3287But Markdown also allows a "lazy" format:
3293### Block content in list items ###
3295A list item may contain multiple paragraphs and other block-level
3296content. However, subsequent paragraphs must be preceded by a blank line
3297and indented to line up with the first non-space content after
3304 * Second paragraph. With a code block, which must be indented
3309Exception: if the list marker is followed by an indented code
3310block, which must begin 5 spaces after the list marker, then
3311subsequent paragraphs must begin two columns after the last
3312character of the list marker:
3316 continuation paragraph
3318List items may include other lists. In this case the preceding blank
3319line is optional. The nested list must be indented to line up with
3320the first non-space character after the list marker of the
3321containing list item.
3333As noted above, Markdown allows you to write list items "lazily," instead of
3334indenting continuation lines. However, if there are multiple paragraphs or
3335other blocks in a list item, the first line of each must be indented.
3337 + A lazy, lazy, list
3340 + Another one; this looks
3343 Second paragraph of second
3346### Ordered lists ###
3348Ordered lists work just like bulleted lists, except that the items
3349begin with enumerators rather than bullets.
3351In standard Markdown, enumerators are decimal numbers followed
3352by a period and a space. The numbers themselves are ignored, so
3353there is no difference between this list:
3365#### Extension: `fancy_lists` ####
3367Unlike standard Markdown, pandoc allows ordered list items to be marked
3368with uppercase and lowercase letters and roman numerals, in addition to
3369Arabic numerals. List markers may be enclosed in parentheses or followed by a
3370single right-parentheses or period. They must be separated from the
3371text that follows by at least one space, and, if the list marker is a
3372capital letter with a period, by at least two spaces.[^2]
3374[^2]: The point of this rule is to ensure that normal paragraphs
3375 starting with people's initials, like
3377 B. Russell was an English philosopher.
3379 do not get treated as list items.
3381 This rule will not prevent
3385 from being interpreted as a list item. In this case, a backslash
3390The `fancy_lists` extension also allows '`#`' to be used as an
3391ordered list marker in place of a numeral:
3396#### Extension: `startnum` ####
3398Pandoc also pays attention to the type of list marker used, and to the
3399starting number, and both of these are preserved where possible in the
3400output format. Thus, the following yields a list with numbers followed
3401by a single parenthesis, starting with 9, and a sublist with lowercase
3411Pandoc will start a new list each time a different type of list
3412marker is used. So, the following will create three lists:
3419If default list markers are desired, use `#.`:
3425#### Extension: `task_lists` ####
3427Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3429 - [ ] an unchecked task list item
3432### Definition lists ###
3434#### Extension: `definition_lists` ####
3436Pandoc supports definition lists, using the syntax of
3437[PHP Markdown Extra] with some extensions.[^3]
3443 Term 2 with *inline markup*
3447 { some code, part of Definition 2 }
3449 Third paragraph of definition 2.
3451Each term must fit on one line, which may optionally be followed by
3452a blank line, and must be followed by one or more definitions.
3453A definition begins with a colon or tilde, which may be indented one
3456A term may have multiple definitions, and each definition may consist of one or
3457more block elements (paragraph, code block, list, etc.), each indented four
3458spaces or one tab stop. The body of the definition (including the first line,
3459aside from the colon or tilde) should be indented four spaces. However,
3460as with other Markdown lists, you can "lazily" omit indentation except
3461at the beginning of a paragraph or other block element:
3466 with lazy continuation.
3468 Second paragraph of the definition.
3470If you leave space before the definition (as in the example above),
3471the text of the definition will be treated as a paragraph. In some
3472output formats, this will mean greater spacing between term/definition
3473pairs. For a more compact definition list, omit the space before the
3483Note that space between items in a definition list is required.
3484(A variant that loosens this requirement, but disallows "lazy"
3485hard wrapping, can be activated with `compact_definition_lists`: see
3486[Non-pandoc extensions], below.)
3488[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3490### Numbered example lists ###
3492#### Extension: `example_lists` ####
3494The special list marker `@` can be used for sequentially numbered
3495examples. The first list item with a `@` marker will be numbered '1',
3496the next '2', and so on, throughout the document. The numbered examples
3497need not occur in a single list; each new list using `@` will take up
3498where the last stopped. So, for example:
3500 (@) My first example will be numbered (1).
3501 (@) My second example will be numbered (2).
3503 Explanation of examples.
3505 (@) My third example will be numbered (3).
3507Numbered examples can be labeled and referred to elsewhere in the
3510 (@good) This is a good example.
3512 As (@good) illustrates, ...
3514The label can be any string of alphanumeric characters, underscores,
3517Note: continuation paragraphs in example lists must always
3518be indented four spaces, regardless of the length of the
3519list marker. That is, example lists always behave as if the
3520`four_space_rule` extension is set. This is because example
3521labels tend to be long, and indenting content to the
3522first non-space character after the label would be awkward.
3524### Compact and loose lists ###
3526Pandoc behaves differently from `Markdown.pl` on some "edge
3527cases" involving lists. Consider this source:
3537Pandoc transforms this into a "compact list" (with no `<p>` tags around
3538"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3539"Second" and "Third" (but not "First"), because of the blank space
3540around "Third". Pandoc follows a simple rule: if the text is followed by
3541a blank line, it is treated as a paragraph. Since "Second" is followed
3542by a list, and not a blank line, it isn't treated as a paragraph. The
3543fact that the list is followed by a blank line is irrelevant. (Note:
3544Pandoc works this way even when the `markdown_strict` format is specified. This
3545behavior is consistent with the official Markdown syntax description,
3546even though it is different from that of `Markdown.pl`.)
3549### Ending a list ###
3551What if you want to put an indented code block after a list?
3558Trouble! Here pandoc (like other Markdown implementations) will treat
3559`{ my code block }` as the second paragraph of item two, and not as
3562To "cut off" the list after item two, you can insert some non-indented
3563content, like an HTML comment, which won't produce visible output in
3569 <!-- end of list -->
3573You can use the same trick if you want two consecutive lists instead
3588A line containing a row of three or more `*`, `-`, or `_` characters
3589(optionally separated by spaces) produces a horizontal rule:
3598Four kinds of tables may be used. The first three kinds presuppose the use of
3599a fixed-width font, such as Courier. The fourth kind can be used with
3600proportionally spaced fonts, as it does not require lining up columns.
3602#### Extension: `table_captions` ####
3604A caption may optionally be provided with all 4 kinds of tables (as
3605illustrated in the examples below). A caption is a paragraph beginning
3606with the string `Table:` (or just `:`), which will be stripped off.
3607It may appear either before or after the table.
3609#### Extension: `simple_tables` ####
3611Simple tables look like this:
3613 Right Left Center Default
3614 ------- ------ ---------- -------
3619 Table: Demonstration of simple table syntax.
3621The header and table rows must each fit on one line. Column
3622alignments are determined by the position of the header text relative
3623to the dashed line below it:[^4]
3625 - If the dashed line is flush with the header text on the right side
3626 but extends beyond it on the left, the column is right-aligned.
3627 - If the dashed line is flush with the header text on the left side
3628 but extends beyond it on the right, the column is left-aligned.
3629 - If the dashed line extends beyond the header text on both sides,
3630 the column is centered.
3631 - If the dashed line is flush with the header text on both sides,
3632 the default alignment is used (in most cases, this will be left).
3634[^4]: This scheme is due to Michel Fortin, who proposed it on the
3635 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3637The table must end with a blank line, or a line of dashes followed by
3640The column header row may be omitted, provided a dashed line is used
3641to end the table. For example:
3643 ------- ------ ---------- -------
3647 ------- ------ ---------- -------
3649When the header row is omitted, column alignments are determined on the basis
3650of the first line of the table body. So, in the tables above, the columns
3651would be right, left, center, and right aligned, respectively.
3653#### Extension: `multiline_tables` ####
3655Multiline tables allow header and table rows to span multiple lines
3656of text (but cells that span multiple columns or rows of the table are
3657not supported). Here is an example:
3659 -------------------------------------------------------------
3660 Centered Default Right Left
3661 Header Aligned Aligned Aligned
3662 ----------- ------- --------------- -------------------------
3663 First row 12.0 Example of a row that
3664 spans multiple lines.
3666 Second row 5.0 Here's another one. Note
3667 the blank line between
3669 -------------------------------------------------------------
3671 Table: Here's the caption. It, too, may span
3674These work like simple tables, but with the following differences:
3676 - They must begin with a row of dashes, before the header text
3677 (unless the header row is omitted).
3678 - They must end with a row of dashes, then a blank line.
3679 - The rows must be separated by blank lines.
3681In multiline tables, the table parser pays attention to the widths of
3682the columns, and the writers try to reproduce these relative widths in
3683the output. So, if you find that one of the columns is too narrow in the
3684output, try widening it in the Markdown source.
3686The header may be omitted in multiline tables as well as simple tables:
3688 ----------- ------- --------------- -------------------------
3689 First row 12.0 Example of a row that
3690 spans multiple lines.
3692 Second row 5.0 Here's another one. Note
3693 the blank line between
3695 ----------- ------- --------------- -------------------------
3697 : Here's a multiline table without a header.
3699It is possible for a multiline table to have just one row, but the row
3700should be followed by a blank line (and then the row of dashes that ends
3701the table), or the table may be interpreted as a simple table.
3703#### Extension: `grid_tables` ####
3705Grid tables look like this:
3707 : Sample grid table.
3709 +---------------+---------------+--------------------+
3710 | Fruit | Price | Advantages |
3711 +===============+===============+====================+
3712 | Bananas | $1.34 | - built-in wrapper |
3713 | | | - bright color |
3714 +---------------+---------------+--------------------+
3715 | Oranges | $2.10 | - cures scurvy |
3717 +---------------+---------------+--------------------+
3719The row of `=`s separates the header from the table body, and can be
3720omitted for a headerless table. The cells of grid tables may contain
3721arbitrary block elements (multiple paragraphs, code blocks, lists,
3722etc.). Cells that span multiple columns or rows are not
3723supported. Grid tables can be created easily using Emacs' table-mode
3724(`M-x table-insert`).
3726Alignments can be specified as with pipe tables, by putting
3727colons at the boundaries of the separator line after the
3730 +---------------+---------------+--------------------+
3731 | Right | Left | Centered |
3732 +==============:+:==============+:==================:+
3733 | Bananas | $1.34 | built-in wrapper |
3734 +---------------+---------------+--------------------+
3736For headerless tables, the colons go on the top line instead:
3738 +--------------:+:--------------+:------------------:+
3739 | Right | Left | Centered |
3740 +---------------+---------------+--------------------+
3742##### Grid Table Limitations #####
3744Pandoc does not support grid tables with row spans or column spans.
3745This means that neither variable numbers of columns across rows nor
3746variable numbers of rows across columns are supported by Pandoc.
3747All grid tables must have the same number of columns in each row,
3748and the same number of rows in each column. For example, the
3749Docutils [sample grid tables] will not render as expected with
3752[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
3755#### Extension: `pipe_tables` ####
3757Pipe tables look like this:
3759 | Right | Left | Default | Center |
3760 |------:|:-----|---------|:------:|
3761 | 12 | 12 | 12 | 12 |
3762 | 123 | 123 | 123 | 123 |
3765 : Demonstration of pipe table syntax.
3767The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3768ending pipe characters are optional, but pipes are required between all
3769columns. The colons indicate column alignment as shown. The header
3770cannot be omitted. To simulate a headerless table, include a header
3773Since the pipes indicate column boundaries, columns need not be vertically
3774aligned, as they are in the above example. So, this is a perfectly
3775legal (though ugly) pipe table:
3783The cells of pipe tables cannot contain block elements like paragraphs
3784and lists, and cannot span multiple lines. If a pipe table contains a
3785row whose printable content is wider than the column width (see
3786`--columns`), then the table will take up the full text width and
3787the cell contents will wrap, with the relative cell widths determined
3788by the number of dashes in the line separating the table header from
3789the table body. (For example `---|-` would make the first column 3/4
3790and the second column 1/4 of the full text width.)
3791On the other hand, if no lines are wider than column width, then
3792cell contents will not be wrapped, and the cells will be sized
3795Note: pandoc also recognizes pipe tables of the following
3796form, as can be produced by Emacs' orgtbl-mode:
3803The difference is that `+` is used instead of `|`. Other orgtbl features
3804are not supported. In particular, to get non-default column alignment,
3805you'll need to add colons as above.
3807[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3811#### Extension: `pandoc_title_block` ####
3813If the file begins with a title block
3816 % author(s) (separated by semicolons)
3819it will be parsed as bibliographic information, not regular text. (It
3820will be used, for example, in the title of standalone LaTeX or HTML
3821output.) The block may contain just a title, a title and an author,
3822or all three elements. If you want to include an author but no
3823title, or a title and a date but no author, you need a blank line:
3832The title may occupy multiple lines, but continuation lines must
3833begin with leading space, thus:
3838If a document has multiple authors, the authors may be put on
3839separate lines with leading space, or separated by semicolons, or
3840both. So, all of the following are equivalent:
3845 % Author One; Author Two
3850The date must fit on one line.
3852All three metadata fields may contain standard inline formatting
3853(italics, links, footnotes, etc.).
3855Title blocks will always be parsed, but they will affect the output only
3856when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3857will appear twice: once in the document head -- this is the title that
3858will appear at the top of the window in a browser -- and once at the
3859beginning of the document body. The title in the document head can have
3860an optional prefix attached (`--title-prefix` or `-T` option). The title
3861in the body appears as an H1 element with class "title", so it can be
3862suppressed or reformatted with CSS. If a title prefix is specified with
3863`-T` and no title block appears in the document, the title prefix will
3864be used by itself as the HTML title.
3866The man page writer extracts a title, man page section number, and
3867other header and footer information from the title line. The title
3868is assumed to be the first word on the title line, which may optionally
3869end with a (single-digit) section number in parentheses. (There should
3870be no space between the title and the parentheses.) Anything after
3871this is assumed to be additional footer and header text. A single pipe
3872character (`|`) should be used to separate the footer text from the header
3877will yield a man page with the title `PANDOC` and section 1.
3879 % PANDOC(1) Pandoc User Manuals
3881will also have "Pandoc User Manuals" in the footer.
3883 % PANDOC(1) Pandoc User Manuals | Version 4.0
3885will also have "Version 4.0" in the header.
3887#### Extension: `yaml_metadata_block` ####
3889A [YAML] metadata block is a valid YAML object, delimited by a line of three
3890hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3891(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3892document, but if it is not at the beginning, it must be preceded by a blank
3893line. (Note that, because of the way pandoc concatenates input files when
3894several are provided, you may also keep the metadata in a separate YAML file
3895and pass it to pandoc as an argument, along with your Markdown files:
3897 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3899Just be sure that the YAML file begins with `---` and ends with `---` or
3900`...`.) Alternatively, you can use the `--metadata-file` option. Using
3901that approach however, you cannot reference content (like footnotes)
3902from the main markdown input document.
3904Metadata will be taken from the fields of the YAML object and added to any
3905existing document metadata. Metadata can contain lists and objects (nested
3906arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3907with names ending in an underscore will be ignored by pandoc. (They may be
3908given a role by external processors.) Field names must not be
3909interpretable as YAML numbers or boolean values (so, for
3910example, `yes`, `True`, and `15` cannot be used as field names).
3912A document may contain multiple metadata blocks. If two
3913metadata blocks attempt to set the same field, the value from
3914the second block will be taken.
3916When pandoc is used with `-t markdown` to create a Markdown document,
3917a YAML metadata block will be produced only if the `-s/--standalone`
3918option is used. All of the metadata will appear in a single block
3919at the beginning of the document.
3921Note that [YAML] escaping rules must be followed. Thus, for example,
3922if a title contains a colon, it must be quoted. The pipe character
3923(`|`) can be used to begin an indented block that will be interpreted
3924literally, without need for escaping. This form is necessary
3925when the field contains blank lines or block-level formatting:
3928 title: 'This is the title: it contains a colon'
3932 keywords: [nothing, nothingness]
3934 This is the abstract.
3936 It consists of two paragraphs.
3939Template variables will be set automatically from the metadata. Thus, for
3940example, in writing HTML, the variable `abstract` will be set to the HTML
3941equivalent of the Markdown in the `abstract` field:
3943 <p>This is the abstract.</p>
3944 <p>It consists of two paragraphs.</p>
3946Variables can contain arbitrary YAML structures, but the template must match
3947this structure. The `author` variable in the default templates expects a
3948simple list or string, but can be changed to support more complicated
3949structures. The following combination, for example, would add an affiliation
3950to the author if one is given:
3953 title: The document title
3956 affiliation: University of Somewhere
3958 affiliation: University of Nowhere
3961To use the structured authors in the example above, you would need a custom
3966 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3972Raw content to include in the document's header may be specified
3973using `header-includes`; however, it is important to mark up
3974this content as raw code for a particular output format, using
3975the [`raw_attribute` extension](#extension-raw_attribute)), or it
3976will be interpreted as markdown. For example:
3981 \let\oldsection\section
3982 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3987#### Extension: `all_symbols_escapable` ####
3989Except inside a code block or inline code, any punctuation or space
3990character preceded by a backslash will be treated literally, even if it
3991would normally indicate formatting. Thus, for example, if one writes
4001 <strong>hello</strong>
4003This rule is easier to remember than standard Markdown's rule,
4004which allows only the following characters to be backslash-escaped:
4008(However, if the `markdown_strict` format is used, the standard Markdown rule
4011A backslash-escaped space is parsed as a nonbreaking space. It will
4012appear in TeX output as `~` and in HTML and XML as `\ ` or
4015A backslash-escaped newline (i.e. a backslash occurring at the end of
4016a line) is parsed as a hard line break. It will appear in TeX output as
4017`\\` and in HTML as `<br />`. This is a nice alternative to
4018Markdown's "invisible" way of indicating hard line breaks using
4019two trailing spaces on a line.
4021Backslash escapes do not work in verbatim contexts.
4027To *emphasize* some text, surround it with `*`s or `_`, like this:
4029 This text is _emphasized with underscores_, and this
4030 is *emphasized with asterisks*.
4032Double `*` or `_` produces **strong emphasis**:
4034 This is **strong emphasis** and __with underscores__.
4036A `*` or `_` character surrounded by spaces, or backslash-escaped,
4037will not trigger emphasis:
4039 This is * not emphasized *, and \*neither is this\*.
4041#### Extension: `intraword_underscores` ####
4043Because `_` is sometimes used inside words and identifiers,
4044pandoc does not interpret a `_` surrounded by alphanumeric
4045characters as an emphasis marker. If you want to emphasize
4046just part of a word, use `*`:
4048 feas*ible*, not feas*able*.
4053#### Extension: `strikeout` ####
4055To strikeout a section of text with a horizontal line, begin and end it
4056with `~~`. Thus, for example,
4058 This ~~is deleted text.~~
4061### Superscripts and subscripts ###
4063#### Extension: `superscript`, `subscript` ####
4065Superscripts may be written by surrounding the superscripted text by `^`
4066characters; subscripts may be written by surrounding the subscripted
4067text by `~` characters. Thus, for example,
4069 H~2~O is a liquid. 2^10^ is 1024.
4071The text between `^...^` or `~...~` may not contain spaces or
4072newlines. If the superscripted or subscripted text contains
4073spaces, these spaces must be escaped with backslashes. (This is
4074to prevent accidental superscripting and subscripting through
4075the ordinary use of `~` and `^`, and also bad interactions with
4076footnotes.) Thus, if you want the letter P with 'a cat' in
4077subscripts, use `P~a\ cat~`, not `P~a cat~`.
4081To make a short span of text verbatim, put it inside backticks:
4083 What is the difference between `>>=` and `>>`?
4085If the verbatim text includes a backtick, use double backticks:
4087 Here is a literal backtick `` ` ``.
4089(The spaces after the opening backticks and before the closing
4090backticks will be ignored.)
4092The general rule is that a verbatim span starts with a string
4093of consecutive backticks (optionally followed by a space)
4094and ends with a string of the same number of backticks (optionally
4095preceded by a space).
4097Note that backslash-escapes (and other Markdown constructs) do not
4098work in verbatim contexts:
4100 This is a backslash followed by an asterisk: `\*`.
4102#### Extension: `inline_code_attributes` ####
4104Attributes can be attached to verbatim text, just as with
4105[fenced code blocks]:
4111To write small caps, use the `smallcaps` class:
4113 [Small caps]{.smallcaps}
4115Or, without the `bracketed_spans` extension:
4117 <span class="smallcaps">Small caps</span>
4119For compatibility with other Markdown flavors, CSS is also supported:
4121 <span style="font-variant:small-caps;">Small caps</span>
4123This will work in all output formats that support small caps.
4128#### Extension: `tex_math_dollars` ####
4130Anything between two `$` characters will be treated as TeX math. The
4131opening `$` must have a non-space character immediately to its right,
4132while the closing `$` must have a non-space character immediately to its
4133left, and must not be followed immediately by a digit. Thus,
4134`$20,000 and $30,000` won't parse as math. If for some reason
4135you need to enclose text in literal `$` characters, backslash-escape
4136them and they won't be treated as math delimiters.
4138TeX math will be printed in all output formats. How it is rendered
4139depends on the output format:
4142 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4143 math) or `\[...\]` (for display math).
4145Markdown, Emacs Org mode, ConTeXt, ZimWiki
4146 ~ It will appear verbatim surrounded by `$...$` (for inline
4147 math) or `$$...$$` (for display math).
4150 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4153 ~ It will be rendered using an [interpreted text role `:math:`].
4156 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4157 surrounded by `latexmath:[$...$]` (for inline math) or
4158 `[latexmath]++++\[...\]+++` (for display math).
4159 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4160 (`$..$` and `\[..\]`) are omitted.
4163 ~ It will be rendered inside a `@math` command.
4165roff man, Jira markup
4166 ~ It will be rendered verbatim without `$`'s.
4169 ~ It will be rendered inside `<math>` tags.
4172 ~ It will be rendered inside `<span class="math">` tags.
4175 ~ It will be rendered, if possible, using Unicode characters,
4176 and will otherwise appear verbatim.
4179 ~ It will be rendered, if possible, using MathML.
4182 ~ If the `--mathml` flag is used, it will be rendered using MathML
4183 in an `inlineequation` or `informalequation` tag. Otherwise it
4184 will be rendered, if possible, using Unicode characters.
4187 ~ It will be rendered using OMML math markup.
4190 ~ If the `--webtex` option is used, formulas are rendered as images
4191 using CodeCogs or other compatible web service, downloaded
4192 and embedded in the e-book. Otherwise, they will appear verbatim.
4194HTML, Slidy, DZSlides, S5, EPUB
4195 ~ The way math is rendered in HTML will depend on the
4196 command-line options selected. Therefore see [Math rendering in HTML]
4199[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4203#### Extension: `raw_html` ####
4205Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4206(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4207literally). (Technically this is not an extension, since standard
4208Markdown allows it, but it has been made an extension so that it can
4209be disabled if desired.)
4211The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4212DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4213output, and suppressed in other formats.
4215For a more explicit way of including raw HTML in a Markdown
4216document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4218In the CommonMark format, if `raw_html` is enabled, superscripts,
4219subscripts, strikeouts and small capitals will be represented as HTML.
4220Otherwise, plain-text fallbacks will be used. Note that even if
4221`raw_html` is disabled, tables will be rendered with HTML syntax if
4222they cannot use pipe syntax.
4224#### Extension: `markdown_in_html_blocks` ####
4226Standard Markdown allows you to include HTML "blocks": blocks
4227of HTML between balanced tags that are separated from the surrounding text
4228with blank lines, and start and end at the left margin. Within
4229these blocks, everything is interpreted as HTML, not Markdown;
4230so (for example), `*` does not signify emphasis.
4232Pandoc behaves this way when the `markdown_strict` format is used; but
4233by default, pandoc interprets material between HTML block tags as Markdown.
4234Thus, for example, pandoc will turn
4239 <td>[a link](http://google.com)</td>
4247 <td><em>one</em></td>
4248 <td><a href="http://google.com">a link</a></td>
4252whereas `Markdown.pl` will preserve it as is.
4254There is one exception to this rule: text between `<script>` and
4255`<style>` tags is not interpreted as Markdown.
4257This departure from standard Markdown should make it easier to mix
4258Markdown with HTML block elements. For example, one can surround
4259a block of Markdown text with `<div>` tags without preventing it
4260from being interpreted as Markdown.
4262#### Extension: `native_divs` ####
4264Use native pandoc `Div` blocks for content inside `<div>` tags.
4265For the most part this should give the same output as
4266`markdown_in_html_blocks`, but it makes it easier to write pandoc
4267filters to manipulate groups of blocks.
4269#### Extension: `native_spans` ####
4271Use native pandoc `Span` blocks for content inside `<span>` tags.
4272For the most part this should give the same output as `raw_html`,
4273but it makes it easier to write pandoc filters to manipulate groups
4276#### Extension: `raw_tex` ####
4278In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4279included in a document. Inline TeX commands will be preserved and passed
4280unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4281LaTeX to include BibTeX citations:
4283 This result was proved in \cite{jones.1967}.
4285Note that in LaTeX environments, like
4287 \begin{tabular}{|l|l|}\hline
4288 Age & Frequency \\ \hline
4291 36--45 & 22 \\ \hline
4294the material between the begin and end tags will be interpreted as raw
4295LaTeX, not as Markdown.
4297For a more explicit and flexible way of including raw TeX in a
4298Markdown document, see the [`raw_attribute`
4299extension][Extension: `raw_attribute`].
4301Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4302Emacs Org mode, and ConTeXt.
4304### Generic raw attribute ###
4306#### Extension: `raw_attribute` ####
4308Inline spans and fenced code blocks with a special
4309kind of attribute will be parsed as raw content with the
4310designated format. For example, the following produces a raw
4317And the following produces a raw `html` inline element:
4319 This is `<a>html</a>`{=html}
4321This can be useful to insert raw xml into `docx` documents, e.g.
4327 <w:br w:type="page"/>
4332The format name should match the target format name (see
4333`-t/--to`, above, for a list, or use `pandoc
4334--list-output-formats`). Use `openxml` for `docx` output,
4335`opendocument` for `odt` output, `html5` for `epub3` output,
4336`html4` for `epub2` output, and `latex`, `beamer`,
4337`ms`, or `html5` for `pdf` output (depending on what you
4338use for `--pdf-engine`).
4340This extension presupposes that the relevant kind of
4341inline code or fenced code block is enabled. Thus, for
4342example, to use a raw attribute with a backtick code block,
4343`backtick_code_blocks` must be enabled.
4345The raw attribute cannot be combined with regular attributes.
4349#### Extension: `latex_macros` ####
4351When this extension is enabled, pandoc will parse LaTeX
4352macro definitions and apply the resulting macros to all LaTeX
4353math and raw LaTeX. So, for example, the following will work in
4354all output formats, not just LaTeX:
4356 \newcommand{\tuple}[1]{\langle #1 \rangle}
4360Note that LaTeX macros will not be applied if they occur
4361inside a raw span or block marked with the
4362[`raw_attribute` extension](#extension-raw_attribute).
4364When `latex_macros` is disabled, the raw LaTeX and math will
4365not have macros applied. This is usually a better approach when
4366you are targeting LaTeX or PDF.
4368Macro definitions in LaTeX will be passed through as raw LaTeX
4369only if `latex_macros` is not enabled. Macro definitions in
4370Markdown source (or other formats allowing `raw_tex`) will
4371be passed through regardless of whether `latex_macros` is
4376Markdown allows links to be specified in several ways.
4378### Automatic links ###
4380If you enclose a URL or email address in pointy brackets, it
4384 <sam@green.eggs.ham>
4388An inline link consists of the link text in square brackets,
4389followed by the URL in parentheses. (Optionally, the URL can
4390be followed by a link title, in quotes.)
4392 This is an [inline link](/url), and here's [one with
4393 a title](http://fsf.org "click here for a good time!").
4395There can be no space between the bracketed part and the parenthesized part.
4396The link text can contain formatting (such as emphasis), but the title cannot.
4398Email addresses in inline links are not autodetected, so they have to be
4399prefixed with `mailto`:
4401 [Write me!](mailto:sam@green.eggs.ham)
4403### Reference links ###
4405An *explicit* reference link has two parts, the link itself and the link
4406definition, which may occur elsewhere in the document (either
4407before or after the link).
4409The link consists of link text in square brackets, followed by a label in
4410square brackets. (There cannot be space between the two unless the
4411`spaced_reference_links` extension is enabled.) The link definition
4412consists of the bracketed label, followed by a colon and a space, followed by
4413the URL, and optionally (after a space) a link title either in quotes or in
4414parentheses. The label must not be parseable as a citation (assuming
4415the `citations` extension is enabled): citations take precedence over
4418Here are some examples:
4420 [my label 1]: /foo/bar.html "My title, optional"
4422 [my label 3]: http://fsf.org (The free software foundation)
4423 [my label 4]: /bar#special 'A title in single quotes'
4425The URL may optionally be surrounded by angle brackets:
4427 [my label 5]: <http://foo.bar.baz>
4429The title may go on the next line:
4431 [my label 3]: http://fsf.org
4432 "The free software foundation"
4434Note that link labels are not case sensitive. So, this will work:
4436 Here is [my link][FOO]
4440In an *implicit* reference link, the second pair of brackets is
4445 [my website]: http://foo.bar.baz
4447Note: In `Markdown.pl` and most other Markdown implementations,
4448reference link definitions cannot occur in nested constructions
4449such as list items or block quotes. Pandoc lifts this arbitrary
4450seeming restriction. So the following is fine in pandoc, though
4451not in most other implementations:
4457#### Extension: `shortcut_reference_links` ####
4459In a *shortcut* reference link, the second pair of brackets may
4464 [my website]: http://foo.bar.baz
4466### Internal links ###
4468To link to another section of the same document, use the automatically
4469generated identifier (see [Heading identifiers]). For example:
4471 See the [Introduction](#introduction).
4475 See the [Introduction].
4477 [Introduction]: #introduction
4479Internal links are currently supported for HTML formats (including
4480HTML slide shows and EPUB), LaTeX, and ConTeXt.
4484A link immediately preceded by a `!` will be treated as an image.
4485The link text will be used as the image's alt text:
4487 
4491 [movie reel]: movie.gif
4493#### Extension: `implicit_figures` ####
4495An image with nonempty alt text, occurring by itself in a
4496paragraph, will be rendered as a figure with a caption. The
4497image's alt text will be used as the caption.
4499 
4501How this is rendered depends on the output format. Some output
4502formats (e.g. RTF) do not yet support figures. In those
4503formats, you'll just get an image in a paragraph by itself, with
4506If you just want a regular inline image, just make sure it is not
4507the only thing in the paragraph. One way to do this is to insert a
4508nonbreaking space after the image:
4510 \
4512Note that in reveal.js slide shows, an image in a paragraph
4513by itself that has the `stretch` class will fill the screen,
4514and the caption and figure tags will be omitted.
4516#### Extension: `link_attributes` ####
4518Attributes can be set on links and images:
4520 An inline {#id .class width=30 height=20px}
4521 and a reference ![image][ref] with attributes.
4523 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4525(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4526and `.class` are used.)
4528For HTML and EPUB, all known HTML5 attributes except `width` and
4529`height` (but including `srcset` and `sizes`) are passed through
4530as is. Unknown attributes are passed through as custom
4531attributes, with `data-` prepended. The other writers ignore
4532attributes that are not specifically supported by their output format.
4534The `width` and `height` attributes on images are treated specially. When
4535used without a unit, the unit is assumed to be pixels. However, any of
4536the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4537and `%`. There must not be any spaces between the number and the unit.
4541{ width=50% }
4544- Dimensions are converted to inches for output in page-based formats like
4545 LaTeX. Dimensions are converted to pixels for output in HTML-like
4546 formats. Use the `--dpi` option to specify the number of pixels per
4547 inch. The default is 96dpi.
4548- The `%` unit is generally relative to some available space.
4549 For example the above example will render to the following.
4550 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4551 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4552 (If you're using a custom template, you need to configure `graphicx`
4553 as in the default template.)
4554 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4555- Some output formats have a notion of a class
4556 ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4557 or a unique identifier (LaTeX `\caption`), or both (HTML).
4558- When no `width` or `height` attributes are specified, the fallback
4559 is to look at the image resolution and the dpi metadata embedded in
4564Using the `native_divs` and `native_spans` extensions
4565(see [above][Extension: `native_divs`]), HTML syntax can
4566be used as part of markdown to create native `Div` and `Span`
4567elements in the pandoc AST (as opposed to raw HTML).
4568However, there is also nicer syntax available:
4570#### Extension: `fenced_divs` ####
4572Allow special fenced syntax for native `Div` blocks. A Div
4573starts with a fence containing at least three consecutive
4574colons plus some attributes. The attributes may optionally
4575be followed by another string of consecutive colons.
4576The attribute syntax is exactly as in fenced code blocks (see
4577[Extension: `fenced_code_attributes`]). As with fenced
4578code blocks, one can use either attributes in curly braces
4579or a single unbraced word, which will be treated as a class
4580name. The Div ends with another line containing a string of at
4581least three consecutive colons. The fenced Div should be
4582separated by blank lines from preceding and following blocks.
4586 ::::: {#special .sidebar}
4587 Here is a paragraph.
4592Fenced divs can be nested. Opening fences are distinguished
4593because they *must* have attributes:
4599 This is a warning within a warning.
4603Fences without attributes are always closing fences. Unlike
4604with fenced code blocks, the number of colons in the closing
4605fence need not match the number in the opening fence. However,
4606it can be helpful for visual clarity to use fences of different
4607lengths to distinguish nested divs from their parents.
4610#### Extension: `bracketed_spans` ####
4612A bracketed sequence of inlines, as one would use to begin
4613a link, will be treated as a `Span` with attributes if it is
4614followed immediately by attributes:
4616 [This is *some text*]{.class key="val"}
4620#### Extension: `footnotes` ####
4622Pandoc's Markdown allows footnotes, using the following syntax:
4624 Here is a footnote reference,[^1] and another.[^longnote]
4626 [^1]: Here is the footnote.
4628 [^longnote]: Here's one with multiple blocks.
4630 Subsequent paragraphs are indented to show that they
4631 belong to the previous footnote.
4635 The whole paragraph can be indented, or just the first
4636 line. In this way, multi-paragraph footnotes work like
4637 multi-paragraph list items.
4639 This paragraph won't be part of the note, because it
4642The identifiers in footnote references may not contain spaces, tabs,
4643or newlines. These identifiers are used only to correlate the
4644footnote reference with the note itself; in the output, footnotes
4645will be numbered sequentially.
4647The footnotes themselves need not be placed at the end of the
4648document. They may appear anywhere except inside other block elements
4649(lists, block quotes, tables, etc.). Each footnote should be
4650separated from surrounding content (including other footnotes)
4653#### Extension: `inline_notes` ####
4655Inline footnotes are also allowed (though, unlike regular notes,
4656they cannot contain multiple paragraphs). The syntax is as follows:
4658 Here is an inline note.^[Inlines notes are easier to write, since
4659 you don't have to pick an identifier and move down to type the
4662Inline and regular footnotes may be mixed freely.
4666#### Extension: `citations` ####
4668Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4669citations and a bibliography in a number of styles. Basic usage is
4671 pandoc --filter pandoc-citeproc myinput.txt
4673In order to use this feature, you will need to specify a bibliography file
4674using the `bibliography` metadata field in a YAML metadata section, or
4675`--bibliography` command line argument. You can supply multiple `--bibliography`
4676arguments or set `bibliography` metadata field to YAML array, if you want to
4677use multiple bibliography files. The bibliography may have any of these
4680 Format File extension
4681 ------------ --------------
4694Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4695use `.bibtex` to force BibTeX.
4697Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4698can produce `.json` and `.yaml` files from any of the supported formats.
4700In-field markup: In BibTeX and BibLaTeX databases,
4701pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4702databases, pandoc Markdown; and in CSL JSON databases, an
4703[HTML-like markup][CSL markup specs]:
4711`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4720`<span class="nocase">...</span>`
4721: prevent a phrase from being capitalized as title case
4723`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4724and CSL YAML formats as far as possible.
4726As an alternative to specifying a bibliography file using `--bibliography`
4727or the YAML metadata field `bibliography`, you can include
4728the citation data directly in the `references` field of the
4729document's YAML metadata. The field should contain an array of
4730YAML-encoded references, for example:
4734 - type: article-journal
4746 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4748 title-short: Molecular structure of nucleic acids
4749 container-title: Nature
4753 DOI: 10.1038/171737a0
4754 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4758(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4759of the supported formats.)
4761Citations and references can be formatted using any style supported by the
4762[Citation Style Language], listed in the [Zotero Style Repository].
4763These files are specified using the `--csl` option or the `csl` metadata field.
4764By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4765format. The CSL project provides further information on [finding and editing styles].
4767To make your citations hyperlinks to the corresponding bibliography
4768entries, add `link-citations: true` to your YAML metadata.
4770Citations go inside square brackets and are separated by semicolons.
4771Each citation must have a key, composed of '@' + the citation
4772identifier from the database, and may optionally have a prefix,
4773a locator, and a suffix. The citation key must begin with a letter, digit,
4774or `_`, and may contain alphanumerics, `_`, and internal punctuation
4775characters (`:.#$%&-+?<>~/`). Here are some examples:
4777 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4779 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4781 Blah blah [@smith04; @doe99].
4783`pandoc-citeproc` detects locator terms in the [CSL locale files].
4784Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4785locale, locator terms can be written in either singular or plural forms,
4786as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4787`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4788`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4789`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4790`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4791`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4792locator term is used, "page" is assumed.
4794`pandoc-citeproc` will use heuristics to distinguish the locator
4795from the suffix. In complex cases, the locator can be enclosed
4796in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4798 [@smith{ii, A, D-Z}, with a suffix]
4799 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4801A minus sign (`-`) before the `@` will suppress mention of
4802the author in the citation. This can be useful when the
4803author is already mentioned in the text:
4805 Smith says blah [-@smith04].
4807You can also write an in-text citation, as follows:
4811 @smith04 [p. 33] says blah.
4813If the style calls for a list of works cited, it will be placed
4814in a div with id `refs`, if one exists:
4819Otherwise, it will be placed at the end of the document.
4820Generation of the bibliography can be suppressed by setting
4821`suppress-bibliography: true` in the YAML metadata.
4823If you wish the bibliography to have a section heading, you can
4824set `reference-section-title` in the metadata, or put the heading
4825at the beginning of the div with id `refs` (if you are using it)
4826or at the end of your document:
4832The bibliography will be inserted after this heading. Note that
4833the `unnumbered` class will be added to this heading, so that the
4834section will not be numbered.
4836If you want to include items in the bibliography without actually
4837citing them in the body text, you can define a dummy `nocite` metadata
4838field and put the citations there:
4847In this example, the document will contain a citation for `item3`
4848only, but the bibliography will contain entries for `item1`, `item2`, and
4851It is possible to create a bibliography with all the citations,
4852whether or not they appear in the document, by using a wildcard:
4859For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4860render the bibliography. In order to do so, specify bibliography
4861files as outlined above, and add `--natbib` or `--biblatex`
4862argument to `pandoc` invocation. Bear in mind that bibliography
4863files have to be in respective format (either BibTeX or
4866For more information, see the [pandoc-citeproc man page].
4868[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4869[Chicago Manual of Style]: http://chicagomanualofstyle.org
4870[Citation Style Language]: http://citationstyles.org
4871[Zotero Style Repository]: https://www.zotero.org/styles
4872[finding and editing styles]: https://citationstyles.org/authors/
4873[CSL locale files]: https://github.com/citation-style-language/locales
4874[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4876## Non-pandoc extensions
4878The following Markdown syntax extensions are not enabled by default
4879in pandoc, but may be enabled by adding `+EXTENSION` to the format
4880name, where `EXTENSION` is the name of the extension. Thus, for
4881example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4883#### Extension: `old_dashes` ####
4885Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4886`-` before a numeral is an en-dash, and `--` is an em-dash.
4887This option only has an effect if `smart` is enabled. It is
4888selected automatically for `textile` input.
4890#### Extension: `angle_brackets_escapable` ####
4892Allow `<` and `>` to be backslash-escaped, as they can be in
4893GitHub flavored Markdown but not original Markdown. This is
4894implied by pandoc's default `all_symbols_escapable`.
4896#### Extension: `lists_without_preceding_blankline` ####
4898Allow a list to occur right after a paragraph, with no intervening
4901#### Extension: `four_space_rule` ####
4903Selects the pandoc <= 2.0 behavior for parsing lists, so that
4904four spaces indent are needed for list item continuation
4907#### Extension: `spaced_reference_links` ####
4909Allow whitespace between the two components of a reference link,
4914#### Extension: `hard_line_breaks` ####
4916Causes all newlines within a paragraph to be interpreted as hard line
4917breaks instead of spaces.
4919#### Extension: `ignore_line_breaks` ####
4921Causes newlines within a paragraph to be ignored, rather than being
4922treated as spaces or as hard line breaks. This option is intended for
4923use with East Asian languages where spaces are not used between words,
4924but text is divided into lines for readability.
4926#### Extension: `east_asian_line_breaks` ####
4928Causes newlines within a paragraph to be ignored, rather than
4929being treated as spaces or as hard line breaks, when they occur
4930between two East Asian wide characters. This is a better choice
4931than `ignore_line_breaks` for texts that include a mix of East
4932Asian wide characters and other characters.
4934#### Extension: `emoji` ####
4936Parses textual emojis like `:smile:` as Unicode emoticons.
4938#### Extension: `tex_math_single_backslash` ####
4940Causes anything between `\(` and `\)` to be interpreted as inline
4941TeX math, and anything between `\[` and `\]` to be interpreted
4942as display TeX math. Note: a drawback of this extension is that
4943it precludes escaping `(` and `[`.
4945#### Extension: `tex_math_double_backslash` ####
4947Causes anything between `\\(` and `\\)` to be interpreted as inline
4948TeX math, and anything between `\\[` and `\\]` to be interpreted
4951#### Extension: `markdown_attribute` ####
4953By default, pandoc interprets material inside block-level tags as Markdown.
4954This extension changes the behavior so that Markdown is only parsed
4955inside block-level tags if the tags have the attribute `markdown=1`.
4957#### Extension: `mmd_title_block` ####
4959Enables a [MultiMarkdown] style title block at the top of
4960the document, for example:
4964 Date: September 1, 2008
4965 Comment: This is a sample mmd title block, with
4966 a field spanning multiple lines.
4968See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4969`yaml_metadata_block` is enabled, it will take precedence over
4972#### Extension: `abbreviations` ####
4974Parses PHP Markdown Extra abbreviation keys, like
4976 *[HTML]: Hypertext Markup Language
4978Note that the pandoc document model does not support
4979abbreviations, so if this extension is enabled, abbreviation keys are
4980simply skipped (as opposed to being parsed as paragraphs).
4982#### Extension: `autolink_bare_uris` ####
4984Makes all absolute URIs into links, even when not surrounded by
4985pointy braces `<...>`.
4987#### Extension: `mmd_link_attributes` ####
4989Parses multimarkdown style key-value attributes on link
4990and image references. This extension should not be confused with the
4991[`link_attributes`](#extension-link_attributes) extension.
4993 This is a reference ![image][ref] with multimarkdown attributes.
4995 [ref]: http://path.to/image "Image title" width=20px height=30px
4996 id=myId class="myClass1 myClass2"
4998#### Extension: `mmd_header_identifiers` ####
5000Parses multimarkdown style heading identifiers (in square brackets,
5001after the heading but before any trailing `#`s in an ATX heading).
5003#### Extension: `compact_definition_lists` ####
5005Activates the definition list syntax of pandoc 1.12.x and earlier.
5006This syntax differs from the one described above under [Definition lists]
5009 - No blank line is required between consecutive items of the
5011 - To get a "tight" or "compact" list, omit space between consecutive
5012 items; the space between a term and its definition does not affect
5014 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5015 be indented four spaces.[^6]
5017[^6]: To see why laziness is incompatible with relaxing the requirement
5018 of a blank line between items, consider the following example:
5025 Is this a single list item with two definitions of "bar," the first of
5026 which is lazily wrapped, or two list items? To remove the ambiguity
5027 we must either disallow lazy wrapping or require a blank line between
5030#### Extension: `gutenberg` ####
5032Use [Project Gutenberg] conventions for `plain` output:
5033all-caps for strong emphasis, surround by underscores
5034for regular emphasis, add extra blank space around headings.
5036 [Project Gutenberg]: https://www.gutenberg.org
5040In addition to pandoc's extended Markdown, the following Markdown
5041variants are supported:
5043`markdown_phpextra` (PHP Markdown Extra)
5044: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5045 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5046 `header_attributes`, `link_attributes`, `abbreviations`,
5047 `shortcut_reference_links`, `spaced_reference_links`.
5049`markdown_github` (deprecated GitHub-Flavored Markdown)
5050: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5051 `gfm_auto_identifiers`, `backtick_code_blocks`,
5052 `autolink_bare_uris`, `space_in_atx_header`,
5053 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5054 `shortcut_reference_links`, `angle_brackets_escapable`,
5055 `lists_without_preceding_blankline`.
5057`markdown_mmd` (MultiMarkdown)
5058: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5059 `tex_math_double_backslash`, `intraword_underscores`,
5060 `mmd_title_block`, `footnotes`, `definition_lists`,
5061 `all_symbols_escapable`, `implicit_header_references`,
5062 `auto_identifiers`, `mmd_header_identifiers`,
5063 `shortcut_reference_links`, `implicit_figures`,
5064 `superscript`, `subscript`, `backtick_code_blocks`,
5065 `spaced_reference_links`, `raw_attribute`.
5067`markdown_strict` (Markdown.pl)
5068: `raw_html`, `shortcut_reference_links`,
5069 `spaced_reference_links`.
5071We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5072which is implemented as a set of extensions on `commonmark`).
5074Note, however, that `commonmark` and `gfm` have limited support
5075for extensions. Only those listed below (and `smart`,
5076`raw_tex`, and `hard_line_breaks`) will work. The extensions
5077can, however, all be individually disabled. Also, `raw_tex`
5078only affects `gfm` output, not input.
5080`gfm` (GitHub-Flavored Markdown)
5081: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5082 `gfm_auto_identifiers`, `backtick_code_blocks`,
5083 `autolink_bare_uris`, `space_in_atx_header`,
5084 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5085 `shortcut_reference_links`, `angle_brackets_escapable`,
5086 `lists_without_preceding_blankline`.
5089# Producing slide shows with pandoc
5091You can use pandoc to produce an HTML + JavaScript slide presentation
5092that can be viewed via a web browser. There are five ways to do this,
5093using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5094You can also produce a PDF slide show using LaTeX [`beamer`], or
5095slides shows in Microsoft [PowerPoint] format.
5097Here's the Markdown source for a simple slide show, `habits.txt`:
5124 
5131To produce an HTML/JavaScript slide show, simply type
5133 pandoc -t FORMAT -s habits.txt -o habits.html
5135where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5137For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5138`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5139assumed to be available at the relative path `s5/default` (for S5), `slideous`
5140(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5141`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5142`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5143above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5146With all HTML slide formats, the `--self-contained` option can be used to
5147produce a single file that contains all of the data necessary to display the
5148slide show, including linked scripts, stylesheets, images, and videos.
5150To produce a PDF slide show using beamer, type
5152 pandoc -t beamer habits.txt -o habits.pdf
5154Note that a reveal.js slide show can also be converted to a PDF
5155by printing it to a file from the browser.
5157To produce a Powerpoint slide show, type
5159 pandoc habits.txt -o habits.pptx
5161## Structuring the slide show
5163By default, the *slide level* is the highest heading level in
5164the hierarchy that is followed immediately by content, and not another
5165heading, somewhere in the document. In the example above, level-1 headings
5166are always followed by level-2 headings, which are followed by content,
5167so the slide level is 2. This default can be overridden using
5168the `--slide-level` option.
5170The document is carved up into slides according to the following
5173 * A horizontal rule always starts a new slide.
5175 * A heading at the slide level always starts a new slide.
5177 * Headings *below* the slide level in the hierarchy create
5178 headings *within* a slide.
5180 * Headings *above* the slide level in the hierarchy create
5181 "title slides," which just contain the section title
5182 and help to break the slide show into sections.
5183 Non-slide content under these headings will be included
5184 on the title slide (for HTML slide shows) or in a
5185 subsequent slide with the same title (for beamer).
5187 * A title page is constructed automatically from the document's title
5188 block, if present. (In the case of beamer, this can be disabled
5189 by commenting out some lines in the default template.)
5191These rules are designed to support many different styles of slide show. If
5192you don't care about structuring your slides into sections and subsections,
5193you can just use level-1 headings for all each slide. (In that case, level-1
5194will be the slide level.) But you can also structure the slide show into
5195sections, as in the example above.
5197Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5198layout will be produced, with level-1 headings building horizontally
5199and level-2 headings building vertically. It is not recommended that
5200you use deeper nesting of section levels with reveal.js.
5204By default, these writers produce lists that display "all at once."
5205If you want your lists to display incrementally (one item at a time),
5206use the `-i` option. If you want a particular list to depart from the
5207default, put it in a `div` block with class `incremental` or
5208`nonincremental`. So, for example, using the `fenced div` syntax, the
5209following would be incremental regardless of the document default:
5227While using `incremental` and `nonincremental` divs are the
5228recommended method of setting incremental lists on a per-case basis,
5229an older method is also supported: putting lists inside a blockquote
5230will depart from the document default (that is, it will display
5231incrementally without the `-i` option and all at once with the `-i`
5237Both methods allow incremental and nonincremental lists to be mixed
5238in a single document.
5240Note: Neither the `-i/--incremental` option nor any of the
5241methods described here currently works for PowerPoint output.
5245You can add "pauses" within a slide by including a paragraph containing
5246three dots, separated by spaces:
5248 # Slide with a pause
5250 content before the pause
5254 content after the pause
5256Note: this feature is not yet implemented for PowerPoint output.
5258## Styling the slides
5260You can change the style of HTML slides by putting customized CSS files
5261in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5262or `$DATADIR/slideous` (for Slideous),
5263where `$DATADIR` is the user data directory (see `--data-dir`, above).
5264The originals may be found in pandoc's system data directory (generally
5265`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5266files it does not find in the user data directory.
5268For dzslides, the CSS is included in the HTML file itself, and may
5271All [reveal.js configuration options] can be set through variables.
5272For example, themes can be used by setting the `theme` variable:
5276Or you can specify a custom stylesheet using the `--css` option.
5278To style beamer slides, you can specify a `theme`, `colortheme`,
5279`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5281 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5283Note that heading attributes will turn into slide attributes
5284(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5285to style individual slides. In beamer, the only heading attribute
5286that affects slides is the `allowframebreaks` class, which sets the
5287`allowframebreaks` option, causing multiple slides to be created
5288if the content overfills the frame. This is recommended especially for
5291 # References {.allowframebreaks}
5295Speaker notes are supported in reveal.js and PowerPoint (pptx)
5296output. You can add notes to your Markdown document thus:
5302 - It can contain Markdown
5307To show the notes window in reveal.js, press `s` while viewing the
5308presentation. Speaker notes in PowerPoint will be available, as usual,
5309in handouts and presenter view.
5311Notes are not yet supported for other slide formats, but the notes
5312will not appear on the slides themselves.
5316To put material in side by side columns, you can use a native
5317div container with class `columns`, containing two or more div
5318containers with class `column` and a `width` attribute:
5320 :::::::::::::: {.columns}
5321 ::: {.column width="40%"}
5324 ::: {.column width="60%"}
5329## Frame attributes in beamer
5331Sometimes it is necessary to add the LaTeX `[fragile]` option to
5332a frame in beamer (for example, when using the `minted` environment).
5333This can be forced by adding the `fragile` class to the heading
5334introducing the slide:
5336 # Fragile slide {.fragile}
5338All of the other frame attributes described in Section 8.1 of
5339the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5340`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5341`shrink`, `standout`, `noframenumbering`.
5343## Background in reveal.js and beamer
5345Background images can be added to self-contained reveal.js slideshows and
5346to beamer slideshows.
5348For the same image on every slide, use the configuration
5349option `background-image` either in the YAML metadata block
5350or as a command-line variable. (There are no other options in
5351beamer and the rest of this section concerns reveal.js slideshows.)
5353For reveal.js, you can instead use the reveal.js-native option
5354`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5355and `parallaxBackgroundVertical` the same way and must also set
5356`parallaxBackgroundSize` to have your values take effect.
5358To set an image for a particular reveal.js slide, add
5359`{data-background-image="/path/to/image"}`
5360to the first slide-level heading on the slide (which may even be empty).
5362In reveal.js's overview mode, the parallaxBackgroundImage will show up
5363only on the first slide.
5365Other reveal.js background settings also work on individual slides, including
5366`data-background-size`, `data-background-repeat`, `data-background-color`,
5367`data-transition`, and `data-transition-speed`.
5370documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5373For example in reveal.js:
5378parallaxBackgroundImage: /path/to/my/background_image.png
5383Slide 1 has background_image.png as its background.
5385## {data-background-image="/path/to/special_image.jpg"}
5387Slide 2 has a special image for its background, even though the heading has no content.
5390# Creating EPUBs with pandoc
5394EPUB metadata may be specified using the `--epub-metadata` option, but
5395if the source document is Markdown, it is better to use a [YAML metadata
5396block][Extension: `yaml_metadata_block`]. Here is an example:
5403 text: An investigation of metadata
5411 text: doi:10.234234.234/33
5413 rights: © 2007 John Smith, CC BY-NC
5418The following fields are recognized:
5421 ~ Either a string value or an object with fields `text` and
5422 `scheme`. Valid values for `scheme` are `ISBN-10`,
5423 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5424 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5425 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5428 ~ Either a string value, or an object with fields `file-as` and
5429 `type`, or a list of such objects. Valid values for `type` are
5430 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5433 ~ Either a string value, or an object with fields `role`, `file-as`,
5434 and `text`, or a list of such objects. Valid values for `role` are
5435 [MARC relators], but
5436 pandoc will attempt to translate the human-readable versions
5437 (like "author" and "editor") to the appropriate marc relators.
5440 ~ Same format as `creator`.
5443 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5444 Pandoc will attempt to convert other common date formats.
5446`lang` (or legacy: `language`)
5447 ~ A string value in [BCP 47] format. Pandoc will default to the local
5448 language if nothing is specified.
5451 ~ A string value or a list of such values.
5472 ~ A string value (path to cover image).
5474`css` (or legacy: `stylesheet`)
5475 ~ A string value (path to CSS stylesheet).
5477`page-progression-direction`
5478 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5479 attribute for the [`spine` element].
5482 ~ iBooks-specific metadata, with the following fields:
5484 - `version`: (string)
5485 - `specified-fonts`: `true`|`false` (default `false`)
5486 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5487 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5488 - `binding`: `true`|`false` (default `true`)
5489 - `scroll-axis`: `vertical`|`horizontal`|`default`
5491[MARC relators]: http://loc.gov/marc/relators/relaterm.html
5492[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5494## The `epub:type` attribute
5496For `epub3` output, you can mark up the heading that corresponds to an EPUB
5497chapter using the [`epub:type` attribute][epub-type]. For example, to set
5498the attribute to the value `prologue`, use this markdown:
5500 # My chapter {epub:type=prologue}
5502Which will result in:
5504 <body epub:type="frontmatter">
5505 <section epub:type="prologue">
5508Pandoc will output `<body epub:type="bodymatter">`, unless
5509you use one of the following values, in which case either
5510`frontmatter` or `backmatter` will be output.
5512`epub:type` of first section `epub:type` of body
5513---------------------------- ------------------
5516acknowledgments frontmatter
5517copyright-page frontmatter
5518dedication frontmatter
5522contributors frontmatter
5523other-credits frontmatter
5525revision-history frontmatter
5526titlepage frontmatter
5527halftitlepage frontmatter
5528seriespage frontmatter
5531seriespage frontmatter
5532titlepage frontmatter
5535bibliography backmatter
5538[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5542By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5543`<video>` or `<source>` element present in the generated EPUB,
5544and include it in the EPUB container, yielding a completely
5545self-contained EPUB. If you want to link to external media resources
5546instead, use raw HTML in your source and add `data-external="1"` to the tag
5547with the `src` attribute. For example:
5549 <audio controls="1">
5550 <source src="http://example.com/music/toccata.mp3"
5551 data-external="1" type="audio/mpeg">
5555# Creating Jupyter notebooks with pandoc
5557When creating a [Jupyter notebook], pandoc will try to infer the
5558notebook structure. Code blocks with the class `code` will be
5559taken as code cells, and intervening content will be taken as
5560Markdown cells. Attachments will automatically be created for
5561images in Markdown cells. Metadata will be taken from the
5562`jupyter` metadata field. For example:
5571 display_name: Python 2
5578 file_extension: ".py"
5579 mimetype: "text/x-python"
5581 nbconvert_exporter: "python"
5582 pygments_lexer: "ipython2"
5588**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5589bibendum felis dictum sodales.
5598from IPython.display import HTML
5601console.log("hello");
5609This image  will be
5610included as a cell attachment.
5613If you want to add cell attributes, group cells differently, or
5614add output to code cells, then you need to include divs to
5615indicate the structure. You can use either [fenced
5616divs][Extension: `fenced_divs`] or [native divs][Extension:
5617`native_divs`] for this. Here is an example:
5620:::::: {.cell .markdown}
5623**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5624bibendum felis dictum sodales.
5627:::::: {.cell .code execution_count=1}
5632::: {.output .stream .stdout}
5639:::::: {.cell .code execution_count=2}
5641from IPython.display import HTML
5644console.log("hello");
5650::: {.output .execute_result execution_count=2}
5653console.log("hello");
5662If you include raw HTML or TeX in an output cell, use the
5663[raw attribute][Extension: `fenced_attribute`], as shown
5664in the last cell of the example above. Although pandoc can
5665process "bare" raw HTML and TeX, the result is often
5666interspersed raw elements and normal textual elements, and
5667in an output cell pandoc expects a single, connected raw
5668block. To avoid using raw HTML or TeX except when
5669marked explicitly using raw attributes, we recommend
5670specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5671translating between Markdown and ipynb notebooks.
5673Note that options and extensions that affect reading and
5674writing of Markdown will also affect Markdown cells in ipynb
5675notebooks. For example, `--wrap=preserve` will preserve
5676soft line breaks in Markdown cells; `--atx-headers` will
5677cause ATX-style headings to be used; and `--preserve-tabs` will
5678prevent tabs from being turned to spaces.
5680# Syntax highlighting
5682Pandoc will automatically highlight syntax in [fenced code blocks] that
5683are marked with a language name. The Haskell library [skylighting] is
5684used for highlighting. Currently highlighting is supported only for
5685HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5686that pandoc will recognize, type `pandoc --list-highlight-languages`.
5688The color scheme can be selected using the `--highlight-style` option.
5689The default color scheme is `pygments`, which imitates the default color
5690scheme used by the Python library pygments (though pygments is not actually
5691used to do the highlighting). To see a list of highlight styles,
5692type `pandoc --list-highlight-styles`.
5694If you are not satisfied with the predefined styles, you can
5695use `--print-highlight-style` to generate a JSON `.theme` file which
5696can be modified and used as the argument to `--highlight-style`. To
5697get a JSON version of the `pygments` style, for example:
5699 pandoc --print-highlight-style pygments > my.theme
5701Then edit `my.theme` and use it like this:
5703 pandoc --highlight-style my.theme
5705If you are not satisfied with the built-in highlighting, or you
5706want highlight a language that isn't supported, you can use the
5707`--syntax-definition` option to load a [KDE-style XML syntax definition
5708file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5709Before writing your own, have a look at KDE's [repository of syntax
5710definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5712To disable highlighting, use the `--no-highlight` option.
5714[skylighting]: https://github.com/jgm/skylighting
5718Custom styles can be used in the docx and ICML formats.
5722By default, pandoc's docx and ICML output applies a predefined set of styles
5723for blocks such as paragraphs and block quotes, and uses largely default
5724formatting (italics, bold) for inlines. This will work for most
5725purposes, especially alongside a `reference.docx` file. However, if you
5726need to apply your own styles to blocks, or match a preexisting set of
5727styles, pandoc allows you to define custom styles for blocks and text
5728using `div`s and `span`s, respectively.
5730If you define a `div` or `span` with the attribute `custom-style`,
5731pandoc will apply your specified style to the contained elements (with
5732the exception of elements whose function depends on a style, like
5733headings, code blocks, block quotes, or links). So, for example, using
5734the `bracketed_spans` syntax,
5736 [Get out]{custom-style="Emphatically"}, he said.
5738would produce a docx file with "Get out" styled with character
5739style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5741 Dickinson starts the poem simply:
5743 ::: {custom-style="Poetry"}
5744 | A Bird came down the Walk---
5745 | He did not know I saw---
5748would style the two contained lines with the `Poetry` paragraph style.
5750For docx output, styles will be defined in the output file as inheriting
5751from normal text, if the styles are not yet in your reference.docx.
5752If they are already defined, pandoc will not alter the definition.
5754This feature allows for greatest customization in conjunction with
5755[pandoc filters]. If you want all paragraphs after block quotes to be
5756indented, you can write a filter to apply the styles necessary. If you
5757want all italics to be transformed to the `Emphasis` character style
5758(perhaps to change their color), you can write a filter which will
5759transform all italicized inlines to inlines within an `Emphasis`
5762For docx output, you don't need to enable any extensions for
5763custom styles to work.
5765[pandoc filters]: http://pandoc.org/filters.html
5769The docx reader, by default, only reads those styles that it can
5770convert into pandoc elements, either by direct conversion or
5771interpreting the derivation of the input document's styles.
5773By enabling the [`styles` extension](#ext-styles) in the docx reader
5774(`-f docx+styles`), you can produce output that maintains the styles
5775of the input document, using the `custom-style` class. Paragraph
5776styles are interpreted as divs, while character styles are interpreted
5779For example, using the `custom-style-reference.docx` file in the test
5780directory, we have the following different outputs:
5782Without the `+styles` extension:
5784 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5787 This is text with an *emphasized* text style. And this is text with a
5788 **strengthened** text style.
5790 > Here is a styled paragraph that inherits from Block Text.
5792And with the extension:
5794 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5796 ::: {custom-style="First Paragraph"}
5800 ::: {custom-style="Body Text"}
5801 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5802 And this is text with a [strengthened]{custom-style="Strengthened"}
5806 ::: {custom-style="My Block Style"}
5807 > Here is a styled paragraph that inherits from Block Text.
5810With these custom styles, you can use your input document as a
5811reference-doc while creating docx output (see below), and maintain the
5812same styles in your input and output files.
5816Pandoc can be extended with custom writers written in [lua]. (Pandoc
5817includes a lua interpreter, so lua need not be installed separately.)
5819To use a custom writer, simply specify the path to the lua script
5820in place of the output format. For example:
5822 pandoc -t data/sample.lua
5824Creating a custom writer requires writing a lua function for each
5825possible element in a pandoc document. To get a documented example
5826which you can modify according to your needs, do
5828 pandoc --print-default-data-file sample.lua
5830Note that custom writers have no default template. If you want
5831to use `--standalone` with a custom writer, you will need to
5832specify a template manually using `--template` or add a new
5833default template with the name
5834`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5835subdirectory of your user data directory (see [Templates]).
5837[lua]: http://www.lua.org
5841If you use pandoc to convert user-contributed content in a web
5842application, here are some things to keep in mind:
58441. Although pandoc itself will not create or modify any files other
5845 than those you explicitly ask it create (with the exception
5846 of temporary files used in producing PDFs), a filter or custom
5847 writer could in principle do anything on your file system. Please
5848 audit filters and custom writers very carefully before using them.
58502. If your application uses pandoc as a Haskell library (rather than
5851 shelling out to the executable), it is possible to use it in a mode
5852 that fully isolates pandoc from your file system, by running the
5853 pandoc operations in the `PandocPure` monad. See the document
5854 [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
58573. Pandoc's parsers can exhibit pathological performance on some
5858 corner cases. It is wise to put any pandoc operations under
5859 a timeout, to avoid DOS attacks that exploit these issues.
5860 If you are using the pandoc executable, you can add the
5861 command line options `+RTS -M512M -RTS` (for example) to limit
5862 the heap size to 512MB.
58644. The HTML generated by pandoc is not guaranteed to be safe.
5865 If `raw_html` is enabled for the Markdown input, users can
5866 inject arbitrary HTML. Even if `raw_html` is disabled,
5867 users can include dangerous content in attributes for
5868 headings, spans, and code blocks. To be safe, you should
5869 run all the generated HTML through an HTML sanitizer.
5873Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5874under the [GPL], version 2 or greater. This software carries no
5875warranty of any kind. (See COPYRIGHT for full copyright and
5876warranty notices.) For a full list of contributors, see the file
5877AUTHORS.md in the pandoc source code.
5879[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5880[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