介绍

特殊语法

分组显示

该语法为特殊语法,分组显示常用于代码内容在不同的选项卡中进行点击切换显示,支持自定义名称。

示例代码

查看代码
::: code-group
``` js [分组一]
这里是测试文本
```

```css [分组二]
这里是测试文本2
```
:::

显示效果

这里是测试文本
这里是测试文本2

提示框

该语法为特殊语法,用于提醒用户,对用户达成目标至关重要的信息。

示例代码

查看代码
::: info
强调用户在快速`浏览`文档时也不应忽略的信息。
:::

::: success
有助于用户更顺利达成目标的`建议`信息。
:::

::: important
对用户达成`目标`至关重要的信息。
:::

::: warning
有助于提醒用户`危险`的提示。
:::

::: danger
行为可能带来的`负面`影响。
:::

::: default 🔔 默认自定义
用于显示`自定义`信息。
:::

显示效果

查看详情

该语法为特殊语法,如果内容太长,可以使用查看详情标签,点击查看详情来查看内容

示例代码

查看代码
::: details 查看详情

| 标题 | 标题 | 标题 |
| --- | --- | --- |
| 内容1 | 内容2 | 内容3 |
| 内容1 | 内容2 | 内容3 |
| 内容1 | 内容2 | 内容3 |

如果内容太长,可以使用查看详情标签,点击查看详情来查看内容
:::

显示效果

查看详情
标题标题标题
内容1内容2内容3
内容1内容2内容3
内容1内容2内容3

如果内容太长,可以使用查看详情标签,点击查看详情来查看内容

标题

Markdown支持6种标题,我们可以使用# 前缀来标记,注意# 后面有个空格

示例代码

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

显示效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

列表

Markdown中,可以使用- 1. 来标记无序列表和有序列表,注意- 1. 后面有个空格

示例代码

- 搜索
- 地图
- 音乐
1. 搜索
2. 地图
3. 音乐

显示效果

  1. 搜索
  2. 地图
  3. 音乐

链接

链接的语法比较简单,使用[显示文本](链接URL)

示例代码

[百度](https://www.baidu.com)

显示效果
百度

图片

图片的语法只是在链接的语法前多了一个!,使用![图片描述](图片地址)

示例代码

![图片标题](/assets/addons/docs/images/1200x900.png)

显示效果
图片标题

引用

如果需要引用文字,可以使用> 来标记

示例代码

> 这是是引用的文字

显示效果

这里是引用的文字

粗体和斜体

Markdown中,粗体和斜体分别使用**_来标记

示例代码

**粗体**
_斜体_

显示效果
粗体
斜体

代码

Markdown中单行代码可以使用`代码`来标记,多行代码可以使用```来标记,注意在```后面可以使用php/js/css等语言名称

示例代码

$obj = \app\common\library\Email::instance();
$result = $obj
    ->to($params->email)
    ->subject('验证码')
    ->message("你的验证码是:1234")
    ->send();

显示效果

$obj = \app\common\library\Email::instance();
$result = $obj
    ->to($params->email)
    ->subject('验证码')
    ->message("你的验证码是:1234")
    ->send();

表格

示例代码

标题1 | 标题2 | 标题3
-----|-------|-----
内容1 | 内容2 | 内容3
内容1 | 内容2 | 内容3
内容1 | 内容2 | 内容3

显示效果

标题1标题2标题3
内容1内容2内容3
内容1内容2内容3
内容1内容2内容3