天天看點

gitbook入門詳解gitbook入門詳解

在ata上面看了幾篇關于gitbook的文章,感覺都是适合之前已經了解過gitbook的同學來學習的,是跳躍式的,說得比較簡略,省略了中間的一部分步驟,這并不适合零基礎的新人,于是下面向新人詳細介紹gitbook。

說到gitbook,很容易聯想到git和github,那麼它們究竟有什麼關系呢?

其實就是java跟javascript的關系,或是雷鋒跟雷鋒塔的關系,也就是并沒有什麼關系。。。

gitbook 是一個基于 node.js 的指令行工具,使用 markdown 文法,可以把你的markdown檔案彙內建電子書,并提供pdf等多種格式輸出。你可以把gitbook生成的html釋出出來,就形成了一個簡單的靜态網站。gitbook還有一個同名的平台(gitbook.io),可以釋出和銷售電子書。

gitbook入門詳解gitbook入門詳解
gitbook入門詳解gitbook入門詳解

node的安裝

可以在終端輸入

檢視node的版本号 同樣輸入

檢視npm的版本号

如果以上步驟沒有出錯,接下來就可以安裝gitbook了。

gitbook的安裝

如果安裝失敗就多安裝幾次

初始化項目

建立目錄,切換到目錄下,執行:

會發現目錄下面多了2個檔案,readme.md和summary.md

readme.md 和 summary.md 是兩個必須檔案

readme.md 是對書籍的簡單介紹

summary.md 是書籍的目錄結構

summary.md目錄

gitbook入門詳解gitbook入門詳解

summary.md 是書籍的目錄結構,格式如上,每一行對應一個相應的檔案

gitbook init

gitbook入門詳解gitbook入門詳解

執行 gitbook init 會根據 summary.md 目錄生成對應的檔案夾和 md 檔案,每一個 md 檔案對應每一章節,每一章節的内容在對應的 md 檔案裡編輯。

如果想要新增章節,可以在 summary.md 裡面新增,然後執行 gitbook init 就會新增對應的 md 檔案,原有檔案不會變化;如果想要删除章節,在 summary.md 裡面删除,然後執行 gitbook init 想要删除的 md 檔案并不會删除,需要手動删除。

gitbook build

gitbook入門詳解gitbook入門詳解

gitbook build . ./output

//output為要輸出的目錄,不寫預設為_book目錄

執行 gitbook build 會根據 gitbook init 生成的 md 檔案生成對應的 html 檔案

gitbook serve

其他配置

建立book.json,可以做一些配置,比如标題,作者,指定readme檔案,關閉分享連結等。

<a href="https://www.gitbook.com/">gitbook項目官網</a>

<a href="https://github.com/gitbookio/gitbook">gitbook github位址</a>

<a href="http://help.demo.taobao.net/">demo平台幫助</a>

<a href="http://www.chengweiyang.cn/gitbook/customize/readme.html">個性化插件與釋出</a>

繼續閱讀