! PikiDocについて

!! はじめに

[[HikiDoc|hikidoc.rubyforge.org/svn/trunk/README.ja]]を拡張し、HikiDocの機能の一つである「プラグイン」機能を簡単にを追加できるようにしたライブラリです。

本家HikiDocライブラリもバンドルしているため、このライブラリを入れるだけで使えます。

!! 使い方

プラグインを追加する部分以外は、本家の機能がそのまま使えます。

require 'piki_doc'
PikiDoc.to_xhtml("! PikiDoc\u306B\u3064\u3044\u3066\n\n!! \u306F\u3058\u3081\u306B\n"

!!! プラグインの使い方

あらかじめPikiDoc.register()にプラグインを指定してください。今のところ、Gist プラグインとASINプラグインがバンドルされています。

PikiDoc.register(PikiDoc::Bundles::Gist.new, PikiDoc::Bundles::Asin.new)
PikiDoc.to_xhtml("!!!! ASIN\n\n\u30A4\u30F3\u30E9\u30A4\u30F3 {{asin('4797336625', 'morodiary05-22')}}\n\n{{asin('4797336625', 'morodiary05-22')}}\n\n!!!! Gist\n\n\u30A4\u30F3\u30E9\u30A4\u30F3 {{gist('88086')}}\n\n{{gist('88086')}}\n")

次のように出力されます

!!!! ASIN

インライン ‘morodiary05-22’)}

‘morodiary05-22’)}

!!!! Gist

インライン {gist(88086)}

{gist(88086)}

!! プラグインの自作方法

lib/piki_doc/bundles/内のサンプルと、features/*内の外部仕様を参考にしてください。

!! Thanks

!!! HikiDoc authors

!! ライセンス

HikiDoc本家と同じ修正BSDライセンスです。