GitBook安装是很简单的,只需要执行几条命令就可以
gitbook 安装
GitBook安装是很简单的,只需要执行几条命令就可以,因为 GitBook 是基于 Node.js,所以我们首先需要安装 Node.js,找到系统对应最新且稳定的版本,直接照着官方文档既可
安装要求
- NodeJS(推荐v4.0.0及以上版本)
- Windows,Linux,Unix或Mac OS X.
检验是NodeJS否安装成功
1 | node -v |
成功的话,会输出node安装版本号
使用NPM安装
安装GitBook
的最佳方法是通过NPM,NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,在终端提示符下,只需运行以下命令即可安装GitBook:
1 | $ npm install gitbook-cli -g |
gitbook-cli是一个在同一系统上安装和使用多个版本的GitBook的实用程序。它将自动安装所需版本的GitBook来构建一本书。
创建一本书
GitBook初始化
1 | $ gitbook init |
初始化完成后,会在当前目录下生产两个文件,README.md 和 SUMMARY.md
- SUMMARY.md 显示你的目录结构
- README.md 展示文章用的具体内容
如果您希望将书籍创建到新目录中,可以通过运行命令
1 | $ gitbook init ./directory |
预览电子书
1 | $ gitbook serve |
执行完成后,会在目录中生成一个 _book
文件夹,这个文件夹就是gitbook生成静态文件夹,可以在浏览器直接显示,在页面上看到的内容就是文件夹中的内容
让后直接输入 http://localhost:4000 直接访问,看到如下界面,一个基本的gitbook就搭建好了
或使用以下方法构建静态网站:
1 | $ gitbook build |
安装预发布版
gitbook-cli
使您可以轻松下载和安装其他版本的GitBook来测试您的书:
1 | $ gitbook fetch beta |
出可供安装远程版本
1 | $ gitbook fetch beta |
调试
您可以使用这些选项--log=debug
并--debug
获得更好的错误消息(使用堆栈跟踪)。例如:
1 | $ gitbook build ./ --log=debug --debug |