产品概览
docdoc 是一个文档静态生成与托管服务,交付形态为单一自包含的 CLI:docdoc 命令既是客户端工具,也是服务器进程(docdoc serve)。
核心能力
| 能力 | 说明 |
|---|---|
| 静态构建 | Markdown 目录树 → 纯静态 HTML,每个 .md 文件生成一个页面 |
| 页面外观 | 构建期将 Header / Footer / Sidebar / Minimap 拼接进每页 |
| 目录与全文搜索 | 构建期生成 tree.json 与全文索引,服务器按站点暴露查询接口 |
| 多站点托管 | 按域名(Host 头)与路径前缀(/:name/)双路由 |
| TLS | ACME HTTP-01 自动签发证书、到期自动续期、热加载 |
| 生命周期 | docdoc service 生成并管理 systemd 单元 |
工作原理
输入是 Markdown,输出是 HTML。所有动态能力(搜索、目录导航数据)都以构建期生成的静态产物为数据源,服务器只做静态文件托管与薄查询转发,运行期没有任何 Markdown 渲染。
设计原则
- 零外部组件:服务器进程不依赖外部数据库、消息中间件、缓存服务等任何组件;持久化只有站点产物目录与一个 JSON 注册表文件
- 单二进制:CLI 与 Server 合一,一次全局安装同时获得客户端与服务器
- 静态优先:内容在构建期固化,运行期无渲染开销,产物可直接整体迁移
