安装gitbook-cli工具
npm install gitbook-cli -g
初始化一本书
gitbook init会在空项目中创建README.md和SUMMARY.md两个文件:
- README.md文件是项目的介绍文件。
- SUMMARY.md是gitbook书籍的目录。
mkdir book
cd book
//然后使用gitbook init来初始化一本书:
gitbook init
本地启动服务编写书籍
gitbook serve
文档打包
gitbook build . //命令来生成最终的项目
生成电子书
GitBook 可以生成一个网站,但也可以输出内容作为电子书(ePub,Mobi,PDF)
# Generate a PDF file
$ gitbook pdf ./ ./mybook.pdf
# Generate an ePub file
$ gitbook epub ./ ./mybook.epub
# Generate a Mobi file
$ gitbook mobi ./ ./mybook.mobi
项目部署到GitHub Pages
由于gitbook生成的项目跟文档的源码是两个部分,所以可以把文档放到master分支上,部署的网站放到gh-pages 分支。
- github上创建公共仓库
- 项目中添加.gitignore文件,忽略# 忽略gitbook生成的项目目录_book
- 提交代码到github代码仓库上
~ git init
~ git add .
~ git commit -m 'gitbook'
~ git remote add origin https://github.com/smileyqp/smileyqp.git //此处替换成自己的git仓库
~ git push -u origin master
为了部署方便,可以创建一个脚本文件deploy.sh,内容如下
#!/usr/bin/env sh
echo '开始执行命令'
# 生成静态文件
echo '执行命令:gitbook build .'
gitbook build .
# 进入生成的文件夹
echo "执行命令:cd ./_book
"
cd ./_book
# 初始化一个仓库,仅仅是做了一个初始化的操作,项目里的文件还没有被跟踪
echo "执行命令:git init
"
git init
# 保存所有的修改
echo "执行命令:git add -A"
git add -A
# 把修改的文件提交
echo "执行命令:commit -m 'deploy'"
git commit -m 'deploy'
# 如果发布到 https://<USERNAME>.github.io/<REPO>
echo "执行命令:git push -f https://github.com/smileyqp/smileyqp.git master:gh-pages"
git push -f https://github.com/smileyqp/smileyqp.git master:gh-pages
# 返回到上一次的工作目录
echo "回到刚才工作目录"
cd -
文件保存后,在终端执行如下命令开始把最终项推送到gh-pages分支:
bash deploy.sh
最后:gitbook简直不要太好用!最近打算用gitbook整理react native项目开发相关的东西!点击gitbook实例查看。