Hugoのシンタックスハイライトのメモ

2024年08月23日 金曜日 21時00分

Hugoのシンタックスハイライトは、デフォルトでは、インラインスタイル noClasses = true として展開されます。

Syntax highlighting | Hugo

以下のマークダウンがありまして。

```html {hl_lines=["4-5",8]}
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>昔、男、初冠して、平安の都にありけり。清涼殿の御幸を賜ひて、梅の枝折りておきければ、その枝にこめたる心をたれもいとはず。よしあし言ふべきやうもあらず。よしなしごとを聞こえくるめる御世のけしきにもおはせまさり、宮の御心地いとやすからず。</p>
</body>
</html>
```

以下のように表示されます。

preview
preview

現在は、Hugoではなく、Eleventyを使っており、ハイライトは無効にしています。

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>
      昔、男、初冠して、平安の都にありけり。清涼殿の御幸を賜ひて、梅の枝折りておきければ、その枝にこめたる心をたれもいとはず。よしあし言ふべきやうもあらず。よしなしごとを聞こえくるめる御世のけしきにもおはせまさり、宮の御心地いとやすからず。
    </p>
  </body>
</html>

出力されたHTMLを確認すると、以下のように、インラインスタイルとして展開されます。

<div class="highlight">
  <pre
    tabindex="0"
    style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;display:grid;"
  ><code class="language-html" data-lang="html"><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 1</span><span><span style="color:#75715e">&lt;!doctype html&gt;</span>
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 2</span><span>&lt;<span style="color:#f92672">html</span> <span style="color:#a6e22e">lang</span><span style="color:#f92672">=</span><span style="color:#e6db74">"en"</span>&gt;
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 3</span><span>&lt;<span style="color:#f92672">head</span>&gt;
</span></span><span style="display:flex; background-color:#3c3d38"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 4</span><span>  &lt;<span style="color:#f92672">meta</span> <span style="color:#a6e22e">charset</span><span style="color:#f92672">=</span><span style="color:#e6db74">"utf-8"</span>&gt;
</span></span><span style="display:flex; background-color:#3c3d38"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 5</span><span>  &lt;<span style="color:#f92672">title</span>&gt;Example HTML5 Document&lt;/<span style="color:#f92672">title</span>&gt;
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 6</span><span>&lt;/<span style="color:#f92672">head</span>&gt;
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 7</span><span>&lt;<span style="color:#f92672">body</span>&gt;
</span></span><span style="display:flex; background-color:#3c3d38"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 8</span><span>  &lt;<span style="color:#f92672">p</span>&gt;昔、男、初冠して、平安の都にありけり。清涼殿の御幸を賜ひて、梅の枝折りておきければ、その枝にこめたる心をたれもいとはず。よしあし言ふべきやうもあらず。よしなしごとを聞こえくるめる御世のけしきにもおはせまさり、宮の御心地いとやすからず。&lt;/<span style="color:#f92672">p</span>&gt;
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 9</span><span>&lt;/<span style="color:#f92672">body</span>&gt;
</span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">10</span><span>&lt;/<span style="color:#f92672">html</span>&gt;
</span></span></code></pre>
</div>

インラインではなく、classを設定したい場合は hugo.toml を以下に設定します。

Configure markup | Hugo

以下は hugo.toml のデフォルト値です。

[markup]
[markup.highlight]
anchorLineNos = false
codeFences = true
guessSyntax = false
hl_Lines = ''
hl_inline = false
lineAnchors = ''
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true
noHl = false
style = 'monokai'
tabWidth = 4

noClasses = false に変更すると、classが設定されます。

lineNumbersInTable = true
noClasses = false
noHl = false
<div class="highlight">
  <pre
    tabindex="0"
    class="chroma"
  ><code class="language-html" data-lang="html"><span class="line"><span class="ln"> 1</span><span class="cl"><span class="cp">&lt;!doctype html&gt;</span>
