语法高亮

Hugo 使用 Chroma 作为其代码高亮器；它是用 Go 构建的，速度非常快。

配置语法高亮器

生成语法高亮器 CSS

如果您的站点配置中运行了 markup.highlight.noClasses=false，则需要一个样式表。该样式表将覆盖 markup.highlight.style 中指定的样式。

您可以使用 Hugo 生成一个

hugo gen chromastyles --style=monokai > syntax.css

运行 hugo gen chromastyles -h 获取更多选项。有关可用样式的图库，请参阅 https://xyproto.github.io/splash/docs/。

高亮短代码

高亮通过内置的 highlight 短代码执行。它需要一个参数来指定要高亮的编程语言，并需要一个闭合标签。

选项

linenos：配置行号。有效值为 true、false、table 或 inline。如果站点配置中配置为开启，则 false 将关闭行号。table 将提供可方便复制和粘贴的代码块。
hl_lines：列出要高亮显示的一组行号或行号范围。
linenostart=199：从 199 开始计算行号。
anchorlinenos：配置行号上的锚点。有效值为 true 或 false；
lineanchors：配置行号上锚点的前缀。将以 - 为后缀，因此使用 lineanchors=prefix 选项链接到第 1 行，将向页面添加锚点 prefix-1。
hl_inline 高亮显示 <code>（内联 HTML 元素）标签内的内容。有效值为 true 或 false。code 标签将获得一个名为 code-inline 的类。

示例：高亮短代码

