為自己的成果寫一本GITBOOK

貢獻(xiàn)開源真的是一種快樂蝗柔,這與工作不同,我們可以無怨無悔的為解決一個(gè)BUG民泵,通宵熬夜癣丧,只希望自己寫的成果能給他人帶來方便,快樂洪灯,減少別人的煩惱坎缭。

REDUX 應(yīng)用框架ZORO是我第一個(gè)開源項(xiàng)目,我為此感到欣慰签钩,因?yàn)檫@也是我一直想要去做的事情,或多或少的為開源社區(qū)做貢獻(xiàn)

重該項(xiàng)目第一次提交


C04B473A-0A68-4794-9E2D-3F6B18D4C655.png

到現(xiàn)在2.*版本


image.png

已經(jīng)經(jīng)歷了126個(gè)大大小小的commit坏快, 15個(gè)版本迭代铅檩,不斷的在公司實(shí)際項(xiàng)目中使用,不斷的優(yōu)化莽鸿,現(xiàn)在已經(jīng)趨于穩(wěn)定昧旨,感謝有幸能得到使用者的3十幾個(gè)star,起初的每一個(gè)star都讓我倍感興奮祥得,因?yàn)檫@是一種認(rèn)可兔沃,也是我堅(jiān)持的動(dòng)力

今天我想為自己的這個(gè)成果寫一本書,同時(shí)也分享如何使用GITBOOK寫書

為了使用gitbook级及,我們首先安裝nodejs, git

下載地址: NODEJS官網(wǎng)乒疏,下載LTS版本的,直接安裝即可
下載地址: GIT下載地址 下載完成直接安裝即可

nodejs安裝完成后饮焦,系統(tǒng)就有了npm命令怕吴,接下來我們執(zhí)行命令安裝gitbook-cli

$ npm install -g gitbook-cli

接下來初始化我們的書籍

$ mkdir book
$ cd ./book
$ gitbook init

這時(shí)我們的book目錄下多出來了兩個(gè)文件

README.md 常用于寫書的前言
SUMMARY.md 用于寫書的目錄

接下來有了書籍窍侧,我們還需要一個(gè)圖形化管理界面,方便我們時(shí)時(shí)編輯查看內(nèi)容转绷,這里使用Typora

下載地址: Typora下載地址

下載完成打開Typora伟件,并且打開我們的book目錄,編寫相關(guān)的章節(jié)即可

以下是我已經(jīng)寫好的ZORO文檔

image.png

所有的內(nèi)容支持markdown語法议经,同簡(jiǎn)書一樣使用簡(jiǎn)單易懂

我們?nèi)绾尉帉懩夸浤?/p>

image.png

對(duì)應(yīng)的內(nèi)容如下:

# 目錄
* [前言](REDAME.md)
* [安裝](INSTALL.md)
* 教程
  * [快速開始](GUIDE/QUIKE_START.md)
  * [接入create-react-app](GUIDE/CREATE_REACT_APP.md)
 ...省略其他內(nèi)容

當(dāng)我們完成了書籍編寫斧账,我們?nèi)绾紊梢粋€(gè)網(wǎng)站呢,執(zhí)行如下命令

$ gitbook build

變會(huì)在book目錄下生成_book目錄

如果你想要臨時(shí)查看生成的網(wǎng)站效果可以執(zhí)行如下命令

$ gitbook serve

之后通過瀏覽器訪問http://localhost:4000即可查看煞肾,
該命令同時(shí)也具備build命令的功能咧织,會(huì)在book目錄下生成_book目錄

最后一起看看我完成的gitbook書吧https://faurewu.github.io/zoro/

每次寫完文章都覺得自己的文筆相當(dāng)?shù)牟睿偀o法完好表達(dá)自己的想法扯旷,感謝您的觀看

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末拯爽,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子钧忽,更是在濱河造成了極大的恐慌毯炮,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,277評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件耸黑,死亡現(xiàn)場(chǎng)離奇詭異桃煎,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)大刊,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門为迈,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人缺菌,你說我怎么就攤上這事葫辐。” “怎么了伴郁?”我有些...
    開封第一講書人閱讀 163,624評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵耿战,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我焊傅,道長(zhǎng)剂陡,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,356評(píng)論 1 293
  • 正文 為了忘掉前任狐胎,我火速辦了婚禮鸭栖,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘握巢。我一直安慰自己晕鹊,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,402評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著捏题,像睡著了一般玻褪。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上公荧,一...
    開封第一講書人閱讀 51,292評(píng)論 1 301
  • 那天嘹履,我揣著相機(jī)與錄音敏弃,去河邊找鬼姆吭。 笑死逞盆,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的绪钥。 我是一名探鬼主播灿里,決...
    沈念sama閱讀 40,135評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼程腹!你這毒婦竟也來了匣吊?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,992評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤寸潦,失蹤者是張志新(化名)和其女友劉穎色鸳,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體见转,經(jīng)...
    沈念sama閱讀 45,429評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡命雀,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,636評(píng)論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了斩箫。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片吏砂。...
    茶點(diǎn)故事閱讀 39,785評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖乘客,靈堂內(nèi)的尸體忽然破棺而出狐血,到底是詐尸還是另有隱情,我是刑警寧澤易核,帶...
    沈念sama閱讀 35,492評(píng)論 5 345
  • 正文 年R本政府宣布氛雪,位于F島的核電站,受9級(jí)特大地震影響耸成,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜浴鸿,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,092評(píng)論 3 328
  • 文/蒙蒙 一井氢、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧岳链,春花似錦花竞、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽零远。三九已至,卻和暖如春厌蔽,著一層夾襖步出監(jiān)牢的瞬間牵辣,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評(píng)論 1 269
  • 我被黑心中介騙來泰國打工奴饮, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留纬向,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,891評(píng)論 2 370
  • 正文 我出身青樓戴卜,卻偏偏與公主長(zhǎng)得像逾条,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子投剥,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,713評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • 概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)構(gòu)建漂亮?xí)拿?..
    輝這樣說閱讀 3,022評(píng)論 0 4
  • 本文詳細(xì)講解了 Gitbook 生成電子書的完整過程师脂,內(nèi)容包括:安裝、命令江锨、配置吃警、文檔結(jié)構(gòu)、生成電子書泳桦、部署汤徽。限于...
    靜默虛空閱讀 11,253評(píng)論 9 138
  • 最近遇到一些問題,就是團(tuán)隊(duì)中會(huì)有些伙伴踩得坑的收集問題或者有些較為復(fù)雜的業(yè)務(wù)需求文檔共享上成本較高灸撰,所以考慮弄...
    tobAlier閱讀 3,897評(píng)論 0 5
  • 轉(zhuǎn)載請(qǐng)注明出處浮毯,謝謝 初級(jí)(適合沒有編程基礎(chǔ)的童鞋看) 使用GitBook Editor 寫開源書籍 這個(gè)是git...
    全科閱讀 14,941評(píng)論 25 110
  • 有人說我總是一副冷冰冰的表情债蓝,不愛笑壳鹤。我的朋友對(duì)我的第一印象大多是這個(gè)人太高冷,不易親近饰迹,但熟悉之后就會(huì)一副神經(jīng)病...
    傾池凝芷閱讀 710評(píng)論 0 0