gitbook 简易教程
最近开始整理自己这几年的 Android 学习笔记,用到了 gitbook 这个工具,记录一下使用方式。
安装
gitbook 是一个基于 Node.js 的命令行工具,所以要先安装 Node.js。
下载地址:https://nodejs.org/en/download/,安装也很简单。
然后使用 npm 命令安装 gitbook:
1 | npm install gitbook-cli -g |
查看下版本号:
1 | gitbook -V |
安装成功会出现版本号:
1 | CLI version: 2.3.2 |
使用
在文件夹下,使用命令
1 | gitbook init |
生成 README.md
和 SUMMARY.md
两个文件。
README
是对书籍的简单介绍; SUMMARY
是书籍的目录结构。
使用命令
1 | gitbook serve |
编译,在浏览器打开 http://localhost:4000 显示效果。
发布
我所有的笔记文件会放在 GitHub 上,这里说一下如何同步 GitHub 仓库到 gitbook,这样每次更新只需要推送到 GitHub 就行了。
在 gitbook 官网 使用 Github 账号注册登陆,创建一个新的 space:
点击左边的 Intergrations
按钮,选择 GitHub 同步:
然后会展示出你的所有 GitHub 仓库,选择需要同步的仓库。
这里选择从 GitHub 同步到 GitBook。
稍等片刻,就可以了。