MarkDown入门语法
标题
标题:#空格+标题名称 回车换行, 几级标题前面就几个#,最高6级
使用 # 号表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推,最多6级。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
字体
**粗体文本**
__粗体文本__
*斜体文本*
_斜体文本_
***粗斜体文本***
___粗斜体文本___
~~删除线文本~~
<u>下划线文本</u>
效果:
Hello,World!
Hello,World!
Hello,World!
Hello,World!
Hello,World!
Hello,World!
Hello,World!Hello,World!
段落
段落:直接编写文字就好,段落的换行是使用两个以上空格加上回车
段落一 ,
段落二 ,
段落三 。
加空格源码效果图
也可以在段落后面使用一个空行来表示重新开始一个段落
段落一,
段落二,
段落三。
引用
在段落开头使用 > 符号 ,然后后面紧跟一个空格符号 >+空格+内容
效果:
引用内容
分割线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
***
*****
- - -
----------
效果:
脚注
脚注是对文本的补充说明。
[^要注明的文本]
在小的帆! [^???]。
[^???]: 也能远航!!!
效果图:
图片
![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
- 开头一个感叹号 !
- 接着一个方括号,里面放上图片的替代文字
- 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
效果:
超链接
[超链接名称](超链接地址)
或者
<超链接地址>
列表
无序列表使用星号()、加号(+)或是减号(-*)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* A
* B
* C
+ A
+ B
+ C
- A
- B
- C
效果:
- A
- B
- C
- A
- B
- C
- A
- B
- C
有序列表使用数字并加上 . 号来表示(不要忘记空格一下)
- A
- B
- C
列表嵌套
列表嵌套只需在子列表中的选项前面添加四个空格(一个Tab默认4个空格)即可
- 第一段
- 第二段
- 第二段
表格
名字|性别|生日
– | – | --|
张三 | 男 | 199.7.1 |
这种写法需注意把源码空格去掉,不然没效果。还可以使用快捷键创建表格(右键空白,插入表格)
名字 | 性别 | 生日 |
---|---|---|
张三 | 男 | 199.7.1 |
代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如 :`pringtf()`函数
pringtf()
函数
代码区块
代码区块使用 ```+空格。
效果:
if(System.out.print("A")==null){//加入判断,输出AB
System.out.print("A");
}else{
System.out.print("B");
}
高级技巧
支持的 HTML 元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:
<kbd> <b> <i> <em> <sup> <sub> <br>
等 ,如:
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
效果:
使用 Ctrl+Alt+Del 重启电脑
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
**文本加粗**
\*\* 正常显示星号 \*\*
效果:
** 正常显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:
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、标准流程图源码格式:
```mermaid
flowchat
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、标准流程图源码格式(横向):
```mermaid
flowchat
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时序图源码样例:
```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗?
```
6、UML时序图源码复杂样例:
```mermaid
sequenceDiagram
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
```
效果图: