History

Houston (Bot) 73ca0ef383 [ci] release (#5948 ) * [ci] release * Update changelogs (#5955) * [ci] release * Wrap astro 2.0 beta logs in `<details>` * Add link to docs upgrade guide * First pass cleaning up 2.0 release notes * mdx changes from Sarah * combine 5584 and 5842 in deno, image, netlify * markdown/remark incl (5684 & 5769) to match mdx * Tweak markdown/remark formatting * Format astro-prism * Format astro-rss * Format create-astro * Format cloudflare * Format lit * Format partytown * Format node * Format preact * Format react * Format solid * Format svelte * Format tailwind * Format vercel * Format vue * Format telemetry * Format webapi * Format scripts * Reinstate h3s for headings Co-authored-by: Ben Holmes <hey@bholmes.dev> * Reformat mdx * astro & markdown/remark: Combine #5679 & #5684 changelogs Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Ben Holmes <hey@bholmes.dev> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Matthew Phillips <matthew@skypack.dev> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Ben Holmes <hey@bholmes.dev>		2023-01-24 11:38:06 -05:00
..
index.ts	Remove deprecated APIs (#5707 )	2023-01-03 14:06:07 -05:00
package.json	[ci] release (#5948 )	2023-01-24 11:38:06 -05:00
README.md	Add “Open with CodeSandbox” buttons to example project READMEs (#5322 )	2022-11-10 11:32:13 +01:00
tsconfig.json	Adds an integration starter example (#4877 )	2022-10-07 16:06:51 +00:00

README.md

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