Skip to content
Guard::Ronn automatically builds manuals.
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib/guard
spec
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
Guardfile
LICENSE
README.md
Rakefile
guard-ronn.gemspec

README.md

Guard::Ronn Build Status

Ronn guard automatically build manuals when markdown source files are modified.

Compatibility

  • Compatible with Ronn ~> 0.7.3.
  • Tested on Ruby 1.8.7, 1.9.2, REE, Rubinius & JRuby.

Install

Please be sure to have Guard installed before continue.

If you're using Bundler, add it to your Gemfile (inside the development or guard group):

gem 'guard-ronn'

and run:

$ bundle install

or manually install the gem:

$ gem install guard-ronn

Add Guard definition to your Guardfile by running this command:

$ guard init ronn

Usage

Please read Guard usage doc.

By default, Guard::Ronn watch for files with the .ronn, .md or .markdown extension in the man directory.

Guardfile

guard 'ronn' do
  watch(%r{^man/.+\.ronn$})
  watch(%r{^man/.+\.m(ark)?d(own)?$})
end

Please read Guard doc for more information about the Guardfile DSL.

Options

You can pass any of the standard Ronn CLI options using the :cli option:

guard 'ronn', :cli => "--html" do
  # ...
end

List of available options:

:cli => "--html"  # pass arbitrary Ronn CLI arguments, default: ""
:bundler => false # don't use "bundle exec" to run the Ronn command, default: true

Bonus: reading gems' man pages from the man command

You can use the awesome gem-man by defunkt.

Development

Pull requests are very welcome! Please try to follow these simple "rules", though:

  • Please create a topic branch for every separate change you make;
  • Make sure your patches are well tested;
  • Update the README (if applicable);
  • Update the CHANGELOG (maybe not for a typo but don't hesitate!);
  • Please do not change the version number.

For questions please join us on our Google group or on #guard (irc.freenode.net).

Testing

bundle exec guard and rake spec:portability (to test against multiple rubies).

Author

Rémy Coutable

Something went wrong with that request. Please try again.