diff options
| author |  Chris Swithinbank <swithinbank@gmail.com>
| 2022-09-02 17:05:04 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-09-02 17:05:04 +0200 |
| commit | eb4eebde9ebe6918db08faf0ff856313089fd627 (patch) | |
| tree | b04ef556a1c26240a0d72059039fb081e027ac20 | |
| parent | c220f53b218c57c0d70464026eb972b84c580950 (diff) | |
| download | astro-eb4eebde9ebe6918db08faf0ff856313089fd627.tar.gz astro-eb4eebde9ebe6918db08faf0ff856313089fd627.tar.zst astro-eb4eebde9ebe6918db08faf0ff856313089fd627.zip | |
Fix image integration README (#4599)
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
| -rw-r--r-- | packages/integrations/image/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/packages/integrations/image/README.md b/packages/integrations/image/README.md index a1ffa25ae..394db59de 100644 --- a/packages/integrations/image/README.md +++ b/packages/integrations/image/README.md @@ -90,9 +90,9 @@ import { Image, Picture } from '@astrojs/image/components'; The included `sharp` transformer supports resizing images and encoding them to different image formats. Third-party image services will be able to add support for custom transformations as well (ex: `blur`, `filter`, `rotate`, etc). -Astro’s <Image /> and <Picture /> components require the alt attribute which provides descriptive text for images. A warning will be logged if "alt" text is missing, and a future release of the integration will throw an error if no alt text is provided. +Astro’s `<Image />` and `<Picture />` components require the `alt` attribute, which provides descriptive text for images. A warning will be logged if alt text is missing, and a future release of the integration will throw an error if no alt text is provided. -If the image is merely decorative (i.e. doesn’t contribute to the understanding of the page), set alt="" so that the image is properly understood and ignored by screen readers. +If the image is merely decorative (i.e. doesn’t contribute to the understanding of the page), set `alt=""` so that the image is properly understood and ignored by screen readers. ### `<Image />` @@ -126,7 +126,7 @@ For remote images, provide the full URL. (e.g. `src="https://astro.build/assets/ Defines an alternative text description of the image. -Set to an empty string (alt="") if the image is not a key part of the content (it's decoration or a tracking pixel). +Set to an empty string (`alt=""`) if the image is not a key part of the content (e.g. it's decoration or a tracking pixel). #### format @@ -218,7 +218,7 @@ For remote images, provide the full URL. (e.g. `src="https://astro.build/assets/ Defines an alternative text description of the image. -Set to an empty string (alt="") if the image is not a key part of the content (it's decoration or a tracking pixel). +Set to an empty string (`alt=""`) if the image is not a key part of the content (e.g. it's decoration or a tracking pixel). #### sizes |