用gitbook搭建Wiki
本文參考這篇博客,同時記錄一下安裝過程遇到的問題。
環境
1、gitbook(1.安裝node,2.安裝gitbook)
2、nginx(安裝教程)
3、gitlab(用gitlab的.gitlab-ci.yml配置CI/CD,配置教程)
過程
1. 創建 git 倉庫
2. 進入倉庫並使用gitbook init
初始化目錄。也可以手動初始化,在根目錄創建文件 book.json
,README.md
,SUMMARY.md
。
book.json
如下,添加了一些常用插件
{
"gitbook": "3.x.x",
"title": "我的Wiki",
"description": "我的Wiki",
"author": "我的Wiki",
"language": "zh-hans",
"root": ".",
"links": {
"sidebar": {
"Home": "http://xxx.com/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 © <a href='http://xxx.com/wiki' target='_blank'>我的Wiki</a> 2019",
"modify_label": "修訂時間:",
"modify_format": "YYYY-MM-DD HH:mm:ss"
}
}
}
README.md
就首頁
<center><font color=0099ff size=72 face="黑體">隨便寫點什麼Wiki</font></center>
SUMMARY.md
是目錄
* [首頁](README.md)
---
* 第一章
* [第一節](1.1.md)
* [第二節](1.2.md)
* [第一篇](1.2.1.md)
---
* 第二章
* [第一節](2.1.md)
* [第二節](2.2.md)
3. 配置持續集成
在nginx所在的服務器中clone倉庫
編寫.gitlab-ci.yml
stages:
- deploy
deploy_wiki:
stage: deploy
script:
- cd /www/wiki
- git pull
- gitbook install
- gitbook build
配置nginx
在/etc/nginx/conf.d/default.conf中加入
# WIKI
location /wiki {
alias /www/wiki/_book/;
index index.html index.htm index.jsp;
}
nginx重載配置
nginx -s reload