跳到主要内容

Markdown 文档语法格式

· 阅读需 4 分钟

Markdown 语法简介​

  • 本文演示 Markdown 所有语法功能
  • 有些功能需要插件支持

告示​

备注

部分 内容 使用 Markdown note 编写。请查看此处api。

提示

部分 内容 使用 Markdown tip 编写。请查看此处api。

信息

部分 内容 使用 Markdown info 编写。请查看此处api。

注意

部分 内容 使用 Markdown warning 编写。请查看此处api。

危险

部分 内容 使用 Markdown danger 编写。请查看此处api。

标题​

不同数量的#可以完成不同的标题，如下：

二级标题​

三级标题​

四级标题​

字体​

**粗体**、_斜体_、**_粗体和斜体_**，~删除线~，需要在文字前后加不同的标记符号。如下：

这个是粗体

这个是斜体

这个是粗体加斜体

这里想用删除线

无序列表​

无序列表的使用，在符号-后加空格使用。如果要控制列表的层级，则需要在符号-前使用空格。如下：

  • 无序列表 1
  • 无序列表 2
    • 无序列表 2.1
    • 无序列表 2.2

有序列表​

有序列表的使用，在数字及符号.后加空格后输入内容，如下：

  1. 有序列表 1
  2. 有序列表 2
  3. 有序列表 3

引用​

引用的格式是在符号>后面书写文字。如下：

读一本好书，就是在和高尚的人谈话。 ——歌德

雇用制度对工人不利，但工人根本无力摆脱这个制度。 ——阮一峰

链接​

有两种方法可以添加到另一个页面的链接：通过 URL 路径和文件路径。

- [指向另一个文档的 URL 路径](./installation)

图片​

用简单的 Markdown 语法显示图像：

![示例横幅](/img/icon/visual_studio_code.png)

示例横幅

分割线​

---

表格​

可以使用冒号来定义表格的对齐方式，如下：

姓名年龄工作
小可爱18吃可爱多
小小勇敢20爬棵勇敢树
小小小机智22看一本机智书

代码块​

```js
console.log("每个仓库都应该有个吉祥物。");
```
console.log("每个仓库都应该有个吉祥物。");

数学公式​

可以使用 KaTeX渲染数学方程式。

$$
I = \int_0^{2\pi} \sin(x)\,dx
$$
I=∫02πsin⁡(x) dxI = \int_0^{2\pi} \sin(x)\,dx

注解​

🚧 未知的，困难的
🚯 未了解的
🔥 热门的
🧊 放弃使用的
🚮 废弃的

参考链接​

markdown 语法文档