Skip to content
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

docs: small tweaks to simplify/clarify docs #260

Merged
merged 3 commits into from
May 17, 2021
Merged

docs: small tweaks to simplify/clarify docs #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
813878d
docs: small tweaks to simplify/clarify docs
danielroe May 12, 2021
99eea15
Update 1.options.md
pi0 May 17, 2021
7365d1b
Update 1.nuxt-img.md
pi0 May 17, 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
6 changes: 4 additions & 2 deletions docs/content/en/2.components/1.nuxt-img.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ Specify width/height of the image.

### `sizes`

Specify responsive reiszes.
Specify responsive sizes.

This a space-separated list of screen size/width pairs. You can [see a list of the defined screen sizes here](/api/options#screens)).

**Example:**

Expand Down Expand Up @@ -109,7 +111,7 @@ Presets are predefined sets of image modifiers that can be used create unified f

```html
<template>
<nuxt-img preset="jpg-cover" src="/nuxt-icon.png" width="50" height="50" />
<nuxt-img preset="cover" src="/nuxt-icon.png" />
</template>
```

Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/3.api/1.options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ export default {

List of predefined screen sizes.
pi0 marked this conversation as resolved.
Show resolved Hide resolved

These sizes will be used to generate resized and optimized versions of an image.
These sizes will be used to generate resized and optimized versions of an image (for example, with the `sizes` modifier).

```ts [nuxt.config.js]
export default {
image: {
// The screen sizes predefined by `@nuxt/image`:
screens: {
xs: 320,
sm: 640,
Expand Down