搭建gitbook文檔中心服務(wù)(Linux環(huán)境)

思路

搭建過程

  • 搭建基本環(huán)境
    • 安裝Git
    • 安裝Node.js和NPM
  • 安裝Gitbook工具
  • 配置Gitbook與Jenkins自動部署

搭建基本環(huán)境

安裝Git

網(wǎng)上已有很多相關(guān)的教程,可參考:Linux下安裝Git

安裝Node.js和NPM

相關(guān)的包在官網(wǎng)下載速度慢,可在國內(nèi)的鏡像網(wǎng)站下載,如淘寶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
# 命令設(shè)置全局,因為安裝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安裝(完整詳細(xì))

安裝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

以上的安裝方式由于墻的原因,安裝非常慢,所以推薦使用國內(nèi)鏡像方式安裝,[淘寶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
# 生成靜態(tài)站點,當(dāng)前目錄會生成_book目錄,即web靜態(tài)站點
gitbook build ./
# 啟動web站點,默認(rèn)瀏覽地址:http://localhost:4000
gitbook serve ./

配置Gitbook與Jenkins自動部署

使用Gitbook提供的webhook功能,待文檔更新時通知jenkins構(gòu)建部署

Jenkins搭建與使用,詳情可參考:

構(gòu)建Jenkins-Job后,進入配置頁面
配置Git信息(需安裝git插件)


Paste_Image.png

設(shè)置觸發(fā)構(gòu)建http地址信息


Paste_Image.png

按以上說明操作, 可添加驗證令牌防止誤訪問,然后再拼接http地址,如:
http://localhost:12000/jenkins/job/interfaceDoc/buildWithParameters?token=xxxxxx

然后把以上http地址填到Gitbook服務(wù)即可

Paste_Image.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 178,828評論 25 709
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,261評論 6 342
  • 好久沒看浪了 于是我沖了下馬桶
    heim_dn閱讀 182評論 0 0
  • 夜晚,從便利店拎了宵夜回酒店,已是八九點,一天的奔波下來很疲憊,朋友已躺在床上不想動,我決定還是去體驗一下掛川當(dāng)?shù)?..
    游蕩在異想世界的惡魔閱讀 162評論 1 0
  • 一、 活動目的: 1、通過活動,使學(xué)生知道父母長輩的關(guān)愛,知道長輩的辛苦,激發(fā)學(xué)生尊敬和愛護長輩,進一步加深對老人...
    軒昂瑤閱讀 2,145評論 0 0

友情鏈接更多精彩內(nèi)容