gitbook基于Node.js,可以用来创建电子书,包括各种API文档、规范、指南等。不仅可以通过命令行来做,还支持在线制作、桌面客户端制作。
我在使用在线制作的时候,因为用的github账号,所以,需要翻墙。
本文主要是讲命令行制作。(以Mac电脑为例)
前提条件:安装了node.js;基本会使用npm、git
Node.js 下载地址:https://nodejs.org/zh-cn/
安装gitbook
- 全局安装
sudo npm install gitbook-cli -g
- sudo 使用管理员身份安装,需要输入电脑密码。
- -g 表示全局安装
- 全局安装:安装包会被下载到电脑特定的系统项目下,能够在所有目录下使用
- 本地安装:安装包会被下载到当前所在目录,比如,是在mygitbook目录下执行的命令,只能在当前目录下使用
-
安装完成后查看gitbook版本
gitbook --version
-
查看Mac下全局安装的时候,gitbook所在目录
which.png
which gitbook
-
更新gitbook
npm update gitbook-cli -g
-
卸载
sudo npm uninstall gitbook-cli -g
快速开始gitbook
- 创建并进入创建的目录 mygitbook(我的mygitbook是在work文件夹里面的)
mkdir mygitbook && cd mygitbook
- gitbook初始化
gitbook init
init.png
- gitbook init 只支持生成两级目录
- .md文件使用的是markdown语法
- 启动服务
gitbook serve
启动后,如果端口号不冲突,默认访问 http://localhost:4000 即可
serve.png
部署
- 至于如何将gitbook对应的git项目部署到线上,这个是后台的操作了。我不是很懂,期待有人能够录屏讲解
网友评论