Markdown 标题
Markdown 标题有两种格式。
使用=和-标记一级和二级标题
= 和 - 标记语法格式如下:
一级标题
=
二级标题
-
展示效果:
一级标题
二级标题
使用 # 号标记
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
展示效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
Markdown 段落
Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。
当然也可以在段落后面使用一个空行来表示重新开始一个段落。
字体
Markdown 可以使用以下几种字体:
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
展示效果:
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
***
* * *
*****
- - -
----------
展示效果:
删除线
如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线即可,实例如下:
RUNOOB.COM
GOOGLE.COM
~~BAIDU.COM~~
展示效果:
RUNOOB.COM
GOOGLE.COM
BAIDU.COM
下划线
下划线可以通过 HTML 的标签来实现:
<u>带下划线文本</u>
展示效果:
带下划线文本
脚注
脚注是对文本的补充说明。
Markdown 脚注的格式如下:
[^要注明的文本]
创建脚注格式类似这样 [^test1]。
[^test1]: CSDN
展示效果:
创建脚注格式类似这样 1。
Markdown 列表
Markdown 支持有序列表和无序列表。
有序列表使用数字并加上 . 号来表示,如:
1. 第一项
2. 第二项
3. 第三项
展示效果:
- 第一项
- 第二项
- 第三项
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项
+ 第一项
- 第一项
展示效果:
- 第一项
- 第一项
- 第一项
列表嵌套
列表嵌套只需在子列表中的选项前面添加四个空格即可:
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
展示效果:
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
Markdown 区块
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
> 区块引用
> CSDN
展示效果:
区块引用
CSDN
Markdown 代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来,例如:
`printf()` 函数
展示效果:
printf()
函数
你也可以用 ```包裹一段代码,并指定一种语言(也可以不指定):
```java
public static void main(String[] args){
System.out.println("Hello World!");
}
```;
展示效果:
public static void main(String[] args){
System.out.println("Hello World!");
}
Markdown 链接
链接使用方法如下:
[链接名称](链接地址)
或者
<链接地址>
展示效果:
链接名称
或者
<链接地址>
例如:
这是一个链接 CSDN
直接使用链接地址:
https://www.csdn.net/
Markdown 图片
Markdown 图片语法格式如下:
开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
格式:
![图标](https://img-blog.csdnimg.cn/img_convert/bd431e9a28d36e34c5ac1665f39c36c8.png)
展示效果:
当然,你也可以像网址那样对图片网址使用变量:
这个链接用 3 作为网址变量 [picture][3].
然后在文档的结尾为变量赋值(网址)
[3]: https://csdnimg.cn/release/cmsfe/public/img/practice-mock.18239b19.png
展示效果:
这个链接用 3 作为网址变量 picture.
然后在文档的结尾为变量赋值(网址)
Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 标签。
<img src="https://csdnimg.cn/release/cmsfe/public/img/practice-mock.18239b19.png">
展示效果:
Markdown 表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
展示效果:
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
对齐方式
我们可以设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
实例如下:
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
展示效果:
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
Markdown 高级技巧
支持的 HTML 元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
展示效果:
目前支持的 HTML 元素有:
等 ,如:
使用 Ctrl+Alt+Del 重启电脑
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
**文本加粗**
\*\* 正常显示星号 \*\*
展示效果:
文本加粗
** 正常显示星号 **
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: 没人陪我玩
```;
展示效果:
CSDN ↩︎