> For the complete documentation index, see [llms.txt](https://langozhang.gitbook.io/me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://langozhang.gitbook.io/me/tools/gitbook-bo-ke-gong-ju.md).

# GitBook博客工具

GitBook 是一个基于 Node.js 的命令行工具 (CLI) 和网络应用程序，用于构建精美的现代文档。它非常适合创建电子书、API 文档、用户手册、教程和其他任何形式的在线书籍或文档。

### **核心特性**

* **强大的 Markdown/AsciiDoc 支持:** GitBook 支持使用 Markdown 和 AsciiDoc 编写文档。 Markdown 简洁易懂，而 AsciiDoc 则更适合编写复杂文档。
* **结构化文档:** GitBook 允许你组织文档结构，创建章节、子章节等，方便用户浏览和导航。
* **主题定制:** GitBook 提供了灵活的主题定制功能。你可以选择内置主题，也可以创建自己的自定义主题，以满足你的品牌需求。
* **版本控制友好:** GitBook 旨在与 Git 集成。你可以将文档存储在 Git 仓库中，方便团队协作和版本控制。
* **插件支持:** GitBook 拥有丰富的插件生态系统。你可以使用插件来扩展 GitBook 的功能，例如添加数学公式支持、搜索功能、评论系统等。
* **静态站点生成:** GitBook 可以生成静态 HTML 站点，方便部署到任何 Web 服务器或 CDN。
* **在线托管 (GitBook.com):** GitBook 提供在线托管服务，你可以在 GitBook.com 上创建和托管你的文档。

### **GitBook 的使用方式**

GitBook 可以通过两种主要方式使用：

1. **命令行工具 (GitBook CLI):**

\* **安装:** `npm install -g gitbook-cli`

\* **创建书籍:** `gitbook init` (在当前目录创建书籍结构，包含 `README.md` 和 `SUMMARY.md` 文件)

\* **构建书籍:** `gitbook build` (将 Markdown/AsciiDoc 文件转换为静态 HTML 站点，默认输出到 `_book` 目录)

\* **本地预览:** `gitbook serve` (启动本地服务器，方便预览书籍)

\* `SUMMARY.md`: 用于定义书籍的目录结构。

1. **GitBook.com (在线平台):**

\* **创建账号:** 注册并登录 GitBook.com。

\* **创建空间 (Space):** 在 GitBook.com 上创建一个空间，用于存放你的文档。

\* **导入 Markdown:** 可以直接从 GitHub、GitLab 或 Bitbucket 导入 Markdown 文件。

\* **在线编辑:** 使用 GitBook 的在线编辑器编辑文档。

\* **发布:** 将文档发布到 GitBook.com 上，生成一个在线书籍。

### **GitBook 的优点**

* **易于使用:** GitBook 的 Markdown 语法简单易学，即使没有编程经验也能快速上手。
* **专业的外观:** GitBook 生成的文档外观精美，适合作为技术文档或在线书籍发布。
* **高度可定制:** GitBook 提供了丰富的主题和插件，可以满足各种定制需求。
* **版本控制友好:** GitBook 与 Git 集成，方便团队协作和版本控制。
* **免费使用:** GitBook 命令行工具是免费的，GitBook.com 提供免费套餐，满足基本需求。

### **GitBook 的缺点**

* **需要学习 Markdown/AsciiDoc 语法:** 虽然 Markdown 语法简单易学，但仍需要一定的学习成本。
* **复杂的插件配置:** 一些插件的配置可能比较复杂，需要一定的技术知识。
* **在线平台收费:** GitBook.com 的高级功能需要付费。
* **GitBook.com 平台的限制:** 使用 GitBook.com 时，你的文档需要公开或者需要订阅高级计划才能设置为私有。

#### **适用场景**

* **技术文档:** API 文档、用户手册、教程等。
* **在线书籍:** 电子书、教程书籍等。
* **团队知识库:** 团队内部的知识分享和文档管理。
* **个人博客:** 用于编写和发布博客文章。

#### **替代方案**

* **Read the Docs:** 专门用于生成 Sphinx 文档的平台。
* **Docusaurus:** Facebook 开发的文档生成工具，基于 React。
* **VuePress:** 基于 Vue.js 的静态站点生成器，适合构建文档和博客。
* **Jekyll:** Ruby 编写的静态站点生成器，广泛应用于博客和文档。
* **Sphinx:** Python 编写的文档生成工具，适合编写复杂的文档。

***

### **总结**

GitBook 是一个强大的文档工具，它易于使用、外观精美、高度可定制。如果你需要创建技术文档、在线书籍或团队知识库，GitBook 是一个不错的选择。你可以选择使用命令行工具进行本地构建，也可以使用 GitBook.com 在线平台进行托管和编辑。 在选择是否使用 GitBook 之前，请根据你的需求和预算考虑它的优缺点以及其他替代方案。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://langozhang.gitbook.io/me/tools/gitbook-bo-ke-gong-ju.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.