文档编写

2021/10/14

# markdown语法

首先文档支持所有的markdown语法,包括各级标题、音视频解析、段落、列表、区块、代码、连接、表格,以及一些高级的编写技巧。

# page title编写

---
title: title
description: description
meta:
  - name: keywords
    content: super duper SEO
---
1
2
3
4
5
6
7

# 新建页面

  • 在对应功能的文件夹内新建.md 文件
  • 找到 .vuepress/config.js 文件下的 themeConfig.locales.sidebar 配置
  • 目录列表每个项对应一个navbar配置的项,内置的目录配置为对应的.md文件和目录文件夹的相对路径
  • 配置上新建文件所在路径

注:新建nav项时,目录下必须包含一个README.md,sidebar目录下必须包含一个 '',点击nav时路径才能匹配正确。

  • 编写新建的.md文件
// Home/demo/demo.md
# 新建页面
1. 新建
2. 页面
1
2
3
4
  • 根目录下执行npm run docs:dev查看效果

# 插件使用

  1. 插件调用使用::: 插件名,且需要有闭合标签
::: tip
:::
1
2
  1. 插件attribute传参放在插件名后
::: tab label=组件概览
:::
1
2
  1. 插件内容放在两个token(:::)里面
::: tip
这是一个tip
:::
1
2
3

这是一个tip

  1. 插件调用时,除非插件本身带嵌套语法,尽量不要嵌套不同插件,否则容易产生语法错误
自带嵌套语法的插件:

:::: tabs

::: tab label=组件概览
这是tabA 展示的页面
:::

::: tab label=详细介绍
这是tabB 展示的页面
:::

::::
1
2
3
4
5
6
7
8
9
10
11
12
13

# 已支持插件

# tip

::: tip
这是一个提示
:::

::: warning
这是一个警告
:::

::: danger
这是一个危险警告
:::

::: details
这是一个详情块,在 IE / Edge 中不生效
:::
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

这是一个提示

这是一个警告

这是一个危险警告

See More

这是一个详情块,在 IE / Edge 中不生效

# tabs

:::: tabs

::: tab label=组件概览
这是tabA 展示的页面
:::

::: tab label=详细介绍
这是tabB 展示的页面
:::

::::
1
2
3
4
5
6
7
8
9
10
11

# steps

:::: steps

::: step
第一步  
第一步
:::

::: step
第二步  
第二步
:::

::: step
第三步  
第三步
:::

::: step
第四步  
第四步
:::

::::
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

第一步
第一步

第二个步
第二个步

第三步
第三步

第四步
第四步

上次更新: 11/1/2024