Skip to content

Document all options for gatsby-remark-images fixes #3882 #3894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2018
Merged

Document all options for gatsby-remark-images fixes #3882 #3894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa9fb97
Document all options for gatsby-remark-images fixes #3882
KyleAMathews Feb 7, 2018
5ce565a
remove
KyleAMathews Feb 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,6 @@ Websites built with Gatsby:
* [Dona Rita](https://donarita.co.uk) ([source](https://github.com/peduarte/dona-rita-website))
* [Andy Slezak](https://www.aslezak.com) ([source](https://github.com/amslezak))


## Docs

**[View the docs on gatsbyjs.org](https://www.gatsbyjs.org/docs/)**
Expand Down
34 changes: 18 additions & 16 deletions packages/gatsby-remark-images/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,6 @@ plugins: [
// the content container as this plugin uses this as the
// base for generating different widths of each image.
maxWidth: 590,
// Remove the default behavior of adding a link to each
// image.
linkImagesToOriginal: true,
// Analyze images' pixel density to make decisions about
// target image size. This is what GitHub is doing when
// embedding images in tickets. This is a useful setting
// for documentation pages with a lot of screenshots.
// It can have unintended side effects on high pixel
// density artworks.
//
// Example: A screenshot made on a retina screen with a
// resolution of 144 (e.g. Macbook) and a width of 100px,
// will be rendered at 50px.
//
// Defaults to false.
sizeByPixelDensity: false,
},
},
],
Expand All @@ -58,5 +42,23 @@ plugins: [
];
```

## Options

| Name | Default | Description |
| `maxWidth` | `650` | The `maxWidth` in pixels of the div where the markdown will be displayed. This value is used when deciding what the width of the various responsive thumbnails should be. |
| `linkImagesToOriginal` | `true` | Add a link to each image to the original image. Sometimes people want to see a full-sized version of an image e.g. to see extra detail on a part of the image and this is a convenient and common pattern for enabling this. Set this option to false to disable this behavior. |
| `sizeByPixelDensity` | `false` |
Analyze images' pixel density to make decisions about target image
size. This is what GitHub is doing when embedding images in
tickets. This is a useful setting for documentation pages with
a lot of screenshots. It can have unintended side effects on high
pixel density artworks.

Example: A screenshot made on a retina screen with a resolution of
144 (e.g. Macbook) and a width of 100px, will be rendered at 50px.
|
| `wrapperStyle` | | Add custom styles to the div wrapping the responsive images. Use the syntax for the style attribute e.g. `margin-bottom:10px; background: red;` |
| `backgroundColor` | `white` | Set the background color of the image to match the background image of your design |

[1]: https://jmperezperez.com/medium-image-progressive-loading-placeholder/
[2]: https://code.facebook.com/posts/991252547593574/the-technology-behind-preview-photos/