https://github.com/jekyll/jekyll-watch

:eyes: Rebuild your Jekyll site when a file changes with the `--watch` switch.
https://github.com/jekyll/jekyll-watch

jekyll-plugin

Last synced: 1 day ago
JSON representation

:eyes: Rebuild your Jekyll site when a file changes with the `--watch` switch.

• Host: GitHub
• URL: https://github.com/jekyll/jekyll-watch
• Owner: jekyll
• License: mit
• Created: 2014-06-26T22:41:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T21:18:26.000Z (over 1 year ago)
• Last Synced: 2024-11-25T20:39:41.801Z (17 days ago)
• Topics: jekyll-plugin
• Language: Ruby
• Homepage:
• Size: 133 KB
• Stars: 93
• Watchers: 7
• Forks: 36
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: History.markdown
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-jekyll-plugins - **Watch** - watch](https://rubygems.org/gems/jekyll-watch)) -- rebuild your site when a file changes with the `--watch` switch **#Official** (Watch & Live Reload)

README

        
# Jekyll Watch

Rebuild your Jekyll site when a file changes with the `--watch` switch.

[![Linux Build Status](https://img.shields.io/travis/jekyll/jekyll-watch/master.svg?label=Linux%20build)][travis]

[![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/jekyll-watch/master.svg?label=Windows%20build)][appveyor]

[travis]: https://travis-ci.org/jekyll/jekyll-watch

[appveyor]: https://ci.appveyor.com/project/jekyll/jekyll-watch

## Installation

**`jekyll-watch` comes pre-installed with Jekyll 2.1 or greater.**

Add this line to your application's Gemfile:

    gem 'jekyll-watch'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install jekyll-watch

## Usage

Pass the `--watch` flag to `jekyll build` or `jekyll serve`:

```bash

$ jekyll build --watch

$ jekyll serve --watch # this flag is the default, so no need to specify it here for the 'serve' command

```

The `--watch` flag can be used in combination with any other flags for those

two commands, except `--detach` for the `serve` command.

## Contributing

1. Fork it ( https://github.com/jekyll/jekyll-watch/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request