mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
a800bf7ec1
* .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
1.4 KiB
1.4 KiB
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
🚀 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 |