MarkDown 语法总结
前言(关于MarkDown)
Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。 它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。 如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等,甚至还能被使用来撰写电子书。Markdown 编写的文档后缀为 .md, .markdown。 – 摘于百度百科
标题
使用 # + 空格可以表示1-6级标题, “#”的个数就代表标题的级数。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
字体
文字加粗 : 在文字两边加上两个“*”或加上两个“_”
文字斜体 : 在文字两边加上一个“*”或加上一个“_”
斜体加粗 : 在文字两边加上三个“*”或加上三个“_”
eg : 文字加粗 文字斜体 斜体加粗
文字删除线和下划线
添加文字删除线: 在文字的两边加上两个波浪线“~~”
添加文字下划线: 通过HTML中的<u>来实现,即<u>下划线</u>
eg : 文字删除线
文字下划线
分割线
分割线,即一条横线,线上没有任何内容。
可以在一行中用三个以上的 “*”、“-”或“_”来创建一个分割线,符号间可以又空格
如: ***
---
___
* * *
eg :
脚注
脚注的作用就是对文本的补充说明,类似Excel中的注释。
格式 : [^注释]
[^注释]: 这才是显示的注释内容
送你一朵小红花 遮住你今天新添的伤疤 奖励你在下雨天 还愿意送我回家 科罗拉多的风雪啊 喜马拉雅的骤雨啊 只要你相信我 闭上眼就能到达1。
列表
有序列表
有序列表的实现: 数字并加上“.”来表示
如 : 1. 第一项
2. 第二项
3. 第三项
- 第一项
- 第二项
- 第三项
无序列表
无序列表的实现 : 使用星号(*)、加号(+)或是减号(-)作为列表标记。
注: 这些标记后面要添加一个空格,再填写内容。
如 : + 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
嵌套列表
列表嵌套的实现:子列表中的选项前面添加四个空格即可,其他语法不变化。
如 : 1. 第一项
* 第一小项
* 第二小项
2. 第二项
* 第一小项
* 第二小项
3. 第三项
* 第一小项
* 第二小项
- 第一项
* 第一小项
* 第二小项 - 第二项
* 第一小项
* 第二小项 - 第三项
* 第一小项
* 第二小项
代码
一个片段的代码可以用反引号(`)把它包起来。
如 : `sort()`函数
代码块的实现 : 用 ```包裹住代码块,一般来说只要在开头写上```,编辑器会在末尾补充```。同时可以指定一种语言(也可不指定)
如 : ```, ```java
注: 反引号就是Tab键上方的那个键。
sort()
函数
public class Add{
int sum = 0;
private int add(int a, int b){
sum = a + b;
return sum;
}
}
区块
区块的作用: 让文章看起来更有层次感。
区块的实现: 在段落开头使用 > 符号,后面紧跟着一个空格
如: > 滕王高阁临江渚,佩玉鸣鸾罢歌舞。
> 画栋朝飞南浦云,珠帘暮卷西山雨。
> 闲云潭影日悠悠,物换星移几度秋。
> 阁中帝子今何在?槛外长江空自流。
区块的嵌套: 第一层使用一个“>”,第二层使用两个“>”,以此类推。
如: >滕王阁序
>>王勃
>>>豫章故郡,洪都新府。星分翼轸,地接衡庐。襟三江而带五湖,控蛮荆而引瓯越……
同理,列表中可以嵌套区块,区块中也可以嵌套列表,这里就不一一演示了。
滕王高阁临江渚,佩玉鸣鸾罢歌舞。
画栋朝飞南浦云,珠帘暮卷西山雨。
闲云潭影日悠悠,物换星移几度秋。
阁中帝子今何在?槛外长江空自流。
滕王阁序
王勃
豫章故郡,洪都新府。星分翼轸,地接衡庐。襟三江而带五湖,控蛮荆而引瓯越……
链接
普通链接的创建有两种方法:
1. <链接地址> 2.[链接名称](链接地址)
如 :1. <https://www.baidu.com/>
2. [百度](www.baidu.com)
高级链接的的创建:
通过变量来设置一个链接,变量赋值在文档末尾进行
如: 3. [百度一下][baidu] (此链接用“baidu”作为网址变量)
[baidu]: www.baidu.com (放在文档的结尾)
图片
图片的语法格式 : ![alt 属性文本](图片地址 "可选标题")
***开头一个感叹号,紧接着是中括号,中括号里面是图片的替代文字,最右边是一个小括号,小括号里面是图片的地址,
最后还可以用引号包住并加上选择性的 'title' 属性的文字
如 : ![可爱的的小妹妹](https://img-blog.csdnimg.cn/2021030915090041.jpg(图片地址))
·像网址那样对图片网址使用变量
如: 点击右侧蓝色字体进入链接图片 [baidu][1]
[1]: //www.baidu.com/img/flexible/logo/pc/index.png (这一行相当于为变量赋值放在文章尾部)
点击右侧蓝色字体进入链接图片 baidu
表格
语法格式: | 表头1 | 表头2 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
如: | 左对齐 | 居中对齐 | 右对齐|
| :-----| :----: | ----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
表头1 | 表头2 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
左对齐 | 居中对齐 | 右对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
写在最后
MarkDown能做的事情还有很多,例如:书写复杂的公式,绘制各种流程图等等。有兴趣的同学可以查询资料好好学习!
关于MarkDown的编辑器推荐,个人比较喜欢Typoro,页面简洁,功能也齐全。