james
/
jekyll-responsive-image
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make it clear that the plugin does nothing without a `sizes` config

This commit is contained in:
Joseph Wynn 2020-07-17 12:31:13 +12:00 committed by GitHub
parent 307f3c6284
commit 4b75f67558
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -35,11 +35,15 @@ For more advanced templates, see the [**Templates**](#templates) section below.
### 3. Configure the plugin
You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. The minimum required configuration is a `template` path:
You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. The minimum required configuration is a `template` path. You should also have a `sizes` configuration or the plugin will not do anything.
```yaml
responsive_image:
template: _includes/responsive-image.html
sizes:
- width: 320
- width: 480
- width: 800
```
For a list of all the available configuration options, see the [**All configuration options**](#all-configuration-options) section below.