-> English version



るびくるgems

RubyGemsでインストール可能なgemを公開しています。


yard-rubicle

導入前 導入後
(左:インストール前、右:インストール後)
Rubyのドキュメンテーションツール「YARD」でドキュメントを生成したときに、背景をちょっとオシャレにするYARDプラグインです。

必要な環境

Ruby 1.8.7 + RubyGems、もしくはRuby 1.9.x

インストール手順

RubyGemsを使って、yard-rubicle gemをインストールしてください。

% gem install yard-rubicle

(このとき、YARDがインストールされていなければ、YARDも同時にインストールされます)

使い方1:1回だけプラグインを有効にしたい場合

  1. yardコマンドで、--pluginオプションを指定してドキュメントを生成してみてください。生成されたドキュメントの背景が変わっていれば成功です。

    % yard doc --plugin yard-rubicle lib/

使い方2:常にプラグインが有効になるよう設定したい場合

  1. yard configコマンドで、yard-rubicleプラグインを自動的に読み込むように設定します。

    % yard config --append autoload_plugins yard-rubicle
  2. yard configコマンドをパラメータなしで実行して、yard-rubicleプラグインが使用可能な状態になっていることを確認します。

    % yard config
    :load_plugins: false
    :ignored_plugins: []
    :autoload_plugins:
    - yard-rubicle
    :safe_mode: false
    %
    
  3. yardコマンドでドキュメントを生成してみてください。生成されたドキュメントの背景が変わっていれば成功です。

    % yard doc lib/

一言メッセージフォーム

るびくるへの質問や、やってほしい企画のリクエスト、Webサイト管理スタッフへの感想・意見・質問など、なんでもお気軽にどうぞ。