Gitbook 基本安装

本文介绍 Gitbook 旧版命令行工具(Legacy CLI)的安装前置条件、安装步骤与版本校验方法,并补充当前在新版 Node.js 环境下的兼容性注意事项。Gitbook 的安装本质上是「准备 Node.js 运行时 → 通过 npm 安装 CLI → 校验版本」三步。

Gitbook 简介

README.mdSUMMARY.md 是 Gitbook 项目中最核心的两个文件。其中 README.md 是 Gitbook 官方规定的必需文件,SUMMARY.md 虽然是可选的,但几乎是实际项目里不可或缺的"目录骨架"——一本最简单的 Gitbook 至少需要 README.md,而只要章节多于一篇,通常都会配上 SUMMARY.md。它们在一本书中承担不同的作用。

GitBook 使用入门

GitBook 是一个基于 Node.js 的命令行工具(Command Line Interface, CLI),可使用 Git/GitHub 和 Markdown 来制作精美的电子书与技术文档。

本文是 GitBook 系列的开篇,面向第一次接触 GitBook 的读者,介绍它的定位、安装方式、目录结构和最常用的命令,帮助你从零搭出一本能在线阅读的电子书。后续章节会分别讲解项目结构命令行速览输出格式

Gitbook 输出为静态网站

Gitbook Legacy CLI 的默认输出形态是静态网站(一组纯 HTML/CSS/JavaScript 文件)。只要本地的 SUMMARY.mdbook.json 与各章节 Markdown 都已就绪,就可以用 CLI 自带的两条命令把它渲染成可以直接放到任意 Web 服务器上的静态站点。本文介绍这两种构建方式:gitbook serve(边预览边生成)与 gitbook build(只构建、不启动服务)。