Markdown 基本语法

简介

• Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
• Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
• Markdown 编写的文档后缀为 .md, .markdown。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、reddit、知乎等。

本文使用 Typora 编写，它支持 MacOS 、Windows、Linux 平台，且包含多种主题，编辑后直接渲染出效果。支持导出 HTML、PDF、Word、图片等多种类型文件。

Tips：本文 markdown 语法在简书渲染有一些问题。可以下载 markdown 编辑器或在线编辑器进行学习。

以下内容参考 Markdown Guide 进行整理。

标题

# h1
## h2
### h3
#### h4
##### h5
###### h6

Header 1
========

Header 2
--------

效果：

标题

为了不影响排版，这里使用图片。

强调

*italic*
_italic_
**bold**
__bold__
`code`

效果：

italic
italic
bold
bold
code

列表

无序列表使用星号（*****）、加号（+）或是减号（-）作为列表标记

* Item 1
* Item 2

+ Item 1
+ Item 2

- Item 1
- Item 2

效果：

• Item 1
• Item 2

• Item 1
• Item 2

• Item 1
• Item 2

有序列表使用数字并加上 . 号来表示

1. Item 1
2. Item 2

效果：

1. Item 1
2. Item 2

列表嵌套

- Item 1
  - Item 1

效果：

• Item 1
  • Item 1

待办事宜 Todo 列表

- [ ] Update the website
- [x] Write the press release

效果：

任务列表

这里在简书的渲染效果有问题，直接贴图片

链接

链接使用方法如下：

[Link name](path)

效果：

link

https://www.jianshu.com/u/3f644e66afa3

添加标题

[Link name](https://www.jianshu.com/u/3f644e66afa3 "title")

鼠标悬停链接上，查看效果：

我的简书

其他操作

通过变量来设置一个链接，变量赋值在文档末尾进行：

[lio][blog]
[blog]: https://www.jianshu.com/u/3f644e66afa3

效果：

通过变量来设置一个链接

简书编辑器所呈现的效果跟 typora 不一样，这里直接贴图片

图片

![Image alt text](/path/to/img.jpg)

显示图片

添加标题

![Image alt text](img.jpg "title")

添加标题

直接使用 标签

代码

使用 ``` 包裹一段代码，并指定一种语言（也可以不指定）

代码

效果：

code fences

console.log('代码块')

区块引用

Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号

> 这是一个区块引用

效果：

这是一个区块引用

另外区块是可以嵌套的，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推

> 最外层
> > 第一层嵌套

效果：

最外层

第一层嵌套

分割线

使用三个以上的星号、减号、底线生成一个分隔线

----

****

___

效果：

删除线

使用两个波浪线 ~~ 来添加删除线

~~该内容已不再最新版本中使用~~

效果：

该内容已不再最新版本中使用

下划线

带下划线文本

效果：

带下划线文本

脚注

脚注是对文本的补充说明。

一段文字[^info]

效果：

脚注

内容目录

[TOC]

内容目录

这里在简书的渲染效果有问题，直接贴图片

表格

Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

| Column 1 Heading | Column 2 Heading |
| ---------------- | ---------------- |
| Some content     | Other content    |

Column 1 Heading | Column 2 Heading
--- | ---
Some content | Other content

效果：

对齐方式：

• -: 设置内容和标题栏居右对齐。
• :- 设置内容和标题栏居左对齐。
• :-: 设置内容和标题栏居中对齐。

| Column 1 Heading | Column 2 Heading | Column 2 Heading |
| :---------------- | :----------------: | ----------------: |
| Some content     | Other content    | Other content |

效果：

使用表情符号短代码🌐

使用开始和结束与冒号 :，并包括表情符号的名称。

Gone camping! :tent: Be back soon.

That is so funny! :joy:

效果：

Gone camping! ⛺️ Be back soon.

That is so funny! 😂

你可以在下面这些网站上找到所有可用的 Emoji：

• emojipedia
• gist:7360908
• markdown-it-emoji

更多资料

Typora 画流程图、时序图(顺序图)、甘特图 来自菜鸟教程的 Markdown 高级技巧中的一篇笔记

本文首发 blog，如果喜欢或者有所启发，欢迎 Star，对作者也是一种鼓励。