文档中心使用指南
欢迎使用本平台的文档中心,本文将详细介绍文档的创建、编辑、管理和美化等核心操作。
1. 文档基础操作
1.1 新建文档
在文档中心首页点击「新建文档」按钮,支持以下类型:
- 空白文档:从零开始编写 Markdown 内容
- 模板文档:基于预设模板快速创建(如接口文档、操作手册)
- 导入文档:支持导入
.md/.docx/.txt格式文件
1.2 文档命名规范
为保证文档可检索、易管理,命名需遵循以下规则:
| 规范项 | 要求 | 示例 |
|---|---|---|
| 命名格式 | 小写字母 + 短横线分隔,无空格/特殊字符 | api-user-login.md |
| 层级标识 | 多级目录用 / 分隔 | guide/operation.md |
| 版本标识 | 可选,用 _v2 标识版本 | config_v2.md |
1.3 保存与备份
- 自动保存:编辑过程中每 30 秒自动保存一次
- 手动保存:点击右上角「保存」按钮(快捷键
Ctrl+S) - 版本回溯:支持查看近 30 天的编辑历史,可一键恢复指定版本
2. Markdown 核心语法
2.1 基础格式
掌握以下核心语法,满足 90% 的文档编写需求:
快速记忆
语法以「标记符号 + 内容」组成,结尾无需额外符号,换行即可生效
| 语法类型 | 示例代码 | 效果说明 |
|---|---|---|
| 标题 | # 一级标题 ## 二级标题 | 最多支持 6 级标题,层级清晰 |
| 文本样式 | **加粗** *斜体* ~~删除线~~ | 突出关键信息 |
| 列表 | - 无序列表 1. 有序列表 | 梳理步骤/选项 |
| 链接 | [腾讯文档](https://docs.qq.com) | 跳转至外部/内部文档 |
| 图片 |  | 展示本地/网络图片 |
2.2 代码块与高亮
支持多语言语法高亮,还可指定高亮行:
javascript
// 用户登录接口示例
const login = (username, password) => {
if (!username) return '用户名不能为空';
return `欢迎 ${username} 登录`;
};
console.log(login('admin', '123456'));