MarkDown简介
1. 传统文档排版缺陷
1.1 统一习惯
传统文档编辑器(邮件、博客、word文档)关于排版都有自己特有的方式各不相同。如果采用MarkDown的方式来编写,以后我们只需要记住一种编写排版规则就可以完成所有基本的文档编写工作。
1.2 修改方便
传统文档修改起来比较麻烦,修改一处有可能影响整个文档的排版,而MarkDown采用排版和内容分离的方式,编写内容者之需要关注文档内容,不需要关注排版样式。
1.3 多人协作
将内容和排版分离,方便多人协作共同编写。
2. 团队统一文档输出
- 统一使用MarkDown编写文档、邮件输出格式,方便团队文档整理输出。
- 方便团队多人协作,编写大型文档。
3. MarkDown 编写语法
3.1 区块元素
3.1.1 段落和换行
- MarkDown编辑器可以自己进行段落格式化。
一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。
3.1.2 标题
- 标题使用的方式就是 “#” 我们最多可以使用6个 “#”,也就是6级标题。
- 标准的使用方式是文字前后加相同个数的 “#”,几个 “#” 代表第几级标题,但是后面的 “#” 可以省略,我们一般习惯采用该简洁方式。
示例代码:
## 这是 H2
### 这是 H3
## 这是 H2 ##
### 这是 H3 ##
效果图:
3.1.3 区块引用
- 使用 “>” 符号来控制,如果需要套引用就是用 “>>”,依次类推
示例代码:
> 下面让大家看下区块引用的效果。
> 自己回车可以自动连接引用。
>> 引用套引用,下面需要分行,才能分离样式。
>
>好像看不到效果。
效果图:
下面让大家看下区块引用的效果。
自己回车可以自动连接引用。引用套引用,下面需要分行,才能分离样式。
好像看不到效果。
3.1.4 列表
- 列表分有序列表和无序列表 。
- 有序列表
有序列表可以使用 “1. ” 依次排列。 - 无序列表
无序列表可以使用”+”、”*”、”-” 等符号,如果需要多层嵌套,使用tab键即可。
- 有序列表
示例代码:
- 第一行
- 第二行
- 第三行
* 第一行
* 第二行
效果图:
1. 第一行
2. 第二行
1. 第三行
* 第一行
* 第二行
3.1.5 代码区块
- MarkDown默认支持的两个 “`代码`” 符号中间填写代码但不支持高亮显示,在github扩展语法中中还可以使用 ““`c++“`” 指定语言,可以支持显示彩色字样代码。
示例代码:
“`c++
#include
#include <stdio.h>
int main(int argc, char** argv)
{
return 0;
}
3.1.6 分割线
- 使用 “—” 或者 “***” 都可以。
示例代码:
—
***
效果图:
3.2 区段元素
3.2.1 链接
- 链接分为“行内式”和“参考式”,”行内式”:[]中显示的是显示的字符,()中前面是链接地址,后面是鼠标放上去显示的提示标题:
示例:[百度](http://www.baidu.com “baidu”)
效果: 百度- “参考式”:其实就是我们可以统一定义地址变量,后续可以统一使用:
示例:
![]()
效果:Google 或者baidu.
3.2.2 图片
图片跟链接语法是差不多的,前面多一个 “!” 号,然后网址换成图片地址即可,也分为“行内式”和“参考式”
1. “行内式”,[]中显示的是显示的字符,()中前面是链接地址,后面是鼠标放上去显示的提示标题:
示例:

效果:
![]()
2. “参考式”:其实就是我们可以统一定义地址变量,后续可以统一使用:
示例:
[img1]: ./imgs/img1.bmp “测试图片”
![][img1]
效果:
3.2.3 强调
- 强调的快捷键是”ctrl+b“,即” **内容** “包含的字符。
- 斜体使用快捷键”斜体“,即” *内容* “包含的字符。
- 斜体加粗使用快捷键”斜体“,即” ***内容**\* “包含的字符。
示例代码:
**加粗**
*斜体*
***斜体加粗***
效果图:
加粗
斜体
斜体加粗
3.3 其它
3.3.1 反斜杠
这跟编写代码的时候使用转义字符一样。
3.3.2 自动链接
用尖括号包起来网址和电子邮箱等,可以自动转换成链接,其实github扩展语法不需要添加”<>”就自动识别了。
http://www.baidu.com
3.3.3 表格
示例代码:
序号 姓名 年龄 1 睢玉佩 27 2 你 1
效果图:
序号 | 姓名 | 年龄 |
---|---|---|
1 | 睢玉佩 | 27 |
2 | 你 | 1 |