</span></span><span class="line"><span class="ln"> 2</span><span class="cl"><span class="p">&lt;</span><span class="nt">html</span> <span class="na">lang</span><span class="o">=</span><span class="s">"en"</span><span class="p">&gt;</span>
</span></span><span class="line"><span class="ln"> 3</span><span class="cl"><span class="p">&lt;</span><span class="nt">head</span><span class="p">&gt;</span>
</span></span><span class="line hl"><span class="ln"> 4</span><span class="cl">  <span class="p">&lt;</span><span class="nt">meta</span> <span class="na">charset</span><span class="o">=</span><span class="s">"utf-8"</span><span class="p">&gt;</span>
</span></span><span class="line hl"><span class="ln"> 5</span><span class="cl">  <span class="p">&lt;</span><span class="nt">title</span><span class="p">&gt;</span>Example HTML5 Document<span class="p">&lt;/</span><span class="nt">title</span><span class="p">&gt;</span>
</span></span><span class="line"><span class="ln"> 6</span><span class="cl"><span class="p">&lt;/</span><span class="nt">head</span><span class="p">&gt;</span>
</span></span><span class="line"><span class="ln"> 7</span><span class="cl"><span class="p">&lt;</span><span class="nt">body</span><span class="p">&gt;</span>
</span></span><span class="line hl"><span class="ln"> 8</span><span class="cl">  <span class="p">&lt;</span><span class="nt">p</span><span class="p">&gt;</span>昔、男、初冠して、平安の都にありけり。清涼殿の御幸を賜ひて、梅の枝折りておきければ、その枝にこめたる心をたれもいとはず。よしあし言ふべきやうもあらず。よしなしごとを聞こえくるめる御世のけしきにもおはせまさり、宮の御心地いとやすからず。<span class="p">&lt;/</span><span class="nt">p</span><span class="p">&gt;</span>
</span></span><span class="line"><span class="ln"> 9</span><span class="cl"><span class="p">&lt;/</span><span class="nt">body</span><span class="p">&gt;</span>
</span></span><span class="line"><span class="ln">10</span><span class="cl"><span class="p">&lt;/</span><span class="nt">html</span><span class="p">&gt;</span>
</span></span></code></pre>
</div>

設定のあとに、以下のコマンドでcssが生成できます。

$ hugo gen chromastyles --style=monokai > syntax.css
/* syntax.css */

