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

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

2019-06-056 min read

目次

  1. 概要
  2. 目次の折りたたみ---expand-active-chapter
  3. コードハイライト---gitbook-plugin-prism
  4. ツリービュー
  5. uml---gitbook-plugin-uml
  6. favicon---gitbook-plugin-custom-favicon
  7. ロゴ---gitbook-plugin-insert-logo

概要

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

or

$ 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

インストール

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

Tags
javascript(110)
node.js(54)
linux(54)
amazon%20aws(47)
typescript(45)
%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0(36)
%E7%94%BB%E5%83%8F%E5%87%A6%E7%90%86(30)
html5(29)
php(24)
centos(24)
python(22)
%E7%AB%B6%E6%8A%80%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0(21)
mac(21)
mysql(20)
canvas(19)
opencv(17)
%E9%9B%91%E8%AB%87(16)
docker(16)
wordpress(15)
atcoder(14)
apache(12)
%E6%A9%9F%E6%A2%B0%E5%AD%A6%E7%BF%92(12)
%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9(12)
amazon%20s3(12)
red%20hat(12)
prisma(12)
ubuntu(11)
github(10)
git(10)
vue.js(10)
%E7%94%BB%E5%83%8F%E5%87%A6%E7%90%86100%E6%9C%AC%E3%83%8E%E3%83%83%E3%82%AF(10)
mariadb(10)
react(9)
aws%20cdk(9)
css3(8)
%E5%8F%AF%E8%A6%96%E5%8C%96(8)
%E5%B0%8F%E3%83%8D%E3%82%BF(8)
nestjs(8)
amazon%20lightsail(7)
next.js(7)
%E3%83%96%E3%83%AD%E3%82%B0(6)
cms(6)
oracle(6)
perl(6)
gitlab(6)
iam(5)
amazon%20ec2(5)
%E8%B3%87%E6%A0%BC%E8%A9%A6%E9%A8%93(5)
aws%20amplify(5)
curl(4)
Author
githubzennqiita
ただの備忘録です。

※外部送信に関する公表事項