美文网首页程序员
搭建gitbook文档中心服务(Linux环境)

搭建gitbook文档中心服务(Linux环境)

作者: 三余无梦_ | 来源:发表于2016-12-09 18:18 被阅读2965次

    思路

    搭建过程

    • 搭建基本环境
      • 安装Git
      • 安装Node.js和NPM
    • 安装Gitbook工具
    • 配置Gitbook与Jenkins自动部署

    搭建基本环境

    安装Git

    网上已有很多相关的教程,可参考:Linux下安装Git

    安装Node.js和NPM

    相关的包在官网下载速度慢,可在国内的镜像网站下载,如淘宝NPM镜像

    # 下载安装,安装包位置随意
    wget https://npm.taobao.org/mirrors/node/v7.2.1/node-v7.2.1-linux-x64.tar.gz
    tar zxvf node-v7.2.1-linux-x64.tar.gz
    cd node-v7.2.1-linux-x64
    # 命令设置全局,因为安装node自带npm,所以不需要安装
    sudo ln -s /home/apps/node-v7.2.1-linux-x64/bin/node /usr/local/bin/node
    sudo ln -s /home/apps/node-v7.2.1-linux-x64/bin/npm /usr/local/bin/npm
    # 查看安装版本
    node -v
    # 查看npm版本
    npm -v
    

    除了以上安装方式,还可以使用编译好的安装包或yum安装,不过yum安装的版本比较低,可参考:Linux下Nodejs安装(完整详细)

    安装Gitbook工具

    # 利用npm安装gitbook
    npm install gitbook-cli -g
    sudo ln -s /home/apps/node-v7.2.1-linux-x64/bin/gitbook /usr/local/bin/gitbook
    # 安装后查看版本
    gitbook -V
    

    以上的安装方式由于墙的原因,安装非常慢,所以推荐使用国内镜像方式安装,[淘宝NPM镜像][1]

    # 安装淘宝定制的cnpm来替代npm
    npm install -g cnpm --registry=https://registry.npm.taobao.org
    sudo ln -s /home/apps/node-v7.2.1-linux-x64/bin/cnpm /usr/local/bin/cnpm
    # 安装gitbook和以上方式一样,只需把npm修改为cnpm
    cnpm install gitbook-cli -g
    sudo ln -s /home/apps/node-v7.2.1-linux-x64/bin/gitbook /usr/local/bin/gitbook
    # 安装后查看版本,第一次查看时会进行初始化处理,需要等一段时间(挺久点,去干点其他事情吧)
    gitbook -V
    

    安装完成后,可使用gitbook搭建一个demo-web站点

    cd /home/apps/gitbook
    mkdir demo
    cd demo
    # 初始化之后会看到两个文件,README.md ,SUMMARY.md
    gitbook init
    # 生成静态站点,当前目录会生成_book目录,即web静态站点
    gitbook build ./
    # 启动web站点,默认浏览地址:http://localhost:4000
    gitbook serve ./
    

    配置Gitbook与Jenkins自动部署

    使用Gitbook提供的webhook功能,待文档更新时通知jenkins构建部署

    Jenkins搭建与使用,详情可参考:

    构建Jenkins-Job后,进入配置页面
    配置Git信息(需安装git插件)


    Paste_Image.png

    设置触发构建http地址信息


    Paste_Image.png

    按以上说明操作, 可添加验证令牌防止误访问,然后再拼接http地址,如:
    http://localhost:12000/jenkins/job/interfaceDoc/buildWithParameters?token=xxxxxx

    然后把以上http地址填到Gitbook服务即可

    Paste_Image.png

    相关文章

      网友评论

        本文标题:搭建gitbook文档中心服务(Linux环境)

        本文链接:https://www.haomeiwen.com/subject/wuosmttx.html