git.iko.soy/typeable/pandoc
on master help sign in
Started documenting individual syntax extensions in README.
6e548b8John MacFarlane
README+38−19
@@ -163,6 +163,14 @@ General options
163 will be rendered as literate Haskell source: see [Literate Haskell
163 will be rendered as literate Haskell source: see [Literate Haskell
164 support](#literate-haskell-support), below.
164 support](#literate-haskell-support), below.
165
165
166+`-e` *EXTENSION*, `--enable=`*EXTENSION*
167+: Enable the specified markdown syntax extension. For a list of extensions,
168+ see [Pandoc's markdown](#pandocs-markdown), below.
169+
170+`-d` *EXTENSION*, `--disable=`*EXTENSION*
171+: Disable the specified markdown syntax extension. For a list of extensions,
172+ see [Pandoc's markdown](#pandocs-markdown), below.
173+
166`-o` *FILE*, `--output=`*FILE*
174`-o` *FILE*, `--output=`*FILE*
167: Write output to *FILE* instead of *stdout*. If *FILE* is
175: Write output to *FILE* instead of *stdout*. If *FILE* is
168 `-`, output will go to *stdout*. (Exception: if the output
176 `-`, output will go to *stdout*. (Exception: if the output
@@ -760,7 +768,9 @@ Pandoc understands an extended and slightly revised version of
760John Gruber's [markdown] syntax. This document explains the syntax,
768John Gruber's [markdown] syntax. This document explains the syntax,
761noting differences from standard markdown. Except where noted, these
769noting differences from standard markdown. Except where noted, these
762differences can be suppressed by specifying the `--strict` command-line
770differences can be suppressed by specifying the `--strict` command-line
763−option.
771+option. They can also be disabled piecemeal using the `--disable`
772+(or `-d`) option. If `--strict` is used, `--enable` (or `-e`) can be
773+used to turn on specific extensions.
764
774
765Philosophy
775Philosophy
766----------
776----------
@@ -789,8 +799,11 @@ Paragraphs
789
799
790A paragraph is one or more lines of text followed by one or more blank line.
800A paragraph is one or more lines of text followed by one or more blank line.
791Newlines are treated as spaces, so you can reflow your paragraphs as you like.
801Newlines are treated as spaces, so you can reflow your paragraphs as you like.
792−If you need a hard line break, put two or more spaces at the end of a line,
802+If you need a hard line break, put two or more spaces at the end of a line.
803+
804+**Extension: `escaped_line_breaks`**
805+
793−or type a backslash followed by a newline.
806+A backslash followed by a newline is also a hard line break.
794
807
795Headers
808Headers
796-------
809-------
@@ -826,6 +839,8 @@ As with setext-style headers, the header text can contain formatting:
826
839
827 # A level-one header with a [link](/url) and *emphasis*
840 # A level-one header with a [link](/url) and *emphasis*
828
841
842+**Extension: `blank_before_header`**
843+
829Standard markdown syntax does not require a blank line before a header.
844Standard markdown syntax does not require a blank line before a header.
830Pandoc does require this (except, of course, at the beginning of the
845Pandoc does require this (except, of course, at the beginning of the
831document). The reason for the requirement is that it is all too easy for a
846document). The reason for the requirement is that it is all too easy for a
@@ -838,7 +853,7 @@ wrapping). Consider, for example:
838
853
839### Header identifiers in HTML, LaTeX, and ConTeXt ###
854### Header identifiers in HTML, LaTeX, and ConTeXt ###
840
855
841−*Pandoc extension*.
856+**Extension**
842
857
843Each header element in pandoc's HTML and ConTeXt output is given a
858Each header element in pandoc's HTML and ConTeXt output is given a
844unique identifier. This identifier is based on the text of the header.
859unique identifier. This identifier is based on the text of the header.
@@ -918,6 +933,8 @@ other block quotes. That is, block quotes can be nested:
918 >
933 >
919 > > A block quote within a block quote.
934 > > A block quote within a block quote.
920
935
936+**Extension: `blank_line_before_blockquote`**
937+
921Standard markdown syntax does not require a blank line before a block
938Standard markdown syntax does not require a blank line before a block
922quote. Pandoc does require this (except, of course, at the beginning of the
939quote. Pandoc does require this (except, of course, at the beginning of the
923document). The reason for the requirement is that it is all too easy for a
940document). The reason for the requirement is that it is all too easy for a
@@ -950,7 +967,7 @@ Note: blank lines in the verbatim text need not begin with four spaces.
950
967
951### Delimited code blocks ###
968### Delimited code blocks ###
952
969
953−*Pandoc extension*.
970+**Extension: `delimited_code_blocks`**
954
971
955In addition to standard indented code blocks, Pandoc supports
972In addition to standard indented code blocks, Pandoc supports
956*delimited* code blocks. These begin with a row of three or more
973*delimited* code blocks. These begin with a row of three or more
@@ -1131,7 +1148,7 @@ and this one:
1131 7. two
1148 7. two
1132 1. three
1149 1. three
1133
1150
1134−*Pandoc extension*.
1151+**Extension: `fancy_lists`**
1135
1152
1136Unlike standard markdown, Pandoc allows ordered list items to be marked
1153Unlike standard markdown, Pandoc allows ordered list items to be marked
1137with uppercase and lowercase letters and roman numerals, in addition to
1154with uppercase and lowercase letters and roman numerals, in addition to
@@ -1156,6 +1173,8 @@ capital letter with a period, by at least two spaces.[^2]
1156
1173
1157 (C\) 2007 Joe Smith
1174 (C\) 2007 Joe Smith
1158
1175
1176+**Extension: `startnum`**
1177+
1159Pandoc also pays attention to the type of list marker used, and to the
1178Pandoc also pays attention to the type of list marker used, and to the
1160starting number, and both of these are preserved where possible in the
1179starting number, and both of these are preserved where possible in the
1161output format. Thus, the following yields a list with numbers followed
1180output format. Thus, the following yields a list with numbers followed
@@ -1186,7 +1205,7 @@ If default list markers are desired, use `#.`:
1186
1205
1187### Definition lists ###
1206### Definition lists ###
1188
1207
1189−*Pandoc extension*.
1208+*Extension*.
1190
1209
1191Pandoc supports definition lists, using a syntax inspired by
1210Pandoc supports definition lists, using a syntax inspired by
1192[PHP Markdown Extra] and [reStructuredText]:[^3]
1211[PHP Markdown Extra] and [reStructuredText]:[^3]
@@ -1231,7 +1250,7 @@ definition and the next term:
1231
1250
1232### Numbered example lists ###
1251### Numbered example lists ###
1233
1252
1234−*Pandoc extension*.
1253+*Extension*.
1235
1254
1236The special list marker `@` can be used for sequentially numbered
1255The special list marker `@` can be used for sequentially numbered
1237examples. The first list item with a `@` marker will be numbered '1',
1256examples. The first list item with a `@` marker will be numbered '1',
@@ -1333,7 +1352,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
1333Tables
1352Tables
1334------
1353------
1335
1354
1336−*Pandoc extension*.
1355+*Extension*.
1337
1356
1338Four kinds of tables may be used. The first three kinds presuppose the use of
1357Four kinds of tables may be used. The first three kinds presuppose the use of
1339a fixed-width font, such as Courier. The fourth kind can be used with
1358a fixed-width font, such as Courier. The fourth kind can be used with
@@ -1496,7 +1515,7 @@ and lists, and cannot span multiple lines.
1496Title block
1515Title block
1497-----------
1516-----------
1498
1517
1499−*Pandoc extension*.
1518+*Extension*.
1500
1519
1501If the file begins with a title block
1520If the file begins with a title block
1502
1521
@@ -1613,7 +1632,7 @@ Backslash escapes do not work in verbatim contexts.
1613Smart punctuation
1632Smart punctuation
1614-----------------
1633-----------------
1615
1634
1616−*Pandoc extension*.
1635+*Extension*.
1617
1636
1618If the `--smart` option is specified, pandoc will produce typographically
1637If the `--smart` option is specified, pandoc will produce typographically
1619correct output, converting straight quotes to curly quotes, `---` to
1638correct output, converting straight quotes to curly quotes, `---` to
@@ -1652,7 +1671,7 @@ just part of a word, use `*`:
1652
1671
1653### Strikeout ###
1672### Strikeout ###
1654
1673
1655−*Pandoc extension*.
1674+*Extension*.
1656
1675
1657To strikeout a section of text with a horizontal line, begin and end it
1676To strikeout a section of text with a horizontal line, begin and end it
1658with `~~`. Thus, for example,
1677with `~~`. Thus, for example,
@@ -1662,7 +1681,7 @@ with `~~`. Thus, for example,
1662
1681
1663### Superscripts and subscripts ###
1682### Superscripts and subscripts ###
1664
1683
1665−*Pandoc extension*.
1684+*Extension*.
1666
1685
1667Superscripts may be written by surrounding the superscripted text by `^`
1686Superscripts may be written by surrounding the superscripted text by `^`
1668characters; subscripts may be written by surrounding the subscripted
1687characters; subscripts may be written by surrounding the subscripted
@@ -1708,7 +1727,7 @@ Attributes can be attached to verbatim text, just as with
1708Math
1727Math
1709----
1728----
1710
1729
1711−*Pandoc extension*.
1730+*Extension*.
1712
1731
1713Anything between two `$` characters will be treated as TeX math. The
1732Anything between two `$` characters will be treated as TeX math. The
1714opening `$` must have a character immediately to its right, while the
1733opening `$` must have a character immediately to its right, while the
@@ -1818,7 +1837,7 @@ The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
1818DZSlides, EPUB,
1837DZSlides, EPUB,
1819Markdown, and Textile output, and suppressed in other formats.
1838Markdown, and Textile output, and suppressed in other formats.
1820
1839
1821−*Pandoc extension*.
1840+*Extension*.
1822
1841
1823Standard markdown allows you to include HTML "blocks": blocks
1842Standard markdown allows you to include HTML "blocks": blocks
1824of HTML between balanced tags that are separated from the surrounding text
1843of HTML between balanced tags that are separated from the surrounding text
@@ -1859,7 +1878,7 @@ from being interpreted as markdown.
1859Raw TeX
1878Raw TeX
1860-------
1879-------
1861
1880
1862−*Pandoc extension*.
1881+*Extension*.
1863
1882
1864In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
1883In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
1865included in a document. Inline TeX commands will be preserved and passed
1884included in a document. Inline TeX commands will be preserved and passed
@@ -1999,7 +2018,7 @@ The link text will be used as the image's alt text:
1999
2018
2000### Pictures with captions ###
2019### Pictures with captions ###
2001
2020
2002−*Pandoc extension*.
2021+*Extension*.
2003
2022
2004An image occurring by itself in a paragraph will be rendered as
2023An image occurring by itself in a paragraph will be rendered as
2005a figure with a caption.[^5] (In LaTeX, a figure environment will be
2024a figure with a caption.[^5] (In LaTeX, a figure environment will be
@@ -2023,7 +2042,7 @@ nonbreaking space after the image:
2023Footnotes
2042Footnotes
2024---------
2043---------
2025
2044
2026−*Pandoc extension*.
2045+*Extension*.
2027
2046
2028Pandoc's markdown allows footnotes, using the following syntax:
2047Pandoc's markdown allows footnotes, using the following syntax:
2029
2048
@@ -2067,7 +2086,7 @@ Inline and regular footnotes may be mixed freely.
2067Citations
2086Citations
2068---------
2087---------
2069
2088
2070−*Pandoc extension*.
2089+*Extension*.
2071
2090
2072Pandoc can automatically generate citations and a bibliography in a number of
2091Pandoc can automatically generate citations and a bibliography in a number of
2073styles (using Andrea Rossato's `hs-citeproc`). In order to use this feature,
2092styles (using Andrea Rossato's `hs-citeproc`). In order to use this feature,