README.md

🫶 @playform/convert

This Astro integration converts all your files into different formats.

🚀 Installation

There are two ways to add integrations to your project. Let's try the most convenient option first!

astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This command will:

1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your astro.config.* file to apply this integration

To install @playform/convert, run the following from your project directory and follow the prompts:

Using NPM:

npx astro add @playform/convert

Using Yarn:

yarn astro add @playform/convert

Using PNPM:

pnpx astro add @playform/convert

Install dependencies manually

First, install the @playform/convert integration like so:

npm install -D -E @playform/convert

Then, apply this integration to your astro.config.* file using the integrations property:

astro.config.ts

import Convert from "@playform/convert";

export default {
	integrations: [Convert()],
};

Getting started

You can override any of the default options from the configurations of:

• sharp

or disable them entirely:

import Convert from "@playform/convert";

export default {
	integrations: [
		Convert({
			Convert: false,
		}),
	],
};

Set Logger to 0 if you do not want to see debug messages. Default is 2.

import Convert from "@playform/convert";

export default {
	integrations: [
		Convert({
			Logger: 0,
		}),
	],
};

Changelog

See CHANGELOG.md for a history of changes to this integration.