Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/playform/convert
🫶🏻 Convert —
https://github.com/playform/convert
astro astro-component astro-convert astro-integration convert playform withastro
Last synced: about 1 month ago
JSON representation
🫶🏻 Convert —
- Host: GitHub
- URL: https://github.com/playform/convert
- Owner: PlayForm
- License: cc0-1.0
- Created: 2023-08-10T12:41:19.000Z (over 1 year ago)
- Default Branch: Current
- Last Pushed: 2025-01-06T16:11:41.000Z (about 1 month ago)
- Last Synced: 2025-01-09T22:55:51.096Z (about 1 month ago)
- Topics: astro, astro-component, astro-convert, astro-integration, convert, playform, withastro
- Language: TypeScript
- Homepage: https://GitHub.Com/PlayForm/Convert
- Size: 881 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🫶 [@playform/convert]
This **[`Astro integration`][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:
```sh
npx astro add @playform/convert
```
Using Yarn:
```sh
yarn astro add @playform/convert
```
Using PNPM:
```sh
pnpx astro add @playform/convert
```
### Install dependencies manually
First, install the `@playform/convert` integration like so:
```sh
npm install -D -E @playform/convert
```
Then, apply this integration to your `astro.config.*` file using the
`integrations` property:
**`astro.config.ts`**
```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`](src/Option/Image.ts)
or disable them entirely:
```ts
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`.
```ts
import Convert from "@playform/convert";
export default {
integrations: [
Convert({
Logger: 0,
}),
],
};
```
[@playform/convert]: HTTPS://NPMJS.Org/@playform/convert
[astro-integration]: HTTPS://docs.astro.build/en/guides/integrations-guide/
## Changelog
See [`CHANGELOG.md`](CHANGELOG.md) for a history of changes to this integration.