Contents

# CloudCannon Jekyll plugin

A Jekyll plugin to create CloudCannon editor details.

[![Build Status](https://travis-ci.com/CloudCannon/cloudcannon-jekyll.svg?branch=main)](https://travis-ci.com/CloudCannon/cloudcannon-jekyll) [![Gem Version](https://badge.fury.io/rb/cloudcannon-jekyll.svg)](https://badge.fury.io/rb/cloudcannon-jekyll)

## Usage

1. Add `gem 'cloudcannon-jekyll'` to your site's `Gemfile`
2. Run `bundle install`
3. Add the following to your site's `_config.yml`:

```yaml
plugins:
  - cloudcannon-jekyll
```

💡 If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.


## Releasing new version

1. Increase version in lib/cloudcannon-jekyll/version.rb
2. Update HISTORY.md
3. Create a release and tag in GitHub
4. Build new gem with `gem build cloudcannon-jekyll.gemspec`
5. Push new version to rubygems.org with `gem push cloudcannon-jekyll-{{ VERSION HERE }}.gem`

OR:

1. Increase version in lib/cloudcannon-jekyll/version.rb
2. Update HISTORY.md
3. Run `./scripts/release`
3. Create a release in GitHub


## Testing

```
bundle exec rspec
```

To test a specific Jekyll version:

```
JEKYLL_VERSION="2.4.0" bundle update && bundle exec rspec
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
cloudcannon-jekyll-2.3.4	README.md
cloudcannon-jekyll-2.3.3	README.md
cloudcannon-jekyll-2.3.2	README.md
cloudcannon-jekyll-2.3.1	README.md
cloudcannon-jekyll-2.3.0	README.md