Updates how the new Image component is exported to support older versions of Astro (#3812)

* don't use typescript for the components named export file

* Adding a readme example for images in markdown

* chore: add changeset
This commit is contained in:
Tony Sullivan 2022-07-04 14:52:32 +00:00 committed by GitHub
parent 08d068496d
commit 5ccccace0c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 0 deletions

View file

@ -0,0 +1,6 @@
---
'@astrojs/image': patch
---
- Updates how the `<Image />` component is exported to support older versions of Astro
- Adds an example of using the `<Image />` component in markdown pages

View file

@ -152,6 +152,30 @@ const imageUrl = 'https://www.google.com/images/branding/googlelogo/2x/googlelog
```
</details>
<details>
<summary><strong>Images in markdown</strong></summary>
<br/>
The `<Image />` component can also be used to optimize images in markdown pages. For local images imported from your project's `src` directory, use Astro's the `setup` frontmatter to import the image file.
```html
---
setup: |
import { Image } from '@astrojs/image/components'
import hero from '../../assets/blog/introducing-astro.jpg'
title: Hello world!
publishDate: 12 Sep 2021
name: Nate Moore
value: 128
description: Just a Hello World Post!
---
<Image src={hero} width={640} />
<Image src="https://example.com/image.jpg" width={640} aspectRatio="16:9" />
```
</details>
## Troubleshooting
- If your installation doesn't seem to be working, make sure to restart the dev server.
- If you edit and save a file and don't see your site update accordingly, try refreshing the page.