本文出自 AWeiLoveAndroid的博客
熟悉git的朋友们,如果使用GitBook,一定会是最佳搭档。因为gitbook是最简洁的,你只要写好你的MD文档,然后用gitbook命令生成html相关文件,传到github即可浏览。或者你直接登陆gitbook,使用网页端编辑,然后也可以直接预览效果。下面讲解一下Gitbook如何制作文档。
命令行: npm install gitbook-cli -g
如图所示:
npm安装gitbook命令行
下载后的相关路径为:
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-asciidoc
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-html
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-markdown
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-fontsettings
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-highlight
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-livereload
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-lunr
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-search
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-sharing
C:\Users\Administrator\AppData\Roaming\npm-cache\gitbook-plugin-theme-default
在npm-cache\registry.npm.taobao.org
路径也有:
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-asciidoc
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-html
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-markdown
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-fontsettings
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-highlight
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\itbook-plugin-livereload
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-lunr
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-search
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-sharing
C:\Users\Administrator\AppData\Roaming\npm-cache\registry.npm.taobao.org\gitbook-plugin-theme-default
临时缓存路径(其中xxx换成电脑里面具体的数字字母组合即可):
C:\Users\Administrator\AppData\Local\Temp\tmp-xxxode_modules\gitbook\node_modules\
1.新建一个文件夹
mkdir gitbook-note
2.进入到文件夹
cd gitbook-note
3.进行初始化
gitbook init
初次初始化会安装GitBook, 这里下载的是GitBook-3.2.3,如果不访问外国网站非常慢。
初始化
访问外国网站之后,就很快了。如图:
git init命令行(必须访问外国网站)
gitbook init会自动生成两个文件README.md
和SUMMARY.md
:
readme内容
SUMMARY内容
运行命令行gitbook serve
,然后打开浏览器输入localhost:4000
。
网页中查看
我们运行命令行gitbook serve
,会生成文件夹_book
,打开会发现生成是的html等能被浏览器识别的文件,能够部署在服务器或者github中,可以直接上传到github。
修改目录:目录结构一定要用*
才可以,用其它的符号都不行。
修改目录
然后各自的文件夹里面写各自的章节内容就好了。
最后效果如图所示:
修改后的网页
项目根目录新建
GLOSSARY.md
,该文件用于词汇、术语列表(可选)。 示例:
## test
测试定义
新建
book.json
文件,里面可以存放一些自定义配置(该文件可选)。
常用的配置选项有:
常用设置
"plugins": ["expandable-chapters-small"]
开启可折叠目录插件配置
"pluginsConfig": {
"expandable-chapters-small":{}
}
安装和使用可折叠目录插件:(未安装的话,先配置这个,然后可以执行命令gitbook install
进行安装)
安装命令示意图如下:
安装可折叠目录插件
gitbook插件下载地址: https://plugins.gitbook.com/plugin/prism
1、使用
https://github.com/liushilive/gitbook-plugin-books/
出现的错误:
出现的错误
解决方案:
首先下载Katex,如图:
下载katex
如果还不行,就全局安装相应模块npm install -g books-cli
。会首先下载Chromium r609904
如果太慢,建议打开淘宝镜像下载:https://npm.taobao.org/mirrors/chromium-browser-snapshots/Win/609904/
下载到这个目录里面了:C:\Users\Administrator\AppData\Roaming\npm\node_modules\books-cli\node_modules\puppeteer.local-chromium\
2、安装过程出现的错误:ERROR: Failed to download Chromium r609904! Set "PUPPETEER_SKIP_CHROMIUM_DOWNLOAD" env variable to skip download.
解决方式:使用国内Chromium源:npm config set puppeteer_download_host=https://npm.taobao.org/mirrors
正常情况如图所示:
下载books-cli