neulab/tldr huggingface dataset:
Partials Partials (subtemplates stored in different files) may be included by using the name of the partial, followed by (), for example:
${ 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)$ - $it.key$: $it.value$ $endfor$
$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: - Aristotle - Peter Abelard ...
Note that if you just want to set PDF or HTML metadata, without including a title block in the document itself, you can set the title-meta, author-meta, and date-meta variables.  (By default these are set automatically, based on title, author, and date.) The page title in HTML is set by pagetitle, which is equal to title by default.
subtitle document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx documents
abstract document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx documents
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 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 One - 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: | <style> blockquote { font-style: italic; } tr.even { background-color: #f0f0f0; } td, th { padding: 0.5em 2em 0.5em 0.5em; } tbody { border-bottom: none; } </style> ---
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)
beamerarticle produce an article from Beamer slides
beameroption add extra beamer option with \setbeameroption{}
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: - twocolumn - landscape ...
documentclass document class: usually one of the standard classes, article, book, and report; the KOMA-Script equivalents, scrartcl, scrbook, and scrreprt, which default to smaller margins; or memoir
geometry option for geometry package, e.g. margin=1in; repeat for multiple options:
--- geometry: - top=30mm - left=20mm - heightrounded ...
hyperrefoptions option for hyperref package, e.g. linktoc=all; repeat for multiple options:
--- hyperrefoptions: - linktoc=all - pdfwindowui - pdfpagemode=FullScreen ...
indent if true, pandoc will use document class settings for indentation (the default LaTeX template otherwise removes indentation and adds space between paragraphs)
linestretch adjusts line spacing using the setspace package, e.g. 1.25, 1.5
margin-left, margin-right, margin-top, margin-bottom sets margins if geometry is not used (otherwise geometry overrides these)
pagestyle control \pagestyle{}: the default article class supports plain (default), empty (no running heads or page numbers), and headings (section titles in running heads)
papersize paper size, e.g. letter, a4
secnumdepth numbering depth for sections (with --number-sections option or numbersections variable)
Fonts fontenc allows font encoding to be specified through fontenc package (with pdflatex); default is T1 (see LaTeX font encodings guide)
fontfamily font package for use with pdflatex: TeX Live includes many options, documented in the LaTeX Font Catalogue.  The default is Latin Modern.
fontfamilyoptions options for package used as fontfamily; repeat for multiple options.  For example, to use the Libertine font with proportional lowercase (old-style) figures through the libertinus package:
--- fontfamily: libertinus fontfamilyoptions: - osf - p ...
fontsize font size for body text.  The standard classes allow 10pt, 11pt, and 12pt.  To use another size, set documentclass to one of the KOMA-Script classes, such as scrartcl or scrbook.
mainfont, sansfont, monofont, mathfont, CJKmainfont font families for use with xelatex or lualatex: take the name of any system font, using the fontspec package.  CJKmainfont uses the xecjk package.
mainfontoptions, sansfontoptions, monofontoptions, mathfontoptions, CJKoptions options to use with mainfont, sansfont, monofont, mathfont, CJKmainfont in xelatex and lualatex.  Allow for any choices available through fontspec; repeat for multiple options.  For example, to use the TeX Gyre version of Palatino with lowercase figures:
--- mainfont: TeX Gyre Pagella mainfontoptions: - Numbers=Lowercase - Numbers=Proportional ...
microtypeoptions options to pass to the microtype package
Links colorlinks add color to link text; automatically enabled if any of linkcolor, filecolor, citecolor, urlcolor, or toccolor are set
linkcolor, filecolor, citecolor, urlcolor, toccolor color for internal links, external links, citation links, linked URLs, and links in table of contents, respectively: uses options allowed by xcolor, including the dvipsnames, svgnames, and x11names lists
links-as-notes causes links to be printed as footnotes
Front matter lof, lot include list of figures, list of tables
thanks contents of acknowledgments footnote after document title
toc    include table of contents (can also be set using --toc/--table-of- contents)
toc-depth level of section to include in table of contents
BibLaTeX Bibliographies These variables function when using BibLaTeX for citation rendering.
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.
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),yyyy[mm[dd]]](e.g.20180402, 201804 or 2018).
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, opendocument, odt, docx, pptx, beamer, LaTeX)
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
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.
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
3. Applications               applications 33                            section
These rules should, in most cases, allow one to determine the identifier from the heading text.  The exception is when several headings have the same text; in this case, the first will get an identifier as described above; the second will get the same identifier with -1 appended; the third with -2; and so on.
(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](#heading-identifiers-in-html-latex-and-context).
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 <section> (or <div>) tag rather than the heading itself.  This allows entire sections to be manipulated using JavaScript or treated differently in CSS.
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: gfm_auto_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.
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.
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.
input formats docx, html
output formats docx, odt, opendocument, html
Extension: native_numbering Enables native numbering of figures and tables.  Enumeration starts at 1.
output formats odt, opendocument
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.
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.
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 Some aspects of Pandoc’s Markdown citation syntax are also accepted in org input.
Extension: element_citations In the jats output formats, this causes reference items to be replaced with <element-citation> 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 standard 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):
A level-one heading ===================
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:
## A level-two heading
### A level-three heading ###
As with setext-style headings, the heading text can contain formatting:
# A level-one heading with a [link](/url) and *emphasis*
Extension: blank_before_header Standard 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: #22, for example, and #5.
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:
# My heading {#foo}
## My heading ##    {#foo}
My other heading   {#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,
# My heading {-}
is just the same as
# My heading {.unnumbered}
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
# Heading identifiers in HTML
you can simply write
[Heading identifiers in HTML]
[Heading identifiers in HTML][]
[the section on heading identifiers][heading identifiers in HTML]
instead of giving the identifier explicitly:
[Heading identifiers in HTML](#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:
# Foo
[foo]: bar
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. > > 1. This is a list inside a block quote. > 2. Second item.
A “lazy” form, which requires the > character only on the first line of each block, is also allowed:
> This is a block quote. This paragraph has two lines.
> 1. This is a list inside a block quote. 2. Second item.
Among the block elements that can be contained in a block quote are other block quotes.  That is, block quotes can be nested:
> 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 >:
>     code
Extension: blank_before_blockquote Standard 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,
if (a > 3) { moveShip(5 * gravity, DOWN); }
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:
~~~~~~~ if (a > 3) { moveShip(5 * gravity, DOWN); } ~~~~~~~
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:
~~~~~~~~~~~~~~~~ ~~~~~~~~~~ code including tildes ~~~~~~~~~~ ~~~~~~~~~~~~~~~~
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:
<pre id="mycode" class="haskell numberLines" startFrom="100"> <code> ... </code> </pre>
The numberLines (or number-lines) class will cause the lines of the code block to be numbered, starting with 1 or the value of the startFrom attribute.  The lineAnchors (or line-anchors) class will cause the lines to be clickable anchors in HTML output.
A shortcut form can also be used for specifying the language of the code block:
```haskell qsort [] = [] ```
``` {.haskell} qsort [] = [] ```
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:
* one * two * 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
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):
* here is my first list item. * and my second.
But Markdown also allows a “lazy” format:
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.
* Second paragraph. With a code block, which must be indented eight spaces:
{ code }
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 + apples - macintosh - red delicious + pears + peaches * vegetables + broccoli + chard
As noted above, Markdown allows you to write list items “lazily,” instead of indenting continuation lines.  However, if there are multiple paragraphs or other blocks in a list item, the first line of each must be indented.
+ 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 standard 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:
1.  one 2.  two 3.  three
and this one:
5.  one 7.  two 1.  three
Extension: fancy_lists Unlike standard Markdown, pandoc allows ordered list items to be marked with uppercase and lowercase letters and roman numerals, in addition to Arabic numerals.  List markers may be enclosed in parentheses or followed by a single right-parentheses or period.  They must be separated from the text that follows by at least one space, and, if the list marker is a capital letter with a period, by at least two spaces.
The fancy_lists extension also allows `#' to be used as an ordered list marker in place of a numeral:
#. one #. two
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 1.  Four *   Five
If default list markers are desired, use #.:
#.  one #.  two #.  three
Extension: task_lists Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
- [ ] an unchecked task list item - [x] checked item
Definition lists Extension: definition_lists Pandoc supports definition lists, using the syntax of PHP Markdown Extra with some extensions.
Term 1
:   Definition 1
Term 2 with *inline markup*
:   Definition 2
{ some code, part of Definition 2 }
Third paragraph of 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 (including the first line, aside from the colon or tilde) 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:
:   Definition with lazy continuation.
Second paragraph of the definition.
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, ...