Markdown标题
-
用 ‘#’,再空格
Markdown 段落
-
段落的换行是使用两个以上空格加上回车
字体
*斜体文本* _斜体文本_ **粗体文本** __粗体文本__ ***粗斜体文本*** ___粗斜体文本___
分隔线
-
在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西
*** * * * ***** - - - ----------
删除线
-
在文字的两端加上两个波浪线 ~~ 即可
~~BAIDU.COM~~
下划线
-
<u>带下划线文本</u>
脚注
脚注是对文本的补充说明。
Markdown 脚注的格式如下:
[^要注明的文本]
以下实例演示了脚注的用法:
创建脚注格式类似这样 [^RUNOOB]。 [^RUNOOB]: 菜鸟教程 -- 学的不仅是技术,更是梦想!!!
Markdown 列表
-
无序列表用 - + 空格
-
有序列表用 ‘1‘ + 空格
列表嵌套
列表嵌套只需在子列表中的选项前面添加两个或四个空格即可:
Markdown 区块
-
在段落开头使用 > 符号 ,然后后面紧跟一个空格符号
-
另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套
Markdown 代码
-
代码块:’```‘ 编程语言
-
一行代码:用 ’ ` ‘ 包裹
Markdown 链接
[链接名称](链接地址)-----------注意:是英文的[]和 () 或者 <链接地址>
高级链接
我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:
这个链接用 1 作为网址变量 [Google][1] 这个链接用 runoob 作为网址变量 [Runoob][runoob] 然后在文档的结尾为变量赋值(网址) [1]: http://www.google.com/ [runoob]: http://www.runoob.com/
显示结果如下:
Markdown 图片
Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 <img> 标签。
Markdown 表格
-
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:
| 表头 | 表头 | | ---- | ---- | | 单元格 | 单元格 | | 单元格 | 单元格 |
以上代码显示结果如下:
-
对齐方式
我们可以设置表格的对齐方式:
-
-: 设置内容和标题栏居右对齐。
-
:- 设置内容和标题栏居左对齐。
-
:-: 设置内容和标题栏居中对齐。
实例如下:
| 左对齐 | 右对齐 | 居中对齐 | | :-----| ----: | :----: | | 单元格 | 单元格 | 单元格 | | 单元格 | 单元格 | 单元格 |
以上代码显示结果如下:
Markdown 高级技巧
-
转义
Markdown 使用反斜杠转义特殊字符
-
公式
-
$...$
或者\(...\)
中的数学表达式将会在行内显示。 -
$$...$$
或者\[...\]
或者```math
中的数学表达式将会在块内显示。
$$ \begin{Bmatrix} a & b \\ c & d \end{Bmatrix} $$ $$ \begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD} $$
输出结果为:
-
typora 画流程图、时序图(顺序图)、甘特图
以下几个实例效果图如下:
1、横向流程图源码格式:
```mermaid graph LR A[方形] -->B(圆角) B --> C{条件a} C -->|a=1| D[结果1] C -->|a=2| E[结果2] F[横向流程图] ```
2、竖向流程图源码格式:
```mermaid graph TD A[方形] --> B(圆角) B --> C{条件a} C --> |a=1| D[结果1] C --> |a=2| E[结果2] F[竖向流程图] ```
3、标准流程图源码格式:
```flow 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、标准流程图源码格式(横向):
```flow 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时序图源码样例:
```sequence 对象A->对象B: 对象B你好吗?(请求) Note right of 对象B: 对象B的描述 Note left of 对象A: 对象A的描述(提示) 对象B-->对象A: 我很好(响应) 对象A->对象B: 你真的好吗? ```
6、UML时序图源码复杂样例:
```sequence 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标准时序图样例:
```mermaid %% 时序图例子,-> 直线,-->虚线,->>实线箭头 sequenceDiagram participant 张三 participant 李四 张三->王五: 王五你好吗? loop 健康检查 王五->王五: 与疾病战斗 end Note right of 王五: 合理 食物 <br/>看医生... 李四-->>张三: 很好! 王五->李四: 你怎么样? 李四-->王五: 很好! ```
8、甘特图样例:
```mermaid %% 语法示例 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 ```
效果图如下: