mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
e5c64c51c1
* adding an integration starter example * chore: linter fixes * removing components from the integration example * removing the monorepo and demo project, adding links to docs and examples * chore: update lock file * typo fix
1.3 KiB
1.3 KiB
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.
🧞 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 |