本文是所在公司,使用GitBook開發(fā)文檔中心的一些步驟恢准。
已脫敏戳气,僅作記錄。
前言
Modern book format and toolchain using Git and Markdown
這個(gè)工具鏈 (GitBook) 是一個(gè)使用 Git 和 Markdown 來構(gòu)建書籍的工具吸占。
基于 Node.js 的命令行工具晴叨,支持 Markdown 和 AsciiDoc 兩種語(yǔ)法格式,可以輸出 HTML矾屯、PDF兼蕊、eBook 等格式的電子書。
一件蚕、開發(fā)環(huán)境:安裝Node.js孙技、Git、GitBook
1排作、安裝Git
- 官網(wǎng):https://git-scm.com/downloads
- 安裝完成后牵啦,終端內(nèi)執(zhí)行
git --version
,驗(yàn)證是否安裝成功妄痪。
2哈雏、安裝Node.js
- 官網(wǎng):https://nodejs.org/en/
- 安裝完成后,終端內(nèi)執(zhí)行
node -v
、npm -v
裳瘪,驗(yàn)證是否安裝成功土浸。 - 若
npm -v
無反應(yīng),可參照:http://www.reibang.com/p/e86357cf99ea
3彭羹、(非必須)使用公司內(nèi)部npm包倉(cāng)庫(kù)
4黄伊、安裝GitBook
執(zhí)行npm install -g gitbook-cli
,若有網(wǎng)絡(luò)問題皆怕,執(zhí)行 tnpm install -g gitbook-cli
ps. 文件夾權(quán)限問題:chmod -R 777 文件名
二毅舆、開發(fā)步驟
1、Clone代碼
- 執(zhí)行命名
git clone 代碼地址
- 證書錯(cuò)誤的話可執(zhí)行
git config --global http.sslVerify false
2愈腾、啟動(dòng)GitBook(staffwifi)
- 執(zhí)行命令
gitbook serve
(啟動(dòng)本地預(yù)覽)憋活,命令執(zhí)行后,會(huì)對(duì) Markdown 文檔默認(rèn)轉(zhuǎn)換為 html 格式虱黄,訪問 http://localhost:4000悦即,即可看到開發(fā)的web頁(yè)面。
三橱乱、提交代碼到版本庫(kù)(officewifi)
- 1辜梳、在Pycharm控制臺(tái)執(zhí)行
gitbook build
,默認(rèn)將生成的靜態(tài)網(wǎng)站輸出到 _book 目錄 - 2泳叠、執(zhí)行命令
git add ./
或git add 文件名
(添加文件到暫存區(qū)) - 3作瞄、第一次時(shí)需要賬密:
git config --global user.email "xx@xx.com”
git config --global user.name "xx"
- 4、執(zhí)行命令
git commit -m “變更內(nèi)容文案”
(提交暫存區(qū)到倉(cāng)庫(kù)區(qū) ) - 5危纫、執(zhí)行命令
git push
(上傳本地指定分支到遠(yuǎn)程倉(cāng)庫(kù) )
四宗挥、發(fā)布代碼到Dev、Pro環(huán)境
1种蝶、登錄機(jī)器 ssh root@x.x.x.x -p 36000
契耿、密碼
2、進(jìn)入代碼目錄cd /data/release/document
3螃征、執(zhí)行命令 git pull
(取回遠(yuǎn)程倉(cāng)庫(kù)的變化搪桂,并與本地分支合并,需要賬密)
4盯滚、Dev踢械、Pro環(huán)境查看修改的內(nèi)容
Git常用命令.png