Skip to content

Low-JavaScript embed components for Astro websites

License

Notifications You must be signed in to change notification settings

HiDeoo/astro-embed

 
 

Repository files navigation

Astro Embed

Welcome! This project aims to collect easy-to-use and lightweight ways to embed common media into your Astro site.

📚 Documentation

Want to get started using some embed components?

Check out the astro-embed documentation

🚀 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 directory.

The Astro site in the /demo directory can be used to preview the various components and the files in /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!

About

Low-JavaScript embed components for Astro websites

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 32.4%
  • TypeScript 31.6%
  • Astro 30.1%
  • CSS 5.9%