用Gitbook快速搭建Wiki

Posted 2021-03-17 mrblue

本文展示如何用Gitbook快速搭建一套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": "http://xxx.com/wiki"，也可以不配

{
    "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 &copy <a href=‘http://xxx.com/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

 

五、看效果浏览器打开 http://{nginx_server_ip}/wiki