概述

Markdown是一种标记语言，Markdown语法目标是：成为一种适用于网络的书写语言。

特点

Markdown的目标是：易读易写。

  • 纯文本，所以兼容性极强，可以用所有文本编辑器打开。
  • 让你专注于文字而不是排版。
  • 格式转换方便，Markdown 的文本你可以轻松转换为 html、PDF等。
  • Markdown 的标记语法有极好的可读性。

github、Stackoverflow、简书等网站均支持这种格式。

区块元素

段落和换行

  1. 段落的前后必须有空行：
    空行指的是行内什么都没有，或者只有空白符。
  2. 如果需要在段落内加入换行：
    可以在一行的末尾加入至少两个空格
    然后换行写其它的文字。

标题

# 标题1 #
## 标题2 ##
### 标题3 ###
#### 标题4 ####
##### 标题5 #####
###### 标题6 ######

在行首插入1到6个 **#**，后面跟标题名字。后面的 **#**可写也可以不写。

区块引用

在行首以 **>**加一个空格开始，后面跟需要引用的文字。

这是一个引用区块

引用可以嵌套，多加一个>就可以了。

列表

Markdown 支持无序和有序列表。

无序列表使用 ***、+、-**行首加一个空格开始：

  • mouse
  • cat
  • dog
  • pig
  • sheep
  • cattle
  • tiger
  • lion
  • Cheetah

有序的列表行首以数字加**.**再加一个空格开始：

  1. Bird
  2. eagle

代码块

在Markdown中建立代码块非常简单，只需要以4个空格或一个制表符（tab）开头就可以了。

1
2
3
4
5
6
7
import json
data = {
	'name': 'fynn'
	'age': 27
}
json_str = json.dumps(data)
print json_str

你也可以使用三个连续的反引号将代码括起来。

1
2
3
4
with open('data.json', 'w') as f: 
json.dump(data, f)
with open('data.json', 'r') as f:
data = json.load(f)

表格

Markdown中创建表格也很简单

单元格和表头

使用|来分隔单元格，使用-来分隔表头和其它行。

1
2
3
| name | age |
| -----| ----|
| small mouse | 1 |
name age
small mouse 1

对其

在表头下方的分隔线标记加入:,可以确定单元格内容对其方式。

  • :— 左对齐
  • :–: 居中对齐
  • —: 右对齐
1
2
3
4
|    left    |    center    |    right    |
| :------  | :--------- : | --------: |
| 左边     | 中间           | 右边       |
| 左边     | 中间           | 右边       |
left center right
左边左边左边左边 中间中间中间中间 右边右边右边右边
左边 中间 右边

分隔线

你可以使用一行三个以上星号（*）、减号（-）、底线（_）来创建一个分割线。

1
2
3
***
---
___

区段元素

链接

Markdown链接格式：[链接名称](url title)。

baidu

简写链接直接将链接用<>包起来。
http://www.baidu.com
注意： title是可选的如果有必须用双引号括起来。

图片

Markdown链接格式：[图片名称](url title)。

superman

强调

Markdown 使用星号（*）和底线（_）作为强调内容的符号。

使用*和_包裹的内容会是倾斜，使用**和__包裹的内容是字体加粗。

superman 超人

代码

一小段代码，可以使用反引号把它包起来（`）。

data = json.load(json_str)

其它

反斜杠

一些符号在Markdown中有特殊含义，在文本如果需要使用它们可以利用反斜杠来插入。

*我需要显示星号*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：

1
2
3
4
5
6
7
8
9
10
11
12
\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

编辑器

Window 平台

Linux 平台

Mac 平台

在线编辑器

Chrome插件