npm 包 gitbook-commander 使用教程

阅读时长 3 分钟读完

什么是 gitbook-commander?

gitbook-commander 是一个基于 Node.js 平台的 npm 包,可以帮助我们快速创建或管理 GitBook 项目。通过 gitbook-commander,我们可以快速的搭建 GitBook,进行本地预览、编译成静态网站,并选择合适的方式发布到指定的位置。

安装 gitbook-commander

在使用 gitbook-commander 之前,我们需要先安装它。打开终端窗口,执行以下命令:

让我们来一一解释这段命令:

  • npm install 命令用于安装 npm 包,-g 参数表示全局安装,也可以省略不写;
  • gitbook-commander 是要安装的 npm 包的名称。

如果您的网络比较慢,安装会需要一些时间,请耐心等待。

创建 GitBook 项目

创建基于官方模板的 GitBook 项目

执行以下命令:

  • [bookname] 是书籍的名称,可以替换成自己喜欢的名称。

如果执行成功,会在当前目录下创建一个名为 [bookname] 的文件夹,里面包含了 GitBook 的基本结构。

创建自定义模板的 GitBook 项目

如果您需要创建自定义模板的 GitBook 项目,可以使用以下命令:

这样就能创建一个包含自定义模板的 GitBook 项目了。

本地预览 GitBook

预览 GitBook

在 GitBook 项目根目录下,执行以下命令:

系统会自动启用本地服务器,之后可以在浏览器中通过 http://localhost:4000 访问预览页面。

预览 GitBook(带阅读器)

如果需要带阅读器地预览 GitBook,可以使用以下命令:

其中 --lr 表示带阅读器启动。

编译 GitBook 网站

在 GitBook 项目根目录下,执行以下命令:

执行完后,会在根目录下生成 _book 文件夹,里面包含了编译后的静态网站资源。

发布 GitBook

发布到 GitHub Pages

在 GitBook 项目根目录下,执行以下命令:

系统会将编译后的静态网站资源推送到 GitHub Pages,该书籍将被部署到 https://[username].github.io/[bookname]/ 上。

其中,[username] 是您的 GitHub 用户名,[bookname] 是您的 GitBook 名称。

发布到其他站点

如果您需要将 GitBook 发布到其他平台,可以考虑使用以下命令:

其中 [dist-folder] 是您需要部署到的目标文件夹。

总结

通过本文的介绍,我们了解了 gitbook-commander 的基本使用,包括创建 GitBook 项目、本地预览 GitBook、编译预览 GitBook、以及发布 GitBook 等操作,相信这能帮助您更加快速地创建和管理 GitBook 项目。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cc281e8991b448e63f1

纠错
反馈