返回介绍

Gitbook 安装

发布于 2023-06-02 09:38:36 字数 3401 浏览 0 评论 0 收藏 0

本地安装

环境要求

安装 GitBook 是很简单的。您的系统只需要满足这两个要求:

  • NodeJS(推荐使用v4.0.0及以上版本)
  • Windows,Linux,Unix 或 Mac OS X

通过NPM安装

安装 GitBook 的最好办法是通过 NPM。在终端提示符下,只需运行以下命令即可安装 GitBook:

$ npm install gitbook-cli -g

gitbook-cli 是 GitBook 的一个命令行工具。它将自动安装所需版本的 GitBook 来构建一本书。

执行下面的命令,查看 GitBook 版本,以验证安装成功。

$ gitbook -V

安装历史版本

gitbook-cli 可以轻松下载并安装其他版本的GitBook来测试您的书籍:

$ gitbook fetch beta

使用 gitbook ls-remote 会列举可以下载的版本。

创建一本书

初始化

GitBook可以设置一个样板书:

$ gitbook init

如果您希望将书籍创建到一个新目录中,可以通过运行 gitbook init ./directory 这样做。

构建

使用下面的命令,会在项目的目录下生成一个 _book 目录,里面的内容为静态站点的资源文件:

$ gitbook build
Debugging

您可以使用选项 --log=debug--debug 来获取更好的错误消息(使用堆栈跟踪)。例如:

$ gitbook build ./ --log=debug --debug

启动服务

使用下列命令会运行一个 web 服务, 通过 http://localhost:4000/ 可以预览书籍

$ gitbook serve

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文