这是一个包含 Hugo blog awesome 主题所有示例内容的综合参考。使用这个文档作为各种 Hugo 功能和 Markdown 语法的参考。

目录配置

本主题支持在博客文章中显示目录（ToC）。

参数

您可以通过两个参数管理目录：

全局 toc 参数；
文章的 toc 参数。

文章的 toc 参数优先级高于全局 toc 参数。

在所有文章中启用目录

要在所有文章（全局）中启用目录，请在 hugo.toml 中将参数 toc 设置为 true。

[params]
  toc = true

要全局禁用目录，只需忽略 toc 参数或将其设置为 false。

在特定文章中启用目录

要在特定文章中启用目录，请在文章设置中将参数 toc 设置为 true。

---
title: 如何启用目录
date: 2023-05-02
toc: true
---

在特定文章中禁用目录

要在特定文章中禁用目录，您需要遵循两个步骤。

注意：文章中的 .Params.toc 会覆盖 .Site.Params.toc。完成这些步骤后，文章中的 toc 参数将为 false。

在 hugo.toml 中将参数 toc 设置为 true。
```
[params]
  toc = true
```

在希望禁用目录的文章的 front matter 中添加 toc = false。

---
title: 如何启用目录
date: 2023-05-02
toc: false
---

默认打开目录

默认情况下，目录是关闭的。要默认打开它，请在 hugo.toml 中将参数 tocOpen 设置为 true。

[params]
  tocOpen = true

或者直接在文章的 front matter 中添加 tocOpen 参数。

---
title: 如何启用目录
date: 2023-05-02
tocOpen: true
---

数学排版

在 Hugo 项目中，可以通过使用第三方 JavaScript 库来启用数学符号。

在本示例中，我们将使用 KaTeX。

要全局启用 KaTeX，请在项目的配置文件中将参数 math 设置为 true，如下所示。
- hugo.toml
```
[params]
  math = true
```
- hugo.yaml
```
params:
  math: true
```
要在每页基础上启用 KaTeX，请在 Markdown 内容文件的 Front Matter 中包含参数 math: true，如下所示。
```
---
math: true
---
```

注意： 支持的 TeX 函数在线参考是一个有用的资源。

数学示例

块级数学公式：
$$ \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } $$
行内数学公式：
这是一个行内多项式：$5x^2 + 2y -7$。

富内容与短代码

Hugo 提供了多个内置短代码来支持富内容，同时还提供了隐私配置和一组简单短代码，以实现各种社交媒体嵌入的静态和无 JS 版本。

YouTube 隐私增强短代码

Twitter 简单短代码

“In addition to being more logical, asymmetry has the advantage that its complete appearance is far more optically effective than symmetry.”
— Jan Tschichold pic.twitter.com/gcv7SrhvJb
— Design Reviewed | Graphic Design History (@DesignReviewed) January 17, 2019

Vimeo 简单短代码

Emoji 支持

在 Hugo 项目中有多种方式可以启用 Emoji。

可以在模板中直接调用 emojify 函数，或者使用 Inline Shortcodes。

要全局启用 Emoji，请在站点的 hugo.toml 中将 enableEmoji 设置为 true。您可以直接在内容文件中输入 Emoji 的简写代码，例如：

:see_no_evil: 🙈 :hear_no_evil: 🙉 :speak_no_evil: 🙊

我 ❤️ Hugo! 😁

Emoji 速查表是一个非常有用的 Emoji 简写代码参考。

注意： 上述步骤启用了 Hugo 中的 Unicode 标准 Emoji 字符和序列，但这些字符的渲染效果取决于浏览器和平台。要为 Emoji 设置样式，您可以使用第三方 Emoji 字体或字体堆栈，例如：

.emoji {
  font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols;
}

Markdown 语法指南

本节提供了 Hugo 内容文件中可以使用的 Markdown 语法示例，同时展示了 Hugo 主题中是否对基本 HTML 元素进行了 CSS 装饰。

标题

以下 HTML <h1>—<h6> 元素表示六个级别的标题。<h1> 是最高级别的标题，而 <h6> 是最低级别的标题。

H1

H2

H3

H4

H5

H6

段落

Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.

Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.

图片

您可以使用以下语法来包含图片。图片的路径应相对于 index.md 文件。

![Landscape](1.jpg)

您还可以包含来自外部来源的图片。

![Image](https://source.unsplash.com/random/600x400/?tech)

引用

引用元素表示从其他来源引用的内容，可以选择包含引用来源，引用来源必须位于 footer 或 cite 元素中，还可以选择包含注释和缩写等内联更改。

无来源的引用

您可以在引用中使用 Markdown 语法，例如 bold, italics, links, code。

带来源的引用

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike¹

表格

表格不是 Markdown 核心规范的一部分，但 Hugo 原生支持它们。

Name	Age
Bob	27
Alice	23

表格中的 Markdown

Italics	Bold	Code
italics	bold	`code`

代码块

使用反引号的代码块

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

缩进四个空格的代码块

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

使用 Hugo 内置高亮短代码的代码块

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

内联代码

使用反引号在句子中引用 variable。

列表类型

有序列表

First item
Second item with some code in it
Third item

无序列表

List item
Another item with some code in it
And another item

嵌套列表

Fruit
- Apple
- Orange
- Banana
Dairy
- Milk
- Cheese

其他元素 — abbr, sub, sup, kbd, mark

GIF 是一种位图图像格式。

H₂O

Xⁿ + Yⁿ = Zⁿ

按下 CTRL+ALT+Delete 结束会话。

大多数蝾螈是夜行动物，捕食昆虫、蠕虫和其他小生物。

占位文本示例

Lorem est tota propiore conpellat pectoribus de pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.

Exierant elisi ambit vivere dedere
Duce pollice
Eris modo
Spargitque ferrea quos palude

Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.

Comas hunc haec pietate fetum procerum dixit
Post torum vates letum Tiresia
Flumen querellas
Arcanaque montibus omnes
Quidem et

Vagus elidunt

The Van de Graaf Canon

Mane refeci capiebant unda mulcebat

Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. Faces illo pepulere tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.

Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.

Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel mitis temploque vocatus, inque alis, oculos nomen non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides parte.

上述引用摘自 Rob Pike 在 2015 年 11 月 18 日 Gopherfest 上的演讲。 ↩︎