MarkDown基础
标题
1 | # 标题名字(井号的个数代表标题的级数) 或者快捷键ctrl+1-6 |
一级标题使用1个#
二级标题使用2个#
三级标题使用3个#
四级标题使4用个#
五级标题使用5个#
六级标题使用6个#
####### 最多支持六级标题#
文字
删除线
1 | 这就是 ~~删除线~~ (使用波浪号) |
这就是 删除线 (使用波浪号)
斜体
1 | 这是用来 *斜体* 的 _文本_ |
这是用来 斜体 的 文本
加粗
1 | 这是用来 **加粗** 的 __文本__ |
这是用来 加粗 的 文本
斜体+加粗
1 | 这是用来 ***斜体+加粗*** 的 ___文本___ |
这是用来 斜体+加粗 的 文本
下划线
下划线是HTML语法
下划线
下划线(快捷键command
+u
,windows为ctrl+u)
高亮(需勾选扩展语法)
1 | 这是用来 ==斜体+加粗== 的文本 |
这是用来 ==斜体+加粗== 的文本
下标(需勾选扩展语法)
1 | 水 H~2~O |
水 H2O
双氧水 H2O2
上标(需勾选扩展语法)
1 | 面积 m^2^ |
面积 m^2^
体积 m^3^
表情符号
Emoji 支持表情符号,你可以用系统默认的 Emoji 符号( Windows 用户不一定支持,自己试下~)。 也可以用图片的表情,输入 :
将会出现智能提示。
一些表情例子
1 | :smile: :laughing: :dizzy_face: :sob: :cold_sweat: :sweat_smile: :cry: :triumph: :heart_eyes: :relaxed: :sunglasses: :weary: |
:smile: :laughing: :dizzy_face: :sob: :cold_sweat: :sweat_smile: :cry: :triumph: :heart_eyes: :relaxed: :sunglasses: :weary: :+1: :-1: :100: :clap: :bell: :gift: :question: :bomb: :heart: :coffee: :cyclone: :bow: :kiss: :pray: :sweat_drops: :hankey: :exclamation: :anger:
( Mac: control
+command
+space
点选)
表格
使用 |
来分隔不同的单元格,使用 -
来分隔表头和其他行:
1 | name | price |
为了使 Markdown 更清晰,
|
和-
两侧需要至少有一个空格(最左侧和最右侧的|
外就不需要了)。
name | price |
---|---|
fried chicken | 19 |
cola | 5 |
为了美观,可以使用空格对齐不同行的单元格,并在左右两侧都使用 |
来标记单元格边界,在表头下方的分隔线标记中加入 :
,即可标记下方单元格内容的对齐方式:
1 | | name | price | |
name | price |
---|---|
fried chicken | 19 |
cola | 32 |
使用快捷键command
+opt
+T
更方便(段落→表格→插入表格,即可查看快捷键)
引用
1 | >“后悔创业” |
“后悔创业”
1 | >也可以在引用中 |
也可以在引用中
使用嵌套的引用
列表
无序列表–符号 空格
1 | * 可以使用 `*` 作为标记 |
- 可以使用
*
作为标记
- 也可以使用
+
- 或者
-
有序列表–数字 .
空格
1 | 1. 有序列表以数字和 `.` 开始; |
有序列表以数字和
.
开始;数字的序列并不会影响生成的列表序列;
但仍然推荐按照自然顺序(1.2.3…)编写。
1
可以使用:数字\. 来取消显示为列表(用反斜杠进行转义)
代码
代码块
1 | ```语言名称 |
1 | public static void main(String[] args) { |
行内代码
1 | 也可以通过 ``,插入行内代码(` 是 `Tab` 键上边、数字 `1` 键左侧的那个按键): |
Markdown
转换规则
代码块中的文本(包括 Markdown 语法)都会显示为原始内容
分隔线
可以在一行中使用三个或更多的 *
、-
或 _
来添加分隔线(``):
1 | *** |
跳转
外部跳转–超链接
格式为 [link text](link)
。
1 | [帮助文档](https://support.typora.io/Links/#faq) |
内部跳转–本文件内跳(Typora支持)
格式为 [link text](#要去的目的地--标题)
。
1 | [我想跳转](#饼图(Pie)) |
Open Links in Typora
You can use
command+click
(macOS), orctrl+click
(Linux/Windows) on links in Typora to jump to target headings, or open them in Typora, or open in related apps.
自动链接
使用 <>
包括的 URL 或邮箱地址会被自动转换为超链接:
1 | <https://www.baidu.com> |
图片
1 | ![自己起的图片名字](图片地址或者图片本地存储的路径) |
网上的图片
1 | ![friedChicken](https://ss0.bdstatic.com/94oJfD_bAAcT8t7mm9GUKT-xh_/timg?image&quality=100&size=b4000_4000&sec=1580814517&di=2630beac440e5dab0e44c7286a3b2b61&src=http://imgsrc.baidu.com/forum/w=580/sign=12c730c4ff03738dde4a0c2a831ab073/9497794f9258d1091818e6d6d858ccbf6d814d1b.jpg) |
本地图片
1 | ![friedChicken](friedChicken.jpg) |
利用Markdown画图(需勾选扩展语法)
markdown画图也是轻量级的,功能并不全。
Mermaid 是一个用于画流程图、状态图、时序图、甘特图的库,使用 JS 进行本地渲染,广泛集成于许多 Markdown 编辑器中。Mermaid 作为一个使用 JS 渲染的库,生成的不是一个“图片”,而是一段 HTML 代码。
(不同的编辑器渲染的可能不一样)
流程图(graph)
概述
1 | graph 方向描述 |
关键字graph表示一个流程图的开始,同时需要指定该图的方向。
其中“方向描述”为:
用词 | 含义 |
---|---|
TB | 从上到下 |
BT | 从下到上 |
RL | 从右到左 |
LR | 从左到右 |
T = TOP,B = BOTTOM,L = LEFT,R = RIGHT,D = DOWN
最常用的布局方向是TB、LR。
1 | graph TB; |
1 | graph TB; |
1 | graph LR; |
1 | graph LR; |
流程图常用符号及含义
节点形状
表述 | 说明 | 含义 |
---|---|---|
id[文字] | 矩形节点 | 表示过程,也就是整个流程中的一个环节 |
id(文字) | 圆角矩形节点 | 表示开始和结束 |
id((文字)) | 圆形节点 | 表示连接。为避免流程过长或有交叉,可将流程切开。成对 |
id{文字} | 菱形节点 | 表示判断、决策 |
id>文字] | 右向旗帜状节点 |
单向箭头线段:表示流程进行方向
id即为节点的唯一标识,A~F 是当前节点名字,类似于变量名,画图时便于引用
括号内是节点中要显示的文字,默认节点的名字和显示的文字都为A
1 | graph TB |
1 | graph TB |
1 | graph TB |
1 | graph TB |
连线
1 | graph TB |
1 | graph TB |
1 | graph TB |
子图表
使用以下语法添加子图表
1 | subgraph 子图表名称 |
1 | graph TB |
1 | graph TB |
序列图(sequence diagram)
概述
1 | sequenceDiagram |
sequenceDiagram
为每幅时序图的固定开头
1 | sequenceDiagram |
1 | sequenceDiagram |
参与者(participant)
传统时序图概念中参与者有角色和类对象之分,但这里我们不做此区分,用参与者表示一切参与交互的事物,可以是人、类对象、系统等形式。中间竖直的线段从上至下表示时间的流逝。
1 | sequenceDiagram |
participant <参与者名称>
声明参与者,语句次序即为参与者横向排列次序。
消息线
类型 | 描述 |
---|---|
-> | 无箭头的实线 |
–> | 无箭头的虚线 |
->> | 有箭头的实线(主动发出消息) |
–->> | 有箭头的虚线(响应) |
-x | 末端为叉的实线(表示异步) |
–x | 末端为叉的虚线(表示异步) |
处理中-激活框
从消息接收方的时间线上标记一小段时间,表示对消息进行处理的时间间隔。
在消息线末尾增加 +
,则消息接收者进入当前消息的“处理中”状态;
在消息线末尾增加 -
,则消息接收者离开当前消息的“处理中”状态。
1 | sequenceDiagram |
1 | sequenceDiagram |
注解(note)
语法如下
1 | Note 位置表述 参与者: 标注文字 |
其中位置表述可以为
表述 | 含义 |
---|---|
right of | 右侧 |
left of | 左侧 |
over | 在当中,可以横跨多个参与者 |
1 | sequenceDiagram |
1 | sequenceDiagram |
循环(loop)
在条件满足时,重复发出消息序列。(相当于编程语言中的 while 语句。)
1 | sequenceDiagram |
1 | sequenceDiagram |
选择(alt)
在多个条件中作出判断,每个条件将对应不同的消息序列。(相当于 if 及 else if 语句。)
1 | sequenceDiagram |
1 | sequenceDiagram |
可选(opt)
在某条件满足时执行消息序列,否则不执行。相当于单个分支的 if 语句。
1 | sequenceDiagram |
1 | sequenceDiagram |
并行(Par)
将消息序列分成多个片段,这些片段并行执行。
1 | sequenceDiagram |
1 | sequenceDiagram |
饼图(Pie)
1 | pie |
1 | pie |
甘特图(gantt)
1 | title 标题 |
1 | gantt |
1 | gantt |