From d4ed59198a5e01010269ddd1f0b281bdfad8f46c Mon Sep 17 00:00:00 2001 From: Joel Scoble Date: Sun, 19 Oct 2014 11:10:35 -0500 Subject: [PATCH] added note about pygment example code and markdown processing, updated example --- docs/content/extras/highlighting.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md index a90a72451..49e68c071 100644 --- 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 %}}
@@ -55,7 +56,7 @@ The example has an extra space between the “{{” and “%” characters to pr
{{ % /highlight %}} - + ``` ### Example Output