—email-obfuscation=none|javascript|references Specify a method for obfuscating mailto: links in HTML documents. none leaves mailto: links as they are. javascript obfuscates them using JavaScript. references obfuscates them by printing their letters as decimal or hexadecimal character references. The default is none.

—id-prefix=STRING Specify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.

-T STRING, —title-prefix=STRING Specify STRING as a prefix at the beginning of the title that appears in the HTML header (but not in the title as it appears at the beginning of the HTML body). Implies —standalone.

-c URL, —css=URL Link to a CSS style sheet. This option can be used repeatedly to include multiple files. They will be included in the order specified.

A stylesheet is required for generating EPUB. If none is provided using this option (or the css or stylesheet metadata fields), pandoc will look for a file epub.css in the user data directory (see —data-dir). If it is not found there, sensible defaults will be used.

—reference-doc=FILE Use the specified file as a style reference in producing a docx or ODT file.

Docx For best results, the reference docx should be a modified version of a docx file produced using pandoc. The contents of the reference docx are ignored, but its stylesheets and document properties (including margins, page size, header, and footer) are used in the new docx. If no reference docx is specified on the command line, pandoc will look for a file reference.docx in the user data directory (see —data-dir). If this is not found either, sensible defaults will be used.

To produce a custom reference.docx, first get a copy of the default reference.docx: pandoc -o custom-reference.docx —print-default-data-file reference.docx. Then open custom-reference.docx in Word, modify the styles as you wish, and save the file. For best results, do not make changes to this file other than modifying the styles used by pandoc:

Paragraph styles:

Normal Body Text First Paragraph Compact Title Subtitle Author Date Abstract Bibliography Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Heading 6 Heading 7 Heading 8 Heading 9 Block Text Footnote Text Definition Term Definition Caption Table Caption Image Caption Figure Captioned Figure TOC Heading Character styles:

Default Paragraph Font Body Text Char Verbatim Char Footnote Reference Hyperlink Section Number Table style:

Table ODT For best results, the reference ODT should be a modified version of an ODT produced using pandoc. The contents of the reference ODT are ignored, but its stylesheets are used in the new ODT. If no reference ODT is specified on the command line, pandoc will look for a file reference.odt in the user data directory (see —data-dir). If this is not found either, sensible defaults will be used.

To produce a custom reference.odt, first get a copy of the default reference.odt: pandoc -o custom-reference.odt —print-default-data-file reference.odt. Then open custom-reference.odt in LibreOffice, modify the styles as you wish, and save the file.

PowerPoint Templates included with Microsoft PowerPoint 2013 (either with .pptx or .potx extension) are known to work, as are most templates derived from these.

The specific requirement is that the template should contain layouts with the following names (as seen within PowerPoint):

Title Slide Title and Content Section Header Two Content Comparison Content with Caption Blank For each name, the first layout found with that name will be used. If no layout is found with one of the names, pandoc will output a warning and use the layout with that name from the default reference doc instead. (How these layouts are used is described in PowerPoint layout choice.)

All templates included with a recent version of MS PowerPoint will fit these criteria. (You can click on Layout under the Home menu to check.)

You can also modify the default reference.pptx: first run pandoc -o custom-reference.pptx —print-default-data-file reference.pptx, and then modify custom-reference.pptx in MS PowerPoint (pandoc will use the layouts with the names listed above).

—epub-cover-image=FILE Use the specified image as the EPUB cover. It is recommended that the image be less than 1000px in width and height. Note that in a Markdown source document you can also specify cover-image in a YAML metadata block (see EPUB Metadata, below).

—epub-metadata=FILE Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements. For example:

Creative Commons es-AR By default, pandoc will include the following metadata elements: (from the document title), (from the document authors), (from the document date, which should be in ISO 8601 format), (from the lang variable, or, if is not set, the locale), and (a randomly generated UUID). Any of these may be overridden by elements in the metadata file.

Note: if the source document is Markdown, a YAML metadata block in the document can be used instead. See below under EPUB Metadata.

—epub-embed-font=FILE Embed the specified font in the EPUB. This option can be repeated to embed multiple fonts. Wildcards can also be used: for example, DejaVuSans-*.ttf. However, if you use wildcards on the command line, be sure to escape them or put the whole filename in single quotes, to prevent them from being interpreted by the shell. To use the embedded fonts, you will need to add declarations like the following to your CSS (see —css):

@font-face { font-family: DejaVuSans; font-style: normal; font-weight: normal; src:url(“DejaVuSans-Regular.ttf”); } @font-face { font-family: DejaVuSans; font-style: normal; font-weight: bold; src:url(“DejaVuSans-Bold.ttf”); } @font-face { font-family: DejaVuSans; font-style: italic; font-weight: normal; src:url(“DejaVuSans-Oblique.ttf”); } @font-face { font-family: DejaVuSans; font-style: italic; font-weight: bold; src:url(“DejaVuSans-BoldOblique.ttf”); } body { font-family: “DejaVuSans”; } —epub-chapter-level=NUMBER Specify the heading level at which to split the EPUB into separate “chapter” files. The default is to split into chapters at level-1 headings. This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users. Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.

—epub-subdirectory=DIRNAME Specify the subdirectory in the OCF container that is to hold the EPUB-specific contents. The default is EPUB. To put the EPUB contents in the top level, use an empty string.

—ipynb-output=all|none|best Determines how ipynb output cells are treated. all means that all of the data formats included in the original are preserved. none means that the contents of data cells are omitted. best causes pandoc to try to pick the richest data block in each output cell that is compatible with the output format. The default is best.

—pdf-engine=PROGRAM Use the specified engine when producing PDF output. Valid values are pdflatex, lualatex, xelatex, latexmk, tectonic, wkhtmltopdf, weasyprint, pagedjs-cli, prince, context, and pdfroff. If the engine is not in your PATH, the full path of the engine may be specified here. If this option is not specified, pandoc uses the following defaults depending on the output format specified using -t/—to:

-t latex or none: pdflatex (other options: xelatex, lualatex, tectonic, latexmk) -t context: context -t html: wkhtmltopdf (other options: prince, weasyprint, pagedjs-cli; see print-css.rocks for a good introduction to PDF generation from HTML/CSS.) -t ms: pdfroff —pdf-engine-opt=STRING Use the given string as a command-line argument to the pdf-engine. For example, to use a persistent directory foo for latexmk’s auxiliary files, use —pdf-engine-opt=-outdir=foo. Note that no check for duplicate options is done.

Citation rendering -C, —citeproc Process the citations in the file, replacing them with rendered citations and adding a bibliography. Citation processing will not take place unless bibliographic data is supplied, either through an external file specified using the —bibliography option or the bibliography field in metadata, or via a references section in metadata containing a list of citations in CSL YAML format with Markdown formatting. The style is controlled by a CSL stylesheet specified using the —csl option or the csl field in metadata. (If no stylesheet is specified, the chicago-author-date style will be used by default.) The citation processing transformation may be applied before or after filters or Lua filters (see —filter, —lua-filter): these transformations are applied in the order they appear on the command line. For more information, see the section on Citations.

—bibliography=FILE Set the bibliography field in the document’s metadata to FILE, overriding any value set in the metadata. If you supply this argument multiple times, each FILE will be added to bibliography. If FILE is a URL, it will be fetched via HTTP. If FILE is not found relative to the working directory, it will be sought in the resource path (see —resource-path).

—csl=FILE Set the csl field in the document’s metadata to FILE, overriding any value set in the metadata. (This is equivalent to —metadata csl=FILE.) If FILE is a URL, it will be fetched via HTTP. If FILE is not found relative to the working directory, it will be sought in the resource path (see —resource-path) and finally in the csl subdirectory of the pandoc user data directory.

—citation-abbreviations=FILE Set the citation-abbreviations field in the document’s metadata to FILE, overriding any value set in the metadata. (This is equivalent to —metadata citation-abbreviations=FILE.) If FILE is a URL, it will be fetched via HTTP. If FILE is not found relative to the working directory, it will be sought in the resource path (see —resource-path) and finally in the csl subdirectory of the pandoc user data directory.

—natbib Use natbib for citations in LaTeX output. This option is not for use with the —citeproc option or with PDF output. It is intended for use in producing a LaTeX file that can be processed with bibtex.

—biblatex Use biblatex for citations in LaTeX output. This option is not for use with the —citeproc option or with PDF output. It is intended for use in producing a LaTeX file that can be processed with bibtex or biber.

Math rendering in HTML The default is to render TeX math as far as possible using Unicode characters. Formulas are put inside a span with class=”math”, so that they may be styled differently from the surrounding text if needed. However, this gives acceptable results only for basic math, usually you will want to use —mathjax or another of the following options.

—mathjax[=URL] Use MathJax to display embedded TeX math in HTML output. TeX math will be put between (…) (for inline math) or […] (for display math) and wrapped in tags with class math. Then the MathJax JavaScript will render it. The URL should point to the MathJax.js load script. If a URL is not provided, a link to the Cloudflare CDN will be inserted.

