gitbookで使えそうなプラグインを集めて見た

概要

gitbookで使えそうなプラグインを集めて見ました。なお、下記の内容はgitbookが導入されていることを前提としています。

https://tech-blog.s-yoshiki.com/2019/06/1254/

目次の折りたたみ - expand-active-chapter

目次の折りたたみができるプラグインです。

インストール

npm i gitbook-plugin-expand-active-chapter

設定

book.jsonに次のように記述します。

{
  "plugins": ["expand-active-chapter"]
}

参考

https://www.npmjs.com/package/gitbook-plugin-expand-active-chapter

コードハイライト - gitbook-plugin-prism

デフォルトのコードハイライトを無効にするとともに、オリジナルのスタイルを適用することができます。

この画像オリジナルのスタイルを適用したコードハイライトの一例です。

インストール

npm i gitbook-plugin-prism

参考

https://www.npmjs.com/package/gitbook-plugin-prism

ツリービュー

この画像のようにメニューをツリー構造で表示します。

インストール

npm i gitbook-plugin-page-treeview

設定

book.jsonに記述する設定の一例です。

{
  "plugins": [
    "page-treeview"
  ],
  "pluginsConfig": {
    "page-treeview": {
      "copyright": "Copyright © aleen42",
      "minHeaderCount": "2",
      "minHeaderDeep": "2"
    }
  }
}

参考

https://www.npmjs.com/package/gitbook-plugin-page-treeview

UML - gitbook-plugin-uml

gitbook-plugin-umlは UMLを作成するPlantUMLをgitbook上で表示するためのプラグインです。

インストール

gitbook-plugin-uml を npmでインストールします。

$ npm install gitbook-plugin-uml

book.json は次のように記述します。

{
  "plugins": ["uml"]
}

UMLにはオプションを加えることができ、次のように記述します。

"pluginsConfig": {
  "uml": {
    format: "png",
    nailgun: false
  }
}

Nailgun ? また、上記の作業を進める前提としてgraphvizのインストールが必要です。

Mac

$ brew install graphviz

Linux

$ sudo apt install graphviz

$ sudo yum install graphviz

表示

uml か puml でコードブロックとして囲みます。

@startuml

	Class Stage
	Class Timeout {
		+constructor:function(cfg)
		+timeout:function(ctx)
		+overdue:function(ctx)
		+stage: Stage
	}
 	Stage <|-- Timeout

@enduml

参考

https://github.com/vowstar/gitbook-plugin-uml

http://plantuml.com/ja/

https://qiita.com/tatsuya_oyanagi/items/db53157640d59572eac5

favicon - gitbook-plugin-custom-favicon

オリジナルのfaviconを利用するプラグイン

インストール

npm install gitbook-plugin-custom-favicon

設定

book.jsonに次のように記述します。 path/to/favicon.ico には置き換えたいfaviconのパスを記述します。

{
  "plugins": ["custom-favicon"],
  "pluginsConfig": {
    "favicon": "path/to/favicon.ico"
  }
}

参考

https://github.com/Bandwidth/gitbook-plugin-custom-favicon

ロゴ - gitbook-plugin-insert-logo

インストール

npm i gitbook-plugin-insert-logo

設定

book.jsonに次のように記述します。 urlの部分はbase64にすることも可能です。

{
  "plugins": ["insert-logo", "another plugin 1", "another plugin 2"],
  "pluginsConfig": {
    "insert-logo": {
      "url": "http://www.example.com/my-logo.png",
      "style": "background: none;"
    }
  }
}

参考

https://github.com/matusnovak/gitbook-plugin-insert-logo