A language grammar to highlight Hugo's templating language with Highlight.js.
Handlebars and Go templates (used by Hugo) have similar template tags. Without setting any relevance the Hugo modules will in most cases loose. To overcome this situation we use the following relevance settings trying to beat Handlebars and still make it win for its own templates.
-
for Go template comments we use relevance = 10.
comments start with start with
{{/*or{{- /*and end with*/}}or*/ - }} -
the opening tag
{{-is very special to Go templates, so we use relevance = 10 -
for functions in the hugo namespace we use Relevance = 10 (e.g. hugo.IsDevelopment)
-
We mark the following Handlebars opening template tags as invalid for the hugo modules:
{{#,{{>,{{!--,{{!
Known limitation:
We are unsure what happens if you include both hugo-html and hugo.text. Maybe the HTML variant will win if there's
enough HTML around. Maybe not, maybe dependent on import order...
In most cases you want the hugo-html module only. If not, specify the language for each code block in that case.
Include the highlight.js library in your webpage or Node app, then load this module.
Load the module after loading Highlight.js. Take the minified version from dist directory.
<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/hugo-text.min.js"></script>
<script type="text/javascript">
hljs.highlightAll();
</script>If you're using Node / Webpack / Rollup / Browserify, etc, simply require the language module, then register it with Highlight.js.
var hljs = require("highlight.js");
var hljsHugo = require("hugo-text");
hljs.registerLanguage("hugo-text", hljsHugo);
hljs.highlightAll();This package is released under the MIT License. See LICENSE file for details.
- Irkode [email protected]
-
HighlightJS Hugo modules:
-
Go templating language
This module is generated from a private repo, which as of now is a quite evil hack...
- scans the hugoDocs for functions and built_ins
- builds the javascript highlighter from a template
- generates the supplemental files needed by highlight.js
- populates the testcases depending on the variant
- runs build and tests
- pushes the updated stuff to the module repositories