github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

added note about pygment example code and markdown processing, updated example

Browse source
This commit is contained in:
Joel Scoble 2014-10-19 11:10:35 -05:00 committed by spf13
parent 8e368e25b1
commit d4ed59198a
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/content/extras/highlighting.md
View file

@ -43,8 +43,9 @@ Highlight takes exactly one required parameter of language and requires a
closing shortcode.
### Example
The example has an extra space between the “{{” and “%” characters to prevent rendering here.
The example has an extra space between the “{{” and “%” characters to prevent rendering here. Since this example is a code block, we use Github flavored Markdown's code fences, ```, to delimit the code. If you are using standard Markdown, instead of the code fence delimiters, each line must be preceeded by 4 spaces to identify each line as a line of code. Not doing either will result in the text being rendered as HTML. This will prevent Pytment highlighting from working.
```
{{ % highlight html %}}
<section id="main">
<div>
@ -55,7 +56,7 @@ The example has an extra space between the “{{” and “%” characters to pr
</div>
</section>
{{ % /highlight %}}
```
### Example Output