2011-06-18 16:33:23 +00:00
|
|
|
It's a [Guard](http://github.com/guard/guard) for the [Rocco](http://github.com/rtomayko/rocco) documentation system!
|
|
|
|
|
|
2011-11-13 13:28:15 +00:00
|
|
|
``` ruby
|
|
|
|
|
# default values
|
2011-11-14 09:56:36 +00:00
|
|
|
guard 'rocco', :run_on => [:start, :change], :dir => 'doc', :stylesheet => 'http://jashkenas.github.com/docco/resources/docco.css' do
|
2011-11-13 13:28:15 +00:00
|
|
|
watch(%r{^app/.*\.(rb|coffee)$})
|
|
|
|
|
watch(%r{^lib/.*\.rb$})
|
|
|
|
|
end
|
|
|
|
|
```
|
2011-10-01 19:56:09 +00:00
|
|
|
Options:
|
2011-06-18 16:33:23 +00:00
|
|
|
|
2011-11-13 13:28:15 +00:00
|
|
|
* `: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
|
2011-06-18 16:33:23 +00:00
|
|
|
|
2011-06-18 16:33:38 +00:00
|
|
|
`gem install guard-rocco` or Bundle it up with `gem 'guard-rocco'`. Then `guard init rocco`. Yeah!
|
2011-06-18 16:33:23 +00:00
|
|
|
|
