From 1bead0ed7affc4fc98e24e22da217bc1e3d2377a Mon Sep 17 00:00:00 2001 From: spf13 Date: Tue, 18 Feb 2014 18:35:45 -0500 Subject: [PATCH] Adding Documentation on using Syntax Highlighting --- docs/content/extras/highlighting.md | 58 +++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 docs/content/extras/highlighting.md diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md new file mode 100644 index 000000000..57e9f5dcf --- /dev/null +++ b/docs/content/extras/highlighting.md @@ -0,0 +1,58 @@ +--- +title: "Highlighting" +date: "2013-07-01" +groups: ["extras"] +groups_weight: 15 +--- + +Hugo provides the ability for you to highlight source code from within your +content. Highlighting is performed by an external python based program called +pygments and is triggered via an embedded shortcode. If pygments is absent from +the path, it will silently simply pass the content along unhighlighted. + + +## Disclaimers + + * **Warning** Pygments is relatively slow and our integration with it isn't +speed optimized. Expect much longer build times when using highlighting + * The languages available depends on your pygments installation. + * While pygments supports a few different output formats and options we currently +only support output=html, style=monokai, noclasses=true, and encoding=utf-8. + * Styles are inline in order to be supported in syndicated content when references +to style sheets are not carried over. + * We have sought to have the simpliest interface possible, which consequently +limits configuration. An ambitious user is encouraged to extend the current +functionality to offer more customization. + +## Usage +Highlight takes exactly one required parameter of language and requires a +closing shortcode. + +## Example +{{% highlight html %}} + {{% highlight html %}} +
+
+

{{ .Title }}

+ {{ range .Data.Pages }} + {{ .Render "summary"}} + {{ end }} +
+
+ {{% /highlight %}} +{{% /highlight %}} + + +## Example Output + +{{% highlight html %}} + <section id="main"> + <div> + <h1 id="title">{{ .Title }}</h1> + {{ range .Data.Pages }} + {{ .Render "summary"}} + {{ end }} + </div> + </section> +{{% /highlight %}} +