binario/exampleSite/content/post/syntax-highlighting.md

1.4 KiB
Raw Permalink Blame History

title description date categories tags
Hugo Syntax Highlighting Syntax Highlighting example test article that shows how to creating and highlighting code blocks in Hugo-generated site 2018-04-15
Development
Chroma
Hugo
Syntax Highlighting
HTML
Markdown

You can have code snippets highlighted so that they are easier to read on your site using Chroma, Hugo's default syntax highlighter. It is built in Go lang and is really, really fast and for the most important parts compatible with Pygments. Chroma takes source code and other structured text and converts it into syntax highlighted HTML, ANSI-coloured text, etc.

The example below shows a simple HTML code snippet highlighted with the Hugo highlight built-in shortcode:

{{< highlight html >}}

<html lang="en"> <head> </head>

Test

</html> {{< /highlight >}}

The following code snippet was used to achieve that result:

{{</* highlight html */>}}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>
{{</* /highlight */>}}

For more information, see "Hugo Syntax Highlighting" from official Hugo docs.