Variables for man pages

C]section]

section number in man pages

C]header]

header in man pages

C]footer]

footer in man pages

C]adjusting]

adjusts text to left (C]l]), right (C]r]), center (C]c]), or both (C]b]) margins

C]hyphenate]

if C]true] (the default), hyphenation will be used

Using variables in templates

Variable names are sequences of alphanumerics, C]-], and C]_], starting with a letter. A variable name surrounded by C]$] signs will be replaced by its value. For example, the string C]$title$] in

C]
<title>$title$</title>
]

will be replaced by the document title.

To write a literal C]$] in a template, use C]$$].

Templates may contain conditionals. The syntax is as follows:

C]
$if(variable)$
X
$else$
Y
$endif$
]

This will include C]X] in the template if C]variable] has a non-null value; otherwise it will include C]Y]. C]X] and C]Y] are placeholders for any valid template text, and may include interpolated variables or other conditionals. The C]$else$] section may be omitted.

When variables can have multiple values (for example, C]author] in a multi-author document), you can use the C]$for$] keyword:

C]
$for(author)$
<meta name="author" content="$author$" />
$endfor$
]

You can optionally specify a separator to be used between consecutive items:

C]
$for(author)$$author$$sep$, $endfor$
]

A dot can be used to select a field of a variable that takes an object as its value. So, for example:

C]
$author.name$ ($author.affiliation$)
]

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.

PANDOC[aq]S MARKDOWN

Pandoc understands an extended and slightly revised version of John Gruber[aq]s Markdown syntax. This document explains the syntax, noting differences from standard Markdown. Except where noted, these differences can be suppressed by using the C]markdown_strict] format instead of C]markdown]. An extensions can be enabled by adding C]+EXTENSION] to the format name and disabled by adding C]-EXTENSION]. For example, C]markdown_strict+footnotes] is strict Markdown with footnotes enabled, while C]markdown-footnotes-pipe_tables] is pandoc[aq]s Markdown without footnotes or pipe tables.

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[aq]s been marked up with tags or formatting instructions. -- John Gruber

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

There is, however, one respect in which pandoc[aq]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: C]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.

Headers

There are two kinds of headers: Setext and ATX.

Setext-style headers

A setext-style header is a line of text "underlined" with a row of C]=] signs (for a level one header) or C]-] signs (for a level two header):

C]
A level-one header
==================

A level-two header
------------------
]

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

ATX-style headers

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

C]
## A level-two header

### A level-three header ###
]

As with setext-style headers, the header text can contain formatting:

C]
# A level-one header with a [link](/url) and *emphasis*
]

Extension: C]blank_before_header]

Standard Markdown syntax does not require a blank line before a header. 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 C]#] to end up at the beginning of a line by accident (perhaps through line wrapping). Consider, for example:

C]
I like several of their flavors of ice cream:
#22, for example, and #5.
]

Header identifiers

Extension: C]header_attributes]

Headers can be assigned attributes using this syntax at the end of the line containing the header text:

C]
{#identifier .class .class key=value key=value}
]

Thus, for example, the following headers will all be assigned the identifier C]foo]:

C]
# My header {#foo}

## My header ##    {#foo}

My other header   {#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[aq]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, and AsciiDoc writers.

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

C]
# My header {-}
]

is just the same as

C]
# My header {.unnumbered}
]

Extension: C]auto_identifiers]

A header without an explicitly specified identifier will be automatically assigned a unique identifier based on the header text. To derive the identifier from the header text,

[bu]

Remove all formatting, links, etc.

[bu]

Remove all footnotes.

[bu]

Remove all punctuation, except underscores, hyphens, and periods.

[bu]

Replace all spaces and newlines with hyphens.

[bu]

Convert all alphabetic characters to lowercase.

[bu]

Remove everything up to the first letter (identifiers may not begin with a number or punctuation mark).

[bu]

If nothing is left after this, use the identifier C]section].

Thus, for example,

These rules should, in most cases, allow one to determine the identifier from the header text. The exception is when several headers have the same text; in this case, the first will get an identifier as described above; the second will get the same identifier with C]-1] appended; the third with C]-2]; and so on.

These identifiers are used to provide link targets in the table of contents generated by the C]--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:

C]
See the section on
[header identifiers](#header-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 C]--section-divs] option is specified, then each section will be wrapped in a C]div] (or a C]section], if C]--html5] was specified), and the identifier will be attached to the enclosing C]<div>] (or C]<section>]) tag rather than the header itself. This allows entire sections to be manipulated using javascript or treated differently in CSS.

Extension: C]implicit_header_references]

Pandoc behaves as if reference links have been defined for each header. So, instead of

C]
[header identifiers](#header-identifiers-in-html)
]

you can simply write

C]
[header identifiers]
]

or

C]
[header identifiers][]
]

or

C]
[the section on header identifiers][header identifiers]
]

If there are multiple headers 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 header references. So, in the following example, the link will point to C]bar], not to C]#foo]:

C]
# 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 headers), with each line preceded by a C]>] character and an optional space. (The C]>] need not start at the left margin, but it should not be indented more than three spaces.)

C]
> 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 C]>] character only on the first line of each block, is also allowed:

C]
> 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:

C]
> This is a block quote.
>
> > A block quote within a block quote.
]

If the C]>] 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 C]>]:

C]
>     code
]

Extension: C]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 C]>] to end up at the beginning of a line by accident (perhaps through line wrapping). So, unless the C]markdown_strict] format is used, the following does not produce a nested block quote in pandoc:

C]
> 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,

C]
    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: C]fenced_code_blocks]

In addition to standard indented code blocks, pandoc supports I]fenced] code blocks. These begin with a row of three or more tildes (C]~]) 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:

C]
~~~~~~~
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:

C]
~~~~~~~~~~~~~~~~
~~~~~~~~~~
code including tildes
~~~~~~~~~~
~~~~~~~~~~~~~~~~
]

Extension: C]backtick_code_blocks]

