为什么要用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. vue多文件上传进度条 进度不更新问题

    转自 hhttp://www.cnblogs.com/muge10/p/6767493.html 感谢这位兄弟的文章,之前因为这个问题 ,我连续在sgmentflow上提问过多次,完全没人能回答.谢谢 ...

  2. 知识图谱+Recorder︱中文知识图谱API与工具、科研机构与算法框架

    目录 分为两个部分,笔者看到的知识图谱在商业领域的应用,外加看到的一些算法框架与研究机构. 文章目录 @ 一.知识图谱商业应用 01 唯品金融大数据 02 PlantData知识图谱数据智能平台 03 ...

  3. CSS代码命名惯例语义化的方法

    CSS代码的命名惯例一直是大家热门讨论的话题.今天暴风彬彬想通过分析一个流行三栏布局中的必要元素,来为大家讲解关于使用语义化方法替代结构化方法来命名CSS类的建议和指导. 您还可以参考彬Go的相关文章 ...

  4. Linux(Centos7)安装ngnix服务器

    Ngnix服务器是一款优秀的静态页服务器软件和反向代理服务器软件 目前,centos安装ngnix可以yum安装也可以下载安装,我们为了扩展方便,选择下载安装.yum一键安装没什么好说的. 一.安装编 ...

  5. jquery中on绑定click事件在苹果手机中不起作用

    写一个div当做了一个按钮来使用. <div class="button"> <div class="sure"> 确定 </di ...

  6. write -在一个文件描述符上执行写操作

    概述 #include <unistd.h> ssize_t write(int fd, const void *buf, size_t count); 描述 write 向文件描述符 f ...

  7. log4j.rootLogger

    log4j.rootLogger=INFO, FILE, CONSOLE log4j.rootLogger=TRACE, FILE, CONSOLE

  8. Redhat镜像-RHEL-官方镜像下载大全

    原网站内容链接:https://pan.baidu.com/s/12XYXh#list/path=%2F 已经存在自己的云盘上了

  9. GCRoots 对象

    GC Roots 虚拟机栈(栈帧中的本地变量表)中引用的对象 方法区中的类静态属性引用的对象 方法区中的常量引用的对象 原生方法栈(Native Method Stack)中 JNI 中引用的对象 可 ...

  10. Windows copy

    将一份或多份文件复制到另一个位置. COPY [/D] [/V] [/N] [/Y | /-Y] [/Z] [/L] [/A | /B ] source [/A | /B]     [+ source ...