Gitbook中文教程

簡介

GitBook 是一個基於 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 來製作精美的電子書。GitBook支持輸出以下幾種文檔格式

• 靜態站點：GitBook默認輸出該種格式

• PDF：需要安裝gitbook-pdf依賴

• eBook：需要安裝ebook-convert

準備安裝

在使用GitBook 之前, 我們需要先安裝一些必須的工具，Node.js、GitBook、GitBook Editor、Git版本控制器。

Node.js

Node.js 是一個基於Chrome JavaScript 運行時建立的一個平臺， 用來方便地搭建快速的， 易於擴展的網絡應用· Node.js 藉助事件驅動， 非阻塞 I/O 模型變得輕量和高效， 非常適合 run across distributed devices 的 data-intensive 的實時應用。

1、win下安裝Node.js

直接到nodejs官網下載，簡單安裝即可，此處不再細述。

2、檢測是否安裝成功

node -v //顯示v4.1.1

GitBook

GitBook 是一個基於 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 來製作精美的電子書。通過Node.js命令安裝GitBook

1、NMP安裝Gitbook

npm install gitbook -g

2、安裝gitbook CLI

想在系統上的任何地方的gitbook命令，需要安裝“gitbook CLI”，執行以下命令

//安裝命令
npm install -g gitbook-cli
//卸載命令
npm uninstall -g gitbook

3、檢驗下是否安裝成功

gitbook -V //顯示0.4.2

Git

Git是一款免費、開源的分佈式版本控制系統，用於敏捷高效地處理任何或小或大的項目。基本安裝請點擊安裝教程。如果不需要從GitHub更新書到本地再編譯，則可以不安裝Git。

GitBookEditor

GitBook官方客戶端編輯器，支持Win、Linux、Mac系統。請點擊下載GitBookEditor。使用該編輯器可以快速的創建、編輯GitBook。安裝具有以下步驟：

• 解壓下載包 gitbook-editor-4.2.1-windows-ia32.zip

• 運行GitBook Editor Setup.exe進行默認安裝

基本使用

GitBook 大致分爲兩種使用方式，即離線和在線。最簡單的使用方式是使用GitBook Editor編輯GitBook ，然後使用相關命令編譯成功HTML。當然還有以下幾種方式

• 使用命令創建基本GitBook

• 使用網頁在線編輯器創建、編輯GitBook。

• 使用itBookEditor客戶端創建、編輯GitBook。

gitBookEditor

使用客戶端方式，支持在線和本地兩種方式創建、編輯GitBook，再執行相關命令編譯成HTML，這種方式比較方便，推薦使用。以本地創建書籍爲例

1、gitBookEditor客戶端基本使用

2、使用命令對已經創建的Book進行編譯

找到需要編譯的書籍所在目錄，執行gitbook serve 命令,在本電腦的默認路徑爲C:UsersQGYGitBookLibraryImportgitbooksimpletutorial，如圖所示

高級擴展

掌握了“基本使用”，但有時候想要gitBook更美觀，或者更符合我們自己的需求，則通過book.json配置進行自定義、以及安裝一些常用的插件等。

Book.json配置

GitBook 在編譯書籍的時候會讀取書籍源碼頂層目錄中的 book.js 或者 book.json，這裏以 book.json 爲例，參考 GitBook 文檔 可以知道，book.json 支持如下配置

{

    //樣式風格配置格式
    "styles": {
        "website": "styles/website.css",
        "ebook": "styles/ebook.css",
        "pdf": "styles/pdf.css",
        "mobi": "styles/mobi.css",
        "epub": "styles/epub.css"
     },

    //插件安裝配置格式

    "plugins": ["myplugin"],
    "pluginsConfig": {
        "myPlugin": {
            "message": "Hello World"
        }
     }    
}

自定義插件擴展

插件是擴展GitBook功能最好的方法。使得GitBook功能更加強大，例如，把數學公式顯示支持，跟蹤回訪使用谷歌解析，…以toggle-chapters插件爲例
toggle-chapters 插件的效果是默認只在目錄導航中顯示章的標題，而不會顯示小節的標題，點擊每一章或者每一節會顯示當前章或節的子目錄，如果有的話，但是同時會收起其它之前展開的章節。所以，個人認爲不是非常實用，因爲這樣子用戶不能快速跳轉到沒有展開的章節！

一、搜索、安裝插件方式

1、編輯器方式（沒成功）

2、通過GitHub方式

www.plugins.gitbook.com

3、node.js命令方式

• 默認安裝在以下路徑

C:\Users\QGY\AppData\Roaming\npm\node_modules

• 把插件文件夾複製到

npm install gitbook-plugin-toggle-chapters --save-dev

二、通過Book.json配置插件

"plugins": ["toggle-chapters"],
    "pluginsConfig": {
        "myPlugin": {
            "message": "Hello World"
        }
     }