Markdown 语法指南

#markdown #syntax #writing #hugo
Table of Contents

Markdown 语法:Hugo 内容创作的基石

Markdown 是一种轻量级的标记语言,以其简洁的语法和易于阅读的特性,成为了博客、文档和在线内容创作的首选格式。对于使用 Hugo 构建网站的内容创作者而言,熟练掌握 Markdown 语法是高效编写文章、美化排版、丰富内容表达的关键。本文将为您详细介绍 Hugo 中常用的 Markdown 语法,帮助您更好地运用这一强大的工具。

基础文本格式

标题 (Headings)

Markdown 使用 # 号来表示标题的层级。# 的数量代表标题的级别,从一级标题到六级标题。

1
2
3
4
5
6
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

在 Hugo 的主题中,通常一级标题会被用作文章的 title,而其他级别的标题则用于组织文章结构。

段落 (Paragraphs)

段落由一个或多个连续的文本行组成,行与行之间用一个或多个空行隔开。Markdown 会自动将连续的文本块渲染成段落。

1
2
3
4
这是第一段。

这是第二段。
它包含多行文本,但会被渲染成一个段落。

强调 (Emphasis)

您可以使用星号 * 或下划线 _ 来实现文本的强调效果。

  • 斜体 (Italic): 使用单个星号或下划线包围文本。
    • *斜体文本*_斜体文本_ 将渲染为 斜体文本
  • 粗体 (Bold): 使用两个星号或下划线包围文本。
    • **粗体文本**__粗体文本__ 将渲染为 粗体文本
  • 粗斜体 (Bold Italic): 结合使用。
    • ***粗斜体文本***___粗斜体文本___ 将渲染为 粗斜体文本

分隔线 (Horizontal Rules)

您可以使用三个或更多的星号 *、减号 - 或下划线 _ 来创建水平分隔线。

1
2
3
---
***
___

它们都会渲染成一条水平线,用于分隔内容。

列表 (Lists)

Markdown 支持有序列表和无序列表。

无序列表 (Unordered Lists)

使用星号 *、加号 + 或减号 - 作为列表项的标记。

1
2
3
4
5
6
* 列表项一
* 列表项二
  * 嵌套列表项一
  * 嵌套列表项二
- 列表项三
+ 列表项四

有序列表 (Ordered Lists)

使用数字后跟一个点 . 来表示列表项。数字的顺序会被正确渲染,即使您输入的数字不连续。

1
2
3
4
5
1. 第一项
2. 第二项
   1. 嵌套第一项
   2. 嵌套第二项
3. 第三项

链接与图片

Markdown 使用方括号 [] 包围链接文本,后跟圆括号 () 包围链接地址。

  • 行内链接 (Inline Links):

    1
    
    这是一个 [行内链接](https://www.example.com)。
    

    渲染为:这是一个 行内链接

  • 参考式链接 (Reference-style Links):

    1
    2
    3
    
    这是一个 [参考式链接][link-id]。
    
    [link-id]: https://www.example.com "可选的链接标题"
    

    渲染为:这是一个 [参考式链接][link-id]。

图片 (Images)

图片语法与链接类似,只是在方括号前增加一个感叹号 !

  • 行内图片 (Inline Images):

    1
    
    ![图片替代文本](/uploads/content/83f6838ad5eb527a.jpg "可选的图片标题")
    

    渲染为:图片替代文本

  • 参考式图片 (Reference-style Images):

    1
    2
    3
    
    ![图片替代文本][image-id]
    
    [image-id]: https://www.example.com/image.png "可选的图片标题"
    

代码 (Code)

Markdown 可以方便地嵌入代码片段。

行内代码 (Inline Code)

使用反引号 ` 包围行内代码。

1
请使用 `git clone` 命令来克隆仓库。

渲染为:请使用 git clone 命令来克隆仓库。

代码块 (Code Blocks)

使用四个空格或一个制表符缩进代码块,或者使用三个反引号 ``` 包围代码块。Hugo 主题通常支持 GitHub Flavored Markdown (GFM) 的语法高亮,您可以在三个反引号后指定语言。

1
2
    这是一个被缩进的代码块。
    它会保持原样显示。
1
2
3
4
5
# 这是一个 Python 代码块
def hello_world():
    print("Hello, Hugo!")

hello_world()

渲染为:

1
2
3
4
5
# 这是一个 Python 代码块
def hello_world():
    print("Hello, Hugo!")

hello_world()

引用 (Blockquotes)

使用大于号 > 来表示引用。

1
2
3
4
> 这是引用的文本。
> 它可以跨越多行。
>
> > 嵌套的引用。

渲染为:

这是引用的文本。 它可以跨越多行。

嵌套的引用。

表格 (Tables)

Markdown 支持使用竖线 | 和减号 - 来创建表格。

1
2
3
4
5
| 列标题一 | 列标题二 | 列标题三 |
| :------- | :------: | -------: |
| 左对齐   |   居中   |  右对齐  |
| 内容一   |  内容二  |  内容三  |
| 更多内容 |  更多内容 |  更多内容 |

渲染为:

列标题一列标题二列标题三
左对齐居中右对齐
内容一内容二内容三
更多内容更多内容更多内容

注意:

  • : 用于控制列的对齐方式::--- (左对齐), ---: (右对齐), :---: (居中对齐)。
  • 表格的标题行和分隔行之间必须有一个减号行。

其他常用语法

删除线 (Strikethrough)

使用两个波浪线 ~~ 包围文本。

1
~~这是删除线文本~~

渲染为:这是删除线文本

HTML 标签

Markdown 允许您直接在文档中插入 HTML 标签,这在需要更精细控制排版时非常有用。

1
<p style="color: blue;">这是一段蓝色的文本。</p>

结论

掌握 Markdown 语法是 Hugo 内容创作的基础。通过以上介绍的常用语法,您可以轻松地创建出结构清晰、格式美观、内容丰富的博客文章。狗子28官网鼓励您多加练习,并在实际创作中不断探索 Markdown 的更多可能性,为您的网站内容注入更多活力。