mirror of
https://github.com/imfing/hextra.git
synced 2025-08-23 22:16:35 -04:00
ec007d73c0
* docs(blog): prepare for v0.10 release post * Update v0.10.md * Update v0.10.md to refine upgrade instructions and enhance blog features. Added synchronized tab switching and pagination controls, while improving the search experience and table of contents navigation. * Enhance v0.10 release documentation with detailed upgrade instructions and migration guide. Added Tailwind theme variable customization section and clarified breaking changes. Improved clarity on CSS class prefix changes for better user experience. * Update v0.10.md to enhance upgrade instructions, clarify breaking changes, and improve overall readability. Adjusted formatting for consistency and added details on asset management and user experience improvements. * Add notable new features to v0.10.md, including dropdown menu support, enhanced search experience, and blog list pagination. Updated FlexSearch upgrade details for clarity and improved migration guide by removing redundant breaking change notes. * chore: update zh-cn translation * chore: update ja translation * chore: update fa and ja translations * chore: prepare release
199 lines
5.0 KiB
Markdown
199 lines
5.0 KiB
Markdown
---
|
|
title: Markdown
|
|
weight: 2
|
|
---
|
|
|
|
Hugo 支持使用 [Markdown](https://en.wikipedia.org/wiki/Markdown) 语法来格式化文本、创建列表等。本页将展示一些最常用的 Markdown 语法示例。
|
|
|
|
<!--more-->
|
|
|
|
## Markdown 示例
|
|
|
|
### 文本样式
|
|
|
|
| 样式 | 语法 | 示例 | 输出 |
|
|
| :----- | :--------------- | :------------------------ | :---------------------- |
|
|
| 粗体 | `**粗体文本**` | `**粗体文本**` | **粗体文本** |
|
|
| 斜体 | `*斜体文本*` | `*斜体文本*` | _斜体文本_ |
|
|
| 删除线 | `~~删除线文本~~` | `~~删除线文本~~` | ~~删除线文本~~ |
|
|
| 下标 | `<sub></sub>` | `这是<sub>下标</sub>文本` | 这是<sub>下标</sub>文本 |
|
|
| 上标 | `<sup></sup>` | `这是<sup>上标</sup>文本` | 这是<sup>上标</sup>文本 |
|
|
|
|
### 引用块
|
|
|
|
带出处的引用
|
|
|
|
> 不要通过共享内存来通信，而要通过通信来共享内存。<br>
|
|
> — <cite>Rob Pike[^1]</cite>
|
|
|
|
[^1]: 上述引用摘自 Rob Pike 在 2015 年 11 月 18 日 Gopherfest 上的[演讲](https://www.youtube.com/watch?v=PAAkCSZUG1c)。
|
|
|
|
```markdown {filename=Markdown}
|
|
> 不要通过共享内存来通信，而要通过通信来共享内存。<br>
|
|
> — <cite>Rob Pike[^1]</cite>
|
|
|
|
[^1]: 上述引用摘自 Rob Pike 在 2015 年 11 月 18 日 Gopherfest 上的[演讲](https://www.youtube.com/watch?v=PAAkCSZUG1c)。
|
|
```
|
|
|
|
### 提示框
|
|
|
|
{{< new-feature version="v0.9.0" >}}
|
|
|
|
提示框是基于引用块语法的 Markdown 扩展，可用于强调关键信息。
|
|
支持 [GitHub 风格的提示框](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)。
|
|
请确保您使用的是最新版本的 Hextra 和 [Hugo v0.146.0](https://github.com/gohugoio/hugo/releases/tag/v0.146.0) 或更高版本。
|
|
|
|
> [!NOTE]
|
|
> 即使用户只是浏览内容，也应该知道的有用信息。
|
|
|
|
> [!TIP]
|
|
> 帮助用户更高效或更轻松完成任务的建议。
|
|
|
|
> [!IMPORTANT]
|
|
> 用户需要了解的关键信息，以实现他们的目标。
|
|
|
|
> [!WARNING]
|
|
> 需要用户立即关注的紧急信息，以避免出现问题。
|
|
|
|
> [!CAUTION]
|
|
> 关于某些操作可能带来风险或负面结果的警告。
|
|
|
|
```markdown {filename=Markdown}
|
|
> [!NOTE]
|
|
> 即使用户只是浏览内容，也应该知道的有用信息。
|
|
|
|
> [!TIP]
|
|
> 帮助用户更高效或更轻松完成任务的建议。
|
|
|
|
> [!IMPORTANT]
|
|
> 用户需要了解的关键信息，以实现他们的目标。
|
|
|
|
> [!WARNING]
|
|
> 需要用户立即关注的紧急信息，以避免出现问题。
|
|
|
|
> [!CAUTION]
|
|
> 关于某些操作可能带来风险或负面结果的警告。
|
|
```
|
|
|
|
### 表格
|
|
|
|
表格不是 Markdown 核心规范的一部分，但 Hugo 原生支持它们。
|
|
|
|
| 姓名 | 年龄 |
|
|
| :--- | :--- |
|
|
| 张三 | 27 |
|
|
| 李四 | 23 |
|
|
|
|
```markdown {filename=Markdown}
|
|
| 姓名 | 年龄 |
|
|
| :--- | :--- |
|
|
| 张三 | 27 |
|
|
| 李四 | 23 |
|
|
```
|
|
|
|
#### 表格内的行内 Markdown
|
|
|
|
| 斜体 | 粗体 | 代码 |
|
|
| :----- | :------- | :----- |
|
|
| _斜体_ | **粗体** | `代码` |
|
|
|
|
```markdown {filename=Markdown}
|
|
| 斜体 | 粗体 | 代码 |
|
|
| :----- | :------- | :----- |
|
|
| _斜体_ | **粗体** | `代码` |
|
|
```
|
|
|
|
### 代码块
|
|
|
|
{{< cards >}}
|
|
{{< card link="../../guide/syntax-highlighting" title="语法高亮" icon="sparkles" >}}
|
|
{{< /cards >}}
|
|
|
|
### 列表
|
|
|
|
#### 有序列表
|
|
|
|
1. 第一项
|
|
2. 第二项
|
|
3. 第三项
|
|
|
|
```markdown {filename=Markdown}
|
|
1. 第一项
|
|
2. 第二项
|
|
3. 第三项
|
|
```
|
|
|
|
#### 无序列表
|
|
|
|
- 列表项
|
|
- 另一个项
|
|
- 再一个项
|
|
|
|
```markdown {filename=Markdown}
|
|
- 列表项
|
|
- 另一个项
|
|
- 再一个项
|
|
```
|
|
|
|
#### 嵌套列表
|
|
|
|
- 水果
|
|
- 苹果
|
|
- 橙子
|
|
- 香蕉
|
|
- 乳制品
|
|
- 牛奶
|
|
- 奶酪
|
|
|
|
```markdown {filename=Markdown}
|
|
- 水果
|
|
- 苹果
|
|
- 橙子
|
|
- 香蕉
|
|
- 乳制品
|
|
- 牛奶
|
|
- 奶酪
|
|
```
|
|
|
|
### 图片
|
|
|
|
|
|
|
|
```markdown {filename=Markdown}
|
|
|
|
```
|
|
|
|
带标题：
|
|
|
|
|
|
|
|
```markdown {filename=Markdown}
|
|
|
|
```
|
|
|
|
如需更高级的功能，请使用 Hugo 内置的 [Figure 短代码](https://gohugo.io/shortcodes/figure/)。
|
|
|
|
## 配置
|
|
|
|
Hugo 使用 [Goldmark](https://github.com/yuin/goldmark) 进行 Markdown 解析。
|
|
Markdown 渲染可以在 `hugo.yaml` 中的 `markup.goldmark` 下配置。
|
|
以下是 Hextra 的默认配置：
|
|
|
|
```yaml {filename="hugo.yaml"}
|
|
markup:
|
|
goldmark:
|
|
renderer:
|
|
unsafe: true
|
|
highlight:
|
|
noClasses: false
|
|
```
|
|
|
|
更多配置选项，请参阅 Hugo 文档中的 [配置 Markup](https://gohugo.io/getting-started/configuration-markup/)。
|
|
|
|
## 学习资源
|
|
|
|
- [Markdown 指南](https://www.markdownguide.org/)
|
|
- [Markdown 速查表](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
|
|
- [Markdown 教程](https://www.markdowntutorial.com/)
|
|
- [Markdown 参考](https://commonmark.org/help/)
|