這里采用github和gitbook關(guān)聯(lián)的方式纹坐,文檔都放在github上面轧飞,平常上庫只需要將當(dāng)前的文檔上庫到github密任,然后gitbook會自動的生效。
一愕够、github中創(chuàng)建對應(yīng)倉庫的文檔庫
注意:github中的私有倉庫走贪,在gitbook中也會變成私有,因此如果向外部其他人看惑芭,盡量使用public倉庫
二坠狡、創(chuàng)建團(tuán)隊(duì)
目前一個團(tuán)隊(duì)內(nèi)部只能創(chuàng)建一個默認(rèn)的公共空間,因此如果想要發(fā)布多個倉庫文檔强衡,則可以采用創(chuàng)建多個團(tuán)隊(duì)的方式席怪。
三料皇、創(chuàng)建空間
<img src = "https://upload-images.jianshu.io/upload_images/2773022-d4688d1c34c54285.png&originHeight=480&originWidth=766&size=28041&status=done&width=383?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" size="180px">
四、創(chuàng)建項(xiàng)目
添加跟github中的文檔項(xiàng)目的關(guān)聯(lián)
五越败、編寫
上面的關(guān)聯(lián)完成之后,我們就可以歡快的在github中提交我們的文檔了硼瓣,那么文檔格式是什么呢究飞,這里就又用到了github了置谦。
1.安裝gitbook包
npm install gitbook-cli -g
注意:<br />如果沒有安裝npm,則先安裝:
brew install nodejs
2.測試是否安裝ok
gitbook -v
3.初始化gitbook
我們拉取github空倉庫到本地
git clone git@github.com:SimonAlong/Neo_doc.git
因?yàn)殛P(guān)聯(lián)了gitbook亿傅,因此該空倉庫中有這么兩個文件(README.md媒峡,SUMMARY.md)<br />readme.md就是首頁的markdown<br />summary.md就是對應(yīng)的左邊的目錄
4.編寫自己的目錄
要生成自己的做個章節(jié)那種樹形的目錄,我們可以通過gitbook中的命令執(zhí)行葵擎,但是該命令也支持讀取summary.md文件谅阿,我們先在目錄中編寫我們的目錄,然后調(diào)用如下命令酬滤,就可以直接生成目錄樹了
gitbook init
比如summary.md
* [簡介](README.md)
* [一签餐、類介紹](usageCls/README.md)
* [一個類](usageCls/oneClass.md)
* [兩種函數(shù)](usageCls/twoFun.md)
* [三種注解](usageCls/threeAnno.md)
* [二、匹配器](matcher/README.md)
* [values](matcher/values.md)
5.本地測試
當(dāng)將上面的子目錄中的文件都編寫完成盯串,則我們就可以發(fā)布了氯檐,我們?nèi)绻肟聪滦Ч敲淳涂梢赃M(jìn)行本地測試
gitbook serve
http://localhost:4000<br />執(zhí)行即可打開默認(rèn)端口4000体捏,想換端口可以采用
gitbook serve -p 8888 .
六冠摄、發(fā)布
當(dāng)將上面的都執(zhí)行完,直接推送到github即可几缭,然后就可以去查看我們的gitbook對應(yīng)的url了河泳,那么這個url在哪里呢,在這里<br />其中該url就是可以直接對外訪問的url奏司,以后就可以通過這個來進(jìn)行分享使用