From 88b678f00e22cfa29827480da890d871ee01d8f5 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Sun, 13 Jan 2013 18:18:07 -0800 Subject: Documented line blocks in README. --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'README') diff --git a/README b/README index 2207f6c26..f57652b89 100644 --- a/README +++ b/README @@ -1100,6 +1100,35 @@ This is equivalent to: To prevent all highlighting, use the `--no-highlight` flag. 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 ----- -- cgit v1.2.3