History

Houston (Bot) d6845245f2 [ci] release (#6184 ) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>		2023-02-09 14:27:56 -05:00
..
index.ts	Remove deprecated APIs (#5707 )	2023-01-03 14:06:07 -05:00
package.json	[ci] release (#6184 )	2023-02-09 14:27:56 -05:00
README.md	Update open with codesandbox link to use synced sandboxes (#6105 )	2023-02-03 11:52:11 -06:00
tsconfig.json	Adds an integration starter example (#4877 )	2022-10-07 16:06:51 +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

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

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