Rebuild documentation using Rocco
Go to file
John Bintz 432b648d9e fix the tests 2011-11-15 11:23:01 -05:00
lib fix the tests 2011-11-15 11:23:01 -05:00
spec fix the tests 2011-11-15 11:23:01 -05:00
.gitignore initial release 2011-06-17 16:01:49 -04:00
.travis.yml update the template so the right files get watched 2011-06-18 18:20:49 -04:00
Gemfile clean things up 2011-08-04 11:25:12 -04:00
Guardfile fix things, oops 2011-06-18 15:33:21 -04:00
README.md Fix typo: run_all should be run_on 2011-11-14 10:56:36 +01:00
Rakefile fix the tests 2011-11-15 11:23:01 -05:00
guard-rocco.gemspec fix the tests 2011-11-15 11:23:01 -05:00

README.md

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!