欢迎来到我的博客,这是一篇Markdown基础写法指南,记录一个Markdown初学者的学习云笔记。
在没学习Markdown之前一直觉得它是一个非常高大上的东西,很羡慕那些使用Markdown非常熟练的大神,沉下心学习之后发现写法还是挺简单的,接下来进入正文。
1、标题 |
Markdown支持6种级别的标题,对应html标签 h1 ~ h6。语法如下:
# h1 (一级标题,总的大分类使用)
## h2 (二级标题,大标题或者段落模块分割使用)
### h3 (三级标题,小标题使用)
#### h4 (四级标题,小标题使用)
##### h5 (五级标题,更小标题,不常用)
###### h6 (六级标题,最小标题,不常用)
效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
2、引用 |
Markdown就是一种易于编写的普通文本,只不过加入了一些渲染文本的标签。引用一般用来做强调处理,语法如下:
> 这段文字是引用xxxxxx
效果如下:
这段文字是引用xxxxxx
3、链接和图片 |
引用链接和图片语法区别就是在最前边加一个感叹号。
链接语法如下:
[点击链接跳转至百度](http://www.baidu.com)
链接效果如下:
图片语法如下:
![百度图片](http://www.baidu.com/img/flexible/logo/pc/index.png)
引用本地图片的话,在基础语法的括号中填入图片的位置路径即可,支持绝对路径和相对路径。
图片效果如下:
4、列表 |
Markdown支持有序列表和无序列表两种形式,语法如下:
有序列表(数字加.): 1.
无序列表(*或+或-):*
效果如下:
有序列表:
-
有序列表1
-
有序列表2
-
有序列表3
无序列表:
- 无序列表1
- 无序列表2
- 无序列表3
如果在单一列表项中包含了多个段落,为了渲染正常,*与段落首字母之间须保留四个空格,语法如下:
* 段落一
* 小段一
* 段落二
* 小段二
效果如下:
- 段落一
- 小段一
- 小段二
- 段落二
- 小段一
- 小段二
5、分割线 |
为了排版漂亮、分割模块可使用分割线,语法如下:
***
或
---
效果如下:
6、文字强调 |
语法如下:
斜体是使用*或_包裹:*我是斜体* 或 _我是斜体_
加粗是使用**或__包裹:**我是加粗** 或 __我是加粗__
斜体加粗是使用***或___包裹:***我是斜体加粗*** 或 ___我是斜体加粗___
下划线:<u>我是下划线</u>
删除线:~~我是删除线~~
效果如下:
我是斜体
我是加粗
我是斜体加粗
我是下划线
我是删除线
7、设置文字样式 |
Markdown可设置文字大小、字体、颜色、背景颜色,语法如下:
文字大小:<font size=4>我是4号文字</font>
字体:<font face="黑体">我是黑体</font>
颜色:<font color=gray>我是灰色</font>
背景颜色:<table><tr><td bgcolor=#B8DDB0>我是浅绿色背景</td></tr></table>
效果如下:
我是灰色的4号黑体文字
我是浅绿色背景 |
8、插入代码 |
插入代码分为行内代码和代码块,语法如下:
行内代码(单个反引号包裹):`var str = dafu`
代码块(三个反引号包裹):```java
public static void main(String[] args) {
System.out.print("dafu");
}
```
效果如下:
var str = dafu
public static void main(String[] args) {
System.out.print("dafu");
}
9、表格 |
表格稍微复杂,建议直接从目录里选择 段落—>表格—>插入表格;
也可选择实用语法,语法如下:
1-1|1-2|1-3
:---:|:---:|:---:
2-1|2-2|2-3
效果如下:
1-1 | 1-2 | 1-3 |
---|---|---|
2-1 | 2-2 | 2-3 |
说明:三个短斜杠左右的冒号用于控制对齐方式,只放置左边冒号表示文字居左,只放置右边冒号表示文字居右,如果两边都放置冒号表示文字居中。
10、数学公式 |
-
行内与独行
行内公式(将公式插入到本行内):
$公示内$
,如:$abc$
;独行公式(将公式插入到新的一行,且居中):
$$公示内容$$
,如:$$abc$$
-
常用公式代码
名称 | 算式 | markdown |
---|---|---|
上标 | x^2 | x^2 |
下标 | y_1 | y_1 |
分式 | 1/2 | 1/2 或\frac{1}{2} |
省略号 | … | \cdots |
开根号 | √2 | \sqrt{2} |
矢量 | ⃗ | \vec |
积分 | ∫ | \int |
极限 | lima+b | \lim{a+b} |
求和 | ∑ | \sum |
求积 | ∏ | \prod |
三角函数 | sin | \sin |
对数函数 | ㏑ | \ln |
对数函数 | ㏒ | \log |
关系运算符 | ± | \pm |
关系运算符 | × | \times |
关系运算符 | ÷ | \div |
空格 | \quad |
更多详细语法可参考其他大神的文章:
- 示例1
语法如下:
$$x^{y^z}=(1+{\rm e}^x)^{-2xy^w} $$
效果如下:
x
y
z
=
(
1
+
e
x
)
−
2
x
y
w
x^{y^z}=(1+{\rm e}^x)^{-2xy^w}
xyz=(1+ex)−2xyw
- 示例2
语法如下:
$$x={\frac{-b \pm \sqrt{b^2-4ac} }{2a} }$$
效果如下:
x
=
−
b
±
b
2
−
4
a
c
2
a
x={\frac{-b \pm \sqrt{b^2-4ac} }{2a} }
x=2a−b±b2−4ac
11、流程图 |
语法如下:
```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
```
效果如下:
12、UML时序图 |
语法如下:
```mermaid
sequenceDiagram
张三->>李四: 你吃饭了吗?(请求)
Note right of 李四: 对李四的描述
Note left of 张三: 对张三的描述(提示)
李四-->>张三: 吃了(响应)
张三->>李四: 你吃的什么?
```
效果如下:
13、甘特图 |
语法如下:
%% 语法示例
gantt
dateFormat YYYY-MM-DD
title 软件开发甘特图
section 设计
需求 :done, des1, 2021-01-06,2021-01-08
原型 :active, des2, 2021-01-09, 3d
UI设计 : des3, after des2, 5d
未来任务 : des4, after des3, 5d
section 开发
理解需求 :crit, done, 2021-01-06,24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
摸鱼 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 :48h
效果如下: