Docsbook
概览

Docsbook 如何发布机器可以引用的文档

Docsbook 是一个文档平台,可将来自 GitHub 仓库、网站扫描或书面简介的 Markdown 发布为位于 docsbook.io/{owner}/{repo} 的实时网站。阅读本页面后,您可以决定 Docsbook 是否适合您的产品,以及您首先需要它完成的三项工作中的哪一项:触达搜索用户,为 AI 助手提供可以引用的关于您的事实,并衡量页面带来的成效。

大多数拥有产品、客户和广告预算的公司,仍然无法被 Google 或 AI 助手推荐,因为没有可供阅读的内容:现有内容已经过时、隐藏在登录墙后,或与产品不一致。Docsbook 会将已有的内容发布到机器能够读取的位置,并展示这些内容带来了多少读者。

您的代码仓库与已发布页面之间发生了什么#

阶段 Docsbook 的操作 您获得的结果
1. 连接源 读取 GitHub 代码仓库、扫描网站,或根据一句产品描述生成草稿 无需登录即可打开的草稿站点
2. 建立索引 解析 Markdown 和 frontmatter,提取标题、链接和元数据,构建可导航的图谱 全文搜索、每个页面的大纲,以及已解析的文件间链接
3. 发布 docsbook.io/{owner}/{repo} 提供网站服务,并在服务器端渲染 包含 sitemap、OpenGraph 和 JSON-LD 的公开 URL
4. 向机器开放 提供 llms.txt 和一个包含 309 个工具的 MCP 服务器 助手和代理可以读取您的文档,代理还可以编辑文档
5. 同步 访问网站时重新检查 GitHub,并重新为发生变化的内容建立索引 页面与代码仓库保持一致,无需构建步骤,也无需 CI 流水线
6. 衡量 记录页面浏览量、搜索、事件、反馈和 AI 使用情况 了解哪些页面被阅读,以及读者在哪些位置停止阅读的报告

触达:为客户提出的每个问题创建一个页面#

回答一个具体问题的文档页面比落地页更容易撰写,而且能在多年间持续获得搜索流量,因为这个问题不会过时。Docsbook 为每个页面提供独立的 URL、独立的标题和描述、在 sitemap.xml 中的独立条目,以及独立的 JSON-LD——因此,关于某个问题的页面可以针对该问题参与竞争,而不是被埋没在营销网站中。

Docsbook 会自动生成这些机器可读的信息层:元标签、sitemap.xml、OpenGraph、规范 URL,以及用于 FAQ 和 HowTo 内容的 JSON-LD。有关搜索引擎层面的内容,请参阅 SEO;有关生成式引擎层面的内容,请参阅 GEO

机器可读事实:助手会引用关于你的哪些内容#

推荐产品的 AI 助手会引用它能够轻松读取和验证的内容:价格、限制、产品不具备的功能,以及公司信息。如果你的文档没有说明某些内容,助手就会用竞争对手页面的内容来填补空白。Docsbook 在这里的作用是让这些事实变得易于读取——以服务器渲染的 HTML、llms.txt 以及 MCP 服务器的形式呈现。

以下三个面向共同完成这项工作:

  • llms.txt — 位于网站根目录的文档纯文本索引,供寻找此类索引的 AI 代理使用。请参阅 llms.txt
  • MCP 服务器 — 通过模型上下文协议提供 309 个工具,因此 Claude Code、Cursor 或 ChatGPT 可以读取和搜索你的页面,并将更改提交回去。请参阅 MCP 服务器
  • AEO 标记 — 根据你的 Markdown 生成 FAQPage、HowTo 和 speakable JSON-LD,用于答案框和语音助手。请参阅 AEO

分析:哪些页面被阅读,以及读者在哪里停止#

Docsbook 会记录文档中的每次页面浏览、搜索查询、反馈投票和跟踪事件,并按页面报告这些数据。这些数据可以回答文档网站营销人员所关心的问题:哪些页面无人访问、哪些搜索没有返回结果、读者在离开前阅读到什么程度,以及他们来自哪些国家和使用哪些语言。

通过事件、目标和漏斗,您可以标记一条贯穿文档的路径,并统计有多少读者完成了这条路径。有关所衡量内容的信息,请参阅 跟踪概览;有关事件目录,请参阅 事件

Docsbook 面向谁#

读者 他们购买的内容
创始人 他们的产品会出现在 ChatGPT、Perplexity 和 Google 对客户问题的回答中
营销人员 将文档作为一种渠道:在按钮之前即可看到转化,设定目标和漏斗,并标记无后续操作的页面
工程师或产品经理 几秒钟内将代码仓库转换为网站,GitHub 作为唯一事实来源,通过 Claude Code 使用 MCP,一键导出

Docsbook 不提供的功能#

Docsbook 不提供 SAML SSO、带有基于角色的访问控制的团队账户、SOC 2 Type II 报告或数据处理协议(DPA)——这四项都在合规路线图中,尚未推出。Docsbook 没有面向非技术作者的所见即所得编辑器:页面是 Markdown 文件,可在 Web 编辑器中、GitHub 中或由代理通过 MCP 进行编辑。有关当前的合规立场,请参阅 MCP 安全性

Docsbook 的运行基础#

Docsbook 是一个运行在 Vercel 上的 Next.js 16 和 React 19 应用,后端使用 Postgres(Neon)和 Redis,采用 Drizzle 作为 ORM,并由 Paddle 作为记录商户。Markdown 使用 unified、remark 和 rehype 进行解析,使用 Shiki 进行高亮,并通过 markdown-lsp 进行导航;markdown-lsp 是 Docsbook 的开源文档解析器。AI 调用通过 OpenRouter 路由,或者通过您自己的服务商密钥路由。

费用#

Docsbook 仅针对每个项目各自的余额计费以下四项,除此之外不收取任何费用:

  • 读者(AI 聊天) — 向文档读者提供的 AI 答案。
  • 管理员 & AI 代理 — 由您或已连接的代理启动的一次代理运行。
  • AI 翻译 — 将页面翻译成其他语言。
  • 语义索引 — 构建 AI 聊天检索所依据的嵌入。

托管、自定义域名及其 TLS 证书、读者、编辑者、GitHub 同步、全文搜索、品牌和分析均不计费。每个新项目都会获得 $1.00 的余额,并可在创建满 3 分钟后再领取 $5.00;之后的充值金额为 $20.00 至 $5,000.00。有关计费机制,请参阅价格;有关当前金额,请参阅 docsbook.io/pricing

后续步骤#

  • 快速开始 — 发布文档网站,从源代码到公开 URL
  • 概念 — 工作区、项目余额、索引以及本文中使用的其他术语
  • 使用场景 — 团队聘请文档服务来完成的工作
  • 常见问题 — 关于同步、隐私、数据所有权和计费的问题
发布网站并查看效果

草稿会在您登录前生成,因此您可以在做出任何承诺之前评估结果。

Updated

此页面对您有帮助吗?