/* Background */
.bg {
  color: #f8f8f2;
  background-color: #272822;
}
/* PreWrapper */
.chroma {
  color: #f8f8f2;
  background-color: #272822;
}
/* Other */
.chroma .x {
}
/* Error */
.chroma .err {
  color: #960050;
  background-color: #1e0010;
}
/* CodeLine */
.chroma .cl {
}
/* LineLink */
.chroma .lnlinks {
  outline: none;
  text-decoration: none;
  color: inherit;
}
/* LineTableTD */
.chroma .lntd {
  vertical-align: top;
  padding: 0;
  margin: 0;
  border: 0;
}
/* LineTable */
.chroma .lntable {
  border-spacing: 0;
  padding: 0;
  margin: 0;
  border: 0;
}
/* LineHighlight */
.chroma .hl {
  background-color: #3c3d38;
}
/* LineNumbersTable */
.chroma .lnt {
  white-space: pre;
  -webkit-user-select: none;
  user-select: none;
  margin-right: 0.4em;
  padding: 0 0.4em 0 0.4em;
  color: #7f7f7f;
}
/* LineNumbers */
.chroma .ln {
  white-space: pre;
  -webkit-user-select: none;
  user-select: none;
  margin-right: 0.4em;
  padding: 0 0.4em 0 0.4em;
  color: #7f7f7f;
}
/* Line */
.chroma .line {
  display: flex;
}
/* Keyword */
.chroma .k {
  color: #66d9ef;
}
/* KeywordConstant */
.chroma .kc {
  color: #66d9ef;
}
/* KeywordDeclaration */
.chroma .kd {
  color: #66d9ef;
}
/* KeywordNamespace */
.chroma .kn {
  color: #f92672;
}
/* KeywordPseudo */
.chroma .kp {
  color: #66d9ef;
}
/* KeywordReserved */
.chroma .kr {
  color: #66d9ef;
}
/* KeywordType */
.chroma .kt {
  color: #66d9ef;
}
/* Name */
.chroma .n {
}
/* NameAttribute */
.chroma .na {
  color: #a6e22e;
}
/* NameBuiltin */
.chroma .nb {
}
/* NameBuiltinPseudo */
.chroma .bp {
}
/* NameClass */
.chroma .nc {
  color: #a6e22e;
}
/* NameConstant */
.chroma .no {
  color: #66d9ef;
}
/* NameDecorator */
.chroma .nd {
  color: #a6e22e;
}
/* NameEntity */
.chroma .ni {
}
/* NameException */
.chroma .ne {
  color: #a6e22e;
}
/* NameFunction */
.chroma .nf {
  color: #a6e22e;
}
/* NameFunctionMagic */
.chroma .fm {
}
/* NameLabel */
.chroma .nl {
}
/* NameNamespace */
.chroma .nn {
}
/* NameOther */
.chroma .nx {
  color: #a6e22e;
}
/* NameProperty */
.chroma .py {
}
/* NameTag */
.chroma .nt {
  color: #f92672;
}
/* NameVariable */
.chroma .nv {
}
/* NameVariableClass */
.chroma .vc {
}
/* NameVariableGlobal */
.chroma .vg {
}
/* NameVariableInstance */
.chroma .vi {
}
/* NameVariableMagic */
.chroma .vm {
}
/* Literal */
.chroma .l {
  color: #ae81ff;
}
/* LiteralDate */
.chroma .ld {
  color: #e6db74;
}
/* LiteralString */
.chroma .s {
  color: #e6db74;
}
/* LiteralStringAffix */
.chroma .sa {
  color: #e6db74;
}
/* LiteralStringBacktick */
.chroma .sb {
  color: #e6db74;
}
/* LiteralStringChar */
.chroma .sc {
  color: #e6db74;
}
/* LiteralStringDelimiter */
.chroma .dl {
  color: #e6db74;
}
/* LiteralStringDoc */
.chroma .sd {
  color: #e6db74;
}
/* LiteralStringDouble */
.chroma .s2 {
  color: #e6db74;
}
/* LiteralStringEscape */
.chroma .se {
  color: #ae81ff;
}
/* LiteralStringHeredoc */
.chroma .sh {
  color: #e6db74;
}
/* LiteralStringInterpol */
.chroma .si {
  color: #e6db74;
}
/* LiteralStringOther */
.chroma .sx {
  color: #e6db74;
}
/* LiteralStringRegex */
.chroma .sr {
  color: #e6db74;
}
/* LiteralStringSingle */
.chroma .s1 {
  color: #e6db74;
}
/* LiteralStringSymbol */
.chroma .ss {
  color: #e6db74;
}
/* LiteralNumber */
.chroma .m {
  color: #ae81ff;
}
/* LiteralNumberBin */
.chroma .mb {
  color: #ae81ff;
}
/* LiteralNumberFloat */
.chroma .mf {
  color: #ae81ff;
}
/* LiteralNumberHex */
.chroma .mh {
  color: #ae81ff;
}
/* LiteralNumberInteger */
.chroma .mi {
  color: #ae81ff;
}
/* LiteralNumberIntegerLong */
.chroma .il {
  color: #ae81ff;
}
/* LiteralNumberOct */
.chroma .mo {
  color: #ae81ff;
}
/* Operator */
.chroma .o {
  color: #f92672;
}
/* OperatorWord */
.chroma .ow {
  color: #f92672;
}
/* Punctuation */
.chroma .p {
}
/* Comment */
.chroma .c {
  color: #75715e;
}
/* CommentHashbang */
.chroma .ch {
  color: #75715e;
}
/* CommentMultiline */
.chroma .cm {
  color: #75715e;
}
/* CommentSingle */
.chroma .c1 {
  color: #75715e;
}
/* CommentSpecial */
.chroma .cs {
  color: #75715e;
}
/* CommentPreproc */
.chroma .cp {
  color: #75715e;
}
/* CommentPreprocFile */
.chroma .cpf {
  color: #75715e;
}
/* Generic */
.chroma .g {
}
/* GenericDeleted */
.chroma .gd {
  color: #f92672;
}
/* GenericEmph */
.chroma .ge {
  font-style: italic;
}
/* GenericError */
.chroma .gr {
}
/* GenericHeading */
.chroma .gh {
}
/* GenericInserted */
.chroma .gi {
  color: #a6e22e;
}
/* GenericOutput */
.chroma .go {
}
/* GenericPrompt */
.chroma .gp {
}
/* GenericStrong */
.chroma .gs {
  font-weight: bold;
}
/* GenericSubheading */
.chroma .gu {
  color: #75715e;
}
/* GenericTraceback */
.chroma .gt {
}
/* GenericUnderline */
.chroma .gl {
}
/* TextWhitespace */
.chroma .w {
}

以下のようなHTMLで、cssを読み込みます。

// /my_blog/themes/my_theme/layouts/partials/head/css_highlight.html

{{- with resources.Get "css/syntax.css" -}}
    {{- if eq hugo.Environment "development" -}}
        <link rel="stylesheet" href="{{ .RelPermalink }}">
    {{- else -}}
        {{- with . | minify | fingerprint -}}
            <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
        {{- end -}}
    {{- end -}}
{{- end -}}