Skip to content

Latest commit

Β 

History

History

integration

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

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

πŸš€ 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