GitBook 使用详解

时间:2022-04-29
本文章向大家介绍GitBook 使用详解,主要内容包括初始化、编写目录、插件、生成、插件列表、相关链接、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

GitBook 示例:https://github.com/yeasy/docker_practice

安装好 Node.js,运行以下命令安装 gitbook

$ npm install -g gitbook-cli

初始化

$ gitbook init

生成 SUMMARY.md README.md 文件

编写目录

编写 SUMMARY.md 文件,之后执行 gitbook init 生成空白的 *.md 文件。

也可以先写内容(*.md 文件),再增加到目录到 SUMMARY.md 文件中。

插件

编辑 book.json 文件,之后执行以下命令,安装插件。

$ gitbook install

生成

$ gitbook build

# 静态文件位于 _book 文件夹

插件列表

  • -sharing :自带风享
  • -highlight :自带代码高亮
  • -livereload :自带实时生成
  • tbfed-pagefooter@git+https://github.com/khs1994/gitbook-plugin-tbfed-pagefooter.git
  • prism :代码高亮
  • toggle-chapters :左侧折叠
  • expandable-chapters :左侧折叠
  • anchor-navigation-ex :目录、锚点
  • favicon :网站图标

相关链接