A Simple Markdown Toturial

Posted 2020-10-31 gogo-go

转载自：https://github.com/younghz/Markdown
参考： http://wowubuntu.com/markdown/index.html#overview

1.Markdown 是什么？

Markdown 是一种轻量级标记语言, 以纯文本形式（易读、易写、易更改）编写文档，最终以html格式发布。Markdown可理解为将以Markdown语法编写的语言转换成HTML内容的工具。此外，Markdown 兼容 HTML，意味着可以用 HTML 语法编写。

2. 如何使用Markdown?

Markdown语法主要分为如下几大部分：标题，段落， 区块引用， 代码区块， 强调， 列表， 分割线， 链接， 图片， **反斜杠 **，以及符号 ` 等。

2.1 标题

两种形式：
1）使用 = 和 - 分别标记一级和二级标题。

一级标题
======

效果：

一级标题

二级标题
--------

效果：

二级标题

说明：标题内容与 ===== 或 ------- 之间没有空行。

2）使用 #，可表示1-6级标题。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果分别如下：

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

说明：# 需顶格。

2.2 段落

一个 Markdown 段落是由一个或多个连续的文本行组成，它的前后要有一个以上的空行（空行的定义是看起来像是空的，便会被视为空行。例如，若某一行只包含空格和制表符，则该行也会被视为空行）。由一个或多个连续的文本行组成这句话暗示了 Markdown 允许段落内的强迫换行（插入换行符），实现方式是使用两个以上空格加上回车。普通段落不该用空格或制表符来缩进。

2.3 区块引用

Markdown 标记区块引用是使用类似 email 中用 > 的引用方式， 在段落的每行或者只在第一行使用符号 >，还可使用多个嵌套引用，如：
> 区块引用
>> 嵌套引用

效果：

区块引用

嵌套引用

2.4 代码区块

代码区块的建立是通过在每行顶端加上4个空格或者一个制表符（正常代码基础上）。

普通段落：

void main()
{
printf("Hello, Markdown.");
}

代码区块：

void main()
{
    printf("Hello, Markdown.");
}

2.5 强调

在需要强调的内容的两侧分别加上 * 或者 _， 如：

*斜体*， _斜体_

效果：

斜体， 斜体

**粗体**，__粗体__

效果：

粗体，粗体

2.6 列表

Markdown 支持无序列表和有序列表。

无序列表使用 *、+、或者 - 作为列表标记

*(+、-) 第一项
*(+、-) 第二项
*(+、-) 第三项

效果：

• 第一项
• 第二项
• 第三项

有序列表的标记方式是将上述的符号换成数字，并辅以 .，如：
1 . 第一项
2 . 第二项
3 . 第三项

效果：

1 . 第一项
2 . 第二项
3 . 第三项

说明：以上效果加入了区块引用

2.7 分割线

分割线最常使用就是三个或以上 *，还可以使用 - 和 _。
效果如下：

---

2.8 链接

链接可以由两种形式生成：行内式和参考式。
两种模式链接文字都是用 [方括号] 来标记。
要建立一个行内式的链接，只要在方块括号后面紧接着圆括号并插入网址链接即可，如果你还想要加上链接的 title 文字，只要在网址后面，用双引号把 title 文字包起来即可.
行内式：
格式： [words](link) "title" (optional)
[wolf_li 的blog](https://i.cnblogs.com/EditPosts.aspx?postid=8876389) "Markdown"
效果：
wolf_li 的blog "Markdown"
参考式的链接是在链接文字的括号后面再接上另一个方括号，而在第二个方括号里面要填入用以辨识链接的标记：
参考式
格式： [words][id]

[wolf_li 的blog 1][1]
[wolf_li 的blog 2][2]
接着，在文件的任意处，你可以把这个标记的链接内容定义出来：
[id]:link "title" (optional)
[1]:https://i.cnblogs.com/EditPosts.aspx?postid=8876389 "Markdown1"
[2]:https://i.cnblogs.com/EditPosts.aspx?postid=8876389 "Markdown2"
效果：

wolf_li 的blog 1
wolf_li 的blog 2

2.9 图片

添加图片的形式和链接相似，只需在链接格式的前面加一个！。

2.10 反斜杠 \\

相当于反转义作用，使符号成为普通符号。

2.11 符号 `

起到标记作用。如：

`ctrl+a`

效果：

ctrl+a

其它：

列表的使用：

1. 第一行为表头，第二行分隔表头和主体部分，第三行开始每一行代表一个表格行；
2. 用|表示表格纵向边界，表头和表内容用-隔开；
3. 用:进行对齐设置，- 右边加:表示右对齐，两边都有:则表示居中，若不加:则默认左对齐。

示例：

代码库  | 链接
:-:|:-:
Makedown | https://i.cnblogs.com/EditPosts.aspx?postid=8876389
MakedownCopy | https://i.cnblogs.com/EditPosts.aspx?postid=8876389

效果：

代码库	链接
Makedown	https://i.cnblogs.com/EditPosts.aspx?postid=8876389
MakedownCopy	https://i.cnblogs.com/EditPosts.aspx?postid=8876389

实践：

掌握一个知识最好的办法是实践，如果没有合适的实践项目，可以实现上述内容。