Markdown使用指南

Posted on Edited on In

自用笔记：本文属于自用笔记，不做详解，仅供参考。在此记录自己已理解并开始遵循的前端代码规范。What How Why

Markdown使用指南

标题

1
2
3
4
5
6
7
8
9
10
11
12
Markdown语法：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
大标题
=
小标题
-

预览效果：

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

大标题
=
小标题
-

粗体、斜体

1
2
3
4
5
6
Markdown语法：

**粗体**
__粗体__
*斜体*
_斜体_

预览效果：

粗体
粗体
斜体
斜体

分割线

1
2
3
4
Markdown语法：
---
***
~~文字删除线~~

预览效果：

文字删除线

列表

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Markdown语法：

- 无序列表项目
- 无序列表项目
- 无序列表项目

* 无序列表项目
* 无序列表项目
* 无序列表项目

1. 有序列表项目
2. 有序列表项目
3. 有序列表项目

- 外层列表项目
 + 内层列表项目
 + 内层列表项目
 + 内层列表项目
- 外层列表项目

预览效果：

  • 无序列表项目
  • 无序列表项目
  • 无序列表项目
  • 无序列表项目
  • 无序列表项目
  • 无序列表项目
  1. 有序列表项目
  2. 有序列表项目
  3. 有序列表项目
  • 外层列表项目
    • 内层列表项目
    • 内层列表项目
    • 内层列表项目
  • 外层列表项目

添加超链接、图片

1
2
3
4
5
6
7
8
9
10
11
12
13
Markdown语法：

[简书](链接地址 "描述")
![简书slogan](https://raw.githubusercontent.com/luuman/luuman.github.io/master/resoures/luuman-ipad-iphone.jpg "描述")

[简书][1]
![简书slogan][2]

[1]:链接地址 "描述"
[2]:链接地址 "描述"

[无链接的链接][null-link]
[null-link]: chrome://not-a-link

效果预览：

简书

简书slogan

简书

简书slogan

[无链接的链接][null-link]
[null-link]: chrome://not-a-link

添加表格

1
2
3
4
5
6
7
8
9
10
11
12
13
Markdown语法：

| ABCD | EFGH | IJKL |
| -----|:----:| ----:|
| a    | b    | c    |
| d    | e    |  f   |
| g    | h    |   i  |

ABCD | EFGH | IGKL
-----|------|----
a    | b    | c
d    | e    | f
g    | h    | i

预览效果：

ABCDEFGHIJKL
abc
def
ghi
ABCDEFGHIGKL
abc
def
ghi

添加代码

1
2
3
4
5
6
Markdown语法：

`字符`（简短文字添加代码框）

`Tab`或
    四个空格（大段文字添加代码框，每行前添加）

预览效果：

字符（简短文字添加代码框）

Tab或
四个空格（大段文字添加代码框，每行前添加）

引用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Markdown语法：

> 引用的文字
> 引用的文字
> 引用的文字

---
> 引用的文字引用的文字引用的文字引用的文字引用的文字引用的文字引
用的文字引用的文字引用的文字引用的文字引用的文字引用的文字引用
的文字引用的文字引用的文字

---
> 引用的文字引用的文字引用的文字引用的文字引用的文字

---
 >> 引言内的引言引言内的引言引言内的引言

---
> 引用的文字引用的文字引用的文字引用的文字引用的文字

预览效果：

引用的文字
引用的文字
引用的文字

引用的文字引用的文字引用的文字引用的文字引用的文字引用的文字引
用的文字引用的文字引用的文字引用的文字引用的文字引用的文字引用
的文字引用的文字引用的文字

引用的文字引用的文字引用的文字引用的文字引用的文字

引言内的引言引言内的引言引言内的引言

引用的文字引用的文字引用的文字引用的文字引用的文字

单行长文字

1
2
3
4
5
Markdown语法：

在需要以单行长文字显示的文字两段各加三个`~`,即`~~~`

在需要以单行长文字显示的文字段落前加四个空格

预览显示：

1
单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字单行长文字

首行缩进

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Markdown语法：

 缩进一个字符缩进一个字符缩进一个字符缩进一个字符缩进一个字符缩进一个字符

 缩进两个字符缩进两个字符缩进两个字符缩进两个字符缩进两个字符缩进两个字符

  缩进四个字符缩进四个字符缩进四个字符缩进四个字符缩进四个字符缩进四个字符

预览效果：

 缩进一个字符缩进一个字符缩进一个字符缩进一个字符缩进一个字符缩进一个字符

 缩进两个字符缩进两个字符缩进两个字符缩进两个字符缩进两个字符缩进两个字符

  缩进四个字符缩进四个字符缩进四个字符缩进四个字符缩进四个字符缩进四个字符

添加脚注

1
2
3
Markdown语法：

![添加脚注](http://upload-images.jianshu.io/upload_images/1064727-49caf145bf6c2a97.png)添加脚注

预览效果：

A 1

创建链接

1
2
3
4
为输入的URL或邮箱自动创建链接，如test@domain.com。
Markdown语法：

<test@domain.com>

预览效果：

test@domain.com

转义字符

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
在特殊字符，如*、[、>等前面加\可使特殊格式字符转换为正常字符打出（有序列表符号如1.，须在. 前加\）。

Markdown语法：

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

预览效果：

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

小型文本

1
2
3
Markdown语法：

<small>文本内容</small>

预览效果：

文本内容

markdown代码语言

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Apache
Bash
CoffeeScript
C++
C#
CSS
Diff
HTTP
Ini
Java
JavaScript
JSON
Makefile
Markdown
Nginx
Objective-C
Perl
PHP
Python
Ruby
SQL
HTML, XML

参考资料：

在线编辑
gitbook

新手指南
Markdown入门学习小结
Markdown 简明教程
Markdown語法說明（繁體中文版）
Markdown 语法说明（简体中文版）
维基百科：Markdown词条

hexo你的博客
如何搭建一个独立博客——简明Github Pages与Hexo教程

简书：献给写作者的 Markdown 新手指南
Lawrence Li：为什么作家应该用 Markdown 保存自己的文稿
阳志平：「Markdown写作浅谈」
Casa Nova：為什麼文科生也該用markdown寫作?
Gnat：Markdown 简明教程
Gnat：Markdown 写作规范参考
Te_Lee：Markdown——入门指南
怀瑾握瑜：Markdown语法纪要
唐衣可俊：MarkDown使用小技巧
温谦：怎样使用Markdown
Leo Chin ：Markdown 11种基本语法
Equation 85：Markdown语法示例

Markdown 免费编辑器

在线编辑器
MaHua
Dillinger.io
Markable.in
marxi

浏览器插件
MaDe

Windows 平台
GitHub Atom
MarkdownPad
MarkPad

Linux 平台
ReText

Mac 平台
Mou

高级应用(Sublime Text 2 + MarkdownEditing 教程)
Sublime Text 2
MarkdownEditing
教程

1
2
3
4
5
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow

Cmd Markdown 简明语法手册