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 - `creole` ([Creole 1.0])
230 - `csv` ([CSV] table)
231 - `docbook` ([DocBook])
232 - `docx` ([Word docx])
233 - `dokuwiki` ([DokuWiki markup])
235 - `fb2` ([FictionBook2] e-book)
236 - `gfm` ([GitHub-Flavored Markdown]),
237 or the deprecated and less accurate `markdown_github`;
238 use [`markdown_github`](#markdown-variants) only
239 if you need extensions not supported in [`gfm`](#markdown-variants).
240 - `haddock` ([Haddock markup])
242 - `ipynb` ([Jupyter notebook])
243 - `jats` ([JATS] XML)
244 - `jira` ([Jira] wiki markup)
245 - `json` (JSON version of native AST)
247 - `markdown` ([Pandoc's Markdown])
248 - `markdown_mmd` ([MultiMarkdown])
249 - `markdown_phpextra` ([PHP Markdown Extra])
250 - `markdown_strict` (original unextended [Markdown])
251 - `mediawiki` ([MediaWiki markup])
254 - `native` (native Haskell)
257 - `org` ([Emacs Org mode])
258 - `rst` ([reStructuredText])
260 - `textile` ([Textile])
261 - `tikiwiki` ([TikiWiki markup])
262 - `twiki` ([TWiki markup])
263 - `vimwiki` ([Vimwiki])
266 Extensions can be individually enabled or disabled by
267 appending `+EXTENSION` or `-EXTENSION` to the format name.
268 See [Extensions] below, for a list of extensions and
269 their names. See `--list-input-formats` and `--list-extensions`,
272`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
274: Specify output format. *FORMAT* can be:
276 ::: {#output-formats}
277 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
278 - `beamer` ([LaTeX beamer][`beamer`] slide show)
279 - `commonmark` ([CommonMark] Markdown)
280 - `context` ([ConTeXt])
281 - `docbook` or `docbook4` ([DocBook] 4)
282 - `docbook5` (DocBook 5)
283 - `docx` ([Word docx])
284 - `dokuwiki` ([DokuWiki markup])
285 - `epub` or `epub3` ([EPUB] v3 book)
287 - `fb2` ([FictionBook2] e-book)
288 - `gfm` ([GitHub-Flavored Markdown]),
289 or the deprecated and less accurate `markdown_github`;
290 use [`markdown_github`](#markdown-variants) only
291 if you need extensions not supported in [`gfm`](#markdown-variants).
292 - `haddock` ([Haddock markup])
293 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
294 - `html4` ([XHTML] 1.0 Transitional)
295 - `icml` ([InDesign ICML])
296 - `ipynb` ([Jupyter notebook])
297 - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
298 - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
299 - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
300 - `jats` (alias for `jats_archiving`)
301 - `jira` ([Jira] wiki markup)
302 - `json` (JSON version of native AST)
305 - `markdown` ([Pandoc's Markdown])
306 - `markdown_mmd` ([MultiMarkdown])
307 - `markdown_phpextra` ([PHP Markdown Extra])
308 - `markdown_strict` (original unextended [Markdown])
309 - `mediawiki` ([MediaWiki markup])
312 - `native` (native Haskell),
313 - `odt` ([OpenOffice text document][ODT])
315 - `opendocument` ([OpenDocument])
316 - `org` ([Emacs Org mode])
318 - `plain` (plain text),
319 - `pptx` ([PowerPoint] slide show)
320 - `rst` ([reStructuredText])
321 - `rtf` ([Rich Text Format])
322 - `texinfo` ([GNU Texinfo])
323 - `textile` ([Textile])
324 - `slideous` ([Slideous] HTML and JavaScript slide show)
325 - `slidy` ([Slidy] HTML and JavaScript slide show)
326 - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
327 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
328 - `s5` ([S5] HTML and JavaScript slide show)
329 - `tei` ([TEI Simple])
330 - `xwiki` ([XWiki markup])
331 - `zimwiki` ([ZimWiki markup])
332 - the path of a custom Lua writer, see [Custom writers] below
335 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
336 to *stdout* unless forced with `-o -`.
338 Extensions can be individually enabled or
339 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
340 name. See [Extensions] below, for a list of extensions and their
341 names. See `--list-output-formats` and `--list-extensions`, below.
343`-o` *FILE*, `--output=`*FILE*
345: Write output to *FILE* instead of *stdout*. If *FILE* is
346 `-`, output will go to *stdout*, even if a non-textual format
347 (`docx`, `odt`, `epub2`, `epub3`) is specified.
349`--data-dir=`*DIRECTORY*
351: Specify the user data directory to search for pandoc data files.
352 If this option is not specified, the default user data directory
353 will be used. On \*nix and macOS systems this will be the `pandoc`
354 subdirectory of the XDG data directory (by default,
355 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
356 environment variable). If that directory does not exist,
357 `$HOME/.pandoc` will be used (for backwards compatibility).
358 In Windows the default user data directory is
359 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
360 You can find the default user data directory on your system by
361 looking at the output of `pandoc --version`.
362 A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
363 `slidy`, `slideous`, or `s5` directory
364 placed in this directory will override pandoc's normal defaults.
366`-d` *FILE*, `--defaults=`*FILE*
368: Specify a set of default option settings. *FILE* is a YAML
369 file whose fields correspond to command-line option
370 settings. All options for document conversion, including input
371 and output files, can be set using a defaults file. The file will
372 be searched for first in the working directory, and then in
373 the `defaults` subdirectory of the user data directory
374 (see `--data-dir`). The `.yaml` extension may be omitted.
375 See the section [Default files] for more information on the
376 file format. Settings from the defaults file may be
377 overridden or extended by subsequent options on the command
382: Generate a bash completion script. To enable bash completion
383 with pandoc, add this to your `.bashrc`:
385 eval "$(pandoc --bash-completion)"
389: Give verbose debugging output. Currently this only has an effect
394: Suppress warning messages.
398: Exit with error status if there are any warnings.
402: Write log messages in machine-readable JSON format to
403 *FILE*. All messages above DEBUG level will be written,
404 regardless of verbosity settings (`--verbose`, `--quiet`).
406`--list-input-formats`
408: List supported input formats, one per line.
410`--list-output-formats`
412: List supported output formats, one per line.
414`--list-extensions`[`=`*FORMAT*]
416: List supported extensions for *FORMAT*, one per line, preceded
417 by a `+` or `-` indicating whether it is enabled by default
418 in *FORMAT*. If *FORMAT* is not specified, defaults for
419 pandoc's Markdown are given.
421`--list-highlight-languages`
423: List supported languages for syntax highlighting, one per
426`--list-highlight-styles`
428: List supported styles for syntax highlighting, one per line.
429 See `--highlight-style`.
439[Markdown]: https://daringfireball.net/projects/markdown/
440[CommonMark]: https://commonmark.org
441[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
442[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
443[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
444[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
445[S5]: https://meyerweb.com/eric/tools/s5/
446[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
447[Slideous]: https://goessner.net/articles/slideous/
448[HTML]: https://www.w3.org/html/
449[HTML5]: https://html.spec.whatwg.org/
450[polyglot markup]: https://www.w3.org/TR/html-polyglot/
451[XHTML]: https://www.w3.org/TR/xhtml1/
452[LaTeX]: https://www.latex-project.org/
453[`beamer`]: https://ctan.org/pkg/beamer
454[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
455[ConTeXt]: https://www.contextgarden.net/
456[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
457[DocBook]: https://docbook.org
458[JATS]: https://jats.nlm.nih.gov
459[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
460[txt2tags]: https://txt2tags.org
461[EPUB]: http://idpf.org/epub
462[OPML]: http://dev.opml.org/spec2.html
463[OpenDocument]: http://opendocument.xml.org
464[ODT]: https://en.wikipedia.org/wiki/OpenDocument
465[Textile]: https://www.promptworks.com/textile
466[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
467[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
468[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
469[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
470[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
471[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
472[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
473[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
474[CSV]: https://tools.ietf.org/html/rfc4180
475[roff man]: https://man.cx/groff_man(7)
476[roff ms]: https://man.cx/groff_ms(7)
477[Haskell]: https://www.haskell.org
478[GNU Texinfo]: https://www.gnu.org/software/texinfo/
479[Emacs Org mode]: https://orgmode.org
480[AsciiDoc]: https://www.methods.co.nz/asciidoc/
481[AsciiDoctor]: https://asciidoctor.org/
482[DZSlides]: http://paulrouget.com/dzslides/
483[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
484[PDF]: https://www.adobe.com/pdf/
485[reveal.js]: https://revealjs.com/
486[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
487[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
488[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
489[TEI Simple]: https://github.com/TEIC/TEI-Simple
490[Muse]: https://amusewiki.org/library/manual
491[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
492[Vimwiki]: https://vimwiki.github.io
494## Reader options {.options}
496`--shift-heading-level-by=`*NUMBER*
498: Shift heading levels by a positive or negative integer.
499 For example, with `--shift-heading-level-by=-1`, level 2
500 headings become level 1 headings, and level 3 headings
501 become level 2 headings. Headings cannot have a level
502 less than 1, so a heading that would be shifted below level 1
503 becomes a regular paragraph. Exception: with a shift of -N,
504 a level-N heading at the beginning of the document
505 replaces the metadata title. `--shift-heading-level-by=-1`
506 is a good choice when converting HTML or Markdown documents that
507 use an initial level-1 heading for the document title and
508 level-2+ headings for sections. `--shift-heading-level-by=1`
509 may be a good choice for converting Markdown documents that
510 use level-1 headings for sections to HTML, since pandoc uses
511 a level-1 heading to render the document title.
513`--base-header-level=`*NUMBER*
515: *Deprecated. Use `--shift-heading-level-by`=X instead,
516 where X = NUMBER - 1.* Specify the base level for headings
519`--strip-empty-paragraphs`
521: *Deprecated. Use the `+empty_paragraphs` extension instead.*
522 Ignore paragraphs with no content. This option is useful
523 for converting word processing documents where users have
524 used empty paragraphs to create inter-paragraph space.
526`--indented-code-classes=`*CLASSES*
528: Specify classes to use for indented code blocks--for example,
529 `perl,numberLines` or `haskell`. Multiple classes may be separated
532`--default-image-extension=`*EXTENSION*
534: Specify a default extension to use when image paths/URLs have no
535 extension. This allows you to use the same source for formats that
536 require different kinds of images. Currently this option only affects
537 the Markdown and LaTeX readers.
541: Parse each file individually before combining for multifile
542 documents. This will allow footnotes in different files with the
543 same identifiers to work as expected. If this option is set,
544 footnotes and links will not work across files. Reading binary
545 files (docx, odt, epub) implies `--file-scope`.
547`-F` *PROGRAM*, `--filter=`*PROGRAM*
549: Specify an executable to be used as a filter transforming the
550 pandoc AST after the input is parsed and before the output is
551 written. The executable should read JSON from stdin and write
552 JSON to stdout. The JSON must be formatted like pandoc's own
553 JSON input and output. The name of the output format will be
554 passed to the filter as the first argument. Hence,
556 pandoc --filter ./caps.py -t latex
560 pandoc -t json | ./caps.py latex | pandoc -f json -t latex
562 The latter form may be useful for debugging filters.
564 Filters may be written in any language. `Text.Pandoc.JSON`
565 exports `toJSONFilter` to facilitate writing filters in Haskell.
566 Those who would prefer to write filters in python can use the
567 module [`pandocfilters`], installable from PyPI. There are also
568 pandoc filter libraries in [PHP], [perl], and
569 [JavaScript/node.js].
571 In order of preference, pandoc will look for filters in
573 1. a specified full or relative path (executable or
576 2. `$DATADIR/filters` (executable or non-executable)
577 where `$DATADIR` is the user data directory (see
578 `--data-dir`, above).
580 3. `$PATH` (executable only)
582 Filters and Lua-filters are applied in the order specified
585`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
587: Transform the document in a similar fashion as JSON filters (see
588 `--filter`), but use pandoc's build-in Lua filtering system. The given
589 Lua script is expected to return a list of Lua filters which will be
590 applied in order. Each Lua filter must contain element-transforming
591 functions indexed by the name of the AST element on which the filter
592 function should be applied.
594 The `pandoc` Lua module provides helper functions for element
595 creation. It is always loaded into the script's Lua environment.
597 The following is an example Lua script for macro-expansion:
599 function expand_hello_world(inline)
600 if inline.c == '{{helloworld}}' then
601 return pandoc.Emph{ pandoc.Str "Hello, World" }
607 return {{Str = expand_hello_world}}
609 In order of preference, pandoc will look for Lua filters in
611 1. a specified full or relative path (executable or
614 2. `$DATADIR/filters` (executable or non-executable)
615 where `$DATADIR` is the user data directory (see
616 `--data-dir`, above).
618`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620: Set the metadata field *KEY* to the value *VAL*. A value specified
621 on the command line overrides a value specified in the document
622 using [YAML metadata blocks][Extension: `yaml_metadata_block`].
623 Values will be parsed as YAML boolean or string values. If no value is
624 specified, the value will be treated as Boolean true. Like
625 `--variable`, `--metadata` causes template variables to be set.
626 But unlike `--variable`, `--metadata` affects the metadata of the
627 underlying document (which is accessible from filters and may be
628 printed in some output formats) and metadata values will be escaped
629 when inserted into the template.
631`--metadata-file=`*FILE*
633: Read metadata from the supplied YAML (or JSON) file. This
634 option can be used with every input format, but string scalars
635 in the YAML file will always be parsed as Markdown. Generally,
636 the input will be handled the same as in [YAML metadata
637 blocks][Extension: `yaml_metadata_block`]. This option can be
638 used repeatedly to include multiple metadata files; values in
639 files specified later on the command line will be preferred
640 over those specified in earlier files. Metadata values
641 specified inside the document, or by using `-M`, overwrite
642 values specified with this option.
644`-p`, `--preserve-tabs`
646: Preserve tabs instead of converting them to spaces. (By default, pandoc
647 converts tabs to spaces before parsing its input.) Note that this will
648 only affect tabs in literal code spans and code blocks. Tabs in regular
649 text are always treated as spaces.
653: Specify the number of spaces per tab (default is 4).
655`--track-changes=accept`|`reject`|`all`
657: Specifies what to do with insertions, deletions, and comments
658 produced by the MS Word "Track Changes" feature. `accept` (the
659 default), inserts all insertions, and ignores all
660 deletions. `reject` inserts all deletions and ignores
661 insertions. Both `accept` and `reject` ignore comments. `all` puts
662 in insertions, deletions, and comments, wrapped in spans with
663 `insertion`, `deletion`, `comment-start`, and `comment-end`
664 classes, respectively. The author and time of change is
665 included. `all` is useful for scripting: only accepting changes
666 from a certain reviewer, say, or before a certain date. If a
667 paragraph is inserted or deleted, `track-changes=all` produces a
668 span with the class `paragraph-insertion`/`paragraph-deletion`
669 before the affected paragraph break. This option only affects the
672`--extract-media=`*DIR*
674: Extract images and other media contained in or linked from
675 the source document to the path *DIR*, creating it if
676 necessary, and adjust the images references in the document
677 so they point to the extracted files. If the source format is
678 a binary container (docx, epub, or odt), the media is
679 extracted from the container and the original
680 filenames are used. Otherwise the media is read from the
681 file system or downloaded, and new filenames are constructed
682 based on SHA1 hashes of the contents.
684`--abbreviations=`*FILE*
686: Specifies a custom abbreviations file, with abbreviations
687 one to a line. If this option is not specified, pandoc will
688 read the data file `abbreviations` from the user data
689 directory or fall back on a system default. To see the
691 `pandoc --print-default-data-file=abbreviations`. The only
692 use pandoc makes of this list is in the Markdown reader.
693 Strings ending in a period that are found in this list will
694 be followed by a nonbreaking space, so that the period will
695 not produce sentence-ending space in formats like LaTeX.
697[`pandocfilters`]: https://github.com/jgm/pandocfilters
698[PHP]: https://github.com/vinai/pandocfilters-php
699[perl]: https://metacpan.org/pod/Pandoc::Filter
700[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702## General writer options {.options}
706: Produce output with an appropriate header and footer (e.g. a
707 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
708 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
709 output. For `native` output, this option causes metadata to
710 be included; otherwise, metadata is suppressed.
712`--template=`*FILE*|*URL*
714: Use the specified file as a custom template for the generated document.
715 Implies `--standalone`. See [Templates], below, for a description
716 of template syntax. If no extension is specified, an extension
717 corresponding to the writer will be added, so that `--template=special`
718 looks for `special.html` for HTML output. If the template is not
719 found, pandoc will search for it in the `templates` subdirectory of
720 the user data directory (see `--data-dir`). If this option is not used,
721 a default template appropriate for the output format will be used (see
722 `-D/--print-default-template`).
724`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
726: Set the template variable *KEY* to the value *VAL* when rendering the
727 document in standalone mode. If no *VAL* is specified, the
728 key will be given the value `true`.
730`-D` *FORMAT*, `--print-default-template=`*FORMAT*
732: Print the system default template for an output *FORMAT*. (See `-t`
733 for a list of possible *FORMAT*s.) Templates in the user data
734 directory are ignored. This option may be used with
735 `-o`/`--output` to redirect output to a file, but
736 `-o`/`--output` must come before `--print-default-template`
739 Note that some of the default templates use partials, for
740 example `styles.html`. To print the partials, use
741 `--print-default-data-file`: for example,
742 `--print-default-data-file=templates/styles.html`.
744`--print-default-data-file=`*FILE*
746: Print a system default data file. Files in the user data directory
747 are ignored. This option may be used with `-o`/`--output` to
748 redirect output to a file, but `-o`/`--output` must come before
749 `--print-default-data-file` on the command line.
751`--eol=crlf`|`lf`|`native`
753: Manually specify line endings: `crlf` (Windows), `lf`
754 (macOS/Linux/UNIX), or `native` (line endings appropriate
755 to the OS on which pandoc is being run). The default is
760: Specify the default dpi (dots per inch) value for conversion
761 from pixels to inch/centimeters and vice versa. (Technically,
762 the correct term would be ppi: pixels per inch.) The default
763 is 96dpi. When images contain information about dpi
764 internally, the encoded value is used instead of the default
765 specified by this option.
767`--wrap=auto`|`none`|`preserve`
769: Determine how text is wrapped in the output (the source
770 code, not the rendered version). With `auto` (the default),
771 pandoc will attempt to wrap lines to the column width specified by
772 `--columns` (default 72). With `none`, pandoc will not wrap
773 lines at all. With `preserve`, pandoc will attempt to
774 preserve the wrapping from the source document (that is,
775 where there are nonsemantic newlines in the source, there
776 will be nonsemantic newlines in the output as well).
777 Automatic wrapping does not currently work in HTML output.
778 In `ipynb` output, this option affects wrapping of the
779 contents of markdown cells.
783: Specify length of lines in characters. This affects text wrapping
784 in the generated source code (see `--wrap`). It also affects
785 calculation of column widths for plain text tables (see [Tables] below).
787`--toc`, `--table-of-contents`
789: Include an automatically generated table of contents (or, in
790 the case of `latex`, `context`, `docx`, `odt`,
791 `opendocument`, `rst`, or `ms`, an instruction to create
792 one) in the output document. This option has no effect
793 unless `-s/--standalone` is used, and it has no effect
794 on `man`, `docbook4`, `docbook5`, or `jats` output.
796 Note that if you are producing a PDF via `ms`, the table
797 of contents will appear at the beginning of the
798 document, before the title. If you would prefer it to
799 be at the end of the document, use the option
800 `--pdf-engine-opt=--no-toc-relocation`.
802`--toc-depth=`*NUMBER*
804: Specify the number of section levels to include in the table
805 of contents. The default is 3 (which means that level-1, 2, and 3
806 headings will be listed in the contents).
810: Strip out HTML comments in the Markdown or Textile source,
811 rather than passing them on to Markdown, Textile or HTML
812 output as raw HTML. This does not apply to HTML comments
813 inside raw HTML blocks when the `markdown_in_html_blocks`
814 extension is not set.
818: Disables syntax highlighting for code blocks and inlines, even when
819 a language attribute is given.
821`--highlight-style=`*STYLE*|*FILE*
823: Specifies the coloring style to be used in highlighted source code.
824 Options are `pygments` (the default), `kate`, `monochrome`,
825 `breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
826 For more information on syntax highlighting in pandoc, see
827 [Syntax highlighting], below. See also
828 `--list-highlight-styles`.
830 Instead of a *STYLE* name, a JSON file with extension
831 `.theme` may be supplied. This will be parsed as a KDE
832 syntax highlighting theme and (if valid) used as the
835 To generate the JSON version of an existing style,
836 use `--print-highlight-style`.
838`--print-highlight-style=`*STYLE*|*FILE*
840: Prints a JSON version of a highlighting style, which can
841 be modified, saved with a `.theme` extension, and used
842 with `--highlight-style`. This option may be used with
843 `-o`/`--output` to redirect output to a file, but
844 `-o`/`--output` must come before `--print-highlight-style`
847`--syntax-definition=`*FILE*
849: Instructs pandoc to load a KDE XML syntax definition file,
850 which will be used for syntax highlighting of appropriately
851 marked code blocks. This can be used to add support for
852 new languages or to use altered syntax definitions for
853 existing languages. This option may be repeated to add
854 multiple syntax definitions.
856`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
858: Include contents of *FILE*, verbatim, at the end of the header.
859 This can be used, for example, to include special
860 CSS or JavaScript in HTML documents. This option can be used
861 repeatedly to include multiple files in the header. They will be
862 included in the order specified. Implies `--standalone`.
864`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
866: Include contents of *FILE*, verbatim, at the beginning of the
867 document body (e.g. after the `<body>` tag in HTML, or the
868 `\begin{document}` command in LaTeX). This can be used to include
869 navigation bars or banners in HTML documents. This option can be
870 used repeatedly to include multiple files. They will be included in
871 the order specified. Implies `--standalone`.
873`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
875: Include contents of *FILE*, verbatim, at the end of the document
876 body (before the `</body>` tag in HTML, or the
877 `\end{document}` command in LaTeX). This option can be used
878 repeatedly to include multiple files. They will be included in the
879 order specified. Implies `--standalone`.
881`--resource-path=`*SEARCHPATH*
883: List of paths to search for images and other resources.
884 The paths should be separated by `:` on Linux, UNIX, and
885 macOS systems, and by `;` on Windows. If `--resource-path`
886 is not specified, the default resource path is the working
887 directory. Note that, if `--resource-path` is specified,
888 the working directory must be explicitly listed or it
889 will not be searched. For example:
890 `--resource-path=.:test` will search the working directory
891 and the `test` subdirectory, in that order.
893 `--resource-path` only has an effect if (a) the output
894 format embeds images (for example, `docx`, `pdf`, or `html`
895 with `--self-contained`) or (b) it is used together with
898`--request-header=`*NAME*`:`*VAL*
900: Set the request header *NAME* to the value *VAL* when making
901 HTTP requests (for example, when a URL is given on the
902 command line, or when resources used in a document must be
903 downloaded). If you're behind a proxy, you also need to set
904 the environment variable `http_proxy` to `http://...`.
906## Options affecting specific writers {.options}
910: Produce a standalone HTML file with no external dependencies, using
911 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
912 images, and videos. Implies `--standalone`. The resulting file should be
913 "self-contained," in the sense that it needs no external files and no net
914 access to be displayed properly by a browser. This option works only with
915 HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
916 `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
917 and stylesheets at absolute URLs will be downloaded; those at relative
918 URLs will be sought relative to the working directory (if the first source
919 file is local) or relative to the base URL (if the first source
920 file is remote). Elements with the attribute
921 `data-external="1"` will be left alone; the documents they
922 link to will not be incorporated in the document.
923 Limitation: resources that are loaded dynamically through
924 JavaScript cannot be incorporated; as a result,
925 `--self-contained` does not work with `--mathjax`, and some
926 advanced features (e.g. zoom or speaker notes) may not work
927 in an offline "self-contained" `reveal.js` slide show.
931: Use `<q>` tags for quotes in HTML.
935: Use only ASCII characters in output. Currently supported for XML
936 and HTML formats (which use entities instead of UTF-8 when this
937 option is selected), CommonMark, gfm, and Markdown (which use
938 entities), roff ms (which use hexadecimal escapes), and to a
939 limited degree LaTeX (which uses standard commands for accented
940 characters when possible). roff man output uses ASCII by default.
944: Use reference-style links, rather than inline links, in writing Markdown
945 or reStructuredText. By default inline links are used. The
946 placement of link references is affected by the
947 `--reference-location` option.
949`--reference-location = block`|`section`|`document`
951: Specify whether footnotes (and references, if `reference-links` is
952 set) are placed at the end of the current (top-level) block, the
953 current section, or the document. The default is
954 `document`. Currently only affects the markdown writer.
958: Use ATX-style headings in Markdown output. The default is
959 to use setext-style headings for levels 1 to 2, and then ATX headings.
960 (Note: for `gfm` output, ATX headings are always used.)
961 This option also affects markdown cells in `ipynb` output.
963`--top-level-division=[default|section|chapter|part]`
965: Treat top-level headings as the given division type in LaTeX, ConTeXt,
966 DocBook, and TEI output. The hierarchy order is part, chapter, then section;
967 all headings are shifted such that the top-level heading becomes the specified
968 type. The default behavior is to determine the best division type via
969 heuristics: unless other conditions apply, `section` is chosen. When the
970 `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
971 `article` option is specified), `chapter` is implied as the setting for this
972 option. If `beamer` is the output format, specifying either `chapter` or
973 `part` will cause top-level headings to become `\part{..}`, while
974 second-level headings remain as their default type.
976`-N`, `--number-sections`
978: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
979 By default, sections are not numbered. Sections with class
980 `unnumbered` will never be numbered, even if `--number-sections`
983`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
985: Offset for section headings in HTML output (ignored in other
986 output formats). The first number is added to the section number for
987 top-level headings, the second for second-level headings, and so on.
988 So, for example, if you want the first top-level heading in your
989 document to be numbered "6", specify `--number-offset=5`.
990 If your document starts with a level-2 heading which you want to
991 be numbered "1.5", specify `--number-offset=1,4`.
992 Offsets are 0 by default. Implies `--number-sections`.
996: Use the [`listings`] package for LaTeX code blocks. The package
997 does not support multi-byte encoding for source code. To handle UTF-8
998 you would need to use a custom template. This issue is fully
999 documented here: [Encoding issue with the listings package].
1001`-i`, `--incremental`
1003: Make list items in slide shows display incrementally (one by one).
1004 The default is for lists to be displayed all at once.
1006`--slide-level=`*NUMBER*
1008: Specifies that headings with the specified level create
1009 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
1010 above this level in the hierarchy are used to divide the
1011 slide show into sections; headings below this level create
1012 subheads within a slide. Note that content that is
1013 not contained under slide-level headings will not appear in
1014 the slide show. The default is to set the slide level based
1015 on the contents of the document; see [Structuring the slide
1020: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1021 and attach identifiers to the enclosing `<section>` (or `<div>`)
1022 rather than the heading itself. See
1023 [Heading identifiers], below.
1025`--email-obfuscation=none`|`javascript`|`references`
1027: Specify a method for obfuscating `mailto:` links in HTML documents.
1028 `none` leaves `mailto:` links as they are. `javascript` obfuscates
1029 them using JavaScript. `references` obfuscates them by printing their
1030 letters as decimal or hexadecimal character references. The default
1033`--id-prefix=`*STRING*
1035: Specify a prefix to be added to all identifiers and internal links
1036 in HTML and DocBook output, and to footnote numbers in Markdown
1037 and Haddock output. This is useful for preventing duplicate
1038 identifiers when generating fragments to be included in other pages.
1040`-T` *STRING*, `--title-prefix=`*STRING*
1042: Specify *STRING* as a prefix at the beginning of the title
1043 that appears in the HTML header (but not in the title as it
1044 appears at the beginning of the HTML body). Implies `--standalone`.
1046`-c` *URL*, `--css=`*URL*
1048: Link to a CSS style sheet. This option can be used repeatedly to
1049 include multiple files. They will be included in the order specified.
1051 A stylesheet is required for generating EPUB. If none is
1052 provided using this option (or the `css` or `stylesheet`
1053 metadata fields), pandoc will look for a file `epub.css` in the
1054 user data directory (see `--data-dir`). If it is not
1055 found there, sensible defaults will be used.
1057`--reference-doc=`*FILE*
1059: Use the specified file as a style reference in producing a
1064 : For best results, the reference docx should be a modified
1065 version of a docx file produced using pandoc. The contents
1066 of the reference docx are ignored, but its stylesheets and
1067 document properties (including margins, page size, header,
1068 and footer) are used in the new docx. If no reference docx
1069 is specified on the command line, pandoc will look for a
1070 file `reference.docx` in the user data directory (see
1071 `--data-dir`). If this is not found either, sensible
1072 defaults will be used.
1074 To produce a custom `reference.docx`, first get a copy of
1075 the default `reference.docx`: `pandoc
1076 -o custom-reference.docx --print-default-data-file reference.docx`.
1077 Then open `custom-reference.docx` in Word, modify the
1078 styles as you wish, and save the file. For best
1079 results, do not make changes to this file other than
1080 modifying the styles used by pandoc:
1116 - Default Paragraph Font
1119 - Footnote Reference
1128 : For best results, the reference ODT should be a modified
1129 version of an ODT produced using pandoc. The contents of
1130 the reference ODT are ignored, but its stylesheets are used
1131 in the new ODT. If no reference ODT is specified on the
1132 command line, pandoc will look for a file `reference.odt` in
1133 the user data directory (see `--data-dir`). If this is not
1134 found either, sensible defaults will be used.
1136 To produce a custom `reference.odt`, first get a copy of
1137 the default `reference.odt`: `pandoc
1138 -o custom-reference.odt --print-default-data-file reference.odt`.
1139 Then open `custom-reference.odt` in LibreOffice, modify
1140 the styles as you wish, and save the file.
1144 : Templates included with Microsoft PowerPoint 2013 (either with
1145 `.pptx` or `.potx` extension) are known to work, as are most
1146 templates derived from these.
1148 The specific requirement is that the template should begin with
1149 the following first four layouts:
1152 2. Title and Content
1156 All templates included with a recent version of MS PowerPoint
1157 will fit these criteria. (You can click on `Layout` under the
1158 `Home` menu to check.)
1160 You can also modify the default `reference.pptx`: first run
1161 `pandoc -o custom-reference.pptx --print-default-data-file
1162 reference.pptx`, and then modify `custom-reference.pptx`
1163 in MS PowerPoint (pandoc will use the first four layout
1164 slides, as mentioned above).
1166`--epub-cover-image=`*FILE*
1168: Use the specified image as the EPUB cover. It is recommended
1169 that the image be less than 1000px in width and height. Note that
1170 in a Markdown source document you can also specify `cover-image`
1171 in a YAML metadata block (see [EPUB Metadata], below).
1173`--epub-metadata=`*FILE*
1175: Look in the specified XML file for metadata for the EPUB.
1176 The file should contain a series of [Dublin Core elements].
1179 <dc:rights>Creative Commons</dc:rights>
1180 <dc:language>es-AR</dc:language>
1182 By default, pandoc will include the following metadata elements:
1183 `<dc:title>` (from the document title), `<dc:creator>` (from the
1184 document authors), `<dc:date>` (from the document date, which should
1185 be in [ISO 8601 format]), `<dc:language>` (from the `lang`
1186 variable, or, if is not set, the locale), and `<dc:identifier
1187 id="BookId">` (a randomly generated UUID). Any of these may be
1188 overridden by elements in the metadata file.
1190 Note: if the source document is Markdown, a YAML metadata block
1191 in the document can be used instead. See below under
1194`--epub-embed-font=`*FILE*
1196: Embed the specified font in the EPUB. This option can be repeated
1197 to embed multiple fonts. Wildcards can also be used: for example,
1198 `DejaVuSans-*.ttf`. However, if you use wildcards on the command
1199 line, be sure to escape them or put the whole filename in single quotes,
1200 to prevent them from being interpreted by the shell. To use the
1201 embedded fonts, you will need to add declarations like the following
1202 to your CSS (see `--css`):
1205 font-family: DejaVuSans;
1207 font-weight: normal;
1208 src:url("DejaVuSans-Regular.ttf");
1211 font-family: DejaVuSans;
1214 src:url("DejaVuSans-Bold.ttf");
1217 font-family: DejaVuSans;
1219 font-weight: normal;
1220 src:url("DejaVuSans-Oblique.ttf");
1223 font-family: DejaVuSans;
1226 src:url("DejaVuSans-BoldOblique.ttf");
1228 body { font-family: "DejaVuSans"; }
1230`--epub-chapter-level=`*NUMBER*
1232: Specify the heading level at which to split the EPUB into separate
1233 "chapter" files. The default is to split into chapters at level-1
1234 headings. This option only affects the internal composition of the
1235 EPUB, not the way chapters and sections are displayed to users. Some
1236 readers may be slow if the chapter files are too large, so for large
1237 documents with few level-1 headings, one might want to use a chapter
1240`--epub-subdirectory=`*DIRNAME*
1242: Specify the subdirectory in the OCF container that is to hold
1243 the EPUB-specific contents. The default is `EPUB`. To put
1244 the EPUB contents in the top level, use an empty string.
1246`--ipynb-output=all|none|best`
1248: Determines how ipynb output cells are treated. `all` means
1249 that all of the data formats included in the original are
1250 preserved. `none` means that the contents of data cells
1251 are omitted. `best` causes pandoc to try to pick the
1252 richest data block in each output cell that is compatible
1253 with the output format. The default is `best`.
1255`--pdf-engine=`*PROGRAM*
1257: Use the specified engine when producing PDF output.
1258 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1259 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1260 and `pdfroff`. If the engine is not in your PATH, the full
1261 path of the engine may be specified here. If this option
1262 is not specified, pandoc uses the following defaults
1263 depending on the output format specified using `-t/--to`:
1265 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1266 `tectonic`, `latexmk`)
1267 - `-t context`: `context`
1268 - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`)
1269 - `-t ms`: `pdfroff`
1271`--pdf-engine-opt=`*STRING*
1273: Use the given string as a command-line argument to the `pdf-engine`.
1274 For example, to use a persistent directory `foo` for `latexmk`'s
1275 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1276 Note that no check for duplicate options is done.
1278[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1279[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1280[Encoding issue with the listings package]:
1281 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1283## Citation rendering {.options}
1285`--bibliography=`*FILE*
1287: Set the `bibliography` field in the document's metadata to *FILE*,
1288 overriding any value set in the metadata, and process citations
1289 using `pandoc-citeproc`. (This is equivalent to
1290 `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1291 If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1292 used, making this equivalent to `--metadata bibliography=FILE`.
1293 If you supply this argument multiple times, each *FILE* will be added
1298: Set the `csl` field in the document's metadata to *FILE*,
1299 overriding any value set in the metadata. (This is equivalent to
1300 `--metadata csl=FILE`.)
1301 This option is only relevant with `pandoc-citeproc`.
1303`--citation-abbreviations=`*FILE*
1305: Set the `citation-abbreviations` field in the document's metadata to
1306 *FILE*, overriding any value set in the metadata. (This is equivalent to
1307 `--metadata citation-abbreviations=FILE`.)
1308 This option is only relevant with `pandoc-citeproc`.
1312: Use [`natbib`] for citations in LaTeX output. This option is not for use
1313 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1314 use in producing a LaTeX file that can be processed with [`bibtex`].
1318: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1319 with the `pandoc-citeproc` filter or with PDF output. It is intended for
1320 use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1322## Math rendering in HTML {.options}
1324The default is to render TeX math as far as possible using Unicode characters.
1325Formulas are put inside a `span` with `class="math"`, so that they may be styled
1326differently from the surrounding text if needed. However, this gives acceptable
1327results only for basic math, usually you will want to use `--mathjax` or another
1328of the following options.
1330`--mathjax`[`=`*URL*]
1332: Use [MathJax] to display embedded TeX math in HTML output.
1333 TeX math will be put between `\(...\)` (for inline math)
1334 or `\[...\]` (for display math) and wrapped in `<span>` tags
1335 with class `math`. Then the MathJax JavaScript will render it.
1336 The *URL* should point to the `MathJax.js` load script.
1337 If a *URL* is not provided, a link to the Cloudflare CDN will
1342: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1343 `html4` and `html5`). This is the default in `odt` output. Note that
1344 currently only Firefox and Safari (and select e-book readers) natively
1349: Convert TeX formulas to `<img>` tags that link to an external script
1350 that converts formulas to images. The formula will be URL-encoded
1351 and concatenated with the URL provided. For SVG images you can for
1352 example use `--webtex https://latex.codecogs.com/svg.latex?`.
1353 If no URL is specified, the CodeCogs URL generating PNGs
1354 will be used (`https://latex.codecogs.com/png.latex?`).
1355 Note: the `--webtex` option will affect Markdown output
1356 as well as HTML, which is useful if you're targeting a
1357 version of Markdown without native math support.
1361: Use [KaTeX] to display embedded TeX math in HTML output.
1362 The *URL* is the base URL for the KaTeX library. That directory
1363 should contain a `katex.min.js` and a `katex.min.css` file.
1364 If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1368: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1369 can then be processed by [GladTeX] to produce images of the typeset
1370 formulas and an HTML file with links to these images.
1371 So, the procedure is:
1373 pandoc -s --gladtex input.md -o myfile.htex
1374 gladtex -d myfile-images myfile.htex
1375 # produces myfile.html and images in myfile-images
1377[MathML]: https://www.w3.org/Math/
1378[MathJax]: https://www.mathjax.org
1379[KaTeX]: https://github.com/Khan/KaTeX
1380[GladTeX]: https://humenda.github.io/GladTeX/
1382## Options for wrapper scripts {.options}
1386: Print information about command-line arguments to *stdout*, then exit.
1387 This option is intended primarily for use in wrapper scripts.
1388 The first line of output contains the name of the output file specified
1389 with the `-o` option, or `-` (for *stdout*) if no output file was
1390 specified. The remaining lines contain the command-line arguments,
1391 one per line, in the order they appear. These do not include regular
1392 pandoc options and their arguments, but do include any options appearing
1393 after a `--` separator at the end of the line.
1397: Ignore command-line arguments (for use in wrapper scripts).
1398 Regular pandoc options are not ignored. Thus, for example,
1400 pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1404 pandoc -o foo.html -s
1408If pandoc completes successfully, it will return exit code 0.
1409Nonzero exit codes have the following meanings:
1412----- ------------------------------------
1413 3 PandocFailOnWarningError
1415 5 PandocTemplateError
1417 21 PandocUnknownReaderError
1418 22 PandocUnknownWriterError
1419 23 PandocUnsupportedExtensionError
1420 31 PandocEpubSubdirectoryError
1422 47 PandocPDFProgramNotFoundError
1424 62 PandocShouldNeverHappenError
1427 65 PandocParsecError
1428 66 PandocMakePDFError
1429 67 PandocSyntaxMapError
1430 83 PandocFilterError
1432 92 PandocUTF8DecodingError
1433 93 PandocIpynbDecodingError
1434 97 PandocCouldNotFindDataFileError
1435 99 PandocResourceNotFound
1436----- ------------------------------------
1440The `--defaults` option may be used to specify a package
1441of options. Here is a sample defaults file demonstrating all of
1442the fields that may be used:
1446# reader: may be used instead of from:
1448# writer: may be used instead of to:
1450# leave blank for output to stdout:
1452# leave blank for input from stdin, use [] for no input:
1456# or you may use input-file: with a single value
1460self-contained: false
1462# note that structured variables may be specified:
1469# metadata values specified here are parsed as literal
1470# string text, not markdown:
1477# or you may use metadata-file: with a single value
1479# Note that these take files, not their contents:
1480include-before-body: []
1481include-after-body: []
1482include-in-header: []
1485# filters will be assumed to be Lua filters if they have
1486# the .lua extension, and json filters otherwise. But
1487# the filter type can also be specified explicitly, as shown:
1498# ERROR, WARNING, or INFO
1502# citeproc, natbib, or biblatex
1503cite-method: citeproc
1504# part, chapter, section, or default:
1505top-level-division: chapter
1511# you may also use pdf-engine-opt: with a single option
1512# pdf-engine-opt: "-shell-escape"
1514# auto, preserve, or none
1519extract-media: mediadir
1521table-of-contents: true
1523number-sections: false
1524# a list of offsets at each heading level
1525number-offset: [0,0,0,0,0,0]
1526# toc: may also be used instead of table-of-contents:
1527shift-heading-level-by: 1
1529identifier-prefix: foo
1531strip-empty-paragraphs: true
1532# lf, crlf, or native
1534strip-comments: false
1535indented-code-classes: []
1537default-image-extension: ".jpg"
1539# either a style name of a style definition file:
1540highlight-style: pygments
1543# or you may use syntax-definition: with a single value
1546reference-doc: myref.docx
1548# method is plain, webtex, gladtex, mathml, mathjax, katex
1549# you may specify a url with webtex, mathjax, katex
1552 url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1553# none, references, or javascript
1554email-obfuscation: javascript
1562epub-subdirectory: EPUB
1563epub-metadata: meta.xml
1566epub-chapter-level: 1
1567epub-cover-image: cover.jpg
1569reference-links: true
1570# block, section, or document
1571reference-location: block
1574# accept, reject, or all
1575track-changes: accept
1584# A list of two-element lists
1586- ["User-Agent", "Mozilla/5.0"]
1588fail-if-warnings: false
1594Fields that are omitted will just have their regular
1595default values. So a defaults file can be as simple as
1602Default files can be placed in the `defaults` subdirectory of
1603the user data directory and used from any directory. For
1604example, one could create a file specifying defaults for writing
1605letters, save it as `letter.yaml` in the `defaults` subdirectory
1606of the user data directory, and then invoke these defaults
1607from any directory using `pandoc --defaults letter`
1608or `pandoc -dletter`.
1610When multiple defaults are used, their contents will be combined.
1612Note that, where command-line arguments may be repeated
1613(`--metadata-file`, `--css`, `--include-in-header`,
1614`--include-before-body`, `--include-after-body`, `--variable`,
1615`--metadata`, `--syntax-definition`), the values specified on
1616the command line will combine with values specified in the
1617defaults file, rather than replacing them.
1621When the `-s/--standalone` option is used, pandoc uses a template to
1622add header and footer material that is needed for a self-standing
1623document. To see the default template that is used, just type
1627where *FORMAT* is the name of the output format. A custom template
1628can be specified using the `--template` option. You can also override
1629the system default templates for a given output format *FORMAT*
1630by putting a file `templates/default.*FORMAT*` in the user data
1631directory (see `--data-dir`, above). *Exceptions:*
1633- For `odt` output, customize the `default.opendocument`
1635- For `pdf` output, customize the `default.latex` template
1636 (or the `default.context` template, if you use `-t context`,
1637 or the `default.ms` template, if you use `-t ms`, or the
1638 `default.html` template, if you use `-t html`).
1639- `docx` and `pptx` have no template (however, you can use
1640 `--reference-doc` to customize the output).
1642Templates contain *variables*, which allow for the inclusion of
1643arbitrary information at any point in the file. They may be set at the
1644command line using the `-V/--variable` option. If a variable is not set,
1645pandoc will look for the key in the document's metadata, which can be set
1646using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1647or with the `-M/--metadata` option. In addition, some variables
1648are given default values by pandoc. See [Variables] below for
1649a list of variables used in pandoc's default templates.
1651If you use custom templates, you may need to revise them as pandoc
1652changes. We recommend tracking the changes in the default templates,
1653and modifying your custom templates accordingly. An easy way to do this
1654is to fork the [pandoc-templates] repository and merge in
1655changes after each pandoc release.
1657 [pandoc-templates]: https://github.com/jgm/pandoc-templates
1663Anything between the sequence `$--` and the end of the
1664line will be treated as a comment and omitted from the output.
1668To mark variables and control structures in the template,
1669either `$`...`$` or `${`...`}` may be used as delimiters.
1670The styles may also be mixed in the same template, but the
1671opening and closing delimiter must match in each case. The
1672opening delimiter may be followed by one or more spaces
1673or tabs, which will be ignored. The closing delimiter may
1674be followed by one or more spaces or tabs, which will be
1677To include a literal `$` in the document, use `$$`.
1679### Interpolated variables
1681A slot for an interpolated variable is a variable name surrounded
1682by matched delimiters. Variable names must begin with a letter
1683and can contain letters, numbers, `_`, `-`, and `.`. The
1684keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1685not be used as variable names. Examples:
1698Variable names with periods are used to get at structured
1699variable values. So, for example, `employee.salary` will return the
1700value of the `salary` field of the object that is the value of
1701the `employee` field.
1703- If the value of the variable is simple value, it will be
1704 rendered verbatim. (Note that no escaping is done;
1705 the assumption is that the calling program will escape
1706 the strings appropriately for the output format.)
1707- If the value is a list, the values will be concatenated.
1708- If the value is a map, the string `true` will be rendered.
1709- Every other value will be rendered as the empty string.
1713A conditional begins with `if(variable)` (enclosed in
1714matched delimiters) and ends with `endif` (enclosed in matched
1715delimiters). It may optionally contain an `else` (enclosed in
1716matched delimiters). The `if` section is used if
1717`variable` has a non-empty value, otherwise the `else`
1718section is used (if present). Examples:
1733${if(foo)}bar${endif}
1746The keyword `elseif` may be used to simplify complex nested
1761A for loop begins with `for(variable)` (enclosed in
1762matched delimiters) and ends with `endfor` (enclosed in matched
1765- If `variable` is an array, the material inside the loop will
1766 be evaluated repeatedly, with `variable` being set to each
1767 value of the array in turn, and concatenated.
1768- If `variable` is a map, the material inside will be set to
1770- If the value of the associated variable is not an array or
1771 a map, a single iteration will be performed on its value.
1776$for(foo)$$foo$$sep$, $endfor$
1779 - $foo.last$, $foo.first$
1783 - ${ foo.bar.last }, ${ foo.bar.first }
1787$it.name$: $it.office$
1791You may optionally specify a separator between consecutive
1792values using `sep` (enclosed in matched delimiters). The
1793material between `sep` and the `endfor` is the separator.
1796${ for(foo) }${ foo }${ sep }, ${ endfor }
1799Instead of using `variable` inside the loop, the special
1800anaphoric keyword `it` may be used.
1804 - ${ it.last }, ${ it.first }
1810Partials (subtemplates stored in different files) may be
1811included using the syntax
1817Partials will be sought in the directory containing
1818the main template, and will be assumed to have the
1819same extension as the main template if they lack
1820an explicit extension. (If the partials are not
1821found here, they will also be sought in the `templates`
1822subdirectory of the user data directory.)
1824Partials may optionally be applied to variables using
1830${ articles:bibentry() }
1833If `articles` is an array, this will iterate over its
1834values, applying the partial `bibentry()` to each one. So the
1835second example above is equivalent to
1843Note that the anaphoric keyword `it` must be used when
1844iterating over partials. In the above examples,
1845the `bibentry` partial should contain `it.title`
1846(and so on) instead of `articles.title`.
1848Final newlines are omitted from included partials.
1850Partials may include other partials.
1852A separator between values of an array may be specified
1853in square brackets, immediately after the variable name
1859${articles:bibentry()[; ]$
1862The separator in this case is literal and (unlike with `sep`
1863in an explicit `for` loop) cannot contain interpolated
1864variables or other template directives.
1868To ensure that content is "nested," that is, subsequent lines
1869indented, use the `^` directive:
1872$item.number$ $^$$item.description$ ($item.price$)
1875In this example, if `item.description` has multiple lines,
1876they will all be indented to line up with the first line:
187900123 A fine bottle of 18-year old
1880 Oban whiskey. ($148)
1883To nest multiple lines to the same level, align them
1884with the `^` directive in the template. For example:
1887$item.number$ $^$$item.description$ ($item.price$)
1888 (Available til $item.sellby$.)
189400123 A fine bottle of 18-year old
1895 Oban whiskey. ($148)
1896 (Available til March 30, 2020.)
1899If a variable occurs by itself on a line, preceded by whitespace
1900and not followed by further text or directives on the same line,
1901and the variable's value contains multiple lines, it will be
1902nested automatically.
1906Normally, spaces in the template itself (as opposed to values of
1907the interpolated variables) are not breakable, but they can be
1908made breakable in part of the template by using the `~` keyword
1909(ended with another `~`).
1912$~$This long line may break if the document is rendered
1913with a short line length.$~$
1918A pipe transforms the value of a variable or partial. Pipes are
1919specified using a slash (`/`) between the variable name (or partial)
1920and the pipe name. Example:
1927$for(metadata/pairs)$
1928- $it.key$: $it.value$
1931$employee:name()/uppercase$
1934Pipes may be chained:
1937$for(employees/pairs)$
1938$it.key/alpha/uppercase$. $it.name$
1942Some pipes take parameters:
1945|----------------------|------------|
1947$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
1949|----------------------|------------|
1952Currently the following pipes are predefined:
1954- `pairs`: Converts a map or array to an array of maps,
1955 each with `key` and `value` fields. If the original
1956 value was an array, the `key` will be the array index,
1959- `uppercase`: Converts text to uppercase.
1961- `lowercase`: Converts text to lowercase.
1963- `length`: Returns the length of the value: number
1964 of characters for a textual value, number of elements
1967- `reverse`: Reverses a textual value or array,
1968 and has no effect on other values.
1970- `chomp`: Removes trailing newlines (and breakable space).
1972- `nowrap`: Disables line wrapping on breakable spaces.
1974- `alpha`: Converts textual values that can be
1975 read as an integer into lowercase alphabetic
1976 characters `a..z` (mod 26). This can be used to get lettered
1977 enumeration from array indices. To get uppercase
1978 letters, chain with `uppercase`.
1980- `roman`: Converts textual values that can be
1981 read as an integer into lowercase roman numerials.
1982 This can be used to get lettered enumeration from array indices.
1983 To get uppercase roman, chain with `uppercase`.
1985- `left n "leftborder" "rightborder"`: Renders a textual value
1986 in a block of width `n`, aligned to the left, with an optional
1987 left and right border. Has no effect on other values. This
1988 can be used to align material in tables. Widths are positive
1989 integers indicating the number of characters. Borders
1990 are strings inside double quotes; literal `"` and `\` characters
1991 must be backslash-escaped.
1993- `right n "leftborder" "rightborder"`: Renders a textual value
1994 in a block of width `n`, aligned to the right, and has no
1995 effect on other values.
1997- `center n "leftborder" "rightborder"`: Renders a textual
1998 value in a block of width `n`, aligned to the center, and has
1999 no effect on other values.
2004### Metadata variables
2006`title`, `author`, `date`
2007: allow identification of basic aspects of the document. Included
2008 in PDF metadata through LaTeX and ConTeXt. These can be set
2009 through a [pandoc title block][Extension: `pandoc_title_block`],
2010 which allows for multiple authors, or through a
2011 [YAML metadata block][Extension: `yaml_metadata_block`]:
2019 Note that if you just want to set PDF or HTML metadata, without
2020 including a title block in the document itself, you can
2021 set the `title-meta`, `author-meta`, and `date-meta`
2022 variables. (By default these are set automatically, based
2023 on `title`, `author`, and `date`.)
2026: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2030: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2034: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2035 and AsciiDoc metadata; repeat as for `author`, above
2038: document subject, included in ODT, PDF, docx and pptx metadata
2041: document description, included in ODT, docx and pptx metadata. Some
2042 applications show this as `Comments` metadata.
2045: document category, included in docx and pptx metadata
2048any root-level string metadata, not included in ODT, docx
2049or pptx metadata is added as a *custom property*.
2050The following [YAML] metadata block for instance:
2053 title: 'This is the title'
2054 subtitle: "This is the subtitle"
2062 It consists of two paragraphs
2065will include `title`, `author` and `description` as standard document
2066properties and `subtitle` as a custom property when converting to docx,
2069### Language variables
2072: identifies the main language of the document using IETF language
2073 tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2074 The [Language subtag lookup] tool can look up or verify these tags.
2075 This affects most formats, and controls hyphenation in PDF output
2076 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2078 Use native pandoc [Divs and Spans] with the `lang` attribute to
2079 switch the language:
2085 Text in the main document language (British English).
2088 > Cette citation est écrite en français canadien.
2091 More text in English. ['Zitat auf Deutsch.']{lang=de}
2094: the base script direction, either `rtl` (right-to-left)
2095 or `ltr` (left-to-right).
2097 For bidirectional documents, native pandoc `span`s and `div`s
2098 with the `dir` attribute (value `rtl` or `ltr`) can be used to
2099 override the base direction in some output formats.
2100 This may not always be necessary if the final renderer
2101 (e.g. the browser, when generating HTML) supports the
2102 [Unicode Bidirectional Algorithm].
2104 When using LaTeX for bidirectional documents, only the `xelatex` engine
2105 is fully supported (use `--pdf-engine=xelatex`).
2107[BCP 47]: https://tools.ietf.org/html/bcp47
2108[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2109[Language subtag lookup]: https://r12a.github.io/app-subtags/
2111### Variables for HTML math
2114: when using [KaTeX](#option--katex), you can render display math equations
2115 flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2117### Variables for HTML slides
2119These affect HTML output when [producing slide shows with pandoc].
2121All [reveal.js configuration options] are available as variables.
2122To turn off boolean flags that default to true in reveal.js, use `0`.
2125: base URL for reveal.js documents (defaults to `reveal.js`)
2128: base URL for S5 documents (defaults to `s5/default`)
2131: base URL for Slidy documents (defaults to
2132 `https://www.w3.org/Talks/Tools/Slidy2`)
2135: base URL for Slideous documents (defaults to `slideous`)
2137`title-slide-attributes`
2138: additional attributes for the title slide of reveal.js slide shows.
2139 See [background in reveal.js and beamer] for an example.
2141[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2143### Variables for Beamer slides
2145These variables change the appearance of PDF slides using [`beamer`].
2148: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2149 `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2153: produce an article from Beamer slides
2156: add extra beamer option with `\setbeameroption{}`
2159: author affiliations: can be a list when there are multiple authors
2162: logo image for slides
2165: controls navigation symbols (default is `empty` for no navigation
2166 symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2169: enables "title pages" for new sections (default is true)
2171`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2175: options for LaTeX beamer themes (a list).
2178: image for title slide
2180### Variables for PowerPoint
2182These variables control the visual aspects of a slide show that
2183are not easily controlled via templates.
2186: font to use for code.
2188### Variables for LaTeX
2190Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2195: make `\paragraph` and `\subparagraph` (fourth- and
2196 fifth-level headings, or fifth- and sixth-level with book
2197 classes) free-standing rather than run-in; requires further
2198 formatting to distinguish from `\subsubsection` (third- or
2199 fourth-level headings). Instead of using this option,
2200 [KOMA-Script] can adjust headings more extensively:
2203 documentclass: scrartcl
2205 \RedeclareSectionCommand[
2206 beforeskip=-10pt plus -2pt minus -1pt,
2207 afterskip=1sp plus -1sp minus 1sp,
2208 font=\normalfont\itshape]{paragraph}
2209 \RedeclareSectionCommand[
2210 beforeskip=-10pt plus -2pt minus -1pt,
2211 afterskip=1sp plus -1sp minus 1sp,
2212 font=\normalfont\scshape,
2213 indent=0pt]{subparagraph}
2217: option for document class, e.g. `oneside`; repeat for multiple options:
2226: document class: usually one of the standard classes, [`article`], [`book`],
2227 and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2228 and `scrreprt`, which default to smaller margins; or [`memoir`]
2231: option for [`geometry`] package, e.g. `margin=1in`;
2232 repeat for multiple options:
2242: option for [`hyperref`] package, e.g. `linktoc=all`;
2243 repeat for multiple options:
2249 - pdfpagemode=FullScreen
2253: uses document class settings for indentation (the default LaTeX template
2254 otherwise removes indentation and adds space between paragraphs)
2257: adjusts line spacing using the [`setspace`]
2258 package, e.g. `1.25`, `1.5`
2260`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2261: sets margins if `geometry` is not used (otherwise `geometry`
2265: control `\pagestyle{}`: the default article class
2266 supports `plain` (default), `empty` (no running heads or page numbers),
2267 and `headings` (section titles in running heads)
2270: paper size, e.g. `letter`, `a4`
2273: numbering depth for sections (with `--number-sections` option
2274 or `numbersections` variable)
2279: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2280 default is `T1` (see [LaTeX font encodings guide])
2283: font package for use with `pdflatex`:
2284 [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2285 The default is [Latin Modern][`lm`].
2288: options for package used as `fontfamily`; repeat for multiple options.
2289 For example, to use the Libertine font with proportional lowercase
2290 (old-style) figures through the [`libertinus`] package:
2293 fontfamily: libertinus
2300: font size for body text. The standard classes allow 10pt, 11pt, and
2301 12pt. To use another size, set `documentclass` to one of
2302 the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2304`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2305: font families for use with `xelatex` or
2306 `lualatex`: take the name of any system font, using the
2307 [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2309`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2310: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2311 `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2312 choices available through [`fontspec`]; repeat for multiple
2313 options. For example, to use the [TeX Gyre] version of
2314 Palatino with lowercase figures:
2317 mainfont: TeX Gyre Pagella
2320 - Numbers=Proportional
2324: options to pass to the microtype package
2329: add color to link text; automatically enabled if any of
2330 `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2332`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2333: color for internal links, external links, citation links, linked
2334 URLs, and links in table of contents, respectively: uses options
2335 allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2339: causes links to be printed as footnotes
2344: include list of figures, list of tables
2347: contents of acknowledgments footnote after document title
2350: include table of contents (can also be set using `--toc/--table-of-contents`)
2353: level of section to include in table of contents
2355#### BibLaTeX Bibliographies
2357These variables function when using BibLaTeX for [citation rendering].
2360: list of options for biblatex
2363: bibliography style, when used with `--natbib` and `--biblatex`.
2366: bibliography title, when used with `--natbib` and `--biblatex`.
2369: bibliography to use for resolving references
2372: list of options for natbib
2374[KOMA-Script]: https://ctan.org/pkg/koma-script
2375[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2376[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2377[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2378[`article`]: https://ctan.org/pkg/article
2379[`book`]: https://ctan.org/pkg/book
2380[`libertinus`]: https://ctan.org/pkg/libertinus
2381[`memoir`]: https://ctan.org/pkg/memoir
2382[`report`]: https://ctan.org/pkg/report
2384### Variables for ConTeXt
2386Pandoc uses these variables when [creating a PDF] with ConTeXt.
2389: font size for body text (e.g. `10pt`, `12pt`)
2391`headertext`, `footertext`
2392: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2393 repeat up to four times for different placement
2396: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2397 repeat for multiple options
2400: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2401 repeat for multiple options
2404: options for page margins and text arrangement (see [ConTeXt Layout]);
2405 repeat for multiple options
2407`linkcolor`, `contrastcolor`
2408: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2411: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2414: include list of figures, list of tables
2416`mainfont`, `sansfont`, `monofont`, `mathfont`
2417: font families: take the name of any system font (see [ConTeXt Font Switching])
2419`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2420: sets margins, if `layout` is not used (otherwise `layout`
2424: page number style and location (using [`setuppagenumbering`]);
2425 repeat for multiple options
2428: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2429 repeat for multiple options
2432: adds to the preamble the setup necessary to generate PDF/A of the type
2433 specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2434 is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2435 block), `1b:2005` will be used as default, for reasons of backwards
2436 compatibility. Using `--variable=pdfa` without specified value is not supported.
2437 To successfully generate PDF/A the required ICC color profiles have to
2438 be available and the content and all included files (such as images)
2439 have to be standard conforming. The ICC profiles and output intent
2440 may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2441 See also [ConTeXt PDFA] for more details.
2444: when used in conjunction with `pdfa`, specifies the ICC profile to use
2445 in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2446 used as default. May be repeated to include multiple profiles. Note that
2447 the profiles have to be available on the system. They can be obtained
2448 from [ConTeXt ICC Profiles].
2451: when used in conjunction with `pdfa`, specifies the output intent for
2452 the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2453 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2456: include table of contents (can also be set using `--toc/--table-of-contents`)
2459: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2462: include all source documents as file attachments in the PDF file
2464[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2465[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2466[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2467[ConTeXt Color]: https://wiki.contextgarden.net/Color
2468[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2469[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2470[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2471[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2472[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2473[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2474[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2476### Variables for `wkhtmltopdf`
2478Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2479The `--css` option also affects the output.
2481`footer-html`, `header-html`
2482: add information to the header and footer
2484`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2485: set the page margins
2488: sets the PDF paper size
2490### Variables for man pages
2493: adjusts text to left (`l`), right (`r`), center (`c`),
2494 or both (`b`) margins
2497: footer in man pages
2500: header in man pages
2503: if `true` (the default), hyphenation will be used
2506: section number in man pages
2511: font family (e.g. `T` or `P`)
2514: paragraph indent (e.g. `2m`)
2517: line height (e.g. `12p`)
2520: point size (e.g. `10p`)
2522### Variables set automatically
2524Pandoc sets these variables automatically in response to [options] or
2525document contents; users can also modify them. These vary depending
2526on the output format, and include the following:
2532: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2533 included in all HTML based formats (dzslides, epub,
2534 html, html4, html5, revealjs, s5, slideous, slidy).
2535 The recognized formats for `date` are: `mm/dd/yyyy`,
2536 `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2537 (e.g. either `02 Apr 2018` or `02 April 2018`),
2538 `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2539 `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2542: contents specified by `-H/--include-in-header` (may have multiple
2546: contents specified by `-B/--include-before-body` (may have
2550: contents specified by `-A/--include-after-body` (may have
2554: JSON representation of all of the document's metadata. Field
2555 values are transformed to the selected output format.
2558: non-null value if `-N/--number-sections` was specified
2560`sourcefile`, `outputfile`
2561: source and destination filenames, as given on the command line.
2562 `sourcefile` can also be a list if input comes from multiple files,
2563 or empty if input is from stdin. You can use the following snippet in
2564 your template to distinguish them:
2574 Similarly, `outputfile` can be `-` if output goes to the terminal.
2576 If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2579: working directory from which pandoc is run.
2582: non-null value if `--toc/--table-of-contents` was specified
2585: title of table of contents (works only with EPUB,
2586 HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2588[pandoc-templates]: https://github.com/jgm/pandoc-templates
2592The behavior of some of the readers and writers can be adjusted by
2593enabling or disabling various extensions.
2595An extension can be enabled by adding `+EXTENSION`
2596to the format name and disabled by adding `-EXTENSION`. For example,
2597`--from markdown_strict+footnotes` is strict Markdown with footnotes
2598enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2599Markdown without footnotes or pipe tables.
2601The markdown reader and writer make by far the most use of extensions.
2602Extensions only used by them are therefore covered in the
2603section [Pandoc's Markdown] below (See [Markdown variants] for
2604`commonmark` and `gfm`.) In the following, extensions that also work
2605for other formats are covered.
2607Note that markdown extensions added to the `ipynb` format
2608affect Markdown cells in Jupyter notebooks (as do command-line
2609options like `--atx-headers`).
2613#### Extension: `smart` ####
2615Interpret straight quotes as curly quotes, `---` as em-dashes,
2616`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2617inserted after certain abbreviations, such as "Mr."
2619This extension can be enabled/disabled for the following formats:
2622: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2625: `markdown`, `latex`, `context`, `rst`
2627enabled by default in
2628: `markdown`, `latex`, `context` (both input and output)
2630Note: If you are *writing* Markdown, then the `smart` extension
2631has the reverse effect: what would have been curly quotes comes
2634In LaTeX, `smart` means to use the standard TeX ligatures
2635for quotation marks (` `` ` and ` '' ` for double quotes,
2636`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2637en-dash and `---` for em-dash). If `smart` is disabled,
2638then in reading LaTeX pandoc will parse these characters
2639literally. In writing LaTeX, enabling `smart` tells pandoc
2640to use the ligatures when possible; if `smart` is disabled
2641pandoc will use unicode quotation mark and dash characters.
2643## Headings and sections
2645#### Extension: `auto_identifiers` ####
2647A heading without an explicitly specified identifier will be
2648automatically assigned a unique identifier based on the heading text.
2650This extension can be enabled/disabled for the following formats:
2653: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2658enabled by default in
2661The default algorithm used to derive the identifier from the
2664 - Remove all formatting, links, etc.
2665 - Remove all footnotes.
2666 - Remove all non-alphanumeric characters,
2667 except underscores, hyphens, and periods.
2668 - Replace all spaces and newlines with hyphens.
2669 - Convert all alphabetic characters to lowercase.
2670 - Remove everything up to the first letter (identifiers may
2671 not begin with a number or punctuation mark).
2672 - If nothing is left after this, use the identifier `section`.
2677 ------------------------------- ----------------------------
2678 `Heading identifiers in HTML` `heading-identifiers-in-html`
2679 `Maître d'hôtel` `maître-dhôtel`
2680 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2681 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2682 `3. Applications` `applications`
2685These rules should, in most cases, allow one to determine the identifier
2686from the heading text. The exception is when several headings have the
2687same text; in this case, the first will get an identifier as described
2688above; the second will get the same identifier with `-1` appended; the
2689third with `-2`; and so on.
2691(However, a different algorithm is used if
2692`gfm_auto_identifiers` is enabled; see below.)
2694These identifiers are used to provide link targets in the table of
2695contents generated by the `--toc|--table-of-contents` option. They
2696also make it easy to provide links from one section of a document to
2697another. A link to this section, for example, might look like this:
2700 [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2702Note, however, that this method of providing links to sections works
2703only in HTML, LaTeX, and ConTeXt formats.
2705If the `--section-divs` option is specified, then each section will
2706be wrapped in a `section` (or a `div`, if `html4` was specified),
2707and the identifier will be attached to the enclosing `<section>`
2708(or `<div>`) tag rather than the heading itself. This allows entire
2709sections to be manipulated using JavaScript or treated differently in
2712#### Extension: `ascii_identifiers` ####
2714Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2715Accents are stripped off of accented Latin letters, and non-Latin
2718#### Extension: `gfm_auto_identifiers` ####
2720Changes the algorithm used by `auto_identifiers` to conform to
2721GitHub's method. Spaces are converted to dashes (`-`),
2722uppercase characters to lowercase characters, and punctuation
2723characters other than `-` and `_` are removed.
2724Emojis are replaced by their names.
2728The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2729[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2730[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2731are described in the section about Pandoc's Markdown.
2733However, they can also be used with HTML input. This is handy for
2734reading web pages formatted using MathJax, for example.
2738The following extensions (especially how they affect Markdown
2739input/output) are also described in more detail in their respective
2740sections of [Pandoc's Markdown].
2742#### Extension: `raw_html` {#raw_html}
2744When converting from HTML, parse elements to raw HTML which are not
2745representable in pandoc's AST.
2746By default, this is disabled for HTML input.
2748#### Extension: `raw_tex` {#raw_tex}
2750Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2752This extension can be enabled/disabled for the following formats
2753(in addition to `markdown`):
2756: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2757 `\eqref` only), `ipynb`
2760: `textile`, `commonmark`
2762Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2763only raw TeX in markdown cells, but data with mime type
2764`text/html` in output cells. Since the `ipynb` reader attempts
2765to preserve the richest possible outputs when several options
2766are given, you will get best results if you disable `raw_html`
2767and `raw_tex` when converting to formats like `docx` which don't
2768allow raw `html` or `tex`.
2770#### Extension: `native_divs` {#native_divs}
2772This extension is enabled by default for HTML input. This means that
2773`div`s are parsed to pandoc native elements. (Alternatively, you
2774can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2776When converting HTML to Markdown, for example, you may want to drop all
2779 pandoc -f html-native_divs-native_spans -t markdown
2781#### Extension: `native_spans` {#native_spans}
2783Analogous to `native_divs` above.
2786## Literate Haskell support
2788#### Extension: `literate_haskell` ####
2790Treat the document as literate Haskell source.
2792This extension can be enabled/disabled for the following formats:
2795: `markdown`, `rst`, `latex`
2798: `markdown`, `rst`, `latex`, `html`
2800If you append `+lhs` (or `+literate_haskell`) to one of the formats
2801above, pandoc will treat the document as literate Haskell source.
2804 - In Markdown input, "bird track" sections will be parsed as Haskell
2805 code rather than block quotations. Text between `\begin{code}`
2806 and `\end{code}` will also be treated as Haskell code. For
2807 ATX-style headings the character '=' will be used instead of '#'.
2809 - In Markdown output, code blocks with classes `haskell` and `literate`
2810 will be rendered using bird tracks, and block quotations will be
2811 indented one space, so they will not be treated as Haskell code.
2812 In addition, headings will be rendered setext-style (with underlines)
2813 rather than ATX-style (with '#' characters). (This is because ghc
2814 treats '#' characters in column 1 as introducing line numbers.)
2816 - In restructured text input, "bird track" sections will be parsed
2819 - In restructured text output, code blocks with class `haskell` will
2820 be rendered using bird tracks.
2822 - In LaTeX input, text in `code` environments will be parsed as
2825 - In LaTeX output, code blocks with class `haskell` will be rendered
2826 inside `code` environments.
2828 - In HTML output, code blocks with class `haskell` will be rendered
2829 with class `literatehaskell` and bird tracks.
2833 pandoc -f markdown+lhs -t html
2835reads literate Haskell source formatted with Markdown conventions and writes
2836ordinary HTML (without bird tracks).
2838 pandoc -f markdown+lhs -t html+lhs
2840writes HTML with the Haskell code in bird tracks, so it can be copied
2841and pasted as literate Haskell source.
2843Note that GHC expects the bird tracks in the first column, so indented
2844literate code blocks (e.g. inside an itemized environment) will not be
2845picked up by the Haskell compiler.
2849#### Extension: `empty_paragraphs` ####
2851Allows empty paragraphs. By default empty paragraphs are
2854This extension can be enabled/disabled for the following formats:
2860: `docx`, `odt`, `opendocument`, `html`
2862#### Extension: `native_numbering` ####
2864Enables native numbering of figures and tables. Enumeration
2867This extension can be enabled/disabled for the following formats:
2870: `odt`, `opendocument`
2872#### Extension: `styles` #### {#ext-styles}
2874When converting from docx, read all docx styles as divs (for
2875paragraph styles) and spans (for character styles) regardless
2876of whether pandoc understands the meaning of these styles.
2877This can be used with [docx custom styles](#custom-styles).
2883#### Extension: `amuse` ####
2885In the `muse` input format, this enables Text::Amuse
2886extensions to Emacs Muse markup.
2888#### Extension: `citations` {#org-citations}
2890Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2893#### Extension: `ntb` ####
2895In the `context` output format this enables the use of [Natural Tables
2896(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2897[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2898Natural tables allow more fine-grained global customization but come
2899at a performance penalty compared to extreme tables.
2904Pandoc understands an extended and slightly revised version of
2905John Gruber's [Markdown] syntax. This document explains the syntax,
2906noting differences from standard Markdown. Except where noted, these
2907differences can be suppressed by using the `markdown_strict` format instead
2908of `markdown`. Extensions can be enabled or disabled to specify the
2909behavior more granularly. They are described in the following. See also
2910[Extensions] above, for extensions that work also on other formats.
2914Markdown is designed to be easy to write, and, even more importantly,
2917> A Markdown-formatted document should be publishable as-is, as plain
2918> text, without looking like it's been marked up with tags or formatting
2920> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2922This principle has guided pandoc's decisions in finding syntax for
2923tables, footnotes, and other extensions.
2925There is, however, one respect in which pandoc's aims are different
2926from the original aims of Markdown. Whereas Markdown was originally
2927designed with HTML generation in mind, pandoc is designed for multiple
2928output formats. Thus, while pandoc allows the embedding of raw HTML,
2929it discourages it, and provides other, non-HTMLish ways of representing
2930important document elements like definition lists, tables, mathematics, and
2935A paragraph is one or more lines of text followed by one or more blank lines.
2936Newlines are treated as spaces, so you can reflow your paragraphs as you like.
2937If you need a hard line break, put two or more spaces at the end of a line.
2939#### Extension: `escaped_line_breaks` ####
2941A backslash followed by a newline is also a hard line break.
2942Note: in multiline and grid table cells, this is the only way
2943to create a hard line break, since trailing spaces in the cells
2948There are two kinds of headings: Setext and ATX.
2950### Setext-style headings ###
2952A setext-style heading is a line of text "underlined" with a row of `=` signs
2953(for a level-one heading) or `-` signs (for a level-two heading):
2961The heading text can contain inline formatting, such as emphasis (see
2962[Inline formatting], below).
2965### ATX-style headings ###
2967An ATX-style heading consists of one to six `#` signs and a line of
2968text, optionally followed by any number of `#` signs. The number of
2969`#` signs at the beginning of the line is the heading level:
2971 ## A level-two heading
2973 ### A level-three heading ###
2975As with setext-style headings, the heading text can contain formatting:
2977 # A level-one heading with a [link](/url) and *emphasis*
2979#### Extension: `blank_before_header` ####
2981Standard Markdown syntax does not require a blank line before a heading.
2982Pandoc does require this (except, of course, at the beginning of the
2983document). The reason for the requirement is that it is all too easy for a
2984`#` to end up at the beginning of a line by accident (perhaps through line
2985wrapping). Consider, for example:
2987 I like several of their flavors of ice cream:
2988 #22, for example, and #5.
2990#### Extension: `space_in_atx_header` ####
2992Many Markdown implementations do not require a space between the
2993opening `#`s of an ATX heading and the heading text, so that
2994`#5 bolt` and `#hashtag` count as headings. With this extension,
2995pandoc does require the space.
2997### Heading identifiers ###
2999See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3001#### Extension: `header_attributes` ####
3003Headings can be assigned attributes using this syntax at the end
3004of the line containing the heading text:
3006 {#identifier .class .class key=value key=value}
3008Thus, for example, the following headings will all be assigned the identifier
3013 ## My heading ## {#foo}
3015 My other heading {#foo}
3018(This syntax is compatible with [PHP Markdown Extra].)
3020Note that although this syntax allows assignment of classes and key/value
3021attributes, writers generally don't use all of this information. Identifiers,
3022classes, and key/value attributes are used in HTML and HTML-based formats such
3023as EPUB and slidy. Identifiers are used for labels and link anchors in the
3024LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3026Headings with the class `unnumbered` will not be numbered, even if
3027`--number-sections` is specified. A single hyphen (`-`) in an attribute
3028context is equivalent to `.unnumbered`, and preferable in non-English
3035 # My heading {.unnumbered}
3037If the `unlisted` class is present in addition to `unnumbered`,
3038the heading will not be included in a table of contents.
3039(Currently this feature is only implemented for certain
3040formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3042#### Extension: `implicit_header_references` ####
3044Pandoc behaves as if reference links have been defined for each heading.
3045So, to link to a heading
3047 # Heading identifiers in HTML
3051 [Heading identifiers in HTML]
3055 [Heading identifiers in HTML][]
3059 [the section on heading identifiers][heading identifiers in
3062instead of giving the identifier explicitly:
3064 [Heading identifiers in HTML](#heading-identifiers-in-html)
3066If there are multiple headings with identical text, the corresponding
3067reference will link to the first one only, and you will need to use explicit
3068links to link to the others, as described above.
3070Like regular reference links, these references are case-insensitive.
3072Explicit link reference definitions always take priority over
3073implicit heading references. So, in the following example, the
3074link will point to `bar`, not to `#foo`:
3084Markdown uses email conventions for quoting blocks of text.
3085A block quotation is one or more paragraphs or other block elements
3086(such as lists or headings), with each line preceded by a `>` character
3087and an optional space. (The `>` need not start at the left margin, but
3088it should not be indented more than three spaces.)
3090 > This is a block quote. This
3091 > paragraph has two lines.
3093 > 1. This is a list inside a block quote.
3096A "lazy" form, which requires the `>` character only on the first
3097line of each block, is also allowed:
3099 > This is a block quote. This
3100 paragraph has two lines.
3102 > 1. This is a list inside a block quote.
3105Among the block elements that can be contained in a block quote are
3106other block quotes. That is, block quotes can be nested:
3108 > This is a block quote.
3110 > > A block quote within a block quote.
3112If the `>` character is followed by an optional space, that space
3113will be considered part of the block quote marker and not part of
3114the indentation of the contents. Thus, to put an indented code
3115block in a block quote, you need five spaces after the `>`:
3119#### Extension: `blank_before_blockquote` ####
3121Standard Markdown syntax does not require a blank line before a block
3122quote. Pandoc does require this (except, of course, at the beginning of the
3123document). The reason for the requirement is that it is all too easy for a
3124`>` to end up at the beginning of a line by accident (perhaps through line
3125wrapping). So, unless the `markdown_strict` format is used, the following does
3126not produce a nested block quote in pandoc:
3128 > This is a block quote.
3132## Verbatim (code) blocks
3134### Indented code blocks ###
3136A block of text indented four spaces (or one tab) is treated as verbatim
3137text: that is, special characters do not trigger special formatting,
3138and all spaces and line breaks are preserved. For example,
3141 moveShip(5 * gravity, DOWN);
3144The initial (four space or one tab) indentation is not considered part
3145of the verbatim text, and is removed in the output.
3147Note: blank lines in the verbatim text need not begin with four spaces.
3150### Fenced code blocks ###
3152#### Extension: `fenced_code_blocks` ####
3154In addition to standard indented code blocks, pandoc supports
3155*fenced* code blocks. These begin with a row of three or more
3156tildes (`~`) and end with a row of tildes that must be at least as long as
3157the starting row. Everything between these lines is treated as code. No
3158indentation is necessary:
3162 moveShip(5 * gravity, DOWN);
3166Like regular code blocks, fenced code blocks must be separated
3167from surrounding text by blank lines.
3169If the code itself contains a row of tildes or backticks, just use a longer
3170row of tildes or backticks at the start and end:
3174 code including tildes
3178#### Extension: `backtick_code_blocks` ####
3180Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3183#### Extension: `fenced_code_attributes` ####
3185Optionally, you may attach attributes to fenced or backtick code block using
3188 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3190 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3191 qsort (filter (>= x) xs)
3192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3194Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3195`startFrom` is an attribute with value `100`. Some output formats can use this
3196information to do syntax highlighting. Currently, the only output formats
3197that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3198highlighting is supported for your output format and language, then the code
3199block above will appear highlighted, with numbered lines. (To see which
3200languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3201the code block above will appear as follows:
3203 <pre id="mycode" class="haskell numberLines" startFrom="100">
3209The `numberLines` (or `number-lines`) class will cause the lines
3210of the code block to be numbered, starting with `1` or the value
3211of the `startFrom` attribute. The `lineAnchors` (or
3212`line-anchors`) class will cause the lines to be clickable
3213anchors in HTML output.
3215A shortcut form can also be used for specifying the language of
3222This is equivalent to:
3228If the `fenced_code_attributes` extension is disabled, but
3229input contains class attribute(s) for the code block, the first
3230class attribute will be printed after the opening fence as a bare
3233To prevent all highlighting, use the `--no-highlight` flag.
3234To set the highlighting style, use `--highlight-style`.
3235For more information on highlighting, see [Syntax highlighting],
3240#### Extension: `line_blocks` ####
3242A line block is a sequence of lines beginning with a vertical bar (`|`)
3243followed by a space. The division into lines will be preserved in
3244the output, as will any leading spaces; otherwise, the lines will
3245be formatted as Markdown. This is useful for verse and addresses:
3247 | The limerick packs laughs anatomical
3248 | In space that is quite economical.
3249 | But the good ones I've seen
3250 | So seldom are clean
3251 | And the clean ones so seldom are comical
3254 | Berkeley, CA 94718
3256The lines can be hard-wrapped if needed, but the continuation
3257line must begin with a space.
3259 | The Right Honorable Most Venerable and Righteous Samuel L.
3262 | Berkeley, CA 94718
3264This syntax is borrowed from [reStructuredText].
3270A bullet list is a list of bulleted list items. A bulleted list
3271item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3278This will produce a "compact" list. If you want a "loose" list, in which
3279each item is formatted as a paragraph, put spaces between the items:
3287The bullets need not be flush with the left margin; they may be
3288indented one, two, or three spaces. The bullet must be followed
3291List items look best if subsequent lines are flush with the first
3292line (after the bullet):
3298But Markdown also allows a "lazy" format:
3304### Block content in list items ###
3306A list item may contain multiple paragraphs and other block-level
3307content. However, subsequent paragraphs must be preceded by a blank line
3308and indented to line up with the first non-space content after
3315 * Second paragraph. With a code block, which must be indented
3320Exception: if the list marker is followed by an indented code
3321block, which must begin 5 spaces after the list marker, then
3322subsequent paragraphs must begin two columns after the last
3323character of the list marker:
3327 continuation paragraph
3329List items may include other lists. In this case the preceding blank
3330line is optional. The nested list must be indented to line up with
3331the first non-space character after the list marker of the
3332containing list item.
3344As noted above, Markdown allows you to write list items "lazily," instead of
3345indenting continuation lines. However, if there are multiple paragraphs or
3346other blocks in a list item, the first line of each must be indented.
3348 + A lazy, lazy, list
3351 + Another one; this looks
3354 Second paragraph of second
3357### Ordered lists ###
3359Ordered lists work just like bulleted lists, except that the items
3360begin with enumerators rather than bullets.
3362In standard Markdown, enumerators are decimal numbers followed
3363by a period and a space. The numbers themselves are ignored, so
3364there is no difference between this list:
3376#### Extension: `fancy_lists` ####
3378Unlike standard Markdown, pandoc allows ordered list items to be marked
3379with uppercase and lowercase letters and roman numerals, in addition to
3380Arabic numerals. List markers may be enclosed in parentheses or followed by a
3381single right-parentheses or period. They must be separated from the
3382text that follows by at least one space, and, if the list marker is a
3383capital letter with a period, by at least two spaces.[^2]
3385[^2]: The point of this rule is to ensure that normal paragraphs
3386 starting with people's initials, like
3388 B. Russell was an English philosopher.
3390 do not get treated as list items.
3392 This rule will not prevent
3396 from being interpreted as a list item. In this case, a backslash
3401The `fancy_lists` extension also allows '`#`' to be used as an
3402ordered list marker in place of a numeral:
3407#### Extension: `startnum` ####
3409Pandoc also pays attention to the type of list marker used, and to the
3410starting number, and both of these are preserved where possible in the
3411output format. Thus, the following yields a list with numbers followed
3412by a single parenthesis, starting with 9, and a sublist with lowercase
3422Pandoc will start a new list each time a different type of list
3423marker is used. So, the following will create three lists:
3430If default list markers are desired, use `#.`:
3436#### Extension: `task_lists` ####
3438Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3440 - [ ] an unchecked task list item
3443### Definition lists ###
3445#### Extension: `definition_lists` ####
3447Pandoc supports definition lists, using the syntax of
3448[PHP Markdown Extra] with some extensions.[^3]
3454 Term 2 with *inline markup*
3458 { some code, part of Definition 2 }
3460 Third paragraph of definition 2.
3462Each term must fit on one line, which may optionally be followed by
3463a blank line, and must be followed by one or more definitions.
3464A definition begins with a colon or tilde, which may be indented one
3467A term may have multiple definitions, and each definition may consist of one or
3468more block elements (paragraph, code block, list, etc.), each indented four
3469spaces or one tab stop. The body of the definition (including the first line,
3470aside from the colon or tilde) should be indented four spaces. However,
3471as with other Markdown lists, you can "lazily" omit indentation except
3472at the beginning of a paragraph or other block element:
3477 with lazy continuation.
3479 Second paragraph of the definition.
3481If you leave space before the definition (as in the example above),
3482the text of the definition will be treated as a paragraph. In some
3483output formats, this will mean greater spacing between term/definition
3484pairs. For a more compact definition list, omit the space before the
3494Note that space between items in a definition list is required.
3495(A variant that loosens this requirement, but disallows "lazy"
3496hard wrapping, can be activated with `compact_definition_lists`: see
3497[Non-pandoc extensions], below.)
3499[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3501### Numbered example lists ###
3503#### Extension: `example_lists` ####
3505The special list marker `@` can be used for sequentially numbered
3506examples. The first list item with a `@` marker will be numbered '1',
3507the next '2', and so on, throughout the document. The numbered examples
3508need not occur in a single list; each new list using `@` will take up
3509where the last stopped. So, for example:
3511 (@) My first example will be numbered (1).
3512 (@) My second example will be numbered (2).
3514 Explanation of examples.
3516 (@) My third example will be numbered (3).
3518Numbered examples can be labeled and referred to elsewhere in the
3521 (@good) This is a good example.
3523 As (@good) illustrates, ...
3525The label can be any string of alphanumeric characters, underscores,
3528Note: continuation paragraphs in example lists must always
3529be indented four spaces, regardless of the length of the
3530list marker. That is, example lists always behave as if the
3531`four_space_rule` extension is set. This is because example
3532labels tend to be long, and indenting content to the
3533first non-space character after the label would be awkward.
3535### Compact and loose lists ###
3537Pandoc behaves differently from `Markdown.pl` on some "edge
3538cases" involving lists. Consider this source:
3548Pandoc transforms this into a "compact list" (with no `<p>` tags around
3549"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3550"Second" and "Third" (but not "First"), because of the blank space
3551around "Third". Pandoc follows a simple rule: if the text is followed by
3552a blank line, it is treated as a paragraph. Since "Second" is followed
3553by a list, and not a blank line, it isn't treated as a paragraph. The
3554fact that the list is followed by a blank line is irrelevant. (Note:
3555Pandoc works this way even when the `markdown_strict` format is specified. This
3556behavior is consistent with the official Markdown syntax description,
3557even though it is different from that of `Markdown.pl`.)
3560### Ending a list ###
3562What if you want to put an indented code block after a list?
3569Trouble! Here pandoc (like other Markdown implementations) will treat
3570`{ my code block }` as the second paragraph of item two, and not as
3573To "cut off" the list after item two, you can insert some non-indented
3574content, like an HTML comment, which won't produce visible output in
3580 <!-- end of list -->
3584You can use the same trick if you want two consecutive lists instead
3599A line containing a row of three or more `*`, `-`, or `_` characters
3600(optionally separated by spaces) produces a horizontal rule:
3609Four kinds of tables may be used. The first three kinds presuppose the use of
3610a fixed-width font, such as Courier. The fourth kind can be used with
3611proportionally spaced fonts, as it does not require lining up columns.
3613#### Extension: `table_captions` ####
3615A caption may optionally be provided with all 4 kinds of tables (as
3616illustrated in the examples below). A caption is a paragraph beginning
3617with the string `Table:` (or just `:`), which will be stripped off.
3618It may appear either before or after the table.
3620#### Extension: `simple_tables` ####
3622Simple tables look like this:
3624 Right Left Center Default
3625 ------- ------ ---------- -------
3630 Table: Demonstration of simple table syntax.
3632The header and table rows must each fit on one line. Column
3633alignments are determined by the position of the header text relative
3634to the dashed line below it:[^4]
3636 - If the dashed line is flush with the header text on the right side
3637 but extends beyond it on the left, the column is right-aligned.
3638 - If the dashed line is flush with the header text on the left side
3639 but extends beyond it on the right, the column is left-aligned.
3640 - If the dashed line extends beyond the header text on both sides,
3641 the column is centered.
3642 - If the dashed line is flush with the header text on both sides,
3643 the default alignment is used (in most cases, this will be left).
3645[^4]: This scheme is due to Michel Fortin, who proposed it on the
3646 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3648The table must end with a blank line, or a line of dashes followed by
3651The column header row may be omitted, provided a dashed line is used
3652to end the table. For example:
3654 ------- ------ ---------- -------
3658 ------- ------ ---------- -------
3660When the header row is omitted, column alignments are determined on the basis
3661of the first line of the table body. So, in the tables above, the columns
3662would be right, left, center, and right aligned, respectively.
3664#### Extension: `multiline_tables` ####
3666Multiline tables allow header and table rows to span multiple lines
3667of text (but cells that span multiple columns or rows of the table are
3668not supported). Here is an example:
3670 -------------------------------------------------------------
3671 Centered Default Right Left
3672 Header Aligned Aligned Aligned
3673 ----------- ------- --------------- -------------------------
3674 First row 12.0 Example of a row that
3675 spans multiple lines.
3677 Second row 5.0 Here's another one. Note
3678 the blank line between
3680 -------------------------------------------------------------
3682 Table: Here's the caption. It, too, may span
3685These work like simple tables, but with the following differences:
3687 - They must begin with a row of dashes, before the header text
3688 (unless the header row is omitted).
3689 - They must end with a row of dashes, then a blank line.
3690 - The rows must be separated by blank lines.
3692In multiline tables, the table parser pays attention to the widths of
3693the columns, and the writers try to reproduce these relative widths in
3694the output. So, if you find that one of the columns is too narrow in the
3695output, try widening it in the Markdown source.
3697The header may be omitted in multiline tables as well as simple tables:
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 : Here's a multiline table without a header.
3710It is possible for a multiline table to have just one row, but the row
3711should be followed by a blank line (and then the row of dashes that ends
3712the table), or the table may be interpreted as a simple table.
3714#### Extension: `grid_tables` ####
3716Grid tables look like this:
3718 : Sample grid table.
3720 +---------------+---------------+--------------------+
3721 | Fruit | Price | Advantages |
3722 +===============+===============+====================+
3723 | Bananas | $1.34 | - built-in wrapper |
3724 | | | - bright color |
3725 +---------------+---------------+--------------------+
3726 | Oranges | $2.10 | - cures scurvy |
3728 +---------------+---------------+--------------------+
3730The row of `=`s separates the header from the table body, and can be
3731omitted for a headerless table. The cells of grid tables may contain
3732arbitrary block elements (multiple paragraphs, code blocks, lists,
3733etc.). Cells that span multiple columns or rows are not
3734supported. Grid tables can be created easily using Emacs' table-mode
3735(`M-x table-insert`).
3737Alignments can be specified as with pipe tables, by putting
3738colons at the boundaries of the separator line after the
3741 +---------------+---------------+--------------------+
3742 | Right | Left | Centered |
3743 +==============:+:==============+:==================:+
3744 | Bananas | $1.34 | built-in wrapper |
3745 +---------------+---------------+--------------------+
3747For headerless tables, the colons go on the top line instead:
3749 +--------------:+:--------------+:------------------:+
3750 | Right | Left | Centered |
3751 +---------------+---------------+--------------------+
3753##### Grid Table Limitations #####
3755Pandoc does not support grid tables with row spans or column spans.
3756This means that neither variable numbers of columns across rows nor
3757variable numbers of rows across columns are supported by Pandoc.
3758All grid tables must have the same number of columns in each row,
3759and the same number of rows in each column. For example, the
3760Docutils [sample grid tables] will not render as expected with
3763[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3766#### Extension: `pipe_tables` ####
3768Pipe tables look like this:
3770 | Right | Left | Default | Center |
3771 |------:|:-----|---------|:------:|
3772 | 12 | 12 | 12 | 12 |
3773 | 123 | 123 | 123 | 123 |
3776 : Demonstration of pipe table syntax.
3778The syntax is identical to [PHP Markdown Extra tables]. The beginning and
3779ending pipe characters are optional, but pipes are required between all
3780columns. The colons indicate column alignment as shown. The header
3781cannot be omitted. To simulate a headerless table, include a header
3784Since the pipes indicate column boundaries, columns need not be vertically
3785aligned, as they are in the above example. So, this is a perfectly
3786legal (though ugly) pipe table:
3794The cells of pipe tables cannot contain block elements like paragraphs
3795and lists, and cannot span multiple lines. If a pipe table contains a
3796row whose printable content is wider than the column width (see
3797`--columns`), then the table will take up the full text width and
3798the cell contents will wrap, with the relative cell widths determined
3799by the number of dashes in the line separating the table header from
3800the table body. (For example `---|-` would make the first column 3/4
3801and the second column 1/4 of the full text width.)
3802On the other hand, if no lines are wider than column width, then
3803cell contents will not be wrapped, and the cells will be sized
3806Note: pandoc also recognizes pipe tables of the following
3807form, as can be produced by Emacs' orgtbl-mode:
3814The difference is that `+` is used instead of `|`. Other orgtbl features
3815are not supported. In particular, to get non-default column alignment,
3816you'll need to add colons as above.
3818[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3822#### Extension: `pandoc_title_block` ####
3824If the file begins with a title block
3827 % author(s) (separated by semicolons)
3830it will be parsed as bibliographic information, not regular text. (It
3831will be used, for example, in the title of standalone LaTeX or HTML
3832output.) The block may contain just a title, a title and an author,
3833or all three elements. If you want to include an author but no
3834title, or a title and a date but no author, you need a blank line:
3843The title may occupy multiple lines, but continuation lines must
3844begin with leading space, thus:
3849If a document has multiple authors, the authors may be put on
3850separate lines with leading space, or separated by semicolons, or
3851both. So, all of the following are equivalent:
3856 % Author One; Author Two
3861The date must fit on one line.
3863All three metadata fields may contain standard inline formatting
3864(italics, links, footnotes, etc.).
3866Title blocks will always be parsed, but they will affect the output only
3867when the `--standalone` (`-s`) option is chosen. In HTML output, titles
3868will appear twice: once in the document head -- this is the title that
3869will appear at the top of the window in a browser -- and once at the
3870beginning of the document body. The title in the document head can have
3871an optional prefix attached (`--title-prefix` or `-T` option). The title
3872in the body appears as an H1 element with class "title", so it can be
3873suppressed or reformatted with CSS. If a title prefix is specified with
3874`-T` and no title block appears in the document, the title prefix will
3875be used by itself as the HTML title.
3877The man page writer extracts a title, man page section number, and
3878other header and footer information from the title line. The title
3879is assumed to be the first word on the title line, which may optionally
3880end with a (single-digit) section number in parentheses. (There should
3881be no space between the title and the parentheses.) Anything after
3882this is assumed to be additional footer and header text. A single pipe
3883character (`|`) should be used to separate the footer text from the header
3888will yield a man page with the title `PANDOC` and section 1.
3890 % PANDOC(1) Pandoc User Manuals
3892will also have "Pandoc User Manuals" in the footer.
3894 % PANDOC(1) Pandoc User Manuals | Version 4.0
3896will also have "Version 4.0" in the header.
3898#### Extension: `yaml_metadata_block` ####
3900A [YAML] metadata block is a valid YAML object, delimited by a line of three
3901hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3902(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3903document, but if it is not at the beginning, it must be preceded by a blank
3904line. (Note that, because of the way pandoc concatenates input files when
3905several are provided, you may also keep the metadata in a separate YAML file
3906and pass it to pandoc as an argument, along with your Markdown files:
3908 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
3910Just be sure that the YAML file begins with `---` and ends with `---` or
3911`...`.) Alternatively, you can use the `--metadata-file` option. Using
3912that approach however, you cannot reference content (like footnotes)
3913from the main markdown input document.
3915Metadata will be taken from the fields of the YAML object and added to any
3916existing document metadata. Metadata can contain lists and objects (nested
3917arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3918with names ending in an underscore will be ignored by pandoc. (They may be
3919given a role by external processors.) Field names must not be
3920interpretable as YAML numbers or boolean values (so, for
3921example, `yes`, `True`, and `15` cannot be used as field names).
3923A document may contain multiple metadata blocks. If two
3924metadata blocks attempt to set the same field, the value from
3925the second block will be taken.
3927When pandoc is used with `-t markdown` to create a Markdown document,
3928a YAML metadata block will be produced only if the `-s/--standalone`
3929option is used. All of the metadata will appear in a single block
3930at the beginning of the document.
3932Note that [YAML] escaping rules must be followed. Thus, for example,
3933if a title contains a colon, it must be quoted. The pipe character
3934(`|`) can be used to begin an indented block that will be interpreted
3935literally, without need for escaping. This form is necessary
3936when the field contains blank lines or block-level formatting:
3939 title: 'This is the title: it contains a colon'
3943 keywords: [nothing, nothingness]
3945 This is the abstract.
3947 It consists of two paragraphs.
3950Template variables will be set automatically from the metadata. Thus, for
3951example, in writing HTML, the variable `abstract` will be set to the HTML
3952equivalent of the Markdown in the `abstract` field:
3954 <p>This is the abstract.</p>
3955 <p>It consists of two paragraphs.</p>
3957Variables can contain arbitrary YAML structures, but the template must match
3958this structure. The `author` variable in the default templates expects a
3959simple list or string, but can be changed to support more complicated
3960structures. The following combination, for example, would add an affiliation
3961to the author if one is given:
3964 title: The document title
3967 affiliation: University of Somewhere
3969 affiliation: University of Nowhere
3972To use the structured authors in the example above, you would need a custom
3977 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3983Raw content to include in the document's header may be specified
3984using `header-includes`; however, it is important to mark up
3985this content as raw code for a particular output format, using
3986the [`raw_attribute` extension](#extension-raw_attribute)), or it
3987will be interpreted as markdown. For example:
3992 \let\oldsection\section
3993 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
3998#### Extension: `all_symbols_escapable` ####
4000Except inside a code block or inline code, any punctuation or space
4001character preceded by a backslash will be treated literally, even if it
4002would normally indicate formatting. Thus, for example, if one writes
4012 <strong>hello</strong>
4014This rule is easier to remember than standard Markdown's rule,
4015which allows only the following characters to be backslash-escaped:
4019(However, if the `markdown_strict` format is used, the standard Markdown rule
4022A backslash-escaped space is parsed as a nonbreaking space. It will
4023appear in TeX output as `~` and in HTML and XML as `\ ` or
4026A backslash-escaped newline (i.e. a backslash occurring at the end of
4027a line) is parsed as a hard line break. It will appear in TeX output as
4028`\\` and in HTML as `<br />`. This is a nice alternative to
4029Markdown's "invisible" way of indicating hard line breaks using
4030two trailing spaces on a line.
4032Backslash escapes do not work in verbatim contexts.
4038To *emphasize* some text, surround it with `*`s or `_`, like this:
4040 This text is _emphasized with underscores_, and this
4041 is *emphasized with asterisks*.
4043Double `*` or `_` produces **strong emphasis**:
4045 This is **strong emphasis** and __with underscores__.
4047A `*` or `_` character surrounded by spaces, or backslash-escaped,
4048will not trigger emphasis:
4050 This is * not emphasized *, and \*neither is this\*.
4052#### Extension: `intraword_underscores` ####
4054Because `_` is sometimes used inside words and identifiers,
4055pandoc does not interpret a `_` surrounded by alphanumeric
4056characters as an emphasis marker. If you want to emphasize
4057just part of a word, use `*`:
4059 feas*ible*, not feas*able*.
4064#### Extension: `strikeout` ####
4066To strikeout a section of text with a horizontal line, begin and end it
4067with `~~`. Thus, for example,
4069 This ~~is deleted text.~~
4072### Superscripts and subscripts ###
4074#### Extension: `superscript`, `subscript` ####
4076Superscripts may be written by surrounding the superscripted text by `^`
4077characters; subscripts may be written by surrounding the subscripted
4078text by `~` characters. Thus, for example,
4080 H~2~O is a liquid. 2^10^ is 1024.
4082The text between `^...^` or `~...~` may not contain spaces or
4083newlines. If the superscripted or subscripted text contains
4084spaces, these spaces must be escaped with backslashes. (This is
4085to prevent accidental superscripting and subscripting through
4086the ordinary use of `~` and `^`, and also bad interactions with
4087footnotes.) Thus, if you want the letter P with 'a cat' in
4088subscripts, use `P~a\ cat~`, not `P~a cat~`.
4092To make a short span of text verbatim, put it inside backticks:
4094 What is the difference between `>>=` and `>>`?
4096If the verbatim text includes a backtick, use double backticks:
4098 Here is a literal backtick `` ` ``.
4100(The spaces after the opening backticks and before the closing
4101backticks will be ignored.)
4103The general rule is that a verbatim span starts with a string
4104of consecutive backticks (optionally followed by a space)
4105and ends with a string of the same number of backticks (optionally
4106preceded by a space).
4108Note that backslash-escapes (and other Markdown constructs) do not
4109work in verbatim contexts:
4111 This is a backslash followed by an asterisk: `\*`.
4113#### Extension: `inline_code_attributes` ####
4115Attributes can be attached to verbatim text, just as with
4116[fenced code blocks]:
4122To write small caps, use the `smallcaps` class:
4124 [Small caps]{.smallcaps}
4126Or, without the `bracketed_spans` extension:
4128 <span class="smallcaps">Small caps</span>
4130For compatibility with other Markdown flavors, CSS is also supported:
4132 <span style="font-variant:small-caps;">Small caps</span>
4134This will work in all output formats that support small caps.
4139#### Extension: `tex_math_dollars` ####
4141Anything between two `$` characters will be treated as TeX math. The
4142opening `$` must have a non-space character immediately to its right,
4143while the closing `$` must have a non-space character immediately to its
4144left, and must not be followed immediately by a digit. Thus,
4145`$20,000 and $30,000` won't parse as math. If for some reason
4146you need to enclose text in literal `$` characters, backslash-escape
4147them and they won't be treated as math delimiters.
4149For display math, use `$$` delimiters. (In this case, the delimiters
4150may be separated from the formula by whitespace.)
4152TeX math will be printed in all output formats. How it is rendered
4153depends on the output format:
4156 ~ It will appear verbatim surrounded by `\(...\)` (for inline
4157 math) or `\[...\]` (for display math).
4159Markdown, Emacs Org mode, ConTeXt, ZimWiki
4160 ~ It will appear verbatim surrounded by `$...$` (for inline
4161 math) or `$$...$$` (for display math).
4164 ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4167 ~ It will be rendered using an [interpreted text role `:math:`].
4170 ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4171 surrounded by `latexmath:[$...$]` (for inline math) or
4172 `[latexmath]++++\[...\]+++` (for display math).
4173 For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4174 (`$..$` and `\[..\]`) are omitted.
4177 ~ It will be rendered inside a `@math` command.
4179roff man, Jira markup
4180 ~ It will be rendered verbatim without `$`'s.
4183 ~ It will be rendered inside `<math>` tags.
4186 ~ It will be rendered inside `<span class="math">` tags.
4189 ~ It will be rendered, if possible, using Unicode characters,
4190 and will otherwise appear verbatim.
4193 ~ It will be rendered, if possible, using MathML.
4196 ~ If the `--mathml` flag is used, it will be rendered using MathML
4197 in an `inlineequation` or `informalequation` tag. Otherwise it
4198 will be rendered, if possible, using Unicode characters.
4201 ~ It will be rendered using OMML math markup.
4204 ~ If the `--webtex` option is used, formulas are rendered as images
4205 using CodeCogs or other compatible web service, downloaded
4206 and embedded in the e-book. Otherwise, they will appear verbatim.
4208HTML, Slidy, DZSlides, S5, EPUB
4209 ~ The way math is rendered in HTML will depend on the
4210 command-line options selected. Therefore see [Math rendering in HTML]
4213[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4217#### Extension: `raw_html` ####
4219Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4220(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4221literally). (Technically this is not an extension, since standard
4222Markdown allows it, but it has been made an extension so that it can
4223be disabled if desired.)
4225The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4226DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4227output, and suppressed in other formats.
4229For a more explicit way of including raw HTML in a Markdown
4230document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4232In the CommonMark format, if `raw_html` is enabled, superscripts,
4233subscripts, strikeouts and small capitals will be represented as HTML.
4234Otherwise, plain-text fallbacks will be used. Note that even if
4235`raw_html` is disabled, tables will be rendered with HTML syntax if
4236they cannot use pipe syntax.
4238#### Extension: `markdown_in_html_blocks` ####
4240Standard Markdown allows you to include HTML "blocks": blocks
4241of HTML between balanced tags that are separated from the surrounding text
4242with blank lines, and start and end at the left margin. Within
4243these blocks, everything is interpreted as HTML, not Markdown;
4244so (for example), `*` does not signify emphasis.
4246Pandoc behaves this way when the `markdown_strict` format is used; but
4247by default, pandoc interprets material between HTML block tags as Markdown.
4248Thus, for example, pandoc will turn
4253 <td>[a link](https://google.com)</td>
4261 <td><em>one</em></td>
4262 <td><a href="https://google.com">a link</a></td>
4266whereas `Markdown.pl` will preserve it as is.
4268There is one exception to this rule: text between `<script>` and
4269`<style>` tags is not interpreted as Markdown.
4271This departure from standard Markdown should make it easier to mix
4272Markdown with HTML block elements. For example, one can surround
4273a block of Markdown text with `<div>` tags without preventing it
4274from being interpreted as Markdown.
4276#### Extension: `native_divs` ####
4278Use native pandoc `Div` blocks for content inside `<div>` tags.
4279For the most part this should give the same output as
4280`markdown_in_html_blocks`, but it makes it easier to write pandoc
4281filters to manipulate groups of blocks.
4283#### Extension: `native_spans` ####
4285Use native pandoc `Span` blocks for content inside `<span>` tags.
4286For the most part this should give the same output as `raw_html`,
4287but it makes it easier to write pandoc filters to manipulate groups
4290#### Extension: `raw_tex` ####
4292In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4293included in a document. Inline TeX commands will be preserved and passed
4294unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4295LaTeX to include BibTeX citations:
4297 This result was proved in \cite{jones.1967}.
4299Note that in LaTeX environments, like
4301 \begin{tabular}{|l|l|}\hline
4302 Age & Frequency \\ \hline
4305 36--45 & 22 \\ \hline
4308the material between the begin and end tags will be interpreted as raw
4309LaTeX, not as Markdown.
4311For a more explicit and flexible way of including raw TeX in a
4312Markdown document, see the [`raw_attribute`
4313extension][Extension: `raw_attribute`].
4315Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4316Emacs Org mode, and ConTeXt.
4318### Generic raw attribute ###
4320#### Extension: `raw_attribute` ####
4322Inline spans and fenced code blocks with a special
4323kind of attribute will be parsed as raw content with the
4324designated format. For example, the following produces a raw
4331And the following produces a raw `html` inline element:
4333 This is `<a>html</a>`{=html}
4335This can be useful to insert raw xml into `docx` documents, e.g.
4341 <w:br w:type="page"/>
4346The format name should match the target format name (see
4347`-t/--to`, above, for a list, or use `pandoc
4348--list-output-formats`). Use `openxml` for `docx` output,
4349`opendocument` for `odt` output, `html5` for `epub3` output,
4350`html4` for `epub2` output, and `latex`, `beamer`,
4351`ms`, or `html5` for `pdf` output (depending on what you
4352use for `--pdf-engine`).
4354This extension presupposes that the relevant kind of
4355inline code or fenced code block is enabled. Thus, for
4356example, to use a raw attribute with a backtick code block,
4357`backtick_code_blocks` must be enabled.
4359The raw attribute cannot be combined with regular attributes.
4363#### Extension: `latex_macros` ####
4365When this extension is enabled, pandoc will parse LaTeX
4366macro definitions and apply the resulting macros to all LaTeX
4367math and raw LaTeX. So, for example, the following will work in
4368all output formats, not just LaTeX:
4370 \newcommand{\tuple}[1]{\langle #1 \rangle}
4374Note that LaTeX macros will not be applied if they occur
4375inside a raw span or block marked with the
4376[`raw_attribute` extension](#extension-raw_attribute).
4378When `latex_macros` is disabled, the raw LaTeX and math will
4379not have macros applied. This is usually a better approach when
4380you are targeting LaTeX or PDF.
4382Macro definitions in LaTeX will be passed through as raw LaTeX
4383only if `latex_macros` is not enabled. Macro definitions in
4384Markdown source (or other formats allowing `raw_tex`) will
4385be passed through regardless of whether `latex_macros` is
4390Markdown allows links to be specified in several ways.
4392### Automatic links ###
4394If you enclose a URL or email address in pointy brackets, it
4397 <https://google.com>
4398 <sam@green.eggs.ham>
4402An inline link consists of the link text in square brackets,
4403followed by the URL in parentheses. (Optionally, the URL can
4404be followed by a link title, in quotes.)
4406 This is an [inline link](/url), and here's [one with
4407 a title](https://fsf.org "click here for a good time!").
4409There can be no space between the bracketed part and the parenthesized part.
4410The link text can contain formatting (such as emphasis), but the title cannot.
4412Email addresses in inline links are not autodetected, so they have to be
4413prefixed with `mailto`:
4415 [Write me!](mailto:sam@green.eggs.ham)
4417### Reference links ###
4419An *explicit* reference link has two parts, the link itself and the link
4420definition, which may occur elsewhere in the document (either
4421before or after the link).
4423The link consists of link text in square brackets, followed by a label in
4424square brackets. (There cannot be space between the two unless the
4425`spaced_reference_links` extension is enabled.) The link definition
4426consists of the bracketed label, followed by a colon and a space, followed by
4427the URL, and optionally (after a space) a link title either in quotes or in
4428parentheses. The label must not be parseable as a citation (assuming
4429the `citations` extension is enabled): citations take precedence over
4432Here are some examples:
4434 [my label 1]: /foo/bar.html "My title, optional"
4436 [my label 3]: https://fsf.org (The free software foundation)
4437 [my label 4]: /bar#special 'A title in single quotes'
4439The URL may optionally be surrounded by angle brackets:
4441 [my label 5]: <http://foo.bar.baz>
4443The title may go on the next line:
4445 [my label 3]: https://fsf.org
4446 "The free software foundation"
4448Note that link labels are not case sensitive. So, this will work:
4450 Here is [my link][FOO]
4454In an *implicit* reference link, the second pair of brackets is
4459 [my website]: http://foo.bar.baz
4461Note: In `Markdown.pl` and most other Markdown implementations,
4462reference link definitions cannot occur in nested constructions
4463such as list items or block quotes. Pandoc lifts this arbitrary
4464seeming restriction. So the following is fine in pandoc, though
4465not in most other implementations:
4471#### Extension: `shortcut_reference_links` ####
4473In a *shortcut* reference link, the second pair of brackets may
4478 [my website]: http://foo.bar.baz
4480### Internal links ###
4482To link to another section of the same document, use the automatically
4483generated identifier (see [Heading identifiers]). For example:
4485 See the [Introduction](#introduction).
4489 See the [Introduction].
4491 [Introduction]: #introduction
4493Internal links are currently supported for HTML formats (including
4494HTML slide shows and EPUB), LaTeX, and ConTeXt.
4498A link immediately preceded by a `!` will be treated as an image.
4499The link text will be used as the image's alt text:
4501 
4505 [movie reel]: movie.gif
4507#### Extension: `implicit_figures` ####
4509An image with nonempty alt text, occurring by itself in a
4510paragraph, will be rendered as a figure with a caption. The
4511image's alt text will be used as the caption.
4513 
4515How this is rendered depends on the output format. Some output
4516formats (e.g. RTF) do not yet support figures. In those
4517formats, you'll just get an image in a paragraph by itself, with
4520If you just want a regular inline image, just make sure it is not
4521the only thing in the paragraph. One way to do this is to insert a
4522nonbreaking space after the image:
4524 \
4526Note that in reveal.js slide shows, an image in a paragraph
4527by itself that has the `stretch` class will fill the screen,
4528and the caption and figure tags will be omitted.
4530#### Extension: `link_attributes` ####
4532Attributes can be set on links and images:
4534 An inline {#id .class width=30 height=20px}
4535 and a reference ![image][ref] with attributes.
4537 [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4539(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4540and `.class` are used.)
4542For HTML and EPUB, all known HTML5 attributes except `width` and
4543`height` (but including `srcset` and `sizes`) are passed through
4544as is. Unknown attributes are passed through as custom
4545attributes, with `data-` prepended. The other writers ignore
4546attributes that are not specifically supported by their output format.
4548The `width` and `height` attributes on images are treated specially. When
4549used without a unit, the unit is assumed to be pixels. However, any of
4550the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4551and `%`. There must not be any spaces between the number and the unit.
4555{ width=50% }
4558- Dimensions are converted to inches for output in page-based formats like
4559 LaTeX. Dimensions are converted to pixels for output in HTML-like
4560 formats. Use the `--dpi` option to specify the number of pixels per
4561 inch. The default is 96dpi.
4562- The `%` unit is generally relative to some available space.
4563 For example the above example will render to the following.
4564 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4565 - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4566 (If you're using a custom template, you need to configure `graphicx`
4567 as in the default template.)
4568 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4569- Some output formats have a notion of a class
4570 ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4571 or a unique identifier (LaTeX `\caption`), or both (HTML).
4572- When no `width` or `height` attributes are specified, the fallback
4573 is to look at the image resolution and the dpi metadata embedded in
4578Using the `native_divs` and `native_spans` extensions
4579(see [above][Extension: `native_divs`]), HTML syntax can
4580be used as part of markdown to create native `Div` and `Span`
4581elements in the pandoc AST (as opposed to raw HTML).
4582However, there is also nicer syntax available:
4584#### Extension: `fenced_divs` ####
4586Allow special fenced syntax for native `Div` blocks. A Div
4587starts with a fence containing at least three consecutive
4588colons plus some attributes. The attributes may optionally
4589be followed by another string of consecutive colons.
4590The attribute syntax is exactly as in fenced code blocks (see
4591[Extension: `fenced_code_attributes`]). As with fenced
4592code blocks, one can use either attributes in curly braces
4593or a single unbraced word, which will be treated as a class
4594name. The Div ends with another line containing a string of at
4595least three consecutive colons. The fenced Div should be
4596separated by blank lines from preceding and following blocks.
4600 ::::: {#special .sidebar}
4601 Here is a paragraph.
4606Fenced divs can be nested. Opening fences are distinguished
4607because they *must* have attributes:
4613 This is a warning within a warning.
4617Fences without attributes are always closing fences. Unlike
4618with fenced code blocks, the number of colons in the closing
4619fence need not match the number in the opening fence. However,
4620it can be helpful for visual clarity to use fences of different
4621lengths to distinguish nested divs from their parents.
4624#### Extension: `bracketed_spans` ####
4626A bracketed sequence of inlines, as one would use to begin
4627a link, will be treated as a `Span` with attributes if it is
4628followed immediately by attributes:
4630 [This is *some text*]{.class key="val"}
4634#### Extension: `footnotes` ####
4636Pandoc's Markdown allows footnotes, using the following syntax:
4638 Here is a footnote reference,[^1] and another.[^longnote]
4640 [^1]: Here is the footnote.
4642 [^longnote]: Here's one with multiple blocks.
4644 Subsequent paragraphs are indented to show that they
4645 belong to the previous footnote.
4649 The whole paragraph can be indented, or just the first
4650 line. In this way, multi-paragraph footnotes work like
4651 multi-paragraph list items.
4653 This paragraph won't be part of the note, because it
4656The identifiers in footnote references may not contain spaces, tabs,
4657or newlines. These identifiers are used only to correlate the
4658footnote reference with the note itself; in the output, footnotes
4659will be numbered sequentially.
4661The footnotes themselves need not be placed at the end of the
4662document. They may appear anywhere except inside other block elements
4663(lists, block quotes, tables, etc.). Each footnote should be
4664separated from surrounding content (including other footnotes)
4667#### Extension: `inline_notes` ####
4669Inline footnotes are also allowed (though, unlike regular notes,
4670they cannot contain multiple paragraphs). The syntax is as follows:
4672 Here is an inline note.^[Inlines notes are easier to write, since
4673 you don't have to pick an identifier and move down to type the
4676Inline and regular footnotes may be mixed freely.
4680#### Extension: `citations` ####
4682Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4683citations and a bibliography in a number of styles. Basic usage is
4685 pandoc --filter pandoc-citeproc myinput.txt
4687In order to use this feature, you will need to specify a bibliography file
4688using the `bibliography` metadata field in a YAML metadata section, or
4689`--bibliography` command line argument. You can supply multiple `--bibliography`
4690arguments or set `bibliography` metadata field to YAML array, if you want to
4691use multiple bibliography files. The bibliography may have any of these
4694 Format File extension
4695 ------------ --------------
4708Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4709use `.bibtex` to force BibTeX.
4711Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4712can produce `.json` and `.yaml` files from any of the supported formats.
4714In-field markup: In BibTeX and BibLaTeX databases,
4715pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4716databases, pandoc Markdown; and in CSL JSON databases, an
4717[HTML-like markup][CSL markup specs]:
4725`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4734`<span class="nocase">...</span>`
4735: prevent a phrase from being capitalized as title case
4737`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4738and CSL YAML formats as far as possible.
4740As an alternative to specifying a bibliography file using `--bibliography`
4741or the YAML metadata field `bibliography`, you can include
4742the citation data directly in the `references` field of the
4743document's YAML metadata. The field should contain an array of
4744YAML-encoded references, for example:
4748 - type: article-journal
4760 title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4762 title-short: Molecular structure of nucleic acids
4763 container-title: Nature
4767 DOI: 10.1038/171737a0
4768 URL: https://www.nature.com/articles/171737a0
4772(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4773of the supported formats.)
4775Citations and references can be formatted using any style supported by the
4776[Citation Style Language], listed in the [Zotero Style Repository].
4777These files are specified using the `--csl` option or the `csl` metadata field.
4778By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4779format. The CSL project provides further information on [finding and editing styles].
4781To make your citations hyperlinks to the corresponding bibliography
4782entries, add `link-citations: true` to your YAML metadata.
4784Citations go inside square brackets and are separated by semicolons.
4785Each citation must have a key, composed of '@' + the citation
4786identifier from the database, and may optionally have a prefix,
4787a locator, and a suffix. The citation key must begin with a letter, digit,
4788or `_`, and may contain alphanumerics, `_`, and internal punctuation
4789characters (`:.#$%&-+?<>~/`). Here are some examples:
4791 Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4793 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4795 Blah blah [@smith04; @doe99].
4797`pandoc-citeproc` detects locator terms in the [CSL locale files].
4798Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4799locale, locator terms can be written in either singular or plural forms,
4800as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4801`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4802`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4803`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4804`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4805`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4806locator term is used, "page" is assumed.
4808`pandoc-citeproc` will use heuristics to distinguish the locator
4809from the suffix. In complex cases, the locator can be enclosed
4810in curly braces (using `pandoc-citeproc` 0.15 and higher only):
4812 [@smith{ii, A, D-Z}, with a suffix]
4813 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4815A minus sign (`-`) before the `@` will suppress mention of
4816the author in the citation. This can be useful when the
4817author is already mentioned in the text:
4819 Smith says blah [-@smith04].
4821You can also write an in-text citation, as follows:
4825 @smith04 [p. 33] says blah.
4827If the style calls for a list of works cited, it will be placed
4828in a div with id `refs`, if one exists:
4833Otherwise, it will be placed at the end of the document.
4834Generation of the bibliography can be suppressed by setting
4835`suppress-bibliography: true` in the YAML metadata.
4837If you wish the bibliography to have a section heading, you can
4838set `reference-section-title` in the metadata, or put the heading
4839at the beginning of the div with id `refs` (if you are using it)
4840or at the end of your document:
4846The bibliography will be inserted after this heading. Note that
4847the `unnumbered` class will be added to this heading, so that the
4848section will not be numbered.
4850If you want to include items in the bibliography without actually
4851citing them in the body text, you can define a dummy `nocite` metadata
4852field and put the citations there:
4861In this example, the document will contain a citation for `item3`
4862only, but the bibliography will contain entries for `item1`, `item2`, and
4865It is possible to create a bibliography with all the citations,
4866whether or not they appear in the document, by using a wildcard:
4873For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4874render the bibliography. In order to do so, specify bibliography
4875files as outlined above, and add `--natbib` or `--biblatex`
4876argument to `pandoc` invocation. Bear in mind that bibliography
4877files have to be in respective format (either BibTeX or
4880For more information, see the [pandoc-citeproc man page].
4882[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4883[Chicago Manual of Style]: https://chicagomanualofstyle.org
4884[Citation Style Language]: https://citationstyles.org
4885[Zotero Style Repository]: https://www.zotero.org/styles
4886[finding and editing styles]: https://citationstyles.org/authors/
4887[CSL locale files]: https://github.com/citation-style-language/locales
4888[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4890## Non-pandoc extensions
4892The following Markdown syntax extensions are not enabled by default
4893in pandoc, but may be enabled by adding `+EXTENSION` to the format
4894name, where `EXTENSION` is the name of the extension. Thus, for
4895example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
4897#### Extension: `old_dashes` ####
4899Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4900`-` before a numeral is an en-dash, and `--` is an em-dash.
4901This option only has an effect if `smart` is enabled. It is
4902selected automatically for `textile` input.
4904#### Extension: `angle_brackets_escapable` ####
4906Allow `<` and `>` to be backslash-escaped, as they can be in
4907GitHub flavored Markdown but not original Markdown. This is
4908implied by pandoc's default `all_symbols_escapable`.
4910#### Extension: `lists_without_preceding_blankline` ####
4912Allow a list to occur right after a paragraph, with no intervening
4915#### Extension: `four_space_rule` ####
4917Selects the pandoc <= 2.0 behavior for parsing lists, so that
4918four spaces indent are needed for list item continuation
4921#### Extension: `spaced_reference_links` ####
4923Allow whitespace between the two components of a reference link,
4928#### Extension: `hard_line_breaks` ####
4930Causes all newlines within a paragraph to be interpreted as hard line
4931breaks instead of spaces.
4933#### Extension: `ignore_line_breaks` ####
4935Causes newlines within a paragraph to be ignored, rather than being
4936treated as spaces or as hard line breaks. This option is intended for
4937use with East Asian languages where spaces are not used between words,
4938but text is divided into lines for readability.
4940#### Extension: `east_asian_line_breaks` ####
4942Causes newlines within a paragraph to be ignored, rather than
4943being treated as spaces or as hard line breaks, when they occur
4944between two East Asian wide characters. This is a better choice
4945than `ignore_line_breaks` for texts that include a mix of East
4946Asian wide characters and other characters.
4948#### Extension: `emoji` ####
4950Parses textual emojis like `:smile:` as Unicode emoticons.
4952#### Extension: `tex_math_single_backslash` ####
4954Causes anything between `\(` and `\)` to be interpreted as inline
4955TeX math, and anything between `\[` and `\]` to be interpreted
4956as display TeX math. Note: a drawback of this extension is that
4957it precludes escaping `(` and `[`.
4959#### Extension: `tex_math_double_backslash` ####
4961Causes anything between `\\(` and `\\)` to be interpreted as inline
4962TeX math, and anything between `\\[` and `\\]` to be interpreted
4965#### Extension: `markdown_attribute` ####
4967By default, pandoc interprets material inside block-level tags as Markdown.
4968This extension changes the behavior so that Markdown is only parsed
4969inside block-level tags if the tags have the attribute `markdown=1`.
4971#### Extension: `mmd_title_block` ####
4973Enables a [MultiMarkdown] style title block at the top of
4974the document, for example:
4978 Date: September 1, 2008
4979 Comment: This is a sample mmd title block, with
4980 a field spanning multiple lines.
4982See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4983`yaml_metadata_block` is enabled, it will take precedence over
4986#### Extension: `abbreviations` ####
4988Parses PHP Markdown Extra abbreviation keys, like
4990 *[HTML]: Hypertext Markup Language
4992Note that the pandoc document model does not support
4993abbreviations, so if this extension is enabled, abbreviation keys are
4994simply skipped (as opposed to being parsed as paragraphs).
4996#### Extension: `autolink_bare_uris` ####
4998Makes all absolute URIs into links, even when not surrounded by
4999pointy braces `<...>`.
5001#### Extension: `mmd_link_attributes` ####
5003Parses multimarkdown style key-value attributes on link
5004and image references. This extension should not be confused with the
5005[`link_attributes`](#extension-link_attributes) extension.
5007 This is a reference ![image][ref] with multimarkdown attributes.
5009 [ref]: https://path.to/image "Image title" width=20px height=30px
5010 id=myId class="myClass1 myClass2"
5012#### Extension: `mmd_header_identifiers` ####
5014Parses multimarkdown style heading identifiers (in square brackets,
5015after the heading but before any trailing `#`s in an ATX heading).
5017#### Extension: `compact_definition_lists` ####
5019Activates the definition list syntax of pandoc 1.12.x and earlier.
5020This syntax differs from the one described above under [Definition lists]
5023 - No blank line is required between consecutive items of the
5025 - To get a "tight" or "compact" list, omit space between consecutive
5026 items; the space between a term and its definition does not affect
5028 - Lazy wrapping of paragraphs is not allowed: the entire definition must
5029 be indented four spaces.[^6]
5031[^6]: To see why laziness is incompatible with relaxing the requirement
5032 of a blank line between items, consider the following example:
5039 Is this a single list item with two definitions of "bar," the first of
5040 which is lazily wrapped, or two list items? To remove the ambiguity
5041 we must either disallow lazy wrapping or require a blank line between
5044#### Extension: `gutenberg` ####
5046Use [Project Gutenberg] conventions for `plain` output:
5047all-caps for strong emphasis, surround by underscores
5048for regular emphasis, add extra blank space around headings.
5050 [Project Gutenberg]: https://www.gutenberg.org
5054In addition to pandoc's extended Markdown, the following Markdown
5055variants are supported:
5057`markdown_phpextra` (PHP Markdown Extra)
5058: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5059 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5060 `header_attributes`, `link_attributes`, `abbreviations`,
5061 `shortcut_reference_links`, `spaced_reference_links`.
5063`markdown_github` (deprecated GitHub-Flavored Markdown)
5064: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5065 `gfm_auto_identifiers`, `backtick_code_blocks`,
5066 `autolink_bare_uris`, `space_in_atx_header`,
5067 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5068 `shortcut_reference_links`, `angle_brackets_escapable`,
5069 `lists_without_preceding_blankline`.
5071`markdown_mmd` (MultiMarkdown)
5072: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5073 `tex_math_double_backslash`, `intraword_underscores`,
5074 `mmd_title_block`, `footnotes`, `definition_lists`,
5075 `all_symbols_escapable`, `implicit_header_references`,
5076 `auto_identifiers`, `mmd_header_identifiers`,
5077 `shortcut_reference_links`, `implicit_figures`,
5078 `superscript`, `subscript`, `backtick_code_blocks`,
5079 `spaced_reference_links`, `raw_attribute`.
5081`markdown_strict` (Markdown.pl)
5082: `raw_html`, `shortcut_reference_links`,
5083 `spaced_reference_links`.
5085We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5086which is implemented as a set of extensions on `commonmark`).
5088Note, however, that `commonmark` and `gfm` have limited support
5089for extensions. Only those listed below (and `smart`,
5090`raw_tex`, and `hard_line_breaks`) will work. The extensions
5091can, however, all be individually disabled. Also, `raw_tex`
5092only affects `gfm` output, not input.
5094`gfm` (GitHub-Flavored Markdown)
5095: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5096 `gfm_auto_identifiers`, `backtick_code_blocks`,
5097 `autolink_bare_uris`, `space_in_atx_header`,
5098 `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5099 `shortcut_reference_links`, `angle_brackets_escapable`,
5100 `lists_without_preceding_blankline`.
5103# Producing slide shows with pandoc
5105You can use pandoc to produce an HTML + JavaScript slide presentation
5106that can be viewed via a web browser. There are five ways to do this,
5107using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5108You can also produce a PDF slide show using LaTeX [`beamer`], or
5109slides shows in Microsoft [PowerPoint] format.
5111Here's the Markdown source for a simple slide show, `habits.txt`:
5138 
5145To produce an HTML/JavaScript slide show, simply type
5147 pandoc -t FORMAT -s habits.txt -o habits.html
5149where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5151For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5152`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5153assumed to be available at the relative path `s5/default` (for S5), `slideous`
5154(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5155`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5156`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5157above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5160With all HTML slide formats, the `--self-contained` option can be used to
5161produce a single file that contains all of the data necessary to display the
5162slide show, including linked scripts, stylesheets, images, and videos.
5164To produce a PDF slide show using beamer, type
5166 pandoc -t beamer habits.txt -o habits.pdf
5168Note that a reveal.js slide show can also be converted to a PDF
5169by printing it to a file from the browser.
5171To produce a Powerpoint slide show, type
5173 pandoc habits.txt -o habits.pptx
5175## Structuring the slide show
5177By default, the *slide level* is the highest heading level in
5178the hierarchy that is followed immediately by content, and not another
5179heading, somewhere in the document. In the example above, level-1 headings
5180are always followed by level-2 headings, which are followed by content,
5181so the slide level is 2. This default can be overridden using
5182the `--slide-level` option.
5184The document is carved up into slides according to the following
5187 * A horizontal rule always starts a new slide.
5189 * A heading at the slide level always starts a new slide.
5191 * Headings *below* the slide level in the hierarchy create
5192 headings *within* a slide.
5194 * Headings *above* the slide level in the hierarchy create
5195 "title slides," which just contain the section title
5196 and help to break the slide show into sections.
5197 Non-slide content under these headings will be included
5198 on the title slide (for HTML slide shows) or in a
5199 subsequent slide with the same title (for beamer).
5201 * A title page is constructed automatically from the document's title
5202 block, if present. (In the case of beamer, this can be disabled
5203 by commenting out some lines in the default template.)
5205These rules are designed to support many different styles of slide show. If
5206you don't care about structuring your slides into sections and subsections,
5207you can just use level-1 headings for all each slide. (In that case, level-1
5208will be the slide level.) But you can also structure the slide show into
5209sections, as in the example above.
5211Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5212layout will be produced, with level-1 headings building horizontally
5213and level-2 headings building vertically. It is not recommended that
5214you use deeper nesting of section levels with reveal.js.
5218By default, these writers produce lists that display "all at once."
5219If you want your lists to display incrementally (one item at a time),
5220use the `-i` option. If you want a particular list to depart from the
5221default, put it in a `div` block with class `incremental` or
5222`nonincremental`. So, for example, using the `fenced div` syntax, the
5223following would be incremental regardless of the document default:
5241While using `incremental` and `nonincremental` divs are the
5242recommended method of setting incremental lists on a per-case basis,
5243an older method is also supported: putting lists inside a blockquote
5244will depart from the document default (that is, it will display
5245incrementally without the `-i` option and all at once with the `-i`
5251Both methods allow incremental and nonincremental lists to be mixed
5252in a single document.
5254Note: Neither the `-i/--incremental` option nor any of the
5255methods described here currently works for PowerPoint output.
5259You can add "pauses" within a slide by including a paragraph containing
5260three dots, separated by spaces:
5262 # Slide with a pause
5264 content before the pause
5268 content after the pause
5270Note: this feature is not yet implemented for PowerPoint output.
5272## Styling the slides
5274You can change the style of HTML slides by putting customized CSS files
5275in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5276or `$DATADIR/slideous` (for Slideous),
5277where `$DATADIR` is the user data directory (see `--data-dir`, above).
5278The originals may be found in pandoc's system data directory (generally
5279`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
5280files it does not find in the user data directory.
5282For dzslides, the CSS is included in the HTML file itself, and may
5285All [reveal.js configuration options] can be set through variables.
5286For example, themes can be used by setting the `theme` variable:
5290Or you can specify a custom stylesheet using the `--css` option.
5292To style beamer slides, you can specify a `theme`, `colortheme`,
5293`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
5295 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5297Note that heading attributes will turn into slide attributes
5298(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5299to style individual slides. In beamer, the only heading attribute
5300that affects slides is the `allowframebreaks` class, which sets the
5301`allowframebreaks` option, causing multiple slides to be created
5302if the content overfills the frame. This is recommended especially for
5305 # References {.allowframebreaks}
5309Speaker notes are supported in reveal.js and PowerPoint (pptx)
5310output. You can add notes to your Markdown document thus:
5316 - It can contain Markdown
5321To show the notes window in reveal.js, press `s` while viewing the
5322presentation. Speaker notes in PowerPoint will be available, as usual,
5323in handouts and presenter view.
5325Notes are not yet supported for other slide formats, but the notes
5326will not appear on the slides themselves.
5330To put material in side by side columns, you can use a native
5331div container with class `columns`, containing two or more div
5332containers with class `column` and a `width` attribute:
5334 :::::::::::::: {.columns}
5335 ::: {.column width="40%"}
5338 ::: {.column width="60%"}
5343## Frame attributes in beamer
5345Sometimes it is necessary to add the LaTeX `[fragile]` option to
5346a frame in beamer (for example, when using the `minted` environment).
5347This can be forced by adding the `fragile` class to the heading
5348introducing the slide:
5350 # Fragile slide {.fragile}
5352All of the other frame attributes described in Section 8.1 of
5353the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5354`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5355`shrink`, `standout`, `noframenumbering`.
5357## Background in reveal.js and beamer
5359Background images can be added to self-contained reveal.js slideshows and
5360to beamer slideshows.
5362For the same image on every slide, use the configuration
5363option `background-image` either in the YAML metadata block
5364or as a command-line variable. (There are no other options in
5365beamer and the rest of this section concerns reveal.js slideshows.)
5367For reveal.js, you can instead use the reveal.js-native option
5368`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5369and `parallaxBackgroundVertical` the same way and must also set
5370`parallaxBackgroundSize` to have your values take effect.
5372To set an image for a particular reveal.js slide, add
5373`{data-background-image="/path/to/image"}`
5374to the first slide-level heading on the slide (which may even be empty).
5376In reveal.js's overview mode, the parallaxBackgroundImage will show up
5377only on the first slide.
5379Other reveal.js background settings also work on individual slides, including
5380`data-background-size`, `data-background-repeat`, `data-background-color`,
5381`data-transition`, and `data-transition-speed`.
5383To add a background image to the automatically generated title slide, use the
5384`title-slide-attributes` variable in the YAML metadata block. It must contain
5385a map of attribute names and values.
5388documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5391For example in reveal.js:
5396parallaxBackgroundImage: /path/to/my/background_image.png
5397title-slide-attributes:
5398 data-background-image: /path/to/title_image.png
5399 data-background-size: contain
5404Slide 1 has background_image.png as its background.
5406## {data-background-image="/path/to/special_image.jpg"}
5408Slide 2 has a special image for its background, even though the heading has no content.
5411# Creating EPUBs with pandoc
5415EPUB metadata may be specified using the `--epub-metadata` option, but
5416if the source document is Markdown, it is better to use a [YAML metadata
5417block][Extension: `yaml_metadata_block`]. Here is an example:
5424 text: An investigation of metadata
5432 text: doi:10.234234.234/33
5434 rights: © 2007 John Smith, CC BY-NC
5439The following fields are recognized:
5442 ~ Either a string value or an object with fields `text` and
5443 `scheme`. Valid values for `scheme` are `ISBN-10`,
5444 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
5445 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
5446 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
5449 ~ Either a string value, or an object with fields `file-as` and
5450 `type`, or a list of such objects. Valid values for `type` are
5451 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
5454 ~ Either a string value, or an object with fields `role`, `file-as`,
5455 and `text`, or a list of such objects. Valid values for `role` are
5456 [MARC relators], but
5457 pandoc will attempt to translate the human-readable versions
5458 (like "author" and "editor") to the appropriate marc relators.
5461 ~ Same format as `creator`.
5464 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
5465 Pandoc will attempt to convert other common date formats.
5467`lang` (or legacy: `language`)
5468 ~ A string value in [BCP 47] format. Pandoc will default to the local
5469 language if nothing is specified.
5472 ~ A string value or a list of such values.
5493 ~ A string value (path to cover image).
5495`css` (or legacy: `stylesheet`)
5496 ~ A string value (path to CSS stylesheet).
5498`page-progression-direction`
5499 ~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
5500 attribute for the [`spine` element].
5503 ~ iBooks-specific metadata, with the following fields:
5505 - `version`: (string)
5506 - `specified-fonts`: `true`|`false` (default `false`)
5507 - `ipad-orientation-lock`: `portrait-only`|`landscape-only`
5508 - `iphone-orientation-lock`: `portrait-only`|`landscape-only`
5509 - `binding`: `true`|`false` (default `true`)
5510 - `scroll-axis`: `vertical`|`horizontal`|`default`
5512[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5513[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
5515## The `epub:type` attribute
5517For `epub3` output, you can mark up the heading that corresponds to an EPUB
5518chapter using the [`epub:type` attribute][epub-type]. For example, to set
5519the attribute to the value `prologue`, use this markdown:
5521 # My chapter {epub:type=prologue}
5523Which will result in:
5525 <body epub:type="frontmatter">
5526 <section epub:type="prologue">
5529Pandoc will output `<body epub:type="bodymatter">`, unless
5530you use one of the following values, in which case either
5531`frontmatter` or `backmatter` will be output.
5533`epub:type` of first section `epub:type` of body
5534---------------------------- ------------------
5537acknowledgments frontmatter
5538copyright-page frontmatter
5539dedication frontmatter
5543contributors frontmatter
5544other-credits frontmatter
5546revision-history frontmatter
5547titlepage frontmatter
5548halftitlepage frontmatter
5549seriespage frontmatter
5552seriespage frontmatter
5553titlepage frontmatter
5556bibliography backmatter
5559[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
5563By default, pandoc will download media referenced from any `<img>`, `<audio>`,
5564`<video>` or `<source>` element present in the generated EPUB,
5565and include it in the EPUB container, yielding a completely
5566self-contained EPUB. If you want to link to external media resources
5567instead, use raw HTML in your source and add `data-external="1"` to the tag
5568with the `src` attribute. For example:
5570 <audio controls="1">
5571 <source src="https://example.com/music/toccata.mp3"
5572 data-external="1" type="audio/mpeg">
5576# Creating Jupyter notebooks with pandoc
5578When creating a [Jupyter notebook], pandoc will try to infer the
5579notebook structure. Code blocks with the class `code` will be
5580taken as code cells, and intervening content will be taken as
5581Markdown cells. Attachments will automatically be created for
5582images in Markdown cells. Metadata will be taken from the
5583`jupyter` metadata field. For example:
5592 display_name: Python 2
5599 file_extension: ".py"
5600 mimetype: "text/x-python"
5602 nbconvert_exporter: "python"
5603 pygments_lexer: "ipython2"
5609**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5610bibendum felis dictum sodales.
5619from IPython.display import HTML
5622console.log("hello");
5630This image  will be
5631included as a cell attachment.
5634If you want to add cell attributes, group cells differently, or
5635add output to code cells, then you need to include divs to
5636indicate the structure. You can use either [fenced
5637divs][Extension: `fenced_divs`] or [native divs][Extension:
5638`native_divs`] for this. Here is an example:
5641:::::: {.cell .markdown}
5644**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
5645bibendum felis dictum sodales.
5648:::::: {.cell .code execution_count=1}
5653::: {.output .stream .stdout}
5660:::::: {.cell .code execution_count=2}
5662from IPython.display import HTML
5665console.log("hello");
5671::: {.output .execute_result execution_count=2}
5674console.log("hello");
5683If you include raw HTML or TeX in an output cell, use the
5684[raw attribute][Extension: `fenced_attribute`], as shown
5685in the last cell of the example above. Although pandoc can
5686process "bare" raw HTML and TeX, the result is often
5687interspersed raw elements and normal textual elements, and
5688in an output cell pandoc expects a single, connected raw
5689block. To avoid using raw HTML or TeX except when
5690marked explicitly using raw attributes, we recommend
5691specifying the extensions `-raw_html-raw_tex+raw_attribute` when
5692translating between Markdown and ipynb notebooks.
5694Note that options and extensions that affect reading and
5695writing of Markdown will also affect Markdown cells in ipynb
5696notebooks. For example, `--wrap=preserve` will preserve
5697soft line breaks in Markdown cells; `--atx-headers` will
5698cause ATX-style headings to be used; and `--preserve-tabs` will
5699prevent tabs from being turned to spaces.
5701# Syntax highlighting
5703Pandoc will automatically highlight syntax in [fenced code blocks] that
5704are marked with a language name. The Haskell library [skylighting] is
5705used for highlighting. Currently highlighting is supported only for
5706HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
5707that pandoc will recognize, type `pandoc --list-highlight-languages`.
5709The color scheme can be selected using the `--highlight-style` option.
5710The default color scheme is `pygments`, which imitates the default color
5711scheme used by the Python library pygments (though pygments is not actually
5712used to do the highlighting). To see a list of highlight styles,
5713type `pandoc --list-highlight-styles`.
5715If you are not satisfied with the predefined styles, you can
5716use `--print-highlight-style` to generate a JSON `.theme` file which
5717can be modified and used as the argument to `--highlight-style`. To
5718get a JSON version of the `pygments` style, for example:
5720 pandoc --print-highlight-style pygments > my.theme
5722Then edit `my.theme` and use it like this:
5724 pandoc --highlight-style my.theme
5726If you are not satisfied with the built-in highlighting, or you
5727want highlight a language that isn't supported, you can use the
5728`--syntax-definition` option to load a [KDE-style XML syntax definition
5729file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
5730Before writing your own, have a look at KDE's [repository of syntax
5731definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
5733To disable highlighting, use the `--no-highlight` option.
5735[skylighting]: https://github.com/jgm/skylighting
5739Custom styles can be used in the docx and ICML formats.
5743By default, pandoc's docx and ICML output applies a predefined set of styles
5744for blocks such as paragraphs and block quotes, and uses largely default
5745formatting (italics, bold) for inlines. This will work for most
5746purposes, especially alongside a `reference.docx` file. However, if you
5747need to apply your own styles to blocks, or match a preexisting set of
5748styles, pandoc allows you to define custom styles for blocks and text
5749using `div`s and `span`s, respectively.
5751If you define a `div` or `span` with the attribute `custom-style`,
5752pandoc will apply your specified style to the contained elements (with
5753the exception of elements whose function depends on a style, like
5754headings, code blocks, block quotes, or links). So, for example, using
5755the `bracketed_spans` syntax,
5757 [Get out]{custom-style="Emphatically"}, he said.
5759would produce a docx file with "Get out" styled with character
5760style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5762 Dickinson starts the poem simply:
5764 ::: {custom-style="Poetry"}
5765 | A Bird came down the Walk---
5766 | He did not know I saw---
5769would style the two contained lines with the `Poetry` paragraph style.
5771For docx output, styles will be defined in the output file as inheriting
5772from normal text, if the styles are not yet in your reference.docx.
5773If they are already defined, pandoc will not alter the definition.
5775This feature allows for greatest customization in conjunction with
5776[pandoc filters]. If you want all paragraphs after block quotes to be
5777indented, you can write a filter to apply the styles necessary. If you
5778want all italics to be transformed to the `Emphasis` character style
5779(perhaps to change their color), you can write a filter which will
5780transform all italicized inlines to inlines within an `Emphasis`
5783For docx output, you don't need to enable any extensions for
5784custom styles to work.
5786[pandoc filters]: https://pandoc.org/filters.html
5790The docx reader, by default, only reads those styles that it can
5791convert into pandoc elements, either by direct conversion or
5792interpreting the derivation of the input document's styles.
5794By enabling the [`styles` extension](#ext-styles) in the docx reader
5795(`-f docx+styles`), you can produce output that maintains the styles
5796of the input document, using the `custom-style` class. Paragraph
5797styles are interpreted as divs, while character styles are interpreted
5800For example, using the `custom-style-reference.docx` file in the test
5801directory, we have the following different outputs:
5803Without the `+styles` extension:
5805 $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
5808 This is text with an *emphasized* text style. And this is text with a
5809 **strengthened** text style.
5811 > Here is a styled paragraph that inherits from Block Text.
5813And with the extension:
5815 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5817 ::: {custom-style="First Paragraph"}
5821 ::: {custom-style="Body Text"}
5822 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5823 And this is text with a [strengthened]{custom-style="Strengthened"}
5827 ::: {custom-style="My Block Style"}
5828 > Here is a styled paragraph that inherits from Block Text.
5831With these custom styles, you can use your input document as a
5832reference-doc while creating docx output (see below), and maintain the
5833same styles in your input and output files.
5837Pandoc can be extended with custom writers written in [Lua]. (Pandoc
5838includes a Lua interpreter, so Lua need not be installed separately.)
5840To use a custom writer, simply specify the path to the Lua script
5841in place of the output format. For example:
5843 pandoc -t data/sample.lua
5845Creating a custom writer requires writing a Lua function for each
5846possible element in a pandoc document. To get a documented example
5847which you can modify according to your needs, do
5849 pandoc --print-default-data-file sample.lua
5851Note that custom writers have no default template. If you want
5852to use `--standalone` with a custom writer, you will need to
5853specify a template manually using `--template` or add a new
5854default template with the name
5855`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5856subdirectory of your user data directory (see [Templates]).
5858[Lua]: https://www.lua.org
5862If you use pandoc to convert user-contributed content in a web
5863application, here are some things to keep in mind:
58651. Although pandoc itself will not create or modify any files other
5866 than those you explicitly ask it create (with the exception
5867 of temporary files used in producing PDFs), a filter or custom
5868 writer could in principle do anything on your file system. Please
5869 audit filters and custom writers very carefully before using them.
58712. If your application uses pandoc as a Haskell library (rather than
5872 shelling out to the executable), it is possible to use it in a mode
5873 that fully isolates pandoc from your file system, by running the
5874 pandoc operations in the `PandocPure` monad. See the document
5875 [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
58783. Pandoc's parsers can exhibit pathological performance on some
5879 corner cases. It is wise to put any pandoc operations under
5880 a timeout, to avoid DOS attacks that exploit these issues.
5881 If you are using the pandoc executable, you can add the
5882 command line options `+RTS -M512M -RTS` (for example) to limit
5883 the heap size to 512MB.
58854. The HTML generated by pandoc is not guaranteed to be safe.
5886 If `raw_html` is enabled for the Markdown input, users can
5887 inject arbitrary HTML. Even if `raw_html` is disabled,
5888 users can include dangerous content in attributes for
5889 headings, spans, and code blocks. To be safe, you should
5890 run all the generated HTML through an HTML sanitizer.
5894Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
5895under the [GPL], version 2 or greater. This software carries no
5896warranty of any kind. (See COPYRIGHT for full copyright and
5897warranty notices.) For a full list of contributors, see the file
5898AUTHORS.md in the pandoc source code.
5900[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5901[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