原 Markdown文档发布为web网站工具之gitbook
Tags: 原创整理自网络gitbook发布网站Node.jsnpm
gitbook简介
借助 GitBook 可以将 MarkDown 类型的文档编辑成一本在线的html格式的开源电子书,方便随时随地查阅。
GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 和 Git 并无直接关联。
GitBook 生成电子书主要有三种方式:
gitbook-cli 命令行操作,简洁高效,适合从事软件开发的相关人员
gitbook-editor 编辑器操作,可视化编辑,适合无编程经验的文学创作者
gitbook.com 官网操作,在线编辑实时发布,适合无本地环境且科学上网的体验者
GitBook 支持输出多种文档格式:
静态站点:GitBook 默认输出该种格式,生成的静态站点可直接托管搭载 Github Pages 服务上;
PDF:需要安装 gitbook-pdf 依赖;
eBook:需要安装 ebook-convert;
单 HTML 网页:支持将内容输出为单页的 HTML,不过一般用在将电子书格式转换为 PDF 或 eBook 的中间过程;
JSON:一般用于电子书的调试或元数据提取。
安装部署gitbook
nvm:https://nvm.p6p.net/about.html
安装Node.js
Gitbook是一个基于Node.js命令行工具,所以需要先安装Node环境。
安装node环境,使用npm -v
命令查看系统是否有node.js,如果没有则进入node官网(http://nodejs.cn/) ,选择对应的操作系统后下载安装即可。
1 2 3 4 5 6 7 8 9 10 11 | # 安装 nvm(Node 版本管理器) curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash # 下载并安装 Node.js(可能需要重新启动终端) nvm install 10.24.1 # 验证环境中是否存在正确的 Node.js 版本 node -v # 应打印 `v10.24.1` # 验证环境中是否存在正确的 npm 版本 npm -v # 应打印 `6.14.12` |
安装Node也有个版本问题,太新的Node版本安装有可能会报错,会出现如下的错误
1 2 3 4 5 6 | C:\Users\Administrator\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287 if (cb) cb.apply(this, arguments) ^ TypeError: cb.apply is not a function at C:\Users\Administrator\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287:18 |
建议安装长期稳定版本,别装最新版,一是很可能会挂,二是不稳定。
我这里安装的是V10.24.1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | [root@lhrdb ~]# node -v v10.24.1 [root@lhrdb ~]# [root@lhrdb ~]# npm -v 6.14.18 [root@lhrdb ~]# [root@lhrdb ~]# which npm /usr/bin/npm [root@lhrdb ~]# which node /usr/bin/node [root@lhrdb ~]# ll /usr/bin/npm lrwxrwxrwx 1 root root 63 Mar 23 18:14 /usr/bin/npm -> /www/server/nodejs/v10.24.1/lib/node_modules/npm/bin/npm-cli.js [root@lhrdb ~]# ll /usr/bin/node lrwxrwxrwx 1 root root 36 Mar 23 18:14 /usr/bin/node -> /www/server/nodejs/v10.24.1/bin/node [root@lhrdb ~]# |
nodejs 镜像配置
nodejs 安装完成后,我们就可以开始安装 gitbook 了。但是在安装之前,我们还需要配置一下 nodejs 插件安装的下载镜像地址。因为默认的镜像地址是在国外,需要翻墙才可以访问,因此我们需要设置国内的镜像地址。国内的我推荐大家使用阿里巴巴的镜像地址 http://registry.npm.taobao.org 。执行下面的命令,进行配置。
1 | npm config set registry http://registry.npm.taobao.org |
除了上面的方法外,我们也可以在用户主目录下编辑 .npmrc 文件,添加一行 registry=http://registry.npm.taobao.org 保存就可以了。用户的主目录一般在 C:\Users\Administrator ,具体随你的操作系统系统盘而定。
安装gitbook-cli工具
使用npm install gitbook-cli -g
命令进行全局安装gitbook-cli工具,如果是mac系统则需要在该命令前加上sudo,否则会提示权限不足。
1 | npm install gitbook-cli -g --registry=https://registry.npmmirror.com |
使用gitbook -V
命令来查看gitbook-cli是否安装成功
第一次运行gitbook命令,会自动安装gitbook,因为刚才安装的是gitbook-cli,此时gitbook-cli会自动安装gitbook。