commit d4ed59198a5e01010269ddd1f0b281bdfad8f46c
parent 8e368e25b1cb6217c34f79165a181b7020772a7d
Author: Joel Scoble <joel.scoble@outlook.com>
Date: Sun, 19 Oct 2014 11:10:35 -0500
added note about pygment example code and markdown processing, updated example
Diffstat:
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md
@@ -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