Person Cloud
0%

Markdown速成指南

发表于 更新于 分类于 阅读次数： 评论： 本文字数： 1.8k 阅读时长 ≈ 2 分钟

前言

本文旨在快速入门 Markdown，并在文末配置了速查表供复习使用，更详细的内容可参见该文档。

Markdown 简介

Markdown 是一种轻量级标记语言，可与 HTML（超文本标记语言） 混编，是适合于制作技术文档、做笔记及为网站创建内容的简便方法。

相较于纯 txt 文档，它多了标题、引用、链接甚至图片等功能；相较于 word 文档，它没有复杂的样式，简单的文本标记即可完成样式的排版。

  1. 专注于文字内容；
  2. 纯文本，易读易写，可以方便地纳入版本控制；
  3. 语法简单，没什么学习成本，能轻松在码字的同时做出美观大方的排版。

准备工作

.md 文档支持多种编辑器，笔者推荐使用 vscode 现代编辑器进行创作，加入 Markdown Preview Enhanced 插件后可实现预览、实时编辑及最重要的导出 HTML 与 PDF 等格式的功能。

除此以外，也可用在线 Markdown 编辑器对照本文档练习。

Markdown基本语法

标题语法

不同数量的 # 可完成不同的标题，1~6级标题样式如下： 

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

段落语法

在 Markdown 中有两种方法实现换行：

A. 插入空白行 

1
2
3
插入空白行

上面是空白行
B. 空两格加回车 
1
2
右边有两个空格  
回车

渲染结果如下：

插入空白行
上面是空白行

右边有两个空格
回车

列表语法

创建有序列表，请用数字序号加英文句点与空格的形式：

1
2
3
4
1. First
2. Second
    1. Indented 
    2. Indented

渲染结果如下：

  1. First
  2. Second
    1. Indented
    2. Indented

创建无序列表，请用-、+、*当中的一种书写：

1
2
3
4
5
6
7
8
9
10
- item_1
    - item_11
    - itme_12
- item_2

+ item_1
+ item_2

* item_1
* item_2

渲染结果如下：

  • item_1
    • item_11
    • itme_12
  • item_2
  • item_1
  • item_2
  • item_1
  • item_2

分隔线语法

创建分隔线，请在单独一行上用三个及以上星号 ***、破折号 --- 或下划线 ___，三种方法渲染得到的结果是一样的。 

1
2
3
4
5
---

***

____
渲染结果如下：

强调语法

在 Markdown 中根据 * 数量的不同衍生出斜体、粗体和粗斜体三种强调语法，以及由波浪号~~删除线~~包裹的删除线。

1
2
3
4
*这个是斜体*
**这个粗体**
***这个是粗斜体***
~~被删掉了~~

渲染结果如下：

这个是斜体
这个粗体
这个是粗斜体
被删掉了

引用语法

1. 引用文字

创建文字引用，请在段落前加 > 符号。 

1
2
3
4
5
6
7
8
9
> 单段引用

> 多个段落引用，需要加入一个空行
>
> 这是第二段

> 嵌套引用，根据'>'号数量决定
>> 嵌套引用
>>> 嵌套引用

渲染结果如下：

单行引用

多个段落引用，需要加入一个空行

这是第二段

嵌套引用，根据'>'号数量决定
嵌套引用
嵌套引用

2. 引用代码

标示单词或句子为代码时，请用反引号 () 包裹起来。

1
This is a `code`

渲染结果如下：
>This is a code

标示一整段代码时，在每行代码前缩进至少一个制表符表示代码块，除此以外，也可以用三个反引号 () 或波浪号包裹起来 

1
2
3
4
5
6
#include <stdio.h>
int main()
{
    ...
    return 0;
}
渲染结果如下：

#include <stdio.h>
int main()
{
...
return 0;
}

3. 引用链接

超链接 Markdown 语法代码为：[链接名](链接地址)

1
欢迎来到[我的首页](https://peronli.github.io/)

渲染结果如下：

欢迎来到我的首页

4. 引用图片

类似于超链接的语法，插入图片 Markdown 语法代码为：![图片名](图片地址)

1
![一张图片](/img/earth-blackbg.jpg)

渲染结果如下：

一张图片
一张图片

表格语法

转义字符语法

与大多数语言类似，Markdown 中在字符前接反斜杠 \ 可显示标记语言字符原本的格式，不需要特别记忆，只要知道发现不能正常使用某字符时加上反斜杠即可。

1
\!\`\()\[]\{}\+\-\*\#\.

渲染结果如下：
!`()[]{}+-*#.