28debcd · typeable/pandoc

930Newlines are treated as spaces, so you can reflow your paragraphs as you like.

931If you need a hard line break, put two or more spaces at the end of a line.

932

933−**Extension: `escaped_line_breaks`**

933+### Extension: `escaped_line_breaks` ###

934

935A backslash followed by a newline is also a hard line break.

936Note: in multiline and grid table cells, this is the only way

971

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

973

974−**Extension: `blank_before_header`**

974+#### Extension: `blank_before_header` ####

975

976Standard markdown syntax does not require a blank line before a header.

977Pandoc does require this (except, of course, at the beginning of the

985

986### Header identifiers in HTML, LaTeX, and ConTeXt ###

987

988−**Extension: `header_attributes`**

988+#### Extension: `header_attributes` ####

989

990Headers can be assigned attributes using this syntax at the end

991of the line containing the header text:

1021

1022 # My header {.unnumbered}

1023

1024−**Extension: `auto_identifiers`**

1024+#### Extension: `auto_identifiers` ####

1025

1026A header without an explicitly specified identifier will be

1027automatically assigned a unique identifier based on the header text.

1070sections to be manipulated using javascript or treated differently in

1071CSS.

1072

1073−**Extension: `implicit_header_references`**

1073+#### Extension: `implicit_header_references` ####

1074

1075Pandoc behaves as if reference links have been defined for each header.

1076So, instead of

1129 >

1130 > > A block quote within a block quote.

1131

1132−**Extension: `blank_before_blockquote`**

1132+### Extension: `blank_before_blockquote` ###

1133

1134Standard markdown syntax does not require a blank line before a block

1135quote. Pandoc does require this (except, of course, at the beginning of the

1163

1164### Fenced code blocks ###

1165

1166−**Extension: `fenced_code_blocks`**

1166+#### Extension: `fenced_code_blocks` ####

1167

1168In addition to standard indented code blocks, Pandoc supports

1169*fenced* code blocks. These begin with a row of three or more

1189 ~~~~~~~~~~

1190 ~~~~~~~~~~~~~~~~

1191

1192−**Extension: `fenced_code_attributes`**

1192+#### Extension: `fenced_code_attributes` ####

1193

1194Optionally, you may attach attributes to the code block using

1195this syntax:

1238Line blocks

1239-----------

1240

1241−**Extension: `line_blocks`**

1241+### Extension: `line_blocks` ###

1242

1243A line block is a sequence of lines beginning with a vertical bar (`|`)

1244followed by a space. The division into lines will be preserved in

1380 7. two

1381 1. three

1382

1383−**Extension: `fancy_lists`**

1383+#### Extension: `fancy_lists` ####

1384

1385Unlike standard markdown, Pandoc allows ordered list items to be marked

1386with uppercase and lowercase letters and roman numerals, in addition to

1411 #. one

1412 #. two

1413

1414−**Extension: `startnum`**

1414+#### Extension: `startnum` ####

1415

1416Pandoc also pays attention to the type of list marker used, and to the

1417starting number, and both of these are preserved where possible in the

1443

1444### Definition lists ###

1445

1446−**Extension: `definition_lists`**

1446+#### Extension: `definition_lists` ####

1447

1448Pandoc supports definition lists, using the syntax of

1449[PHP Markdown Extra] with some extensions.[^3]

1504

1505### Numbered example lists ###

1506

1507−**Extension: `example_lists`**

1507+#### Extension: `example_lists` ####

1508

1509The special list marker `@` can be used for sequentially numbered

1510examples. The first list item with a `@` marker will be numbered '1',

1610a fixed-width font, such as Courier. The fourth kind can be used with

1611proportionally spaced fonts, as it does not require lining up columns.

1612

1613−### Simple tables

1613+### Simple tables ###

1614

1615−**Extension: `simple_tables`, `table_captions`**

1615+#### Extension: `simple_tables`, `table_captions` ####

1616

1617Simple tables look like this:

1618

1659of the first line of the table body. So, in the tables above, the columns

1660would be right, left, center, and right aligned, respectively.

1661

1662−### Multiline tables

1662+### Multiline tables ###

1663

1664−**Extension: `multiline_tables`, `table_captions`**

1664+#### Extension: `multiline_tables`, `table_captions` ####

1665

1666Multiline tables allow headers and table rows to span multiple lines

1667of text (but cells that span multiple columns or rows of the table are

1711should be followed by a blank line (and then the row of dashes that ends

1712the table), or the table may be interpreted as a simple table.

1713

1714−### Grid tables

1714+### Grid tables ###

1715

1716−**Extension: `grid_tables`, `table_captions`**

1716+#### Extension: `grid_tables`, `table_captions` ####

1717

1718Grid tables look like this:

1719

1737

1738 [Emacs table mode]: http://table.sourceforge.net/

1739

1740−### Pipe tables

1740+### Pipe tables ###

1741

1742−**Extension: `pipe_tables`, `table_captions`**

1742+#### Extension: `pipe_tables`, `table_captions` ####

1743

1744Pipe tables look like this:

1745

1788Title block

1789-----------

1790

1791−**Extension: `pandoc_title_block`**

1791+### Extension: `pandoc_title_block` ###

1792

1793If the file begins with a title block

1794

1867YAML metadata block

1868-------------------

1869

1870−**Extension: `yaml_metadata_block`**

1870+### Extension: `yaml_metadata_block` ###

1871

1872A YAML metadata block is a valid YAML object, delimited by a line of three

1873hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

1935Backslash escapes

1936-----------------

1937

1938−**Extension: `all_symbols_escapable`**

1938+### Extension: `all_symbols_escapable` ###

1939

1940Except inside a code block or inline code, any punctuation or space

1941character preceded by a backslash will be treated literally, even if it

1974Smart punctuation

1975-----------------

1976

1977−**Extension**

1977+### Extension ###

1978

1979If the `--smart` option is specified, pandoc will produce typographically

1980correct output, converting straight quotes to curly quotes, `---` to

2003

2004 This is * not emphasized *, and \*neither is this\*.

2005

2006−**Extension: `intraword_underscores`**

2006+#### Extension: `intraword_underscores` ####

2007

2008Because `_` is sometimes used inside words and identifiers,

2009pandoc does not interpret a `_` surrounded by alphanumeric

2015

2016### Strikeout ###

2017

2018−**Extension: `strikeout`**

2018+#### Extension: `strikeout` ####

2019

2020To strikeout a section of text with a horizontal line, begin and end it

2021with `~~`. Thus, for example,

2025

2026### Superscripts and subscripts ###

2027

2028−**Extension: `superscript`, `subscript`**

2028+#### Extension: `superscript`, `subscript` ####

2029

2030Superscripts may be written by surrounding the superscripted text by `^`

2031characters; subscripts may be written by surrounding the subscripted

2063

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

2065

2066−**Extension: `inline_code_attributes`**

2066+#### Extension: `inline_code_attributes` ####

2067

2068Attributes can be attached to verbatim text, just as with

2069[fenced code blocks](#fenced-code-blocks):

2082Math

2083----

2084

2085−**Extension: `tex_math_dollars`**

2085+### Extension: `tex_math_dollars` ###

2086

2087Anything between two `$` characters will be treated as TeX math. The

2088opening `$` must have a character immediately to its right, while the

2184Raw HTML

2185--------

2186

2187−**Extension: `raw_html`**

2187+### Extension: `raw_html` ###

2188

2189Markdown allows you to insert raw HTML (or DocBook) anywhere in a document

2190(except verbatim contexts, where `<`, `>`, and `&` are interpreted

2196DZSlides, EPUB, Markdown, and Textile output, and suppressed in other

2197formats.

2198

2199−**Extension: `markdown_in_html_blocks`**

2199+### Extension: `markdown_in_html_blocks` ###

2200

2201Standard markdown allows you to include HTML "blocks": blocks

2202of HTML between balanced tags that are separated from the surrounding text

2237Raw TeX

2238-------

2239

2240−**Extension: `raw_tex`**

2240+### Extension: `raw_tex` ###

2241

2242In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be

2243included in a document. Inline TeX commands will be preserved and passed

2264LaTeX macros

2265------------

2266

2267−**Extension: `latex_macros`**

2267+### Extension: `latex_macros` ###

2268

2269For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and

2270`\renewcommand` definitions and apply the resulting macros to all LaTeX

2356 >

2357 > [quote]: /foo

2358

2359−### Internal links

2359+### Internal links ###

2360

2361To link to another section of the same document, use the automatically

2362generated identifier (see [Header identifiers in HTML, LaTeX, and

2388

2389### Pictures with captions ###

2390

2391−**Extension: `implicit_figures`**

2391+#### Extension: `implicit_figures` ####

2392

2393An image occurring by itself in a paragraph will be rendered as

2394a figure with a caption.[^5] (In LaTeX, a figure environment will be

2412Footnotes

2413---------

2414

2415−**Extension: `footnotes`**

2415+### Extension: `footnotes` ###

2416

2417Pandoc's markdown allows footnotes, using the following syntax:

2418

2443document. They may appear anywhere except inside other block elements

2444(lists, block quotes, tables, etc.).

2445

2446−**Extension: `inline_notes`**

2446+### Extension: `inline_notes` ###

2447

2448Inline footnotes are also allowed (though, unlike regular notes,

2449they cannot contain multiple paragraphs). The syntax is as follows:

2458Citations

2459---------

2460

2461−**Extension: `citations`**

2461+### Extension: `citations` ###

2462

2463Using an external filter, `pandoc-citeproc`, pandoc can automatically generate

2464citations and a bibliography in a number of styles. Basic usage is

2580name, where `EXTENSION` is the name of the extension. Thus, for

2581example, `markdown+hard_line_breaks` is markdown with hard line breaks.

2582

2583−**Extension: `lists_without_preceding_blankline`**\

2583+### Extension: `lists_without_preceding_blankline` ###

2584Allow a list to occur right after a paragraph, with no intervening

2585blank space.

2586

2587−**Extension: `hard_line_breaks`**\

2587+### Extension: `hard_line_breaks` ###

2588Causes all newlines within a paragraph to be interpreted as hard line

2589breaks instead of spaces.

2590

2591−**Extension: `ignore_line_breaks`**\

2591+### Extension: `ignore_line_breaks` ###

2592Causes newlines within a paragraph to be ignored, rather than being

2593treated as spaces or as hard line breaks. This option is intended for

2594use with East Asian languages where spaces are not used between words,

2595but text is divided into lines for readability.

2596

2597−**Extension: `tex_math_single_backslash`**\

2597+### Extension: `tex_math_single_backslash` ###

2598Causes anything between `$` and `$` to be interpreted as inline

2599TeX math, and anything between `\[` and `\]` to be interpreted

2600as display TeX math. Note: a drawback of this extension is that

2601it precludes escaping `(` and `[`.

2602

2603−**Extension: `tex_math_double_backslash`**\

2603+### Extension: `tex_math_double_backslash` ###

2604Causes anything between `\$` and `\$` to be interpreted as inline

2605TeX math, and anything between `\\[` and `\\]` to be interpreted

2606as display TeX math.

2607

2608−**Extension: `markdown_attribute`**\

2608+### Extension: `markdown_attribute` ###

2609By default, pandoc interprets material inside block-level tags as markdown.

2610This extension changes the behavior so that markdown is only parsed

2611inside block-level tags if the tags have the attribute `markdown=1`.

2612

2613−**Extension: `mmd_title_block`**\

2613+### Extension: `mmd_title_block` ###

2614Enables a [MultiMarkdown] style title block at the top of

2615the document, for example:

2616

2626

2627 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

2628

2629−**Extension: `abbreviations`**\

2629+### Extension: `abbreviations` ###

2630Parses PHP Markdown Extra abbreviation keys, like

2631

2632 *[HTML]: Hyper Text Markup Language

2635abbreviations, so if this extension is enabled, abbreviation keys are

2636simply skipped (as opposed to being parsed as paragraphs).

2637

2638−**Extension: `autolink_bare_uris`**\

2638+### Extension: `autolink_bare_uris` ###

2639Makes all absolute URIs into links, even when not surrounded by

2640pointy braces `<...>`.

2641

2642−**Extension: `ascii_identifiers`**\

2642+### Extension: `ascii_identifiers` ###

2643Causes the identifiers produced by `auto_identifiers` to be pure ASCII.

2644Accents are stripped off of accented latin letters, and non-latin

2645letters are omitted.

2646

2647−**Extension: `link_attributes`**\

2647+### Extension: `link_attributes` ###

2648Parses multimarkdown style key-value attributes on link and image references.

2649Note that pandoc's internal document model provides nowhere to put

2650these, so they are presently just ignored.

2651

2652−**Extension: `mmd_header_identifiers`**\

2652+### Extension: `mmd_header_identifiers` ###

2653Parses multimarkdown style header identifiers (in square brackets,

2654after the header but before any trailing `#`s in an ATX header).

2655

2656−**Extension: `compact_definition_lists`**\

2656+### Extension: `compact_definition_lists` ###

2657Activates the definition list syntax of pandoc 1.12.x and earlier.

2658This syntax differs from the one described [above](#definition-lists)

2659in several respects: