Markdown语法手册

Blog

Markdown 简明语法手册

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。

Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

1.Markdown 标题

Markdown 标题有两种格式。

1
2
3
4
5
6
我展示的是一级标题
=================

我展示的是二级标题
-----------------

使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

2.段落和斜体和粗体

Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。
当然也可以在段落后面使用一个空行来表示重新开始一个段落。

2.1斜体和粗体

使用 * 和 ** 表示斜体和粗体。

1
2
3
4
5
6
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

2.2删除线和下划线

1
2
3
~~BAIDU.COM~~
<u>带下划线文本</u>

[^RUNOOB]: 菜鸟教程 – 学的不仅是技术，更是梦想

3.列表

3.1无序列表

使用 * ，+ ，- 表示无序列表。

1
2
3
4
- 无序列表项 一
- 无序列表项 二
- 无序列表项 三

示例：

  • 无序列表项 一
  • 无序列表项 二
  • 无序列表项 三

3.2有序列表

使用数字和点表示有序列表。

1
2
3
4
1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三

示例：

  1. 有序列表项 一
  2. 有序列表项 二
  3. 有序列表项 三

3.3列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可：

  1. 第一项：
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项：
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

4.引用的区块

文字引用

使用 > 表示文字引用。

示例：

野火烧不尽，春风吹又生。

区块的以嵌套

最外层

第一层嵌套

第二层嵌套

区块中使用列表

区块中使用列表

  1. 第一项
  2. 第二项
  • 第一项
  • 第二项
  • 第三项

列表中使用区块

  • 第一项

    菜鸟教程
    学的不仅是技术更是梦想

  • 第二项

5.外链接和图片

使用 [描述](链接地址) 为文字增加外链接。

示例：

这是去往 本人博客 的链接。

5.1插入图像

使用 ![描述](图片链接地址) 插入图像。

示例：

1
![我的头像](https://www.zybuluo.com/static/img/my_head.jpg)

5.2高级链接

1
2
3
4
5
6
这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值（网址）

[1]: http://www.google.com/
[runoob]: http://www.runoob.com/

6.代码

6.1行内代码块

使用 `代码` 表示行内代码块。

示例：

让我们聊聊 html。

6.2代码块

使用 四个缩进空格 表示代码块。

示例：

这是一个代码块，此行左侧有四个不可见的空格。

6.3代码实例

1
2
3
4
5
```javascript
$(document).ready(function () {
    alert('RUNOOB');
});

Cmd Markdown 高阶语法手册

1. 内容目录

在段落中填写 [TOC] 以显示全文内容的目录结构。

[TOC]

2. 标签分类

在编辑区任意行的列首位置输入以下代码给文稿标签：

标签： 数学 英语 Markdown

或者

Tags： 数学 英语 Markdown

3. 注脚

使用 [^keyword] 表示注脚。

这是一个注脚[^footnote]的样例。

这是第二个注脚[^footnote2]的样例。

4. LaTeX 公式

$ 表示行内公式：

质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。

$$ 表示整行公式：

$$\sum_{i=1}^n a_i=0$$

$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$

$$\sum^{j-1}{k=0}{\widehat{\gamma}{kj} z_k}$$

访问 MathJax 参考更多使用方法。

5. 加强的代码块

支持四十一种编程语言的语法高亮的显示，行号显示。

非代码示例：

1
$ sudo apt-get install vim-gnome

Python 示例：

1
2
3
4
5
6
7
8
9
10
11
12
@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None

class SomeClass:
    pass

>>> message = '''interpreter
... prompt'''

JavaScript 示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
* nth element in the fibonacci series.
* @param n >= 0
* @return the nth element, >= 0.
*/
function fib(n) {
  var a = 1, b = 1;
  var tmp;
  while (--n >= 0) {
    tmp = a;
    a += b;
    b = tmp;
  }
  return a;
}

document.write(fib(10));

6. 表格支持

项目 价格 数量
计算机 $1600 5
手机 $12 12
管线 $1 234

7. 定义型列表

名词 1
定义 1（左侧有一个可见的冒号和四个不可见的空格）
代码块 2
这是代码块的定义（左侧有一个可见的冒号和四个不可见的空格）
    代码块（左侧有八个不可见的空格）

8. Html 标签

本站支持在 Markdown 语法中嵌套 Html 标签，譬如，你可以用 Html 写一个纵跨两行的表格：

<table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>
值班人员 星期一 星期二 星期三
李强 张明 王平

9. 内嵌图标

本站的图标系统对外开放，在文档中输入

<i class="icon-weibo"></i>

即显示微博的图标：

替换 上述 i 标签 内的 icon-weibo 以显示不同的图标，例如：

<i class="icon-renren"></i>

即显示人人的图标：

更多的图标和玩法可以参看 font-awesome 官方网站。

10.甘特图

1
2
3
4
5
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
1
2
3
4
5
6
7
8
9
10
11
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail...
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
1
2
3
4
5
6
7
8
9
gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
gitGraph:
options
{
    "nodeSpacing": 150,
    "nodeRadius": 10
}
end
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch

甘特图、Mermaid 流程图、序列图Mermaid 序列图、待办事宜 Todo 列表

这些还没用到，就安装这些插件。