Markdown 备忘清单

0 阅读1分钟

一份快速查阅的 Markdown 语法参考,涵盖从标题到行内 HTML 的常用标记写法,助你高效编写结构清晰的文档。

  1. 标题语法:掌握 atx 与 setext 两种风格
  2. 文本样式:粗体、斜体、删除线、内联代码与换行
  3. 列表与任务:有序列表、无序列表、任务列表的写法
  4. 链接与图片:内联、参考、带链接图片的用法
  5. 代码与块引用:代码块、引用块的格式与嵌套

一、标题语法

Markdown 提供两种定义标题的方式:atx 风格使用 # 符号,setext 风格在文本下方放置等号或短横线。

1.1 atx 风格标题


# h1

## h2

### h3

#### h4

##### h5

###### h6

1.2 setext 风格标题

Header 1
========

Header 2
--------

注意:setext 风格仅支持 h1 和 h2 两级标题。


二、文本样式

2.1 强调与删除

*斜体*    _斜体_    **粗体**   __粗体__
~~删除~~

2.2 内联代码

`内联代码` 使用反引号包裹

2.3 换行

在行尾添加两个空格
即可实现换行
或使用反斜杠进行
手动换行


三、列表

3.1 无序列表


- Item 1

- Item 2
  - item 3a
  - item 3b

3.2 有序列表


1. Item 1

2. Item 2
    - item 3a
    - item 3b

子列表可通过缩进(4 个空格或制表符)实现,使用 - 创建子条目。

3.3 任务列表


- [ ] Checkbox off

- [x] Checkbox on


四、链接与图片

4.1 链接

[内联链接](http://google.com)

[参考链接][google]
[google]: http://google.com

<http://google.com>   <!-- 自动链接 -->

4.2 图片

基本图片

![替代文字](https://via.placeholder.com/150)

带链接的图片

[![替代文字](https://via.placeholder.com/150)](https://github.com)

参考风格图片

![替代文字][logo]
[logo]: https://via.placeholder.com/150 "Logo Title"

五、代码与块引用

5.1 块引用

> 这是一个块引用
>
> > 嵌套块引用

效果

这是一个块引用

嵌套块引用

5.2 代码块

使用围栏式(推荐)或缩进式均可。

围栏式代码块(三反引号)

console.log("This is a block code")
.button { border: none; }

缩进式代码块

    4 个空格缩进的代码块

六、表格与脚注

6.1 表格

基础表格

| 左栏     | 中间栏   | 右栏  |
| -------- | -------- | ----- |
| 单元格 1 | 居中对齐 | $1600 |
| 单元格 2 | 单元格 3 | $12   |

对齐方式

| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 文字   |   文字   |   文字 |

效果

左对齐居中对齐右对齐
文字文字文字

6.2 脚注

这是一个简单的脚注[^1]。

一个脚注也可以有多行[^2]。

[^1]: 我的参考说明。
[^2]: 每个新行都应以 2 个空格为前缀。  
  这允许你有一个多行的脚注。

七、分隔线与转义

7.1 水平分隔线

---

***

___

三种写法效果相同。

7.2 反斜杠转义

符号Markdown 写法含义
\\\\\反斜杠
``\``反引号
*\\\*星号
_\\\_下划线
{}\\{}花括号
[]\\[]方括号
()\\()圆括号
#\\#井号

| + | \\+​ | 加号 |
| - | \\-​ | 减号/连字符 |
| . | \\.​ | 句点 |
| ! | \\! | 感叹号 |


八、行内 HTML

Markdown 支持混入部分行内 HTML 元素,常用于精细排版。

目前支持的元素包括 <kbd>Ctrl</kbd>, <b>粗体</b>, <i>斜体</i>, 
<em>强调</em>, <sup>上标</sup>, <sub>下标</sub>, <br> 换行等。

效果:目前支持的元素包括 Ctrl​, 粗体, 斜体, 强调, 上标, 下标,
换行等。


最后

掌握以上基础语法,便能应对绝大多数文档编写场景。Markdown 的精髓在于简洁且可读,勤加练习,形成肌肉记忆,写作效率将大幅提升。