Skip to content

Commit

Permalink
fix: 🐛 Documentation update
Browse files Browse the repository at this point in the history
Attention notice for filenameGenerator moved to be under the
filenameGenerator blurb
  • Loading branch information
boylec committed Aug 30, 2022
1 parent 9b1fbd9 commit 21e1b8c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/docs/04-Configurations/01-basic-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ const config = {
+ 'images-sample.1920.75.png'
```

#### ❗️Attention

When making this setting, make sure that the file names (including the path part) of different images do not cover each other.
Specifically, include the name, width, quality, and extension in the return value. If path is not included, all src's should be specified with `import` or `require` so that they can be distinguished by their hash value even if they have the same filename.

### `sourceImageParser`

- Type: function
Expand Down Expand Up @@ -126,11 +131,6 @@ const config = {
}
```

#### ❗️Attention

When making this setting, make sure that the file names (including the path part) of different images do not cover each other.
Specifically, include the name, width, quality, and extension in the return value. If path is not included, all src's should be specified with `import` or `require` so that they can be distinguished by their hash value even if they have the same filename.

### `sharpOptions`

- Type: Object
Expand Down

0 comments on commit 21e1b8c

Please sign in to comment.