hi-frontend/docs/zh/admin/users/document.md
2025-12-11 03:29:07 +00:00

145 lines
2.7 KiB
Markdown

<div v-pre>
# 文档管理
创建和管理帮助文档,支持Markdown格式和标签分类。
## 表格列说明
### 显示 (Show)
开关按钮,控制文档是否在前台显示。
### 标题 (Title)
文档标题。
### 标签 (Tags)
文档分类标签,多个标签用逗号分隔。
### 更新时间 (Updated At)
最后更新时间。
## 表格操作
### 编辑
打开侧边抽屉表单修改文档。
### 删除
删除文档(需确认),不可恢复。
### 批量删除
选中多个文档后批量删除。
## 文档表单
### 标题 (必填)
文档标题。
### 标签 (必填)
文档分类标签,支持多个标签:
- 常用标签: 新手指南、使用教程、常见问题、技术支持
- 输入标签按回车添加
- 点击标签删除
### 内容 (必填)
文档正文,支持Markdown格式:
- 标题: # ## ### ####
- 粗体: **文字**
- 斜体: *文字*
- 代码块: ```语言
- 图片: ![alt](url)
- 链接: [文字](url)
- 列表: - 或 1.
- 引用: >
- 表格: | 列1 | 列2 |
## 筛选功能
### 关键词搜索
输入标题搜索文档。
### 标签筛选
输入标签查找对应分类文档。
## 使用场景
### 场景一: 创建新手指南
**表单配置**:
- 标题: 快速入门指南
- 标签: 新手指南, 使用教程
- 内容:
```markdown
# 快速入门指南
## 1. 注册账号
访问网站注册...
## 2. 购买套餐
进入订阅页面...
## 3. 下载客户端
支持的平台:
- Windows
- macOS
- Android
- iOS
```
- 显示: 开启
### 场景二: 创建FAQ
**表单配置**:
- 标题: 常见问题解答
- 标签: 常见问题, FAQ
- 内容:
```markdown
# 常见问题
## 如何重置密码?
答: 点击登录页面的"忘记密码"...
## 如何查看流量使用?
答: 登录后在个人中心查看...
## 订阅过期后怎么办?
答: 可以续费或购买新套餐...
```
- 显示: 开启
### 场景三: 创建平台教程
**表单配置**:
- 标题: Windows客户端使用教程
- 标签: 使用教程, Windows
- 内容:
```markdown
# Windows客户端教程
## 下载安装
1. 下载客户端
2. 运行安装程序
3. 完成安装
## 配置订阅
1. 复制订阅链接
2. 打开客户端
3. 导入订阅
## 连接服务
选择节点后点击连接即可
```
- 显示: 开启
## 重要提示
1. **Markdown支持**: 内容支持完整Markdown语法
2. **标签管理**: 合理使用标签便于用户查找
3. **显示控制**: 可先创建后再开启显示
4. **图片链接**: 图片使用外链地址
5. **代码高亮**: 代码块支持语法高亮
6. **批量操作**: 可批量删除过时文档
7. **搜索优化**: 标题和标签会被搜索索引
8. **更新提示**: 修改后更新时间会变化
</div>