Markdown语法手册

标签 : Markdown

[TOC]

一基础资料

1.1 斜体和粗体

使用 * 和 ** 表示斜体和粗体。
示例:
这是斜体，这是粗体。

使用三个*表示为粗斜体
示例:
这是 粗斜体

1.2 分级标题

使用 === 表示一级标题,使用 --- 表示二级标题
示例:

这是一个一级标题
======================
这是一个二级标题
----------------------
### 这是一个三级标题

这是一个一级标题

这是一个二级标题

你也可以选择在行首加井号表示不同级别的标题 (H1-H6)，例如：# H1, ## H2, ### H3，#### H4。

1.3 使用外连接

使用[表述](连接地址)为文字增加外连接.
示例:
这是去往百度的链接.

1.4 无序列表

使用 * , + , - 表示列表.
示例:

无序列表一

无序列表二

无序列表三

1.5 有序列表

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

示例:

有序列表一
有序列表二
有序列表三

1.6 文字引用

使用 > 表示文字引用
示例:

野火

烧不尽

春分

吹又生

1.7 行内代码块

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

示例:

让我们聊聊html

1.8 代码块

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

示例:

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

1.9 插入图像

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

示例：

我的头像

二高阶语法

2.1 内容目录

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

[TOC]

2.2 标签分类

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

标签：数学英语 Markdown

或者

Tags：数学英语 Markdown

2.3 删除线

使用~~ 表示删除线

~~这是一段错误的文本.~~

2.4 注脚

使用 ^[1] 表示注脚

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

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

2.5 LaTeX 公式

E=mc^2$ 来表达。

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

2.6 加强代码块

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

非代码示例：

$ sudo apt-get install vim-gnome

@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'''

/**
* 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));

2.7 流程图

flow示例:

st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end

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

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

更多语法参考：流程图语法参考

竖向流程图:

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

横向流程图:

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

2.8 序列图

示例1:

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

示例2:

Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow

更多语法参考：序列图语法参考

复杂时序图:

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: 没人陪我玩

标准时序图:

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

更多语法参考：Mermaid 序列图语法参考

2.9 甘特图

示例1:

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

示例2:

gantt
  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

2.10 表格支持

示例:

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

2.11 定义型列表

Markdown
: 轻量级文本标记语言，可以转换成html，pdf等格式（左侧有一个可见的冒号和四个不可见的空格）
代码块 2
: 这是代码块的定义（左侧有一个可见的冒号和四个不可见的空格）
代码块（左侧有八个不可见的空格）

2.12 Html 标签

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

值班人员	星期一	星期二	星期三
值班人员	李强	张明	王平

2.13 内嵌图标

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

即显示微博的图标：

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

即显示人人的图标：

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

2.14 待办事宜 Todo 列表

使用带有 [ ] 或 [x] （未完成或已完成）项的列表语法撰写一个待办事宜列表，并且支持子列表嵌套以及混用Markdown语法，例如：

- [ ] **Cmd Markdown 开发**
    - [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
    - [ ] 支持以 PDF 格式导出文稿
    - [x] 新增Todo列表功能 [语法参考](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
    - [x] 改进 LaTex 功能
        - [x] 修复 LaTex 公式渲染问题
        - [x] 新增 LaTex 公式编号功能 [语法参考](http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers)
- [ ] **七月旅行准备**
    - [ ] 准备邮轮上需要携带的物品
    - [ ] 浏览日本免税店的物品
    - [x] 购买蓝宝石公主号七月一日的船票

对应显示如下待办事宜 Todo 列表：

[ ] Cmd Markdown 开发
- [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
- [ ] 支持以 PDF 格式导出文稿
- [x] 新增Todo列表功能语法参考
- [x] 改进 LaTex 功能
  - [x] 修复 LaTex 公式渲染问题
  - [x] 新增 LaTex 公式编号功能语法参考
[ ] 七月旅行准备
- [ ] 准备邮轮上需要携带的物品
- [ ] 浏览日本免税店的物品
- [x] 购买蓝宝石公主号七月一日的船票

三简要命令还可参考简要命令

这是一个样例 ↩
样例1 ↩
样例2 ↩

Markdown语法手册

Markdown语法手册

[TOC]

一 基础资料

1.1 斜体和粗体

1.2 分级标题

这是一个一级标题

这是一个二级标题

1.3 使用外连接

1.4 无序列表

1.5 有序列表

1.6 文字引用

1.7 行内代码块

1.8 代码块

1.9 插入图像

二 高阶语法

2.1 内容目录

2.2 标签分类

2.3 删除线

2.4 注脚

2.5 LaTeX 公式

2.6 加强代码块

2.7 流程图

2.8 序列图

2.9 甘特图

2.10 表格支持

2.11 定义型列表

2.12 Html 标签

2.13 内嵌图标

2.14 待办事宜 Todo 列表

三 简要命令还可参考简要命令

你可能感兴趣的:(Markdown语法手册)

一基础资料

二高阶语法

三简要命令还可参考简要命令