—mathml Convert TeX math to MathML (in epub3, docbook4, docbook5, jats, html4 and html5). This is the default in odt output. Note that currently only Firefox and Safari (and select e-book readers) natively support MathML.

—webtex[=URL] Convert TeX formulas to tags that link to an external script that converts formulas to images. The formula will be URL-encoded and concatenated with the URL provided. For SVG images you can for example use —webtex https://latex.codecogs.com/svg.latex?. If no URL is specified, the CodeCogs URL generating PNGs will be used (https://latex.codecogs.com/png.latex?). Note: the —webtex option will affect Markdown output as well as HTML, which is useful if you’re targeting a version of Markdown without native math support.

—katex[=URL] Use KaTeX to display embedded TeX math in HTML output. The URL is the base URL for the KaTeX library. That directory should contain a katex.min.js and a katex.min.css file. If a URL is not provided, a link to the KaTeX CDN will be inserted.

—gladtex Enclose TeX math in tags in HTML output. The resulting HTML can then be processed by GladTeX to produce SVG images of the typeset formulas and an HTML file with these images embedded.

pandoc -s —gladtex input.md -o myfile.htex gladtex -d image_dir myfile.htex

Options for wrapper scripts —dump-args Print information about command-line arguments to stdout, then exit. This option is intended primarily for use in wrapper scripts. The first line of output contains the name of the output file specified with the -o option, or - (for stdout) if no output file was specified. The remaining lines contain the command-line arguments, one per line, in the order they appear. These do not include regular pandoc options and their arguments, but do include any options appearing after a — separator at the end of the line.

—ignore-args Ignore command-line arguments (for use in wrapper scripts). Regular pandoc options are not ignored. Thus, for example,

pandoc —ignore-args -o foo.html -s foo.txt — -e latin1 is equivalent to

pandoc -o foo.html -s Exit codes If pandoc completes successfully, it will return exit code 0. Nonzero exit codes have the following meanings:

Code Error 1 PandocIOError 3 PandocFailOnWarningError 4 PandocAppError 5 PandocTemplateError 6 PandocOptionError 21 PandocUnknownReaderError 22 PandocUnknownWriterError 23 PandocUnsupportedExtensionError 24 PandocCiteprocError 25 PandocBibliographyError 31 PandocEpubSubdirectoryError 43 PandocPDFError 44 PandocXMLError 47 PandocPDFProgramNotFoundError 61 PandocHttpError 62 PandocShouldNeverHappenError 63 PandocSomeError 64 PandocParseError 65 PandocParsecError 66 PandocMakePDFError 67 PandocSyntaxMapError 83 PandocFilterError 84 PandocLuaError 91 PandocMacroLoop 92 PandocUTF8DecodingError 93 PandocIpynbDecodingError 94 PandocUnsupportedCharsetError 97 PandocCouldNotFindDataFileError 98 PandocCouldNotFindMetadataFileError 99 PandocResourceNotFound Defaults files The —defaults option may be used to specify a package of options, in the form of a YAML file.

Fields that are omitted will just have their regular default values. So a defaults file can be as simple as one line:

verbosity: INFO In fields that expect a file path (or list of file paths), the following syntax may be used to interpolate environment variables:

csl: ${HOME}/mycsldir/special.csl ${USERDATA} may also be used; this will always resolve to the user data directory that is current when the defaults file is parsed, regardless of the setting of the environment variable USERDATA.

${.} will resolve to the directory containing the defaults file itself. This allows you to refer to resources contained in that directory:

epub-cover-image: ${.}/cover.jpg epub-metadata: ${.}/meta.xml resource-path:

Defaults files can be placed in the defaults subdirectory of the user data directory and used from any directory. For example, one could create a file specifying defaults for writing letters, save it as letter.yaml in the defaults subdirectory of the user data directory, and then invoke these defaults from any directory using pandoc —defaults letter or pandoc -dletter.

When multiple defaults are used, their contents will be combined.

Note that, where command-line arguments may be repeated (—metadata-file, —css, —include-in-header, —include-before-body, —include-after-body, —variable, —metadata, —syntax-definition), the values specified on the command line will combine with values specified in the defaults file, rather than replacing them.

The following tables show the mapping between the command line and defaults file entries.

command line defaults file foo.md input-file: foo.md foo.md bar.md

input-files:

General options command line defaults file —from markdown+emoji from: markdown+emoji reader: markdown+emoji —to markdown+hard_line_breaks to: markdown+hard_line_breaks writer: markdown+hard_line_breaks —output foo.pdf output-file: foo.pdf —output - output-file: —data-dir dir data-dir: dir —defaults file defaults:

verbosity can have the values ERROR, WARNING, or INFO.

Reader options command line defaults file —shift-heading-level-by -1 shift-heading-level-by: -1 —indented-code-classes python indented-code-classes:

filters:

Filters will be assumed to be Lua filters if they have the .lua extension, and JSON filters otherwise. But the filter type can also be specified explicitly, as shown. Filters are run in the order specified. To include the built-in citeproc filter, use either citeproc or {type: citeproc}.

General writer options command line defaults file —standalone standalone: true —template letter template: letter —variable key=val \ —variable key2 variables: key: val key2: true —eol nl eol: nl —dpi 300 dpi: 300 —wrap 60 wrap: 60 —columns 72 columns: 72 —table-of-contents table-of-contents: true —toc toc: true —toc-depth 3 toc-depth: 3 —strip-comments strip-comments: true —no-highlight highlight-style: null —highlight-style kate highlight-style: kate —syntax-definition mylang.xml syntax-definitions:

If you need control over when the citeproc processing is done relative to other filters, you should instead use citeproc in the list of filters (see above).

Math rendering in HTML command line defaults file —mathjax html-math-method: method: mathjax —mathml html-math-method: method: mathml —webtex html-math-method: method: webtex —katex html-math-method: method: katex —gladtex html-math-method: method: gladtex In addition to the values listed above, method can have the value plain.

If the command line option accepts a URL argument, an url: field can be added to html-math-method:.

Options for wrapper scripts command line defaults file —dump-args dump-args: true —ignore-args ignore-args: true Templates When the -s/—standalone option is used, pandoc uses a template to add header and footer material that is needed for a self-standing document. To see the default template that is used, just type

pandoc -D FORMAT where FORMAT is the name of the output format. A custom template can be specified using the —template option. You can also override the system default templates for a given output format FORMAT by putting a file templates/default.FORMAT in the user data directory (see —data-dir, above). Exceptions:

For odt output, customize the default.opendocument template. For pdf output, customize the default.latex template (or the default.context template, if you use -t context, or the default.ms template, if you use -t ms, or the default.html template, if you use -t html). docx and pptx have no template (however, you can use —reference-doc to customize the output). Templates contain variables, which allow for the inclusion of arbitrary information at any point in the file. They may be set at the command line using the -V/—variable option. If a variable is not set, pandoc will look for the key in the document’s metadata, which can be set using either YAML metadata blocks or with the -M/—metadata option. In addition, some variables are given default values by pandoc. See Variables below for a list of variables used in pandoc’s default templates.

If you use custom templates, you may need to revise them as pandoc changes. We recommend tracking the changes in the default templates, and modifying your custom templates accordingly. An easy way to do this is to fork the pandoc-templates repository and merge in changes after each pandoc release.

Template syntax Comments Anything between the sequence $— and the end of the line will be treated as a comment and omitted from the output.

Delimiters To mark variables and control structures in the template, either $…$ or ${…} may be used as delimiters. The styles may also be mixed in the same template, but the opening and closing delimiter must match in each case. The opening delimiter may be followed by one or more spaces or tabs, which will be ignored. The closing delimiter may be followed by one or more spaces or tabs, which will be ignored.

To include a literal $ in the document, use $$.

Interpolated variables A slot for an interpolated variable is a variable name surrounded by matched delimiters. Variable names must begin with a letter and can contain letters, numbers, _, -, and .. The keywords it, if, else, endif, for, sep, and endfor may not be used as variable names. Examples:

$foo$ $foo.bar.baz$ $foo_bar.baz-bim$ $ foo $ ${foo} ${foo.bar.baz} ${foo_bar.baz-bim} ${ foo } Variable names with periods are used to get at structured variable values. So, for example, employee.salary will return the value of the salary field of the object that is the value of the employee field.

If the value of the variable is simple value, it will be rendered verbatim. (Note that no escaping is done; the assumption is that the calling program will escape the strings appropriately for the output format.) If the value is a list, the values will be concatenated. If the value is a map, the string true will be rendered. Every other value will be rendered as the empty string. Conditionals A conditional begins with if(variable) (enclosed in matched delimiters) and ends with endif (enclosed in matched delimiters). It may optionally contain an else (enclosed in matched delimiters). The if section is used if variable has a non-empty value, otherwise the else section is used (if present). Examples:

