markdown现在是github的标准文档格式,容易书写且在不同平台展示效果相同。markdown常用语法如下。
标题
一个#代表一级,最多6级
三级标题
文字样式
用两个星号包围标识加粗,
一个星号标识斜体,
一个下划线标识斜体
两个波浪线标识删除
链接及图片
url链接
中括号后面跟引号表示url
插入图片
引用
尖括号代表引用
尖括号代表引用
尖括号代表引用
无序列表
无序列表用 - + * 任何一种都可以
- 中划线开头,也可以为*开头
- 中划线开头,按tab键可以添加二级列表
- 二级列表
- 中划线开头
有序列表1
- 直接输入1开始的序号
- 阿萨德
- 阿萨德
分割线
三个中划线
代码高亮
代码高亮换行
三个反引号包裹起来
代码高亮换行,添加格式,在第一行三反引号后加代码格式类型:sh,js等
var params = $("#test").val();
代码高亮不换行
使用一个反引号包裹
生成目录结构
toc(table of content)
可以使用插件生成
https://github.com/houbb/markdown-toc
生成md文件,可以通过插件生成md文件
https://github.com/verbose/verb
https://github.com/verbose/verb-cli
表格
表头 | 表头 | 表头 |
---|---|---|
内容 | 内容 | 内容 |
内容 | 内容 | 内容 |
使用竖线分隔表头和内容的td,第二行分隔表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略
流程图(用处不大)
sequenceDiagram
A->>B: How are you?
B->>A: Great!