スポンサーリンク

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

スポンサーリンク
Git
スポンサーリンク

スポンサーリンク

概要

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

gitbookを使ってドキュメントを生成する
概要GitBookを使ってドキュメントを生成するまでをやってみました。なお、この記事で紹介しているのはgitbook-cliであり、クラウドサービスのGitBookはこちら↓を見て下さい。どんなものができるのかこんなドキュメント...

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

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

インストール

npm i gitbook-plugin-expand-active-chapter

設定

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

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

参考

gitbook-plugin-expand-active-chapter
Expand as the user step through the chapters.

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

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

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

インストール

npm i gitbook-plugin-prism

参考

gitbook-plugin-prism
Prism highlighting for gitbook

ツリービュー

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

インストール

npm i gitbook-plugin-page-treeview

設定

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

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

参考

gitbook-plugin-page-treeview
a gitbook plugin for generating a treeview of each page

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

or

 $ sudo yum install graphviz

表示

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

```uml
@startuml

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

@enduml
```

参考

vowstar/gitbook-plugin-uml
PlantUml plugin of gitbook which can draw UML graph in both markdown HTML and PDF - vowstar/gitbook-plugin-uml
シンプルなテキストファイルで UML が書ける、オープンソースのツール
シンプルなテキストファイルから UML ダイアグラムを作成することができます。作ることのできるダイアグラムには、多くの種類があります。それらは、PNG、LaTeX、EPS、SVG などの画像でエクスポートできます。
Gitbook-Plugin-Plantumlをgit cloneから利用できるようにする - Qiita
# Abstract wordで仕様書であったり設計書を書いてたけど, とってもいいツール((を見つけてしまったのでそちらへ移行した際にプラグインの一つが上手く動...

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"
	}
}

参考

Bandwidth/gitbook-plugin-custom-favicon
Add your own favicon to gitbook themes. Contribute to Bandwidth/gitbook-plugin-custom-favicon development by creating an account on GitHub.

ロゴ – 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;"
        }
    }
}

参考

matusnovak/gitbook-plugin-insert-logo
GitBook Plugin to insert logo image into the navigation above search input - matusnovak/gitbook-plugin-insert-logo
タイトルとURLをコピーしました