anomaly/jekyll-incremental

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Code Climate](https://img.shields.io/codeclimate/maintainability/anomaly/jekyll-incremental.svg?style=for-the-badge)](https://codeclimate.com/github/anomaly/jekyll-incremental/maintainability)
![Gem Version](https://img.shields.io/gem/v/jekyll-incremental.svg?style=for-the-badge)
![Gem DL](https://img.shields.io/gem/dt/jekyll-incremental.svg?style=for-the-badge)

# Jekyll Incremental

Jekyll Incremental is a more simple, and to the point version of incremental generation for Jekyll.  It also tries to solve the shortfalls of Jekyll's own incremental regeneration by treating all things equal, dynamic, doc, post, or collection.  As long as we can get the path, we will track it and make sure it gets generated.  It has an almost backwards compatible API (as far as adding dependencies, and dependent's) and merges several other API's in favor of a single, simple interface to track everything.

## Installation

```ruby
gem "jekyll-incremental", {
  group: "jekyll-plugins"
}
```

## Usage

By default we replace Jekyll's internal regenerator with our own, so you would use ours the same way you would use theirs.  This allows us to stay out of your way and for you not to have to adjust any workflows.

```ruby
bundle exec jekyll b \
  --incremental
```