Astro Starter Kit: Component Package#

This is a template for an Astro component library. Use this template for writing components to use in multiple projects or publish to NPM.

pnpm create astro@latest -- --template component

🚀 Project Structure#

Inside of your Astro project, you'll see the following folders and files:

/
├── index.ts
├── src
│   └── MyComponent.astro
├── tsconfig.json
├── package.json

The index.ts file is the "entry point" for your package. Export your components 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
`pnpm link`	Registers this package locally. Run `pnpm link my-component-library` in an Astro project to install your components
`pnpm publish`	Publishes this package to NPM. Requires you to be logged in