Docsbook
概览

核心概念

什么是工作区?

工作区 — 您的文档链接到单个 GitHub 仓库。

工作区包括：

  • 您的包含 Markdown 文件的仓库
  • 文档站点（地址和外观）
  • 设置（域名、翻译、样式）

它是如何工作的？

1. You create a Workspace from your GitHub repo
                    ↓
2. Docsbook reads markdown files from GitHub
                    ↓
3. Transforms them into a beautiful site
                    ↓
4. Site is available at: docsbook.io/{user}/{repo}
                    ↓
5. You update files in GitHub
                    ↓
6. Site updates automatically

站点结构

左侧面板 — 导航（侧边栏）

侧边栏由您仓库的文件结构构建而成：

docs/
├── README.md          → "Home"
├── getting-started.md → "Getting Started"
├── api/
│   ├── auth.md        → "API / Auth"
│   └── endpoints.md   → "API / Endpoints"
└── faq.md             → "FAQ"

显示为：

📘 Home
📄 Getting Started
📁 API
  └─ Auth
  └─ Endpoints
📄 FAQ

主要内容

中心区域显示所选markdown文件的内容。

特性：

  • 精美的格式化
  • 语法高亮
  • 表格和列表
  • 指向其他页面的链接

右侧面板 — 概览

右侧会自动从当前页面的标题构建目录。

Outline:
  - Installation
    - Requirements
    - Steps
  - Usage
  - Troubleshooting

点击标题 → 将页面滚动到它。

Float Widget — Control Widget

当您已登录并查看您自己的文档时，一个组件将出现在右下角。

谁能看到小部件?

  • ✅ 你 — 能看到你的小部件
  • ❌ 其他人 — 看不到它（仅在你的帐户上）

它显示什么?

┌─────────────────────────┐
│ 👤 alice               │
│ ✨ Premium             │
│ ⚙️ Settings            │
│ 🚪 Sign out            │
└─────────────────────────┘

您可以使用小部件做什么？

  1. 查看头像 — 点击以打开菜单
  2. 查看状态 — 免费或高级
  3. 打开设置 — 以更改域名、启用翻译
  4. 注销 — 退出登录

公共访问

您的文档对所有人开放。 即使仓库是私有的，文档也对所有人可见。

优势：

  • SEO 优化 (由 Google 索引)
  • 比纯 GitHub 更美观
  • 加载速度快
  • 移动设备友好
  • 全文搜索 (即将推出)

GitHub 同步

如何同步？

Docsbook 不使用 webhook。相反：

  1. 你在 GitHub 中更新文件
  2. 你访问文档站点
  3. Docsbook 检查 GitHub 是否有新内容
  4. 如果有更改 — 显示新版本

结果： 文档在你查看时始终保持最新。

什么是同步？

  • ✅ 新建 .md 文件
  • ✅ 文本更新
  • ✅ 文件删除
  • ✅ 文件重命名
  • ✅ 新建文件夹

什么是未同步的？

  • ❌ 代码注释
  • ❌ 提交历史
  • ❌ 分支信息
  • ❌ 其他格式 (.txt, .rst, 等等)

免费版与高级版

免费计划

  • ✅ 1 个公共仓库
  • ✅ GitHub 同步
  • ✅ SEO 优化
  • ✅ 美丽的设计
  • ✅ 移动设备友好
  • ❌ 自定义域名
  • ❌ 移除“Powered by Docsbook”
  • ❌ 翻译成其他语言

Premium ($29 one-time lifetime)

Get everything from Free, plus:

  • ✅ 无限制的仓库
  • ✅ 自定义域名 (docs.example.com)
  • ✅ 移除 "Powered by Docsbook" 徽章
  • ✅ 翻译成任何语言
  • ✅ 优先支持

如何开始？

准备好了吗？ 在 3 分钟内创建您的第一个工作区。

有疑问吗？ 查看 FAQ。

由...提供支持 Docsbook