added note about pygment example code and markdown processing, updated example
authorJoel Scoble <joel.scoble@outlook.com>
Sun, 19 Oct 2014 16:10:35 +0000 (11:10 -0500)
committerspf13 <steve.francia@gmail.com>
Sun, 2 Nov 2014 02:58:44 +0000 (22:58 -0400)
docs/content/extras/highlighting.md

index a90a72451a3f334d623486448542a229621bbe5b..49e68c071f4831b85008dfac75ce688b3364e3da 100644 (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