https://github.com/delucis/astro-embed

Low-JavaScript embed components for Astro websites
https://github.com/delucis/astro-embed

astro oembed twitter vimeo youtube

Last synced: 7 days ago
JSON representation

Low-JavaScript embed components for Astro websites

• Host: GitHub
• URL: https://github.com/delucis/astro-embed
• Owner: delucis
• License: mit
• Created: 2022-04-07T07:32:03.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-14T23:50:26.000Z (about 1 month ago)
• Last Synced: 2025-01-10T10:07:16.625Z (14 days ago)
• Topics: astro, oembed, twitter, vimeo, youtube
• Language: Astro
• Homepage: https://astro-embed.netlify.app
• Size: 1.58 MB
• Stars: 272
• Watchers: 3
• Forks: 40
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Astro Embed

Welcome! This project aims to collect easy-to-use and lightweight ways to embed common media into your [Astro](https://astro.build/) site.

## 📚 Documentation

Want to get started using some embed components?

Check out the [`astro-embed` documentation](https://astro-embed.netlify.app/)

## 🚀 Project Structure

This project uses a monorepo structure with a separate workspace for each embed type. You’ll find a directory for each service in the [`/packages`](packages) directory.

The Astro site in the [`/demo`](demo) directory can be used to preview the various components and the files in [`/tests`](tests) are used to run automated testing on the components.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command       | Action                                                          |

| :------------ | :-------------------------------------------------------------- |

| `npm install` | Installs dependencies                                           |

| `npm start`   | Starts local dev server for the `demo` site at `localhost:3000` |

| `npm t`       | Run the test suite                                              |

## 🧪 Testing

You can run unit tests by running `npm t` in a terminal or run `npm start` to start a dev server for the demo project.

## ✨ Want to contribute?

This is an Astro Community project. That means YOU!

- 🛠 Want to build a missing component? [We have a guide for that.](CONTRIBUTING.md)

- 🐛 Found a bug? Open a [new issue](https://github.com/delucis/astro-embed/issues/new/choose) to let us know.

- 💬 Want to chat? Jump into [the Astro Discord server](https://astro.build/chat).