0%

Gitbook

写技术文档比较好的工具。

简介

Gitbook 是一个现代文本平台,可以用于技术团队发表技术文本或者 API。

安装

node.js 安装

gitbook-cli 是一个基于 node.js 的命令行工具,所以需要先安装 node.js。由于最新版本的 nodejs 运行 gitbook 会出现异常,建议使用 12.x.x 版本的。

Node.js 默认会安装 npm (包管理工具),安装命令执行如下:

1
npm install -g gitbook-cli  # 全局安装 gitbook-cli

使用

windows 10 需要安装

切换到项目目录下,执行如下命令:

1
2
3
4
# 创建文档目录
mkdir doc && cd doc
# 初始化文档
gitbook init