wiki.ohea.xyz/gollum
10
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

clarify syntax highlighting syntax

Browse Source
This commit is contained in:
Tom Preston-Werner
2010-04-04 22:43:59 -07:00
parent d84d6a3be0
commit 2e2a79f2a4
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -187,22 +187,22 @@ This is useful for writing about the link syntax in your wiki pages.
## SYNTAX HIGHLIGHTING ## SYNTAX HIGHLIGHTING
In Markdown and Textile page files you can get automatic syntax highlighting In page files you can get automatic syntax highlighting for a wide range of
for a wide range of languages (courtesy of Pygments) by using the following languages (courtesy of [Pygments](http://pygments.org/)) by using the
syntax: following syntax:
```ruby``` ```ruby```
def foo def foo
puts 'bar' puts 'bar'
end end
``` ``````````
The block must start with three backticks (as the first characters on the The block must start with three backticks (as the first characters on the
line). After that comes the name of the language that is contained by the 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 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 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 options. Following the language name you may optionally add an additional
for aesthetic reasons (but this is not required). three backticks for aesthetic reasons.
If the block contents are indented two spaces or one tab, then that whitespace 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). will be ignored (this makes the blocks easier to read in plaintext).