Markdown 基础语法
查看更多学习笔记:GitHub:LoveEmiliaForever
标题创建
标题语法格式
在文字前添加一至六个#
即可创建标题
标题是有等级的,具体等级根据#
个数决定
由于标题等级参与构建整篇文章的架构,编写时应该遵循如下规则:
- 标题等级之间应该连续,最好不要中断
- 应该从一级标题开始书写文章
- 标题的上下两行应该为空
- 用空格隔开
#
与文字
标题创建示例
# 一级标题
## 二级标题
### 三级标题
文本样式
文本样式示例
效果 | 语法 | 源代码 | 生成效果 |
---|---|---|---|
加粗 | ** 文字内容** | **突出信息** | 突出信息 |
斜体 | * 文字内容* | *引用、作品名、标记* | 引用、作品名、标记 |
删除线 | ~~ 文字内容~~ | ~~强调错误、特殊情况~~ | |
叠加使用粗体与斜体 | ** ** 与__ __ | **叠加*使用*它们** | 叠加使用它们 |
下标 | <sub>文字内容</sub> | 一般情况<sub>不要用下标做注释</sub> | 一般情况不要用下标做注释 |
上标 | <sup>文字内容</sup> | 一般情况<sup>不要用上标做注释</sup> | 一般情况不要用上标做注释 |
ℹ️注意事项:注意要使用与排版目的相对应的效果,每个效果都应该有固定的排版目的,这样才不会造成文章的混乱不堪
换行、段落、空格与空行
ℹ️注意:有些编辑器支持常规排版操作,有些则不支持,为了兼容性应该全部采取非常规操作(本文所介绍方法)
换行
换行只需要在行末插入两个空格 + 回车
即可实现换行
<!--下面两行是不加空格直接换行的代码-->
这是第一行
这是第二行
<!--下面两行则是加了两个空格后换行的代码-->
这是第一行
这是第二行
【不正确换行】这是第一行
【不正确换行】这是第二行
【正确换行】这是第一行
【正确换行】这是第二行
段落
新建段落需要换行后再留下一行空白行
,也就是说段落之间是由空白行隔开的
<!--下面是换行不换段-->
【换行不换段】第一段的文字
【换行不换段】第二段文字
<!--换段效果-->
【换段】第一段的文字
【换段】第二段文字
【换行不换段】第一段的文字
【换行不换段】第二段文字
【换段】第一段的文字
【换段】第二段文字
空格与空行
要输入空格只需输入 
即可,要输入空行只需输入&emsp
即可
表情符号 Emoji✌️ 使用
可以通过在Markdown中使用:Emoji符号代码:
来显示Emoji表情符号
Emoji 代码百科    GitHub Emoji 代码
ℹ️注意:不同的 markdown 编辑器的 Emoji 代码不同
:octocat:GitHub
:trollface:暴走漫画
:moyai:复活岛石像
:octocat:GitHub
:trollface:暴走漫画
🗿复活岛石像
添加脚注
脚注分为两部分,文内标记和解释标记
文内标记选择想要解释的词,解释标记对词进行解释
它们是一一对应的,一对脚注标记的样子是一样的,都是[^脚注标记名字]
ℹ️注意:所有的解释标记都是放在 Markdown 文档的末尾,无论它在 Markdown 文档内的声明位置在哪里
ℹ️注意:脚注标记名字是不影响页面渲染出来之后的脚注名字的,渲染出来的脚注名字始终是脚注的排名数字
说明文档[^说明文档]不仅仅对前端开发[^1]来说很重要,对所有工程应用都很很重要。
[^说明文档]: 对应用设计、操作、架构等进行说明的文档
[^1]: 构建可视化页面的软件工程师
说明文档1不仅仅对前端开发2来说很重要,对所有工程应用都很很重要。
脚注被 Markdown渲染器 放在了该页面的底部
引用文本块
引用文本块语法格式
在需要引用的文本前添加>
即可构成文本块
在段落内引用引用文本应该使用文本斜体样式
如果是大段落的引用文本,则应该
使用引用文本块,将它包裹住,以构成合理的文本框架
文本块在编写时应该注意以下格式要求:
- 文本块的上下两行应该为空格
- 文本块不应该被使用在除标记引用文字外的用途
- 连续的两个引用块之间不应该以空行中断
引用块创建示例
下面的文字是引用文字
> 落霞与孤鹜齐飞,秋水共长天一色。
下面的文字是引用文字
落霞与孤鹜齐飞,秋水共长天一色。
引用代码、命令、快捷键等
引用代码语法格式
在文本中引用代码应该使用`代码语句`
单独展示代码应该使用代码块代码块
代码引用应该注意格式:
- 明晰代码块和代码段的不同使用场景
- 代码块引用前后两行应该是空行
- 在代码引用块后应该声明使用语言(如下所示)
引用代码示例
<!--这是行内代码语句引用-->
Python 可以使用`print()`方法输出字符串,如下:
<!--这是代码块引用-->
```python
print("Hello! World!")
```
Python 可以使用print()
方法输出字符串,如下:
print("Hello! World!")
列表与任务列表
列表
和 HTML 一样,Markdown 的列表也分为无序列表和有序列表,并且列表可以嵌套
要创建无序列表,在文本前添加*
、-
或+
即可
创建有序列表则需要在文本前添加编号,如:1.
、2.
等
列表嵌套则只需要在列表的符号前按Tab
输入制表符即可嵌套一层
ℹ️注意:列表只能一层一层的嵌套,无法跳跃式的嵌套
ℹ️注意:同一无序列表的符号应该要统一,否则 Markdown 会把它们分成不同的列表处理
<!--不统一的无序列表符号-->
- 原神
+ 华为
* 比亚迪
1. 原神
2. 华为
3. 比亚迪
* 原神
* 华为
* 比亚迪
- 原神
- 华为
- 比亚迪
- 原神
- 华为
- 比亚迪
- 原神
- 华为
- 比亚迪
- 华为
任务列表
任务列表的展现形式和普通列表不同,它带有复选框
如需创建任务列表,在文本前面输入- [ ]
或- [x]
即可
ℹ️注意:-
和[
之间有一个空格,- [ ]
中 [
和 ]
之间有一个空格
ℹ️注意:用户对任务列表进行的操作会反应到文档本身(一些 Markdown 编辑器会如此)
每日任务:
- [x] 原神
- [x] 华为
- [ ] 比亚迪
每日任务:
- 原神
- 华为
- 比亚迪
链接
Markdown 的链接使用方法也和 HTML 很相像,用户在点击链接后就会跳转到目标页面或目标地址
链接的定义:[介绍文字](目标地址)
链接的目的地既可以是一个网址,也可以是本文章的一个锚点(一般是某标题),还可以根据相对地址
进行文档间的跳跃
<!--外部网址-->
[点击前往百度](www.baidu.com)
<!--文章内跳转-->
[前往列表标题处](#列表)
<!--文档间跳转-->
[前往README.md文件](../../README.md)
点击前往百度
前往列表标题处
前往README.md文件
图像
添加图像的语法是![图片描述](图片地址)
图片可以是本地的(此时使用相对地址),可以是在线的(此时使用图片网址)
ℹ️注意:有些 Markdown 编辑器可以调整图片的大小和位置,但原生 Markdown 是不可以的
![一只章鱼猫](./image/image-1.png)
创建表格
表格分为表头
、格式化行
、内容
它们是由上到下排列的,其中格式化行
的作用是声明列的水平对齐方式
格式化行
可以填写---
、:---:
、:---
、---:
它们分别对应默认对齐
、水平居中
、左对齐
、右对齐
表格单元格之间以|
分隔
在创建表格时不用担心宽度问题,Markdown 会自动选择合适宽度
表格同样要求前后两行为空行
| 默认 | 居中 | 左对齐 | 右对齐 |
| --- | :---: | :--- | ---: |
| 我家 | 哥哥 | 下的蛋有本事 | 你就别吃 |
| 只因哥哥你下蛋 | 实在是 | 太 | 美 |
| 原神 | 华为 | 比亚迪 | 大疆 |
默认 | 居中 | 左对齐 | 右对齐 |
---|---|---|---|
我家 | 哥哥 | 下的蛋有本事 | 你就别吃 |
只因哥哥你下蛋 | 实在是 | 太 | 美 |
原神 | 华为 | 比亚迪 | 大疆 |
转义字符
在编写 Markdown 文档时,如果需要输入一些特殊字符(一般是编写 Markdown 的命令字符),则要对它们进行转义。
转义符号是\
,比如想要表格正常显示|
就需要输入\|
才行
其次是对`
的转义,它的转义在需要将它写入代码引用片段时和其它符号不同
例如显示`
的源代码是 而显示
的源代码是```````````````````
以此类推
家 | 哥哥 | 下的蛋有本事 | 你就别吃 |
| 只因哥哥你下蛋 | 实在是 | 太 | 美 |
| 原神 | 华为 | 比亚迪 | 大疆 |
转义字符
在编写 Markdown 文档时,如果需要输入一些特殊字符(一般是编写 Markdown 的命令字符),则要对它们进行转义。
转义符号是\
,比如想要表格正常显示|
就需要输入\|
才行
其次是对`
的转义,它的转义在需要将它写入代码引用片段时和其它符号不同
例如显示`
的源代码是 而显示
的源代码是```````````````````
以此类推
对应用设计、操作、架构等进行说明的文档 ↩︎
构建可视化页面的软件工程师 ↩︎