1 Introduction

Markdown is easy mark language, created by John Gruber(US) in 2004.

Featrue :

Easy and concision
HTML compatible
Chart and formula support
Can be export as HTML, doc, PDF etc

Tips : markdown document end with .md or .markdown.

2 Title

Start with # in a line, as below (1~6 level support) :

# Level 1
## Level 2
### Level 3
#### Level 4
##### Level 5
###### Level 6

3 Paragraph

3.1 Line break

Add two space and a CR at the tail position or add a blank line before the newline.

3.2 Font

Add one * or _ at both ends of text to make the italic style, and two pair is for bold sytle and three for italic-bold style, as below :

*Italic style 1*
_Italic style 2_
**Bold style 1**
__Bold Style 2__
***Italic and Bold style 1 ***
___Italic and Bold style 1 ___

3.3 Line

3.3.1 Divid line

Three or more - continues connection

3.3.2 Delete line

Two ~ at both ends of text.

3.3.3 Under line

Nothing used for markdown but HTML \\</u>

3.4 Annotation

Text or image note for extra infomation which will be displaied when the mouse hover or click.

[^Text to be annotated]
[^Text to be annotated] This is annotation text.

4 List

Start with * or + or - (for unordered list) or 'digtal.' (for ordered list) at the begin of the each line of the list, and intentation with a tab (or four space) to start sub-list.

Tips : Nest list can be used.

5 Block

Start with > to make a block, as below :

> block
> > block nest 1
> > > block nest 2

6 Code

Add ` (for one code line) or ``` (for multi code line) at both ends of code, and programming language can be declared after the front end ```.

7 Link ,target and image

[Annotation Text](web link address) or [Annotation Test](#local target ID).

!Annotation Text

Form

| Head1 | Head 2 | Head 3| ... alignment style |ceil |ceil |ceil|... |ceil |ceil |ceil|... |ceil |ceil |ceil|... ...

alignment style :

- none \:- left
-: right \:-: middle

Math Formula

Wrap TeX or LaTeX with two $

Escape

use \

Flow chart

1、横向流程图源码格式：

graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]

2、竖向流程图源码格式：

graph TD
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[竖向流程图]

3、标准流程图源码格式：

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op

4、标准流程图源码格式（横向）：

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op

5、UML时序图源码样例：

对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗？

6、UML时序图源码复杂样例：

Title: 标题：复杂使用
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗？
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩

7、UML标准时序图样例：

%% 时序图例子,-> 直线，-->虚线，->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗？
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!

8、甘特图样例：

%% 语法示例
gantt
dateFormat  YYYY-MM-DD
title 软件开发甘特图
section 设计
需求                      :done,    des1, 2014-01-06,2014-01-08
原型                      :active,  des2, 2014-01-09, 3d
UI设计                     :         des3, after des2, 5d
未来任务                     :         des4, after des3, 5d
section 开发
学习准备理解需求                      :crit, done, 2014-01-06,24h
设计框架                             :crit, done, after des2, 2d
开发                                 :crit, active, 3d
未来任务                              :crit, 5d
耍                                   :2d
section 测试
功能测试                              :active, a1, after des3, 3d
压力测试                               :after a1  , 20h
测试报告                               : 48h

Markdown