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

README.md

Guard::Ronn

Gem Version Build Status Dependency Status Code Climate Test Coverage

Ronn Guard plugin automatically build manuals when markdown source files are modified.

  • Compatible with Ronn ~> 0.7.
  • Tested against Ruby 2.0.0, 2.1.7, 2.2.3 & Rubinius (1.9 mode only).

Install

Please be sure to have Guard installed before continuing.

Add the gem to your Gemfile (inside the :development or :tool group):

group :development do
  gem 'guard-ronn'
end

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

See the template Guardfile for some examples.

Please read the Guard documentation for more info 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

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 if applicable:

  • Please create a topic branch for every separate change you make.
  • Make sure your patches are well tested. All specs must pass on Travis CI.
  • Update the Yard documentation.
  • Update the README.
  • Please do not change the version number.

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

Author

Rémy Coutable

Contributors

https://github.com/guard/guard-ronn/graphs/contributors