Docpad Pluginを簡単に作れるYeoman Generatorを作った

docpad, plugin, yeoman

docpad

DocPadというプロダクトをご存知でしょうか?
いわゆる静的サイトジェネレータの一種で、JekyllやOctopressと同レイヤーのプロダクトに当たります。
nodeを使用していて、大量のプラグインが既に存在し、様々なスケルトンや言語を用いることができます。
今回はこのDocPadのPluginのひな形を作るGeneratorを作成しました。

レポジトリはこちらです。

インストール

通常のgeneratorと同じようにnpmでインストールします。

1
npm install -g generator-docpad-plugin

以前の投稿で触れたように、Yeomanのgeneratorはgenerator-なんちゃらの名前になっています。

使い方

1
2
3
mkdir docpad-plguin-yourplugin
cd !$
yo docpad-plugin

上記コマンドを実行すると、yourpluginがプラグイン名として認識されます。
DocPadのプラグイン名はdocpad-plugin-なんちゃらと決まっていて、かつなんちゃらの部分はハイフン等記号を入れないことが推奨されているようです。

以上でサンプルのプラグインが生成されるはずです。
あとは自由に改変してプラグインを作っていきましょう。

作った理由

余談ですが、作った理由についてです。
DocPadはJekyllのようにブログに特化しているわけではないので、ブログ用のコマンドは用意されていません。
幸いDocPadのコマンドはプラグインによって拡張できるので、DocPadプラグイン作成に挑戦。。したかったのですが、そもそもPluginの作り方がよくわからない。

モチベーションがあるのにこういう部分で躓くのは勿体無いと思い、まずはDocPadのPluginのひな形を作るYeoman Generatorを作成しました。
これによりプラグイン作成の敷居を下げることに貢献できればと思います。
また、これからDocPadに興味を持ってPlugInを作る人達の役に立てれば幸いです。

Comments