如何使用 gitbook cli工具

如何使用 gitbook cli工具

💡 原文中文,约1000字,阅读约需3分钟。
📝

内容提要

本文介绍使用 GitBook CLI 写书:通过 nvm 安装并切换到 Node 10,全局安装 gitbook-cli,再用 gitbook init demo-book 创建书籍项目,具体用法见官方文档。

🔎

延伸解读

Node 版本是 GitBook CLI 的关键前提

文章特别强调使用 GitBook CLI 前必须选择正确的 Node 版本,并推荐用 nvm 安装 Node 10。这是因为 GitBook CLI 对 Node 版本较敏感,新版本 Node 可能导致安装或运行失败。作者也提醒安装脚本可能过时,建议直接参考 nvm 官方链接,说明环境配置是使用该工具时最容易出问题的环节。

安装步骤简单,但官方文档才是使用核心

全文的安装流程只有三步:安装 nvm、下载并使用 Node 10、全局安装 gitbook-cli。作者并未展开 gitbook init 生成的文件含义和具体写作命令,而是直接推荐读者查看更详细的 GitBook 文档。这意味着本文更像是一份环境准备记录,真正学习 GitBook 用法还需依赖外部文档。

注意时效性:安装命令可能已过时

文章写于 2022 年 1 月 9 日,并明确提示 nvm 安装版本可能已经过时,如果距离书写时间过长,应直接访问官方链接获取最新安装方式。对于现在参考此文的读者,这意味着命令中的版本号和安装脚本地址不一定仍然适用,需要先确认当前环境与官方说明再操作。

❓

Q&A

使用 GitBook CLI 写书需要先安装什么?

需要先安装 nvm(Node 版本管理工具),然后通过 nvm 安装 Node 10 并切换使用。

如何安装 nvm?

可以参考官方链接 https://github.com/nvm-sh/nvm#install–update-script,使用命令:curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash。注意文章书写于 2022-01-09,版本可能已过时,建议直接查看官方链接。

如何下载并使用 Node 10?

使用命令:nvm install 10 下载 Node 10,然后使用 nvm use 10 切换到 Node 10。

如何全局安装 gitbook-cli?

使用命令:npm install -g gitbook-cli。

如何使用 gitbook cli 初始化一本书?

使用命令:gitbook init demo-book,即可创建书籍项目。

在哪里可以找到 GitBook CLI 的详细使用文档?

可以参考 https://chrisniael.gitbooks.io/gitbook-documentation/content/ 这个文档,它更具体地解释了如何使用。

🏷️

标签

➡️

继续阅读