本系统自带的编辑器可以非常方便地插入Markdown,但仍然有必要将常用的Markdown语法列在此处方便查看
标题
使用井号+空格+标题内容
即可。除了一级标题还有二级、三级...等。每个标题都只是在前面加的井号数量而区分。
例如上面的这个标题就是用下面的代码做到的:
::: details 查看范例
# 标题
## 二级标题
:::
段落
标题下方可直接跟段落,两个段落之间建议空一行,这样比较不那么拥挤
::: details 查看范例
这是第一个段落内容
这是第二个段落内容
这是第一个段落内容
这是第二个段落内容
:::
斜体
左右各使用1个*
星号放在需要变斜的内容两侧
默认模板的斜体是橘黄色的,您也可以在文档设置中自定义颜色
::: details 查看范例
例:我是斜体
*我是斜体*
:::
粗体
左右各使用2个*
星号放在需要变斜的内容两侧
::: details 查看范例
例:这两个字需要加粗
这两个字需要**加粗**
:::
代码引用
代码块
可在页面上显示代码框,并根据代码语言高亮代码内容
::: details 查看范例
```javascript
const someFunction = function(x,y) {
return x + y;
}
```
:::
内联代码
使用反引号
可在段落中显示内联代码
::: details 查看范例
这是段落中的代码x + y = 3
,是不是挺有意思
这是段落中的代码`x + y = 3`,是不是挺有意思
:::
块引用
代表其中的文字是引用内容。通常在渲染时,这部分的内容会有一定的缩进
::: details 查看范例
这是一个引用的块
块可以有多行
> 这是一个引用的块
> 块可以有多行
:::
图片
您可以直接在编辑器中直接上传插入图片,插入的图片会显示为下面的样子:
::: details 查看范例
[图片名称用中括号](图片地址.扩展名)
:::
无序项目编号
当您需要插入一个无序列表时,使用星号+空格+内容
即可
::: details 查看范例
购物清单:
购物清单:
* 牙刷
* 蛋卷
:::
有序项目编号
当您需要插入一个有序列表时,使用起始序号+点号+空格+内容
即可
::: details 查看范例
把大象放入冰箱的方法:
- 打开冰箱门
- 放入大象
(你是认真的??)
- 把冰箱门关起来
- 真的没有步骤了
把大象放入冰箱的方法:
1. 打开冰箱门
2. 放入大象
(你是认真的??)
3. 把冰箱门关起来
4. 真的没有步骤了
:::
文档自带的其它语法
比较常用的就上述的内容。文档自带的编辑器可以方便的插入其他内容,这些你都不需要记住,只需要点击编辑器的按钮就好了
例如:表格、删除线、标记、超链接、分割线、任务列表、表情、提示框、幻灯片
折叠面板
使用此容器可实现多个内容的折叠,并通过参数设置默认展开、面板颜色、展开时自动折叠其他内容
:::: collapse-panel accordion
::: collapse-item 基础用法
添加面板
在 collapse-panel
容器中嵌入 collapse-item
容器,在其后添加或修改内容即可成为标题
设置内容
在 collapse-item
容器内编写Markdown即可成为内容
:::
::: collapse-item 高级用法
面板颜色
在 collapse-item
后添加或修改颜色参数:warning
error
success
默认展开
在 collapse-item
后添加参数 open
手风琴
在 collapse-panel
后添加参数 accordion
,展开面板时其他面板自动折叠
:::
::::
::::: details 查看范例
:::: collapse-panel accordion
::: collapse-item 基础用法
**添加面板**
在 `collapse-panel` 容器中嵌入 `collapse-item` 容器,在其后添加或修改内容即可成为标题
**设置内容**
在 `collapse-item` 容器内编写Markdown即可成为内容
:::
::: collapse-item 高级用法
**面板颜色**
在 `collapse-item` 后添加或修改颜色参数:`warning` `error` `success`
**默认展开**
在 `collapse-item` 后添加参数 `open`
**手风琴**
在 `collapse-panel` 后添加参数 `accordion`,展开面板时其他面板自动折叠
:::
::::
:::::
标签
使用标签容器可创建标签页效果,并通过参数设置默认打开的标签、标签颜色、标签位置
:::: tabs top-start
::: tab-pane 基础用法
添加标签
在 tabs
容器中嵌入 tab-pane
容器,在其后添加或修改内容即可成为标题
设置内容
在 tab-pane
容器内编写Markdown即可成为内容
:::
::: tab-pane 高级用法
标签颜色
在 tab-pane
后添加或修改颜色参数:warning
error
success
标签位置
在 tabs
后添加或修改位置参数:top
top-start
top-end
right
right-start
right-end
bottom
bottom-start
bottom-end
left
left-start
left-end
默认标签
在 tab-pane
后添加参数 open
:::
::::
:::::: details 查看范例
::::: tabs
:::: tab-pane 基础用法
**添加标签**
在 `tabs` 容器中嵌入 `tab-pane` 容器
**设置内容**
在 `tab-pane` 后添加或修改内容即可成为标题,在 `tab-pane` 容器内编写Markdown即可成为内容
::::
:::: tab-pane 高级用法
**标签颜色**
在 `tab-pane` 后添加或修改颜色参数:`warning` `error` `success`
**标签位置**
在 `tabs` 后添加或修改位置参数:`top` `top-start` `top-end` `right` `right-start` `right-end` `bottom` `bottom-start` `bottom-end` `left` `left-start` `left-end`
::::
:::::
::::::