0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
The web framework for content-driven websites. ️ Star to support our work!
Find a file
2024-12-16 19:52:14 +00:00
.gitignore Sync from a44cfb874a 2024-12-16 19:52:14 +00:00
index.ts Sync from a44cfb874a 2024-12-16 19:52:14 +00:00
package.json Sync from a44cfb874a 2024-12-16 19:52:14 +00:00
README.md Sync from a44cfb874a 2024-12-16 19:52:14 +00:00
tsconfig.json Sync from a44cfb874a 2024-12-16 19:52:14 +00:00

Astro Starter Kit: Integration Package

This is a template for an Astro integration. Use this template for writing integrations to use in multiple projects or publish to NPM.

npm create astro@latest -- --template integration

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── index.ts
├── tsconfig.json
├── package.json

The index.ts file is the "entry point" for your integration. Export your integration in index.ts to make them importable from your package.

🧞 Commands

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

Command Action
npm link Registers this package locally. Run npm link my-integration in an Astro project to install your integration
npm publish Publishes this package to NPM. Requires you to be logged in