安装GitBook
-
前提是已经安装了node环境, 没有安装的需要先安装node环境, 请另行参考文档。
-
安装完node之后, 最后给npm换淘宝源:
npm config set registry https://registry.npm.taobao.org/
, 速度会快点。 -
通过
npm install gitbook-cli -g
安装GitBook
。
使用GitBook
-
mkdir test_book && cd test_book
创建一个目录, 该目录用于保存一本书的内容。 -
gitbook init
初始化, 这时候会创建两个文件:README.md
和SUMMARY.md
。
-
使用命令
gitbook serve
启动服务, 浏览器输入http://127.0.0.1:4000
, 可以看到:
-
使用
gitbook build ./ docs
命令在当前目录下生成一个docs
文件夹,里面保存的是一些html
,css
,js
文件,这些文件对应刚刚看到的页面内容。
使用Github托管页面
- 新建一个项目, 填个仓库名和描述就行了。
- 创建成功后会跳转到页面, 如下
- 在之前创建的
test_book
文件夹中输入命令git init
初始化仓库。 - 然后通过
git remote add origin [email protected]:ClassmateLin/test_book.git
设置本地项目的远程仓库地址,这里对应你实际的内容。 - 然后依次执行:
git add docs
git commit -m "测试书籍"
git push --set-upstream origin master
-
回到刚刚
Github
完成项目创建的页面进行刷新, 如图:
-
点击
settings
按钮后跳转至:
-
然后往下来,找到
Github Pages
:
点击第二个内容, 页面会自动刷新。 -
再次回到
Github Pages
:
-
画横线的部分就是访问书籍的链接,效果:
写文章发布
上面没有提到如何写文章再发布, 这里提下:
SUMMARY.md
文件其作用是目录定义, 如将其内容改为:
# 目录
* [介绍](README.md)
* [章节1](chap1.md)
* [章节2](chap2.md)
* [章节3](chap3.md)
-
然后依次在其同级目录下创建:
chap1.md
,chap2.md
,chap3.md
文件,README.md
文件是原本存在的。- chap1.md内容:
章节1
- chap2.md内容:
章节2
- chap3.md内容:
章节3
-
写完内容后需要重新生成页面文件:
gitbook build ./ docs
。 -
更新内容到
Github
:git add .
,git commit -m '更新'
,git push
, 然后再访问书籍页面即可,会有一定延时。 -
Gitbook 支持多种插件, 可自行搜索相关教程进行添加。