【云+社区年度征文】markdown使用手册

发布于

导读

  • 都2020年尾声了，markdown已经成为程序员的主要文档书写工具，如果你还不会用，我总结了一个markdown的使用手册，希望能帮你快速学习和掌握。

1. markdown和word比较

比较

优点

缺点

markdwon

写作效率高。2.自动排版。3.方便阅读。

1.排版功能没有word强。2.放置图片比较繁琐。3.需要学习语法。

word

1.功能强大。

1.写作效率低。2.排版操作复杂。3.必须要有word软件支持。

2. markdown的语法

2.1. 分级标题

语法：n个#表示n级标题，n最大为6。

代码语言：txt
复制
# 一级标签
## 二级标签
...
###### 六级标签

语法：标题后换行输入 = 表示一级标题，-表示二级标题。（不常用）

代码语言：txt
复制
一级标签
=
二级标签
-

2.2. 列表

2.2.1. 有序列表

语法：有序列表使用数字接着一个英文句点。

代码语言：txt
复制
1. a
    1. aa
    ...
2. b

2.2.2. 无序列表

语法：无序列表是使用,+,-中任意一种来表示。

代码语言：txt
复制
- a
    - aa
        - aaa
        ...
+ b
* c

2.3. 引用

2.3.1. 简单引用

语法：使用 > 来表示引用。

代码语言：txt
复制
> a

2.3.2. 嵌套引用

语法：使用 >> 来表示嵌套引用。一般结合简单引用一起使用。

代码语言：txt
复制
> a
>> aa
>>> aaa
...

2.4. 字体

2.4.1. 粗体

语法：用两个 * 包含一段文本就是粗体的语法。符号与文本之间无需空格。

代码语言：txt
复制
**粗体**

2.4.2. 斜体

语法：用一个 * 包含一段文本就是斜体的语法。符号与文本之间无需空格。

代码语言：txt
复制
*斜体*

2.5. 链接

2.5.1 图片链接

语法：插入图片只需要使用 undefined(图片链接地址)即可。

代码语言：txt
复制
![百度logo](https://ss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/logo/bd_logo1_31bdc765.png)

2.5.2 地址链接

语法：插入地址链接只需要使用 显示文本 即可。

代码语言：txt
复制
[百度](https://www.baidu.com)

2.6. 分割线

语法：另起一行，连续输入三个星号 *** 即可分割两段文字内容。

代码语言：txt
复制
第一段
***
第二段

2.7. 表格

语法：

代码语言：txt
复制
 head1 | head2
 - | -
 body1 | body2
 body3 | body4

2.8. 代码高亮

语法：

代码语言：txt
复制
     public class A{}

2.9. 待办事项

语法：- x 表示已完成， 表示待办。

代码语言：txt
复制
 - [x] 完成
 - [ ] 待办

2.10. 画图

2.10.1. 流程图

语法：中括号代表方形块。大括号代表菱形块。-->代表指向。

代码语言：txt
复制
    graph TD
        A[苹果] 
        B[香蕉]
        C{吃}
        A-->B
        B-->C

3. markdown转义

字符

转义字符

名称

\

\\

反斜杠

`

\`

反引号

*

\*

星号

_

\_

下划线

{}

\{\}

大括号

[]

\[\]

中括号

()

\(\)

小括号

#

\#

井号

+

\ +

加号

-

\-

减号

.

\.

英文句号

!

\!

感叹号

#markdown