适合谁
适合的场景
| 场景 | 说明 |
|---|---|
| 团队自托管文档站 | 文档源码在自己手里,部署在自己的服务器或内网 |
| Markdown 写作流 | 内容以 Markdown 管理,随代码仓库评审与留痕 |
| API 参考 + 使用手册一体 | 接口页需要参数表 / 示例 / 在线调试面板 |
| 多站点统一托管 | 多个项目文档共用一个托管服务,域名或路径区分 |
不适合的场景
| 场景 | 原因 |
|---|---|
| 需要浏览器里在线编辑 | docdoc 是「写作 → 构建 → 发布」流,不含在线编辑器 |
| 需要评论 / 权限 / 工作流 | 站点是公开可读的静态内容,无账号体系 |
| 动态内容(数据库驱动) | 产物是纯静态页面,运行期不查询数据源 |
两种方式怎么选
| 对比 | 纯静态生成器(自行托管) | docdoc |
|---|---|---|
| 服务器 | 需要自己另配 Nginx 等 | 内置托管服务器,一键安装为系统服务 |
| HTTPS 证书 | 自行申请与续期 | 注册站点带域名即自动签发与续期 |
| 多站点管理 | 手工维护站点目录 | 注册表统一管理,命令行增删 |
| 写作约定 | 各自为政 | 内置目录组织 / 接口文档等开箱约定 |
