貢獻(xiàn)開源真的是一種快樂蝗柔,這與工作不同,我們可以無怨無悔的為解決一個(gè)BUG民泵,通宵熬夜癣丧,只希望自己寫的成果能給他人帶來方便,快樂洪灯,減少別人的煩惱坎缭。
REDUX 應(yīng)用框架ZORO是我第一個(gè)開源項(xiàng)目,我為此感到欣慰签钩,因?yàn)檫@也是我一直想要去做的事情,或多或少的為開源社區(qū)做貢獻(xiàn)
重該項(xiàng)目第一次提交
到現(xiàn)在2.*版本
已經(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文檔
所有的內(nèi)容支持markdown語法议经,同簡(jiǎn)書一樣使用簡(jiǎn)單易懂
我們?nèi)绾尉帉懩夸浤?/p>
對(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á)自己的想法扯旷,感謝您的觀看