Skip to content

tai1802/astro-and-svelte-component

Repository files navigation

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.

npm create astro@latest -- --template component

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
├── 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.

🧞 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-component-library in an Astro project to install your components
npm publish Publishes this package to NPM. Requires you to be logged in

About

astro-and-svelte-component

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published