GitBook 使用

介紹

GitBook是一個基於Node.js的命令行工具,可以使用 Github/Git和Markdown來製做精美的電子書,GitBook 並不是關 Git的教程。html

導出格式有PDF、HTML等,須要添加相應插件。node

官網:https://www.gitbook.comgit


安裝

安裝npm

從網站 https://nodejs.org/en/download/ 上下載並安裝github

npm -v

查看是否安裝成功。npm

安裝gitbook

npm install -g gitbook-cli
gitbook -V

查看是否安裝成功。編輯器

安裝GitBook Editor

這是官方的一個客戶端編輯器。能夠不安裝,直接在GitBook網站上編輯文檔也是能夠的。工具

下載地址:https://www.gitbook.com/editor網站

如今的版本是7.0.12,若是要切換到Markdown編輯器,右下角有個按鈕,點擊而後選擇「Edit Markdown」便可使用Markdown編輯器。若是是舊的版本,ui


使用

直接使用

在頁面上,直接點擊「+New Book」,根據提示便可建立一本書,而後就能夠進行編輯了。this

可用editor編輯,也能夠網站上直接編輯。

關聯GitHub

GitHub:先在上GitHub建立一個倉庫。

GitBook:而後在GitBook右上角的我的信息那裏,點擊「Account Settings」,在界面上選擇「GitHub」這個Tab,找到「Integration」選項卡,有一個按鈕「Install GitHub integration on this account」,點擊,選擇剛剛在GitHub建立的倉庫便可。

注意:後續若是還須要繼續作關聯,在GitHub網站的Setting中的「Intalled GitHub Apps」,對GitBook進行配置便可。

GitBook:建立一個新書,而後點擊setting,有一個GitHub選項卡,選擇關聯的GitHub倉庫便可。

如今就可用editor編輯,也能夠網站上直接編輯,還能夠用GitHub進行管理了。


文件結構

除了README.md,還須要SUMMARY.md這個文件,這個是書的結構,以下:

# Summary
* 第一章
    * [第一節](di-yi-zhang/di-yi-jie.md)
    * [第二節](di-yi-zhang/di-er-jie.md)
* 第二章
* 第三章

文件夾「di-yi-zhang」跟SUMMARY.md都在根目錄。

默認狀況下,若是是直接在網頁上編輯的,目錄跟文件名都會是拼音,固然能夠本身命名。


導出

導出HTML,會在_book文件夾下生成文件

gitbook build

若是是要導出PDF,ePub或者mobi格式的電子書時,須要安裝Calibre電子書閱讀/管理器和命令行工具,否則可能會報錯「EbookError: Error during ebook generation: 'ebook-convert'」。

導出PDF

gitbook pdf

其餘功能

https://chrisniael.gitbooks.io/gitbook-documentation/content/index.html

插件搜索地址:https://plugins.gitbook.com/

相關文章
相關標籤/搜索