Markdown语法
1.标题
从 h1 到 h6 的标题在每个级别上都加上一个#
1 | # h1 标题 |
2.注释
注释与html注释一样,在<!-- -->
内填写注释内容
1 | <!-- 这是一段注释 --> |
注释是不能看到的。
3.水平线
1 | ___: 三个连续的下划线 |
4.段落
按照纯文本的方式书写段落, 用一个空行
进行换行
5.内联 HTML 元素
直接使用html元素,例如
1 | <div class="class"> |
6.强调
6.1加粗
两个星号**
或下划线__
将需要加粗的内容进行包裹
1 | **渲染为粗体** |
6.2斜体
一个星号*
或下划线_
将需要斜体的内容进行包裹
1 | *渲染为斜体* |
6.3删除线
两个~~
将需要的内容进行包裹
1 | ~~这段文本带有删除线~~ |
6.4组合
加粗, 斜体, 和删除线可以组合使用
5.引用
在要引用的任何文本之前添加 >
1 | > 这是一段引用文字. |
引用可以套用,只需增加 >
个数
1 | > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. |
6.列表
6.1无序列表
在列表前添加 *
、 -
、 +
任一或组合
1 | * 一项内容 |
6.2有序列表
列表前加入数字和圆点
——1. 2. 3. 4. 5. … 等
1 | 1. Lorem ipsum dolor sit amet |
如果每一项列表都使用 1.
, Markdown 将自动为每一项编号
1 | 1. Lorem ipsum dolor sit amet |
6.3任务列表
任务列表用于创建带有复选框的列表. 创建任务列表, 在任务列表项之前添加破折号 (-
) 和带有空格的方括号 ([ ]
). 要选择一个复选框,请在方括号之间添加([x
]).
1 | - [x] Write the press release |
7.代码
行内代码用 `
包装行内代码段
1 | ` Hellow wordl ` |
8.表格
通过在每个单元格之间添加竖线作为分隔线, 并在标题下添加一行破折号 (也由竖线分隔) 来创建表格
注意,竖线不需要垂直对齐
1 | | Option | Description | |
文本默认左侧对其,如有需要居中,则破折号两侧添加冒号;如有需要右对齐,则破折号右侧添加冒号
1 | | Option | Description | |
9.链接
9.1基本链接
1 | [Assemble](https://assemble.io) |
9.2添加一个标题
1 | [Upstage](https://github.com/upstage/ "Visit Upstage!") |
9.3定位标记
定位标记使你可以跳至同一页面上的指定锚点. 例如, 每个章节:
1 | ## Table of Contents |
注意,定位标记的位置几乎是任意的. 因为它们并不引人注目, 所以它们通常被放在同一行了
10.脚注
脚注使你可以添加注释和参考, 而不会使文档正文混乱. 当创建脚注时, 会在添加脚注引用的位置出现带有链接的上标编号,读者可以单击链接以跳至页面底部的脚注内容.
要创建脚注引用,在方括号
中添加插入上三角
符号和标识符
([^1]). 标识符可以是数字或单词
,但不能包含空格或制表符. 标识符仅将脚注引用与脚注本身相关联 - 在脚注输出中,脚注按顺序编号.
在中括号内使用插入符号和数字以及用冒号和文本来添加脚注内容 ([^1]:这是一段脚注
). 你不一定要在文档末尾添加脚注. 可以将它们放在除列表, 引用和表格等元素之外的任何位置.
1 | 这是一个数字脚注[^1]. |
11.图片
图片的语法与链接相似,但包含一个在前面的感叹号——即格式为![]()
1 | ## 不带图标描述 |