为什么要用markdown写开发文档?

1.可以在git上在线预览,docx文档需要下载才能看见;

2. .md文档每次修改之后能被git管理,可追踪修改内容和修改人,但是docx不能追踪修改内容。

兼容HTML

1.在HTML区块内,写markdown的样式,是不生效的
但是markdown的语法是生效的

2.HTML中 '< ' 和 '& '需要特殊处理才能显示 "&lt;" "&amp;"
markdown中:
在代码范围内,markdown不会将特殊符号转换为"&lt;" "&amp;",
在文档范围内出现markdown自动会转换为"&lt;" "&amp;"

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>

markdown常用知识点的更多相关文章

  1. DB2_SQL_常用知识点&实践

    DB2_SQL_常用知识点&实践 一.删除表中的数据(delete或truncate) 1 truncate table T_USER immediate; 说明:Truncate是一个能够快 ...

  2. JAVA常用知识点及面试题总结

    1. String.StringBuffer.StringBuilder三者区别? (1)三者在执行速率上的比较: String<StringBuffer<StringBuilder 原因 ...

  3. HTML常用知识点代码演示

    1 HTML部分常用知识点 <!-- 版本声明 --> <!DOCTYPE html> <!-- 唯一根元素 --> <html> <!-- 对网 ...

  4. Java 常用知识点

    Java 常用知识点 1.日期格式化 SimpleDateFormat Date date=new Date(System.currentTimeMillis()) ; SimpleDateForma ...

  5. Less常用知识点

    上篇文章介绍了如何安装Less,我们将所有东西都写在.less里面,最后通过命令将.less转换成.css文件,就可以放入到项目里用了.今天了解一些less常用知识点. 1.变量:声明两个变量,一个是 ...

  6. BIOS备忘录之EC常用知识点

    BIOS工程师眼中常用的EC知识点汇总: EC的硬件架构 EC硬件结构上主要分为两部分:Host Domain和EC Domain Host Domain就是通过LPC与CPU通信的部分(LPC部分需 ...

  7. MarkDown常用语法表

    MarkDown常用语法表 本文提供全流程,中文翻译.Chinar坚持将简单的生活方式,带给世人!(拥有更好的阅读体验 -- 高分辨率用户请根据需求调整网页缩放比例) 1 Title - 标题 2 H ...

  8. YII2常用知识点总结

    YII2常用知识点总结 (一)总结性语句 (1)经常看看yii源码比如vendor\yiisoft\yii2\web这个目录(很重要)下的文件中的方法(这些文件中的公共方法,大致看了下基本上都可以通过 ...

  9. Markdown常用语法学习

    Markdown常用语法学习,这些就够用了. 演示地址: https://github.com/YalongYan/Markdown-- 特别提示:  标题'##'后面必须加一个空格,否则编译不对.# ...

随机推荐

  1. Java & 架构硬核福利,速度上车!

    极客时间福利时间! 最近,栈长每周都会给大家带来极客时间的专栏拼团优惠,给错过优惠的朋友一个再次优惠上车的机会. <从0开始学架构>和<Java核心技术36讲>,这两个专栏很火 ...

  2. axios 基本运用

    axios是专门对ajax请求进行封装的一个插件,其返回一个promise对象,用法跟ES6的promise很相似 一.安装axios插件npm install axios 二.引入axios插件 在 ...

  3. PHP魔方解密

    安装composer参考:https://www.runoob.com/w3cnote/composer-install-and-usage.html 常用的加密类型及特征 加密类型 加密特征 Zen ...

  4. The linux command 之 扩展

    echo * " * "字符意味着匹配文件名中的任意字符,shell会在执行echo命令之前把*扩展成其他内容. 一.路径扩展(pathname Expansion) 通过使用通配 ...

  5. python: 函数递归与尾递归

    如果一个函数在内部调用自己,那么这个函数就是递归函数. 例如一个阶乘函数:fact(n)=n! ,其实可以写成 fact(n)=n x fact(n-1). fact(n) 以递归的方式可以表示为: ...

  6. [JZOJ3339]【NOI2013模拟】wyl8899和法法塔的游戏

    题目 题目大意 给你一个数列,每次给出\(r,a,b\),你要找到\(l\in [a,b]\)使得\([l,r-1]\)的异或和最小, 并且要修改\(r\)位置的数. 思考历程 当我看到这题的时候,已 ...

  7. 线性dp,后缀处理——cf1016C好题

    绝对是好题 #include<bits/stdc++.h> using namespace std; #define maxn 300005 #define ll long long ll ...

  8. docker删除未使用到的镜像

    docker image prune -a docker image prune -a -f  #-f强制,不需要确认

  9. win7下mysql5.5与mysql5.6同时安装

    5.5己正常的情况下,用官方下载的安装包总是不成功,用的官方解压版5.6.44 1.复制my-default.ini到my.ini,只需要改端口就行了,设置base-dir/data-dir反而无法启 ...

  10. vue中export和export default的使用

    1 export的使用 比喻index.js要使用test.js中的数据 首先在test.js文件中进行导出操作 在index.js文件进行导入操作 第一种方法: 此时的输出结果是: 注意: expo ...