gitbook Mac配置与使用

791 阅读2分钟

做一个备份 demo.kujiajia.xyz/%E7%8E%AF%E… www.jianshu.com/p/0388d8bb4… www.cnblogs.com/phyger/p/14…

配置

直接下载node v10的版本(高了不行,gitbook已经不再维护了,无法兼容高版本的node

这里自动会顺便安装npm(node包管理工具)

  • 查看版本(检查是否安装成功) node -v

npm -v

  • 安装gitbook包 npm install -g gitbook-cli

如果出现path error问题,检查文件夹写入权限

初次使用(使用github)

  • 在 github 上新建一个仓库Repository

  • 创建一个文件夹,并进入到该文件夹中, 执行下面命令 gitbook init

  • 转化成项目,方便插件 npm init

命令会提示输入项目信息,可默认不填写,直接回车。 初始化成功后,系统会自动在当前目录创建package.json文件,这是npm项目的配置文件。

  • 启动项目 在package.json文件的scripts中配置如下的脚本命令:
"scripts”:{
"serve":"gitbook serve",
"build":"gitbook build" 
}

分别是gitbook在本地启动的命令,和gitbook打包成HTML静态文件的命令。

  • 忽略文件 .bookignore(自己新建文件在.git同一个目录下)
package.json 

package-lock.json 

.bookignore
  • 本地演示(每次演示都需要) npm run serve

这条命令其实就是执行了package.json文件的scripts中的serve脚本,即gitbook serve。 control c,终端卡死结束进程

  • 启动成功后,就可以在浏览器输入http://localhost:4000/来本地查看

  • github仓库里面的setting

image.png

  • 如果上一步生成网址打不开的话: 在本地环境中先将编译文档到docs目录

gitbook build . docs

发现两个文件夹一样,删除_book文件夹

  • 配置文件(自己新建文件在.git同一个目录下)

Gitbook在编译书籍的时候会读取书籍源码顶层目录中的book.js或者book.json

以下为book.js配置

module.exports = {
//书籍信息
title:'书名',
description:'描述', 
isbn:'图书编号', 
author:'作者',
lang:'zh-cn',
//插件列表
plugins:[],
//插件全局配置
pluginsConfig:{},
//模板变量
variables:{
//自定义
},
};

章节配置

GitBook使用文件SUMMARY.md来定义书本的章节和子章节的结构。文件SUMMARY.md被用来生成书本内容的预览表。