基本语法
文字
倾斜: 倾斜部分前后各添加一个星号 *
倾斜
粗体: 加粗部分两侧各添加两个星号 **
加粗
倾斜并加粗: 倾斜并加粗部分两侧各添加三个星号 ***
倾斜并加粗
文字删除线: 在单词前后使用两个波浪号 ~~
文字删除线
下划线: 使用 <u>下划线</u>
标签添加下划线 下划线
段落
要创建段落,使用空白行将一行或多行文本进行分隔
换行
在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行
块引用
在引用的文字前加 >
即可,可以嵌套,如加两个 >>
三个 >>>
块引用可以包含多个段落,为段落之间的空白行添加一个 >
符号即可
这是引用的内容一
这是引用的内容二
这是引用的内容三
分割线
在单独一行上使用三个或多个星号 ***
、破折号 ---
或下划线 ___
,并且不能包含其他内容
|
|
超链接
链接文本放在中括号内,链接地址放在后面的括号中,链接 title 可选(链接 title 是当鼠标悬停在链接上时会出现的文字)
超链接 Markdown 语法代码:[超链接显示名](超链接地址 "超链接 title")
[andyblog](https://andyqiu.cn "link title")
andyblog
- 也可以直接用尖括号包含网址的方式
<https://andyqiu.cn>
来直接构造一个可点击的链接 https://andyqiu.cn - 如果不希望自动链接 URL,则可以通过将 URL 表示为带反引号的代码来删除该链接
`https://andyqiu.cn`
https://andyqiu.cn
图片
使用感叹号 !
, 然后在方括号增加替代文本,图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本
图片 Markdown 语法代码:![图片alt](图片地址 "图片title")
- 图片 alt: 显示在图片下的文字
- 图片 title: 当鼠标移到图片上时显示的内容,title 可加可不加
![](https://andyqiu.cn/imgs/favicon.ico)
- 给图片增加链接,将图像的 Markdown 内容括在方括号中,然后将链接添加在圆括号中
[![favicon](https://andyqiu.cn/imgs/favicon.ico "favicon")](https://andyqiu.cn)
自定义图片尺寸
markdown 自定义图片尺寸需要用 html 语句来支持
|
|
使用 Emoji 表情
在 Markdown 文档中添加对应的 Emoji 表情符号,前后用冒号包围
:smile_code:
😄
Emoji 表情符号参考 Emoji
列表
无序列表
在每个列表项前面添加破折号 -
、星号 *
或加号 +
,缩进一个或多个列表项可创建嵌套列表
|
|
- list one
- list two
- list three
有序列表
在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列,但是列表应当以数字 1 起始
|
|
- a
- b
- c
任务列表
任务列表在列表的基础上,加上中括号 [ ]
,已完成列表在中括号中加 x
|
|
- 看电影
- 听音乐
列表嵌套
要在保留列表连续性的同时在列表中添加另一种元素,将该元素缩进四个空格或一个制表符
|
|
- list one
- a
- b
- list two
- list A
- list B
代码
单行代码:代码之间分别用一个反引号 `
包起来
代码块:代码之间分别用三个反引号 ```
或三个波浪号 ~~~
包起来,且两边的反引号单独占一行
转义反引号
如果要表示为代码的单词或短语中包含一个或多个反引号,则可以通过将单词或短语包裹在双反引号中
|
|
Use `code` in your Markdown file.
表格
使用三个或多个连字符 ---
创建每列的标题,并使用管道 |
分隔每列
- 通过在标题行中的连字符的左侧,右侧或两侧添加冒号
:
,将列中的文本对齐到左侧,右侧或中心 - 第二行分割表头和内容
|
|
表头1 | 表头2 | 表头3 |
---|---|---|
左对齐 | 居中对齐 | 右对齐 |
内容 | 内容 | 内容 |
流程图
- 流程图
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
- 甘特图
%% 语法示例
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