$if(foo)$bar$endif$

$if(foo)$ $foo$ $endif$

$if(foo)$ part one $else$ part two $endif$

${if(foo)}bar${endif}

${if(foo)} ${foo} ${endif}

${if(foo)} ${ foo.bar } ${else} no foo! ${endif} The keyword elseif may be used to simplify complex nested conditionals:

$if(foo)$ XXX $elseif(bar)$ YYY $else$ ZZZ $endif$ For loops A for loop begins with for(variable) (enclosed in matched delimiters) and ends with endfor (enclosed in matched delimiters.

If variable is an array, the material inside the loop will be evaluated repeatedly, with variable being set to each value of the array in turn, and concatenated. If variable is a map, the material inside will be set to the map. If the value of the associated variable is not an array or a map, a single iteration will be performed on its value. Examples:

$for(foo)foofoofoosep$, $endfor$

$for(foo)$

${ for(foo.bar) }

$for(mymap)$ $it.name$: $it.office$ $endfor$ You may optionally specify a separator between consecutive values using sep (enclosed in matched delimiters). The material between sep and the endfor is the separator.

${ for(foo) }${ foo }${ sep }, ${ endfor } Instead of using variable inside the loop, the special anaphoric keyword it may be used.

${ for(foo.bar) }

${ styles() } Partials will be sought in the directory containing the main template. The file name will be assumed to have the same extension as the main template if it lacks an extension. When calling the partial, the full name including file extension can also be used:

${ styles.html() } (If a partial is not found in the directory of the template and the template path is given as a relative path, it will also be sought in the templates subdirectory of the user data directory.)

Partials may optionally be applied to variables using a colon:

${ date:fancy() }

${ articles:bibentry() } If articles is an array, this will iterate over its values, applying the partial bibentry() to each one. So the second example above is equivalent to

${ for(articles) } ${ it:bibentry() } ${ endfor } Note that the anaphoric keyword it must be used when iterating over partials. In the above examples, the bibentry partial should contain it.title (and so on) instead of articles.title.

Final newlines are omitted from included partials.

Partials may include other partials.

A separator between values of an array may be specified in square brackets, immediately after the variable name or partial:

${months[, ]}$

${articles:bibentry()[; ]$ The separator in this case is literal and (unlike with sep in an explicit for loop) cannot contain interpolated variables or other template directives.

Nesting To ensure that content is “nested,” that is, subsequent lines indented, use the ^ directive:

$item.number$ $^$$item.description$ ($item.price$) In this example, if item.description has multiple lines, they will all be indented to line up with the first line:

00123 A fine bottle of 18-year old Oban whiskey. ($148) To nest multiple lines to the same level, align them with the ^ directive in the template. For example:

$item.number$ $^$$item.description$ ($item.price$) (Available til $item.sellby$.) will produce

00123 A fine bottle of 18-year old Oban whiskey. ($148) (Available til March 30, 2020.) If a variable occurs by itself on a line, preceded by whitespace and not followed by further text or directives on the same line, and the variable’s value contains multiple lines, it will be nested automatically.

Breakable spaces Normally, spaces in the template itself (as opposed to values of the interpolated variables) are not breakable, but they can be made breakable in part of the template by using the ~ keyword (ended with another ~).

$~$This long line may break if the document is rendered with a short line length.$~$ Pipes A pipe transforms the value of a variable or partial. Pipes are specified using a slash (/) between the variable name (or partial) and the pipe name. Example:

$for(name)$ $name/uppercase$ $endfor$

$for(metadata/pairs)$

$employee:name()/uppercase$ Pipes may be chained:

$for(employees/pairs)$ $it.key/alpha/uppercase$. $it.name$ $endfor$ Some pipes take parameters:

|———————————|——————| $for(employee)$ $it.name.first/uppercase/left 20 “| “$$it.name.salary/right 10 “ | “ “ |”$ $endfor$ |———————————|——————| Currently the following pipes are predefined:

pairs: Converts a map or array to an array of maps, each with key and value fields. If the original value was an array, the key will be the array index, starting with 1.

uppercase: Converts text to uppercase.

lowercase: Converts text to lowercase.

length: Returns the length of the value: number of characters for a textual value, number of elements for a map or array.

reverse: Reverses a textual value or array, and has no effect on other values.

first: Returns the first value of an array, if applied to a non-empty array; otherwise returns the original value.

last: Returns the last value of an array, if applied to a non-empty array; otherwise returns the original value.

rest: Returns all but the first value of an array, if applied to a non-empty array; otherwise returns the original value.

allbutlast: Returns all but the last value of an array, if applied to a non-empty array; otherwise returns the original value.

chomp: Removes trailing newlines (and breakable space).

nowrap: Disables line wrapping on breakable spaces.

alpha: Converts textual values that can be read as an integer into lowercase alphabetic characters a..z (mod 26). This can be used to get lettered enumeration from array indices. To get uppercase letters, chain with uppercase.

roman: Converts textual values that can be read as an integer into lowercase roman numerials. This can be used to get lettered enumeration from array indices. To get uppercase roman, chain with uppercase.

left n “leftborder” “rightborder”: Renders a textual value in a block of width n, aligned to the left, with an optional left and right border. Has no effect on other values. This can be used to align material in tables. Widths are positive integers indicating the number of characters. Borders are strings inside double quotes; literal “ and \ characters must be backslash-escaped.

right n “leftborder” “rightborder”: Renders a textual value in a block of width n, aligned to the right, and has no effect on other values.

center n “leftborder” “rightborder”: Renders a textual value in a block of width n, aligned to the center, and has no effect on other values.

Variables Metadata variables title, author, date allow identification of basic aspects of the document. Included in PDF metadata through LaTeX and ConTeXt. These can be set through a pandoc title block, which allows for multiple authors, or through a YAML metadata block:

author:

subtitle document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx documents abstract document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx documents abstract-title title of abstract, currently used only in HTML and EPUB. This will be set automatically to a localized value, depending on lang, but can be manually overridden. keywords list of keywords to be included in HTML, PDF, ODT, pptx, docx and AsciiDoc metadata; repeat as for author, above subject document subject, included in ODT, PDF, docx, EPUB, and pptx metadata description document description, included in ODT, docx and pptx metadata. Some applications show this as Comments metadata. category document category, included in docx and pptx metadata Additionally, any root-level string metadata, not included in ODT, docx or pptx metadata is added as a custom property. The following YAML metadata block for instance:

title: ‘This is the title’ subtitle: “This is the subtitle” author:

Author Two description: | This is a long description.

It consists of two paragraphs … will include title, author and description as standard document properties and subtitle as a custom property when converting to docx, ODT or pptx.

Language variables lang identifies the main language of the document using IETF language tags (following the BCP 47 standard), such as en or en-GB. The Language subtag lookup tool can look up or verify these tags. This affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.

Use native pandoc Divs and Spans with the lang attribute to switch the language:

lang: en-GB …

Text in the main document language (British English).

::: {lang=fr-CA}

Cette citation est écrite en français canadien. :::

More text in English. [‘Zitat auf Deutsch.’]{lang=de} dir the base script direction, either rtl (right-to-left) or ltr (left-to-right).

For bidirectional documents, native pandoc spans and divs with the dir attribute (value rtl or ltr) can be used to override the base direction in some output formats. This may not always be necessary if the final renderer (e.g. the browser, when generating HTML) supports the Unicode Bidirectional Algorithm.

When using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use —pdf-engine=xelatex).

Variables for HTML document-css Enables inclusion of most of the CSS in the styles.html partial (have a look with pandoc —print-default-data-file=templates/styles.html). Unless you use —css, this variable is set to true by default. You can disable it with e.g. pandoc -M document-css=false. mainfont sets the CSS font-family property on the html element. fontsize sets the base CSS font-size, which you’d usually set to e.g. 20px, but it also accepts pt (12pt = 16px in most browsers). fontcolor sets the CSS color property on the html element. linkcolor sets the CSS color property on all links. monofont sets the CSS font-family property on code elements. monobackgroundcolor sets the CSS background-color property on code elements and adds extra padding. linestretch sets the CSS line-height property on the html element, which is preferred to be unitless. backgroundcolor sets the CSS background-color property on the html element. margin-left, margin-right, margin-top, margin-bottom sets the corresponding CSS padding properties on the body element. To override or extend some CSS for just one document, include for example:

header-includes: |

Variables for HTML math classoption when using KaTeX, you can render display math equations flush left using YAML metadata or with -M classoption=fleqn. Variables for HTML slides These affect HTML output when [producing slide shows with pandoc].

institute author affiliations: can be a list when there are multiple authors revealjs-url base URL for reveal.js documents (defaults to https://unpkg.com/reveal.js@^4/) s5-url base URL for S5 documents (defaults to s5/default) slidy-url base URL for Slidy documents (defaults to https://www.w3.org/Talks/Tools/Slidy2) slideous-url base URL for Slideous documents (defaults to slideous) title-slide-attributes additional attributes for the title slide of reveal.js slide shows. See [background in reveal.js and beamer] for an example. All reveal.js configuration options are available as variables. To turn off boolean flags that default to true in reveal.js, use 0.

Variables for Beamer slides These variables change the appearance of PDF slides using beamer.

aspectratio slide aspect ratio (43 for 4:3 [default], 169 for 16:9, 1610 for 16:10, 149 for 14:9, 141 for 1.41:1, 54 for 5:4, 32 for 3:2) `beameroption add extra beamer option with \setbeameroption{} institute author affiliations: can be a list when there are multiple authors logo logo image for slides navigation controls navigation symbols (default is empty for no navigation symbols; other valid values are frame, vertical, and horizontal) section-titles enables “title pages” for new sections (default is true) theme, colortheme, fonttheme, innertheme, outertheme beamer themes themeoptions options for LaTeX beamer themes (a list). titlegraphic image for title slide Variables for PowerPoint These variables control the visual aspects of a slide show that are not easily controlled via templates.

monofont font to use for code. Variables for LaTeX Pandoc uses these variables when creating a PDF with a LaTeX engine.

Layout block-headings make \paragraph and \subparagraph (fourth- and fifth-level headings, or fifth- and sixth-level with book classes) free-standing rather than run-in; requires further formatting to distinguish from \subsubsection (third- or fourth-level headings). Instead of using this option, KOMA-Script can adjust headings more extensively:

documentclass: scrartcl header-includes: | \RedeclareSectionCommand[ beforeskip=-10pt plus -2pt minus -1pt, afterskip=1sp plus -1sp minus 1sp, font=\normalfont\itshape]{paragraph} \RedeclareSectionCommand[ beforeskip=-10pt plus -2pt minus -1pt, afterskip=1sp plus -1sp minus 1sp, font=\normalfont\scshape, indent=0pt]{subparagraph} … classoption option for document class, e.g. oneside; repeat for multiple options:

classoption:

geometry:

hyperrefoptions:

fontfamily: libertinus fontfamilyoptions:

mainfont: TeX Gyre Pagella mainfontoptions:

biblatexoptions list of options for biblatex biblio-style bibliography style, when used with —natbib and —biblatex. biblio-title bibliography title, when used with —natbib and —biblatex. bibliography bibliography to use for resolving references natbiboptions list of options for natbib Variables for ConTeXt Pandoc uses these variables when creating a PDF with ConTeXt.

fontsize font size for body text (e.g. 10pt, 12pt) headertext, footertext text to be placed in running header or footer (see ConTeXt Headers and Footers); repeat up to four times for different placement indenting controls indentation of paragraphs, e.g. yes,small,next (see ConTeXt Indentation); repeat for multiple options interlinespace adjusts line spacing, e.g. 4ex (using setupinterlinespace); repeat for multiple options layout options for page margins and text arrangement (see ConTeXt Layout); repeat for multiple options linkcolor, contrastcolor color for links outside and inside a page, e.g. red, blue (see ConTeXt Color) linkstyle typeface style for links, e.g. normal, bold, slanted, boldslanted, type, cap, small lof, lot include list of figures, list of tables mainfont, sansfont, monofont, mathfont font families: take the name of any system font (see ConTeXt Font Switching) margin-left, margin-right, margin-top, margin-bottom sets margins, if layout is not used (otherwise layout overrides these) pagenumbering page number style and location (using setuppagenumbering); repeat for multiple options papersize paper size, e.g. letter, A4, landscape (see ConTeXt Paper Setup); repeat for multiple options pdfa adds to the preamble the setup necessary to generate PDF/A of the type specified, e.g. 1a:2005, 2a. If no type is specified (i.e. the value is set to True, by e.g. —metadata=pdfa or pdfa: true in a YAML metadata block), 1b:2005 will be used as default, for reasons of backwards compatibility. Using —variable=pdfa without specified value is not supported. To successfully generate PDF/A the required ICC color profiles have to be available and the content and all included files (such as images) have to be standard conforming. The ICC profiles and output intent may be specified using the variables pdfaiccprofile and pdfaintent. See also ConTeXt PDFA for more details. pdfaiccprofile when used in conjunction with pdfa, specifies the ICC profile to use in the PDF, e.g. default.cmyk. If left unspecified, sRGB.icc is used as default. May be repeated to include multiple profiles. Note that the profiles have to be available on the system. They can be obtained from ConTeXt ICC Profiles. pdfaintent when used in conjunction with pdfa, specifies the output intent for the colors, e.g. ISO coated v2 300\letterpercent\space (ECI) If left unspecified, sRGB IEC61966-2.1 is used as default. toc include table of contents (can also be set using —toc/—table-of-contents) whitespace spacing between paragraphs, e.g. none, small (using setupwhitespace) includesource include all source documents as file attachments in the PDF file Variables for wkhtmltopdf Pandoc uses these variables when creating a PDF with wkhtmltopdf. The —css option also affects the output.

footer-html, header-html add information to the header and footer margin-left, margin-right, margin-top, margin-bottom set the page margins papersize sets the PDF paper size Variables for man pages adjusting adjusts text to left (l), right (r), center (c), or both (b) margins footer footer in man pages header header in man pages hyphenate if true (the default), hyphenation will be used section section number in man pages Variables for ms fontfamily font family (e.g. T or P) indent paragraph indent (e.g. 2m) lineheight line height (e.g. 12p) pointsize point size (e.g. 10p) Variables set automatically Pandoc sets these variables automatically in response to options or document contents; users can also modify them. These vary depending on the output format, and include the following:

body body of document date-meta the date variable converted to ISO 8601 YYYY-MM-DD, included in all HTML based formats (dzslides, epub, html, html4, html5, revealjs, s5, slideous, slidy). The recognized formats for date are: mm/dd/yyyy, mm/dd/yy, yyyy-mm-dd (ISO 8601), dd MM yyyy (e.g. either 02 Apr 2018 or 02 April 2018), MM dd, yyyy (e.g. Apr. 02, 2018 or April 02, 2018),yyyymm[dd]]. header-includes contents specified by -H/—include-in-header (may have multiple values) include-before contents specified by -B/—include-before-body (may have multiple values) include-after contents specified by -A/—include-after-body (may have multiple values) meta-json JSON representation of all of the document’s metadata. Field values are transformed to the selected output format. numbersections non-null value if -N/—number-sections was specified sourcefile, outputfile source and destination filenames, as given on the command line. sourcefile can also be a list if input comes from multiple files, or empty if input is from stdin. You can use the following snippet in your template to distinguish them:

$if(sourcefile)$ $for(sourcefile)$ $sourcefile$ $endfor$ $else$ (stdin) $endif$ Similarly, outputfile can be - if output goes to the terminal.

If you need absolute paths, use e.g. $curdir$/$sourcefile$.

curdir working directory from which pandoc is run. toc non-null value if —toc/—table-of-contents was specified toc-title title of table of contents (works only with EPUB, HTML, revealjs, opendocument, odt, docx, pptx, beamer, LaTeX) Extensions The behavior of some of the readers and writers can be adjusted by enabling or disabling various extensions.

An extension can be enabled by adding +EXTENSION to the format name and disabled by adding -EXTENSION. For example, —from markdown_strict+footnotes is strict Markdown with footnotes enabled, while —from markdown-footnotes-pipe_tables is pandoc’s Markdown without footnotes or pipe tables.

The markdown reader and writer make by far the most use of extensions. Extensions only used by them are therefore covered in the section Pandoc’s Markdown below (See Markdown variants for commonmark and gfm.) In the following, extensions that also work for other formats are covered.

Note that markdown extensions added to the ipynb format affect Markdown cells in Jupyter notebooks (as do command-line options like —atx-headers).

Typography Extension: smart Interpret straight quotes as curly quotes, —- as em-dashes, — as en-dashes, and … as ellipses. Nonbreaking spaces are inserted after certain abbreviations, such as “Mr.”

This extension can be enabled/disabled for the following formats:

input formats markdown, commonmark, latex, mediawiki, org, rst, twiki, html output formats markdown, latex, context, rst enabled by default in markdown, latex, context (both input and output) Note: If you are writing Markdown, then the smart extension has the reverse effect: what would have been curly quotes comes out straight.

In LaTeX, smart means to use the standard TeX ligatures for quotation marks (` and '' for double quotes, and ‘ for single quotes) and dashes (— for en-dash and —- for em-dash). If smart is disabled, then in reading LaTeX pandoc will parse these characters literally. In writing LaTeX, enabling smart tells pandoc to use the ligatures when possible; if smart is disabled pandoc will use unicode quotation mark and dash characters.

Headings and sections Extension: auto_identifiers A heading without an explicitly specified identifier will be automatically assigned a unique identifier based on the heading text.

This extension can be enabled/disabled for the following formats:

input formats markdown, latex, rst, mediawiki, textile output formats markdown, muse enabled by default in markdown, muse The default algorithm used to derive the identifier from the heading text is:

Remove all formatting, links, etc. Remove all footnotes. Remove all non-alphanumeric characters, except underscores, hyphens, and periods. Replace all spaces and newlines with hyphens. Convert all alphabetic characters to lowercase. Remove everything up to the first letter (identifiers may not begin with a number or punctuation mark). If nothing is left after this, use the identifier section. Thus, for example,

Heading Identifier Heading identifiers in HTML heading-identifiers-in-html Maître d’hôtel maître-dhôtel Dogs?—in my house? dogs—in-my-house [HTML], [S5], or [RTF]? html-s5-or-rtf

(However, a different algorithm is used if gfm_auto_identifiers is enabled; see below.)

These identifiers are used to provide link targets in the table of contents generated by the —toc|—table-of-contents option. They also make it easy to provide links from one section of a document to another. A link to this section, for example, might look like this:

See the section on heading identifiers. Note, however, that this method of providing links to sections works only in HTML, LaTeX, and ConTeXt formats.

If the —section-divs option is specified, then each section will be wrapped in a section (or a div, if html4 was specified), and the identifier will be attached to the enclosing

Extension: ascii_identifiers Causes the identifiers produced by auto_identifiers to be pure ASCII. Accents are stripped off of accented Latin letters, and non-Latin letters are omitted.

Extension: gfmauto_identifiers Changes the algorithm used by auto_identifiers to conform to GitHub’s method. Spaces are converted to dashes (-), uppercase characters to lowercase characters, and punctuation characters other than - and are removed. Emojis are replaced by their names.

Math Input The extensions tex_math_dollars, tex_math_single_backslash, and tex_math_double_backslash are described in the section about Pandoc’s Markdown.

However, they can also be used with HTML input. This is handy for reading web pages formatted using MathJax, for example.

Raw HTML/TeX The following extensions are described in more detail in their respective sections of Pandoc’s Markdown:

raw_html allows HTML elements which are not representable in pandoc’s AST to be parsed as raw HTML. By default, this is disabled for HTML input.

raw_tex allows raw LaTeX, TeX, and ConTeXt to be included in a document. This extension can be enabled/disabled for the following formats (in addition to markdown):

input formats latex, textile, html (environments, \ref, and \eqref only), ipynb output formats textile, commonmark Note: as applied to ipynb, raw_html and raw_tex affect not only raw TeX in markdown cells, but data with mime type text/html in output cells. Since the ipynb reader attempts to preserve the richest possible outputs when several options are given, you will get best results if you disable raw_html and raw_tex when converting to formats like docx which don’t allow raw html or tex.

native_divs causes HTML div elements to be parsed as native pandoc Div blocks. If you want them to be parsed as raw HTML, use -f html-native_divs+raw_html.

native_spans causes HTML span elements to be parsed as native pandoc Span inlines. If you want them to be parsed as raw HTML, use -f html-native_spans+raw_html. If you want to drop all divs and spans when converting HTML to Markdown, you can use pandoc -f html-native_divs-native_spans -t markdown.

Literate Haskell support Extension: literate_haskell Treat the document as literate Haskell source.

This extension can be enabled/disabled for the following formats:

input formats markdown, rst, latex output formats markdown, rst, latex, html If you append +lhs (or +literate_haskell) to one of the formats above, pandoc will treat the document as literate Haskell source. This means that

In Markdown input, “bird track” sections will be parsed as Haskell code rather than block quotations. Text between \begin{code} and \end{code} will also be treated as Haskell code. For ATX-style headings the character ‘=’ will be used instead of ‘#’.

In Markdown output, code blocks with classes haskell and literate will be rendered using bird tracks, and block quotations will be indented one space, so they will not be treated as Haskell code. In addition, headings will be rendered setext-style (with underlines) rather than ATX-style (with ‘#’ characters). (This is because ghc treats ‘#’ characters in column 1 as introducing line numbers.)

In restructured text input, “bird track” sections will be parsed as Haskell code.

In restructured text output, code blocks with class haskell will be rendered using bird tracks.

In LaTeX input, text in code environments will be parsed as Haskell code.

In LaTeX output, code blocks with class haskell will be rendered inside code environments.

In HTML output, code blocks with class haskell will be rendered with class literatehaskell and bird tracks.

Examples:

pandoc -f markdown+lhs -t html reads literate Haskell source formatted with Markdown conventions and writes ordinary HTML (without bird tracks).

pandoc -f markdown+lhs -t html+lhs writes HTML with the Haskell code in bird tracks, so it can be copied and pasted as literate Haskell source.

Note that GHC expects the bird tracks in the first column, so indented literate code blocks (e.g. inside an itemized environment) will not be picked up by the Haskell compiler.

Other extensions Extension: empty_paragraphs Allows empty paragraphs. By default empty paragraphs are omitted.

This extension can be enabled/disabled for the following formats:

input formats docx, html output formats docx, odt, opendocument, html Extension: native_numbering Enables native numbering of figures and tables. Enumeration starts at 1.

This extension can be enabled/disabled for the following formats:

output formats odt, opendocument, docx Extension: xrefs_name Links to headings, figures and tables inside the document are substituted with cross-references that will use the name or caption of the referenced item. The original link text is replaced once the generated document is refreshed. This extension can be combined with xrefs_number in which case numbers will appear before the name.

Text in cross-references is only made consistent with the referenced item once the document has been refreshed.

This extension can be enabled/disabled for the following formats:

output formats odt, opendocument Extension: xrefs_number Links to headings, figures and tables inside the document are substituted with cross-references that will use the number of the referenced item. The original link text is discarded. This extension can be combined with xrefs_name in which case the name or caption numbers will appear after the number.

For the xrefs_number to be useful heading numbers must be enabled in the generated document, also table and figure captions must be enabled using for example the native_numbering extension.

Numbers in cross-references are only visible in the final document once it has been refreshed.

This extension can be enabled/disabled for the following formats:

output formats odt, opendocument Extension: styles When converting from docx, read all docx styles as divs (for paragraph styles) and spans (for character styles) regardless of whether pandoc understands the meaning of these styles. This can be used with docx custom styles. Disabled by default.

input formats docx Extension: amuse In the muse input format, this enables Text::Amuse extensions to Emacs Muse markup.

Extension: raw_markdown In the ipynb input format, this causes Markdown cells to be included as raw Markdown blocks (allowing lossless round-tripping) rather than being parsed. Use this only when you are targeting ipynb or a markdown-based output format.

Extension: citations When the citations extension is enabled in org, org-cite and org-ref style citations will be parsed as native pandoc citations.

When citations is enabled in docx, citations inserted by Zotero or Mendeley or EndNote plugins will be parsed as native pandoc citations. (Otherwise, the formatted citations generated by the bibliographic software will be parsed as regular text.)

Extension: fancy_lists Some aspects of Pandoc’s Markdown fancy lists are also accepted in org input, mimicking the option org-list-allow-alphabetical in Emacs. As in Org Mode, enabling this extension allows lowercase and uppercase alphabetical markers for ordered lists to be parsed in addition to arabic ones. Note that for Org, this does not include roman numerals or the # placeholder that are enabled by the extension in Pandoc’s Markdown.

Extension: element_citations In the jats output formats, this causes reference items to be replaced with elements. These elements are not influenced by CSL styles, but all information on the item is included in tags.

Extension: ntb In the context output format this enables the use of Natural Tables (TABLE) instead of the default Extreme Tables (xtables). Natural tables allow more fine-grained global customization but come at a performance penalty compared to extreme tables.

Pandoc’s Markdown Pandoc understands an extended and slightly revised version of John Gruber’s Markdown syntax. This document explains the syntax, noting differences from original Markdown. Except where noted, these differences can be suppressed by using the markdown_strict format instead of markdown. Extensions can be enabled or disabled to specify the behavior more granularly. They are described in the following. See also Extensions above, for extensions that work also on other formats.

Philosophy Markdown is designed to be easy to write, and, even more importantly, easy to read:

A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. – John Gruber

This principle has guided pandoc’s decisions in finding syntax for tables, footnotes, and other extensions.

There is, however, one respect in which pandoc’s aims are different from the original aims of Markdown. Whereas Markdown was originally designed with HTML generation in mind, pandoc is designed for multiple output formats. Thus, while pandoc allows the embedding of raw HTML, it discourages it, and provides other, non-HTMLish ways of representing important document elements like definition lists, tables, mathematics, and footnotes.

Paragraphs A paragraph is one or more lines of text followed by one or more blank lines. Newlines are treated as spaces, so you can reflow your paragraphs as you like. If you need a hard line break, put two or more spaces at the end of a line.

Extension: escaped_line_breaks A backslash followed by a newline is also a hard line break. Note: in multiline and grid table cells, this is the only way to create a hard line break, since trailing spaces in the cells are ignored.

Headings There are two kinds of headings: Setext and ATX.

Setext-style headings A setext-style heading is a line of text “underlined” with a row of = signs (for a level-one heading) or - signs (for a level-two heading):

The heading text can contain inline formatting, such as emphasis (see Inline formatting, below).

ATX-style headings An ATX-style heading consists of one to six # signs and a line of text, optionally followed by any number of # signs. The number of # signs at the beginning of the line is the heading level:

As with setext-style headings, the heading text can contain formatting:

Extension: blank_before_header Original Markdown syntax does not require a blank line before a heading. Pandoc does require this (except, of course, at the beginning of the document). The reason for the requirement is that it is all too easy for a # to end up at the beginning of a line by accident (perhaps through line wrapping). Consider, for example:

I like several of their flavors of ice cream:

Extension: space_in_atx_header Many Markdown implementations do not require a space between the opening #s of an ATX heading and the heading text, so that #5 bolt and #hashtag count as headings. With this extension, pandoc does require the space.

Heading identifiers See also the auto_identifiers extension above.

Extension: header_attributes Headings can be assigned attributes using this syntax at the end of the line containing the heading text:

{#identifier .class .class key=value key=value} Thus, for example, the following headings will all be assigned the identifier foo:

(This syntax is compatible with PHP Markdown Extra.)

Note that although this syntax allows assignment of classes and key/value attributes, writers generally don’t use all of this information. Identifiers, classes, and key/value attributes are used in HTML and HTML-based formats such as EPUB and slidy. Identifiers are used for labels and link anchors in the LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.

Headings with the class unnumbered will not be numbered, even if —number-sections is specified. A single hyphen (-) in an attribute context is equivalent to .unnumbered, and preferable in non-English documents. So,

is just the same as

If the unlisted class is present in addition to unnumbered, the heading will not be included in a table of contents. (Currently this feature is only implemented for certain formats: those based on LaTeX and HTML, PowerPoint, and RTF.)

Extension: implicit_header_references Pandoc behaves as if reference links have been defined for each heading. So, to link to a heading

you can simply write

[Heading identifiers in HTML] or

[Heading identifiers in HTML][] or

[the section on heading identifiers][heading identifiers in HTML] instead of giving the identifier explicitly:

Heading identifiers in HTML If there are multiple headings with identical text, the corresponding reference will link to the first one only, and you will need to use explicit links to link to the others, as described above.

Like regular reference links, these references are case-insensitive.

Explicit link reference definitions always take priority over implicit heading references. So, in the following example, the link will point to bar, not to #foo:

See foo Block quotations Markdown uses email conventions for quoting blocks of text. A block quotation is one or more paragraphs or other block elements (such as lists or headings), with each line preceded by a > character and an optional space. (The > need not start at the left margin, but it should not be indented more than three spaces.)

This is a block quote. This paragraph has two lines.

This is a block quote. This paragraph has two lines.

This is a block quote.

A block quote within a block quote. If the > character is followed by an optional space, that space will be considered part of the block quote marker and not part of the indentation of the contents. Thus, to put an indented code block in a block quote, you need five spaces after the >:

Extension: blank_before_blockquote Original Markdown syntax does not require a blank line before a block quote. Pandoc does require this (except, of course, at the beginning of the document). The reason for the requirement is that it is all too easy for a > to end up at the beginning of a line by accident (perhaps through line wrapping). So, unless the markdown_strict format is used, the following does not produce a nested block quote in pandoc:

This is a block quote.

Nested. Verbatim (code) blocks Indented code blocks A block of text indented four spaces (or one tab) is treated as verbatim text: that is, special characters do not trigger special formatting, and all spaces and line breaks are preserved. For example,

The initial (four space or one tab) indentation is not considered part of the verbatim text, and is removed in the output.

Note: blank lines in the verbatim text need not begin with four spaces.

Fenced code blocks Extension: fenced_code_blocks In addition to standard indented code blocks, pandoc supports fenced code blocks. These begin with a row of three or more tildes (~) and end with a row of tildes that must be at least as long as the starting row. Everything between these lines is treated as code. No indentation is necessary:

Like regular code blocks, fenced code blocks must be separated from surrounding text by blank lines.

If the code itself contains a row of tildes or backticks, just use a longer row of tildes or backticks at the start and end:

Extension: backtick_code_blocks Same as fenced_code_blocks, but uses backticks (`) instead of tildes (~).

Extension: fenced_code_attributes Optionally, you may attach attributes to fenced or backtick code block using this syntax:

~~ {#mycode .haskell .numberLines startFrom=”100”} qsort [] = [] qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ qsort (filter (>= x) xs) ~~~~~~~~~~~ Here mycode is an identifier, haskell and numberLines are classes, and startFrom is an attribute with value 100. Some output formats can use this information to do syntax highlighting. Currently, the only output formats that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If highlighting is supported for your output format and language, then the code block above will appear highlighted, with numbered lines. (To see which languages are supported, type pandoc —list-highlight-languages.) Otherwise, the code block above will appear as follows:

A shortcut form can also be used for specifying the language of the code block:

This is equivalent to:

If the fenced_code_attributes extension is disabled, but input contains class attribute(s) for the code block, the first class attribute will be printed after the opening fence as a bare word.

To prevent all highlighting, use the —no-highlight flag. To set the highlighting style, use —highlight-style. For more information on highlighting, see Syntax highlighting, below.

Line blocks Extension: line_blocks A line block is a sequence of lines beginning with a vertical bar (|) followed by a space. The division into lines will be preserved in the output, as will any leading spaces; otherwise, the lines will be formatted as Markdown. This is useful for verse and addresses:

| The limerick packs laughs anatomical | In space that is quite economical. | But the good ones I’ve seen | So seldom are clean | And the clean ones so seldom are comical

| 200 Main St. | Berkeley, CA 94718 The lines can be hard-wrapped if needed, but the continuation line must begin with a space.

| The Right Honorable Most Venerable and Righteous Samuel L. Constable, Jr. | 200 Main St. | Berkeley, CA 94718 Inline formatting (such as emphasis) is allowed in the content, but not block-level formatting (such as block quotes or lists).

This syntax is borrowed from reStructuredText.

Lists Bullet lists A bullet list is a list of bulleted list items. A bulleted list item begins with a bullet (*, +, or -). Here is a simple example:

three This will produce a “compact” list. If you want a “loose” list, in which each item is formatted as a paragraph, put spaces between the items:

one

two

three The bullets need not be flush with the left margin; they may be indented one, two, or three spaces. The bullet must be followed by whitespace.

List items look best if subsequent lines are flush with the first line (after the bullet):

and my second. But Markdown also allows a “lazy” format:

here is my first list item.

and my second. Block content in list items A list item may contain multiple paragraphs and other block-level content. However, subsequent paragraphs must be preceded by a blank line and indented to line up with the first non-space content after the list marker.

First paragraph.

Continued.

Second paragraph. With a code block, which must be indented eight spaces:

Exception: if the list marker is followed by an indented code block, which must begin 5 spaces after the list marker, then subsequent paragraphs must begin two columns after the last character of the list marker:

code

continuation paragraph List items may include other lists. In this case the preceding blank line is optional. The nested list must be indented to line up with the first non-space character after the list marker of the containing list item.

fruits

A lazy, lazy, list item.

Another one; this looks bad but is legal.

Second paragraph of second list item. Ordered lists Ordered lists work just like bulleted lists, except that the items begin with enumerators rather than bullets.

In original Markdown, enumerators are decimal numbers followed by a period and a space. The numbers themselves are ignored, so there is no difference between this list:

three and this one:

one

The fancy_lists extension also allows ‘#’ to be used as an ordered list marker in place of a numeral:

Extension: startnum Pandoc also pays attention to the type of list marker used, and to the starting number, and both of these are preserved where possible in the output format. Thus, the following yields a list with numbers followed by a single parenthesis, starting with 9, and a sublist with lowercase roman numerals:

9) Ninth 10) Tenth 11) Eleventh i. subone ii. subtwo iii. subthree Pandoc will start a new list each time a different type of list marker is used. So, the following will create three lists:

(2) Two (5) Three

Extension: task_lists Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.

Term 1

: Definition 1

Term 2 with inline markup

: Definition 2

Each term must fit on one line, which may optionally be followed by a blank line, and must be followed by one or more definitions. A definition begins with a colon or tilde, which may be indented one or two spaces.

A term may have multiple definitions, and each definition may consist of one or more block elements (paragraph, code block, list, etc.), each indented four spaces or one tab stop. The body of the definition (not including the first line) should be indented four spaces. However, as with other Markdown lists, you can “lazily” omit indentation except at the beginning of a paragraph or other block element:

Term 1

: Definition with lazy continuation.

If you leave space before the definition (as in the example above), the text of the definition will be treated as a paragraph. In some output formats, this will mean greater spacing between term/definition pairs. For a more compact definition list, omit the space before the definition:

Term 1 ~ Definition 1

Term 2 ~ Definition 2a ~ Definition 2b Note that space between items in a definition list is required. (A variant that loosens this requirement, but disallows “lazy” hard wrapping, can be activated with compact_definition_lists: see Non-default extensions, below.)

Numbered example lists Extension: example_lists The special list marker @ can be used for sequentially numbered examples. The first list item with a @ marker will be numbered ‘1’, the next ‘2’, and so on, throughout the document. The numbered examples need not occur in a single list; each new list using @ will take up where the last stopped. So, for example:

(@) My first example will be numbered (1). (@) My second example will be numbered (2).

Explanation of examples.

(@) My third example will be numbered (3). Numbered examples can be labeled and referred to elsewhere in the document:

(@good) This is a good example.

As (@good) illustrates, … The label can be any string of alphanumeric characters, underscores, or hyphens.

Note: continuation paragraphs in example lists must always be indented four spaces, regardless of the length of the list marker. That is, example lists always behave as if the four_space_rule extension is set. This is because example labels tend to be long, and indenting content to the first non-space character after the label would be awkward.

Ending a list What if you want to put an indented code block after a list?

item two

{ my code block } Trouble! Here pandoc (like other Markdown implementations) will treat { my code block } as the second paragraph of item two, and not as a code block.

To “cut off” the list after item two, you can insert some non-indented content, like an HTML comment, which won’t produce visible output in any format:

You can use the same trick if you want two consecutive lists instead of one big list:

Tables Four kinds of tables may be used. The first three kinds presuppose the use of a fixed-width font, such as Courier. The fourth kind can be used with proportionally spaced fonts, as it does not require lining up columns.

Extension: table_captions A caption may optionally be provided with all 4 kinds of tables (as illustrated in the examples below). A caption is a paragraph beginning with the string Table: (or just :), which will be stripped off. It may appear either before or after the table.

Extension: simple_tables Simple tables look like this:

Right Left Center Default

Table: Demonstration of simple table syntax. The header and table rows must each fit on one line. Column alignments are determined by the position of the header text relative to the dashed line below it:3

If the dashed line is flush with the header text on the right side but extends beyond it on the left, the column is right-aligned. If the dashed line is flush with the header text on the left side but extends beyond it on the right, the column is left-aligned. If the dashed line extends beyond the header text on both sides, the column is centered. If the dashed line is flush with the header text on both sides, the default alignment is used (in most cases, this will be left). The table must end with a blank line, or a line of dashes followed by a blank line.

The column header row may be omitted, provided a dashed line is used to end the table. For example:

When the header row is omitted, column alignments are determined on the basis of the first line of the table body. So, in the tables above, the columns would be right, left, center, and right aligned, respectively.

Extension: multiline_tables Multiline tables allow header and table rows to span multiple lines of text (but cells that span multiple columns or rows of the table are not supported). Here is an example:

Centered Default Right Left Header Aligned Aligned Aligned

First row 12.0 Example of a row that spans multiple lines.

Second row 5.0 Here’s another one. Note the blank line between

Table: Here’s the caption. It, too, may span multiple lines. These work like simple tables, but with the following differences:

They must begin with a row of dashes, before the header text (unless the header row is omitted). They must end with a row of dashes, then a blank line. The rows must be separated by blank lines. In multiline tables, the table parser pays attention to the widths of the columns, and the writers try to reproduce these relative widths in the output. So, if you find that one of the columns is too narrow in the output, try widening it in the Markdown source.

The header may be omitted in multiline tables as well as simple tables:

First row 12.0 Example of a row that spans multiple lines.

Second row 5.0 Here’s another one. Note the blank line between rows.

: Here’s a multiline table without a header. It is possible for a multiline table to have just one row, but the row should be followed by a blank line (and then the row of dashes that ends the table), or the table may be interpreted as a simple table.

Extension: grid_tables Grid tables look like this:

: Sample grid table.

+———————-+———————-+——————————+ | Fruit | Price | Advantages | +===============+===============+====================+ | Bananas | $1.34 | - built-in wrapper | | | | - bright color | +———————-+———————-+——————————+ | Oranges | $2.10 | - cures scurvy | | | | - tasty | +———————-+———————-+——————————+ The row of =s separates the header from the table body, and can be omitted for a headerless table. The cells of grid tables may contain arbitrary block elements (multiple paragraphs, code blocks, lists, etc.). Cells that span multiple columns or rows are not supported. Grid tables can be created easily using Emacs’ table-mode (M-x table-insert).

Alignments can be specified as with pipe tables, by putting colons at the boundaries of the separator line after the header:

+———————-+———————-+——————————+ | Right | Left | Centered | +==============:+:==============+:==================:+ | Bananas | $1.34 | built-in wrapper | +———————-+———————-+——————————+ For headerless tables, the colons go on the top line instead:

+———————:+:———————+:—————————:+ | Right | Left | Centered | +———————-+———————-+——————————+ Grid Table Limitations Pandoc does not support grid tables with row spans or column spans. This means that neither variable numbers of columns across rows nor variable numbers of rows across columns are supported by Pandoc. All grid tables must have the same number of columns in each row, and the same number of rows in each column. For example, the Docutils sample grid tables will not render as expected with Pandoc.

Extension: pipe_tables Pipe tables look like this:

: Demonstration of pipe table syntax. The syntax is identical to PHP Markdown Extra tables. The beginning and ending pipe characters are optional, but pipes are required between all columns. The colons indicate column alignment as shown. The header cannot be omitted. To simulate a headerless table, include a header with blank cells.

Since the pipes indicate column boundaries, columns need not be vertically aligned, as they are in the above example. So, this is a perfectly legal (though ugly) pipe table:

Note: pandoc also recognizes pipe tables of the following form, as can be produced by Emacs’ orgtbl-mode:

| One | Two | |——-+———-| | my | table | | is | nice | The difference is that + is used instead of |. Other orgtbl features are not supported. In particular, to get non-default column alignment, you’ll need to add colons as above.

Metadata blocks Extension: pandoc_title_block If the file begins with a title block

% title % author(s) (separated by semicolons) % date it will be parsed as bibliographic information, not regular text. (It will be used, for example, in the title of standalone LaTeX or HTML output.) The block may contain just a title, a title and an author, or all three elements. If you want to include an author but no title, or a title and a date but no author, you need a blank line:

% % Author % My title % % June 15, 2006 The title may occupy multiple lines, but continuation lines must begin with leading space, thus:

% My title on multiple lines If a document has multiple authors, the authors may be put on separate lines with leading space, or separated by semicolons, or both. So, all of the following are equivalent:

% Author One Author Two % Author One; Author Two % Author One; Author Two The date must fit on one line.

All three metadata fields may contain standard inline formatting (italics, links, footnotes, etc.).

Title blocks will always be parsed, but they will affect the output only when the —standalone (-s) option is chosen. In HTML output, titles will appear twice: once in the document head – this is the title that will appear at the top of the window in a browser – and once at the beginning of the document body. The title in the document head can have an optional prefix attached (—title-prefix or -T option). The title in the body appears as an H1 element with class “title”, so it can be suppressed or reformatted with CSS. If a title prefix is specified with -T and no title block appears in the document, the title prefix will be used by itself as the HTML title.

The man page writer extracts a title, man page section number, and other header and footer information from the title line. The title is assumed to be the first word on the title line, which may optionally end with a (single-digit) section number in parentheses. (There should be no space between the title and the parentheses.) Anything after this is assumed to be additional footer and header text. A single pipe character (|) should be used to separate the footer text from the header text. Thus,

% PANDOC(1) will yield a man page with the title PANDOC and section 1.

% PANDOC(1) Pandoc User Manuals will also have “Pandoc User Manuals” in the footer.

% PANDOC(1) Pandoc User Manuals | Version 4.0 will also have “Version 4.0” in the header.

Extension: yaml_metadata_block A YAML metadata block is a valid YAML object, delimited by a line of three hyphens (—-) at the top and a line of three hyphens (—-) or three dots (…) at the bottom. A YAML metadata block may occur anywhere in the document, but if it is not at the beginning, it must be preceded by a blank line. (Note that, because of the way pandoc concatenates input files when several are provided, you may also keep the metadata in a separate YAML file and pass it to pandoc as an argument, along with your Markdown files:

pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html Just be sure that the YAML file begins with —- and ends with —- or ….) Alternatively, you can use the —metadata-file option. Using that approach however, you cannot reference content (like footnotes) from the main markdown input document.

Metadata will be taken from the fields of the YAML object and added to any existing document metadata. Metadata can contain lists and objects (nested arbitrarily), but all string scalars will be interpreted as Markdown. Fields with names ending in an underscore will be ignored by pandoc. (They may be given a role by external processors.) Field names must not be interpretable as YAML numbers or boolean values (so, for example, yes, True, and 15 cannot be used as field names).

A document may contain multiple metadata blocks. If two metadata blocks attempt to set the same field, the value from the second block will be taken.

Each metadata block is handled internally as an independent YAML document. This means, for example, that any YAML anchors defined in a block cannot be referenced in another block.

When pandoc is used with -t markdown to create a Markdown document, a YAML metadata block will be produced only if the -s/—standalone option is used. All of the metadata will appear in a single block at the beginning of the document.

Note that YAML escaping rules must be followed. Thus, for example, if a title contains a colon, it must be quoted, and if it contains a backslash escape, then it must be ensured that it is not treated as a YAML escape sequence. The pipe character (|) can be used to begin an indented block that will be interpreted literally, without need for escaping. This form is necessary when the field contains blank lines or block-level formatting:

title: ‘This is the title: it contains a colon’ author:

Author Two keywords: [nothing, nothingness] abstract: | This is the abstract.

It consists of two paragraphs. … The literal block after the | must be indented relative to the line containing the |. If it is not, the YAML will be invalid and pandoc will not interpret it as metadata. For an overview of the complex rules governing YAML, see the Wikipedia entry on YAML syntax.

Template variables will be set automatically from the metadata. Thus, for example, in writing HTML, the variable abstract will be set to the HTML equivalent of the Markdown in the abstract field:

This is the abstract.

It consists of two paragraphs.

title: The document title author:

$for(author)$ $if(author.name)$ $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$ $else$ $author$ $endif$ $endfor$ Raw content to include in the document’s header may be specified using header-includes; however, it is important to mark up this content as raw code for a particular output format, using the raw_attribute extension), or it will be interpreted as markdown. For example:

header-includes:

The YAML metadata block must occur at the beginning of the document (and there can be only one). If multiple files are given as arguments to pandoc, only the first can be a YAML metadata block.

The leaf nodes of the YAML structure are parsed in isolation from each other and from the rest of the document. So, for example, you can’t use a reference link in these contexts if the link definition is somewhere else in the document.

Backslash escapes Extension: all_symbols_escapable Except inside a code block or inline code, any punctuation or space character preceded by a backslash will be treated literally, even if it would normally indicate formatting. Thus, for example, if one writes

\hello** one will get

hello instead of

hello This rule is easier to remember than original Markdown’s rule, which allows only the following characters to be backslash-escaped:

`*_{}>#+-.! (However, if the markdown_strict format is used, the original Markdown rule will be used.)

A backslash-escaped space is parsed as a nonbreaking space. In TeX output, it will appear as ~. In HTML and XML output, it will appear as a literal unicode nonbreaking space character (note that it will thus actually look “invisible” in the generated HTML source; you can still use the —ascii command-line option to make it appear as an explicit entity).

A backslash-escaped newline (i.e. a backslash occurring at the end of a line) is parsed as a hard line break. It will appear in TeX output as \ and in HTML as . This is a nice alternative to Markdown’s “invisible” way of indicating hard line breaks using two trailing spaces on a line.

Backslash escapes do not work in verbatim contexts.

Inline formatting Emphasis To emphasize some text, surround it with *s or _, like this:

This text is emphasized with underscores, and this is emphasized with asterisks. Double * or _ produces strong emphasis:

This is strong emphasis and with underscores. A * or _ character surrounded by spaces, or backslash-escaped, will not trigger emphasis:

This is not emphasized , and *neither is this*. Extension: intrawordunderscores Because is sometimes used inside words and identifiers, pandoc does not interpret a _ surrounded by alphanumeric characters as an emphasis marker. If you want to emphasize just part of a word, use *:

feasible, not feasable. Strikeout Extension: strikeout To strikeout a section of text with a horizontal line, begin and end it with ~~. Thus, for example,

This is deleted text. Superscripts and subscripts Extension: superscript, subscript Superscripts may be written by surrounding the superscripted text by ^ characters; subscripts may be written by surrounding the subscripted text by ~ characters. Thus, for example,

H~2~O is a liquid. 2^10^ is 1024. The text between ^…^ or ~…~ may not contain spaces or newlines. If the superscripted or subscripted text contains spaces, these spaces must be escaped with backslashes. (This is to prevent accidental superscripting and subscripting through the ordinary use of ~ and ^, and also bad interactions with footnotes.) Thus, if you want the letter P with ‘a cat’ in subscripts, use P~a\ cat~, not P~a cat~.

Verbatim To make a short span of text verbatim, put it inside backticks:

What is the difference between >>= and >>? If the verbatim text includes a backtick, use double backticks:

Here is a literal backtick ` . (The spaces after the opening backticks and before the closing backticks will be ignored.)

The general rule is that a verbatim span starts with a string of consecutive backticks (optionally followed by a space) and ends with a string of the same number of backticks (optionally preceded by a space).

Note that backslash-escapes (and other Markdown constructs) do not work in verbatim contexts:

This is a backslash followed by an asterisk: \*. Extension: inline_code_attributes Attributes can be attached to verbatim text, just as with fenced code blocks:

{.haskell} Underline To underline text, use the underline class:

[Underline]{.underline} Or, without the bracketed_spans extension (but with native_spans):

Underline This will work in all output formats that support underline.

Small caps To write small caps, use the smallcaps class:

[Small caps]{.smallcaps} Or, without the bracketed_spans extension:

Small caps For compatibility with other Markdown flavors, CSS is also supported:

Small caps This will work in all output formats that support small caps.

Math Extension: tex_math_dollars Anything between two $ characters will be treated as TeX math. The opening $ must have a non-space character immediately to its right, while the closing $ must have a non-space character immediately to its left, and must not be followed immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some reason you need to enclose text in literal $ characters, backslash-escape them and they won’t be treated as math delimiters.

For display math, use delimiters.(Inthiscase,thedelimitersmaybeseparatedfromtheformulabywhitespace.However,therecanbenoblanklinesbetweentheopeningandclosing delimiters. (In this case, the delimiters may be separated from the formula by whitespace. However, there can be no blank lines between the opening and closing delimiters.(Inthiscase,thedelimitersmaybeseparatedfromtheformulabywhitespace.However,therecanbenoblanklinesbetweentheopeningandclosing delimiters.)

TeX math will be printed in all output formats. How it is rendered depends on the output format:

LaTeX It will appear verbatim surrounded by (…) (for inline math) or […] (for display math). Markdown, Emacs Org mode, ConTeXt, ZimWiki It will appear verbatim surrounded by $…$ (for inline math) or ……… (for display math). XWiki It will appear verbatim surrounded by {{formula}}..{{/formula}}. reStructuredText It will be rendered using an interpreted text role :math:. AsciiDoc For AsciiDoc output format (-t asciidoc) it will appear verbatim surrounded by latexmath:[$…$] (for inline math) or [latexmath]++++[…]+++ (for display math). For AsciiDoctor output format (-t asciidoctor) the LaTex delimiters ($..$ and [..]) are omitted. Texinfo It will be rendered inside a @math command. roff man, Jira markup It will be rendered verbatim without $’s. MediaWiki, DokuWiki It will be rendered inside tags. Textile It will be rendered inside tags. RTF, OpenDocument It will be rendered, if possible, using Unicode characters, and will otherwise appear verbatim. ODT It will be rendered, if possible, using MathML. DocBook If the —mathml flag is used, it will be rendered using MathML in an inlineequation or informalequation tag. Otherwise it will be rendered, if possible, using Unicode characters. Docx It will be rendered using OMML math markup. FictionBook2 If the —webtex option is used, formulas are rendered as images using CodeCogs or other compatible web service, downloaded and embedded in the e-book. Otherwise, they will appear verbatim. HTML, Slidy, DZSlides, S5, EPUB The way math is rendered in HTML will depend on the command-line options selected. Therefore see Math rendering in HTML above. Raw HTML Extension: raw_html Markdown allows you to insert raw HTML (or DocBook) anywhere in a document (except verbatim contexts, where , and & are interpreted literally). (Technically this is not an extension, since standard Markdown allows it, but it has been made an extension so that it can be disabled if desired.)

The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous, DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile output, and suppressed in other formats.

For a more explicit way of including raw HTML in a Markdown document, see the raw_attribute extension.

In the CommonMark format, if raw_html is enabled, superscripts, subscripts, strikeouts and small capitals will be represented as HTML. Otherwise, plain-text fallbacks will be used. Note that even if raw_html is disabled, tables will be rendered with HTML syntax if they cannot use pipe syntax.

Extension: markdown_in_html_blocks Original Markdown allows you to include HTML “blocks”: blocks of HTML between balanced tags that are separated from the surrounding text with blank lines, and start and end at the left margin. Within these blocks, everything is interpreted as HTML, not Markdown; so (for example), * does not signify emphasis.

Pandoc behaves this way when the markdown_strict format is used; but by default, pandoc interprets material between HTML block tags as Markdown. Thus, for example, pandoc will turn

There is one exception to this rule: text between