概览

常见问题解答 (FAQ)

通用问题

Q: 什么是 Docsbook?

A: Docsbook 将您的 GitHub 文档转换为精美的网站,只需 5 秒钟。只需连接您的 GitHub 存储库,即可完成!


Q: 我需要付费才能开始使用吗?

A: 不需要!免费计划包括 1 个存储库、GitHub 同步和精美的设计。高级版(一次性 29 美元)添加了自定义域名、翻译等等。


Q: 我需要什么样的存储库?

A: 任何带有 Markdown 文件的公共 GitHub 存储库。这可以包括:

  • README.md
  • 项目文档
  • 说明
  • API 参考
  • 任何 Markdown 文件

Q: 是否支持私有 GitHub 存储库?

A: 目前仅支持公共存储库。私有存储库计划在未来推出。


Q: 我需要在 GitHub 中配置任何内容吗?

A: 不需要!只需通过 OAuth 连接您的帐户。Docsbook 将访问您的公共存储库。


用法

Q: 我如何更新我的文档?

A: 只需要更新 GitHub 上的文件 — 站点会自动同步。

  1. 编辑 .md 文件
  2. 提交到 GitHub
  3. 打开 Docsbook 站点
  4. 查看更新!

Q: 文档更新的速度有多快?

A: 非常快,在您下次访问时:

  1. 您访问该站点
  2. Docsbook 检查 GitHub 是否有新内容
  3. 显示最新版本

通常:立即。


Q: 为什么我的站点没有更新?

A: 检查:

  1. 提交是否实际在 GitHub 上?(在 github.com 上检查)
  2. 您是否刷新了浏览器?(Ctrl+F5)
  3. 是否过去了 1-2 分钟?
  4. 文件扩展名是否为 .md

Q: 我应该使用什么文件夹结构?

A: 任何!我们推荐:

repo/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api/
│   └── guides/

但是任何其他结构也适用。


Q: 我可以使用 .markdown 代替 .md 吗?

A: 是的,两种扩展名都适用。


Q: 文件之间的链接是否有效?

A: 是的!使用:

[Link](/zh/docs/path/to/file)
[Link to folder](/zh/docs/../folder/file)

它们会自动转换为正确的 URL。


Q: 关于图片呢?

A: 将它们放在一个文件夹中(例如,docs/images/)并引用它们:

![Description](https://raw.githubusercontent.com/docsbook-io/docs/main/./images/screenshot.png)

支持 PNG、JPG、GIF、WebP。


Q: 我可以使用 HTML 吗?

A: Markdown 支持 HTML,所以是的:

<div>Regular HTML</div>

但我们建议使用纯 Markdown。


访问 & 安全

Q: 谁可以看到我的文档?

A: 互联网上的所有人!您的站点完全公开。

  • 没有 GitHub 帐户的人
  • 搜索引擎机器人 (Google, Bing)
  • 任何人

这是预期的——您希望每个人都能看到您的文档。


Q: 这与私有 GitHub 仓库有什么关系?

A: 即使 GitHub 仓库是私有的,Docsbook 上的文档也是公开的。 这就是神奇之处! 😊

(私有仓库尚未支持)


Q: 我的文档安全吗?

A: 是的,使用 HTTPS (SSL) 和 Vercel CDN。


Q: 某人可以通过 Docsbook 编辑我的文档吗?

A: 不,这是不可能的。 编辑只能在 GitHub 中完成。


Q: 谁可以看到浮动小部件 (控制按钮)?

A: 只有您,当您登录时。 其他人只能看到文档。


Premium

Q: 什么是 Premium?

A: 一次性订阅($29)带有附加功能:

  • 无限仓库
  • 自定义域名
  • 隐藏“Powered by Docsbook”
  • 自动翻译

Q: Premium 多少钱?

A: $29 美元一次性,终身有效。前 100 名客户支付了 $19。


Q: 我如何付款?

A: 点击浮动小部件中的“升级到 Premium”→ 在 Stripe 表单中输入您的卡。

接受:Visa、Mastercard、AmEx、Apple Pay、Google Pay。


Q: 付款安全吗?

A: 是的,100%。付款由 Stripe(全球领先者)处理。Docsbook 从不看到您的卡号。


Q: 是否可以退款?

A: 是的,在最初 30 天内提供全额退款。联系 support@docsbook.io


Q: 价格会上涨吗?

A: 不,$29 是永久价格。您只需支付一次。


Q: 我可以为多个工作区购买 Premium 吗?

A: 是的,但您需要为每个工作区单独购买。价格实惠(每个工作区 $29)。


Q: 组织是否有折扣?

A: 联系 support@docsbook.io 以获取特别安排。


域名

Q: 如何使用我自己的域名?

A: 优质功能。指南:自定义域名设置

TL;DR:

  1. 在设置中输入域名
  2. 更新 DNS (添加 CNAME)
  3. 等待 30 分钟
  4. 完成!

Q: 根域名和子域名哪个更好?

A: 我们建议使用子域名:

✅ docs.example.com (recommended)
✅ example.com (also works)
✅ guide.example.com (multiple can be used)

Q: 我需要 SSL (HTTPS) 吗?

A: Docsbook 会通过 Let's Encrypt 自动设置它。免费且无需您采取任何操作。


Q: DNS 传播需要多长时间?

A: 通常 15-30 分钟,最多 48 小时。


翻译

Q: 如何翻译文档?

A: 高级功能。指南:翻译

TL;DR:

  1. 打开设置
  2. 选择语言
  3. 点击保存
  4. Docsbook 分钟内完成翻译

Q: 支持哪些语言?

A: 100+,包括:

  • 西班牙语,法语,德语
  • 俄语,中文,日语
  • 阿拉伯语,韩语,泰语
  • 等等

Q: AI 翻译质量如何?

A: 适用于技术文档。可能需要编辑以适应习语和文化参考。


Q: 当我更新文档时,翻译会更新吗?

A: 是的,会自动更新。


Q: 我可以编辑翻译吗?

A: 是的,您可以手动下载和编辑。联系 support@docsbook.io


支持 & 问题

Q: 如何联系支持?

A: 电子邮件:support@docsbook.io

高级客户享有优先权。


Q: 有 Docsbook 文档吗?

A: 是的,您正在阅读它!请参阅其他部分。


Q: 如果出现问题该怎么办?

A: 撰写邮件至 support@docsbook.io,并描述问题。


Q: 有状态页面吗?

A: 即将推出。关注 twitter.com/docsbook


技术问题

Q: Docsbook 是用什么构建的?

A: Next.js, React, Vercel, Stripe, GitHub API。


Q: 数据存储在哪里?

A: 存储在 Vercel (美国和其他国家/地区的服务器) 和 Neon Postgres。


Q: 使用了什么 Markdown 解析器?

A: Remark + Rehype。支持 GitHub Flavored Markdown (GFM)。


Q: 站内搜索是否可用?

A: 内置搜索即将推出。目前使用浏览器搜索 (Ctrl+F)。


Q: 是否有深色主题?

A: 即将推出。目前仅提供浅色主题。


Q: 它能处理多少并发访问者?

A: Vercel 会自动扩展。不用担心负载。


Q: 是否有服务条款?

A: 是的,请参阅 服务条款 (即将推出)。


Q: 隐私政策呢?

A: 是的,请参阅 隐私政策 (即将推出)。


Q: 如果我违反了规则会怎样?

A: 我们会联系您。通常我们会给您一次改正的机会。


找不到问题的答案?

写信至 support@docsbook.io — 我们很乐意提供帮助! 😊


下一步: