###通过NPM安装
安装 GitBook 的最好办法是通过 NPM。在终端提示符下,只需运行以下命令即可安装 GitBook:
1 | npm install gitbook-cli -g |
gitbook-cli是 GitBook 的一个命令行工具。它将自动安装所需版本的 GitBook 来构建一本书.
执行下面的命令,查看 GitBook 版本,以验证安装成功。
1 | gitbook -V |
###初始化
GitBook可以设置一个样板书:
1 | gitbook init // 安装时间有时候比较长 请耐心等待 |
如果您希望将书籍创建到一个新目录中,可以通过运行 gitbook init ./directory 这样做
###构建
使用下面的命令,会在项目的目录下生成一个 _book 目录,里面的内容为静态站点的资源文件:
1 | gitbook build |
###Debugging
您可以使用选项 –log=debug 和 –debug 来获取更好的错误消息(使用堆栈跟踪)。例如:
1 | gitbook build ./ --log=debug --debug |
###启动服务
使用下列命令会运行一个 web 服务, 通过 http://localhost:4000/ 可以预览书籍
1 | gitbook serve |
###GitBook 命令
列出 gitbook 所有的命令
1 | gitbook help |
生成静态网页
1 | gitbook build |
生成静态网页并运行服务器
1 | gitbook serve |
生成时指定gitbook的版本, 本地没有会先下载
1 | gitbook build --gitbook=2.0.1 |
列出本地所有的gitbook版本
1 | gitbook ls |
列出远程可用的gitbook版本
1 | gitbook ls-remote |
安装对应的gitbook版本
1 | gitbook fetch 标签/版本号 |
更新到gitbook的最新版本
1 | gitbook update |
卸载对应的gitbook版本
1 | gitbook uninstall 2.0.1 |
指定log的级别
1 | gitbook build --log=debug |
输出错误信息
1 | gitbook builid --debug |
###官方资源
Markdown基本语法
Gitbook Github