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

思路

搭建过程

  • 搭建基本环境
    • 安装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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,263评论 25 707
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,713评论 6 342
  • 好久没看浪了 于是我冲了下马桶
    heim_dn阅读 157评论 0 0
  • 夜晚,从便利店拎了宵夜回酒店,已是八九点,一天的奔波下来很疲惫,朋友已躺在床上不想动,我决定还是去体验一下挂川当地...
    游荡在异想世界的恶魔阅读 116评论 1 0
  • 一、 活动目的: 1、通过活动,使学生知道父母长辈的关爱,知道长辈的辛苦,激发学生尊敬和爱护长辈,进一步加深对老人...
    轩昂瑶阅读 2,083评论 0 0