{{< highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" >}}
// ... code
{{< / highlight >}}

得到这个

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218


// GetTitleFunc returns a func that can be used to transform a string to
// title case.
//
// The supported styles are
//
// - "Go" (strings.Title)
// - "AP" (see https://www.apstylebook.com/)
// - "Chicago" (see https://www.chicagomanualofstyle.org/home.html)
//
// If an unknown or empty style is provided, AP style is what you get.
func GetTitleFunc(style string) func(s string) string {
  switch strings.ToLower(style) {
  case "go":
    return strings.Title
  case "chicago":
    return transform.NewTitleConverter(transform.ChicagoStyle)
  default:
    return transform.NewTitleConverter(transform.APStyle)
  }
}

高亮 Hugo/Go 模板代码

要在您的页面上高亮显示 Hugo/Go 模板代码，请在开头的双花括号后添加 /*，并在结尾的花括号前添加 */。

{{</* myshortcode */>}}

得到这个

{{< myshortcode >}}

高亮模板函数

请参阅高亮。

代码围栏中的高亮

默认情况下启用代码围栏中的高亮。

```go {linenos=table,hl_lines=[8,"15-17"],linenostart=199}
// ... code
```

得到这个

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218


// GetTitleFunc returns a func that can be used to transform a string to
// title case.
//
// The supported styles are
//
// - "Go" (strings.Title)
// - "AP" (see https://www.apstylebook.com/)
// - "Chicago" (see https://www.chicagomanualofstyle.org/home.html)
//
// If an unknown or empty style is provided, AP style is what you get.
func GetTitleFunc(style string) func(s string) string {
  switch strings.ToLower(style) {
  case "go":
    return strings.Title
  case "chicago":
    return transform.NewTitleConverter(transform.ChicagoStyle)
  default:
    return transform.NewTitleConverter(transform.APStyle)
  }
}

这些选项与高亮短代码中的相同，包括 linenos=false，但请注意 Markdown 属性语法略有不同。

Chroma 高亮语言列表

Chroma 词法分析器及其别名（即 highlight 模板函数或在代码围栏中进行高亮时使用的标识符）的完整列表

ABAP: abap
ABNF: abnf
ActionScript: as, actionscript
ActionScript 3: as3, actionscript3
Ada: ada, ada95, ada2005
Agda: agda
AL: al
Alloy: alloy
Angular2: ng2
ANTLR: antlr
ApacheConf: apacheconf, aconf, apache
APL: apl
AppleScript: applescript
ArangoDB AQL: aql
Arduino: arduino
ArmAsm: armasm
ATL: atl
AutoHotkey: autohotkey, ahk
AutoIt: autoit
Awk: awk, gawk, mawk, nawk
Ballerina: ballerina
Bash: bash, sh, ksh, zsh, shell
Bash Session: bash-session, console, shell-session
Batchfile: bat, batch, dosbatch, winbatch
Beef: beef
BibTeX: bib, bibtex
Bicep: bicep
BlitzBasic: blitzbasic, b3d, bplus
BNF: bnf
BQN: bqn
Brainfuck: brainfuck, bf
C: c
C#: csharp, c#
C++: cpp, c++
Caddyfile: caddyfile, caddy
Caddyfile Directives: caddyfile-directives, caddyfile-d, caddy-d
Cap'n Proto: capnp
Cassandra CQL: cassandra, cql
Ceylon: ceylon
CFEngine3: cfengine3, cf3
cfstatement: cfs
ChaiScript: chai, chaiscript
Chapel: chapel, chpl
Cheetah: cheetah, spitfire
Clojure: clojure, clj, edn
CMake: cmake
COBOL: cobol
CoffeeScript: coffee-script, coffeescript, coffee
Common Lisp: common-lisp, cl, lisp
Coq: coq
Crystal: cr, crystal
CSS: css
CSV: csv
CUE: cue
Cython: cython, pyx, pyrex
D: d
Dart: dart
Dax: dax
Desktop file: desktop, desktop_entry
Diff: diff, udiff
Django/Jinja: django, jinja
dns: zone, bind
Docker: docker, dockerfile
DTD: dtd
Dylan: dylan
EBNF: ebnf
Elixir: elixir, ex, exs
Elm: elm
EmacsLisp: emacs, elisp, emacs-lisp
Erlang: erlang
Factor: factor
Fennel: fennel, fnl
Fish: fish, fishshell
Forth: forth
Fortran: fortran, f90
FortranFixed: fortranfixed
FSharp: fsharp
GAS: gas, asm
GDScript: gdscript, gd
GDScript3: gdscript3, gd3
Genshi: genshi, kid, xml+genshi, xml+kid
Genshi HTML: html+genshi, html+kid
Genshi Text: genshitext
Gherkin: cucumber, Cucumber, gherkin, Gherkin
Gleam: gleam
GLSL: glsl
Gnuplot: gnuplot
Go: go, golang
Go HTML Template: go-html-template
Go Template: go-template
Go Text Template: go-text-template
GraphQL: graphql, graphqls, gql
Groff: groff, nroff, man
Groovy: groovy
Handlebars: handlebars, hbs
Hare: hare
Haskell: haskell, hs
Haxe: hx, haxe, hxsl
HCL: hcl
Hexdump: hexdump
HLB: hlb
HLSL: hlsl
HolyC: holyc
HTML: html
HTTP: http
Hy: hylang
Idris: idris, idr
Igor: igor, igorpro
INI: ini, cfg, dosini
Io: io
ISCdhcpd: iscdhcpd
J: j
Java: java
JavaScript: js, javascript
JSON: json
JSONata: jsonata
Jsonnet: jsonnet
Julia: julia, jl
Jungle: jungle
Kotlin: kotlin
Lighttpd configuration file: lighty, lighttpd
LLVM: llvm
Lua: lua
Makefile: make, makefile, mf, bsdmake
Mako: mako
markdown: md, mkd
Mason: mason
Materialize SQL dialect: materialize, mzsql
Mathematica: mathematica, mma, nb
Matlab: matlab
MCFunction: mcfunction, mcf
Meson: meson, meson.build
Metal: metal
MiniZinc: minizinc, MZN, mzn
MLIR: mlir
Modula-2: modula2, m2
MonkeyC: monkeyc
MorrowindScript: morrowind, mwscript
Myghty: myghty
MySQL: mysql, mariadb
NASM: nasm
Natural: natural
NDISASM: ndisasm
Newspeak: newspeak
Nginx configuration file: nginx
Nim: nim, nimrod
Nix: nixos, nix
NSIS: nsis, nsi, nsh
Objective-C: objective-c, objectivec, obj-c, objc
ObjectPascal: objectpascal
OCaml: ocaml
Octave: octave
Odin: odin
OnesEnterprise: ones, onesenterprise, 1S, 1S:Enterprise
OpenEdge ABL: openedge, abl, progress, openedgeabl
OpenSCAD: openscad
Org Mode: org, orgmode
PacmanConf: pacmanconf
Perl: perl, pl
PHP: php, php3, php4, php5
PHTML: phtml
Pig: pig
PkgConfig: pkgconfig
PL/pgSQL: plpgsql
plaintext: text, plain, no-highlight
Plutus Core: plutus-core, plc
Pony: pony
PostgreSQL SQL dialect: postgresql, postgres
PostScript: postscript, postscr
POVRay: pov
PowerQuery: powerquery, pq
PowerShell: powershell, posh, ps1, psm1, psd1, pwsh
Prolog: prolog
Promela: promela
PromQL: promql
properties: java-properties
Protocol Buffer: protobuf, proto
PRQL: prql
PSL: psl
Puppet: puppet
Python: python, py, sage, python3, py3
Python 2: python2, py2
QBasic: qbasic, basic
QML: qml, qbs
R: splus, s, r
Racket: racket, rkt
Ragel: ragel
Raku: perl6, pl6, raku
react: jsx, react
ReasonML: reason, reasonml
reg: registry
Rego: rego
reStructuredText: rst, rest, restructuredtext
Rexx: rexx, arexx
RPMSpec: spec
Ruby: rb, ruby, duby
Rust: rust, rs
SAS: sas
Sass: sass
Scala: scala
Scheme: scheme, scm
Scilab: scilab
SCSS: scss
Sed: sed, gsed, ssed
Sieve: sieve
Smali: smali
Smalltalk: smalltalk, squeak, st
Smarty: smarty
SNBT: snbt
Snobol: snobol
Solidity: sol, solidity
SourcePawn: sp
SPARQL: sparql
SQL: sql
SquidConf: squidconf, squid.conf, squid
Standard ML: sml
stas
Stylus: stylus
Svelte: svelte
Swift: swift
SYSTEMD: systemd
systemverilog: systemverilog, sv
TableGen: tablegen
Tal: tal, uxntal
TASM: tasm
Tcl: tcl
Tcsh: tcsh, csh
Termcap: termcap
Terminfo: terminfo
Terraform: terraform, tf
TeX: tex, latex
Thrift: thrift
TOML: toml
TradingView: tradingview, tv
Transact-SQL: tsql, t-sql
Turing: turing
Turtle: turtle
Twig: twig
TypeScript: ts, tsx, typescript
TypoScript: typoscript
TypoScriptCssData: typoscriptcssdata
TypoScriptHtmlData: typoscripthtmldata
Typst: typst
ucode
V: v, vlang
V shell: vsh, vshell
Vala: vala, vapi
VB.net: vb.net, vbnet
verilog: verilog, v
VHDL: vhdl
VHS: vhs, tape, cassette
VimL: vim
vue: vue, vuejs
WDTE
WebGPU Shading Language: wgsl
WebVTT: vtt
Whiley: whiley
XML: xml
Xorg: xorg.conf
YAML: yaml
YANG: yang
Z80 Assembly: z80
Zed: zed
Zig: zig

配置语法高亮器

生成语法高亮器 CSS

高亮短代码

示例：高亮短代码

高亮 Hugo/Go 模板代码

高亮模板函数

代码围栏中的高亮

Chroma 高亮语言列表

另请参阅

最后更新：2025年1月16日：将嵌入式短代码文档提升到其自己的部分 (a346ca1fd)