Same as C]fenced_code_blocks], but uses backticks (C]`]) instead of tildes (C]~]).

Extension: C]fenced_code_attributes]

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

C]
~~~~ {#mycode .haskell .numberLines startFrom="100"}
qsort []     = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
               qsort (filter (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
]

Here C]mycode] is an identifier, C]haskell] and C]numberLines] are classes, and C]startFrom] is an attribute with value C]100]. Some output formats can use this information to do syntax highlighting. Currently, the only output formats that uses this information are HTML and LaTeX. 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, do C]pandoc --version].) Otherwise, the code block above will appear as follows:

C]
<pre id="mycode" class="haskell numberLines" startFrom="100">
  <code>
  ...
  </code>
</pre>
]

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

C]
```haskell
qsort [] = []
```
]

This is equivalent to:

C]
``` {.haskell}
qsort [] = []
```
]

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

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

Line blocks

Extension: C]line_blocks]

A line block is a sequence of lines beginning with a vertical bar (C]|]) 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:

C]
| The limerick packs laughs anatomical
| In space that is quite economical.
|    But the good ones I[aq]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.

C]
| The Right Honorable Most Venerable and Righteous Samuel L.
  Constable, Jr.
| 200 Main St.
| Berkeley, CA 94718
]

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 (C]*], C]+], or C]-]). Here is a simple example:

C]
* 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:

C]
* 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):

C]
* here is my first
  list item.
* and my second.
]

But Markdown also allows a "lazy" format:

C]
* here is my first
list item.
* and my second.
]

The four-space rule

A list item may contain multiple paragraphs and other block-level content. However, subsequent paragraphs must be preceded by a blank line and indented four spaces or a tab. The list will look better if the first paragraph is aligned with the rest:

C]
  * First paragraph.

    Continued.

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

        { code }
]

List items may include other lists. In this case the preceding blank line is optional. The nested list must be indented four spaces or one tab:

C]
* 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.

C]
+ A lazy, lazy, list
item.

+ Another one; this looks
bad but is legal.

    Second paragraph of second
list item.
]

B]Note:] Although the four-space rule for continuation paragraphs comes from the official Markdown syntax guide, the reference implementation, C]Markdown.pl], does not follow it. So pandoc will give different results than C]Markdown.pl] when authors have indented continuation paragraphs fewer than four spaces.

The Markdown syntax guide is not explicit whether the four-space rule applies to I]all] block-level content in a list item; it only mentions paragraphs and code blocks. But it implies that the rule applies to all block-level content (including nested lists), and pandoc interprets it that way.

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:

C]
1.  one
2.  two
3.  three
]

and this one:

C]
5.  one
7.  two
1.  three
]

Extension: C]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 C]fancy_lists] extension also allows [aq]C]#][aq] to be used as an ordered list marker in place of a numeral:

C]
#. one
#. two
]

Extension: C]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:

C]
 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:

C]
(2) Two
(5) Three
1.  Four
*   Five
]

If default list markers are desired, use C]#.]:

C]
#.  one
#.  two
#.  three
]

Definition lists

Extension: C]definition_lists]

Pandoc supports definition lists, using the syntax of PHP Markdown Extra with some extensions.

C]
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:

C]
Term 1

:   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:

C]
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 C]compact_definition_lists]: see Non-pandoc extensions, below.)

Numbered example lists

Extension: C]example_lists]

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

C]
(@)  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:

C]
(@good)  This is a good example.

As (@good) illustrates, ...
]

The label can be any string of alphanumeric characters, underscores, or hyphens.

Compact and loose lists

Pandoc behaves differently from C]Markdown.pl] on some "edge cases" involving lists. Consider this source:

C]
+   First
+   Second:
    -   Fee
    -   Fie
    -   Foe

+   Third
]

Pandoc transforms this into a "compact list" (with no C]<p>] tags around "First", "Second", or "Third"), while Markdown puts C]<p>] tags around "Second" and "Third" (but not "First"), because of the blank space around "Third". Pandoc follows a simple rule: if the text is followed by a blank line, it is treated as a paragraph. Since "Second" is followed by a list, and not a blank line, it isn[aq]t treated as a paragraph. The fact that the list is followed by a blank line is irrelevant. (Note: Pandoc works this way even when the C]markdown_strict] format is specified. This behavior is consistent with the official Markdown syntax description, even though it is different from that of C]Markdown.pl].)

Ending a list

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

C]
-   item one
-   item two

    { my code block }
]

Trouble! Here pandoc (like other Markdown implementations) will treat C]{ 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[aq]t produce visible output in any format:

C]
-   item one
-   item two

<!-- end of list -->

    { my code block }
]

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

C]
1.  one
2.  two
3.  three

<!-- -->

1.  uno
2.  dos
3.  tres
]

Horizontal rules

A line containing a row of three or more C]*], C]-], or C]_] characters (optionally separated by spaces) produces a horizontal rule:

C]
*  *  *  *

---------------
]

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: C]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 C]Table:] (or just C]:]), which will be stripped off. It may appear either before or after the table.

Extension: C]simple_tables]

Simple tables look like this:

C]
  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.
]

The headers 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:

[bu]

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.

[bu]

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.

[bu]

If the dashed line extends beyond the header text on both sides, the column is centered.

[bu]

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 headers may be omitted, provided a dashed line is used to end the table. For example:

C]
-------     ------ ----------   -------
     12     12        12             12
    123     123       123           123
      1     1          1              1
-------     ------ ----------   -------
]

When headers are 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: C]multiline_tables]

Multiline tables allow headers 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:

C]
-------------------------------------------------------------
 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[aq]s another one. Note
                                    the blank line between
                                    rows.
-------------------------------------------------------------

Table: Here[aq]s the caption. It, too, may span
multiple lines.
]

These work like simple tables, but with the following differences:

[bu]

They must begin with a row of dashes, before the header text (unless the headers are omitted).

[bu]

They must end with a row of dashes, then a blank line.

[bu]

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.

Headers may be omitted in multiline tables as well as simple tables:

C]
----------- ------- --------------- -------------------------
   First    row                12.0 Example of a row that
                                    spans multiple lines.

  Second    row                 5.0 Here[aq]s another one. Note
                                    the blank line between
                                    rows.
----------- ------- --------------- -------------------------

: Here[aq]s a multiline table without headers.
]

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: C]grid_tables]

Grid tables look like this:

C]
: Sample grid table.

+---------------+---------------+--------------------+
| Fruit         | Price         | Advantages         |
+===============+===============+====================+
| Bananas       | $1.34         | - built-in wrapper |
|               |               | - bright color     |
+---------------+---------------+--------------------+
| Oranges       | $2.10         | - cures scurvy     |
|               |               | - tasty            |
+---------------+---------------+--------------------+
]

The row of C]=]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.). Alignments are not supported, nor are cells that span multiple columns or rows. Grid tables can be created easily using Emacs table mode.

Extension: C]pipe_tables]

Pipe tables look like this:

C]
| Right | Left | Default | Center |
|------:|:-----|---------|:------:|
|   12  |  12  |    12   |    12  |
|  123  |  123 |   123   |   123  |
|    1  |    1 |     1   |     1  |

  : 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:

C]
fruit| price
-----|-----:
apple|2.05
pear|1.37
orange|3.09
]

The cells of pipe tables cannot contain block elements like paragraphs and lists, and cannot span multiple lines. If a pipe table contains a row whose printable content is wider than the column width (see C]--columns]), then the cell contents will wrap, with the relative cell widths determined by the widths of the separator lines.

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

C]
| One | Two   |
|-----+-------|
| my  | table |
| is  | nice  |
]

The difference is that C]+] is used instead of C]|]. Other orgtbl features are not supported. In particular, to get non-default column alignment, you[aq]ll need to add colons as above.

Metadata blocks

Extension: C]pandoc_title_block]

If the file begins with a title block

C]
% 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:

C]
%
% Author

% My title
%
% June 15, 2006
]

The title may occupy multiple lines, but continuation lines must begin with leading space, thus:

C]
% 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:

C]
% 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 C]--standalone] (C]-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 (C]--title-prefix] or C]-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 C]-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 (C]|]) should be used to separate the footer text from the header text. Thus,

C]
% PANDOC(1)
]

will yield a man page with the title C]PANDOC] and section 1.

C]
% PANDOC(1) Pandoc User Manuals
]

will also have "Pandoc User Manuals" in the footer.

C]
% PANDOC(1) Pandoc User Manuals | Version 4.0
]

will also have "Version 4.0" in the header.

Extension: C]yaml_metadata_block]

A YAML metadata block is a valid YAML object, delimited by a line of three hyphens (C]---]) at the top and a line of three hyphens (C]---]) or three dots (C]...]) 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:

C]
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
]

Just be sure that the YAML file begins with C]---] and ends with C]---] or C]...].)

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.)

A document may contain multiple metadata blocks. The metadata fields will be combined through a I]left-biased union]: if two metadata blocks attempt to set the same field, the value from the first block will be taken.

When pandoc is used with C]-t markdown] to create a Markdown document, a YAML metadata block will be produced only if the C]-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. The pipe character (C]|]) 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:

C]
---
title:  [aq]This is the title: it contains a colon[aq]
author:
- name: Author One
  affiliation: University of Somewhere
- name: Author Two
  affiliation: University of Nowhere
tags: [nothing, nothingness]
abstract: |
  This is the abstract.

  It consists of two paragraphs.
...
]

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

C]
<p>This is the abstract.</p>
<p>It consists of two paragraphs.</p>
]

Note: The C]author] variable in the default templates expects a simple list or string. To use the structured authors in the example, you would need a custom template. For example:

C]
$for(author)$
$if(author.name)$
$author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
$else$
$author$
$endif$
$endfor$
]

Backslash escapes

Extension: C]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

C]
*\*hello\**
]

one will get

C]
<em>*hello*</em>
]

instead of

C]
<strong>hello</strong>
]

This rule is easier to remember than standard Markdown[aq]s rule, which allows only the following characters to be backslash-escaped:

C]
\`*_{}[]()>#+-.!
]

(However, if the C]markdown_strict] format is used, the standard Markdown rule will be used.)

A backslash-escaped space is parsed as a nonbreaking space. It will appear in TeX output as C]~] and in HTML and XML as C]\&#160;] or C]\&nbsp;].

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 C]\\] and in HTML as C]<br />]. This is a nice alternative to Markdown[aq]s "invisible" way of indicating hard line breaks using two trailing spaces on a line.

Backslash escapes do not work in verbatim contexts.

Smart punctuation

Extension

If the C]--smart] option is specified, pandoc will produce typographically correct output, converting straight quotes to curly quotes, C]---] to em-dashes, C]--] to en-dashes, and C]...] to ellipses. Nonbreaking spaces are inserted after certain abbreviations, such as "Mr."

Note: if your LaTeX template or any included header file call for the C]csquotes] package, pandoc will detect this automatically and use C]\enquote{...}] for quoted text.

Inline formatting

Emphasis

To I]emphasize] some text, surround it with C]*]s or C]_], like this:

C]
This text is _emphasized with underscores_, and this
is *emphasized with asterisks*.
]

Double C]*] or C]_] produces B]strong emphasis]:

C]
This is **strong emphasis** and __with underscores__.
]

A C]*] or C]_] character surrounded by spaces, or backslash-escaped, will not trigger emphasis:

C]
This is * not emphasized *, and \*neither is this\*.
]

Extension: C]intraword_underscores]

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

C]
feas*ible*, not feas*able*.
]

Strikeout

Extension: C]strikeout]

To strikeout a section of text with a horizontal line, begin and end it with C]~~]. Thus, for example,

C]
This ~~is deleted text.~~
]

Superscripts and subscripts

Extension: C]superscript], C]subscript]

Superscripts may be written by surrounding the superscripted text by C]^] characters; subscripts may be written by surrounding the subscripted text by C]~] characters. Thus, for example,

C]
H~2~O is a liquid.  2^10^ is 1024.
]

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 C]~] and C]^].) Thus, if you want the letter P with [aq]a cat[aq] in subscripts, use C]P~a\ cat~], not C]P~a cat~].

Verbatim

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

C]
What is the difference between `>>=` and `>>`?
]

If the verbatim text includes a backtick, use double backticks:

C]
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:

C]
This is a backslash followed by an asterisk: `\*`.
]

Extension: C]inline_code_attributes]

Attributes can be attached to verbatim text, just as with fenced code blocks:

C]
`<$>`{.haskell}
]

Small caps

To write small caps, you can use an HTML span tag:

C]
<span style="font-variant:small-caps;">Small caps</span>
]

(The semicolon is optional and there may be space after the colon.) This will work in all output formats that support small caps.

Math

Extension: C]tex_math_dollars]

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

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

Markdown, LaTeX, Emacs Org mode, ConTeXt

It will appear verbatim between C]$] characters.

reStructuredText

It will be rendered using an interpreted text role C]:math:].

AsciiDoc

It will be rendered as C]latexmath:[...]].

Texinfo

It will be rendered inside a C]@math] command.

groff man

It will be rendered verbatim without C]$][aq]s.

MediaWiki, DokuWiki

It will be rendered inside C]<math>] tags.

Textile

It will be rendered inside C]<span class="math">] tags.

RTF, OpenDocument, ODT

It will be rendered, if possible, using unicode characters, and will otherwise appear verbatim.

DocBook

If the C]--mathml] flag is used, it will be rendered using MathML in an C]inlineequation] or C]informalequation] tag. Otherwise it will be rendered, if possible, using unicode characters.

Docx

It will be rendered using OMML math markup.

FictionBook2

If the C]--webtex] option is used, formulas are rendered as images using Google Charts 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:

1.

The default is to render TeX math as far as possible using unicode characters, as with RTF, DocBook, and OpenDocument output. Formulas are put inside a C]span] with C]class="math"], so that they may be styled differently from the surrounding text if needed.

2.

If the C]--latexmathml] option is used, TeX math will be displayed between C]$] or C]$$] characters and put in C]<span>] tags with class C]LaTeX]. The LaTeXMathML script will be used to render it as formulas. (This trick does not work in all browsers, but it works in Firefox. In browsers that do not support LaTeXMathML, TeX math will appear verbatim between C]$] characters.)

3.

If the C]--jsmath] option is used, TeX math will be put inside C]<span>] tags (for inline math) or C]<div>] tags (for display math) with class C]math]. The jsMath script will be used to render it.

4.

If the C]--mimetex] option is used, the mimeTeX CGI script will be called to generate images for each TeX formula. This should work in all browsers. The C]--mimetex] option takes an optional URL as argument. If no URL is specified, it will be assumed that the mimeTeX CGI script is at C]/cgi-bin/mimetex.cgi].

5.

If the C]--gladtex] option is used, TeX formulas will be enclosed in C]<eq>] tags in the HTML output. The resulting C]htex] file may then be processed by gladTeX, which will produce image files for each formula and an HTML file with links to these images. So, the procedure is:

C]
pandoc -s --gladtex myfile.txt -o myfile.htex
gladtex -d myfile-images myfile.htex
# produces myfile.html and images in myfile-images
]

6.

If the C]--webtex] option is used, TeX formulas will be converted to C]<img>] tags that link to an external script that converts formulas to images. The formula will be URL-encoded and concatenated with the URL provided. If no URL is specified, the Google Chart API will be used (C]chart.apis.google.com/chart?cht=tx&chl=]).

7.

If the C]--mathjax] option is used, TeX math will be displayed between C]\(...\)] (for inline math) or C]\[...\]] (for display math) and put in C]<span>] tags with class C]math]. The MathJax script will be used to render it as formulas.

Raw HTML

Extension: C]raw_html]

Markdown allows you to insert raw HTML (or DocBook) anywhere in a document (except verbatim contexts, where C]<], C]>], and C]&] 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, and Textile output, and suppressed in other formats.

Extension: C]markdown_in_html_blocks]

Standard 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), C]*] does not signify emphasis.

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

C]
<table>
<tr>
<td>*one*</td>
<td>[a link](google.com</td>
</tr>
</table>
]

into

C]
<table>
<tr>
<td><em>one</em></td>
<td><a href="google.com">a link</a></td>
</tr>
</table>
]

whereas C]Markdown.pl] will preserve it as is.

There is one exception to this rule: text between C]<script>] and C]<style>] tags is not interpreted as Markdown.

This departure from standard Markdown should make it easier to mix Markdown with HTML block elements. For example, one can surround a block of Markdown text with C]<div>] tags without preventing it from being interpreted as Markdown.

Extension: C]native_divs]

Use native pandoc C]Div] blocks for content inside C]<div>] tags. For the most part this should give the same output as C]markdown_in_html_blocks], but it makes it easier to write pandoc filters to manipulate groups of blocks.

Extension: C]native_spans]

Use native pandoc C]Span] blocks for content inside C]<span>] tags. For the most part this should give the same output as C]raw_html], but it makes it easier to write pandoc filters to manipulate groups of inlines.

Raw TeX

Extension: C]raw_tex]

In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be included in a document. Inline TeX commands will be preserved and passed unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to include BibTeX citations:

C]
This result was proved in \cite{jones.1967}.
]

Note that in LaTeX environments, like

C]
\begin{tabular}{|l|l|}\hline
Age & Frequency \\ \hline
18--25  & 15 \\
26--35  & 33 \\
36--45  & 22 \\ \hline
\end{tabular}
]

the material between the begin and end tags will be interpreted as raw LaTeX, not as Markdown.

Inline LaTeX is ignored in output formats other than Markdown, LaTeX, and ConTeXt.

LaTeX macros

Extension: C]latex_macros]

For output formats other than LaTeX, pandoc will parse LaTeX C]\newcommand] and C]\renewcommand] definitions and apply the resulting macros to all LaTeX math. So, for example, the following will work in all output formats, not just LaTeX:

C]
\newcommand{\tuple}[1]{\langle #1 \rangle}

$\tuple{a, b, c}$
]

In LaTeX output, the C]\newcommand] definition will simply be passed unchanged to the output.

Links

Markdown allows links to be specified in several ways.

Automatic links

If you enclose a URL or email address in pointy brackets, it will become a link:

C]
<google.com>
<sam@green.eggs.ham>
]

Inline links

An inline link consists of the link text in square brackets, followed by the URL in parentheses. (Optionally, the URL can be followed by a link title, in quotes.)

C]
This is an [inline link](/url), and here[aq]s [one with
a title](fsf.org "click here for a good time!").
]

There can be no space between the bracketed part and the parenthesized part. The link text can contain formatting (such as emphasis), but the title cannot.

Email addresses in inline links are not autodetected, so they have to be prefixed with C]mailto]:

C]
[Write me!](mailto:sam@green.eggs.ham)
]

Reference links

An I]explicit] reference link has two parts, the link itself and the link definition, which may occur elsewhere in the document (either before or after the link).

The link consists of link text in square brackets, followed by a label in square brackets. (There can be space between the two.) The link definition consists of the bracketed label, followed by a colon and a space, followed by the URL, and optionally (after a space) a link title either in quotes or in parentheses. The label must not be parseable as a citation (assuming the C]citations] extension is enabled): citations take precedence over link labels.

Here are some examples:

C]
[my label 1]: /foo/bar.html  "My title, optional"
[my label 2]: /foo
[my label 3]: fsf.org (The free software foundation)
[my label 4]: /bar#special  [aq]A title in single quotes[aq]
]

The URL may optionally be surrounded by angle brackets:

C]
[my label 5]: <http://foo.bar.baz>
]

The title may go on the next line:

C]
[my label 3]: fsf.org
  "The free software foundation"
]

Note that link labels are not case sensitive. So, this will work:

C]
Here is [my link][FOO]

[Foo]: /bar/baz
]

In an I]implicit] reference link, the second pair of brackets is empty:

C]
See [my website][].

[my website]: http://foo.bar.baz
]

Note: In C]Markdown.pl] and most other Markdown implementations, reference link definitions cannot occur in nested constructions such as list items or block quotes. Pandoc lifts this arbitrary seeming restriction. So the following is fine in pandoc, though not in most other implementations:

C]
> My block [quote].
>
> [quote]: /foo
]

Extension: C]shortcut_reference_links]

In a I]shortcut] reference link, the second pair of brackets may be omitted entirely:

C]
See [my website].

[my website]: http://foo.bar.baz
]

Internal links

To link to another section of the same document, use the automatically generated identifier (see Header identifiers). For example:

C]
See the [Introduction](#introduction).
]

or

C]
See the [Introduction].

[Introduction]: #introduction
]

Internal links are currently supported for HTML formats (including HTML slide shows and EPUB), LaTeX, and ConTeXt.

Images

A link immediately preceded by a C]!] will be treated as an image. The link text will be used as the image[aq]s alt text:

C]
![la lune](lalune.jpg "Voyage to the moon")

![movie reel]

[movie reel]: movie.gif
]

Extension: C]implicit_figures]

An image occurring by itself in a paragraph will be rendered as a figure with a caption. (In LaTeX, a figure environment will be used; in HTML, the image will be placed in a C]div] with class C]figure], together with a caption in a C]p] with class C]caption].) The image[aq]s alt text will be used as the caption.

C]
![This is the caption](/url/of/image.png)
]

If you just want a regular inline image, just make sure it is not the only thing in the paragraph. One way to do this is to insert a nonbreaking space after the image:

C]
![This image won[aq]t be a figure](/url/of/image.png)\ 
]

Extension: C]link_attributes]

Attributes can be set on links and images:

C]
An inline ![image](foo.jpg){#id .class width=30 height=20px}
and a reference ![image][ref] with attributes.

[ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
]

(This syntax is compatible with PHP Markdown Extra when only C]#id] and C].class] are used.)

For HTML and EPUB, all attributes except C]width] and C]height] (but including C]srcset] and C]sizes]) are passed through as is. The other writers ignore attributes that are not supported by their output format.

The C]width] and C]height] attributes on images are treated specially. When used without a unit, the unit is assumed to be pixels. However, any of the following unit identifiers can be used: C]px], C]cm], C]mm], C]in], C]inch] and C]%]. There must not be any spaces between the number and the unit. For example:

C]
![](file.jpg){ width=50% }
]

[bu]

Dimensions are converted to inches for output in page-based formats like LaTeX. Dimensions are converted to pixels for output in HTML-like formats. Use the C]--dpi] option to specify the number of pixels per inch. The default is 96dpi.

[bu]

The C]%] unit is generally relative to some available space. For example the above example will render to C]<img href="file.jpg" style="width: 50%;" />] (HTML), C]\includegraphics[width=0.5\textwidth]{file.jpg}] (LaTeX), or C]\externalfigure[file.jpg][width=0.5\textwidth]] (ConTeXt).

[bu]

Some output formats have a notion of a class (ConTeXt) or a unique identifier (LaTeX C]\caption]), or both (HTML).

[bu]

When no C]width] or C]height] attributes are specified, the fallback is to look at the image resolution and the dpi metadata embedded in the image file.

Footnotes

Extension: C]footnotes]

Pandoc[aq]s Markdown allows footnotes, using the following syntax:

C]
Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here[aq]s one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

        { some.code }

    The whole paragraph can be indented, or just the first
    line.  In this way, multi-paragraph footnotes work like
    multi-paragraph list items.

This paragraph won[aq]t be part of the note, because it
isn[aq]t indented.
]

The identifiers in footnote references may not contain spaces, tabs, or newlines. These identifiers are used only to correlate the footnote reference with the note itself; in the output, footnotes will be numbered sequentially.

The footnotes themselves need not be placed at the end of the document. They may appear anywhere except inside other block elements (lists, block quotes, tables, etc.).

Extension: C]inline_notes]

Inline footnotes are also allowed (though, unlike regular notes, they cannot contain multiple paragraphs). The syntax is as follows:

C]
Here is an inline note.^[Inlines notes are easier to write, since
you don[aq]t have to pick an identifier and move down to type the
note.]
]

Inline and regular footnotes may be mixed freely.

Citations

Extension: C]citations]

Using an external filter, C]pandoc-citeproc], pandoc can automatically generate citations and a bibliography in a number of styles. Basic usage is

C]
pandoc --filter pandoc-citeproc myinput.txt
]

In order to use this feature, you will need to specify a bibliography file using the C]bibliography] metadata field in a YAML metadata section, or C]--bibliography] command line argument. You can supply multiple C]--bibliography] arguments or set C]bibliography] metadata field to YAML array, if you want to use multiple bibliography files. The bibliography may have any of these formats:

Note that C].bib] can be used with both BibTeX and BibLaTeX files; use C].bibtex] to force BibTeX.

Note that C]pandoc-citeproc --bib2json] and C]pandoc-citeproc --bib2yaml] can produce C].json] and C].yaml] files from any of the supported formats.

In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an HTML-like markup:

C]<i>...</i>]

italics

C]<b>...</b>]

bold

C]<span style=font-variant:small-caps;>...</span>] or C]<sc>...</sc>]

small capitals

C]_...]

subscript

C]^...]

superscript

C]<span class=nocase>...</span>]

prevent a phrase from being capitalized as title case

C]pandoc-citeproc -j] and C]-y] interconvert the CSL JSON and CSL YAML formats as far as possible.

As an alternative to specifying a bibliography file using C]--bibliography] or the YAML metadata field C]bibliography], you can include the citation data directly in the C]references] field of the document[aq]s YAML metadata. The field should contain an array of YAML-encoded references, for example:

C]
---
references:
- type: article-journal
  id: WatsonCrick1953
  author:
  - family: Watson
    given: J. D.
  - family: Crick
    given: F. H. C.
  issued:
    date-parts:
    - - 1953
      - 4
      - 25
  title: [aq]Molecular structure of nucleic acids: a structure for deoxyribose
    nucleic acid[aq]
  title-short: Molecular structure of nucleic acids
  container-title: Nature
  volume: 171
  issue: 4356
  page: 737-738
  DOI: 10.1038/171737a0
  URL: www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
  language: en-GB
...
]

(C]pandoc-citeproc --bib2yaml] can produce these from a bibliography file in one of the supported formats.)

Citations and references can be formatted using any style supported by the Citation Style Language, listed in the Zotero Style Repository. These files are specified using the C]--csl] option or the C]csl] metadata field. By default, C]pandoc-citeproc] will use the Chicago Manual of Style author-date format. The CSL project provides further information on finding and editing styles.

To make your citations hyperlinks to the corresponding bibliography entries, add C]link-citations: true] to your YAML metadata.

Citations go inside square brackets and are separated by semicolons. Each citation must have a key, composed of [aq]@[aq] + the citation identifier from the database, and may optionally have a prefix, a locator, and a suffix. The citation key must begin with a letter, digit, or C]_], and may contain alphanumerics, C]_], and internal punctuation characters (C]:.#$%&-+?<>~/]). Here are some examples:

C]
Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].

Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

Blah blah [@smith04; @doe99].
]

C]pandoc-citeproc] detects locator terms in the CSL locale files. Either abbreviated or unabbreviated forms are accepted. In the C]en-US] locale, locator terms can be written in either singular or plural forms, as C]book], C]bk.]/C]bks.]; C]chapter], C]chap.]/C]chaps.]; C]column], C]col.]/C]cols.]; C]figure], C]fig.]/C]figs.]; C]folio], C]fol.]/C]fols.]; C]number], C]no.]/C]nos.]; C]line], C]l.]/C]ll.]; C]note], C]n.]/C]nn.]; C]opus], C]op.]/C]opp.]; C]page], C]p.]/C]pp.]; C]paragraph], C]para.]/C]paras.]; C]part], C]pt.]/C]pts.]; C]section], C]sec.]/C]secs.]; C]sub verbo], C]s.v.]/C]s.vv.]; C]verse], C]v.]/C]vv.]; C]volume], C]vol.]/C]vols.]; C]¶]/C]¶¶]; C]§]/C]§§]. If no locator term is used, "page" is assumed.

A minus sign (C]-]) before the C]@] will suppress mention of the author in the citation. This can be useful when the author is already mentioned in the text:

C]
Smith says blah [-@smith04].
]

You can also write an in-text citation, as follows:

C]
@smith04 says blah.

@smith04 [p. 33] says blah.
]

If the style calls for a list of works cited, it will be placed at the end of the document. Normally, you will want to end your document with an appropriate header:

C]
last paragraph...

# References
]

The bibliography will be inserted after this header. Note that the C]unnumbered] class will be added to this header, so that the section will not be numbered.

If you want to include items in the bibliography without actually citing them in the body text, you can define a dummy C]nocite] metadata field and put the citations there:

C]
---
nocite: |
  @item1, @item2
...

@item3
]

In this example, the document will contain a citation for C]item3] only, but the bibliography will contain entries for C]item1], C]item2], and C]item3].

For LaTeX or PDF output, you can also use C]natbib] or C]biblatex] to render bibliography. In order to do so, specify bibliography files as outlined above, and add C]--natbib] or C]--biblatex] argument to C]pandoc] invocation. Bear in mind that bibliography files have to be in respective format (either BibTeX or BibLaTeX).

For more information, see the pandoc-citeproc man page.

Non-pandoc extensions

The following Markdown syntax extensions are not enabled by default in pandoc, but may be enabled by adding C]+EXTENSION] to the format name, where C]EXTENSION] is the name of the extension. Thus, for example, C]markdown+hard_line_breaks] is Markdown with hard line breaks.

Extension: C]lists_without_preceding_blankline]

Allow a list to occur right after a paragraph, with no intervening blank space.

Extension: C]hard_line_breaks]

Causes all newlines within a paragraph to be interpreted as hard line breaks instead of spaces.

Extension: C]ignore_line_breaks]

Causes newlines within a paragraph to be ignored, rather than being treated as spaces or as hard line breaks. This option is intended for use with East Asian languages where spaces are not used between words, but text is divided into lines for readability.

Extension: C]east_asian_line_breaks]

Causes newlines within a paragraph to be ignored, rather than being treated as spaces or as hard line breaks, when they occur between two East Asian wide characters. This is a better choice than C]ignore_line_breaks] for texts that include a mix of East Asian wide characters and other characters.

Extension: C]emoji]

Parses textual emojis like C]:smile:] as Unicode emoticons.

Extension: C]tex_math_single_backslash]

Causes anything between C]\(] and C]\)] to be interpreted as inline TeX math, and anything between C]\[] and C]\]] to be interpreted as display TeX math. Note: a drawback of this extension is that it precludes escaping C](] and C][].

Extension: C]tex_math_double_backslash]

Causes anything between C]\\(] and C]\\)] to be interpreted as inline TeX math, and anything between C]\\[] and C]\\]] to be interpreted as display TeX math.

Extension: C]markdown_attribute]

By default, pandoc interprets material inside block-level tags as Markdown. This extension changes the behavior so that Markdown is only parsed inside block-level tags if the tags have the attribute C]markdown=1].

Extension: C]mmd_title_block]

Enables a MultiMarkdown style title block at the top of the document, for example:

C]
Title:   My title
Author:  John Doe
Date:    September 1, 2008
Comment: This is a sample mmd title block, with
         a field spanning multiple lines.
]

See the MultiMarkdown documentation for details. If C]pandoc_title_block] or C]yaml_metadata_block] is enabled, it will take precedence over C]mmd_title_block].

Extension: C]abbreviations]

Parses PHP Markdown Extra abbreviation keys, like

C]
*[HTML]: Hypertext Markup Language
]

Note that the pandoc document model does not support abbreviations, so if this extension is enabled, abbreviation keys are simply skipped (as opposed to being parsed as paragraphs).

Extension: C]autolink_bare_uris]

Makes all absolute URIs into links, even when not surrounded by pointy braces C]<...>].

Extension: C]ascii_identifiers]

Causes the identifiers produced by C]auto_identifiers] to be pure ASCII. Accents are stripped off of accented latin letters, and non-latin letters are omitted.

Extension: C]mmd_link_attributes]

Parses multimarkdown style key-value attributes on link and image references. This extension should not be confused with the C]link_attributes] extension.

C]
This is a reference ![image][ref] with multimarkdown attributes.

[ref]: path.to/image "Image title" width=20px height=30px
       id=myId class="myClass1 myClass2"
]

Extension: C]mmd_header_identifiers]

Parses multimarkdown style header identifiers (in square brackets, after the header but before any trailing C]#]s in an ATX header).

Extension: C]compact_definition_lists]

Activates the definition list syntax of pandoc 1.12.x and earlier. This syntax differs from the one described above under Definition lists in several respects:

[bu]

No blank line is required between consecutive items of the definition list.

[bu]

To get a "tight" or "compact" list, omit space between consecutive items; the space between a term and its definition does not affect anything.

[bu]

Lazy wrapping of paragraphs is not allowed: the entire definition must be indented four spaces.

Markdown variants

In addition to pandoc[aq]s extended Markdown, the following Markdown variants are supported:

C]markdown_phpextra] (PHP Markdown Extra)

C]footnotes], C]pipe_tables], C]raw_html], C]markdown_attribute], C]fenced_code_blocks], C]definition_lists], C]intraword_underscores], C]header_attributes], C]link_attributes], C]abbreviations], C]shortcut_reference_links].

C]markdown_github] (GitHub-Flavored Markdown)

C]pipe_tables], C]raw_html], C]tex_math_single_backslash], C]fenced_code_blocks], C]auto_identifiers], C]ascii_identifiers], C]backtick_code_blocks], C]autolink_bare_uris], C]intraword_underscores], C]strikeout], C]hard_line_breaks], C]emoji], C]shortcut_reference_links].

C]markdown_mmd] (MultiMarkdown)

C]pipe_tables] C]raw_html], C]markdown_attribute], C]mmd_link_attributes], C]raw_tex], C]tex_math_double_backslash], C]intraword_underscores], C]mmd_title_block], C]footnotes], C]definition_lists], C]all_symbols_escapable], C]implicit_header_references], C]auto_identifiers], C]mmd_header_identifiers], C]shortcut_reference_links].

C]markdown_strict] (Markdown.pl)

C]raw_html]

Extensions with formats other than Markdown

Some of the extensions discussed above can be used with formats other than Markdown:

[bu]

C]auto_identifiers] can be used with C]latex], C]rst], C]mediawiki], and C]textile] input (and is used by default).

[bu]

C]tex_math_dollars], C]tex_math_single_backslash], and C]tex_math_double_backslash] can be used with C]html] input. (This is handy for reading web pages formatted using MathJax, for example.)

PRODUCING SLIDE SHOWS WITH PANDOC

You can use pandoc to produce an HTML + javascript slide presentation that can be viewed via a web browser. There are five ways to do this, using S5, DZSlides, Slidy, Slideous, or reveal.js. You can also produce a PDF slide show using LaTeX C]beamer].

Here[aq]s the Markdown source for a simple slide show, C]habits.txt]:

C]
% Habits
% John Doe
% March 22, 2005

# In the morning

## Getting up

- Turn off alarm
- Get out of bed

## Breakfast

- Eat eggs
- Drink coffee

# In the evening

## Dinner

- Eat spaghetti
- Drink wine

------------------

![picture of spaghetti](images/spaghetti.jpg)

## Going to sleep

- Get in bed
- Count sheep
]

To produce an HTML/javascript slide show, simply type

C]
pandoc -t FORMAT -s habits.txt -o habits.html
]

where C]FORMAT] is either C]s5], C]slidy], C]slideous], C]dzslides], or C]revealjs].

For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the C]-s/--standalone] option embeds a link to javascripts and CSS files, which are assumed to be available at the relative path C]s5/default] (for S5), C]slideous] (for Slideous), C]reveal.js] (for reveal.js), or at the Slidy website at C]w3.org] (for Slidy). (These paths can be changed by setting the C]slidy-url], C]slideous-url], C]revealjs-url], or C]s5-url] variables; see Variables for slides, above.) For DZSlides, the (relatively short) javascript and css are included in the file by default.

With all HTML slide formats, the C]--self-contained] option can be used to produce a single file that contains all of the data necessary to display the slide show, including linked scripts, stylesheets, images, and videos.

To produce a PDF slide show using beamer, type

C]
pandoc -t beamer habits.txt -o habits.pdf
]

Note that a reveal.js slide show can also be converted to a PDF by printing it to a file from the browser.

Structuring the slide show

By default, the I]slide level] is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. In the example above, level 1 headers are always followed by level 2 headers, which are followed by content, so 2 is the slide level. This default can be overridden using the C]--slide-level] option.

The document is carved up into slides according to the following rules:

[bu]

A horizontal rule always starts a new slide.

[bu]

A header at the slide level always starts a new slide.

[bu]

Headers I]below] the slide level in the hierarchy create headers I]within] a slide.

[bu]

Headers I]above] the slide level in the hierarchy create "title slides," which just contain the section title and help to break the slide show into sections.

[bu]

A title page is constructed automatically from the document[aq]s title block, if present. (In the case of beamer, this can be disabled by commenting out some lines in the default template.)

These rules are designed to support many different styles of slide show. If you don[aq]t care about structuring your slides into sections and subsections, you can just use level 1 headers for all each slide. (In that case, level 1 will be the slide level.) But you can also structure the slide show into sections, as in the example above.

Note: in reveal.js slide shows, if slide level is 2, a two-dimensional layout will be produced, with level 1 headers building horizontally and level 2 headers building vertically. It is not recommended that you use deeper nesting of section levels with reveal.js.

Incremental lists

By default, these writers produce lists that display "all at once." If you want your lists to display incrementally (one item at a time), use the C]-i] option. If you want a particular list to depart from the default (that is, to display incrementally without the C]-i] option and all at once with the C]-i] option), put it in a block quote:

C]
> - Eat spaghetti
> - Drink wine
]

In this way incremental and nonincremental lists can be mixed in a single document.

Inserting pauses

You can add "pauses" within a slide by including a paragraph containing three dots, separated by spaces:

C]
# Slide with a pause

content before the pause

. . .

content after the pause
]

Styling the slides

You can change the style of HTML slides by putting customized CSS files in C]$DATADIR/s5/default] (for S5), C]$DATADIR/slidy] (for Slidy), or C]$DATADIR/slideous] (for Slideous), where C]$DATADIR] is the user data directory (see C]--data-dir], above). The originals may be found in pandoc[aq]s system data directory (generally C]$CABALDIR/pandoc-VERSION/s5/default]). Pandoc will look there for any files it does not find in the user data directory.

For dzslides, the CSS is included in the HTML file itself, and may be modified there.

All reveal.js configuration options can be set through variables. For example, themes can be used by setting the C]theme] variable:

C]
-V theme=moon
]

Or you can specify a custom stylesheet using the C]--css] option.

To style beamer slides, you can specify a C]theme], C]colortheme], C]fonttheme], C]innertheme], and C]outertheme], using the C]-V] option:

C]
pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
]

Note that header attributes will turn into slide attributes (on a C]<div>] or C]<section>]) in HTML slide formats, allowing you to style individual slides. In beamer, the only header attribute that affects slides is the C]allowframebreaks] class, which sets the C]allowframebreaks] option, causing multiple slides to be created if the content overfills the frame. This is recommended especially for bibliographies:

C]
# References {.allowframebreaks}
]

Speaker notes

reveal.js has good support for speaker notes. You can add notes to your Markdown document thus:

C]
<div class="notes">
This is my note.

- It can contain Markdown
- like this list

</div>
]

To show the notes window, press C]s] while viewing the presentation. Notes are not yet supported for other slide formats, but the notes will not appear on the slides themselves.

Frame attributes in beamer

Sometimes it is necessary to add the LaTeX C][fragile]] option to a frame in beamer (for example, when using the C]minted] environment). This can be forced by adding the C]fragile] class to the header introducing the slide:

C]
# Fragile slide {.fragile}
]

All of the other frame attributes described in Section 8.1 of the Beamer User[aq]s Guide may also be used: C]allowdisplaybreaks], C]allowframebreaks], C]b], C]c], C]t], C]environment], C]label], C]plain], C]shrink].

CREATING EPUBS WITH PANDOC

EPUB Metadata

EPUB metadata may be specified using the C]--epub-metadata] option, but if the source document is Markdown, it is better to use a YAML metadata block. Here is an example:

C]
---
title:
- type: main
  text: My Book
- type: subtitle
  text: An investigation of metadata
creator:
- role: author
  text: John Smith
- role: editor
  text: Sarah Jones
identifier:
- scheme: DOI
  text: doi:10.234234.234/33
publisher:  My Press
rights: © 2007 John Smith, CC BY-NC
...
]

The following fields are recognized:

C]identifier]

Either a string value or an object with fields C]text] and C]scheme]. Valid values for C]scheme] are C]ISBN-10], C]GTIN-13], C]UPC], C]ISMN-10], C]DOI], C]LCCN], C]GTIN-14], C]ISBN-13], C]Legal deposit number], C]URN], C]OCLC], C]ISMN-13], C]ISBN-A], C]JP], C]OLCC].

C]title]

Either a string value, or an object with fields C]file-as] and C]type], or a list of such objects. Valid values for C]type] are C]main], C]subtitle], C]short], C]collection], C]edition], C]extended].

C]creator]

Either a string value, or an object with fields C]role], C]file-as], and C]text], or a list of such objects. Valid values for C]role] are MARC relators, but pandoc will attempt to translate the human-readable versions (like "author" and "editor") to the appropriate marc relators.

C]contributor]

Same format as C]creator].

C]date]

A string value in C]YYYY-MM-DD] format. (Only the year is necessary.) Pandoc will attempt to convert other common date formats.

C]lang] (or legacy: C]language])

A string value in BCP 47 format. Pandoc will default to the local language if nothing is specified.

C]subject]

A string value or a list of such values.

C]description]

A string value.

C]type]

A string value.

C]format]

A string value.

C]relation]

A string value.

C]coverage]

A string value.

C]rights]

A string value.

C]cover-image]

A string value (path to cover image).

C]stylesheet]

A string value (path to CSS stylesheet).

C]page-progression-direction]

Either C]ltr] or C]rtl]. Specifies the C]page-progression-direction] attribute for the C]spine] element.

Linked media

By default, pandoc will download linked media (including audio and video) and include it in the EPUB container, yielding a completely self-contained EPUB. If you want to link to external media resources instead, use raw HTML in your source and add C]data-external="1"] to the tag with the C]src] attribute. For example:

C]
<audio controls="1">
  <source src="http://example.com/music/toccata.mp3"
          data-external="1" type="audio/mpeg">
  </source>
</audio>
]

LITERATE HASKELL SUPPORT

If you append C]+lhs] (or C]+literate_haskell]) to an appropriate input or output format (C]markdown], C]markdown_strict], C]rst], or C]latex] for input or output; C]beamer], C]html] or C]html5] for output only), pandoc will treat the document as literate Haskell source. This means that

[bu]

In Markdown input, "bird track" sections will be parsed as Haskell code rather than block quotations. Text between C]\begin{code}] and C]\end{code}] will also be treated as Haskell code. For ATX-style headers the character [aq]=[aq] will be used instead of [aq]#[aq].

[bu]

In Markdown output, code blocks with classes C]haskell] and C]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, headers will be rendered setext-style (with underlines) rather than ATX-style (with [aq]#[aq] characters). (This is because ghc treats [aq]#[aq] characters in column 1 as introducing line numbers.)

[bu]

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

[bu]

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

[bu]

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

[bu]

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

[bu]

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

Examples:

C]
pandoc -f markdown+lhs -t html
]

reads literate Haskell source formatted with Markdown conventions and writes ordinary HTML (without bird tracks).

C]
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.

SYNTAX HIGHLIGHTING

Pandoc will automatically highlight syntax in fenced code blocks that are marked with a language name. The Haskell library highlighting-kate is used for highlighting, which works in HTML, Docx, and LaTeX/PDF output. The color scheme can be selected using the C]--highlight-style] option. The default color scheme is C]pygments], which imitates the default color scheme used by the Python library pygments, but pygments is not actually used to do the highlighting.

To see a list of language names that pandoc will recognize, type C]pandoc --version].

To disable highlighting, use the C]--no-highlight] option.

CUSTOM WRITERS

Pandoc can be extended with custom writers written in lua. (Pandoc includes a lua interpreter, so lua need not be installed separately.)

To use a custom writer, simply specify the path to the lua script in place of the output format. For example:

C]
pandoc -t data/sample.lua
]

Creating a custom writer requires writing a lua function for each possible element in a pandoc document. To get a documented example which you can modify according to your needs, do

C]
pandoc --print-default-data-file sample.lua
]

AUTHORS

© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)

Contributors include Aaron Wolen, Albert Krewinkel, Alexander Kondratskiy, Alexander Sulfrian, Alexander V Vershilov, Alfred Wechselberger, Andreas Lööw, Andrew Dunning, Antoine Latter, Arata Mizuki, Arlo O[aq]Keeffe, Artyom Kazak, Ben Gamari, Beni Cherniavsky-Paskin, Bjorn Buckwalter, Bradley Kuhn, Brent Yorgey, Bryan O[aq]Sullivan, B. Scott Michel, Caleb McDaniel, Calvin Beck, Christoffer Ackelman, Christoffer Sawicki, Clare Macrae, Clint Adams, Conal Elliott, Craig S. Bosma, Daniel Bergey, Daniel T. Staal, David Lazar, David Röthlisberger, Denis Laxalde, Douglas Calvert, Douglas F. Calvert, Eric Kow, Eric Seidel, Florian Eitel, François Gannaz, Freiric Barral, Fyodor Sheremetyev, Gabor Pali, Gavin Beatty, Greg Maslov, Grégory Bataille, Greg Rundlett, gwern, Gwern Branwen, Hans-Peter Deifel, Henry de Valence, Ilya V. Portnov, infinity0x, Jaime Marquínez Ferrándiz, James Aspnes, Jamie F. Olson, Jan Larres, Jason Ronallo, Jeff Arnold, Jeff Runningen, Jens Petersen, Jérémy Bobbio, Jesse Rosenthal, J. Lewis Muir, Joe Hillenbrand, John MacFarlane, Jonas Smedegaard, Jonathan Daugherty, Josef Svenningsson, Jose Luis Duran, Julien Cretel, Justin Bogner, Kelsey Hightower, Konstantin Zudov, Lars-Dominik Braun, Luke Plant, Mark Szepieniec, Mark Wright, Masayoshi Takahashi, Matej Kollar, Mathias Schenner, Matthew Pickering, Matthias C. M. Troffaes, Mauro Bieg, Max Bolingbroke, Max Rydahl Andersen, Merijn Verstraaten, Michael Snoyman, Michael Thompson, MinRK, Nathan Gass, Neil Mayhew, Nick Bart, Nicolas Kaiser, Nikolay Yakimov, nkalvi, Paulo Tanimoto, Paul Rivier, Peter Wang, Philippe Ombredanne, Phillip Alday, Puneeth Chaganti, qerub, Ralf Stephan, Recai Oktaş, rodja.trappe, RyanGlScott, Scott Morrison, Sergei Trofimovich, Sergey Astanin, Shahbaz Youssefi, Shaun Attfield, shreevatsa.public, Simon Hengel, Sumit Sahrawat, takahashim, thsutton, Tim Lin, Timothy Humphries, Todd Sifleet, Tom Leese, Uli Köhler, Václav Zeman, Viktor Kronvall, Vincent, Wikiwide, and Xavier Olive.

The Pandoc source code and all documentation may be downloaded from <pandoc.org>.