-> Japanese version (original)



Rubicle gems


yard-rubicle

Before After
(Left: before installing, Right: installed.)
yard-rubicle is YARD plugin for styling background of generated documents.

Requirement

Ruby 1.8.7 + RubyGems, or Ruby 1.9.x

Install

Install yard-rubicle gem by RubyGems.

% gem install yard-rubicle

(YARD will be also installed if you haven't install it not yet.)

Usage 1 : at once

  1. Add --plugin option and run yard command. If background is changed, you have succeeded.

    % yard doc --plugin yard-rubicle lib/

Usage 2 : At everytime

  1. Use yard config command and enable autoloading of yard-rubicle plugin.

    % yard config --append autoload_plugins yard-rubicle
  2. Run yard config without any parameters and check that yard-rubicle is enabled.

    % yard config
    :load_plugins: false
    :ignored_plugins: []
    :autoload_plugins:
    - yard-rubicle
    :safe_mode: false
    %
    
  3. Run yard command. If background is changed, you have succeeded.

    % yard doc lib/

Comment form

Please send message frankly. e.g.) Asking to Rubicle, an idea about that you want the website or a message to rubicle.net administrators.

comments powered by Disqus