跳转至

2024

如何配置 GitBook-cli 环境

文档历史说明

本文档最早位于群文档,于 groupdocs@2ba4aaa 添加,作为编写参考。后因群文档迁移至 Docusaurus 而失去其原有作用,特此于 groupdocs@d1d1b43 迁出。

迁出后,本文档进行了 MkDocs 适配,并对一些问题进行更新。感谢 @鸽子 对此次更新的贡献。

本文档之目的为,在已有 GitBook 文档项目的前提下,通过 GitBook-cli 进行预览。文档假设您基本没有使用命令行的经验。

为什么要有这篇教程

GitBook-cli 是 CloudFlare Pages 构建时可以选择使用的框架之一。它是现在的 GitBook.com Platform 的前身,随开发重心转移而被搁置。

As the efforts of the GitBook team are focused on the GitBook.com platform, the CLI is no longer under active development.

在群文档的建设中,一般需要在推送更改后等待 CF Pages 更新,然后查看是否有 bug,将 bug 修复后再次提交并推送。这样很不方便,而且一次提交能解决的事情,为什么要两次提交解决呢?

后来,群文档将 GitBook-cli 使用的 Markdown 语法作为归档类文件添加,以期有所改善。但查看文档 (甚至是全英的文档),怎么能比得上自己用相同的框架打包一次来得快、准确和可靠呢?

因此,作为 groupdocs#21 的解决方案,我们将在本文中指导您如何安装 GitBook-cli,及如何利用它进行测试。

在下文中,我们就分别在 Termux 平台和 Windows 平台指导您安装它。