Skip to content

Commit

Permalink
docs: small tweaks to simplify/clarify docs (#260)
Browse files Browse the repository at this point in the history
Co-authored-by: Clément Ollivier <[email protected]>
Co-authored-by: pooya parsa <[email protected]>
  • Loading branch information
3 people authored May 17, 2021
1 parent d2e65f9 commit e382b4f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/content/en/2.components/1.nuxt-img.md
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ export default {

List of predefined screen sizes.

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

0 comments on commit e382b4f

Please sign in to comment.