GiBbook實用配置以及插件使用

GitBook可以在您的計算機上用於構建本地書籍,,可以本地預覽

安裝gitbook

環境要求:
安裝GitBook,您的系統需要安裝NodeJS(推薦v4.0.0及以上版本)
NodeJS下載地址

使用npm安裝

安裝GitBook的最佳方法是通過NPM。在終端提示符(cmd命令行)下,只需執行以下命令即可安裝GitBook:

npm install gitbook-cli -g

gitbook-cli是一個在同一系統上安裝和使用多個版本的GitBook的實用程序。它將自動安裝所需版本的GitBook來構建一本書。
安裝成功後,執行gitbook -V查看版本信息。
至此,gitbook安裝成功

GitBook 基本使用

gitbook 的基本用法非常簡單,基本上就只有兩步:

  1. 執行gitbook init初始化書籍目錄
  2. 執行gitbook serve編譯書籍

下面將結合一個非常簡單的實例,來介紹 gitbook 的基本用法。

初始化 - gitbook init

  1. 首先,編輯文件內容
  2. 在書籍項目根目錄執行 gitbook init命令初始化文件夾,會自動生成兩個必要的文件README.mdSUMMARY.md(這兩個文件是GitBook製作電子書的必要文件)。
  • README.md: 書的介紹文字,如前言、簡介,在章節中也可做爲章節的簡介。
  • SUMMARY.md: 定製書籍的章節結構和順序。
  1. 我的文件目錄樹
    執行tree \f命令可以查看文件目錄(包含文件夾和文件)
    ├─GitBook.md
    ├─README.md
    ├─SUMMARY.md
    ├─chapter1
    │     ├─file1.md
    │     └─file2.md
    └─chapter2
          └─other.md
    
  2. 編輯目錄文件——SUMMARY.md
    目錄的語法如下:* [顯示的目錄名](文件夾/文件名#標題id)
    這裏的id有個規則,基本上是和標題名一致:
    • -/中文字體/數字/小寫字母格式不變
    • 大寫字母改成小寫
    • 大部分特殊符號直接省略不寫
    • 空格用符號-代替
    # Summary 示例目錄
    * [Introduction](README.md)
    * [GitBook](GitBook.md)
        * [安裝GitBook](GitBook.md)
        * [操作環境](GitBook.md#操作環境)
            * [NodeJs安裝](GitBook.md#nodejs安裝)
        * [初始化](GitBook.md#初始化)
        * [預覽](GitBook.md#預覽)
    * [文件一](chapter1/file1.md)
        * [個性化配置](chapter1/file1.md#個性化setting)
        * [插件](chapter1/file1.md#插件)
    * [文件二](chapter1/file2.md)
    * [其他](chapter2/other.md)
    

預覽書籍 - gitbook serve

書籍目錄結構創建完成以後,就可以執行gitbook serve命令來編譯和預覽書籍了。

  1. 編譯:命令行中執行gitbook serve
    gitbook serve命令實際上會首先調用gitbook build編譯書籍,完成以後會打開一個 web 服務器,監聽在本地的 4000 端口。
  2. 預覽:瀏覽器訪問 http://localhost:4000 如圖:

個性化使用 - GitBook插件

  1. 在書籍目錄下新增book.json文件,然後增加插件代碼。
    例如增加設置logo插件,在book.json中添加以下代碼:

    {
       "plugins": [ "insert-logo" ]
       "pluginsConfig": {
    	  "insert-logo": {
      	  "url": "images/logo.png",
          "style": "background: none; max-height: 30px; min-height: 30px"
         }
        }
    }
    
  2. 保存book.json,執行gitbook install安裝,或者執行npm install gitbook-plugin-insert-logo
    如果報錯說明json文件可能有語法問題
    兩種安裝方式介紹:

     1) 使用gitbook-cli 方式,即`gitbook install`,把`book.json`中所有的插件列表都安裝一遍,如果修改了插件的配置文件,會被覆蓋
     2) 使用NPM安裝,只是單獨安裝一個插件,不影響其他插件
    
  3. 執行gitbook serve預覽

  4. 其他插件:
    官方獲取插件地址:https://plugins.gitbook.com

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章