docdoc 是什么
docdoc 是一个文档静态生成与托管服务:同一条 docdoc 命令既是客户端(把 Markdown 目录构建成静态文档站),也是服务器(托管多个文档站并提供域名路由与自动 HTTPS)。
能做什么
- 把 Markdown 变成文档站:标题层级、表格、代码高亮、D2 图表、站内搜索、上一页/下一页导航开箱即用,无需编写任何前端代码
- 本地实时预览:保存源文件后站点自动重建,浏览器刷新即可看到最新效果
- 一站托管多份文档:单个服务器托管任意数量站点,按域名或路径前缀访问
- 发布即上线:一条命令把本地目录或 git 仓库注册到远程服务器
- 接口文档一体渲染:HTTP / NATS 接口页自动生成参数表格、TypeScript 视图与 Try 调试面板(写 API 参考时尤其顺手)
发行形态
docdoc 只有一个发行形态:同一 CLI 二进制身兼客户端与服务器。构建、预览、发布与托管都是同一条 docdoc 命令的子命令,不存在客户端版 / 服务器版之分,也没有两侧版本不匹配的问题。
- 查看版本:
docdoc --version - 服务器进程启动时同样在首行打印版本:
docdoc serve 0.1.0 监听 …
