Markdown 写作速查

这是一篇随博客附带的写作参考。所有示例都可以复制到自己的文章中。

Markdown 用少量符号表达文章结构。这个博客会自动把它们排成适合阅读的页面。

标题与段落

文章标题由文件开头的 title 设置。正文从二级标题开始；标题会自动进入文章目录。

## 一个主要观点

这里写正文。段落之间留一个空行。

### 一个具体例子

这里补充解释。

用 **文字** 表示重点，用反引号包住行内代码，例如 print("hello")。

列表与引用

- 一个要点
- 另一个要点

1. 第一步
2. 第二步

> 一段需要单独展示的引用。

引用他人的内容时，在相邻位置补充作者和原始链接。

链接与图片

链接的写法是 [说明文字](网址)。例如：Hugo 官方文档。

把图片与 index.md 放在同一个文件夹，再按下面的方式引用：

![解释图片主要内容的文字](screenshot.png)

图片说明应表达图片中的关键信息。这样即使图片无法显示，读者也能理解上下文。

代码块

用三个反引号包住代码，并注明语言。博客会显示语法高亮和复制按钮。

def keep_a_note(topic: str) -> str:
    return f"今天记录：{topic}"

print(keep_a_note("一个新想法"))

表格

表格适合比较简短且平行的信息。较长的解释更适合写成段落。

对应的 Markdown：

| 写作目的 | 适合的结构 |
| --- | --- |
| 解释概念 | 定义、例子、边界 |
| 记录实践 | 目标、过程、结果 |

发布前看一眼

• 标题是否能说明文章内容？
• 日期和标签是否正确？
• 引用是否附有原始链接？
• 图片、代码和链接是否能正常显示？
• 正文是否包含不适合公开的信息？

确认之后，将 draft 设为 false，再提交文章。