参与文档编写

GitHub 工作流程

步骤 1

Fork 文档仓库。

步骤 2

克隆你的 fork。

步骤 3

创建一个描述性名称的新分支。

git checkout -b fix/typos-site-variables

步骤 4

进行修改。

步骤 5

使用描述性的提交消息提交你的修改，通常不超过 50 个字符。如果你的修改解决了一个或多个已提交的问题，则包括 “Closes” 关键词。

git commit -m "修复站点变量页面的拼写错误

Closes #1234
Closes #5678"

步骤 6

将新分支推送到你 fork 的文档仓库。

步骤 7

访问 文档仓库 并创建一个拉取请求（PR）。

步骤 8

项目维护者将会审查你的 PR，并可能要求进行修改。在维护者合并你的 PR 后，你可以删除你的分支。

包含示例代码

围栏式代码块

在使用围栏式代码块时，包含代码语言。

```go-html-template
{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}
```

渲染结果：

{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}

code 简码

使用 code 简码来包含文件名和一个复制到剪贴板的按钮。这个简码接受以下可选参数：

copy

(bool) 如果为 true，显示一个复制到剪贴板的按钮。默认为 true。

file

(string) 要显示的文件名。如果没有提供 lang 参数，文件扩展名决定代码语言。

lang

(string) 代码语言。默认为 text。

{{< code file="layouts/_default_/single.html" >}}
{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}
{{< /code >}}

渲染结果：

{{ if eq $foo "bar" }}
  {{ print "foo is bar" }}
{{ end }}

code-toggle 简码

使用 code-toggle 简码来显示网站配置、正文元数据或数据文件的示例。这个简码接受以下可选参数：

copy

(bool) 如果为 true，显示一个复制到剪贴板的按钮。默认为 true。

file

(string) 要显示的文件名。对于网站配置和数据文件示例，省略文件扩展名。

fm

(bool) 如果为 true，将代码显示为正文元数据。默认为 false。

网站配置示例

{{< code-toggle file=hugo >}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"
{{< /code-toggle >}}

渲染结果：

baseURL: https://example.org
languageCode: en-US
title: Example Site

baseURL = 'https://example.org'
languageCode = 'en-US'
title = 'Example Site'

{
   "baseURL": "https://example.org",
   "languageCode": "en-US",
   "title": "Example Site"
}

正文元数据示例

{{< code-toggle file="content/about.md" fm=true >}}
title = "About"
date = 2023-04-02T12:47:24-07:00
draft = false
{{< /code-toggle >}}

渲染结果：

---
date: 2023-04-02T12:47:24-07:00
draft: false
title: About
---

+++
date = 2023-04-02T12:47:24-07:00
draft = false
title = 'About'
+++

{
   "date": "2023-04-02T12:47:24-07:00",
   "draft": false,
   "title": "About"
}

提示

使用 note 简码来引起内容的注意。在调用这个简码时，使用 {{% %}} 表示法。

{{% note %}}
This is **bold** text.
{{% /note %}}