以前总觉得office是大家通用的,以后在公司写需求文档什么的肯定也要用,所以收藏了好多的教程。后来男朋友去实习后跟我说公司里写需求文档都要求用MarkDown,他觉得我学一下很有必要,况且MarkDown使用也很广泛,我在看github上的项目的时候也经常看到大佬用.md的说明文档。
所以!!作为一名程序员,我要根据目前我常用的顺序记录下它的使用规则。
1. 当然是代码
- 代码块:
敲四个空格然后不用换行直接敲代码就可以出现代码块区,结尾也是不用换行直接再敲四个空格即可关闭代码区。
或用```+一个空格+代码所用语言(eg:html)(不必须写)+回车即可在代码区写代码,结尾在代码的末尾换行再用三个 ` 封锁代码区
例如:
<div class="test">
hello
</div>
- 行内代码:
用`在代码两端进行包裹即可产生。
例如<div></div>
2.标题
- 通过在标题文字前加#来设置标题级别。
一到六级标题分别对应一到六个#,一级标题最大。 - 或在标题文字的下一行用任意个=来标识一级标题,任意个-标识二级标题。
3.列表
用-或*或+加一个空格即可表示无序列表
例如:
- 示例
有序列表直接用数字加英文句点即可。
4.引用
引用以>来表示。引用中支持多级引用、标题、列表、代码块、分割线等常规语法。
例如:
示例引用
二级引用
5.强调
在文本两端加上两个标识加粗文本
文本两端加上一个标识斜体文本
文本两端加上两个~ 标识删除文本,eg:示例
6.图片和链接
!+[图片说明文字,可不写]+(图片url)
[链接说明文字,可不写]+(链接url)
这是行内式链接:[百度](http://www.baidu.com).
这是参考式链接:[百度][url],其中url为链接标记,可置于文中任意位置。
[url]: http://www.baidu.com
链接标记格式为:[链接标记文本]: 链接地址 链接title(可忽略)
这是自动链接:直接使用`<>`括起来<http://www.baidu.com>
显示为:
这是行内式链接:百度.
这是参考式链接:[百度][url],其中url为链接标记,可置于文中任意位置。
[url]: http://www.baidu.com
链接标记格式为:[链接标记文本]: 链接地址 链接title(可忽略)
这是自动链接:直接使用<>
括起来http://www.baidu.com
7.分隔线
在一行中用三个以上的*、-、_来建立一个分隔线,行内不能有其他东西。也可以在符号间插入空格。例如:
8.表格
表格对齐格式
- 居左::----
- 居中::----:或-----
- 居右:----:
例如:
|th1|th2|th3|
|:---|:---:|---:|
|居左|居中|居右|
|apple|tomato|orange|
|red|yellow|blue|
th1 | th2 | th3 |
---|---|---|
居左 | 居中 | 居右 |
apple | tomato | orange |
red | yellow | blue |