Skip to content

Guard::LiveReload automatically reload your browser when 'view' files are modified.

License

Notifications You must be signed in to change notification settings

school-scout/guard-livereload

 
 

Repository files navigation

Guard::LiveReload Gem Version Build Status Dependency Status Code Climate Coverage Status

LiveReload guard allows to automatically reload your browser when 'view' files are modified.

Support

For any support question/issue related to livereload please ask on [email protected].

Install

Please be sure to have Guard installed before continuing.

Install the gem:

$ gem install guard-livereload

Add it to your Gemfile (inside development group):

group :development do
  gem 'guard-livereload'
end

Add guard definition to your Guardfile by running this command:

$ guard init livereload

Use rack-livereload or install LiveReload Safari/Chrome extension

Usage

Please read Guard usage doc and rack-livereload how it works readme section or LiveReload extension usage doc

Guardfile

You can adapt your 'view' files like you want. Please read Guard doc for more info about Guardfile DSL.

guard 'livereload' do
  watch(%r{app/views/.+\.(erb|haml|slim)})
  watch(%r{app/helpers/.+\.rb})
  watch(%r{public/.+\.(css|js|html)})
  watch(%r{config/locales/.+\.yml})
  # Rails Assets Pipeline
  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|js|html))).*}) { |m| "/assets/#{m[3]}" }
end

Options

LiveReload guard has 6 options that you can set like this:

guard 'livereload' do
  # ...
end

Available options:

:host => '127.3.3.1'     # default '0.0.0.0'
:port => '12345'         # default '35729'
:apply_css_live => false # default true
:override_url => false   # default false
:grace_period => 0.5     # default 0 (seconds)

See LiveReload configuration doc for more info about those options.

Development

Pull requests are very welcome! Please try to follow these simple "rules", though:

  • Please create a topic branch for every separate change you make.
  • Make sure your patches are well tested.
  • Update the README (if applicable).
  • Please do not change the version number.

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

Author

Thibaud Guillaume-Gentil

About

Guard::LiveReload automatically reload your browser when 'view' files are modified.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 55.3%
  • Ruby 44.7%