Gitbook的使用紀錄

Gitbook提供了能夠將markdown格式轉寫成一本電子書的樣子

本地端執行

安裝方式，用 npm 安裝

1

npm install -g gitbook-cli

使用方式

找一個資料夾，執行

1

gitbook init

會產生

• reamdme.md
  • 介紹本書內容
• summary.md
  • 用來定義gitbook目錄

summary.md 結構

1
2
3

* ch1
  * ch1-1
  * ch1-2

檔案結構的話就長這樣

1
2
3
4
5

- ch1
|- ch1-1
|- ch1-2
-readme.md
-summary.md

運行gitbook

1

gitbook serve

預設會運行在 localhost:4000

安裝Plugin

事先安裝gitbook-plugin套件

1

npm install gitbook-plugin

若要安裝留言板等套件，需要先定義 book.json ，可以定義使用的plugin

book.json

1
2
3
4
5
6
7
8

{
  "plugins": ["disqus"],
  "pluginsConfig": {
    "disqus": {
      "shortName": "你的留言板名稱"
    }
  }
}

例如可使用 Google Analytics ( Google 分析 )、Disqus ( 社群&留言板 ) 和 youtube …等外掛，也可以在Gitbook npm網站中找到自己要的plugin

定義玩使用的plungin外掛，請執行

1

gitbook install

Disqus留言板

1

npm i gitbook-plugin-disqus

1
2
3
4
5
6
7
8

{
  "plugins": ["disqus"],
  "pluginsConfig": {
    "disqus": {
      "shortName": "你的留言板名稱"
    }
  }
}

內容綱要 InTopic TOC

如果要實現右邊側邊欄本頁md檔案的階層式，可安裝 InTopic TOC

GitBook plugin: InTopic TOC

於book.json中定義

1
2
3
4
5
6
7
8
9
10

{
  "plugins": [
    "intopic-toc"
  ],
  "pluginsConfig": {
    "intopic-toc": {
      "label": "In this article"
    }
  }
}

接著執行

1

gitbook install

參考

Gitbook Github Docs

Gitbook Online Platform Docs

用 GitBook 來寫本書吧

• ← Previous Post
• Next Post →