Docsify 文档使用说明

本文档说明如何在项目中管理和编辑 docsify 文档。

文档结构

public/docs/
├── index.html          # Docsify 入口文件
├── README.md           # 文档首页
├── _sidebar.md         # 侧边栏导航配置
├── device-dev.md       # 设备端开发文档
├── mobile-dev.md       # 移动端开发文档
├── backend-integrations.md  # 后台接入文档
├── capabilities.md     # 能力中心文档
├── api-reference.md    # API 参考文档
└── best-practices.md   # 最佳实践文档

如何编辑文档

1. 编辑现有文档

直接编辑 public/docs/ 目录下的 .md 文件即可。文档使用 Markdown 格式编写。

2. 添加新文档

在 public/docs/ 目录下创建新的 .md 文件
在 _sidebar.md 中添加导航链接

示例：

# 在 _sidebar.md 中添加
- 新文档
  - [章节1](new-doc.md#章节1)
  - [章节2](new-doc.md#章节2)

3. 修改侧边栏

编辑 public/docs/_sidebar.md 文件来修改侧边栏导航结构。

Markdown 语法

Docsify 支持标准 Markdown 语法，还支持一些扩展功能：

代码高亮

使用三个反引号包裹代码，并指定语言：

```javascript
const api = new SmartGlassesAPI()
```

表格

| 参数 | 类型 | 说明 |
|------|------|------|
| apiKey | string | API 密钥 |

链接

[链接文本](文档路径.md#锚点)

配置说明

文档配置在 public/docs/index.html 中的 window.$docsify 对象中：

name: 文档名称
loadSidebar: 是否加载侧边栏
subMaxLevel: 侧边栏最大层级
search: 搜索功能配置
pagination: 分页配置

访问文档

文档通过以下方式访问：

在 Vue 应用中：访问 /docs 路由
直接访问：访问 http://localhost:81/docs/index.html

插件说明

当前使用的 Docsify 插件：

搜索插件：支持全文搜索
分页插件：支持章节导航
代码高亮：支持多种编程语言

注意事项

文档文件必须放在 public/docs/ 目录下
修改文档后，刷新页面即可看到更新
侧边栏文件必须命名为 _sidebar.md
首页文件必须命名为 README.md

2.4 KiB Raw Blame History