mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
Adding Documentation on using Syntax Highlighting
This commit is contained in:
parent
56dfdfe86c
commit
1bead0ed7a
1 changed files with 58 additions and 0 deletions
58
docs/content/extras/highlighting.md
Normal file
58
docs/content/extras/highlighting.md
Normal file
|
@ -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 %}}
|
||||
<section id="main">
|
||||
<div>
|
||||
<h1 id="title">{{ .Title }}</h1>
|
||||
{{ range .Data.Pages }}
|
||||
{{ .Render "summary"}}
|
||||
{{ end }}
|
||||
</div>
|
||||
</section>
|
||||
{{% /highlight %}}
|
||||
{{% /highlight %}}
|
||||
|
||||
|
||||
## Example Output
|
||||
|
||||
{{% highlight html %}}
|
||||
<span style="color: #f92672"><section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"main"</span><span style="color: #f92672">></span>
|
||||
<span style="color: #f92672"><div></span>
|
||||
<span style="color: #f92672"><h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"title"</span><span style="color: #f92672">></span>{{ .Title }}<span style="color: #f92672"></h1></span>
|
||||
{{ range .Data.Pages }}
|
||||
{{ .Render "summary"}}
|
||||
{{ end }}
|
||||
<span style="color: #f92672"></div></span>
|
||||
<span style="color: #f92672"></section></span>
|
||||
{{% /highlight %}}
|
||||
|
Loading…
Reference in a new issue