Documentation for delimited code blocks.
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1208 788f1e2b-df1e-0410-8736-df70ead52e1b
This commit is contained in:
parent
f2354590f9
commit
705340824d
1 changed files with 51 additions and 2 deletions
53
README
53
README
|
@ -452,8 +452,8 @@ with `~~`. Thus, for example,
|
||||||
|
|
||||||
This ~~is deleted text.~~
|
This ~~is deleted text.~~
|
||||||
|
|
||||||
Lists
|
Nested Lists
|
||||||
-----
|
------------
|
||||||
|
|
||||||
Pandoc behaves differently from standard markdown on some "edge
|
Pandoc behaves differently from standard markdown on some "edge
|
||||||
cases" involving lists. Consider this source:
|
cases" involving lists. Consider this source:
|
||||||
|
@ -477,6 +477,9 @@ Pandoc works this way even when the `--strict` option is specified. This
|
||||||
behavior is consistent with the official markdown syntax description,
|
behavior is consistent with the official markdown syntax description,
|
||||||
even though it is different from that of `Markdown.pl`.)
|
even though it is different from that of `Markdown.pl`.)
|
||||||
|
|
||||||
|
Ordered Lists
|
||||||
|
-------------
|
||||||
|
|
||||||
Unlike standard markdown, Pandoc allows ordered list items to be marked
|
Unlike standard markdown, Pandoc allows ordered list items to be marked
|
||||||
with uppercase and lowercase letters and roman numerals, in addition to
|
with uppercase and lowercase letters and roman numerals, in addition to
|
||||||
arabic numerals. (This behavior can be turned off using the `--strict`
|
arabic numerals. (This behavior can be turned off using the `--strict`
|
||||||
|
@ -705,6 +708,52 @@ These work like simple tables, but with the following differences:
|
||||||
- They must end with a row of dashes, then a blank line.
|
- They must end with a row of dashes, then a blank line.
|
||||||
- The rows must be separated by blank lines.
|
- The rows must be separated by blank lines.
|
||||||
|
|
||||||
|
Delimited Code blocks
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
In addition to standard indented code blocks, Pandoc supports
|
||||||
|
*delimited* code blocks. These begin with a row of three or more
|
||||||
|
tildes (`~`) and end with a row of tildes that must be at least
|
||||||
|
as long as the starting row. Everything between the tilde-lines
|
||||||
|
is treated as code. No indentation is necessary:
|
||||||
|
|
||||||
|
~~~~~~~
|
||||||
|
{code here}
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
If the code itself contains a row of tildes, just use a longer
|
||||||
|
row of tildes at the start and end:
|
||||||
|
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
~~~~~~~~~~
|
||||||
|
code including tildes
|
||||||
|
~~~~~~~~~~
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Optionally, you may specify the language of the code block using
|
||||||
|
this syntax:
|
||||||
|
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell}
|
||||||
|
qsort [] = []
|
||||||
|
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
|
||||||
|
qsort (filter (>= x) xs)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Some output formats can use this information to do syntax highlighting.
|
||||||
|
Currently, the only output format that uses this information is HTML.
|
||||||
|
The code block above would appear in the context
|
||||||
|
|
||||||
|
<pre class="haskell">
|
||||||
|
<code>
|
||||||
|
...
|
||||||
|
</code>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
This allows the HTML to be postprocessed using a syntax highlighting tool.
|
||||||
|
(Pandoc itself does not do any syntax highlighting.) Note that multiple
|
||||||
|
classes can be specified: for example, one might use `{.haskell
|
||||||
|
.number}` to specify that lines be numbered in the highlighted output.
|
||||||
|
|
||||||
Title blocks
|
Title blocks
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue