GitBook安装部署实操手册
abp(net core)+easyui+efcore实现仓储管理系统——入库管理之一(三十七)
媒介
GitBook是一个基于Node.js的敕令行东西,可运用Git和Markdown来编写文档,赞誉太多,不再赘述。
Node.js
- 下载装置包
cd /tmp
wget https://nodejs.org/dist/v12.16.1/node-v12.16.1-linux-x64.tar.xz
- 解压装置包
tar xvf node-v12.16.1-linux-x64.tar.xz
- 装置
装置历程分为3步:挪动装置包解压目次至/user/local、为node、npm竖立软链接,以及删除装置包。
mv node-v12.16.1-linux-x64 /usr/local/
ln -s /usr/local/node-v12.16.1-linux-x64/bin/node /usr/bin/node
ln -s /usr/local/node-v12.16.1-linux-x64/bin/npm /usr/bin/npm
rm -rf rm -rf node-v12.16.1-linux-x64.tar.xz
GitBook
参考链接:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md
装置
npm install gitbook-cli -g
ln -s /usr/local/node-v12.16.1-linux-x64/bin/gitbook /usr/bin/gitbook
gitbook -V
gitbook-cli 是用于装置、运用多个差别版本GitBook的东西。运用GitBook时会自动装置须要的版本,比方:“gitbook -V”。
初始化
- GitLab建立项目,命名为“wiki”,内容为空,克隆至当地;
git clone ssh://git@git.intra.weibo.com:2222/dip/wiki.git
GitLab建立项目的目的仅仅为Markdown文件的版本掌握,不是必需选项,当地直接竖立目次也是能够的。
- 初始化示例
gitbook init wiki
- 预览
实行以下敕令:
cd wiki
gitbook serve
守候,看到以下信息:
Starting server ...
Serving book on http://localhost:4000
即能够经由过程浏览器接见预览结果,以下:
- 背景启动
mkdir -p /var/log/gitbook
gitbook serve >> /var/log/gitbook/serve.log 2>&1 &
目次构造
链接参考:https://github.com/GitbookIO/gitbook/blob/master/docs/structure.md
基础的目次构造,以下图:
book.json
用于存储设置信息(可选),简朴能够理解为设置文件,后续会触及。
README.md
用于形貌媒介/申明信息(必需),简朴能够理解为主页,根据Markdown花样编写即可。
SUMMARY.md
用于形貌章节列表(可选,发起必需),简朴能够理解为导航栏,接下来会引见。
SUMMARY.md
链接参数:https://github.com/GitbookIO/gitbook/blob/master/docs/pages.md
SUMMARY.md花样现实是一个链接列表。链接的称号就是章节的称号,链接的目的就是章节文件途径,以下图:
“Part I”示意“章节1”,“part1/README.md”示意“章节1对应的文件途径”;“Writing is nice”是“Part I”的子章节,“part1/writing.md”是相对应的文件途径;“GitBook is nice”与“Writing is nice”雷同。能够根据上述形貌的层级花样继承向下延展。我们能够运用目次 + 子目次的体式格局对章节文件举行归档。
插件
GitBook运用的插件及响应的设置须要经由过程 book.json指定,以下:
{
"plugins": [
"expandable-chapters-small",
"-lunr",
"-search",
"search-plus",
"-sharing",
"splitter",
"anchor-navigation-ex-toc",
"hide-element",
"insert-logo",
"code"
],
"pluginsConfig": {
"hide-element": {
"elements": [".gitbook-link"]
},
"insert-logo": {
"url": "/images/dip.png",
"style": "background: none; max-height: 120px; min-height: 120px"
}
}
}
设置文件的变动可能会致使GitBook历程重启或非常停止,如上述插件设置调解,假如响应的插件没有装置完成,就会致使历程停止,须要装置完成以后,再重新启动。
插件装置敕令:
gitbook install
- expandable-chapters-small
章节导航支撑多层目次,并设置箭头图标,点击箭头才完成收放目次。
- search-plus
高等搜刮,支撑中文,运用此插件,须要将默许的 lunr 和 search禁用掉,即“-lunr”和“-search”。
- sharing
分享插件,默许开启,禁用。
- splitter
扩大导航侧边栏,支撑宽度可调治。
- anchor-navigation-ex-toc
为文章增添锚点目次栏及回到顶部功用。
- hide-element
隐蔽元素,如:“Published with GitBook”。
- insert-logo
左边导航栏上方插进去Logo。
预览
团队合作
现在对GitBook相识有限,大抵谈下本身的主意:团队成员能够经由过程GitLab将“wiki”克隆至当地,建立本身各自的写作分支;编写完成且当地启动效劳测试一般以后,能够提交并兼并至Master。布置GitBook效劳的效劳器,布置Cron使命,定时Pull Master,坚持同步更新。
什么?接口中方法可以不是抽象的「JDK8接口新语法的深度思考」