GitBookのプラグインの作成手順


GitBookでAmazonへのリンクを気軽に作りたくて「gitbook-plugin-amazon-jp-link
を作ってnpmで公開しました。すごく単純なスクリプトですが、ほぼ迷うことなくnpmへの公開できました。かなり簡単です。

ということで今回はgitbookのプラグインの作成手順を簡単にまとめておきます。


🍄 GitBook pluginについて

GitBook」はHTMLやPDF形式のシンプルな電子書籍を簡単に作成できるサービスです。
このサービス自体は非常にシンプルですので、簡単にpluginを作ってカスタマイズできることが魅力です。

🎳 pluginの開発方法について

まずは「GitBookIO/plugin」公式のプラグインのひな型を取得してきます。

git clone https://github.com/GitBookIO/plugin.git

次にpluginフォルダを今回のplugin名に変更します。

mv plugin gitbook-plugin-xxx

自分用のpluginなのでGitを初期化します。

cd gitbook-plugin-xxx
rm -rf git
git init

次に作りたいプラグインのタイプを決めて開発します。

  • Hook
    • 処理の前後にhookして、カスタマイズを行う
  • Block
    • カスタマイズしたブロックをテンプレートで書き込めるようにする
  • Filter
    • テンプレートの中で記入できる

おそらくそのほかもあると思いますが、知識不足で申し訳ない。

詳細は公式ドキュメントの『Plugins · GitBook Toolchain Documentation』が読みやすいのでぜひ参考にしてみてください。

🐮 ローカルで実行テスト

作成したpluginをローカルでテストするために「npm link の手順 / morizyun GitBook」を実行してください。

あとは、book.json側にプラグインの設定を追加。

{
"plugins": ["<プラグイン名>"]
}

これで gitbook server を実行するとローカルのプラグインをテストできます。

😎 npmへのpush

npmでpublishするのは次のコマンドです。

npm publish

たったこれだけでnpmに公開されます。ちょっとしたプラグインを作るのも簡単でJavaScriptのいい勉強になりそうです。

Happy Hacking!

📚 おすすめの書籍