Honkit基础使用

HonKit 是一个基于 GitBook 的现代化文档工具，用于构建美观、高效的文档网站。以下是 HonKit 的基本使用方法，包括安装、初始化、编写、构建和发布文档。

1. 安装 HonKit

首先，确保你的系统已安装 Node.js（建议 v12 或更高版本），然后通过 npm 全局安装 HonKit：

npm install -g honkit

验证安装是否成功：

honkit --version

2. 初始化项目

创建一个新目录并初始化 HonKit 项目：

mkdir my-docs
cd my-docs
honkit init

这会生成默认的文档结构：

.
├── README.md       # 首页内容
├── SUMMARY.md     # 目录结构配置
└── book.json      # 项目配置（可选）

3. 配置文档结构

编辑 SUMMARY.md 定义目录和章节关系，例如：

# Summary

* [简介](README.md)
* [安装](installation.md)
* [使用指南]
    * [基础功能](guide/basic.md)
    * [高级功能](guide/advanced.md)

HonKit 会根据此文件自动生成导航菜单。

4. 编写文档

• 在对应的路径（如 installation.md、guide/basic.md）中编写 Markdown 文件。
• 支持 Markdown 语法、代码块、表格等，还支持 HonKit 扩展语法（如标签、提示框等）。

示例：

# 安装

使用 npm 安装 HonKit：

```bash
npm install -g honkit

注意：需要 Node.js 环境。

---


### **5. 本地预览**
启动本地服务器实时预览：
```bash
honkit serve

默认访问地址：http://localhost:4000。修改文件后会自动刷新。

6. 构建静态网站

生成静态 HTML 文件到 _book 目录：

honkit build

7. 发布文档

• GitHub Pages：将 _book 内容推送到 GitHub 仓库的 gh-pages 分支。
• Netlify/Vercel：直接关联包含 HonKit 项目的 Git 仓库。
• 手动部署：上传 _book 到任何静态网站托管服务。

8. 高级配置

在 book.json 中自定义主题、插件等：

{
  "title": "我的文档",
  "plugins": ["theme-default", "highlight"],
  "pluginsConfig": {
    "theme-default": {
      "showLevel": true
    }
  }
}

安装插件后需重新构建：

npm install honkit-plugin-xxx
honkit build

常用命令总结

注意事项

• HonKit 是 GitBook 的维护分支，API 和用法与 GitBook 类似。
• 如需更多功能（如 PDF 导出），需安装额外插件。

通过以上步骤，你可以快速搭建一个结构清晰的文档网站。详细配置参考 官方文档。