如何书写 md 文档

标题

使用#标记 作为开头，中间隔开空格， 并且对应 h1-h6

注意事项： 搜索内容仅对一至三级标题(h1-h3)生效

一级标题

有且只有一个

  1.   # 文字

二级标题

  1.   ## 文字

三级标题

  1.   ### 文字

四级标题

  1.   #### 文字

五级标题

  1.   ##### 文字

六级标题

  1.   ###### 文字

加粗、斜体

你可以使用 * 或者 _ 作为标记开头，来对文字加粗或者斜体

加粗

使用 ** 或者 __ 来标记，成对出现

::: tip 例子 **你的文字** : 你的文字

__你的文字__ : 你的文字 :::

斜体

使用 * 或者 _ 来标记， 成对出现

::: tip 例子 *你的文字* : 你的文字

_你的文字_ : 你的文字 :::

加粗斜体

使用*** 或者 ___ 作为标记，成对出现

:::tip 例子 ***你的文字*** : 你的文字

___你的文字___ : 你的文字
:::

列表

有序列表

使用 1. 来标记，英文标点

:::tip 这是一个有序列表 1. 测试

  1. 测试
  2. 测试 :::

无序列表

可以使用 -、+、* 来写无序列表

::: tip 例子 - 测试, +、*都相同

  • 测试

  • 测试

:::

引用

使用 > 标记作为开头可以嵌套

::: tip 例子

这是一段引用1

这是一段引用2

这是一段引用3

:::

引用可以在列表中使用

代码块

行内代码块可以是用 “`” 来标记，成对出现

测试文本

多行包裹代码块使用 “ ```javascript/php/typescript… “ 来包裹标记，成对出现, 语言标注说明开头标记后

  1. const txt = 'test'

超链接

在页面加入超链接 [文字](地址) 或者直接是地址 <地址>

:::tip 例子 [文字](地址): 百度

<地址>: https://www.baidu.com :::

图片

在页面加入图片,使用 ![文字描述](地址)

::: tip 例子 ![测试地址](http://bbs.cnlinfo.net/up/tou/150611164743.jpg):测试地址 :::

表格

快速嵌入表格

  1. |  标头   | 标头  |
  2. |  ----  | ----  |  // 可以使用对齐方式， :- 左对齐， -: 右对齐，:-: 居中对齐
  3. | 单元格  | 单元格 |
  4. | 单元格  | 单元格 |

::: tip 例子 | 表头 | 表头 | | —— | —— | | 单元格 | 单元格 | | 单元格 | 单元格 | :::