gitbook 創(chuàng)建書籍

這里采用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ì)的方式席怪。


image.png
image.png

三料皇、創(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)目

image.png
image.png

添加跟github中的文檔項(xiàng)目的關(guān)聯(lián)


image.png
image.png

選擇同步的分支(以后github發(fā)布完成之后淌实,gitbook會自動的進(jìn)行部署缩搅,特別方便)<br />
image.png
image.png

等待一會兒就可以了<br />
image.png
image.png

五越败、編寫

上面的關(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 />
image.png
image.png

其中該url就是可以直接對外訪問的url奏司,以后就可以通過這個來進(jìn)行分享使用

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末乔询,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子韵洋,更是在濱河造成了極大的恐慌竿刁,老刑警劉巖,帶你破解...
    沈念sama閱讀 210,914評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件搪缨,死亡現(xiàn)場離奇詭異食拜,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)副编,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評論 2 383
  • 文/潘曉璐 我一進(jìn)店門负甸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人痹届,你說我怎么就攤上這事呻待。” “怎么了队腐?”我有些...
    開封第一講書人閱讀 156,531評論 0 345
  • 文/不壞的土叔 我叫張陵蚕捉,是天一觀的道長。 經(jīng)常有香客問我柴淘,道長迫淹,這世上最難降的妖魔是什么秘通? 我笑而不...
    開封第一講書人閱讀 56,309評論 1 282
  • 正文 為了忘掉前任,我火速辦了婚禮敛熬,結(jié)果婚禮上肺稀,老公的妹妹穿的比我還像新娘。我一直安慰自己应民,他們只是感情好话原,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,381評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著瑞妇,像睡著了一般稿静。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上辕狰,一...
    開封第一講書人閱讀 49,730評論 1 289
  • 那天改备,我揣著相機(jī)與錄音,去河邊找鬼蔓倍。 笑死悬钳,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的偶翅。 我是一名探鬼主播默勾,決...
    沈念sama閱讀 38,882評論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼聚谁!你這毒婦竟也來了母剥?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,643評論 0 266
  • 序言:老撾萬榮一對情侶失蹤形导,失蹤者是張志新(化名)和其女友劉穎环疼,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體朵耕,經(jīng)...
    沈念sama閱讀 44,095評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡炫隶,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,448評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了阎曹。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片伪阶。...
    茶點(diǎn)故事閱讀 38,566評論 1 339
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖处嫌,靈堂內(nèi)的尸體忽然破棺而出栅贴,到底是詐尸還是另有隱情,我是刑警寧澤熏迹,帶...
    沈念sama閱讀 34,253評論 4 328
  • 正文 年R本政府宣布筹误,位于F島的核電站,受9級特大地震影響癣缅,放射性物質(zhì)發(fā)生泄漏厨剪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,829評論 3 312
  • 文/蒙蒙 一友存、第九天 我趴在偏房一處隱蔽的房頂上張望祷膳。 院中可真熱鬧,春花似錦屡立、人聲如沸直晨。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽勇皇。三九已至,卻和暖如春焚刺,著一層夾襖步出監(jiān)牢的瞬間敛摘,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評論 1 264
  • 我被黑心中介騙來泰國打工乳愉, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留兄淫,地道東北人。 一個月前我還...
    沈念sama閱讀 46,248評論 2 360
  • 正文 我出身青樓蔓姚,卻偏偏與公主長得像捕虽,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子坡脐,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,440評論 2 348