用Gitbook快速搭建Wiki

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

⽤Gitbook快速搭建Wiki
本⽂展⽰如何⽤快速搭建⼀套wiki
必备环境
1、gitbook(如何安装gitbook⾃⾏百度)
2、nginx(或其他的能当作静态http服务器的)
3、gitlab(或者svn,需要能触发CI/CD的。

我这⾥只展⽰⽤gitlab的.gitlab-ci.yml配置CI/CD,svn可以⽤post-trigger)
⼀、创建git库
⼆、初始化gitbook⽬录(可以⽤gitbook init,这⾥我采⽤⼿动)
根⽬录分别创建3个⽂件book.json,README.md,SUMMARY.md
1. book.json(我给加⼊了⼀些常⽤插件),注意"Home": "/wiki",也可以不配
{
"gitbook": "3.x.x",
"title": "我的Wiki",
"description": "我的Wiki",
"author": "我的Wiki",
"language": "zh-hans",
"root": ".",
"links": {
"sidebar": {
"Home": "/wiki"
}
},
"plugins": ["chapter-fold","expandable-chapters","tbfed-pagefooter","prism", "-highlight", "splitter", "mermaid-gb3"], "pluginsConfig": {
"theme-default": {
"showLevel": true
},
"prism": {
"css": [
"prismjs/themes/prism-tomorrow.css"
]
},
"tbfed-pagefooter": {
"copyright": "Copyright &copy <a href='/wiki' target='_blank'>我的Wiki</a> 2019",
"modify_label": "修订时间:",
"modify_format": "YYYY-MM-DD HH:mm:ss"
}
}
}
2. README.md(md语法随便写点什么)
<center><font color=0099ff size=72 face="⿊体">随便写点什么Wiki</font></center>
3. SUMMARY.md
* [⾸页](README.md)
---
* 第⼀章
* [第⼀节](1.1.md)
* [第⼆节](1.2.md)
* [第⼀篇](1.2.1.md)
---
* 第⼆章
* [第⼀节](2.1.md)
* [第⼆节](2.2.md)
三、持续集成
1、在nginx所在的web服务器上clone这个git库(⽐⽅我的⽬录是/www/wiki)
2、编写.gitlab-ci.yml
stages:
- deploy
deploy_wiki:
stage: deploy
script:
- cd /www/wiki
- git pull
- gitbook install
- gitbook build
四、配置nginx(不会配置nginx的可以参考我之前发的⼏个配置模板)
1、在/etc/nginx/conf.d/default.conf中加⼊
# WIKI
location /wiki {
alias /www/wiki/_book/;
index index.html index.htm index.jsp;
}
2、nginx重载配置
nginx -s reload。

相关文档
最新文档