forked from drowl87/hextra_mirror
114 lines
2.3 KiB
Markdown
114 lines
2.3 KiB
Markdown
---
|
||
title: "语法高亮"
|
||
weight: 3
|
||
---
|
||
|
||
Hugo 使用 [Chroma](https://github.com/alecthomas/chroma)，这是一个用纯 Go 编写的通用语法高亮器，用于语法高亮。
|
||
建议在 Markdown 内容中使用反引号来标记代码块。例如：
|
||
|
||
<!--more-->
|
||
|
||
````markdown {filename="Markdown"}
|
||
```python
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
````
|
||
|
||
将会渲染为：
|
||
|
||
```python
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
|
||
## 功能
|
||
|
||
### 文件名
|
||
|
||
要为代码块添加文件名或标题，请设置 `filename` 属性：
|
||
|
||
````markdown {filename="Markdown"}
|
||
```python {filename="hello.py"}
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
````
|
||
|
||
```python {filename="hello.py"}
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
|
||
### 文件链接
|
||
|
||
{{< new-feature version="v0.9.2" >}}
|
||
|
||
你可以使用 `base_url` 属性提供一个基础 URL，它将与文件名结合生成一个链接。
|
||
|
||
如果文件名指定了文件在基础路径中的位置，则可以包含相对路径。
|
||
|
||
````markdown {filename="Markdown"}
|
||
```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"}
|
||
go 1.20
|
||
```
|
||
````
|
||
|
||
```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"}
|
||
go 1.20
|
||
```
|
||
|
||
### 行号
|
||
|
||
要设置行号，请将 `linenos` 属性设置为 `table`，并可选地设置 `linenostart` 为起始行号：
|
||
|
||
````markdown {filename="Markdown"}
|
||
```python {linenos=table,linenostart=42}
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
````
|
||
|
||
```python {linenos=table,linenostart=42}
|
||
def say_hello():
|
||
print("Hello!")
|
||
```
|
||
|
||
### 高亮行
|
||
|
||
要高亮特定行，请将 `hl_lines` 属性设置为行号列表：
|
||
|
||
````markdown {filename="Markdown"}
|
||
```python {linenos=table,hl_lines=[2,4],linenostart=1,filename="hello.py"}
|
||
def say_hello():
|
||
print("Hello!")
|
||
|
||
def main():
|
||
say_hello()
|
||
```
|
||
````
|
||
|
||
```python {linenos=table,hl_lines=[2,4],linenostart=1,filename="hello.py"}
|
||
def say_hello():
|
||
print("Hello!")
|
||
|
||
def main():
|
||
say_hello()
|
||
```
|
||
|
||
### 复制按钮
|
||
|
||
默认情况下，代码块启用了复制按钮。可以通过修改站点配置文件来更改其行为：
|
||
|
||
```yaml {linenos=table,linenostart=42,filename="hugo.yaml"}
|
||
params:
|
||
highlight:
|
||
copy:
|
||
enable: true
|
||
# hover | always
|
||
display: hover
|
||
```
|
||
|
||
## 支持的语言
|
||
|
||
有关支持的语言列表，请参阅 [Chroma 文档](https://github.com/alecthomas/chroma#supported-languages)。 |