本站 Markdown 写作速查 - 石以砥焉化钝为利

635 字

3 分钟

本站 Markdown 写作速查

2026-09-20

浏览量加载中...

写文章时最常用的语法集中在这里，方便随时回来抄。

基础语法#

1
**加粗**  *斜体*  ~~删除线~~  `行内代码`
2

3
# 一级标题（正文里一般从 ## 开始用）
4

5
> 引用
6

7
- 无序列表
8
- 第二项
9

10
1. 有序列表
11
2. 第二项
12

13
[链接文字](https://example.com)
14
![图片说明](./step-1.png)
15

16
| 表头 | 表头 |
17
| --- | --- |
18
| 内容 | 内容 |

提示框#

主题内置了四种提示框，写法是 :::类型 加内容：

1
:::note
2
补充说明。
3
:::
4

5
:::tip
6
小技巧。
7
:::
8

9
:::important
10
重要信息。
11
:::
12

13
:::caution
14
注意，可能会出问题。
15
:::

渲染出来是这样：

Note

这是一条补充说明。

Tip

这是一条小技巧。

Caution

这是一条警告，提醒你注意某个坑。

代码块#

用三个反引号加语言名，会带上语法高亮、行号和复制按钮：

1
```ts
2
const greeting = "hello";
3
console.log(greeting);
4
```

1
const greeting = "hello";
2
console.log(greeting);

数学公式#

行内公式用单个 $，独立公式用两个 $$：

1
质能方程 $E = mc^2$ 大家都见过。
2

3
$$
4
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
5
$$

效果：质能方程 $E = mc^2$ 大家都见过。

\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}

图表#

Mermaid#

1
```mermaid
2
graph LR
3
  A[写 Markdown] --> B[构建]
4
  B --> C[上传 dist]
5
  C --> D[线上生效]
6
```

PlantUML#

1
```plantuml
2
@startuml
3
Alice -> Bob: 请求
4
Bob --> Alice: 响应
5
@enduml
6
```

GitHub 卡片#

直接插入仓库卡片：

1
::github{repo="CuteLeaf/Firefly"}

CuteLeaf

Firefly

🍀Firefly, fresh and aesthetic Astro blog theme template.

—

MIT

Astro

文章加密#

在 front-matter 里设置密码，整篇文章会被加密：

1
---
2
title: 私密文章
3
password: "123456"
4
passwordHint: "六位数字"
5
---

正文在浏览器端解密，密码不会出现在构建产物里。但这是前端加密，只适合挡住随手点进来的人，不要用来存真正敏感的东西。

支持的提示框类型#

:::类型 里的类型名可以是下面任意一个，写哪个都会渲染成对应颜色的提示框：

1
note  tip  important  warning  caution
2
info  todo  success  question  danger
3
example  quote  abstract  failure  bug

文章 front-matter 速查#

1
---
2
title: 文章标题            # 必填
3
published: 2026-09-20      # 必填，发布时间
4
description: 文章简介       # 显示在列表和分享卡片
5
image: ./cover.avif        # 封面图，可用相对路径
6
tags: [标签1, 标签2]        # 标签
7
category: 分类名            # 分类，只能有一个
8
draft: false               # true 表示只在本地显示
9
pinned: false              # true 会置顶
10
comment: true              # 是否允许评论
11
series: 系列名              # 系列文章
12
seriesOrder: 1             # 系列中的顺序
13
---

Tip

category 只能是一个分类，tags 可以有很多个。分类用于归档页的大类划分，标签用于交叉检索——分类别乱建，标签可以随便加。

文章分享

如果这篇文章对你有帮助，欢迎分享给更多人！

本站 Markdown 写作速查

https://boyuan.net.cn/posts/markdown-cheatsheet/

作者

Boyuan

发布于