作为开发人员,都会涉及到版本管理,比较主流的当属gitlab、github,相信大家也看过不少git上的代码,都有README.md这个文件,一个整体的描述文件,而且还是图文的,还有超链接,是不是很炫酷,接下来就告诉大家一些简单的语法,足够日常使用了。
语法篇:
1、标题
语法:# 标题1 #
## 标题2 ##
### 标题3 ###
效果:标题1
标题2
标题3
2、文字样式
语法:* 样式 *
_样式_
效果:样式
样式
3、树形结构:
语法:* 节点1
* 节点2
* 子节点1
* 子节点2
效果:
- 节点1
- 节点2
- 子节点1
- 子节点2
4
、超链接:
语法:
[text](url)
效果:
[百度](heep:www.baidu.com)
5、图片
语法:
效果:
6、表格
语法:
| Tables | Are | Cool |
| ------------- |:---------------:| -------:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
| ------------- |:---------------:| -------:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
效果:
总结:可能有的效果不是很明显或者正确,你如果有github的账号可以自己新建一个README.md文件,在线编辑和预览,就非常直观了,下图为例: