為自己的成果寫一本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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

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

友情鏈接更多精彩內(nèi)容