Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Guard::LiveReload automatically reload your browser when 'view' files are modified.
JavaScript Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/guard
spec
.gitignore
Gemfile
Guardfile
LICENSE
README.rdoc
Rakefile
guard-livereload.gemspec

README.rdoc

Guard::LiveReload

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

Install

Please be sure to have Guard installed before continue.

Install the gem:

gem install guard-livereload

Add it to your Gemfile (inside test group):

gem 'guard-livereload'

Add guard definition to your Guardfile by running this command:

guard init livereload

Install LiveReload Safari/Chrome extension

Usage

Please read Guard usage doc and 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/.+\.(erb|haml)})
  watch(%r{app/helpers/.+\.rb})
  watch(%r{public/.+\.(css|js|html)})
  watch(%r{config/locales/.+\.yml})
end

Options

LiveReload guard have 5 options that you can set like this:

guard 'livereload', :api_version => '1.4', :port => '35728' do
  ...
end

Available options:

:api_version => '1.4'    # default '1.6'
:host => '127.3.3.1'     # default '0.0.0.0'
:port => '12345'         # default '35729'
:apply_js_live => false  # default true
:apply_css_live => false # default true

See LiveReload configuration doc for more info about those options.

Development

Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.

Authors

Thibaud Guillaume-Gentil

Something went wrong with that request. Please try again.