Add run_on option to specify when to run the rocco command #3

2011-11-13T13:34:43Z

JeanMertz commented

2011-11-13 13:34:43 +00:00

(Migrated from github.com)

It's a Guard for the Rocco documentation system!

# default values
guard 'rocco', :run_on => [:start, :change], :dir => 'doc', :stylesheet => 'http://jashkenas.github.com/docco/resources/docco.css' do
  watch(%r{^app/.*\.(rb|coffee)$})
  watch(%r{^lib/.*\.rb$})
end

Options:

:run_on specifies when to update the docs
- :start - run on all documentation when the guard starts
- :change - run when watched files change
- :reload - run when the guard is reloaded
- :all - run when running all the guards
:dir specifies the output dir
:stylesheet specifies a custom stylesheet to use

gem install guard-rocco or Bundle it up with gem 'guard-rocco'. Then guard init rocco. Yeah!

It's a [Guard](http://github.com/guard/guard) for the [Rocco](http://github.com/rtomayko/rocco) documentation system! ``` ruby # default values guard 'rocco', :run_on => [:start, :change], :dir => 'doc', :stylesheet => 'http://jashkenas.github.com/docco/resources/docco.css' do watch(%r{^app/.*\.(rb|coffee)$}) watch(%r{^lib/.*\.rb$}) end ``` Options: - `:run_on` specifies when to update the docs - `:start` - run on all documentation when the guard starts - `:change` - run when watched files change - `:reload` - run when the guard is reloaded - `:all` - run when running all the guards - `:dir` specifies the output dir - `:stylesheet` specifies a custom stylesheet to use `gem install guard-rocco` or Bundle it up with `gem 'guard-rocco'`. Then `guard init rocco`. Yeah!

johnbintz commented

2011-11-15 15:42:19 +00:00

(Migrated from github.com)

Looks great, thanks so much!

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: github-migration/guard-rocco#3