为什么要用markdown写开发文档?
1.可以在git上在线预览,docx文档需要下载才能看见;
2. .md文档每次修改之后能被git管理,可追踪修改内容和修改人,但是docx不能追踪修改内容。
兼容HTML
1.在HTML区块内,写markdown的样式,是不生效的
但是markdown的语法是生效的
2.HTML中 '< ' 和 '& '需要特殊处理才能显示 "<" "&"
markdown中:
在代码范围内,markdown不会将特殊符号转换为"<" "&",
在文档范围内出现markdown自动会转换为"<" "&"
3.markdown中空行 或者 多个空格加回车 表示空行
4.markdown标题两种展现方式
一级标题
===========
二级标题
--------
#一级标题
##二级标题
5.markdown的区块引用 ">"
多个>代表层级关系,>可以给每句话强制性断行
6.markdown只支持有序列表和无序列表
无序列表用:* + - 作为列表标记
有序列表用:1. 数字加英文句点作为列表标记
7.markdown中建立代码区块,只要缩进4个空格或1个制表符,markdown会自动用<pre>和<code>标签把代码区块包起来。
代码区块内,markdown会将特殊的字符,"<" "" "&"转换成HTML实体。
8.分隔线
markdown可以在一行内用三个以上的 * - —
9.markdown中链接文字都是用[ ]来标记()紧跟网址链接
10.markdown使用“*”和“_”作为强调字词的符号。一个表示markdown会转换成<em>斜体,两个符号会转成<strong>.注意符号要成对出现
11.用反斜线“”使特殊符号不被markdown转义,直接展示出来
12.在行内展示一小句代码,用反引号包起来“``”
13.markdown插入图片格式(无法指定图片宽高)
![图片替代的文字](图片的路径)
14.一般网址用尖括号包起来 <http://example.com/>
markdown会将其转化为<a href="http://example.com/">http://example.com/</a>