Skip to content

教程撰写语法

当你认为你可以开始撰写相关文档时,请先阅读此开发文档,快来尝试你的第一个攻略吧!

标题

首先是标题,几级标题就用几个#开头,#号与标题之间用空格隔开,如下格式:

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

写出上面的内容后,会生成如下效果:

一级标题

(二级标题如小节)

三级标题

四级标题

五级标题

小点

md
- 小点
    - 小点

渲染效果如下:

  • 小点
    • 小点

提示

md
:::  tip 提示
提示内容
:::

:::  warning 警告
警告内容
:::

:::  danger 危险
危险内容
:::

::: info  信息
信息内容
:::

::: details 点击展开
详情内容
:::

渲染效果如下,其中汉字都可以替换:

提示

提示内容

警告

警告内容

危险

危险内容

信息

信息内容

点击展开

详情内容

链接

md
[链接文字](https://www.bilibili.com)

渲染效果如下:链接文字

图片

图片的加载方式同上,只需要在前面增加一个,这里规定,一个文档所对应的图片必须放在image文件夹内,全部图片重命名为文件名-序号,结构如下:

md
|- 教程撰写语法.md
|- image
    |- 教程撰写语法-1.png
    |- 教程撰写语法-2.png

文档内撰写图片的语法如下:

md
![图片名称](/image/图片名称.png)

文本块

这里的语言可以不填写,但是建议填写为txt 或者 md 格式,想要编写的内容将\n替换为换行,内容不能与语言在同一行,渲染效果如下:

md
```语言\n```

高亮显示

md
`内容`

渲染效果如下: 内容

标签

md
<Badge type="info" text="default" />
<Badge type="tip" text="^1.9.0" />
<Badge type="warning" text="beta" />
<Badge type="danger" text="caution" />

渲染效果如下:

default^1.9.0betacaution

代码

本文档支持识别原生HTML/CSS,同时支持vue语法,按照正常开发逻辑去写即可,记得做好样式隔离。

进阶内容

点击跳转详细文档