目录

Markdown 完全指南

初识 Markdown

Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown 通过标记语法,使用预设的样式,简化我们的文字排版,使我们能够专心于创作内容。使用 Markdown,从内容到格式到配图,都可以使用键盘来控制。

现在,支持 Markdown 语法的编辑器越来越多,很多网站(如 简书)都加入了对 Markdown 的支持。你可以将 Markdown 导出为 PDF 等格式,还可以导出成 HTML 格式在网页上发布。Markdown 可扩展性很高,很多解释器都会支持 LaTex、流程图、时序图等功能。

Markdown 的这些特性造就它方便使用,易于修改与版本控制,能兼容绝大多数的编辑器与网站,可以让创作者不被花样的格式打断思路。

Markdown 官方文档

原版 Markdown 语法说明

Markdown 语法规则

标题

在 Markdown 中,表示文章标题,只需要在文字前面加上 # 即可。Markdown 支持六级标题。

示例:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

水平线

如果需要在文章中加入水平分割线,可以在空行中输入三个或三个以上的 - 或者 *

示例:

***
水平分割线可以将你的内容分开。
---
水平分割线可以很明确的分开你的章节。
* * *
但是不要用太多水平分割线,使你的内容不连续。
-----

效果:


水平分割线可以将你的内容分开。


水平分割线可以很明确的分开你的章节。


但是不要用太多水平分割线,使你的内容不连续。


强调

  • 加粗
    将需要加粗的文字用两个 * 包含起来。

  • 斜体
    将需要倾斜的文字用一个 * 包含起来。

  • 斜体加粗
    将需要斜体加粗的文字用三个 * 包含起来。

  • 删除线
    将需要加删除线的文字用两个 ~ 包含起来。

示例:

一段文字里面可能需要**加粗**、*斜体*、***斜体加粗***、~~删除线~~等文字格式。

效果:

一段文字里面可能需要加粗斜体斜体加粗删除线等文字格式。

引用

如果你需要引用别人的话,那么你可以在你引用的文字前面加上 > 即可。

示例:

> 这是引用的其他人的话。
>> 引用也可以嵌套。

效果:

这是引用的其他人的话。

引用也可以嵌套。

列表

  • 无序列表
    在列表项前加上 *-+ 其中的任意一种即可。

  • 有序列表
    在列表项前加上 1. 2. 3. …… 即可。

示例:

* 这是一个无序列表的例子
* 银河系
    - 太阳系
        + 地球
        + 火星
        + ……
    - ……
* ……

1. 这是一个有序列表的例子
2. 需求分析
3. 软件建模设计
    * 软件概要设计
    * 软件详细设计
    * 数据库设计
4. 编写程序
5. ……

效果:

  • 这是一个无序列表的例子
  • 银河系
    • 太阳系
      • 地球
      • 火星
      • ……
    • ……
  • ……
  1. 这是一个有序列表的例子
  2. 需求分析
  3. 软件建模设计
    • 软件概要设计
    • 软件详细设计
    • 数据库设计
  4. 编写程序
  5. ……

表格

在 Markdown 中插入表格,比较复杂,如以下示例:

| 编号 | 品名  | 单价 |
| ---- | :---: | ---: |
| 1    | 西瓜  |   30 |
| 2    | 桃子  |    5 |
| 3    | 橘子  |    8 |

每列之间通过 | 分开,表头和内容通过第二行的分割线分开。第二行中,- 至少有一个,- 两边的 : 表示表格对其方式,两边都有表示该列为「居中」对齐,只在右边表示「靠右」对齐。

效果:

编号 品名 单价
1 西瓜 30
2 桃子 5
3 橘子 8

代码

  • 行内代码
    行内代码是指在包含在一句话内的代码,将代码用一个 ` 包含即可。

  • 行间代码
    行间代码是指在两行之间的代码块,将代码块用独占一行的 ``` 包含即可。

示例:

你可能会遇到 `**行内代码**`;或者代码块的情况。

```
这是一个代码块,无论是行内代码或者行间代码,其内容或格式都不会被改变。
如果代码中也存在「`」,那么需要使用「``」或者「````」来表示代码内容。
```

效果:

你可能会遇到 **行内代码**;或者代码块的情况。

这是一个代码块,无论是行内代码或者行间代码,其内容或格式都不会被改变。
如果代码中也存在「`」,那么需要使用「``」或者「````」来表示代码内容。

链接

当你需要在文章中插入网页链接时,只需要使用 [website](URL/to/website) 就可以插入链接文字。其中 [] 中是链接显示文字,() 中是网站链接。

像 Email 之类的链接可以采取直接链接 <email or URL>。其中 <> 中为 Email 地址或者链接地址。

示例:

点击 [这里](https://blog.samchu.cn/) 回到我博客首页。
我的电子邮箱:<samchu-social@outlook.com>

效果:

点击 这里 回到我博客首页。
我的电子邮箱:samchu-social@outlook.com

图片

当你需要在文章中插入图片时,只需要使用 ![picture annotation](URL/to/picture "picture title") 就可以插入图片。其中 [] 中是图片下方的注解,可以省略,() 中是图片链接,"" 中是图片标题,当鼠标指向图片时会显示图片标题,可以省略。

示例:

![This is the icon of my blog](https://static.samchu.cn/image/favicon/favicon_256x256.png "favicon")

效果:

https://static.samchu.cn/image/favicon/favicon_256x256.png
favicon

写在最后

Markdown 语言是一种易于掌握,便于利用的语言。其独特之处就是能够帮助创作者排除文字格式的干扰,专心创作。这篇文章就是用 Markdown 写出来的。Markdown 的语法很简单,标记符号只有十多个,相对于 HTML 语言来说,Markdown 可以说是很轻量化,学习门槛很低。学会了这门语言,对以后的工作学习生活有一劳永逸的作用。

We believe that writing is about content, about what you want to say – not about fancy formatting.
我们坚信写作写的是内容,所思所想,而不是花样格式
— Ulysses for Mac