Markdown编辑器编写规范格式记录文档

技术  /  管理员 发布于 4个月前   130

Markdown编写规范格式分享

一、标题

#        一级标题
##       二级标题
###      三级标题
####     四级标题
#####    五级标题
######   六级标题

二、段落

1、字体

*斜体文本*
**粗体文本**
***粗斜体文本***

2、分割线

---

3、删除线

~~删除线~~

4、下划线

<u>下划线</u>

5、脚注

[^要注明的文本]

6、转义

可以添加反斜杠转义以下字符

\\   反斜线
\`   反引号
\*   星号
\_   下划线
\{}  花括号
\[]  方括号
\()  小括号
\#   井字号
\+   加号
\-   减号
\.   英文句点
\!   感叹号
\|   管道

7、多选框

- [x] 默认选项
- [ ] 其他选项（1）
- [ ] 其他选项（2）

三、列表

1、无序列表

- 无序列表1
- 无序列表2
- 无序列表3

2、有序列表

1. 有序列表1
2. 有序列表2
3. 有序列表3

3、嵌套列表

1. 有序列表1
    - 无序列表1
    - 无序列表2
2. 有序列表2
    - 无序列表1
    - 无序列表2

四、区块

> 一级区块
>> 二级区块
>>> 三级区块
...

五、代码

1、引用

我引用了 `PHP`

2、指定代码语言

\ 我是javaScript alert('我是javaScript'); \\

六、链接

1：[超链接显示名](超链接地址 "超链接title")

[百度一下](https://www.baidu.com,"百度一下,你就知道")

2：用 < > 直接输出链接

<https://www.baidu.com>

3：在代码块中使用链接

[`百度一下，你就知道`](https://www.baidu.com)

4：引用链接

[百度一下][1]

[1]:https://www.baidu.com

七、图片

1：

![百度](https://ock.cn/2p4q4,"百度一下,你就知道")

2： [](图片链接)

[![百度一下](https://ock.cn/2p4q4,"百度一下,你就知道")](https://www.baidu.com)

八、表格

1、基础表格

| 标题 | 标题 |
| - | - |
| 内容 | 内容 |

2、表格对齐

| 表格左对齐 | 表格居中对齐 | 表格右对齐 |
| :- | :-: | -: |
| 内容 | 内容 | 内容 |

3、显示竖线

| 标题 | 标题 | 标题 |
| - | - | - |
| |  | | | | |

4、换行显示

| 标题 | 标题 | 标题 |
| :- | :-: | -: |
| 1<br/>2<br/>3<br/>| 456 | 789 |

九、命名规则

1、目录

级别    名称
1    一、二、三…
2    1、2、3…
3    （1）、（2）、（3）…
4    [1]、[2]、[3]…
5    <1>、<2>、<3>…
6    {1}、{2}、{3}…

2、文本描述

文字或代码使用大括号 {} 注释和描述

例如：

docker run {运行} –name php8.1 {自定义容器容器名称} -d php:8.1-fpm {镜像名称}