0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/component
Matthew Phillips ef37f9e290
Revert "[ci] release (#8285)" (#8290)
This reverts commit b4e67a0b1b.
2023-08-30 10:31:24 -04:00
..
src nit: export props has been unnecessary.. forever (#7646) 2023-07-14 09:57:06 -04:00
index.ts chore: update component template (#4540) 2022-09-07 18:16:54 -04:00
package.json Revert "[ci] release (#8285)" (#8290) 2023-08-30 10:31:24 -04:00
README.md Format markdown files (#7439) 2023-06-26 11:34:13 +08:00
tsconfig.json chore: update component template (#4540) 2022-09-07 18:16:54 -04:00

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