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`]: https://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]: https://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`]: https://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 https://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 - `commonmark_x` ([CommonMark] Markdown with extensions)
230 - `creole` ([Creole 1.0])
231 - `csv` ([CSV] table)
232 - `docbook` ([DocBook])
233 - `docx` ([Word docx])
234 - `dokuwiki` ([DokuWiki markup])
236 - `fb2` ([FictionBook2] e-book)
237 - `gfm` ([GitHub-Flavored Markdown]),
238 or the deprecated and less accurate `markdown_github`;
239 use [`markdown_github`](#markdown-variants) only
240 if you need extensions not supported in [`gfm`](#markdown-variants).
241 - `haddock` ([Haddock markup])
243 - `ipynb` ([Jupyter notebook])
244 - `jats` ([JATS] XML)
245 - `jira` ([Jira] wiki markup)
246 - `json` (JSON version of native AST)
248 - `markdown` ([Pandoc's Markdown])
249 - `markdown_mmd` ([MultiMarkdown])
250 - `markdown_phpextra` ([PHP Markdown Extra])
251 - `markdown_strict` (original unextended [Markdown])
252 - `mediawiki` ([MediaWiki markup])
255 - `native` (native Haskell)
258 - `org` ([Emacs Org mode])
259 - `rst` ([reStructuredText])
261 - `textile` ([Textile])
262 - `tikiwiki` ([TikiWiki markup])
263 - `twiki` ([TWiki markup])
264 - `vimwiki` ([Vimwiki])
267 Extensions can be individually enabled or disabled by
268 appending `+EXTENSION` or `-EXTENSION` to the format name.
269 See [Extensions] below, for a list of extensions and
270 their names. See `--list-input-formats` and `--list-extensions`,
273`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
275: Specify output format. *FORMAT* can be:
277 ::: {#output-formats}
278 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
279 - `beamer` ([LaTeX beamer][`beamer`] slide show)
280 - `commonmark` ([CommonMark] Markdown)
281 - `commonmark_x` ([CommonMark] Markdown with extensions)
282 - `context` ([ConTeXt])
283 - `docbook` or `docbook4` ([DocBook] 4)
284 - `docbook5` (DocBook 5)
285 - `docx` ([Word docx])
286 - `dokuwiki` ([DokuWiki markup])
287 - `epub` or `epub3` ([EPUB] v3 book)
289 - `fb2` ([FictionBook2] e-book)
290 - `gfm` ([GitHub-Flavored Markdown]),
291 or the deprecated and less accurate `markdown_github`;
292 use [`markdown_github`](#markdown-variants) only
293 if you need extensions not supported in [`gfm`](#markdown-variants).
294 - `haddock` ([Haddock markup])
295 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
296 - `html4` ([XHTML] 1.0 Transitional)
297 - `icml` ([InDesign ICML])
298 - `ipynb` ([Jupyter notebook])
299 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
300 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
301 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
302 - `jats` (alias for `jats_archiving`)
303 - `jira` ([Jira] wiki markup)
304 - `json` (JSON version of native AST)
307 - `markdown` ([Pandoc's Markdown])
308 - `markdown_mmd` ([MultiMarkdown])
309 - `markdown_phpextra` ([PHP Markdown Extra])
310 - `markdown_strict` (original unextended [Markdown])
311 - `mediawiki` ([MediaWiki markup])
314 - `native` (native Haskell),
315 - `odt` ([OpenOffice text document][ODT])
317 - `opendocument` ([OpenDocument])
318 - `org` ([Emacs Org mode])
320 - `plain` (plain text),
321 - `pptx` ([PowerPoint] slide show)
322 - `rst` ([reStructuredText])
323 - `rtf` ([Rich Text Format])
324 - `texinfo` ([GNU Texinfo])
325 - `textile` ([Textile])
326 - `slideous` ([Slideous] HTML and JavaScript slide show)
327 - `slidy` ([Slidy] HTML and JavaScript slide show)
328 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
329 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
330 - `s5` ([S5] HTML and JavaScript slide show)
331 - `tei` ([TEI Simple])
332 - `xwiki` ([XWiki markup])
333 - `zimwiki` ([ZimWiki markup])
334 - the path of a custom Lua writer, see [Custom writers] below
337 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
338 to *stdout* unless forced with `-o -`.
340 Extensions can be individually enabled or
341 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
342 name. See [Extensions] below, for a list of extensions and their
343 names. See `--list-output-formats` and `--list-extensions`, below.
345`-o` *FILE*, `--output=`*FILE*
347: Write output to *FILE* instead of *stdout*. If *FILE* is
348 `-`, output will go to *stdout*, even if a non-textual format
349 (`docx`, `odt`, `epub2`, `epub3`) is specified.
351`--data-dir=`*DIRECTORY*
353: Specify the user data directory to search for pandoc data files.
354 If this option is not specified, the default user data directory
355 will be used. On \*nix and macOS systems this will be the `pandoc`
356 subdirectory of the XDG data directory (by default,
357 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
358 environment variable). If that directory does not exist,
359 `$HOME/.pandoc` will be used (for backwards compatibility).
360 In Windows the default user data directory is
361 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
362 You can find the default user data directory on your system by
363 looking at the output of `pandoc --version`.
364 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
365 `slidy`, `slideous`, or `s5` directory
366 placed in this directory will override pandoc's normal defaults.
368`-d` *FILE*, `--defaults=`*FILE*
370: Specify a set of default option settings. *FILE* is a YAML
371 file whose fields correspond to command-line option
372 settings. All options for document conversion, including input
373 and output files, can be set using a defaults file. The file will
374 be searched for first in the working directory, and then in
375 the `defaults` subdirectory of the user data directory
376 (see `--data-dir`). The `.yaml` extension may be omitted.
377 See the section [Default files] for more information on the
378 file format. Settings from the defaults file may be
379 overridden or extended by subsequent options on the command
384: Generate a bash completion script. To enable bash completion
385 with pandoc, add this to your `.bashrc`:
387 eval "$(pandoc --bash-completion)"
391: Give verbose debugging output. Currently this only has an effect
396: Suppress warning messages.
400: Exit with error status if there are any warnings.
404: Write log messages in machine-readable JSON format to
405 *FILE*. All messages above DEBUG level will be written,
406 regardless of verbosity settings (`--verbose`, `--quiet`).
408`--list-input-formats`
410: List supported input formats, one per line.
412`--list-output-formats`
414: List supported output formats, one per line.
416`--list-extensions`[`=`*FORMAT*]
418: List supported extensions for *FORMAT*, one per line, preceded
419 by a `+` or `-` indicating whether it is enabled by default
420 in *FORMAT*. If *FORMAT* is not specified, defaults for
421 pandoc's Markdown are given.
423`--list-highlight-languages`
425: List supported languages for syntax highlighting, one per
428`--list-highlight-styles`
430: List supported styles for syntax highlighting, one per line.
431 See `--highlight-style`.
441[Markdown]: https://daringfireball.net/projects/markdown/
442[CommonMark]: https://commonmark.org
443[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
444[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
445[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
446[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
447[S5]: https://meyerweb.com/eric/tools/s5/
448[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
449[Slideous]: https://goessner.net/articles/slideous/
450[HTML]: https://www.w3.org/html/
451[HTML5]: https://html.spec.whatwg.org/
452[polyglot markup]: https://www.w3.org/TR/html-polyglot/
453[XHTML]: https://www.w3.org/TR/xhtml1/
454[LaTeX]: https://www.latex-project.org/
455[`beamer`]: https://ctan.org/pkg/beamer
456[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
457[ConTeXt]: https://www.contextgarden.net/
458[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
459[DocBook]: https://docbook.org
460[JATS]: https://jats.nlm.nih.gov
461[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
462[txt2tags]: https://txt2tags.org
463[EPUB]: http://idpf.org/epub
464[OPML]: http://dev.opml.org/spec2.html
465[OpenDocument]: http://opendocument.xml.org
466[ODT]: https://en.wikipedia.org/wiki/OpenDocument
467[Textile]: https://www.promptworks.com/textile
468[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
469[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
470[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
471[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
472[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
473[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
474[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
475[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
476[CSV]: https://tools.ietf.org/html/rfc4180
477[roff man]: https://man.cx/groff_man(7)
478[roff ms]: https://man.cx/groff_ms(7)
479[Haskell]: https://www.haskell.org
480[GNU Texinfo]: https://www.gnu.org/software/texinfo/
481[Emacs Org mode]: https://orgmode.org
482[AsciiDoc]: https://www.methods.co.nz/asciidoc/
483[AsciiDoctor]: https://asciidoctor.org/
484[DZSlides]: http://paulrouget.com/dzslides/
485[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
486[PDF]: https://www.adobe.com/pdf/
487[reveal.js]: https://revealjs.com/
488[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
489[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
490[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
491[TEI Simple]: https://github.com/TEIC/TEI-Simple
492[Muse]: https://amusewiki.org/library/manual
493[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
494[Vimwiki]: https://vimwiki.github.io
496## Reader options {.options}
498`--shift-heading-level-by=`*NUMBER*
500: Shift heading levels by a positive or negative integer.
501 For example, with `--shift-heading-level-by=-1`, level 2
502 headings become level 1 headings, and level 3 headings
503 become level 2 headings. Headings cannot have a level
504 less than 1, so a heading that would be shifted below level 1
505 becomes a regular paragraph. Exception: with a shift of -N,
506 a level-N heading at the beginning of the document
507 replaces the metadata title. `--shift-heading-level-by=-1`
508 is a good choice when converting HTML or Markdown documents that
509 use an initial level-1 heading for the document title and
510 level-2+ headings for sections. `--shift-heading-level-by=1`
511 may be a good choice for converting Markdown documents that
512 use level-1 headings for sections to HTML, since pandoc uses
513 a level-1 heading to render the document title.
515`--base-header-level=`*NUMBER*
517: *Deprecated. Use `--shift-heading-level-by`=X instead,
518 where X = NUMBER - 1.* Specify the base level for headings
521`--strip-empty-paragraphs`
523: *Deprecated. Use the `+empty_paragraphs` extension instead.*
524 Ignore paragraphs with no content. This option is useful
525 for converting word processing documents where users have
526 used empty paragraphs to create inter-paragraph space.
528`--indented-code-classes=`*CLASSES*
530: Specify classes to use for indented code blocks--for example,
531 `perl,numberLines` or `haskell`. Multiple classes may be separated
534`--default-image-extension=`*EXTENSION*
536: Specify a default extension to use when image paths/URLs have no
537 extension. This allows you to use the same source for formats that
538 require different kinds of images. Currently this option only affects
539 the Markdown and LaTeX readers.
543: Parse each file individually before combining for multifile
544 documents. This will allow footnotes in different files with the
545 same identifiers to work as expected. If this option is set,
546 footnotes and links will not work across files. Reading binary
547 files (docx, odt, epub) implies `--file-scope`.
549`-F` *PROGRAM*, `--filter=`*PROGRAM*
551: Specify an executable to be used as a filter transforming the
552 pandoc AST after the input is parsed and before the output is
553 written. The executable should read JSON from stdin and write
554 JSON to stdout. The JSON must be formatted like pandoc's own
555 JSON input and output. The name of the output format will be
556 passed to the filter as the first argument. Hence,
558 pandoc --filter ./caps.py -t latex
562 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
564 The latter form may be useful for debugging filters.
566 Filters may be written in any language. `Text.Pandoc.JSON`
567 exports `toJSONFilter` to facilitate writing filters in Haskell.
568 Those who would prefer to write filters in python can use the
569 module [`pandocfilters`], installable from PyPI. There are also
570 pandoc filter libraries in [PHP], [perl], and
571 [JavaScript/node.js].
573 In order of preference, pandoc will look for filters in
575 1. a specified full or relative path (executable or
578 2. `$DATADIR/filters` (executable or non-executable)
579 where `$DATADIR` is the user data directory (see
580 `--data-dir`, above).
582 3. `$PATH` (executable only)
584 Filters and Lua-filters are applied in the order specified
587`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
589: Transform the document in a similar fashion as JSON filters (see
590 `--filter`), but use pandoc's build-in Lua filtering system. The given
591 Lua script is expected to return a list of Lua filters which will be
592 applied in order. Each Lua filter must contain element-transforming
593 functions indexed by the name of the AST element on which the filter
594 function should be applied.
596 The `pandoc` Lua module provides helper functions for element
597 creation. It is always loaded into the script's Lua environment.
599 The following is an example Lua script for macro-expansion:
601 function expand_hello_world(inline)
602 if inline.c == '{{helloworld}}' then
603 return pandoc.Emph{ pandoc.Str "Hello, World" }
609 return {{Str = expand_hello_world}}
611 In order of preference, pandoc will look for Lua filters in
613 1. a specified full or relative path (executable or
616 2. `$DATADIR/filters` (executable or non-executable)
617 where `$DATADIR` is the user data directory (see
618 `--data-dir`, above).
620`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
622: Set the metadata field *KEY* to the value *VAL*. A value specified
623 on the command line overrides a value specified in the document
624 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
625 Values will be parsed as YAML boolean or string values. If no value is
626 specified, the value will be treated as Boolean true. Like
627 `--variable`, `--metadata` causes template variables to be set.
628 But unlike `--variable`, `--metadata` affects the metadata of the
629 underlying document (which is accessible from filters and may be
630 printed in some output formats) and metadata values will be escaped
631 when inserted into the template.
633`--metadata-file=`*FILE*
635: Read metadata from the supplied YAML (or JSON) file. This
636 option can be used with every input format, but string scalars
637 in the YAML file will always be parsed as Markdown. Generally,
638 the input will be handled the same as in [YAML metadata
639 blocks][Extension: `yaml_metadata_block`]. This option can be
640 used repeatedly to include multiple metadata files; values in
641 files specified later on the command line will be preferred
642 over those specified in earlier files. Metadata values
643 specified inside the document, or by using `-M`, overwrite
644 values specified with this option.
646`-p`, `--preserve-tabs`
648: Preserve tabs instead of converting them to spaces. (By default, pandoc
649 converts tabs to spaces before parsing its input.) Note that this will
650 only affect tabs in literal code spans and code blocks. Tabs in regular
651 text are always treated as spaces.
655: Specify the number of spaces per tab (default is 4).
657`--track-changes=accept`|`reject`|`all`
659: Specifies what to do with insertions, deletions, and comments
660 produced by the MS Word "Track Changes" feature. `accept` (the
661 default), inserts all insertions, and ignores all
662 deletions. `reject` inserts all deletions and ignores
663 insertions. Both `accept` and `reject` ignore comments. `all` puts
664 in insertions, deletions, and comments, wrapped in spans with
665 `insertion`, `deletion`, `comment-start`, and `comment-end`
666 classes, respectively. The author and time of change is
667 included. `all` is useful for scripting: only accepting changes
668 from a certain reviewer, say, or before a certain date. If a
669 paragraph is inserted or deleted, `track-changes=all` produces a
670 span with the class `paragraph-insertion`/`paragraph-deletion`
671 before the affected paragraph break. This option only affects the
674`--extract-media=`*DIR*
676: Extract images and other media contained in or linked from
677 the source document to the path *DIR*, creating it if
678 necessary, and adjust the images references in the document
679 so they point to the extracted files. If the source format is
680 a binary container (docx, epub, or odt), the media is
681 extracted from the container and the original
682 filenames are used. Otherwise the media is read from the
683 file system or downloaded, and new filenames are constructed
684 based on SHA1 hashes of the contents.
686`--abbreviations=`*FILE*
688: Specifies a custom abbreviations file, with abbreviations
689 one to a line. If this option is not specified, pandoc will
690 read the data file `abbreviations` from the user data
691 directory or fall back on a system default. To see the
693 `pandoc --print-default-data-file=abbreviations`. The only
694 use pandoc makes of this list is in the Markdown reader.
695 Strings ending in a period that are found in this list will
696 be followed by a nonbreaking space, so that the period will
697 not produce sentence-ending space in formats like LaTeX.
699[`pandocfilters`]: https://github.com/jgm/pandocfilters
700[PHP]: https://github.com/vinai/pandocfilters-php
701[perl]: https://metacpan.org/pod/Pandoc::Filter
702[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
704## General writer options {.options}
708: Produce output with an appropriate header and footer (e.g. a
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711 output. For `native` output, this option causes metadata to
712 be included; otherwise, metadata is suppressed.
714`--template=`*FILE*|*URL*
716: Use the specified file as a custom template for the generated document.
717 Implies `--standalone`. See [Templates], below, for a description
718 of template syntax. If no extension is specified, an extension
719 corresponding to the writer will be added, so that `--template=special`
720 looks for `special.html` for HTML output. If the template is not
721 found, pandoc will search for it in the `templates` subdirectory of
722 the user data directory (see `--data-dir`). If this option is not used,
723 a default template appropriate for the output format will be used (see
724 `-D/--print-default-template`).
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
728: Set the template variable *KEY* to the value *VAL* when rendering the
729 document in standalone mode. If no *VAL* is specified, the
730 key will be given the value `true`.
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
734: Print the system default template for an output *FORMAT*. (See `-t`
735 for a list of possible *FORMAT*s.) Templates in the user data
736 directory are ignored. This option may be used with
737 `-o`/`--output` to redirect output to a file, but
738 `-o`/`--output` must come before `--print-default-template`
741 Note that some of the default templates use partials, for
742 example `styles.html`. To print the partials, use
743 `--print-default-data-file`: for example,
744 `--print-default-data-file=templates/styles.html`.
746`--print-default-data-file=`*FILE*
748: Print a system default data file. Files in the user data directory
749 are ignored. This option may be used with `-o`/`--output` to
750 redirect output to a file, but `-o`/`--output` must come before
751 `--print-default-data-file` on the command line.
753`--eol=crlf`|`lf`|`native`
755: Manually specify line endings: `crlf` (Windows), `lf`
756 (macOS/Linux/UNIX), or `native` (line endings appropriate
757 to the OS on which pandoc is being run). The default is
762: Specify the default dpi (dots per inch) value for conversion
763 from pixels to inch/centimeters and vice versa. (Technically,
764 the correct term would be ppi: pixels per inch.) The default
765 is 96dpi. When images contain information about dpi
766 internally, the encoded value is used instead of the default
767 specified by this option.
769`--wrap=auto`|`none`|`preserve`
771: Determine how text is wrapped in the output (the source
772 code, not the rendered version). With `auto` (the default),
773 pandoc will attempt to wrap lines to the column width specified by
774 `--columns` (default 72). With `none`, pandoc will not wrap
775 lines at all. With `preserve`, pandoc will attempt to
776 preserve the wrapping from the source document (that is,
777 where there are nonsemantic newlines in the source, there
778 will be nonsemantic newlines in the output as well).
779 Automatic wrapping does not currently work in HTML output.
780 In `ipynb` output, this option affects wrapping of the
781 contents of markdown cells.
785: Specify length of lines in characters. This affects text wrapping
786 in the generated source code (see `--wrap`). It also affects
787 calculation of column widths for plain text tables (see [Tables] below).
789`--toc`, `--table-of-contents`
791: Include an automatically generated table of contents (or, in
792 the case of `latex`, `context`, `docx`, `odt`,
793 `opendocument`, `rst`, or `ms`, an instruction to create
794 one) in the output document. This option has no effect
795 unless `-s/--standalone` is used, and it has no effect
796 on `man`, `docbook4`, `docbook5`, or `jats` output.
798 Note that if you are producing a PDF via `ms`, the table
799 of contents will appear at the beginning of the
800 document, before the title. If you would prefer it to
801 be at the end of the document, use the option
802 `--pdf-engine-opt=--no-toc-relocation`.
804`--toc-depth=`*NUMBER*
806: Specify the number of section levels to include in the table
807 of contents. The default is 3 (which means that level-1, 2, and 3
808 headings will be listed in the contents).
812: Strip out HTML comments in the Markdown or Textile source,
813 rather than passing them on to Markdown, Textile or HTML
814 output as raw HTML. This does not apply to HTML comments
815 inside raw HTML blocks when the `markdown_in_html_blocks`
816 extension is not set.
820: Disables syntax highlighting for code blocks and inlines, even when
821 a language attribute is given.
823`--highlight-style=`*STYLE*|*FILE*
825: Specifies the coloring style to be used in highlighted source code.
826 Options are `pygments` (the default), `kate`, `monochrome`,
827 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
828 For more information on syntax highlighting in pandoc, see
829 [Syntax highlighting], below. See also
830 `--list-highlight-styles`.
832 Instead of a *STYLE* name, a JSON file with extension
833 `.theme` may be supplied. This will be parsed as a KDE
834 syntax highlighting theme and (if valid) used as the
837 To generate the JSON version of an existing style,
838 use `--print-highlight-style`.
840`--print-highlight-style=`*STYLE*|*FILE*
842: Prints a JSON version of a highlighting style, which can
843 be modified, saved with a `.theme` extension, and used
844 with `--highlight-style`. This option may be used with
845 `-o`/`--output` to redirect output to a file, but
846 `-o`/`--output` must come before `--print-highlight-style`
849`--syntax-definition=`*FILE*
851: Instructs pandoc to load a KDE XML syntax definition file,
852 which will be used for syntax highlighting of appropriately
853 marked code blocks. This can be used to add support for
854 new languages or to use altered syntax definitions for
855 existing languages. This option may be repeated to add
856 multiple syntax definitions.
858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
860: Include contents of *FILE*, verbatim, at the end of the header.
861 This can be used, for example, to include special
862 CSS or JavaScript in HTML documents. This option can be used
863 repeatedly to include multiple files in the header. They will be
864 included in the order specified. Implies `--standalone`.
866`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
868: Include contents of *FILE*, verbatim, at the beginning of the
869 document body (e.g. after the `<body>` tag in HTML, or the
870 `\begin{document}` command in LaTeX). This can be used to include
871 navigation bars or banners in HTML documents. This option can be
872 used repeatedly to include multiple files. They will be included in
873 the order specified. Implies `--standalone`.
875`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
877: Include contents of *FILE*, verbatim, at the end of the document
878 body (before the `</body>` tag in HTML, or the
879 `\end{document}` command in LaTeX). This option can be used
880 repeatedly to include multiple files. They will be included in the
881 order specified. Implies `--standalone`.
883`--resource-path=`*SEARCHPATH*
885: List of paths to search for images and other resources.
886 The paths should be separated by `:` on Linux, UNIX, and
887 macOS systems, and by `;` on Windows. If `--resource-path`
888 is not specified, the default resource path is the working
889 directory. Note that, if `--resource-path` is specified,
890 the working directory must be explicitly listed or it
891 will not be searched. For example:
892 `--resource-path=.:test` will search the working directory
893 and the `test` subdirectory, in that order.
895 `--resource-path` only has an effect if (a) the output
896 format embeds images (for example, `docx`, `pdf`, or `html`
897 with `--self-contained`) or (b) it is used together with
900`--request-header=`*NAME*`:`*VAL*
902: Set the request header *NAME* to the value *VAL* when making
903 HTTP requests (for example, when a URL is given on the
904 command line, or when resources used in a document must be
905 downloaded). If you're behind a proxy, you also need to set
906 the environment variable `http_proxy` to `http://...`.
908`--no-check-certificate
910: Disable the certificate verification to allow access to
911 unsecure HTTP resources (for example when the certificate
912 is no longer valid or self signed).
914## Options affecting specific writers {.options}
918: Produce a standalone HTML file with no external dependencies, using
919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
920 images, and videos. Implies `--standalone`. The resulting file should be
921 "self-contained," in the sense that it needs no external files and no net
922 access to be displayed properly by a browser. This option works only with
923 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925 and stylesheets at absolute URLs will be downloaded; those at relative
926 URLs will be sought relative to the working directory (if the first source
927 file is local) or relative to the base URL (if the first source
928 file is remote). Elements with the attribute
929 `data-external="1"` will be left alone; the documents they
930 link to will not be incorporated in the document.
931 Limitation: resources that are loaded dynamically through
932 JavaScript cannot be incorporated; as a result,
933 `--self-contained` does not work with `--mathjax`, and some
934 advanced features (e.g. zoom or speaker notes) may not work
935 in an offline "self-contained" `reveal.js` slide show.
939: Use `<q>` tags for quotes in HTML.
943: Use only ASCII characters in output. Currently supported for XML
944 and HTML formats (which use entities instead of UTF-8 when this
945 option is selected), CommonMark, gfm, and Markdown (which use
946 entities), roff ms (which use hexadecimal escapes), and to a
947 limited degree LaTeX (which uses standard commands for accented
948 characters when possible). roff man output uses ASCII by default.
952: Use reference-style links, rather than inline links, in writing Markdown
953 or reStructuredText. By default inline links are used. The
954 placement of link references is affected by the
955 `--reference-location` option.
957`--reference-location = block`|`section`|`document`
959: Specify whether footnotes (and references, if `reference-links` is
960 set) are placed at the end of the current (top-level) block, the
961 current section, or the document. The default is
962 `document`. Currently only affects the markdown writer.
966: Use ATX-style headings in Markdown output. The default is
967 to use setext-style headings for levels 1 to 2, and then ATX headings.
968 (Note: for `gfm` output, ATX headings are always used.)
969 This option also affects markdown cells in `ipynb` output.
971`--top-level-division=[default|section|chapter|part]`
973: Treat top-level headings as the given division type in LaTeX, ConTeXt,
974 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
975 all headings are shifted such that the top-level heading becomes the specified
976 type. The default behavior is to determine the best division type via
977 heuristics: unless other conditions apply, `section` is chosen. When the
978 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
979 `article` option is specified), `chapter` is implied as the setting for this
980 option. If `beamer` is the output format, specifying either `chapter` or
981 `part` will cause top-level headings to become `\part{..}`, while
982 second-level headings remain as their default type.
984`-N`, `--number-sections`
986: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
987 By default, sections are not numbered. Sections with class
988 `unnumbered` will never be numbered, even if `--number-sections`
991`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
993: Offset for section headings in HTML output (ignored in other
994 output formats). The first number is added to the section number for
995 top-level headings, the second for second-level headings, and so on.
996 So, for example, if you want the first top-level heading in your
997 document to be numbered "6", specify `--number-offset=5`.
998 If your document starts with a level-2 heading which you want to
999 be numbered "1.5", specify `--number-offset=1,4`.
1000 Offsets are 0 by default. Implies `--number-sections`.
1004: Use the [`listings`] package for LaTeX code blocks. The package
1005 does not support multi-byte encoding for source code. To handle UTF-8
1006 you would need to use a custom template. This issue is fully
1007 documented here: [Encoding issue with the listings package].
1009`-i`, `--incremental`
1011: Make list items in slide shows display incrementally (one by one).
1012 The default is for lists to be displayed all at once.
1014`--slide-level=`*NUMBER*
1016: Specifies that headings with the specified level create
1017 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1018 above this level in the hierarchy are used to divide the
1019 slide show into sections; headings below this level create
1020 subheads within a slide. Note that content that is
1021 not contained under slide-level headings will not appear in
1022 the slide show. The default is to set the slide level based
1023 on the contents of the document; see [Structuring the slide
1028: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1029 and attach identifiers to the enclosing `<section>` (or `<div>`)
1030 rather than the heading itself. See
1031 [Heading identifiers], below.
1033`--email-obfuscation=none`|`javascript`|`references`
1035: Specify a method for obfuscating `mailto:` links in HTML documents.
1036 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1037 them using JavaScript. `references` obfuscates them by printing their
1038 letters as decimal or hexadecimal character references. The default
1041`--id-prefix=`*STRING*
1043: Specify a prefix to be added to all identifiers and internal links
1044 in HTML and DocBook output, and to footnote numbers in Markdown
1045 and Haddock output. This is useful for preventing duplicate
1046 identifiers when generating fragments to be included in other pages.
1048`-T` *STRING*, `--title-prefix=`*STRING*
1050: Specify *STRING* as a prefix at the beginning of the title
1051 that appears in the HTML header (but not in the title as it
1052 appears at the beginning of the HTML body). Implies `--standalone`.
1054`-c` *URL*, `--css=`*URL*
1056: Link to a CSS style sheet. This option can be used repeatedly to
1057 include multiple files. They will be included in the order specified.
1059 A stylesheet is required for generating EPUB. If none is
1060 provided using this option (or the `css` or `stylesheet`
1061 metadata fields), pandoc will look for a file `epub.css` in the
1062 user data directory (see `--data-dir`). If it is not
1063 found there, sensible defaults will be used.
1065`--reference-doc=`*FILE*
1067: Use the specified file as a style reference in producing a
1072 : For best results, the reference docx should be a modified
1073 version of a docx file produced using pandoc. The contents
1074 of the reference docx are ignored, but its stylesheets and
1075 document properties (including margins, page size, header,
1076 and footer) are used in the new docx. If no reference docx
1077 is specified on the command line, pandoc will look for a
1078 file `reference.docx` in the user data directory (see
1079 `--data-dir`). If this is not found either, sensible
1080 defaults will be used.
1082 To produce a custom `reference.docx`, first get a copy of
1083 the default `reference.docx`: `pandoc
1084 -o custom-reference.docx --print-default-data-file reference.docx`.
1085 Then open `custom-reference.docx` in Word, modify the
1086 styles as you wish, and save the file. For best
1087 results, do not make changes to this file other than
1088 modifying the styles used by pandoc:
1124 - Default Paragraph Font
1127 - Footnote Reference
1136 : For best results, the reference ODT should be a modified
1137 version of an ODT produced using pandoc. The contents of
1138 the reference ODT are ignored, but its stylesheets are used
1139 in the new ODT. If no reference ODT is specified on the
1140 command line, pandoc will look for a file `reference.odt` in
1141 the user data directory (see `--data-dir`). If this is not
1142 found either, sensible defaults will be used.
1144 To produce a custom `reference.odt`, first get a copy of
1145 the default `reference.odt`: `pandoc
1146 -o custom-reference.odt --print-default-data-file reference.odt`.
1147 Then open `custom-reference.odt` in LibreOffice, modify
1148 the styles as you wish, and save the file.
1152 : Templates included with Microsoft PowerPoint 2013 (either with
1153 `.pptx` or `.potx` extension) are known to work, as are most
1154 templates derived from these.
1156 The specific requirement is that the template should begin with
1157 the following first four layouts:
1160 2. Title and Content
1164 All templates included with a recent version of MS PowerPoint
1165 will fit these criteria. (You can click on `Layout` under the
1166 `Home` menu to check.)
1168 You can also modify the default `reference.pptx`: first run
1169 `pandoc -o custom-reference.pptx --print-default-data-file
1170 reference.pptx`, and then modify `custom-reference.pptx`
1171 in MS PowerPoint (pandoc will use the first four layout
1172 slides, as mentioned above).
1174`--epub-cover-image=`*FILE*
1176: Use the specified image as the EPUB cover. It is recommended
1177 that the image be less than 1000px in width and height. Note that
1178 in a Markdown source document you can also specify `cover-image`
1179 in a YAML metadata block (see [EPUB Metadata], below).
1181`--epub-metadata=`*FILE*
1183: Look in the specified XML file for metadata for the EPUB.
1184 The file should contain a series of [Dublin Core elements].
1187 <dc:rights>Creative Commons</dc:rights>
1188 <dc:language>es-AR</dc:language>
1190 By default, pandoc will include the following metadata elements:
1191 `<dc:title>` (from the document title), `<dc:creator>` (from the
1192 document authors), `<dc:date>` (from the document date, which should
1193 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1194 variable, or, if is not set, the locale), and `<dc:identifier
1195 id="BookId">` (a randomly generated UUID). Any of these may be
1196 overridden by elements in the metadata file.
1198 Note: if the source document is Markdown, a YAML metadata block
1199 in the document can be used instead. See below under
1202`--epub-embed-font=`*FILE*
1204: Embed the specified font in the EPUB. This option can be repeated
1205 to embed multiple fonts. Wildcards can also be used: for example,
1206 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1207 line, be sure to escape them or put the whole filename in single quotes,
1208 to prevent them from being interpreted by the shell. To use the
1209 embedded fonts, you will need to add declarations like the following
1210 to your CSS (see `--css`):
1213 font-family: DejaVuSans;
1215 font-weight: normal;
1216 src:url("DejaVuSans-Regular.ttf");
1219 font-family: DejaVuSans;
1222 src:url("DejaVuSans-Bold.ttf");
1225 font-family: DejaVuSans;
1227 font-weight: normal;
1228 src:url("DejaVuSans-Oblique.ttf");
1231 font-family: DejaVuSans;
1234 src:url("DejaVuSans-BoldOblique.ttf");
1236 body { font-family: "DejaVuSans"; }
1238`--epub-chapter-level=`*NUMBER*
1240: Specify the heading level at which to split the EPUB into separate
1241 "chapter" files. The default is to split into chapters at level-1
1242 headings. This option only affects the internal composition of the
1243 EPUB, not the way chapters and sections are displayed to users. Some
1244 readers may be slow if the chapter files are too large, so for large
1245 documents with few level-1 headings, one might want to use a chapter
1248`--epub-subdirectory=`*DIRNAME*
1250: Specify the subdirectory in the OCF container that is to hold
1251 the EPUB-specific contents. The default is `EPUB`. To put
1252 the EPUB contents in the top level, use an empty string.
1254`--ipynb-output=all|none|best`
1256: Determines how ipynb output cells are treated. `all` means
1257 that all of the data formats included in the original are
1258 preserved. `none` means that the contents of data cells
1259 are omitted. `best` causes pandoc to try to pick the
1260 richest data block in each output cell that is compatible
1261 with the output format. The default is `best`.
1263`--pdf-engine=`*PROGRAM*
1265: Use the specified engine when producing PDF output.
1266 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1267 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1268 and `pdfroff`. If the engine is not in your PATH, the full
1269 path of the engine may be specified here. If this option
1270 is not specified, pandoc uses the following defaults
1271 depending on the output format specified using `-t/--to`:
1273 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1274 `tectonic`, `latexmk`)
1275 - `-t context`: `context`
1276 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1277 see [print-css.rocks](https://print-css.rocks) for a good
1278 introduction to PDF generation from HTML/CSS.)
1279 - `-t ms`: `pdfroff`
1281`--pdf-engine-opt=`*STRING*
1283: Use the given string as a command-line argument to the `pdf-engine`.
1284 For example, to use a persistent directory `foo` for `latexmk`'s
1285 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1286 Note that no check for duplicate options is done.
1288[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1289[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1290[Encoding issue with the listings package]:
1291 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1293## Citation rendering {.options}
1295`--bibliography=`*FILE*
1297: Set the `bibliography` field in the document's metadata to *FILE*,
1298 overriding any value set in the metadata, and process citations
1299 using `pandoc-citeproc`. (This is equivalent to
1300 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1301 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1302 used, making this equivalent to `--metadata bibliography=FILE`.
1303 If you supply this argument multiple times, each *FILE* will be added
1308: Set the `csl` field in the document's metadata to *FILE*,
1309 overriding any value set in the metadata. (This is equivalent to
1310 `--metadata csl=FILE`.)
1311 This option is only relevant with `pandoc-citeproc`.
1313`--citation-abbreviations=`*FILE*
1315: Set the `citation-abbreviations` field in the document's metadata to
1316 *FILE*, overriding any value set in the metadata. (This is equivalent to
1317 `--metadata citation-abbreviations=FILE`.)
1318 This option is only relevant with `pandoc-citeproc`.
1322: Use [`natbib`] for citations in LaTeX output. This option is not for use
1323 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1324 use in producing a LaTeX file that can be processed with [`bibtex`].
1328: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1329 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1330 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1332## Math rendering in HTML {.options}
1334The default is to render TeX math as far as possible using Unicode characters.
1335Formulas are put inside a `span` with `class="math"`, so that they may be styled
1336differently from the surrounding text if needed. However, this gives acceptable
1337results only for basic math, usually you will want to use `--mathjax` or another
1338of the following options.
1340`--mathjax`[`=`*URL*]
1342: Use [MathJax] to display embedded TeX math in HTML output.
1343 TeX math will be put between `\(...\)` (for inline math)
1344 or `\[...\]` (for display math) and wrapped in `<span>` tags
1345 with class `math`. Then the MathJax JavaScript will render it.
1346 The *URL* should point to the `MathJax.js` load script.
1347 If a *URL* is not provided, a link to the Cloudflare CDN will
1352: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1353 `html4` and `html5`). This is the default in `odt` output. Note that
1354 currently only Firefox and Safari (and select e-book readers) natively
1359: Convert TeX formulas to `<img>` tags that link to an external script
1360 that converts formulas to images. The formula will be URL-encoded
1361 and concatenated with the URL provided. For SVG images you can for
1362 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1363 If no URL is specified, the CodeCogs URL generating PNGs
1364 will be used (`https://latex.codecogs.com/png.latex?`).
1365 Note: the `--webtex` option will affect Markdown output
1366 as well as HTML, which is useful if you're targeting a
1367 version of Markdown without native math support.
1371: Use [KaTeX] to display embedded TeX math in HTML output.
1372 The *URL* is the base URL for the KaTeX library. That directory
1373 should contain a `katex.min.js` and a `katex.min.css` file.
1374 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1378: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1379 can then be processed by [GladTeX] to produce images of the typeset
1380 formulas and an HTML file with links to these images.
1381 So, the procedure is:
1383 pandoc -s --gladtex input.md -o myfile.htex
1384 gladtex -d myfile-images myfile.htex
1385 # produces myfile.html and images in myfile-images
1387[MathML]: https://www.w3.org/Math/
1388[MathJax]: https://www.mathjax.org
1389[KaTeX]: https://github.com/Khan/KaTeX
1390[GladTeX]: https://humenda.github.io/GladTeX/
1392## Options for wrapper scripts {.options}
1396: Print information about command-line arguments to *stdout*, then exit.
1397 This option is intended primarily for use in wrapper scripts.
1398 The first line of output contains the name of the output file specified
1399 with the `-o` option, or `-` (for *stdout*) if no output file was
1400 specified. The remaining lines contain the command-line arguments,
1401 one per line, in the order they appear. These do not include regular
1402 pandoc options and their arguments, but do include any options appearing
1403 after a `--` separator at the end of the line.
1407: Ignore command-line arguments (for use in wrapper scripts).
1408 Regular pandoc options are not ignored. Thus, for example,
1410 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1414 pandoc -o foo.html -s
1418If pandoc completes successfully, it will return exit code 0.
1419Nonzero exit codes have the following meanings:
1422----- ------------------------------------
1423 3 PandocFailOnWarningError
1425 5 PandocTemplateError
1427 21 PandocUnknownReaderError
1428 22 PandocUnknownWriterError
1429 23 PandocUnsupportedExtensionError
1430 31 PandocEpubSubdirectoryError
1432 47 PandocPDFProgramNotFoundError
1434 62 PandocShouldNeverHappenError
1437 65 PandocParsecError
1438 66 PandocMakePDFError
1439 67 PandocSyntaxMapError
1440 83 PandocFilterError
1442 92 PandocUTF8DecodingError
1443 93 PandocIpynbDecodingError
1444 97 PandocCouldNotFindDataFileError
1445 99 PandocResourceNotFound
1446----- ------------------------------------
1450The `--defaults` option may be used to specify a package
1451of options. Here is a sample defaults file demonstrating all of
1452the fields that may be used:
1456# reader: may be used instead of from:
1458# writer: may be used instead of to:
1460# leave blank for output to stdout:
1462# leave blank for input from stdin, use [] for no input:
1466# or you may use input-file: with a single value
1470self-contained: false
1472# note that structured variables may be specified:
1479# metadata values specified here are parsed as literal
1480# string text, not markdown:
1487# or you may use metadata-file: with a single value
1489# Note that these take files, not their contents:
1490include-before-body: []
1491include-after-body: []
1492include-in-header: []
1495# filters will be assumed to be Lua filters if they have
1496# the .lua extension, and json filters otherwise. But
1497# the filter type can also be specified explicitly, as shown:
1508# ERROR, WARNING, or INFO
1512# citeproc, natbib, or biblatex
1513cite-method: citeproc
1514# part, chapter, section, or default:
1515top-level-division: chapter
1521# you may also use pdf-engine-opt: with a single option
1522# pdf-engine-opt: "-shell-escape"
1524# auto, preserve, or none
1529extract-media: mediadir
1531table-of-contents: true
1533number-sections: false
1534# a list of offsets at each heading level
1535number-offset: [0,0,0,0,0,0]
1536# toc: may also be used instead of table-of-contents:
1537shift-heading-level-by: 1
1539identifier-prefix: foo
1541strip-empty-paragraphs: true
1542# lf, crlf, or native
1544strip-comments: false
1545indented-code-classes: []
1547default-image-extension: ".jpg"
1549# either a style name of a style definition file:
1550highlight-style: pygments
1553# or you may use syntax-definition: with a single value
1556reference-doc: myref.docx
1558# method is plain, webtex, gladtex, mathml, mathjax, katex
1559# you may specify a url with webtex, mathjax, katex
1562 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1563# none, references, or javascript
1564email-obfuscation: javascript
1572epub-subdirectory: EPUB
1573epub-metadata: meta.xml
1576epub-chapter-level: 1
1577epub-cover-image: cover.jpg
1579reference-links: true
1580# block, section, or document
1581reference-location: block
1584# accept, reject, or all
1585track-changes: accept
1594# A list of two-element lists
1596- ["User-Agent", "Mozilla/5.0"]
1598fail-if-warnings: false
1604Fields that are omitted will just have their regular
1605default values. So a defaults file can be as simple as
1612Default files can be placed in the `defaults` subdirectory of
1613the user data directory and used from any directory. For
1614example, one could create a file specifying defaults for writing
1615letters, save it as `letter.yaml` in the `defaults` subdirectory
1616of the user data directory, and then invoke these defaults
1617from any directory using `pandoc --defaults letter`
1618or `pandoc -dletter`.
1620When multiple defaults are used, their contents will be combined.
1622Note that, where command-line arguments may be repeated
1623(`--metadata-file`, `--css`, `--include-in-header`,
1624`--include-before-body`, `--include-after-body`, `--variable`,
1625`--metadata`, `--syntax-definition`), the values specified on
1626the command line will combine with values specified in the
1627defaults file, rather than replacing them.
1631When the `-s/--standalone` option is used, pandoc uses a template to
1632add header and footer material that is needed for a self-standing
1633document. To see the default template that is used, just type
1637where *FORMAT* is the name of the output format. A custom template
1638can be specified using the `--template` option. You can also override
1639the system default templates for a given output format *FORMAT*
1640by putting a file `templates/default.*FORMAT*` in the user data
1641directory (see `--data-dir`, above). *Exceptions:*
1643- For `odt` output, customize the `default.opendocument`
1645- For `pdf` output, customize the `default.latex` template
1646 (or the `default.context` template, if you use `-t context`,
1647 or the `default.ms` template, if you use `-t ms`, or the
1648 `default.html` template, if you use `-t html`).
1649- `docx` and `pptx` have no template (however, you can use
1650 `--reference-doc` to customize the output).
1652Templates contain *variables*, which allow for the inclusion of
1653arbitrary information at any point in the file. They may be set at the
1654command line using the `-V/--variable` option. If a variable is not set,
1655pandoc will look for the key in the document's metadata, which can be set
1656using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1657or with the `-M/--metadata` option. In addition, some variables
1658are given default values by pandoc. See [Variables] below for
1659a list of variables used in pandoc's default templates.
1661If you use custom templates, you may need to revise them as pandoc
1662changes. We recommend tracking the changes in the default templates,
1663and modifying your custom templates accordingly. An easy way to do this
1664is to fork the [pandoc-templates] repository and merge in
1665changes after each pandoc release.
1667 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1673Anything between the sequence `$--` and the end of the
1674line will be treated as a comment and omitted from the output.
1678To mark variables and control structures in the template,
1679either `$`...`$` or `${`...`}` may be used as delimiters.
1680The styles may also be mixed in the same template, but the
1681opening and closing delimiter must match in each case. The
1682opening delimiter may be followed by one or more spaces
1683or tabs, which will be ignored. The closing delimiter may
1684be followed by one or more spaces or tabs, which will be
1687To include a literal `$` in the document, use `$$`.
1689### Interpolated variables
1691A slot for an interpolated variable is a variable name surrounded
1692by matched delimiters. Variable names must begin with a letter
1693and can contain letters, numbers, `_`, `-`, and `.`. The
1694keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1695not be used as variable names. Examples:
1708Variable names with periods are used to get at structured
1709variable values. So, for example, `employee.salary` will return the
1710value of the `salary` field of the object that is the value of
1711the `employee` field.
1713- If the value of the variable is simple value, it will be
1714 rendered verbatim. (Note that no escaping is done;
1715 the assumption is that the calling program will escape
1716 the strings appropriately for the output format.)
1717- If the value is a list, the values will be concatenated.
1718- If the value is a map, the string `true` will be rendered.
1719- Every other value will be rendered as the empty string.
1723A conditional begins with `if(variable)` (enclosed in
1724matched delimiters) and ends with `endif` (enclosed in matched
1725delimiters). It may optionally contain an `else` (enclosed in
1726matched delimiters). The `if` section is used if
1727`variable` has a non-empty value, otherwise the `else`
1728section is used (if present). Examples:
1743${if(foo)}bar${endif}
1756The keyword `elseif` may be used to simplify complex nested
1771A for loop begins with `for(variable)` (enclosed in
1772matched delimiters) and ends with `endfor` (enclosed in matched
1775- If `variable` is an array, the material inside the loop will
1776 be evaluated repeatedly, with `variable` being set to each
1777 value of the array in turn, and concatenated.
1778- If `variable` is a map, the material inside will be set to
1780- If the value of the associated variable is not an array or
1781 a map, a single iteration will be performed on its value.
1786$for(foo)$$foo$$sep$, $endfor$
1789 - $foo.last$, $foo.first$
1793 - ${ foo.bar.last }, ${ foo.bar.first }
1797$it.name$: $it.office$
1801You may optionally specify a separator between consecutive
1802values using `sep` (enclosed in matched delimiters). The
1803material between `sep` and the `endfor` is the separator.
1806${ for(foo) }${ foo }${ sep }, ${ endfor }
1809Instead of using `variable` inside the loop, the special
1810anaphoric keyword `it` may be used.
1814 - ${ it.last }, ${ it.first }
1820Partials (subtemplates stored in different files) may be
1821included using the syntax
1827Partials will be sought in the directory containing
1828the main template, and will be assumed to have the
1829same extension as the main template if they lack
1830an explicit extension. (If the partials are not
1831found here, they will also be sought in the `templates`
1832subdirectory of the user data directory.)
1834Partials may optionally be applied to variables using
1840${ articles:bibentry() }
1843If `articles` is an array, this will iterate over its
1844values, applying the partial `bibentry()` to each one. So the
1845second example above is equivalent to
1853Note that the anaphoric keyword `it` must be used when
1854iterating over partials. In the above examples,
1855the `bibentry` partial should contain `it.title`
1856(and so on) instead of `articles.title`.
1858Final newlines are omitted from included partials.
1860Partials may include other partials.
1862A separator between values of an array may be specified
1863in square brackets, immediately after the variable name
1869${articles:bibentry()[; ]$
1872The separator in this case is literal and (unlike with `sep`
1873in an explicit `for` loop) cannot contain interpolated
1874variables or other template directives.
1878To ensure that content is "nested," that is, subsequent lines
1879indented, use the `^` directive:
1882$item.number$ $^$$item.description$ ($item.price$)
1885In this example, if `item.description` has multiple lines,
1886they will all be indented to line up with the first line:
188900123 A fine bottle of 18-year old
1890 Oban whiskey. ($148)
1893To nest multiple lines to the same level, align them
1894with the `^` directive in the template. For example:
1897$item.number$ $^$$item.description$ ($item.price$)
1898 (Available til $item.sellby$.)
190400123 A fine bottle of 18-year old
1905 Oban whiskey. ($148)
1906 (Available til March 30, 2020.)
1909If a variable occurs by itself on a line, preceded by whitespace
1910and not followed by further text or directives on the same line,
1911and the variable's value contains multiple lines, it will be
1912nested automatically.
1916Normally, spaces in the template itself (as opposed to values of
1917the interpolated variables) are not breakable, but they can be
1918made breakable in part of the template by using the `~` keyword
1919(ended with another `~`).
1922$~$This long line may break if the document is rendered
1923with a short line length.$~$
1928A pipe transforms the value of a variable or partial. Pipes are
1929specified using a slash (`/`) between the variable name (or partial)
1930and the pipe name. Example:
1937$for(metadata/pairs)$
1938- $it.key$: $it.value$
1941$employee:name()/uppercase$
1944Pipes may be chained:
1947$for(employees/pairs)$
1948$it.key/alpha/uppercase$. $it.name$
1952Some pipes take parameters:
1955|----------------------|------------|
1957$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1959|----------------------|------------|
1962Currently the following pipes are predefined:
1964- `pairs`: Converts a map or array to an array of maps,
1965 each with `key` and `value` fields. If the original
1966 value was an array, the `key` will be the array index,
1969- `uppercase`: Converts text to uppercase.
1971- `lowercase`: Converts text to lowercase.
1973- `length`: Returns the length of the value: number
1974 of characters for a textual value, number of elements
1977- `reverse`: Reverses a textual value or array,
1978 and has no effect on other values.
1980- `first`: Returns the first value of an array, if
1981 applied to a non-empty array; otherwise returns
1984- `last`: Returns the last value of an array, if
1985 applied to a non-empty array; otherwise returns
1988- `rest`: Returns all but the first value of an array, if
1989 applied to a non-empty array; otherwise returns
1992- `allbutlast`: Returns all but the last value of an array, if
1993 applied to a non-empty array; otherwise returns
1996- `chomp`: Removes trailing newlines (and breakable space).
1998- `nowrap`: Disables line wrapping on breakable spaces.
2000- `alpha`: Converts textual values that can be
2001 read as an integer into lowercase alphabetic
2002 characters `a..z` (mod 26). This can be used to get lettered
2003 enumeration from array indices. To get uppercase
2004 letters, chain with `uppercase`.
2006- `roman`: Converts textual values that can be
2007 read as an integer into lowercase roman numerials.
2008 This can be used to get lettered enumeration from array indices.
2009 To get uppercase roman, chain with `uppercase`.
2011- `left n "leftborder" "rightborder"`: Renders a textual value
2012 in a block of width `n`, aligned to the left, with an optional
2013 left and right border. Has no effect on other values. This
2014 can be used to align material in tables. Widths are positive
2015 integers indicating the number of characters. Borders
2016 are strings inside double quotes; literal `"` and `\` characters
2017 must be backslash-escaped.
2019- `right n "leftborder" "rightborder"`: Renders a textual value
2020 in a block of width `n`, aligned to the right, and has no
2021 effect on other values.
2023- `center n "leftborder" "rightborder"`: Renders a textual
2024 value in a block of width `n`, aligned to the center, and has
2025 no effect on other values.
2030### Metadata variables
2032`title`, `author`, `date`
2033: allow identification of basic aspects of the document. Included
2034 in PDF metadata through LaTeX and ConTeXt. These can be set
2035 through a [pandoc title block][Extension: `pandoc_title_block`],
2036 which allows for multiple authors, or through a
2037 [YAML metadata block][Extension: `yaml_metadata_block`]:
2045 Note that if you just want to set PDF or HTML metadata, without
2046 including a title block in the document itself, you can
2047 set the `title-meta`, `author-meta`, and `date-meta`
2048 variables. (By default these are set automatically, based
2049 on `title`, `author`, and `date`.)
2052: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2056: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2060: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2061 and AsciiDoc metadata; repeat as for `author`, above
2064: document subject, included in ODT, PDF, docx and pptx metadata
2067: document description, included in ODT, docx and pptx metadata. Some
2068 applications show this as `Comments` metadata.
2071: document category, included in docx and pptx metadata
2074any root-level string metadata, not included in ODT, docx
2075or pptx metadata is added as a *custom property*.
2076The following [YAML] metadata block for instance:
2079 title: 'This is the title'
2080 subtitle: "This is the subtitle"
2088 It consists of two paragraphs
2091will include `title`, `author` and `description` as standard document
2092properties and `subtitle` as a custom property when converting to docx,
2095### Language variables
2098: identifies the main language of the document using IETF language
2099 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2100 The [Language subtag lookup] tool can look up or verify these tags.
2101 This affects most formats, and controls hyphenation in PDF output
2102 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2104 Use native pandoc [Divs and Spans] with the `lang` attribute to
2105 switch the language:
2111 Text in the main document language (British English).
2114 > Cette citation est écrite en français canadien.
2117 More text in English. ['Zitat auf Deutsch.']{lang=de}
2120: the base script direction, either `rtl` (right-to-left)
2121 or `ltr` (left-to-right).
2123 For bidirectional documents, native pandoc `span`s and `div`s
2124 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2125 override the base direction in some output formats.
2126 This may not always be necessary if the final renderer
2127 (e.g. the browser, when generating HTML) supports the
2128 [Unicode Bidirectional Algorithm].
2130 When using LaTeX for bidirectional documents, only the `xelatex` engine
2131 is fully supported (use `--pdf-engine=xelatex`).
2133[BCP 47]: https://tools.ietf.org/html/bcp47
2134[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2135[Language subtag lookup]: https://r12a.github.io/app-subtags/
2137### Variables for HTML math
2140: when using [KaTeX](#option--katex), you can render display math equations
2141 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2143### Variables for HTML slides
2145These affect HTML output when [producing slide shows with pandoc].
2147All [reveal.js configuration options] are available as variables.
2148To turn off boolean flags that default to true in reveal.js, use `0`.
2151: base URL for reveal.js documents (defaults to `reveal.js`)
2154: base URL for S5 documents (defaults to `s5/default`)
2157: base URL for Slidy documents (defaults to
2158 `https://www.w3.org/Talks/Tools/Slidy2`)
2161: base URL for Slideous documents (defaults to `slideous`)
2163`title-slide-attributes`
2164: additional attributes for the title slide of reveal.js slide shows.
2165 See [background in reveal.js and beamer] for an example.
2167[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2169### Variables for Beamer slides
2171These variables change the appearance of PDF slides using [`beamer`].
2174: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2175 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2179: produce an article from Beamer slides
2182: add extra beamer option with `\setbeameroption{}`
2185: author affiliations: can be a list when there are multiple authors
2188: logo image for slides
2191: controls navigation symbols (default is `empty` for no navigation
2192 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2195: enables "title pages" for new sections (default is true)
2197`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2201: options for LaTeX beamer themes (a list).
2204: image for title slide
2206### Variables for PowerPoint
2208These variables control the visual aspects of a slide show that
2209are not easily controlled via templates.
2212: font to use for code.
2214### Variables for LaTeX
2216Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2221: make `\paragraph` and `\subparagraph` (fourth- and
2222 fifth-level headings, or fifth- and sixth-level with book
2223 classes) free-standing rather than run-in; requires further
2224 formatting to distinguish from `\subsubsection` (third- or
2225 fourth-level headings). Instead of using this option,
2226 [KOMA-Script] can adjust headings more extensively:
2229 documentclass: scrartcl
2231 \RedeclareSectionCommand[
2232 beforeskip=-10pt plus -2pt minus -1pt,
2233 afterskip=1sp plus -1sp minus 1sp,
2234 font=\normalfont\itshape]{paragraph}
2235 \RedeclareSectionCommand[
2236 beforeskip=-10pt plus -2pt minus -1pt,
2237 afterskip=1sp plus -1sp minus 1sp,
2238 font=\normalfont\scshape,
2239 indent=0pt]{subparagraph}
2243: option for document class, e.g. `oneside`; repeat for multiple options:
2252: document class: usually one of the standard classes, [`article`], [`book`],
2253 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2254 and `scrreprt`, which default to smaller margins; or [`memoir`]
2257: option for [`geometry`] package, e.g. `margin=1in`;
2258 repeat for multiple options:
2268: option for [`hyperref`] package, e.g. `linktoc=all`;
2269 repeat for multiple options:
2275 - pdfpagemode=FullScreen
2279: uses document class settings for indentation (the default LaTeX template
2280 otherwise removes indentation and adds space between paragraphs)
2283: adjusts line spacing using the [`setspace`]
2284 package, e.g. `1.25`, `1.5`
2286`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2287: sets margins if `geometry` is not used (otherwise `geometry`
2291: control `\pagestyle{}`: the default article class
2292 supports `plain` (default), `empty` (no running heads or page numbers),
2293 and `headings` (section titles in running heads)
2296: paper size, e.g. `letter`, `a4`
2299: numbering depth for sections (with `--number-sections` option
2300 or `numbersections` variable)
2305: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2306 default is `T1` (see [LaTeX font encodings guide])
2309: font package for use with `pdflatex`:
2310 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2311 The default is [Latin Modern][`lm`].
2314: options for package used as `fontfamily`; repeat for multiple options.
2315 For example, to use the Libertine font with proportional lowercase
2316 (old-style) figures through the [`libertinus`] package:
2319 fontfamily: libertinus
2326: font size for body text. The standard classes allow 10pt, 11pt, and
2327 12pt. To use another size, set `documentclass` to one of
2328 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2330`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2331: font families for use with `xelatex` or
2332 `lualatex`: take the name of any system font, using the
2333 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2335`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2336: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2337 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2338 choices available through [`fontspec`]; repeat for multiple
2339 options. For example, to use the [TeX Gyre] version of
2340 Palatino with lowercase figures:
2343 mainfont: TeX Gyre Pagella
2346 - Numbers=Proportional
2350: options to pass to the microtype package
2355: add color to link text; automatically enabled if any of
2356 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2358`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2359: color for internal links, external links, citation links, linked
2360 URLs, and links in table of contents, respectively: uses options
2361 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2365: causes links to be printed as footnotes
2370: include list of figures, list of tables
2373: contents of acknowledgments footnote after document title
2376: include table of contents (can also be set using `--toc/--table-of-contents`)
2379: level of section to include in table of contents
2381#### BibLaTeX Bibliographies
2383These variables function when using BibLaTeX for [citation rendering].
2386: list of options for biblatex
2389: bibliography style, when used with `--natbib` and `--biblatex`.
2392: bibliography title, when used with `--natbib` and `--biblatex`.
2395: bibliography to use for resolving references
2398: list of options for natbib
2400[KOMA-Script]: https://ctan.org/pkg/koma-script
2401[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2402[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2403[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2404[`article`]: https://ctan.org/pkg/article
2405[`book`]: https://ctan.org/pkg/book
2406[`libertinus`]: https://ctan.org/pkg/libertinus
2407[`memoir`]: https://ctan.org/pkg/memoir
2408[`report`]: https://ctan.org/pkg/report
2410### Variables for ConTeXt
2412Pandoc uses these variables when [creating a PDF] with ConTeXt.
2415: font size for body text (e.g. `10pt`, `12pt`)
2417`headertext`, `footertext`
2418: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2419 repeat up to four times for different placement
2422: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2423 repeat for multiple options
2426: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2427 repeat for multiple options
2430: options for page margins and text arrangement (see [ConTeXt Layout]);
2431 repeat for multiple options
2433`linkcolor`, `contrastcolor`
2434: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2437: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2440: include list of figures, list of tables
2442`mainfont`, `sansfont`, `monofont`, `mathfont`
2443: font families: take the name of any system font (see [ConTeXt Font Switching])
2445`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2446: sets margins, if `layout` is not used (otherwise `layout`
2450: page number style and location (using [`setuppagenumbering`]);
2451 repeat for multiple options
2454: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2455 repeat for multiple options
2458: adds to the preamble the setup necessary to generate PDF/A of the type
2459 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2460 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2461 block), `1b:2005` will be used as default, for reasons of backwards
2462 compatibility. Using `--variable=pdfa` without specified value is not supported.
2463 To successfully generate PDF/A the required ICC color profiles have to
2464 be available and the content and all included files (such as images)
2465 have to be standard conforming. The ICC profiles and output intent
2466 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2467 See also [ConTeXt PDFA] for more details.
2470: when used in conjunction with `pdfa`, specifies the ICC profile to use
2471 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2472 used as default. May be repeated to include multiple profiles. Note that
2473 the profiles have to be available on the system. They can be obtained
2474 from [ConTeXt ICC Profiles].
2477: when used in conjunction with `pdfa`, specifies the output intent for
2478 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2479 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2482: include table of contents (can also be set using `--toc/--table-of-contents`)
2485: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2488: include all source documents as file attachments in the PDF file
2490[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2491[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2492[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2493[ConTeXt Color]: https://wiki.contextgarden.net/Color
2494[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2495[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2496[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2497[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2498[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2499[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2500[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2502### Variables for `wkhtmltopdf`
2504Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2505The `--css` option also affects the output.
2507`footer-html`, `header-html`
2508: add information to the header and footer
2510`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2511: set the page margins
2514: sets the PDF paper size
2516### Variables for man pages
2519: adjusts text to left (`l`), right (`r`), center (`c`),
2520 or both (`b`) margins
2523: footer in man pages
2526: header in man pages
2529: if `true` (the default), hyphenation will be used
2532: section number in man pages
2537: font family (e.g. `T` or `P`)
2540: paragraph indent (e.g. `2m`)
2543: line height (e.g. `12p`)
2546: point size (e.g. `10p`)
2548### Variables set automatically
2550Pandoc sets these variables automatically in response to [options] or
2551document contents; users can also modify them. These vary depending
2552on the output format, and include the following:
2558: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2559 included in all HTML based formats (dzslides, epub,
2560 html, html4, html5, revealjs, s5, slideous, slidy).
2561 The recognized formats for `date` are: `mm/dd/yyyy`,
2562 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2563 (e.g. either `02 Apr 2018` or `02 April 2018`),
2564 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2565 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2568: contents specified by `-H/--include-in-header` (may have multiple
2572: contents specified by `-B/--include-before-body` (may have
2576: contents specified by `-A/--include-after-body` (may have
2580: JSON representation of all of the document's metadata. Field
2581 values are transformed to the selected output format.
2584: non-null value if `-N/--number-sections` was specified
2586`sourcefile`, `outputfile`
2587: source and destination filenames, as given on the command line.
2588 `sourcefile` can also be a list if input comes from multiple files,
2589 or empty if input is from stdin. You can use the following snippet in
2590 your template to distinguish them:
2600 Similarly, `outputfile` can be `-` if output goes to the terminal.
2602 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2605: working directory from which pandoc is run.
2608: non-null value if `--toc/--table-of-contents` was specified
2611: title of table of contents (works only with EPUB,
2612 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2614[pandoc-templates]: https://github.com/jgm/pandoc-templates
2618The behavior of some of the readers and writers can be adjusted by
2619enabling or disabling various extensions.
2621An extension can be enabled by adding `+EXTENSION`
2622to the format name and disabled by adding `-EXTENSION`. For example,
2623`--from markdown_strict+footnotes` is strict Markdown with footnotes
2624enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2625Markdown without footnotes or pipe tables.
2627The markdown reader and writer make by far the most use of extensions.
2628Extensions only used by them are therefore covered in the
2629section [Pandoc's Markdown] below (See [Markdown variants] for
2630`commonmark` and `gfm`.) In the following, extensions that also work
2631for other formats are covered.
2633Note that markdown extensions added to the `ipynb` format
2634affect Markdown cells in Jupyter notebooks (as do command-line
2635options like `--atx-headers`).
2639#### Extension: `smart` ####
2641Interpret straight quotes as curly quotes, `---` as em-dashes,
2642`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2643inserted after certain abbreviations, such as "Mr."
2645This extension can be enabled/disabled for the following formats:
2648: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2651: `markdown`, `latex`, `context`, `rst`
2653enabled by default in
2654: `markdown`, `latex`, `context` (both input and output)
2656Note: If you are *writing* Markdown, then the `smart` extension
2657has the reverse effect: what would have been curly quotes comes
2660In LaTeX, `smart` means to use the standard TeX ligatures
2661for quotation marks (` `` ` and ` '' ` for double quotes,
2662`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2663en-dash and `---` for em-dash). If `smart` is disabled,
2664then in reading LaTeX pandoc will parse these characters
2665literally. In writing LaTeX, enabling `smart` tells pandoc
2666to use the ligatures when possible; if `smart` is disabled
2667pandoc will use unicode quotation mark and dash characters.
2669## Headings and sections
2671#### Extension: `auto_identifiers` ####
2673A heading without an explicitly specified identifier will be
2674automatically assigned a unique identifier based on the heading text.
2676This extension can be enabled/disabled for the following formats:
2679: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2684enabled by default in
2687The default algorithm used to derive the identifier from the
2690 - Remove all formatting, links, etc.
2691 - Remove all footnotes.
2692 - Remove all non-alphanumeric characters,
2693 except underscores, hyphens, and periods.
2694 - Replace all spaces and newlines with hyphens.
2695 - Convert all alphabetic characters to lowercase.
2696 - Remove everything up to the first letter (identifiers may
2697 not begin with a number or punctuation mark).
2698 - If nothing is left after this, use the identifier `section`.
2703 ------------------------------- ----------------------------
2704 `Heading identifiers in HTML` `heading-identifiers-in-html`
2705 `Maître d'hôtel` `maître-dhôtel`
2706 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2707 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2708 `3. Applications` `applications`
2711These rules should, in most cases, allow one to determine the identifier
2712from the heading text. The exception is when several headings have the
2713same text; in this case, the first will get an identifier as described
2714above; the second will get the same identifier with `-1` appended; the
2715third with `-2`; and so on.
2717(However, a different algorithm is used if
2718`gfm_auto_identifiers` is enabled; see below.)
2720These identifiers are used to provide link targets in the table of
2721contents generated by the `--toc|--table-of-contents` option. They
2722also make it easy to provide links from one section of a document to
2723another. A link to this section, for example, might look like this:
2726 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2728Note, however, that this method of providing links to sections works
2729only in HTML, LaTeX, and ConTeXt formats.
2731If the `--section-divs` option is specified, then each section will
2732be wrapped in a `section` (or a `div`, if `html4` was specified),
2733and the identifier will be attached to the enclosing `<section>`
2734(or `<div>`) tag rather than the heading itself. This allows entire
2735sections to be manipulated using JavaScript or treated differently in
2738#### Extension: `ascii_identifiers` ####
2740Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2741Accents are stripped off of accented Latin letters, and non-Latin
2744#### Extension: `gfm_auto_identifiers` ####
2746Changes the algorithm used by `auto_identifiers` to conform to
2747GitHub's method. Spaces are converted to dashes (`-`),
2748uppercase characters to lowercase characters, and punctuation
2749characters other than `-` and `_` are removed.
2750Emojis are replaced by their names.
2754The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2755[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2756[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2757are described in the section about Pandoc's Markdown.
2759However, they can also be used with HTML input. This is handy for
2760reading web pages formatted using MathJax, for example.
2764The following extensions (especially how they affect Markdown
2765input/output) are also described in more detail in their respective
2766sections of [Pandoc's Markdown].
2768#### Extension: `raw_html` {#raw_html}
2770When converting from HTML, parse elements to raw HTML which are not
2771representable in pandoc's AST.
2772By default, this is disabled for HTML input.
2774#### Extension: `raw_tex` {#raw_tex}
2776Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2778This extension can be enabled/disabled for the following formats
2779(in addition to `markdown`):
2782: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2783 `\eqref` only), `ipynb`
2786: `textile`, `commonmark`
2788Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2789only raw TeX in markdown cells, but data with mime type
2790`text/html` in output cells. Since the `ipynb` reader attempts
2791to preserve the richest possible outputs when several options
2792are given, you will get best results if you disable `raw_html`
2793and `raw_tex` when converting to formats like `docx` which don't
2794allow raw `html` or `tex`.
2796#### Extension: `native_divs` {#native_divs}
2798This extension is enabled by default for HTML input. This means that
2799`div`s are parsed to pandoc native elements. (Alternatively, you
2800can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2802When converting HTML to Markdown, for example, you may want to drop all
2805 pandoc -f html-native_divs-native_spans -t markdown
2807#### Extension: `native_spans` {#native_spans}
2809Analogous to `native_divs` above.
2812## Literate Haskell support
2814#### Extension: `literate_haskell` ####
2816Treat the document as literate Haskell source.
2818This extension can be enabled/disabled for the following formats:
2821: `markdown`, `rst`, `latex`
2824: `markdown`, `rst`, `latex`, `html`
2826If you append `+lhs` (or `+literate_haskell`) to one of the formats
2827above, pandoc will treat the document as literate Haskell source.
2830 - In Markdown input, "bird track" sections will be parsed as Haskell
2831 code rather than block quotations. Text between `\begin{code}`
2832 and `\end{code}` will also be treated as Haskell code. For
2833 ATX-style headings the character '=' will be used instead of '#'.
2835 - In Markdown output, code blocks with classes `haskell` and `literate`
2836 will be rendered using bird tracks, and block quotations will be
2837 indented one space, so they will not be treated as Haskell code.
2838 In addition, headings will be rendered setext-style (with underlines)
2839 rather than ATX-style (with '#' characters). (This is because ghc
2840 treats '#' characters in column 1 as introducing line numbers.)
2842 - In restructured text input, "bird track" sections will be parsed
2845 - In restructured text output, code blocks with class `haskell` will
2846 be rendered using bird tracks.
2848 - In LaTeX input, text in `code` environments will be parsed as
2851 - In LaTeX output, code blocks with class `haskell` will be rendered
2852 inside `code` environments.
2854 - In HTML output, code blocks with class `haskell` will be rendered
2855 with class `literatehaskell` and bird tracks.
2859 pandoc -f markdown+lhs -t html
2861reads literate Haskell source formatted with Markdown conventions and writes
2862ordinary HTML (without bird tracks).
2864 pandoc -f markdown+lhs -t html+lhs
2866writes HTML with the Haskell code in bird tracks, so it can be copied
2867and pasted as literate Haskell source.
2869Note that GHC expects the bird tracks in the first column, so indented
2870literate code blocks (e.g. inside an itemized environment) will not be
2871picked up by the Haskell compiler.
2875#### Extension: `empty_paragraphs` ####
2877Allows empty paragraphs. By default empty paragraphs are
2880This extension can be enabled/disabled for the following formats:
2886: `docx`, `odt`, `opendocument`, `html`
2888#### Extension: `native_numbering` ####
2890Enables native numbering of figures and tables. Enumeration
2893This extension can be enabled/disabled for the following formats:
2896: `odt`, `opendocument`
2898#### Extension: `styles` {#ext-styles} ####
2900When converting from docx, read all docx styles as divs (for
2901paragraph styles) and spans (for character styles) regardless
2902of whether pandoc understands the meaning of these styles.
2903This can be used with [docx custom styles](#custom-styles).
2909#### Extension: `amuse` ####
2911In the `muse` input format, this enables Text::Amuse
2912extensions to Emacs Muse markup.
2914#### Extension: `citations` {#org-citations}
2916Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2919#### Extension: `ntb` ####
2921In the `context` output format this enables the use of [Natural Tables
2922(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2923[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2924Natural tables allow more fine-grained global customization but come
2925at a performance penalty compared to extreme tables.
2930Pandoc understands an extended and slightly revised version of
2931John Gruber's [Markdown] syntax. This document explains the syntax,
2932noting differences from standard Markdown. Except where noted, these
2933differences can be suppressed by using the `markdown_strict` format instead
2934of `markdown`. Extensions can be enabled or disabled to specify the
2935behavior more granularly. They are described in the following. See also
2936[Extensions] above, for extensions that work also on other formats.
2940Markdown is designed to be easy to write, and, even more importantly,
2943> A Markdown-formatted document should be publishable as-is, as plain
2944> text, without looking like it's been marked up with tags or formatting
2946> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2948This principle has guided pandoc's decisions in finding syntax for
2949tables, footnotes, and other extensions.
2951There is, however, one respect in which pandoc's aims are different
2952from the original aims of Markdown. Whereas Markdown was originally
2953designed with HTML generation in mind, pandoc is designed for multiple
2954output formats. Thus, while pandoc allows the embedding of raw HTML,
2955it discourages it, and provides other, non-HTMLish ways of representing
2956important document elements like definition lists, tables, mathematics, and
2961A paragraph is one or more lines of text followed by one or more blank lines.
2962Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2963If you need a hard line break, put two or more spaces at the end of a line.
2965#### Extension: `escaped_line_breaks` ####
2967A backslash followed by a newline is also a hard line break.
2968Note: in multiline and grid table cells, this is the only way
2969to create a hard line break, since trailing spaces in the cells
2974There are two kinds of headings: Setext and ATX.
2976### Setext-style headings ###
2978A setext-style heading is a line of text "underlined" with a row of `=` signs
2979(for a level-one heading) or `-` signs (for a level-two heading):
2987The heading text can contain inline formatting, such as emphasis (see
2988[Inline formatting], below).
2991### ATX-style headings ###
2993An ATX-style heading consists of one to six `#` signs and a line of
2994text, optionally followed by any number of `#` signs. The number of
2995`#` signs at the beginning of the line is the heading level:
2997 ## A level-two heading
2999 ### A level-three heading ###
3001As with setext-style headings, the heading text can contain formatting:
3003 # A level-one heading with a [link](/url) and *emphasis*
3005#### Extension: `blank_before_header` ####
3007Standard Markdown syntax does not require a blank line before a heading.
3008Pandoc does require this (except, of course, at the beginning of the
3009document). The reason for the requirement is that it is all too easy for a
3010`#` to end up at the beginning of a line by accident (perhaps through line
3011wrapping). Consider, for example:
3013 I like several of their flavors of ice cream:
3014 #22, for example, and #5.
3016#### Extension: `space_in_atx_header` ####
3018Many Markdown implementations do not require a space between the
3019opening `#`s of an ATX heading and the heading text, so that
3020`#5 bolt` and `#hashtag` count as headings. With this extension,
3021pandoc does require the space.
3023### Heading identifiers ###
3025See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3027#### Extension: `header_attributes` ####
3029Headings can be assigned attributes using this syntax at the end
3030of the line containing the heading text:
3032 {#identifier .class .class key=value key=value}
3034Thus, for example, the following headings will all be assigned the identifier
3039 ## My heading ## {#foo}
3041 My other heading {#foo}
3044(This syntax is compatible with [PHP Markdown Extra].)
3046Note that although this syntax allows assignment of classes and key/value
3047attributes, writers generally don't use all of this information. Identifiers,
3048classes, and key/value attributes are used in HTML and HTML-based formats such
3049as EPUB and slidy. Identifiers are used for labels and link anchors in the
3050LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3052Headings with the class `unnumbered` will not be numbered, even if
3053`--number-sections` is specified. A single hyphen (`-`) in an attribute
3054context is equivalent to `.unnumbered`, and preferable in non-English
3061 # My heading {.unnumbered}
3063If the `unlisted` class is present in addition to `unnumbered`,
3064the heading will not be included in a table of contents.
3065(Currently this feature is only implemented for certain
3066formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3068#### Extension: `implicit_header_references` ####
3070Pandoc behaves as if reference links have been defined for each heading.
3071So, to link to a heading
3073 # Heading identifiers in HTML
3077 [Heading identifiers in HTML]
3081 [Heading identifiers in HTML][]
3085 [the section on heading identifiers][heading identifiers in
3088instead of giving the identifier explicitly:
3090 [Heading identifiers in HTML](#heading-identifiers-in-html)
3092If there are multiple headings with identical text, the corresponding
3093reference will link to the first one only, and you will need to use explicit
3094links to link to the others, as described above.
3096Like regular reference links, these references are case-insensitive.
3098Explicit link reference definitions always take priority over
3099implicit heading references. So, in the following example, the
3100link will point to `bar`, not to `#foo`:
3110Markdown uses email conventions for quoting blocks of text.
3111A block quotation is one or more paragraphs or other block elements
3112(such as lists or headings), with each line preceded by a `>` character
3113and an optional space. (The `>` need not start at the left margin, but
3114it should not be indented more than three spaces.)
3116 > This is a block quote. This
3117 > paragraph has two lines.
3119 > 1. This is a list inside a block quote.
3122A "lazy" form, which requires the `>` character only on the first
3123line of each block, is also allowed:
3125 > This is a block quote. This
3126 paragraph has two lines.
3128 > 1. This is a list inside a block quote.
3131Among the block elements that can be contained in a block quote are
3132other block quotes. That is, block quotes can be nested:
3134 > This is a block quote.
3136 > > A block quote within a block quote.
3138If the `>` character is followed by an optional space, that space
3139will be considered part of the block quote marker and not part of
3140the indentation of the contents. Thus, to put an indented code
3141block in a block quote, you need five spaces after the `>`:
3145#### Extension: `blank_before_blockquote` ####
3147Standard Markdown syntax does not require a blank line before a block
3148quote. Pandoc does require this (except, of course, at the beginning of the
3149document). The reason for the requirement is that it is all too easy for a
3150`>` to end up at the beginning of a line by accident (perhaps through line
3151wrapping). So, unless the `markdown_strict` format is used, the following does
3152not produce a nested block quote in pandoc:
3154 > This is a block quote.
3158## Verbatim (code) blocks
3160### Indented code blocks ###
3162A block of text indented four spaces (or one tab) is treated as verbatim
3163text: that is, special characters do not trigger special formatting,
3164and all spaces and line breaks are preserved. For example,
3167 moveShip(5 * gravity, DOWN);
3170The initial (four space or one tab) indentation is not considered part
3171of the verbatim text, and is removed in the output.
3173Note: blank lines in the verbatim text need not begin with four spaces.
3176### Fenced code blocks ###
3178#### Extension: `fenced_code_blocks` ####
3180In addition to standard indented code blocks, pandoc supports
3181*fenced* code blocks. These begin with a row of three or more
3182tildes (`~`) and end with a row of tildes that must be at least as long as
3183the starting row. Everything between these lines is treated as code. No
3184indentation is necessary:
3188 moveShip(5 * gravity, DOWN);
3192Like regular code blocks, fenced code blocks must be separated
3193from surrounding text by blank lines.
3195If the code itself contains a row of tildes or backticks, just use a longer
3196row of tildes or backticks at the start and end:
3200 code including tildes
3204#### Extension: `backtick_code_blocks` ####
3206Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3209#### Extension: `fenced_code_attributes` ####
3211Optionally, you may attach attributes to fenced or backtick code block using
3214 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3216 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3217 qsort (filter (>= x) xs)
3218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3220Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3221`startFrom` is an attribute with value `100`. Some output formats can use this
3222information to do syntax highlighting. Currently, the only output formats
3223that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3224highlighting is supported for your output format and language, then the code
3225block above will appear highlighted, with numbered lines. (To see which
3226languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3227the code block above will appear as follows:
3229 <pre id="mycode" class="haskell numberLines" startFrom="100">
3235The `numberLines` (or `number-lines`) class will cause the lines
3236of the code block to be numbered, starting with `1` or the value
3237of the `startFrom` attribute. The `lineAnchors` (or
3238`line-anchors`) class will cause the lines to be clickable
3239anchors in HTML output.
3241A shortcut form can also be used for specifying the language of
3248This is equivalent to:
3254If the `fenced_code_attributes` extension is disabled, but
3255input contains class attribute(s) for the code block, the first
3256class attribute will be printed after the opening fence as a bare
3259To prevent all highlighting, use the `--no-highlight` flag.
3260To set the highlighting style, use `--highlight-style`.
3261For more information on highlighting, see [Syntax highlighting],
3266#### Extension: `line_blocks` ####
3268A line block is a sequence of lines beginning with a vertical bar (`|`)
3269followed by a space. The division into lines will be preserved in
3270the output, as will any leading spaces; otherwise, the lines will
3271be formatted as Markdown. This is useful for verse and addresses:
3273 | The limerick packs laughs anatomical
3274 | In space that is quite economical.
3275 | But the good ones I've seen
3276 | So seldom are clean
3277 | And the clean ones so seldom are comical
3280 | Berkeley, CA 94718
3282The lines can be hard-wrapped if needed, but the continuation
3283line must begin with a space.
3285 | The Right Honorable Most Venerable and Righteous Samuel L.
3288 | Berkeley, CA 94718
3290This syntax is borrowed from [reStructuredText].
3296A bullet list is a list of bulleted list items. A bulleted list
3297item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3304This will produce a "compact" list. If you want a "loose" list, in which
3305each item is formatted as a paragraph, put spaces between the items:
3313The bullets need not be flush with the left margin; they may be
3314indented one, two, or three spaces. The bullet must be followed
3317List items look best if subsequent lines are flush with the first
3318line (after the bullet):
3324But Markdown also allows a "lazy" format:
3330### Block content in list items ###
3332A list item may contain multiple paragraphs and other block-level
3333content. However, subsequent paragraphs must be preceded by a blank line
3334and indented to line up with the first non-space content after
3341 * Second paragraph. With a code block, which must be indented
3346Exception: if the list marker is followed by an indented code
3347block, which must begin 5 spaces after the list marker, then
3348subsequent paragraphs must begin two columns after the last
3349character of the list marker:
3353 continuation paragraph
3355List items may include other lists. In this case the preceding blank
3356line is optional. The nested list must be indented to line up with
3357the first non-space character after the list marker of the
3358containing list item.
3370As noted above, Markdown allows you to write list items "lazily," instead of
3371indenting continuation lines. However, if there are multiple paragraphs or
3372other blocks in a list item, the first line of each must be indented.
3374 + A lazy, lazy, list
3377 + Another one; this looks
3380 Second paragraph of second
3383### Ordered lists ###
3385Ordered lists work just like bulleted lists, except that the items
3386begin with enumerators rather than bullets.
3388In standard Markdown, enumerators are decimal numbers followed
3389by a period and a space. The numbers themselves are ignored, so
3390there is no difference between this list:
3402#### Extension: `fancy_lists` ####
3404Unlike standard Markdown, pandoc allows ordered list items to be marked
3405with uppercase and lowercase letters and roman numerals, in addition to
3406Arabic numerals. List markers may be enclosed in parentheses or followed by a
3407single right-parentheses or period. They must be separated from the
3408text that follows by at least one space, and, if the list marker is a
3409capital letter with a period, by at least two spaces.[^2]
3411[^2]: The point of this rule is to ensure that normal paragraphs
3412 starting with people's initials, like
3414 B. Russell was an English philosopher.
3416 do not get treated as list items.
3418 This rule will not prevent
3422 from being interpreted as a list item. In this case, a backslash
3427The `fancy_lists` extension also allows '`#`' to be used as an
3428ordered list marker in place of a numeral:
3433#### Extension: `startnum` ####
3435Pandoc also pays attention to the type of list marker used, and to the
3436starting number, and both of these are preserved where possible in the
3437output format. Thus, the following yields a list with numbers followed
3438by a single parenthesis, starting with 9, and a sublist with lowercase
3448Pandoc will start a new list each time a different type of list
3449marker is used. So, the following will create three lists:
3456If default list markers are desired, use `#.`:
3462#### Extension: `task_lists` ####
3464Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3466 - [ ] an unchecked task list item
3469### Definition lists ###
3471#### Extension: `definition_lists` ####
3473Pandoc supports definition lists, using the syntax of
3474[PHP Markdown Extra] with some extensions.[^3]
3480 Term 2 with *inline markup*
3484 { some code, part of Definition 2 }
3486 Third paragraph of definition 2.
3488Each term must fit on one line, which may optionally be followed by
3489a blank line, and must be followed by one or more definitions.
3490A definition begins with a colon or tilde, which may be indented one
3493A term may have multiple definitions, and each definition may consist of one or
3494more block elements (paragraph, code block, list, etc.), each indented four
3495spaces or one tab stop. The body of the definition (including the first line,
3496aside from the colon or tilde) should be indented four spaces. However,
3497as with other Markdown lists, you can "lazily" omit indentation except
3498at the beginning of a paragraph or other block element:
3503 with lazy continuation.
3505 Second paragraph of the definition.
3507If you leave space before the definition (as in the example above),
3508the text of the definition will be treated as a paragraph. In some
3509output formats, this will mean greater spacing between term/definition
3510pairs. For a more compact definition list, omit the space before the
3520Note that space between items in a definition list is required.
3521(A variant that loosens this requirement, but disallows "lazy"
3522hard wrapping, can be activated with `compact_definition_lists`: see
3523[Non-pandoc extensions], below.)
3525[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3527### Numbered example lists ###
3529#### Extension: `example_lists` ####
3531The special list marker `@` can be used for sequentially numbered
3532examples. The first list item with a `@` marker will be numbered '1',
3533the next '2', and so on, throughout the document. The numbered examples
3534need not occur in a single list; each new list using `@` will take up
3535where the last stopped. So, for example:
3537 (@) My first example will be numbered (1).
3538 (@) My second example will be numbered (2).
3540 Explanation of examples.
3542 (@) My third example will be numbered (3).
3544Numbered examples can be labeled and referred to elsewhere in the
3547 (@good) This is a good example.
3549 As (@good) illustrates, ...
3551The label can be any string of alphanumeric characters, underscores,
3554Note: continuation paragraphs in example lists must always
3555be indented four spaces, regardless of the length of the
3556list marker. That is, example lists always behave as if the
3557`four_space_rule` extension is set. This is because example
3558labels tend to be long, and indenting content to the
3559first non-space character after the label would be awkward.
3561### Compact and loose lists ###
3563Pandoc behaves differently from `Markdown.pl` on some "edge
3564cases" involving lists. Consider this source:
3574Pandoc transforms this into a "compact list" (with no `<p>` tags around
3575"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3576"Second" and "Third" (but not "First"), because of the blank space
3577around "Third". Pandoc follows a simple rule: if the text is followed by
3578a blank line, it is treated as a paragraph. Since "Second" is followed
3579by a list, and not a blank line, it isn't treated as a paragraph. The
3580fact that the list is followed by a blank line is irrelevant. (Note:
3581Pandoc works this way even when the `markdown_strict` format is specified. This
3582behavior is consistent with the official Markdown syntax description,
3583even though it is different from that of `Markdown.pl`.)
3586### Ending a list ###
3588What if you want to put an indented code block after a list?
3595Trouble! Here pandoc (like other Markdown implementations) will treat
3596`{ my code block }` as the second paragraph of item two, and not as
3599To "cut off" the list after item two, you can insert some non-indented
3600content, like an HTML comment, which won't produce visible output in
3606 <!-- end of list -->
3610You can use the same trick if you want two consecutive lists instead
3625A line containing a row of three or more `*`, `-`, or `_` characters
3626(optionally separated by spaces) produces a horizontal rule:
3635Four kinds of tables may be used. The first three kinds presuppose the use of
3636a fixed-width font, such as Courier. The fourth kind can be used with
3637proportionally spaced fonts, as it does not require lining up columns.
3639#### Extension: `table_captions` ####
3641A caption may optionally be provided with all 4 kinds of tables (as
3642illustrated in the examples below). A caption is a paragraph beginning
3643with the string `Table:` (or just `:`), which will be stripped off.
3644It may appear either before or after the table.
3646#### Extension: `simple_tables` ####
3648Simple tables look like this:
3650 Right Left Center Default
3651 ------- ------ ---------- -------
3656 Table: Demonstration of simple table syntax.
3658The header and table rows must each fit on one line. Column
3659alignments are determined by the position of the header text relative
3660to the dashed line below it:[^4]
3662 - If the dashed line is flush with the header text on the right side
3663 but extends beyond it on the left, the column is right-aligned.
3664 - If the dashed line is flush with the header text on the left side
3665 but extends beyond it on the right, the column is left-aligned.
3666 - If the dashed line extends beyond the header text on both sides,
3667 the column is centered.
3668 - If the dashed line is flush with the header text on both sides,
3669 the default alignment is used (in most cases, this will be left).
3671[^4]: This scheme is due to Michel Fortin, who proposed it on the
3672 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3674The table must end with a blank line, or a line of dashes followed by
3677The column header row may be omitted, provided a dashed line is used
3678to end the table. For example:
3680 ------- ------ ---------- -------
3684 ------- ------ ---------- -------
3686When the header row is omitted, column alignments are determined on the basis
3687of the first line of the table body. So, in the tables above, the columns
3688would be right, left, center, and right aligned, respectively.
3690#### Extension: `multiline_tables` ####
3692Multiline tables allow header and table rows to span multiple lines
3693of text (but cells that span multiple columns or rows of the table are
3694not supported). Here is an example:
3696 -------------------------------------------------------------
3697 Centered Default Right Left
3698 Header Aligned Aligned Aligned
3699 ----------- ------- --------------- -------------------------
3700 First row 12.0 Example of a row that
3701 spans multiple lines.
3703 Second row 5.0 Here's another one. Note
3704 the blank line between
3706 -------------------------------------------------------------
3708 Table: Here's the caption. It, too, may span
3711These work like simple tables, but with the following differences:
3713 - They must begin with a row of dashes, before the header text
3714 (unless the header row is omitted).
3715 - They must end with a row of dashes, then a blank line.
3716 - The rows must be separated by blank lines.
3718In multiline tables, the table parser pays attention to the widths of
3719the columns, and the writers try to reproduce these relative widths in
3720the output. So, if you find that one of the columns is too narrow in the
3721output, try widening it in the Markdown source.
3723The header may be omitted in multiline tables as well as simple tables:
3725 ----------- ------- --------------- -------------------------
3726 First row 12.0 Example of a row that
3727 spans multiple lines.
3729 Second row 5.0 Here's another one. Note
3730 the blank line between
3732 ----------- ------- --------------- -------------------------
3734 : Here's a multiline table without a header.
3736It is possible for a multiline table to have just one row, but the row
3737should be followed by a blank line (and then the row of dashes that ends
3738the table), or the table may be interpreted as a simple table.
3740#### Extension: `grid_tables` ####
3742Grid tables look like this:
3744 : Sample grid table.
3746 +---------------+---------------+--------------------+
3747 | Fruit | Price | Advantages |
3748 +===============+===============+====================+
3749 | Bananas | $1.34 | - built-in wrapper |
3750 | | | - bright color |
3751 +---------------+---------------+--------------------+
3752 | Oranges | $2.10 | - cures scurvy |
3754 +---------------+---------------+--------------------+
3756The row of `=`s separates the header from the table body, and can be
3757omitted for a headerless table. The cells of grid tables may contain
3758arbitrary block elements (multiple paragraphs, code blocks, lists,
3759etc.). Cells that span multiple columns or rows are not
3760supported. Grid tables can be created easily using Emacs' table-mode
3761(`M-x table-insert`).
3763Alignments can be specified as with pipe tables, by putting
3764colons at the boundaries of the separator line after the
3767 +---------------+---------------+--------------------+
3768 | Right | Left | Centered |
3769 +==============:+:==============+:==================:+
3770 | Bananas | $1.34 | built-in wrapper |
3771 +---------------+---------------+--------------------+
3773For headerless tables, the colons go on the top line instead:
3775 +--------------:+:--------------+:------------------:+
3776 | Right | Left | Centered |
3777 +---------------+---------------+--------------------+
3779##### Grid Table Limitations #####
3781Pandoc does not support grid tables with row spans or column spans.
3782This means that neither variable numbers of columns across rows nor
3783variable numbers of rows across columns are supported by Pandoc.
3784All grid tables must have the same number of columns in each row,
3785and the same number of rows in each column. For example, the
3786Docutils [sample grid tables] will not render as expected with
3789[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3792#### Extension: `pipe_tables` ####
3794Pipe tables look like this:
3796 | Right | Left | Default | Center |
3797 |------:|:-----|---------|:------:|
3798 | 12 | 12 | 12 | 12 |
3799 | 123 | 123 | 123 | 123 |
3802 : Demonstration of pipe table syntax.
3804The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3805ending pipe characters are optional, but pipes are required between all
3806columns. The colons indicate column alignment as shown. The header
3807cannot be omitted. To simulate a headerless table, include a header
3810Since the pipes indicate column boundaries, columns need not be vertically
3811aligned, as they are in the above example. So, this is a perfectly
3812legal (though ugly) pipe table:
3820The cells of pipe tables cannot contain block elements like paragraphs
3821and lists, and cannot span multiple lines. If a pipe table contains a
3822row whose Markdown content is wider than the column width (see
3823`--columns`), then the table will take up the full text width and
3824the cell contents will wrap, with the relative cell widths determined
3825by the number of dashes in the line separating the table header from
3826the table body. (For example `---|-` would make the first column 3/4
3827and the second column 1/4 of the full text width.)
3828On the other hand, if no lines are wider than column width, then
3829cell contents will not be wrapped, and the cells will be sized
3832Note: pandoc also recognizes pipe tables of the following
3833form, as can be produced by Emacs' orgtbl-mode:
3840The difference is that `+` is used instead of `|`. Other orgtbl features
3841are not supported. In particular, to get non-default column alignment,
3842you'll need to add colons as above.
3844[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3848#### Extension: `pandoc_title_block` ####
3850If the file begins with a title block
3853 % author(s) (separated by semicolons)
3856it will be parsed as bibliographic information, not regular text. (It
3857will be used, for example, in the title of standalone LaTeX or HTML
3858output.) The block may contain just a title, a title and an author,
3859or all three elements. If you want to include an author but no
3860title, or a title and a date but no author, you need a blank line:
3873The title may occupy multiple lines, but continuation lines must
3874begin with leading space, thus:
3881If a document has multiple authors, the authors may be put on
3882separate lines with leading space, or separated by semicolons, or
3883both. So, all of the following are equivalent:
3891% Author One; Author Two
3899The date must fit on one line.
3901All three metadata fields may contain standard inline formatting
3902(italics, links, footnotes, etc.).
3904Title blocks will always be parsed, but they will affect the output only
3905when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3906will appear twice: once in the document head -- this is the title that
3907will appear at the top of the window in a browser -- and once at the
3908beginning of the document body. The title in the document head can have
3909an optional prefix attached (`--title-prefix` or `-T` option). The title
3910in the body appears as an H1 element with class "title", so it can be
3911suppressed or reformatted with CSS. If a title prefix is specified with
3912`-T` and no title block appears in the document, the title prefix will
3913be used by itself as the HTML title.
3915The man page writer extracts a title, man page section number, and
3916other header and footer information from the title line. The title
3917is assumed to be the first word on the title line, which may optionally
3918end with a (single-digit) section number in parentheses. (There should
3919be no space between the title and the parentheses.) Anything after
3920this is assumed to be additional footer and header text. A single pipe
3921character (`|`) should be used to separate the footer text from the header
3926will yield a man page with the title `PANDOC` and section 1.
3928 % PANDOC(1) Pandoc User Manuals
3930will also have "Pandoc User Manuals" in the footer.
3932 % PANDOC(1) Pandoc User Manuals | Version 4.0
3934will also have "Version 4.0" in the header.
3936#### Extension: `yaml_metadata_block` ####
3938A [YAML] metadata block is a valid YAML object, delimited by a line of three
3939hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3940(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3941document, but if it is not at the beginning, it must be preceded by a blank
3942line. (Note that, because of the way pandoc concatenates input files when
3943several are provided, you may also keep the metadata in a separate YAML file
3944and pass it to pandoc as an argument, along with your Markdown files:
3946 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3948Just be sure that the YAML file begins with `---` and ends with `---` or
3949`...`.) Alternatively, you can use the `--metadata-file` option. Using
3950that approach however, you cannot reference content (like footnotes)
3951from the main markdown input document.
3953Metadata will be taken from the fields of the YAML object and added to any
3954existing document metadata. Metadata can contain lists and objects (nested
3955arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3956with names ending in an underscore will be ignored by pandoc. (They may be
3957given a role by external processors.) Field names must not be
3958interpretable as YAML numbers or boolean values (so, for
3959example, `yes`, `True`, and `15` cannot be used as field names).
3961A document may contain multiple metadata blocks. If two
3962metadata blocks attempt to set the same field, the value from
3963the second block will be taken.
3965When pandoc is used with `-t markdown` to create a Markdown document,
3966a YAML metadata block will be produced only if the `-s/--standalone`
3967option is used. All of the metadata will appear in a single block
3968at the beginning of the document.
3970Note that [YAML] escaping rules must be followed. Thus, for example,
3971if a title contains a colon, it must be quoted. The pipe character
3972(`|`) can be used to begin an indented block that will be interpreted
3973literally, without need for escaping. This form is necessary
3974when the field contains blank lines or block-level formatting:
3977 title: 'This is the title: it contains a colon'
3981 keywords: [nothing, nothingness]
3983 This is the abstract.
3985 It consists of two paragraphs.
3988Template variables will be set automatically from the metadata. Thus, for
3989example, in writing HTML, the variable `abstract` will be set to the HTML
3990equivalent of the Markdown in the `abstract` field:
3992 <p>This is the abstract.</p>
3993 <p>It consists of two paragraphs.</p>
3995Variables can contain arbitrary YAML structures, but the template must match
3996this structure. The `author` variable in the default templates expects a
3997simple list or string, but can be changed to support more complicated
3998structures. The following combination, for example, would add an affiliation
3999to the author if one is given:
4002 title: The document title
4005 affiliation: University of Somewhere
4007 affiliation: University of Nowhere
4010To use the structured authors in the example above, you would need a custom
4015 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4021Raw content to include in the document's header may be specified
4022using `header-includes`; however, it is important to mark up
4023this content as raw code for a particular output format, using
4024the [`raw_attribute` extension](#extension-raw_attribute)), or it
4025will be interpreted as markdown. For example:
4030 \let\oldsection\section
4031 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4036#### Extension: `all_symbols_escapable` ####
4038Except inside a code block or inline code, any punctuation or space
4039character preceded by a backslash will be treated literally, even if it
4040would normally indicate formatting. Thus, for example, if one writes
4050 <strong>hello</strong>
4052This rule is easier to remember than standard Markdown's rule,
4053which allows only the following characters to be backslash-escaped:
4057(However, if the `markdown_strict` format is used, the standard Markdown rule
4060A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4061it will appear as `~`. In HTML and XML output, it will appear as a
4062literal unicode nonbreaking space character (note that it will thus
4063actually look "invisible" in the generated HTML source; you can still
4064use the `--ascii` command-line option to make it appear as an explicit
4067A backslash-escaped newline (i.e. a backslash occurring at the end of
4068a line) is parsed as a hard line break. It will appear in TeX output as
4069`\\` and in HTML as `<br />`. This is a nice alternative to
4070Markdown's "invisible" way of indicating hard line breaks using
4071two trailing spaces on a line.
4073Backslash escapes do not work in verbatim contexts.
4079To *emphasize* some text, surround it with `*`s or `_`, like this:
4081 This text is _emphasized with underscores_, and this
4082 is *emphasized with asterisks*.
4084Double `*` or `_` produces **strong emphasis**:
4086 This is **strong emphasis** and __with underscores__.
4088A `*` or `_` character surrounded by spaces, or backslash-escaped,
4089will not trigger emphasis:
4091 This is * not emphasized *, and \*neither is this\*.
4093#### Extension: `intraword_underscores` ####
4095Because `_` is sometimes used inside words and identifiers,
4096pandoc does not interpret a `_` surrounded by alphanumeric
4097characters as an emphasis marker. If you want to emphasize
4098just part of a word, use `*`:
4100 feas*ible*, not feas*able*.
4105#### Extension: `strikeout` ####
4107To strikeout a section of text with a horizontal line, begin and end it
4108with `~~`. Thus, for example,
4110 This ~~is deleted text.~~
4113### Superscripts and subscripts ###
4115#### Extension: `superscript`, `subscript` ####
4117Superscripts may be written by surrounding the superscripted text by `^`
4118characters; subscripts may be written by surrounding the subscripted
4119text by `~` characters. Thus, for example,
4121 H~2~O is a liquid. 2^10^ is 1024.
4123The text between `^...^` or `~...~` may not contain spaces or
4124newlines. If the superscripted or subscripted text contains
4125spaces, these spaces must be escaped with backslashes. (This is
4126to prevent accidental superscripting and subscripting through
4127the ordinary use of `~` and `^`, and also bad interactions with
4128footnotes.) Thus, if you want the letter P with 'a cat' in
4129subscripts, use `P~a\ cat~`, not `P~a cat~`.
4133To make a short span of text verbatim, put it inside backticks:
4135 What is the difference between `>>=` and `>>`?
4137If the verbatim text includes a backtick, use double backticks:
4139 Here is a literal backtick `` ` ``.
4141(The spaces after the opening backticks and before the closing
4142backticks will be ignored.)
4144The general rule is that a verbatim span starts with a string
4145of consecutive backticks (optionally followed by a space)
4146and ends with a string of the same number of backticks (optionally
4147preceded by a space).
4149Note that backslash-escapes (and other Markdown constructs) do not
4150work in verbatim contexts:
4152 This is a backslash followed by an asterisk: `\*`.
4154#### Extension: `inline_code_attributes` ####
4156Attributes can be attached to verbatim text, just as with
4157[fenced code blocks]:
4163To write small caps, use the `smallcaps` class:
4165 [Small caps]{.smallcaps}
4167Or, without the `bracketed_spans` extension:
4169 <span class="smallcaps">Small caps</span>
4171For compatibility with other Markdown flavors, CSS is also supported:
4173 <span style="font-variant:small-caps;">Small caps</span>
4175This will work in all output formats that support small caps.
4180#### Extension: `tex_math_dollars` ####
4182Anything between two `$` characters will be treated as TeX math. The
4183opening `$` must have a non-space character immediately to its right,
4184while the closing `$` must have a non-space character immediately to its
4185left, and must not be followed immediately by a digit. Thus,
4186`$20,000 and $30,000` won't parse as math. If for some reason
4187you need to enclose text in literal `$` characters, backslash-escape
4188them and they won't be treated as math delimiters.
4190For display math, use `$$` delimiters. (In this case, the delimiters
4191may be separated from the formula by whitespace.)
4193TeX math will be printed in all output formats. How it is rendered
4194depends on the output format:
4197 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4198 math) or `\[...\]` (for display math).
4200Markdown, Emacs Org mode, ConTeXt, ZimWiki
4201 ~ It will appear verbatim surrounded by `$...$` (for inline
4202 math) or `$$...$$` (for display math).
4205 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4208 ~ It will be rendered using an [interpreted text role `:math:`].
4211 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4212 surrounded by `latexmath:[$...$]` (for inline math) or
4213 `[latexmath]++++\[...\]+++` (for display math).
4214 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4215 (`$..$` and `\[..\]`) are omitted.
4218 ~ It will be rendered inside a `@math` command.
4220roff man, Jira markup
4221 ~ It will be rendered verbatim without `$`'s.
4224 ~ It will be rendered inside `<math>` tags.
4227 ~ It will be rendered inside `<span class="math">` tags.
4230 ~ It will be rendered, if possible, using Unicode characters,
4231 and will otherwise appear verbatim.
4234 ~ It will be rendered, if possible, using MathML.
4237 ~ If the `--mathml` flag is used, it will be rendered using MathML
4238 in an `inlineequation` or `informalequation` tag. Otherwise it
4239 will be rendered, if possible, using Unicode characters.
4242 ~ It will be rendered using OMML math markup.
4245 ~ If the `--webtex` option is used, formulas are rendered as images
4246 using CodeCogs or other compatible web service, downloaded
4247 and embedded in the e-book. Otherwise, they will appear verbatim.
4249HTML, Slidy, DZSlides, S5, EPUB
4250 ~ The way math is rendered in HTML will depend on the
4251 command-line options selected. Therefore see [Math rendering in HTML]
4254[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4258#### Extension: `raw_html` ####
4260Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4261(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4262literally). (Technically this is not an extension, since standard
4263Markdown allows it, but it has been made an extension so that it can
4264be disabled if desired.)
4266The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4267DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4268output, and suppressed in other formats.
4270For a more explicit way of including raw HTML in a Markdown
4271document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4273In the CommonMark format, if `raw_html` is enabled, superscripts,
4274subscripts, strikeouts and small capitals will be represented as HTML.
4275Otherwise, plain-text fallbacks will be used. Note that even if
4276`raw_html` is disabled, tables will be rendered with HTML syntax if
4277they cannot use pipe syntax.
4279#### Extension: `markdown_in_html_blocks` ####
4281Standard Markdown allows you to include HTML "blocks": blocks
4282of HTML between balanced tags that are separated from the surrounding text
4283with blank lines, and start and end at the left margin. Within
4284these blocks, everything is interpreted as HTML, not Markdown;
4285so (for example), `*` does not signify emphasis.
4287Pandoc behaves this way when the `markdown_strict` format is used; but
4288by default, pandoc interprets material between HTML block tags as Markdown.
4289Thus, for example, pandoc will turn
4294 <td>[a link](https://google.com)</td>
4302 <td><em>one</em></td>
4303 <td><a href="https://google.com">a link</a></td>
4307whereas `Markdown.pl` will preserve it as is.
4309There is one exception to this rule: text between `<script>` and
4310`<style>` tags is not interpreted as Markdown.
4312This departure from standard Markdown should make it easier to mix
4313Markdown with HTML block elements. For example, one can surround
4314a block of Markdown text with `<div>` tags without preventing it
4315from being interpreted as Markdown.
4317#### Extension: `native_divs` ####
4319Use native pandoc `Div` blocks for content inside `<div>` tags.
4320For the most part this should give the same output as
4321`markdown_in_html_blocks`, but it makes it easier to write pandoc
4322filters to manipulate groups of blocks.
4324#### Extension: `native_spans` ####
4326Use native pandoc `Span` blocks for content inside `<span>` tags.
4327For the most part this should give the same output as `raw_html`,
4328but it makes it easier to write pandoc filters to manipulate groups
4331#### Extension: `raw_tex` ####
4333In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4334included in a document. Inline TeX commands will be preserved and passed
4335unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4336LaTeX to include BibTeX citations:
4338 This result was proved in \cite{jones.1967}.
4340Note that in LaTeX environments, like
4342 \begin{tabular}{|l|l|}\hline
4343 Age & Frequency \\ \hline
4346 36--45 & 22 \\ \hline
4349the material between the begin and end tags will be interpreted as raw
4350LaTeX, not as Markdown.
4352For a more explicit and flexible way of including raw TeX in a
4353Markdown document, see the [`raw_attribute`
4354extension][Extension: `raw_attribute`].
4356Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4357Emacs Org mode, and ConTeXt.
4359### Generic raw attribute ###
4361#### Extension: `raw_attribute` ####
4363Inline spans and fenced code blocks with a special
4364kind of attribute will be parsed as raw content with the
4365designated format. For example, the following produces a raw
4372And the following produces a raw `html` inline element:
4374 This is `<a>html</a>`{=html}
4376This can be useful to insert raw xml into `docx` documents, e.g.
4382 <w:br w:type="page"/>
4387The format name should match the target format name (see
4388`-t/--to`, above, for a list, or use `pandoc
4389--list-output-formats`). Use `openxml` for `docx` output,
4390`opendocument` for `odt` output, `html5` for `epub3` output,
4391`html4` for `epub2` output, and `latex`, `beamer`,
4392`ms`, or `html5` for `pdf` output (depending on what you
4393use for `--pdf-engine`).
4395This extension presupposes that the relevant kind of
4396inline code or fenced code block is enabled. Thus, for
4397example, to use a raw attribute with a backtick code block,
4398`backtick_code_blocks` must be enabled.
4400The raw attribute cannot be combined with regular attributes.
4404#### Extension: `latex_macros` ####
4406When this extension is enabled, pandoc will parse LaTeX
4407macro definitions and apply the resulting macros to all LaTeX
4408math and raw LaTeX. So, for example, the following will work in
4409all output formats, not just LaTeX:
4411 \newcommand{\tuple}[1]{\langle #1 \rangle}
4415Note that LaTeX macros will not be applied if they occur
4416inside a raw span or block marked with the
4417[`raw_attribute` extension](#extension-raw_attribute).
4419When `latex_macros` is disabled, the raw LaTeX and math will
4420not have macros applied. This is usually a better approach when
4421you are targeting LaTeX or PDF.
4423Macro definitions in LaTeX will be passed through as raw LaTeX
4424only if `latex_macros` is not enabled. Macro definitions in
4425Markdown source (or other formats allowing `raw_tex`) will
4426be passed through regardless of whether `latex_macros` is
4431Markdown allows links to be specified in several ways.
4433### Automatic links ###
4435If you enclose a URL or email address in pointy brackets, it
4438 <https://google.com>
4439 <sam@green.eggs.ham>
4443An inline link consists of the link text in square brackets,
4444followed by the URL in parentheses. (Optionally, the URL can
4445be followed by a link title, in quotes.)
4447 This is an [inline link](/url), and here's [one with
4448 a title](https://fsf.org "click here for a good time!").
4450There can be no space between the bracketed part and the parenthesized part.
4451The link text can contain formatting (such as emphasis), but the title cannot.
4453Email addresses in inline links are not autodetected, so they have to be
4454prefixed with `mailto`:
4456 [Write me!](mailto:sam@green.eggs.ham)
4458### Reference links ###
4460An *explicit* reference link has two parts, the link itself and the link
4461definition, which may occur elsewhere in the document (either
4462before or after the link).
4464The link consists of link text in square brackets, followed by a label in
4465square brackets. (There cannot be space between the two unless the
4466`spaced_reference_links` extension is enabled.) The link definition
4467consists of the bracketed label, followed by a colon and a space, followed by
4468the URL, and optionally (after a space) a link title either in quotes or in
4469parentheses. The label must not be parseable as a citation (assuming
4470the `citations` extension is enabled): citations take precedence over
4473Here are some examples:
4475 [my label 1]: /foo/bar.html "My title, optional"
4477 [my label 3]: https://fsf.org (The free software foundation)
4478 [my label 4]: /bar#special 'A title in single quotes'
4480The URL may optionally be surrounded by angle brackets:
4482 [my label 5]: <http://foo.bar.baz>
4484The title may go on the next line:
4486 [my label 3]: https://fsf.org
4487 "The free software foundation"
4489Note that link labels are not case sensitive. So, this will work:
4491 Here is [my link][FOO]
4495In an *implicit* reference link, the second pair of brackets is
4500 [my website]: http://foo.bar.baz
4502Note: In `Markdown.pl` and most other Markdown implementations,
4503reference link definitions cannot occur in nested constructions
4504such as list items or block quotes. Pandoc lifts this arbitrary
4505seeming restriction. So the following is fine in pandoc, though
4506not in most other implementations:
4512#### Extension: `shortcut_reference_links` ####
4514In a *shortcut* reference link, the second pair of brackets may
4519 [my website]: http://foo.bar.baz
4521### Internal links ###
4523To link to another section of the same document, use the automatically
4524generated identifier (see [Heading identifiers]). For example:
4526 See the [Introduction](#introduction).
4530 See the [Introduction].
4532 [Introduction]: #introduction
4534Internal links are currently supported for HTML formats (including
4535HTML slide shows and EPUB), LaTeX, and ConTeXt.
4539A link immediately preceded by a `!` will be treated as an image.
4540The link text will be used as the image's alt text:
4542 
4546 [movie reel]: movie.gif
4548#### Extension: `implicit_figures` ####
4550An image with nonempty alt text, occurring by itself in a
4551paragraph, will be rendered as a figure with a caption. The
4552image's alt text will be used as the caption.
4554 
4556How this is rendered depends on the output format. Some output
4557formats (e.g. RTF) do not yet support figures. In those
4558formats, you'll just get an image in a paragraph by itself, with
4561If you just want a regular inline image, just make sure it is not
4562the only thing in the paragraph. One way to do this is to insert a
4563nonbreaking space after the image:
4565 \
4567Note that in reveal.js slide shows, an image in a paragraph
4568by itself that has the `stretch` class will fill the screen,
4569and the caption and figure tags will be omitted.
4571#### Extension: `link_attributes` ####
4573Attributes can be set on links and images:
4575 An inline {#id .class width=30 height=20px}
4576 and a reference ![image][ref] with attributes.
4578 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4580(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4581and `.class` are used.)
4583For HTML and EPUB, all known HTML5 attributes except `width` and
4584`height` (but including `srcset` and `sizes`) are passed through
4585as is. Unknown attributes are passed through as custom
4586attributes, with `data-` prepended. The other writers ignore
4587attributes that are not specifically supported by their output format.
4589The `width` and `height` attributes on images are treated specially. When
4590used without a unit, the unit is assumed to be pixels. However, any of
4591the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4592and `%`. There must not be any spaces between the number and the unit.
4596{ width=50% }
4599- Dimensions may be converted to a form that is compatible with
4600 the output format (for example, dimensions given in pixels will
4601 be converted to inches when converting HTML to LaTeX). Conversion
4602 between pixels and physical measurements is affected by the
4603 `--dpi` option (by default, 96 dpi is assumed, unless the image
4604 itself contains dpi information).
4605- The `%` unit is generally relative to some available space.
4606 For example the above example will render to the following.
4607 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4608 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4609 (If you're using a custom template, you need to configure `graphicx`
4610 as in the default template.)
4611 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4612- Some output formats have a notion of a class
4613 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4614 or a unique identifier (LaTeX `\caption`), or both (HTML).
4615- When no `width` or `height` attributes are specified, the fallback
4616 is to look at the image resolution and the dpi metadata embedded in
4621Using the `native_divs` and `native_spans` extensions
4622(see [above][Extension: `native_divs`]), HTML syntax can
4623be used as part of markdown to create native `Div` and `Span`
4624elements in the pandoc AST (as opposed to raw HTML).
4625However, there is also nicer syntax available:
4627#### Extension: `fenced_divs` ####
4629Allow special fenced syntax for native `Div` blocks. A Div
4630starts with a fence containing at least three consecutive
4631colons plus some attributes. The attributes may optionally
4632be followed by another string of consecutive colons.
4633The attribute syntax is exactly as in fenced code blocks (see
4634[Extension: `fenced_code_attributes`]). As with fenced
4635code blocks, one can use either attributes in curly braces
4636or a single unbraced word, which will be treated as a class
4637name. The Div ends with another line containing a string of at
4638least three consecutive colons. The fenced Div should be
4639separated by blank lines from preceding and following blocks.
4643 ::::: {#special .sidebar}
4644 Here is a paragraph.
4649Fenced divs can be nested. Opening fences are distinguished
4650because they *must* have attributes:
4656 This is a warning within a warning.
4660Fences without attributes are always closing fences. Unlike
4661with fenced code blocks, the number of colons in the closing
4662fence need not match the number in the opening fence. However,
4663it can be helpful for visual clarity to use fences of different
4664lengths to distinguish nested divs from their parents.
4667#### Extension: `bracketed_spans` ####
4669A bracketed sequence of inlines, as one would use to begin
4670a link, will be treated as a `Span` with attributes if it is
4671followed immediately by attributes:
4673 [This is *some text*]{.class key="val"}
4677#### Extension: `footnotes` ####
4679Pandoc's Markdown allows footnotes, using the following syntax:
4681 Here is a footnote reference,[^1] and another.[^longnote]
4683 [^1]: Here is the footnote.
4685 [^longnote]: Here's one with multiple blocks.
4687 Subsequent paragraphs are indented to show that they
4688 belong to the previous footnote.
4692 The whole paragraph can be indented, or just the first
4693 line. In this way, multi-paragraph footnotes work like
4694 multi-paragraph list items.
4696 This paragraph won't be part of the note, because it
4699The identifiers in footnote references may not contain spaces, tabs,
4700or newlines. These identifiers are used only to correlate the
4701footnote reference with the note itself; in the output, footnotes
4702will be numbered sequentially.
4704The footnotes themselves need not be placed at the end of the
4705document. They may appear anywhere except inside other block elements
4706(lists, block quotes, tables, etc.). Each footnote should be
4707separated from surrounding content (including other footnotes)
4710#### Extension: `inline_notes` ####
4712Inline footnotes are also allowed (though, unlike regular notes,
4713they cannot contain multiple paragraphs). The syntax is as follows:
4715 Here is an inline note.^[Inlines notes are easier to write, since
4716 you don't have to pick an identifier and move down to type the
4719Inline and regular footnotes may be mixed freely.
4723#### Extension: `citations` ####
4725Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4726citations and a bibliography in a number of styles. Basic usage is
4728 pandoc --filter pandoc-citeproc myinput.txt
4730In order to use this feature, you will need to specify a bibliography file
4731using the `bibliography` metadata field in a YAML metadata section, or
4732`--bibliography` command line argument. You can supply multiple `--bibliography`
4733arguments or set `bibliography` metadata field to YAML array, if you want to
4734use multiple bibliography files. The bibliography may have any of these
4737 Format File extension
4738 ------------ --------------
4751Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4752use `.bibtex` to force BibTeX.
4754Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4755can produce `.json` and `.yaml` files from any of the supported formats.
4757In-field markup: In BibTeX and BibLaTeX databases,
4758pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4759databases, pandoc Markdown; and in CSL JSON databases, an
4760[HTML-like markup][CSL markup specs]:
4768`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4777`<span class="nocase">...</span>`
4778: prevent a phrase from being capitalized as title case
4780`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4781and CSL YAML formats as far as possible.
4783As an alternative to specifying a bibliography file using `--bibliography`
4784or the YAML metadata field `bibliography`, you can include
4785the citation data directly in the `references` field of the
4786document's YAML metadata. The field should contain an array of
4787YAML-encoded references, for example:
4791 - type: article-journal
4803 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4805 title-short: Molecular structure of nucleic acids
4806 container-title: Nature
4810 DOI: 10.1038/171737a0
4811 URL: https://www.nature.com/articles/171737a0
4815(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4816of the supported formats.)
4818Citations and references can be formatted using any style supported by the
4819[Citation Style Language], listed in the [Zotero Style Repository].
4820These files are specified using the `--csl` option or the `csl` metadata field.
4821By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4822format. The CSL project provides further information on [finding and editing styles].
4824To make your citations hyperlinks to the corresponding bibliography
4825entries, add `link-citations: true` to your YAML metadata.
4827Citations go inside square brackets and are separated by semicolons.
4828Each citation must have a key, composed of '@' + the citation
4829identifier from the database, and may optionally have a prefix,
4830a locator, and a suffix. The citation key must begin with a letter, digit,
4831or `_`, and may contain alphanumerics, `_`, and internal punctuation
4832characters (`:.#$%&-+?<>~/`). Here are some examples:
4834 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4836 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4838 Blah blah [@smith04; @doe99].
4840`pandoc-citeproc` detects locator terms in the [CSL locale files].
4841Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4842locale, locator terms can be written in either singular or plural forms,
4843as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4844`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4845`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4846`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4847`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4848`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4849locator term is used, "page" is assumed.
4851`pandoc-citeproc` will use heuristics to distinguish the locator
4852from the suffix. In complex cases, the locator can be enclosed
4853in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4855 [@smith{ii, A, D-Z}, with a suffix]
4856 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4858A minus sign (`-`) before the `@` will suppress mention of
4859the author in the citation. This can be useful when the
4860author is already mentioned in the text:
4862 Smith says blah [-@smith04].
4864You can also write an in-text citation, as follows:
4868 @smith04 [p. 33] says blah.
4870If the style calls for a list of works cited, it will be placed
4871in a div with id `refs`, if one exists:
4876Otherwise, it will be placed at the end of the document.
4877Generation of the bibliography can be suppressed by setting
4878`suppress-bibliography: true` in the YAML metadata.
4880If you wish the bibliography to have a section heading, you can
4881set `reference-section-title` in the metadata, or put the heading
4882at the beginning of the div with id `refs` (if you are using it)
4883or at the end of your document:
4889The bibliography will be inserted after this heading. Note that
4890the `unnumbered` class will be added to this heading, so that the
4891section will not be numbered.
4893If you want to include items in the bibliography without actually
4894citing them in the body text, you can define a dummy `nocite` metadata
4895field and put the citations there:
4904In this example, the document will contain a citation for `item3`
4905only, but the bibliography will contain entries for `item1`, `item2`, and
4908It is possible to create a bibliography with all the citations,
4909whether or not they appear in the document, by using a wildcard:
4916For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4917render the bibliography. In order to do so, specify bibliography
4918files as outlined above, and add `--natbib` or `--biblatex`
4919argument to `pandoc` invocation. Bear in mind that bibliography
4920files have to be in respective format (either BibTeX or
4923For more information, see the [pandoc-citeproc man page].
4925[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4926[Chicago Manual of Style]: https://chicagomanualofstyle.org
4927[Citation Style Language]: https://citationstyles.org
4928[Zotero Style Repository]: https://www.zotero.org/styles
4929[finding and editing styles]: https://citationstyles.org/authors/
4930[CSL locale files]: https://github.com/citation-style-language/locales
4931[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4933## Non-pandoc extensions
4935The following Markdown syntax extensions are not enabled by default
4936in pandoc, but may be enabled by adding `+EXTENSION` to the format
4937name, where `EXTENSION` is the name of the extension. Thus, for
4938example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4940#### Extension: `attributes` ####
4942Allows attributes to be attached to any inline or block-level
4943element. The syntax for the attributes is the same as that
4944used in [`header_attributes`][Extension: `header_attributes`].
4946- Attributes that occur immediately after an inline
4947 element affect that element. If they follow a space, then they
4948 belong to the space. (Hence, this option subsumes
4949 `inline_code_attributes` and `link_attributes`.)
4950- Attributes that occur immediately before a block
4951 element, on a line by themselves, affect that
4953- Consecutive attribute specifiers may be used,
4954 either for blocks or for inlines. Their attributes
4956- Attributes that occur at the end of the text of
4957 a Setext or ATX heading (separated by whitespace
4958 from the text) affect the heading element. (Hence, this
4959 option subsumes `header_attributes`.)
4960- Attributes that occur after the opening fence
4961 in a fenced code block affect the code block element. (Hence,
4962 this option subsumes `fenced_code_attributes`.)
4963- Attributes that occur at the end of a reference
4964 link definition affect links that refer to that
4967Note that pandoc's AST does not currently allow attributes
4968to be attached to arbitrary elements. Hence a Span or Div
4969container will be added if needed.
4971#### Extension: `old_dashes` ####
4973Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4974`-` before a numeral is an en-dash, and `--` is an em-dash.
4975This option only has an effect if `smart` is enabled. It is
4976selected automatically for `textile` input.
4978#### Extension: `angle_brackets_escapable` ####
4980Allow `<` and `>` to be backslash-escaped, as they can be in
4981GitHub flavored Markdown but not original Markdown. This is
4982implied by pandoc's default `all_symbols_escapable`.
4984#### Extension: `lists_without_preceding_blankline` ####
4986Allow a list to occur right after a paragraph, with no intervening
4989#### Extension: `four_space_rule` ####
4991Selects the pandoc <= 2.0 behavior for parsing lists, so that
4992four spaces indent are needed for list item continuation
4995#### Extension: `spaced_reference_links` ####
4997Allow whitespace between the two components of a reference link,
5002#### Extension: `hard_line_breaks` ####
5004Causes all newlines within a paragraph to be interpreted as hard line
5005breaks instead of spaces.
5007#### Extension: `ignore_line_breaks` ####
5009Causes newlines within a paragraph to be ignored, rather than being
5010treated as spaces or as hard line breaks. This option is intended for
5011use with East Asian languages where spaces are not used between words,
5012but text is divided into lines for readability.
5014#### Extension: `east_asian_line_breaks` ####
5016Causes newlines within a paragraph to be ignored, rather than
5017being treated as spaces or as hard line breaks, when they occur
5018between two East Asian wide characters. This is a better choice
5019than `ignore_line_breaks` for texts that include a mix of East
5020Asian wide characters and other characters.
5022#### Extension: `emoji` ####
5024Parses textual emojis like `:smile:` as Unicode emoticons.
5026#### Extension: `tex_math_single_backslash` ####
5028Causes anything between `\(` and `\)` to be interpreted as inline
5029TeX math, and anything between `\[` and `\]` to be interpreted
5030as display TeX math. Note: a drawback of this extension is that
5031it precludes escaping `(` and `[`.
5033#### Extension: `tex_math_double_backslash` ####
5035Causes anything between `\\(` and `\\)` to be interpreted as inline
5036TeX math, and anything between `\\[` and `\\]` to be interpreted
5039#### Extension: `markdown_attribute` ####
5041By default, pandoc interprets material inside block-level tags as Markdown.
5042This extension changes the behavior so that Markdown is only parsed
5043inside block-level tags if the tags have the attribute `markdown=1`.
5045#### Extension: `mmd_title_block` ####
5047Enables a [MultiMarkdown] style title block at the top of
5048the document, for example:
5052 Date: September 1, 2008
5053 Comment: This is a sample mmd title block, with
5054 a field spanning multiple lines.
5056See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5057`yaml_metadata_block` is enabled, it will take precedence over
5060#### Extension: `abbreviations` ####
5062Parses PHP Markdown Extra abbreviation keys, like
5064 *[HTML]: Hypertext Markup Language
5066Note that the pandoc document model does not support
5067abbreviations, so if this extension is enabled, abbreviation keys are
5068simply skipped (as opposed to being parsed as paragraphs).
5070#### Extension: `autolink_bare_uris` ####
5072Makes all absolute URIs into links, even when not surrounded by
5073pointy braces `<...>`.
5075#### Extension: `mmd_link_attributes` ####
5077Parses multimarkdown style key-value attributes on link
5078and image references. This extension should not be confused with the
5079[`link_attributes`](#extension-link_attributes) extension.
5081 This is a reference ![image][ref] with multimarkdown attributes.
5083 [ref]: https://path.to/image "Image title" width=20px height=30px
5084 id=myId class="myClass1 myClass2"
5086#### Extension: `mmd_header_identifiers` ####
5088Parses multimarkdown style heading identifiers (in square brackets,
5089after the heading but before any trailing `#`s in an ATX heading).
5091#### Extension: `compact_definition_lists` ####
5093Activates the definition list syntax of pandoc 1.12.x and earlier.
5094This syntax differs from the one described above under [Definition lists]
5097 - No blank line is required between consecutive items of the
5099 - To get a "tight" or "compact" list, omit space between consecutive
5100 items; the space between a term and its definition does not affect
5102 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5103 be indented four spaces.[^6]
5105[^6]: To see why laziness is incompatible with relaxing the requirement
5106 of a blank line between items, consider the following example:
5113 Is this a single list item with two definitions of "bar," the first of
5114 which is lazily wrapped, or two list items? To remove the ambiguity
5115 we must either disallow lazy wrapping or require a blank line between
5118#### Extension: `gutenberg` ####
5120Use [Project Gutenberg] conventions for `plain` output:
5121all-caps for strong emphasis, surround by underscores
5122for regular emphasis, add extra blank space around headings.
5124 [Project Gutenberg]: https://www.gutenberg.org
5128In addition to pandoc's extended Markdown, the following Markdown
5129variants are supported:
5131`markdown_phpextra` (PHP Markdown Extra)
5132: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5133 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5134 `header_attributes`, `link_attributes`, `abbreviations`,
5135 `shortcut_reference_links`, `spaced_reference_links`.
5137`markdown_github` (deprecated GitHub-Flavored Markdown)
5138: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5139 `gfm_auto_identifiers`, `backtick_code_blocks`,
5140 `autolink_bare_uris`, `space_in_atx_header`,
5141 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5142 `shortcut_reference_links`, `angle_brackets_escapable`,
5143 `lists_without_preceding_blankline`.
5145`markdown_mmd` (MultiMarkdown)
5146: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5147 `tex_math_double_backslash`, `intraword_underscores`,
5148 `mmd_title_block`, `footnotes`, `definition_lists`,
5149 `all_symbols_escapable`, `implicit_header_references`,
5150 `auto_identifiers`, `mmd_header_identifiers`,
5151 `shortcut_reference_links`, `implicit_figures`,
5152 `superscript`, `subscript`, `backtick_code_blocks`,
5153 `spaced_reference_links`, `raw_attribute`.
5155`markdown_strict` (Markdown.pl)
5156: `raw_html`, `shortcut_reference_links`,
5157 `spaced_reference_links`.
5159We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5160which is implemented as a set of extensions on `commonmark`).
5162Note, however, that `commonmark` and `gfm` have limited support
5163for extensions. Only those listed below (and `smart`,
5164`raw_tex`, and `hard_line_breaks`) will work. The extensions
5165can, however, all be individually disabled. Also, `raw_tex`
5166only affects `gfm` output, not input.
5168`gfm` (GitHub-Flavored Markdown)
5169: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5170 `gfm_auto_identifiers`, `backtick_code_blocks`,
5171 `autolink_bare_uris`, `space_in_atx_header`,
5172 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5173 `shortcut_reference_links`, `angle_brackets_escapable`,
5174 `lists_without_preceding_blankline`.
5177# Producing slide shows with pandoc
5179You can use pandoc to produce an HTML + JavaScript slide presentation
5180that can be viewed via a web browser. There are five ways to do this,
5181using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5182You can also produce a PDF slide show using LaTeX [`beamer`], or
5183slides shows in Microsoft [PowerPoint] format.
5185Here's the Markdown source for a simple slide show, `habits.txt`:
5212 
5219To produce an HTML/JavaScript slide show, simply type
5221 pandoc -t FORMAT -s habits.txt -o habits.html
5223where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5225For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5226`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5227assumed to be available at the relative path `s5/default` (for S5), `slideous`
5228(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5229`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5230`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5231above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5234With all HTML slide formats, the `--self-contained` option can be used to
5235produce a single file that contains all of the data necessary to display the
5236slide show, including linked scripts, stylesheets, images, and videos.
5238To produce a PDF slide show using beamer, type
5240 pandoc -t beamer habits.txt -o habits.pdf
5242Note that a reveal.js slide show can also be converted to a PDF
5243by printing it to a file from the browser.
5245To produce a Powerpoint slide show, type
5247 pandoc habits.txt -o habits.pptx
5249## Structuring the slide show
5251By default, the *slide level* is the highest heading level in
5252the hierarchy that is followed immediately by content, and not another
5253heading, somewhere in the document. In the example above, level-1 headings
5254are always followed by level-2 headings, which are followed by content,
5255so the slide level is 2. This default can be overridden using
5256the `--slide-level` option.
5258The document is carved up into slides according to the following
5261 * A horizontal rule always starts a new slide.
5263 * A heading at the slide level always starts a new slide.
5265 * Headings *below* the slide level in the hierarchy create
5266 headings *within* a slide.
5268 * Headings *above* the slide level in the hierarchy create
5269 "title slides," which just contain the section title
5270 and help to break the slide show into sections.
5271 Non-slide content under these headings will be included
5272 on the title slide (for HTML slide shows) or in a
5273 subsequent slide with the same title (for beamer).
5275 * A title page is constructed automatically from the document's title
5276 block, if present. (In the case of beamer, this can be disabled
5277 by commenting out some lines in the default template.)
5279These rules are designed to support many different styles of slide show. If
5280you don't care about structuring your slides into sections and subsections,
5281you can just use level-1 headings for all each slide. (In that case, level-1
5282will be the slide level.) But you can also structure the slide show into
5283sections, as in the example above.
5285Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5286layout will be produced, with level-1 headings building horizontally
5287and level-2 headings building vertically. It is not recommended that
5288you use deeper nesting of section levels with reveal.js.
5292By default, these writers produce lists that display "all at once."
5293If you want your lists to display incrementally (one item at a time),
5294use the `-i` option. If you want a particular list to depart from the
5295default, put it in a `div` block with class `incremental` or
5296`nonincremental`. So, for example, using the `fenced div` syntax, the
5297following would be incremental regardless of the document default:
5315While using `incremental` and `nonincremental` divs are the
5316recommended method of setting incremental lists on a per-case basis,
5317an older method is also supported: putting lists inside a blockquote
5318will depart from the document default (that is, it will display
5319incrementally without the `-i` option and all at once with the `-i`
5325Both methods allow incremental and nonincremental lists to be mixed
5326in a single document.
5328Note: Neither the `-i/--incremental` option nor any of the
5329methods described here currently works for PowerPoint output.
5333You can add "pauses" within a slide by including a paragraph containing
5334three dots, separated by spaces:
5336 # Slide with a pause
5338 content before the pause
5342 content after the pause
5344Note: this feature is not yet implemented for PowerPoint output.
5346## Styling the slides
5348You can change the style of HTML slides by putting customized CSS files
5349in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5350or `$DATADIR/slideous` (for Slideous),
5351where `$DATADIR` is the user data directory (see `--data-dir`, above).
5352The originals may be found in pandoc's system data directory (generally
5353`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5354files it does not find in the user data directory.
5356For dzslides, the CSS is included in the HTML file itself, and may
5359All [reveal.js configuration options] can be set through variables.
5360For example, themes can be used by setting the `theme` variable:
5364Or you can specify a custom stylesheet using the `--css` option.
5366To style beamer slides, you can specify a `theme`, `colortheme`,
5367`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5369 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5371Note that heading attributes will turn into slide attributes
5372(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5373to style individual slides. In beamer, the only heading attribute
5374that affects slides is the `allowframebreaks` class, which sets the
5375`allowframebreaks` option, causing multiple slides to be created
5376if the content overfills the frame. This is recommended especially for
5379 # References {.allowframebreaks}
5383Speaker notes are supported in reveal.js and PowerPoint (pptx)
5384output. You can add notes to your Markdown document thus:
5390 - It can contain Markdown
5395To show the notes window in reveal.js, press `s` while viewing the
5396presentation. Speaker notes in PowerPoint will be available, as usual,
5397in handouts and presenter view.
5399Notes are not yet supported for other slide formats, but the notes
5400will not appear on the slides themselves.
5404To put material in side by side columns, you can use a native
5405div container with class `columns`, containing two or more div
5406containers with class `column` and a `width` attribute:
5408 :::::::::::::: {.columns}
5409 ::: {.column width="40%"}
5412 ::: {.column width="60%"}
5417### Additional columns attributes in beamer
5419The div containers with classes `columns` and `column` can optionally have
5420an `align` attribute.
5421The class `columns` can optionally have a `totalwidth` attribute or an
5422`onlytextwidth` class.
5424 :::::::::::::: {.columns align=center totalwidth=8em}
5425 ::: {.column width="40%"}
5428 ::: {.column width="60%" align=bottom}
5433The `align` attributes on `columns` and `column` can be used with the
5434values `top`, `top-baseline`, `center` and `bottom` to vertically align
5435the columns. It defaults to `top` in `columns`.
5437The `totalwidth` attribute limits the width of the columns to the given value.
5439 :::::::::::::: {.columns align=top .onlytextwidth}
5440 ::: {.column width="40%" align=center}
5443 ::: {.column width="60%"}
5448The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5450See Section 12.7 of the [Beamer User's Guide] for more details.
5452## Frame attributes in beamer
5454Sometimes it is necessary to add the LaTeX `[fragile]` option to
5455a frame in beamer (for example, when using the `minted` environment).
5456This can be forced by adding the `fragile` class to the heading
5457introducing the slide:
5459 # Fragile slide {.fragile}
5461All of the other frame attributes described in Section 8.1 of
5462the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5463`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5464`shrink`, `standout`, `noframenumbering`.
5466## Background in reveal.js and beamer
5468Background images can be added to self-contained reveal.js slideshows and
5469to beamer slideshows.
5471For the same image on every slide, use the configuration
5472option `background-image` either in the YAML metadata block
5473or as a command-line variable. (There are no other options in
5474beamer and the rest of this section concerns reveal.js slideshows.)
5476For reveal.js, you can instead use the reveal.js-native option
5477`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5478and `parallaxBackgroundVertical` the same way and must also set
5479`parallaxBackgroundSize` to have your values take effect.
5481To set an image for a particular reveal.js slide, add
5482`{data-background-image="/path/to/image"}`
5483to the first slide-level heading on the slide (which may even be empty).
5485In reveal.js's overview mode, the parallaxBackgroundImage will show up
5486only on the first slide.
5488Other reveal.js background settings also work on individual slides, including
5489`data-background-size`, `data-background-repeat`, `data-background-color`,
5490`data-transition`, and `data-transition-speed`.
5492To add a background image to the automatically generated title slide, use the
5493`title-slide-attributes` variable in the YAML metadata block. It must contain
5494a map of attribute names and values.
5497documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5500For example in reveal.js:
5505parallaxBackgroundImage: /path/to/my/background_image.png
5506title-slide-attributes:
5507 data-background-image: /path/to/title_image.png
5508 data-background-size: contain
5513Slide 1 has background_image.png as its background.
5515## {data-background-image="/path/to/special_image.jpg"}
5517Slide 2 has a special image for its background, even though the heading has no content.
5520# Creating EPUBs with pandoc
5524EPUB metadata may be specified using the `--epub-metadata` option, but
5525if the source document is Markdown, it is better to use a [YAML metadata
5526block][Extension: `yaml_metadata_block`]. Here is an example:
5533 text: An investigation of metadata
5541 text: doi:10.234234.234/33
5543 rights: © 2007 John Smith, CC BY-NC
5548The following fields are recognized:
5551 ~ Either a string value or an object with fields `text` and
5552 `scheme`. Valid values for `scheme` are `ISBN-10`,
5553 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5554 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5555 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5558 ~ Either a string value, or an object with fields `file-as` and
5559 `type`, or a list of such objects. Valid values for `type` are
5560 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5563 ~ Either a string value, or an object with fields `role`, `file-as`,
5564 and `text`, or a list of such objects. Valid values for `role` are
5565 [MARC relators], but
5566 pandoc will attempt to translate the human-readable versions
5567 (like "author" and "editor") to the appropriate marc relators.
5570 ~ Same format as `creator`.
5573 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5574 Pandoc will attempt to convert other common date formats.
5576`lang` (or legacy: `language`)
5577 ~ A string value in [BCP 47] format. Pandoc will default to the local
5578 language if nothing is specified.
5581 ~ A string value or a list of such values.
5602 ~ A string value (path to cover image).
5604`css` (or legacy: `stylesheet`)
5605 ~ A string value (path to CSS stylesheet).
5607`page-progression-direction`
5608 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5609 attribute for the [`spine` element].
5612 ~ iBooks-specific metadata, with the following fields:
5614 - `version`: (string)
5615 - `specified-fonts`: `true`|`false` (default `false`)
5616 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5617 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5618 - `binding`: `true`|`false` (default `true`)
5619 - `scroll-axis`: `vertical`|`horizontal`|`default`
5621[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5622[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5624## The `epub:type` attribute
5626For `epub3` output, you can mark up the heading that corresponds to an EPUB
5627chapter using the [`epub:type` attribute][epub-type]. For example, to set
5628the attribute to the value `prologue`, use this markdown:
5630 # My chapter {epub:type=prologue}
5632Which will result in:
5634 <body epub:type="frontmatter">
5635 <section epub:type="prologue">
5638Pandoc will output `<body epub:type="bodymatter">`, unless
5639you use one of the following values, in which case either
5640`frontmatter` or `backmatter` will be output.
5642`epub:type` of first section `epub:type` of body
5643---------------------------- ------------------
5646acknowledgments frontmatter
5647copyright-page frontmatter
5648dedication frontmatter
5652contributors frontmatter
5653other-credits frontmatter
5655revision-history frontmatter
5656titlepage frontmatter
5657halftitlepage frontmatter
5658seriespage frontmatter
5661seriespage frontmatter
5662titlepage frontmatter
5665bibliography backmatter
5668[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5672By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5673`<video>` or `<source>` element present in the generated EPUB,
5674and include it in the EPUB container, yielding a completely
5675self-contained EPUB. If you want to link to external media resources
5676instead, use raw HTML in your source and add `data-external="1"` to the tag
5677with the `src` attribute. For example:
5679 <audio controls="1">
5680 <source src="https://example.com/music/toccata.mp3"
5681 data-external="1" type="audio/mpeg">
5685# Creating Jupyter notebooks with pandoc
5687When creating a [Jupyter notebook], pandoc will try to infer the
5688notebook structure. Code blocks with the class `code` will be
5689taken as code cells, and intervening content will be taken as
5690Markdown cells. Attachments will automatically be created for
5691images in Markdown cells. Metadata will be taken from the
5692`jupyter` metadata field. For example:
5701 display_name: Python 2
5708 file_extension: ".py"
5709 mimetype: "text/x-python"
5711 nbconvert_exporter: "python"
5712 pygments_lexer: "ipython2"
5718**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5719bibendum felis dictum sodales.
5728from IPython.display import HTML
5731console.log("hello");
5739This image  will be
5740included as a cell attachment.
5743If you want to add cell attributes, group cells differently, or
5744add output to code cells, then you need to include divs to
5745indicate the structure. You can use either [fenced
5746divs][Extension: `fenced_divs`] or [native divs][Extension:
5747`native_divs`] for this. Here is an example:
5750:::::: {.cell .markdown}
5753**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5754bibendum felis dictum sodales.
5757:::::: {.cell .code execution_count=1}
5762::: {.output .stream .stdout}
5769:::::: {.cell .code execution_count=2}
5771from IPython.display import HTML
5774console.log("hello");
5780::: {.output .execute_result execution_count=2}
5783console.log("hello");
5792If you include raw HTML or TeX in an output cell, use the
5793[raw attribute][Extension: `fenced_attribute`], as shown
5794in the last cell of the example above. Although pandoc can
5795process "bare" raw HTML and TeX, the result is often
5796interspersed raw elements and normal textual elements, and
5797in an output cell pandoc expects a single, connected raw
5798block. To avoid using raw HTML or TeX except when
5799marked explicitly using raw attributes, we recommend
5800specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5801translating between Markdown and ipynb notebooks.
5803Note that options and extensions that affect reading and
5804writing of Markdown will also affect Markdown cells in ipynb
5805notebooks. For example, `--wrap=preserve` will preserve
5806soft line breaks in Markdown cells; `--atx-headers` will
5807cause ATX-style headings to be used; and `--preserve-tabs` will
5808prevent tabs from being turned to spaces.
5810# Syntax highlighting
5812Pandoc will automatically highlight syntax in [fenced code blocks] that
5813are marked with a language name. The Haskell library [skylighting] is
5814used for highlighting. Currently highlighting is supported only for
5815HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5816that pandoc will recognize, type `pandoc --list-highlight-languages`.
5818The color scheme can be selected using the `--highlight-style` option.
5819The default color scheme is `pygments`, which imitates the default color
5820scheme used by the Python library pygments (though pygments is not actually
5821used to do the highlighting). To see a list of highlight styles,
5822type `pandoc --list-highlight-styles`.
5824If you are not satisfied with the predefined styles, you can
5825use `--print-highlight-style` to generate a JSON `.theme` file which
5826can be modified and used as the argument to `--highlight-style`. To
5827get a JSON version of the `pygments` style, for example:
5829 pandoc --print-highlight-style pygments > my.theme
5831Then edit `my.theme` and use it like this:
5833 pandoc --highlight-style my.theme
5835If you are not satisfied with the built-in highlighting, or you
5836want highlight a language that isn't supported, you can use the
5837`--syntax-definition` option to load a [KDE-style XML syntax definition
5838file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5839Before writing your own, have a look at KDE's [repository of syntax
5840definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5842To disable highlighting, use the `--no-highlight` option.
5844[skylighting]: https://github.com/jgm/skylighting
5848Custom styles can be used in the docx and ICML formats.
5852By default, pandoc's docx and ICML output applies a predefined set of styles
5853for blocks such as paragraphs and block quotes, and uses largely default
5854formatting (italics, bold) for inlines. This will work for most
5855purposes, especially alongside a `reference.docx` file. However, if you
5856need to apply your own styles to blocks, or match a preexisting set of
5857styles, pandoc allows you to define custom styles for blocks and text
5858using `div`s and `span`s, respectively.
5860If you define a `div` or `span` with the attribute `custom-style`,
5861pandoc will apply your specified style to the contained elements (with
5862the exception of elements whose function depends on a style, like
5863headings, code blocks, block quotes, or links). So, for example, using
5864the `bracketed_spans` syntax,
5866 [Get out]{custom-style="Emphatically"}, he said.
5868would produce a docx file with "Get out" styled with character
5869style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5871 Dickinson starts the poem simply:
5873 ::: {custom-style="Poetry"}
5874 | A Bird came down the Walk---
5875 | He did not know I saw---
5878would style the two contained lines with the `Poetry` paragraph style.
5880For docx output, styles will be defined in the output file as inheriting
5881from normal text, if the styles are not yet in your reference.docx.
5882If they are already defined, pandoc will not alter the definition.
5884This feature allows for greatest customization in conjunction with
5885[pandoc filters]. If you want all paragraphs after block quotes to be
5886indented, you can write a filter to apply the styles necessary. If you
5887want all italics to be transformed to the `Emphasis` character style
5888(perhaps to change their color), you can write a filter which will
5889transform all italicized inlines to inlines within an `Emphasis`
5892For docx output, you don't need to enable any extensions for
5893custom styles to work.
5895[pandoc filters]: https://pandoc.org/filters.html
5899The docx reader, by default, only reads those styles that it can
5900convert into pandoc elements, either by direct conversion or
5901interpreting the derivation of the input document's styles.
5903By enabling the [`styles` extension](#ext-styles) in the docx reader
5904(`-f docx+styles`), you can produce output that maintains the styles
5905of the input document, using the `custom-style` class. Paragraph
5906styles are interpreted as divs, while character styles are interpreted
5909For example, using the `custom-style-reference.docx` file in the test
5910directory, we have the following different outputs:
5912Without the `+styles` extension:
5914 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5917 This is text with an *emphasized* text style. And this is text with a
5918 **strengthened** text style.
5920 > Here is a styled paragraph that inherits from Block Text.
5922And with the extension:
5924 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5926 ::: {custom-style="First Paragraph"}
5930 ::: {custom-style="Body Text"}
5931 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5932 And this is text with a [strengthened]{custom-style="Strengthened"}
5936 ::: {custom-style="My Block Style"}
5937 > Here is a styled paragraph that inherits from Block Text.
5940With these custom styles, you can use your input document as a
5941reference-doc while creating docx output (see below), and maintain the
5942same styles in your input and output files.
5946Pandoc can be extended with custom writers written in [Lua]. (Pandoc
5947includes a Lua interpreter, so Lua need not be installed separately.)
5949To use a custom writer, simply specify the path to the Lua script
5950in place of the output format. For example:
5952 pandoc -t data/sample.lua
5954Creating a custom writer requires writing a Lua function for each
5955possible element in a pandoc document. To get a documented example
5956which you can modify according to your needs, do
5958 pandoc --print-default-data-file sample.lua
5960Note that custom writers have no default template. If you want
5961to use `--standalone` with a custom writer, you will need to
5962specify a template manually using `--template` or add a new
5963default template with the name
5964`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5965subdirectory of your user data directory (see [Templates]).
5967[Lua]: https://www.lua.org
5971If you use pandoc to convert user-contributed content in a web
5972application, here are some things to keep in mind:
59741. Although pandoc itself will not create or modify any files other
5975 than those you explicitly ask it create (with the exception
5976 of temporary files used in producing PDFs), a filter or custom
5977 writer could in principle do anything on your file system. Please
5978 audit filters and custom writers very carefully before using them.
59802. If your application uses pandoc as a Haskell library (rather than
5981 shelling out to the executable), it is possible to use it in a mode
5982 that fully isolates pandoc from your file system, by running the
5983 pandoc operations in the `PandocPure` monad. See the document
5984 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
59873. Pandoc's parsers can exhibit pathological performance on some
5988 corner cases. It is wise to put any pandoc operations under
5989 a timeout, to avoid DOS attacks that exploit these issues.
5990 If you are using the pandoc executable, you can add the
5991 command line options `+RTS -M512M -RTS` (for example) to limit
5992 the heap size to 512MB.
59944. The HTML generated by pandoc is not guaranteed to be safe.
5995 If `raw_html` is enabled for the Markdown input, users can
5996 inject arbitrary HTML. Even if `raw_html` is disabled,
5997 users can include dangerous content in attributes for
5998 headings, spans, and code blocks. To be safe, you should
5999 run all the generated HTML through an HTML sanitizer.
6003Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6004under the [GPL], version 2 or greater. This software carries no
6005warranty of any kind. (See COPYRIGHT for full copyright and
6006warranty notices.) For a full list of contributors, see the file
6007AUTHORS.md in the pandoc source code.
6009[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6010[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