0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/examples/integration
Houston (Bot) 19f9edf977
[ci] release (beta) (#8067)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-08-14 08:46:22 -05:00
..
index.ts Remove deprecated APIs (#5707) 2023-01-03 14:06:07 -05:00
package.json [ci] release (beta) (#8067) 2023-08-14 08:46:22 -05:00
README.md Format markdown files (#7439) 2023-06-26 11:34:13 +08:00
tsconfig.json

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