Sha256: 884cf646ea303a58d115342c7afeb4d7da0fdbd56a90422912345eca0e2b9ba1

Contents?: true

Size: 1.89 KB

Versions: 2

Compression:

Stored size: 1.89 KB

Contents

# Guard::Jekyll

Guard::Jekyll automatically rebuilds websites with the [Jekyll static site generator](http://jekyllrb.com/) every time files are modified.

## Installation

Add this line to your application's Gemfile:

    gem 'guard-jekyll'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install guard-jekyll

## Usage

Enter the Jekyll site directory for which you want to use Guard::Jekyll. Create a Guardfile using:

    $ guard init jekyll

Then execute:

    $ guard

Whenever you change a file in the Jekyll site directory now, the site will be rebuilt!

## Options

You can provide these options to Guard::Jekyll:

* `:source` the source directory which Jekyll reads files from.
* `:destination` the directory where Jekyll will write files to.
* `:config` array of configuration files for Jekyll.

Without options, Jekyll will use its built-in defaults.

## License

(MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
guard-jekyll-1.5.0 README.markdown
guard-jekyll-1.4.0 README.markdown