0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/component
Houston (Bot) fb4e79bf1f
[ci] release (#6261)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-02-16 14:36:33 -05:00
..
src
index.ts
package.json [ci] release (#6261) 2023-02-16 14:36:33 -05:00
README.md Update open with codesandbox link to use synced sandboxes (#6105) 2023-02-03 11:52:11 -06:00
tsconfig.json

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

🚀 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