Markdown语法

Markdown 语法

Markdown 语法

• Markdown 语法
  • • 1. 内容目录
    • 2. 标题设置
    • 3. 块注释
    • 4. 斜体
    • 5. 粗体
    • 6. 无序列表
    • 7. 有序列表
    • 8. 链接(Links)
    • 9. 图片(Images)
    • 10. 代码(Code)
    • 11. 脚注(footnote)
    • 12. 下划线
    • 13. 标签和分类
    • 14. 待办事宜TODO列表
    • 15. 表格
    • 16. 流程图和时序图
    • 17. LaTeX公式
    • 18. 删除线
    • 19. 定义型列表
    • 20. 分割线

1. 内容目录

使用[TOC]引用目录,例如本方目录。

2. 标题设置

第一种：通过在文字下方添加 =和- 分别表示一级标题和二级标题
例如：“一级标题
=============”

第二种：在文字开头加上 # 通过#的数量表示几级标题
例如：“#一级标题 ##二级标题 ###三级标题”

3. 块注释

通过在文字开头添加 > 表示块注释 （当>和文字之间添加五个blank时，块注释的文字会有变化。）
例如 > 注释

注释

4. 斜体

将需要设置为斜体的文字两端使用1个 * 或者 _夹起来
例如：*斜体*
斜体

5. 粗体

将需要设置为粗体的文字两端使用2个 * 或者 _夹起来
例如：**粗体**
粗体

6. 无序列表

在文字开头添加（*，+，-）实现无序列表。但是要注意在（*，+，-）和文字之间需要添加空格。（建义：一个文档中只是用一种无序列表的表示方式）
例如：+ step1

• step1
• step2
• step3

7. 有序列表

使用数字后面跟上句号点。（还要有空格）

1. step1
2. step2
3. step3

8. 链接(Links)

Markdown中有两种方式实现链接，分别为内联方式和引用方式
内联方式：使用[描述](链接地址) 为文字增加外链接
This is an example link.
引用方式：
I get 10 times more taffic from Google than from Yahoo or MSN.

9. 图片(Images)

使用  插入图像。
内联方式：!\alt text
引用方式：!\alt text

10. 代码(Code)

实现方式有两种
第一种：简单文字出现一个代码框。使用`代码`。（不是单引号而是左上角~中的）
第二种：大片文字需要实现代码框。使用Tab或者四个空格
这是一个代码块
第三种：
使用 三个` + 语言名称进行标记。
例如：
java示例

    public static void main（String[] args）{
    }

11. 脚注(footnote)

实现方式如下
hello1

12. 下划线

在空白行下方添加三条 - 横线。（前面文字下方添加-，实现在2级标题）
例如：下划线

13. 标签和分类

一般在文首输入tags添加标签，categories添加分类：

tags:

• Markdown
• 语言

categories

• 技术

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 格式导出文稿

新增Todo列表功能 语法参考

改进 LaTex 功能

修复 LaTex 公式渲染问题

新增 LaTex 公式编号功能 语法参考

七月旅行准备

准备邮轮上需要携带的物品

浏览日本免税店的物品

购买蓝宝石公主号七月一日的船票

15. 表格

表头1	表头2
Content Cell	Content Cell
Content Cell	Content Cell

表头1	表头2
Content Cell	Content Cell
Content Cell	Content Cell

名字	描述
Help	Display the help window.
Close	Closes a window

表格中也可以使用普通文本的删除线，斜体等效果

名字	描述
Help	Display the help window.
Close	Closes a window

表格可以指定对齐方式

左对齐	居中	右对齐
col 3 is	some wordy text	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

16. 流程图和时序图

• 流程图

语法大体分为两段，第一段用来定义元素，第二段用来连接元素
定义元素阶段的语法是 
tag=>type: content:>url 
tag就是一个标签，在第二段连接元素时用 
type是这个标签的类型，从上段内容看有6中类型，非别为：
start 
end 
operation 
subroutine 
condition 
inputoutput
content就是在框框中要写的内容，中英文均可，但有一点需要特别注意，就是type后的冒号与文本之间一定要有个空格，没空格会出问题。 
url就是一个连接，与框框中的文本相绑定

连接元素阶段的语法就简单多了，直接用->来连接两个元素，需要注意的是condition类型，因为他有yes和no两个分支，所以要写成

c2(yes)->io->e 
c2(no)->op2->e

例如

• 时序图

创建sequence
->中，-代表实线，>代表实心箭头，还可以用--表示虚线，>>表示非实心箭头。在UML时序图中，实线表示主动发送消息，虚线表示返回（应答）消息，实心箭头表示同步消息（消息发送者停止活动等待应答消息），非实心箭头表示异步消息（消息发送者无须停止活动等待应答消息）。->两边可以是同一个Actor，表示自交互:

创建Title 
title: Title
创建Actor
participant A
participant B
participant C as C_Alias

给Actor添加Note
Note right of A: I'm A
Note left of A: I'm A
Note over A: I'm A
Note over A, B: We're friends.

17. LaTeX公式

• $表示行内公式
  质能守恒方程： 来表达。

• $$表示整行公式

   

  

   

18. 删除线

使用 ~~ 将要删除文字夹起来。表示删除线
这是一段错误的文本。

19. 定义型列表

名词 1

定义 1（左侧有一个可见的冒号和四个不可见的空格）

代码块 2

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

 代码块（左侧有八个不可见的空格）

20. 分割线

分割线

---

可以在一行用3个以上的 *,-,_来建立一条分割线，行内除了空格不能有其他东西，当然三条线效果是不同的，按顺序是很明显，不明显，一般。第二种不仔细看真看不到有线，我是换了暗色主题才看清。

---

1. hi ↩