mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
# 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.
|
|
|
|
```sh
|
|
npm create astro@latest -- --template component
|
|
```
|
|
|
|
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages)
|
|
[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/non-html-pages)
|
|
[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/component/devcontainer.json)
|
|
|
|
## 🚀 Project Structure
|
|
|
|
Inside of your Astro project, you'll see the following folders and files:
|
|
|
|
```text
|
|
/
|
|
├── 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](https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages#publishing-unscoped-public-packages) this package to NPM. Requires you to be [logged in](https://docs.npmjs.com/cli/v8/commands/npm-adduser) |
|