Markdown语法使用手册

30分钟掌握Markdown轻量标记语言

Posted by LZP[原创] on August 4, 2018

常用语法


标题

这是 H1 一级标题
======
这是 H2 二级标题
------
# 这是 H1 一级标题
## 这是 H2 二级标题
### 这是 H3 三级标题
#### 这是 H4 四级标题
##### 这是 H5 五级标题
###### 这是 H6 六级标题

列表

无序列表

* 项目1
  * 子项目1.1
  * 子项目1.2
    * 子项目1.2.1
* 项目2
* 项目3

+ 项目1
  + 子项目1.1
  + 子项目1.2
    + 子项目1.2.1
+ 项目2
+ 项目3

- 项目1
  - 子项目1.1
  - 子项目1.2
    - 子项目1.2.1
- 项目2
- 项目3

有序列表

1. 项目1
2. 项目2
3. 项目3
    1. 项目3.1
    2. 项目3.2

1. 项目1
1. 项目2
1. 项目3
    1. 项目3.1
    1. 项目3.2

有序列表起始编号

58. 项目5
2. 项目6

快捷键: [ctrl + o]

链接

[链接名称](链接地址)
[链接名称][1]
[1] : 链接地址

图片

![名称](链接地址)
![名称][1]
[1] : 链接地址

文字格式

**这是文字粗体格式**

__这是文字粗体格式__

*这是文字斜体格式*

_这是文字斜体格式_

引用

> 第一行引用文字
> 第二行引用文字

水平线

***

GFM扩展语法


表格

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

增强型表格

|First Header  | Second Header ||
|First Header  | Second Header | Third Header|
|------------- | -------------|-------------|
表身1Content Cell  | Merge Content Cell||
Content Cell  | Content Cell| Content Cell|

表身2Content Cell  | Merge Content Cell||
Content Cell  | Content Cell| Content Cell|
[表格标题]

代码

行内代码

`var x = "hello world"`

块代码

```javascript
var a = "hello world";
var b = "good luck";
```

自动转换成超链接

系统将自动根据内容,将地址转换成超链接格式

http://markdown.xiaoshujiang.com

HTML

<div class="hey">Hello world</div>

支持的html标签

删除线

~~在文字上添加删除线~~

扩展语法


目录

[toc]

扩展的文字格式

++插入的文字++

==被记号的文字==

上角文字: 19^th^

下角文字: H~2~O

印刷字替换

系统将自动替换下列文字,转换成排版系统使用的符号

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

缩写定义

The HTML specification
is maintained by the W3C.
*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium

待办事项

- [ ] 未完成事项
- [ ] 未完成事项
- [x] 完成事项
- [X] 完成事项

脚注

脚注[^1x]
[^1x]: 脚注的用法

定义

苹果
: 一种水果
: 一种品牌,计算机,手持设备
桔子
: 一种水果

公式

行内公式

这是行内公式`!$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. $`

块公式

```mathjax!
$$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.$$
```

流程图 (语法)

```flow
st=>start: 开始
e=>end: 结束
op=>operation: 操作步骤
cond=>condition: 是 或者 否?

st->op->cond
cond(yes)->e
cond(no)->op
```

序列图 (语法)

```sequence
小明->小李: 你好 小李, 最近怎么样?
Note right of 小李: 小李想了想
小李-->小明: 还是老样子
```

示例


[toc]

这是 H1 一s级标题

这是 H2 二级标题

这是 H3 三级标题

这是 H4 四级标题

这是 H5 五级标题
这是 H6 六级标题

待办事项

  • 未完成事项
  • 完成事项
  • 完成事项

缩写定义

The HTML specification is maintained by the W3C.

印刷字替换

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

html代码

html代码

流程图 (语法)

st=>start: 开始
e=>end: 结束
op=>operation: 操作步骤
cond=>condition: 是 或者 否?

st->op->cond
cond(yes)->e
cond(no)->op

序列图 (语法)

小明->小李: 你好 小李, 最近怎么样?
Note right of 小李: 小李想了想
小李-->小明: 还是老样子

脚注1

表格Tables

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

定义

苹果
一种水果
一种品牌,计算机,手持设备
桔子
一种水果

文字格式

这是文字粗体格式

这是文字粗体格式

这是文字斜体格式

这是文字斜体格式

在文字上添加删除线

++插入的文字++

==被记号的文字==

上角文字: 19^th^

下角文字: H~2~O

无序列表

  • 项目1
    • 子项目1.1
    • 子项目1.2
      • 子项目1.2.1
  • 项目2
  • 项目3

有序列表

  1. 项目1
  2. 项目2
  3. 项目3
    1. 项目3.1
    2. 项目3.2

有序列表起始编号

  1. 项目5
  2. 项目6

图片

图片名称 链接

链接名称

引用

第一行引用文字 第二行引用文字

水平线


代码

行内代码

var x = "hello world"

块代码

/**
 * @author John Smith <john.smith@example.com>
 * @version 1.0
*/
package l2f.gameserver.model;

import >>++java.util.ArrayList++<<;

>>~~public abstract class L2Character {~~<<
>>++public abstract class L2Character extends L2Object {++<<
  public static final Short ABNORMAL_EFFECT_BLEEDING = 0x0_0_0_1; // not sure

  public void moveTo(int x, int y, int z) {
    _ai = null;
    _log.warning("Should not be called");
    if (1 > 5) {
      return;
    }
  }

  /** Task of AI notification */
  @SuppressWarnings( { "nls", "unqualified-field-access", "boxing" })
  >>==public class NotifyAITask implements Runnable {
    private final CtrlEvent _evt;

    List<String> mList==<< = new ArrayList<String>()

    public void run() {
      try {
        getAI().notifyEvent(_evt, _evt.class, null);
      } catch (Throwable t) {
        t.printStackTrace();
      }
    }
  }
}

公式

行内公式

这是行内公式$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. $

块公式

mermaid流程图,序列图,甘特图

流程图

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

序列图

sequenceDiagram
A->> B: Query
B->> C: Forward query
Note right of C: Thinking...
C->> B: Response
B->> A: Forward response

甘特图

gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality 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
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

emoji表情语法

Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:

Shortcuts (emoticons): :-) :-( 8-) ;)

emoji表情清单:《Emoji cheat sheet for GitHub, Basecamp and other services》

  1. 脚注的用法