astro/examples/integration/README.md
Brian McManus 7da05febea
Enhanced Astro codespace support (#6288)
* Enhanced Astro codespace support

Enhances the base devcontainer and Dockerfile to provide a smoother
development experience out of the box for contributors.

Adds a devcontainer per example so that we can add buttons on astro.new
that will launch users straight into the appropriate example app.

* Cleanup devcontainers and pin base image

* Update .devcontainer/example-welcome-message.txt

Co-authored-by: Samruddhi Khandale <skhandale@microsoft.com>

---------

Co-authored-by: Samruddhi Khandale <skhandale@microsoft.com>
2023-02-23 09:34:37 -06:00

1.7 KiB

Astro Starter Kit: Integration Package

This is a template for an Astro integration. Use this template for writing integrations to use in multiple projects or publish to NPM.

npm create astro@latest -- --template integration

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
├── tsconfig.json
├── package.json

The index.ts file is the "entry point" for your integration. Export your integration 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-integration in an Astro project to install your integration
npm publish Publishes this package to NPM. Requires you to be logged in