Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Documented line blocks in README.

Browse source
This commit is contained in:
John MacFarlane 2013-01-13 18:18:07 -08:00
parent 9ee9096d07
commit 88b678f00e
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README
View file

@ -1100,6 +1100,35 @@ This is equivalent to:
To prevent all highlighting, use the `--no-highlight` flag. To prevent all highlighting, use the `--no-highlight` flag.
To set the highlighting style, use `--highlight-style`. To set the highlighting style, use `--highlight-style`.
Line blocks
-----------
**Extension: `line_blocks`**
A line block is a sequence of lines beginning with a vertical bar (`|`)
followed by a space. The division into lines will be preserved in
the output, as will any leading spaces; otherwise, the lines will
be formatted as markdown. This is useful for verse and addresses:
| The limerick packs laughs anatomical
| In space that is quite economical.
| But the good ones I've seen
| So seldom are clean
| And the clean ones so seldom are comical
| 200 Main St.
| Berkeley, CA 94718
The lines can be hard-wrapped if needed, but the continuation
line must begin with a space.
| The Right Honorable Most Venerable and Righteous Samuel L.
Constable, Jr.
| 200 Main St.
| Berkeley, CA 94718
This syntax is borrowed from [reStructuredText].
Lists Lists
----- -----