From a3acce0c5b5876768077d86a742582751ab54b43 Mon Sep 17 00:00:00 2001 From: Noah Silvera Date: Thu, 9 Apr 2020 14:14:52 -0700 Subject: [PATCH 1/4] Add a note that `plugin-ideal-image` only perform compression on a production build. In reference to https://github.com/facebook/docusaurus/issues/2571 --- .../versioned_docs/version-2.0.0-alpha.50/using-plugins.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md index bce6ff9e89eb..9f2f923a586d 100644 --- a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md +++ b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md @@ -425,6 +425,10 @@ import thumbnail from './path/to/img.png'; #### Options +:::note +Image compression/transformation will only happen in a production build. When developing with the local server, full, original size images will always be returned. +::: + | Option | Type | Default | Description | | --- | --- | --- | --- | | `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. | From 7cbacec671f71827b3d2e0a3a366f3c29a3711e9 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 10 Apr 2020 10:46:07 +0800 Subject: [PATCH 2/4] Update using-plugins.md --- .../version-2.0.0-alpha.50/using-plugins.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md index 9f2f923a586d..f7fdf7445321 100644 --- a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md +++ b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md @@ -392,7 +392,7 @@ module.exports = { ### `@docusaurus/plugin-ideal-image` -Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) +Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) *in the production builds*. ```bash npm2yarn npm install --save @docusaurus/plugin-ideal-image @@ -410,7 +410,7 @@ module.exports = { #### Usage -This plugin supports png, gif and jpg only +This plugin supports the PNG, GIF and JPG formats only. ```jsx import Image from '@theme/IdealImage'; @@ -425,10 +425,6 @@ import thumbnail from './path/to/img.png'; #### Options -:::note -Image compression/transformation will only happen in a production build. When developing with the local server, full, original size images will always be returned. -::: - | Option | Type | Default | Description | | --- | --- | --- | --- | | `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. | From 86337dd31967567650cf4c16da4eb1f71c032b4e Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 10 Apr 2020 10:46:56 +0800 Subject: [PATCH 3/4] Update using-plugins.md --- website/docs/using-plugins.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/website/docs/using-plugins.md b/website/docs/using-plugins.md index 33e05c32a14e..ecb5dd84f087 100644 --- a/website/docs/using-plugins.md +++ b/website/docs/using-plugins.md @@ -401,7 +401,7 @@ module.exports = { ### `@docusaurus/plugin-ideal-image` -Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) +Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) **in the production builds**. ```bash npm2yarn npm install --save @docusaurus/plugin-ideal-image @@ -409,18 +409,17 @@ npm install --save @docusaurus/plugin-ideal-image Modify your `docusaurus.config.js` -```js title="docusaurus.config.js" +```diff module.exports = { - // ... - // highlight-next-line - plugins: ['@docusaurus/plugin-ideal-image'], - // ... -}; + ... ++ plugins: ['@docusaurus/plugin-ideal-image'], + ... +} ``` #### Usage -This plugin supports png, gif and jpg only +This plugin supports the PNG, GIF and JPG formats only. ```jsx import Image from '@theme/IdealImage'; From 1963c48bd997ac1924a88636d8b055ee9531793c Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 10 Apr 2020 10:47:15 +0800 Subject: [PATCH 4/4] Update using-plugins.md --- website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md index f7fdf7445321..343ec900f595 100644 --- a/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md +++ b/website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md @@ -392,7 +392,7 @@ module.exports = { ### `@docusaurus/plugin-ideal-image` -Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) *in the production builds*. +Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) **in the production builds**. ```bash npm2yarn npm install --save @docusaurus/plugin-ideal-image