Docsbook
概览

快速入门:使用 Docsbook 发布文档网站

你将学到:如何将一个来源——GitHub 仓库、网站或产品描述——转化为一个已发布的 Docsbook 文档网站,并获得公开 URL、搜索索引和分析功能。

开始之前#

你需要准备以下所有内容:

  • 最新版本的 Chrome、Firefox、Safari 或 Edge。
  • 一个来源,且只能有一个:包含至少一个 .md 文件的 GitHub 仓库、公开网站 URL,或两句话描述你所销售的产品。
  • 在第 3 步登录所需的方式:GitHub 帐户、Google 帐户、Apple ID,或能够接收一次性验证码的电子邮件地址。

在第 3 步之前,你不需要信用卡、构建流程或帐户。

1
第 1 步 — 生成草稿
  1. 打开 docsbook.io/start
  2. 将你的来源粘贴到唯一的输入框中:网站 URL、GitHub 仓库链接或关于你产品的句子。Docsbook 会自行判断它属于哪种类型——无需选择类型。
  3. 等待 Docsbook 读取来源。每一步都会说明它读取了什么以及找到了什么。

预期结果:草稿网站会在其独立的管理面板中打开,其中包含页面数量、来源,以及品牌、布局和 SEO 的所有部分。此时尚未创建帐户。

2
第 2 步 — 打开并检查草稿
  1. 在管理面板中点击 打开,或直接点击预览。
  2. 像浏览真实文档网站一样浏览生成的页面——页眉、侧边栏树、目录、面包屑和上一页/下一页功能都可以正常使用。
  3. 使用面板中的 助手 修改措辞或询问有关网站的问题。在消息框中,交互模式会打开网站,并在旁边显示聊天窗口,同时每个区块都可以点击。

预期结果:你已经阅读了草稿,并了解它是否正确描述了你的产品。来自网站或想法的草稿在发布之前只存在于你的浏览器中。

3
第 3 步 — 登录以发布
  1. 在面板首页点击 发布此网站,或点击文档网站工具栏中的蓝色按钮。如果你尚未进行任何更改,按钮显示为 发布;如果你进行了更改,则显示为 保存更改;如果你通过认领链接进入,则显示为 认领所有权——这三个按钮执行的操作相同。
  2. 选择登录方式:GitHub、Google、Apple,或使用带一次性验证码的电子邮件。
  3. 完成登录流程。

预期结果:草稿会变成一个已上线的 Docsbook 项目,拥有公开地址、搜索索引和分析功能。你编写的内容不会被重新处理。

如果你的网站来自 GitHub 仓库,而你使用 Google、Apple 或电子邮件登录,Docsbook 还会要求你授权 GitHub 访问权限——它会通过该授权读取仓库文件。

4
第 4 步 — 打开已发布的网站
  1. 打开 Docsbook 显示给你的地址。它遵循以下格式。
docsbook.io/{owner}/{repo}
  1. 使用页眉中的搜索框,或按 Cmd+K(Windows 和 Linux 上按 Ctrl+K),搜索你某个页面中的短语。

预期结果:页面会通过公开 URL 加载,搜索会返回你的短语,并且无需登录即可阅读网站。

你现在拥有的内容#

你已经拥有一个已发布的文档网站:一个公开 URL、全文搜索、一个 sitemap.xml、供 AI 代理使用的 llms.txt,以及从第一位访问者开始记录页面浏览量的分析功能。基于 GitHub 仓库构建的网站会在访问时重新检查仓库,因此推送到 GitHub 后无需构建步骤即可更新页面。

后续步骤#

发布您的第一个网站

粘贴一个代码仓库、网站 URL,或用一句话介绍您的产品,然后在登录前阅读草稿。

此页面对您有帮助吗?