HonKit 项目教程

项目的目录结构及介绍

HonKit 项目的目录结构通常包含以下几个主要部分：

/honkit
├── book.json          # 项目的配置文件
├── README.md          # 项目介绍文件
├── SUMMARY.md         # 目录结构文件
├── _layouts           # 布局文件目录
├── _plugins           # 插件目录
├── _assets            # 静态资源目录
└── docs               # 生成的静态网站目录

• book.json: 项目的配置文件，包含项目的各种设置。
• README.md: 项目介绍文件，通常包含项目的基本信息和使用说明。
• SUMMARY.md: 目录结构文件，定义了书籍的章节和页面的组织结构。
• _layouts: 布局文件目录，包含页面的布局模板。
• _plugins: 插件目录，包含自定义插件。
• _assets: 静态资源目录，包含图片、CSS、JavaScript 等静态资源。
• docs: 生成的静态网站目录，包含最终生成的静态网站文件。

项目的启动文件介绍

HonKit 项目的启动文件主要是 book.json 和 SUMMARY.md。

• book.json: 这个文件包含了项目的配置信息，如标题、作者、描述、插件配置等。以下是一个示例：

{
  "title": "我的书籍",
  "author": "作者名",
  "description": "这是一本用 HonKit 制作的书籍。",
  "plugins": ["plugin-name"],
  "pluginsConfig": {
    "plugin-name": {
      "configKey": "configValue"
    }
  }
}

• SUMMARY.md: 这个文件定义了书籍的目录结构，通过 Markdown 列表的形式组织章节和页面。以下是一个示例：

# 目录

* [介绍](README.md)
* [第一章](chapter1/README.md)
  * [第一节](chapter1/section1.md)
  * [第二节](chapter1/section2.md)
* [第二章](chapter2/README.md)
  * [第一节](chapter2/section1.md)
  * [第二节](chapter2/section2.md)

项目的配置文件介绍

HonKit 项目的配置文件是 book.json，它包含了项目的各种配置选项。以下是一些常用的配置选项：

• title: 书籍的标题。
• author: 书籍的作者。
• description: 书籍的描述。
• language: 书籍的语言。
• plugins: 启用的插件列表。
• pluginsConfig: 插件的配置选项。
• links: 自定义链接，如侧边栏链接。
• variables: 自定义变量，可在书籍中使用。

以下是一个完整的 book.json 示例：

{
  "title": "我的书籍",
  "author": "作者名",
  "description": "这是一本用 HonKit 制作的书籍。",
  "language": "zh-hans",
  "plugins": ["plugin-name", "another-plugin"],
  "pluginsConfig": {
    "plugin-name": {
      "configKey": "configValue"
    },
    "another-plugin": {
      "anotherConfigKey": "anotherConfigValue"
    }
  },
  "links": {
    "sidebar": {
      "自定义链接": "https://example.com"
    }
  },
  "variables": {
    "customVariable": "自定义变量值"
  }
}

通过这些配置选项，可以灵活地定制书籍的外观和行为。