Markdown

headers

header3

header4

header5

Content

blablabla

List

list:

  • item1
  • item2
  • item3
  1. first
  2. second
  3. third

link: www.baidu.com

Table

header1 header2 header3
content1 content2 content3
content4 content5 content6

quotation

quota

Code

echo "hello world"

import pandas as pd
print("hello world")
a = 1 + 2

SELECT * FROM table WHERE ds = 20100304

Formular

$$ a = b + c $$

sum_(i=1)^n i^3=((n(n+1))/2)^2

Diagram

Flowchart

Top -> Bottom

graph TB
  A --> B

Botton -> Top

graph BT
  A --> B

Left -> Right

graph LR
  A --> B

Right -> Left

graph RL
  A --> B

graph TB
A[矩形节点] --> B(圆角节点)
B --- C((圆形节点))
B <--> D>旗帜状节点]
B --> E{菱形节点}
B ==> F
B --文字描述--> G
B -.- H
B -.虚线.- X

Sequence Diagram

sequenceDiagram
	participant A
    participant B
    participant C
    A -> B: hello
    A --> B: world
    A ->> B: hi
    A -->> B: ciao
    A -x C: bonjour
    A --x C: ca va

Gantt

gantt
    title 项目开发流程
    section 项目确定
        需求分析       :a1, 2016-06-22, 3d
        可行性报告     :after a1, 5d
        概念验证       : 5d
    section 项目实施
        概要设计      :2016-07-05, 5d
        详细设计      :2016-07-08, 10d
        编码          :2016-07-15, 10d
        测试          :2016-07-22, 5d
    section 发布验收
        发布: 2d
        验收: 3d

Picture

picture_example.png

Utils

lint-md

Github - lint Markdown

Install: npm install -g @lint-md/cli

Usage:

# 校验当前目录下的 test.md 文件
lint-md test.md

# 校验当前目录下的 test.md 文件，并修复之
lint-md test.md --fix

# 校验 examples 目录下所有的 Markdown 文件，并修复之
lint-md examples/**/* --fix

Online Drawing