From cec610cfa19bbec820552683aa7e2a86d33e9fdd Mon Sep 17 00:00:00 2001 From: Tom Preston-Werner Date: Tue, 30 Mar 2010 01:21:30 -0700 Subject: [PATCH] allow syntax hilighted code to be indented --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2a3c72e2..bfbbacc2 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,9 @@ for a wide range of languages (courtesy of Pygments) by using the following syntax: ```ruby``` - def foo - puts 'bar' - end + def foo + puts 'bar' + end ``` The block must start with three backticks (as the first characters on the @@ -122,9 +122,13 @@ line). After that comes the name of the language that is contained by the block. The language must be one of the `short name` lexer strings supported by Pygments. See the [list of lexers](http://pygments.org/docs/lexers/) for valid options. Following the language name you may add an additional three backticks -for aesthetic reasons (but this is not required). The block must end with at -least three backticks as the first characters on a line. You may add more -backticks for balance if you like. +for aesthetic reasons (but this is not required). + +If the block contents are indented two spaces or one tab, then that whitespace +will be ignored (this makes the blocks easier to read in plaintext). + +The block must end with at least three backticks as the first characters on a +line. You may add more backticks for balance if you like. ## API DOCUMENTATION