markdown语法记录

基础语法

1.1 标题

使用 1 到 6 个 “#” 加上空格和标题文本，创建 1 到 6 级标题，如：

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

1.2 字体样式

• 加粗：用两个 “*” 或 “_” 包裹文字，如**加粗文字** 或 加粗文字。

• 斜体：用一个 “*” 或 “_” 包裹文字，如*斜体文字* 或 斜体文字。

• 斜体加粗：用三个 “*” 或 “_” 包裹文字，如***斜体加粗文字*** 或 ___斜体加粗文字___。

• 删除线：用两个 “~” 包裹文字，如~~删除线文字~~。

1.3 列表

• 无序列表：使用 “*”、“+” 或 “-” 加空格开始列表项，如：

* 列表项1

+ 列表项2

- 列表项3

• 有序列表：用数字加英文句点和空格开始列表项，如：

1. 第一项

2. 第二项

3. 第三项

• 列表嵌套：在子列表项前缩进 4 个空格或 1 个制表符，如：

1. 主列表项1

- 子列表项1.1

- 子列表项1.2

2. 主列表项2

1.4 引用

在引用内容前加 “>”，如：

> 这是一段引用文字。

可多层嵌套，如：

> 外层引用

> > 内层引用

1.5 分割线

用三个或更多的 “*”、“-” 或 “_”，单独占一行，如：

***

---

___

1.6 图片

行内形式为，如：

![示例图片](https://example.com/image.jpg "这是一张示例图片")

本地图片替换为本地文件路径。

1.7 链接

• 行内式链接：[链接文本](链接地址 "链接标题")，如[前往百度](https://www.baidu.com "百度官网")。

• 参考式链接：先[链接文本][标记]，再在其他位置定义[标记]: 链接地址 "链接标题"，如：

在文档中写下 [我的博客][blog]，然后在文末定义 [blog]: https://example.com/blog "我的个人博客"

• 自动链接：网址或邮箱用 “<>” 包起来，或直接书写，如<https://chenxianlin.com> 或 cxl_forest@foxmail.com。

1.8 代码

• 行内代码：用反引号（`）包裹代码，如`print("Hello, World!")`。

• 代码块：

缩进 4 个空格或 1 个制表符，如：

  def add(a, b):
      return a + b

• 用三个反引号（```）包裹，并可指定代码语言实现语法高亮，如：

  def add(a, b):
    return a + b

  function add(a, b) {
     return a + b;
  }

1.9 表格

用 “|” 分隔表头和单元格，“-” 分隔表头和表体，“:” 设置对齐方式，如：

  | 表头1 | 表头2 | 表头3 |
  | :---- | :---: | ----: |
  | 内容1 | 内容2 | 内容3 |
  | 内容4 | 内容5 | 内容6 |

“:” 在 “-” 左边左对齐，两边都有居中对齐，在右边右对齐。

进阶语法

2.1 注脚

在需加注脚文字后加（^ 注脚名字），在文本任意位置（一般文末）添加脚注，如：

  这是一个具有注脚的文本。^1
  甘特图的mermaid语法^2
  
  ^1: 注脚的解释
  ^2: (mermaid语法说明)(http://mermaid.js.org/)

2.2 数学公式（基于 LaTeX 语法）

• 行内公式：用 “$”包裹，如$E = mc^2$。

• 独立公式：用 “$$” 包裹，如：

  $$
  \sum_{i=1}^{n} i = \frac{n(n + 1)}{2}
  $$

2.3 图表（以 Mermaid 为例）

以流程图为例，语法如下：

```mermaid
 graph TD;
 A-->B;
 A-->C;
 B-->D;
 C-->D;
```

生成简单流程图展示A、B、C、D流程关系。

2.4 脚注和尾注

可结合HTML的“<sup>”和“<a>”标签创建自定义脚注和尾注效果，配合CSS调整显示位置和样式。

2.5 自定义列表样式

结合HTML和CSS，用图标库（如Font Awesome）替换列表标记，如：

  ```html
  <ul class="custom-list">
    <li>列表项1</li>
    <li>列表项2</li>
    <li>列表项3</li>
  </ul>
  
  .custom-list li::before {
   content: "\f00c"; /* Font Awesome图标代码 */
   font-family: "Font Awesome 5 Free";
   font-weight: 900;
   margin-right: 5px;
  }
```

其他语法

3.1 转义

使用 “\” 转义特殊符号，如\*显示为*，可转义符号有：\、*、_、{}、()、#、+、-、.、!等。

3.2 任务列表（GFM 扩展语法）

语法为：

- [ ] 未勾选任务
- [x] 已勾选任务

“x” 用小写，部分编辑器不支持大写。

3.3 表情符号（GFM 扩展语法）

语法为:表情代码:，代码参考http://www.webpagefx.com/tools/emoji-cheat-sheet 。

3.4 锚点

用于跳转到文档特定位置，语法为[锚点描述](#锚点名)，锚点名建议用字母和数字，区分大小写，不含空格和特殊字符。

3.5 内嵌 HTML​

可直接在 Markdown 中插入 HTML 标签，用于实现复杂排版，如：

  <p style="color: red; text-align: center;">红色居中文本</p>
  <div class="custom-box">自定义区块内容</div>

  <!-- 合并单元格 -->
  <table>​
    <tr>​
      <td colspan="2">跨两列的单元格</td>​
    </tr>​
    <tr>​
      <td rowspan="2">跨两行的单元格</td>​
      <td>普通单元格1</td>​
    </tr>​
    <tr>​
      <td>普通单元格2</td>​
    </tr>​
  </table>

注意：过度使用会降低 Markdown 的简洁性。

推荐

以上截图效果均为 VS Code 插件 Markdown Preview Enhanced所展示。其它markdown软件可参考此篇分享。