@astro-community/astro-embed-integration

@astro-community/astro-embed-integration

This is an experimental Astro integration that allows you to auto-convert URLs in Markdown file to a corresponding embed component.

Install

npm i @astro-community/astro-embed-integration

Usage

To enable the integration, add it to the integrations array in your astro.config.mjs file.

import { defineConfig } from 'astro/config';
import embeds from '@astro-community/astro-embed-integration';

export default defineConfig({
  integrations: [embeds()],
});

⚠️ Astro integrations are still experimental currently so you will need to add the --experimental-integrations flag to your astro dev/build commands to enable this unofficial integration.

With the integration enabled any isolated URL in a Markdown file that matches one of the astro-embed component types will be converted to the appropriate component.

For example, Markdown like this

I saw this cool Tweet the other day:

https://twitter.com/astrodotbuild/status/1511750228428435457

Will render a static Tweet component in place of the URL.