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

Create a "Troubleshooting" section

This commit is contained in:
Joseph Wynn 2019-02-04 14:36:44 +13:00 committed by GitHub
parent b9791014de
commit 6444d327de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -17,19 +17,6 @@ Either add `jekyll-responsive-image` to your Gemfile, or run the following comma
$ gem install jekyll-responsive-image
```
> **Note:** `jekyll-responsive-image` uses `rmagick` which is currently incompatible with `imagemagick 7`. If you get an error like:
>
> ```
> Can't install RMagick 2.16.0. Can't find MagickWand.h
> ```
> make sure you have `imagemagick 6` installed:
>
> ```
> $ brew uninstall imagemagick
> $ brew install imagemagick@6 && brew link imagemagick@6 --force
> ```
Then you can either add `jekyll-responsive-image` to the `plugins` section of your `_config.yml`:
```yaml
@ -203,6 +190,23 @@ responsive_image:
- assets/avatars/*.{jpeg,jpg}
```
## Troubleshooting
### Error: Can't install RMagick
`jekyll-responsive-image` uses `rmagick` which is currently incompatible with ImageMagick 7. If you get an error like:
```
Can't install RMagick 2.16.0. Can't find MagickWand.h
```
Then you will need to install ImageMagick 6. If you are using Homebrew on Mac OS, this can be done with the following commands:
```
$ brew uninstall imagemagick
$ brew install imagemagick@6 && brew link imagemagick@6 --force
```
## Caching
You may be able to speed up the build of large sites by enabling render caching. This is usually only effective when the same image is used many times, for example a header image that is rendered in every post.