Rebuild documentation using Rocco
Ruby
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
Guardfile
README.md
Rakefile
guard-rocco.gemspec

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!