Skip to content

Commit

Permalink
docs(v2): add a note for images not rendered on dev server (#4164)
Browse files Browse the repository at this point in the history
* Update plugin-ideal-image.md

Add a note that images are not rendered on the development server

* Update plugin-ideal-image.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
  • Loading branch information
yuval-hazaz and slorber authored Feb 3, 2021
1 parent 9fc30b3 commit 24b1695
Showing 1 changed file with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ slug: '/api/plugins/@docusaurus/plugin-ideal-image'

Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) **in the production builds**.


:::note

You must create and serve a **production build** in order to view the high-quality images.

When using this plugin in **development**, only the low-quality image placeholders will be visible.

:::

## Installation

```bash npm2yarn
Expand Down

0 comments on commit 24b1695

Please sign in to comment.