目录
- 引言
- 安装node.js
- 安装Gitbook
- 创建Gitbook项目
- 安装typora
- typora和Gitbook
- 推送Githup
- sourceTree
- 常见问题
- which gitbook
- Permission denied
- operation not permitted
- FileNotFoundError
引言
你是不是很想按照目录的方式整理自己的知识体系,那么 Gitbook是你的不二之选,它的安装非常简单,由于我工作用的是Mac电脑,因而,先出Mac版的安装教程。
Gitbook一般不是单独使用的,而是通过Gitbook+GitHub+typera+sourceTree
混合使用
安装node.js
-
GitBook 是一个基于 Node.js 的命令行工具,因而你首先安装node.js,这是node.js的官网:https://nodejs.org/zh-cn/
-
安装完node.js之后,使用 node -v来查看node版本
安装Gitbook
1. sudo npm install -g cnpm --registry=https://registry.npm.taobao.org2. sudo cnpm install -g gitbook-cli
创建Gitbook项目
创建目录
首先找一个目录,使用如下命令创建文件夹:
mkdir mygitbook
初始化数据
使用如下命令初始化数据:
gitbook init
这时会生成两个文件:一个是README.md文件;一个是SUMMARY.md文件,这是创建目录的文件:
启动gitbook服务
使用如下命令启动gitbook服务:
gitbook serve
安装typora
typora 是编写Markdown的软件,编写起来特别流畅,非常好用,他的官网地址:https://typora.io/
typora和Gitbook
-
打开安装好的typora
-
导入初始化好的Gitbook项目
- 新建Markdown文件
使用命令vim SUMMARY.md
创建文件,把创建好的文件名称,以相对路径的方式加入到SUMMARY文件中,如代码所示:
# 目录* [大纲](大纲.md)
* [基本语法](基本语法.md)* [整型](整形.md)* [浮点型](浮点数.md)
配置完成后,即可启动Gitbook项目:gitbook serve
推送Githup
创建仓库
如果你还没有注册Githup,需要注册GitHub,注册完之后,需要创建一个仓库,如图所示:
推送数据
创建完仓库,通过如下命令推送数据:
-
git init
-
git clone https://github.com/zhubaoya/javaCourse.git
-
git add .
-
git commit -m “初始化数据”
-
git push --set-upstream https://github.com/zhubaoya/javaCourse.git master
通过这些命令,可以把数据推送到Githup上,如图所示:
sourceTree
它是Githup免费版的客户端软件,可以实现创建仓库,拉取和推送数据,创建和合并分支,打开终端等。
官网地址是https://www.sourcetreeapp.com/
常见问题
which gitbook
which gitbook
可以查看Gitbook安装到哪里
Permission denied
网上其他人通过sudo npm install gitbook -g
这种方式安装,但它可能会安装失败,报出这样的错误:Permission denied
如果报出上面的错误,采用我上面的安装方式去安装Gitbook
operation not permitted
gitbook serve 启动会报出这样的错误:operation not permitted,因为我在Gitbook init初始化数据时,没有去创建文件夹,你只需要去创建文件夹,通过 cd 进入到该文件夹去初始化数据即可。
FileNotFoundError
README.md文件必须存在,否则会报错:FileNotFoundError: No “README” file (or is ignored)