mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-30 06:50:36 +02:00
0252d01ebb
* docs(v2): Add READMEs to v2 packages Signed-off-by: Reece Dunham <me@rdil.rocks> * Update packages/docusaurus-remark-plugin-npm2yarn/package.json * Update packages/docusaurus/README.md * Update packages/docusaurus-plugin-sitemap/README.md Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# `@docusaurus/plugin-ideal-image`
|
|
|
|
Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
yarn add @docusaurus/plugin-ideal-image
|
|
```
|
|
|
|
Modify your `docusaurus.config.js`
|
|
|
|
```diff
|
|
module.exports = {
|
|
...
|
|
+ plugins: ['@docusaurus/plugin-ideal-image'],
|
|
...
|
|
}
|
|
```
|
|
|
|
## Usage
|
|
|
|
Support png, gif and jpg only
|
|
|
|
```jsx
|
|
import Image from '@theme/IdealImage';
|
|
import thumbnail from './path/to/img.png';
|
|
|
|
// your react code
|
|
<Image img={thumbnail} />
|
|
|
|
// or
|
|
<Image img={require('./path/to/img.png')} />
|
|
```
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. |
|
|
| `sizes` | `array` | _original size_ | Specify all widths you want to use; if a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). You may also declare a default `sizes` array in the loader options in your `webpack.config.js`. |
|
|
| `size` | `integer` | _original size_ | Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up) |
|
|
| `min` | `integer` | | As an alternative to manually specifying `sizes`, you can specify `min`, `max` and `steps`, and the sizes will be generated for you. |
|
|
| `max` | `integer` | | See `min` above |
|
|
| `steps` | `integer` | `4` | Configure the number of images generated between `min` and `max` (inclusive) |
|
|
| `quality` | `integer` | `85` | JPEG compression quality |
|