astro-gists/package
Adam Matthiesen d8ebfda836
Initial commit
2024-02-23 18:44:44 -08:00
..
src Initial commit 2024-02-23 18:44:44 -08:00
README.md Initial commit 2024-02-23 18:44:44 -08:00
package.json Initial commit 2024-02-23 18:44:44 -08:00
tsconfig.json Initial commit 2024-02-23 18:44:44 -08:00

README.md

package-name

This is an Astro integration that TODO:description

Usage

Prerequisites

TODO:

Installation

Install the integration automatically using the Astro CLI:

pnpm astro add package-name
npx astro add package-name
yarn astro add package-name

Or install it manually:

  1. Install the required dependencies
pnpm add package-name
npm install package-name
yarn add package-name
  1. Add the integration to your astro config
+import integration from "package-name";

export default defineConfig({
  integrations: [
+    integration(),
  ],
});

Configuration

TODO:configuration

Contributing

This package is structured as a monorepo:

  • playground contains code for testing the package
  • package contains the actual package

Install dependencies using pnpm:

pnpm i --frozen-lockfile

Start the playground:

pnpm playground:dev

You can now edit files in package. Please note that making changes to those files may require restarting the playground dev server.

Licensing

MIT Licensed. Made with ❤️ by TODO:.

Acknowledgements

TODO: