Skip to content

Add documentation for overriding responsive image sizing #88

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 3 commits into from
Feb 3, 2021
Merged

Add documentation for overriding responsive image sizing #88

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b240d6f
Add documentation for overriding responsive image sizing
blefevre Jan 27, 2021
ddc745f
Add warning that existing images wont be resized
blefevre Jan 28, 2021
e91c86d
Merge branch 'main' into pr-9002-update
derrickmehaffy Feb 3, 2021
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
27 changes: 27 additions & 0 deletions developer-docs/latest/plugins/upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,33 @@ module.exports = {
};
```

#### Responsive Images

When the `Enable responsive friendly upload` setting is enabled in the settings panel the plugin will generate the following responsive image sizes:
| Name | Largest Dimension |
| :------ | :--------- |
| large | 1000px |
| medium | 750px |
| small | 500px |

These sizes can be overridden in `config/plugins.js`:
```javascript
module.exports = {
upload: {
breakpoints: {
xlarge: 1920,
large: 1000,
medium: 750,
small: 500,
xsmall: 64
}
}
}
```
::: warning
Breakpoint changes will only apply to new images, existing images will not be resized or have new sizes generated.
:::

## Endpoints

<style lang="stylus">
Expand Down