赞
踩
一、md文件简介
经常在项目中看到这种文件:README.md
md全称Markdown。
Markdown语言是2004年由John Gruber(约翰·格鲁伯)创建。
Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown编写的文档可以导出 HTML、Word、图像、PDF、Epub 等多种格式的文档。
用Markdown编写的文档后缀为 .md, .markdown。
二、基本语法
1.标题
a.使用=和-标记一级和二级标题
一级标题
========
二级标题
--------
b.使用#标记
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
2.格式
a.字体
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
b.分隔符
***
* * *
*****
- - -
--------
c.删除线
~~删除线~~
d.下划线
<u>下划线</u>
3.列表
a.无序列表:使用星号,加号或者减号
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
b.有序列表:使用数字加点
1. 第一项
2. 第二项
3. 第三项
c.列表嵌套:在子列表中的选项前面添加四个空格
1. 第一项
- 第一项嵌套的第一个元素
2. 第二项
- 第二项嵌套的第一个元素
4.区块、引用
> 一级引用
>> 二级引用
>>> 三级引用
5.代码
a.单行代码使用`
`printf()`
b.多行代码使用```(后边可以指定语言类型,也可以不指定)
```sh
cd /
```
6.链接
a.行内式
[链接名](链接地址 "可选标题")
链接的文字放在[]中,链接地址放在随后的()中
链接也可以带title属性,链接地址后面空一格,然后用引号引起来
该表达式放在文本的行内,效果是将链接名做成链接
b.参数式
[链接名]: 链接地址 "可选标题"
链接的文字放在[]中,链接地址放在随后的:后,链接地址后面空一格,然后title用引号引起来
该格式定义了一个参数,后续可以在需要使用该链接的地方使用[链接名]即可
7.图片
a.行内式

b.参数式
[图片名]: 图片地址 "可选标题"
该格式定义了一个参数,引用图片时需要在[]前加上!
8.表格
分割线后面的冒号表示对齐方式,写在左边表示左对齐,右边为右对齐,两边都写表示居中
|表头|表头|表头|
|:---|:---:|---:|
|单元格|单元格|单元格|
|单元格|单元格|单元格|
9.可以使用PlantUML工具在markdown里面进行画图(流程图、时序图啥的都行)
PlantUML的使用方法:
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。