README.md

@playform/remove 🪦

This Astro integration will automatically remove all the dead links in your website.

🚀 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/remove, run the following from your project directory and follow the prompts:

Using NPM:

npx astro add @playform/remove

Using Yarn:

yarn astro add @playform/remove

Using PNPM:

pnpx astro add @playform/remove

Install dependencies manually

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

npm install -D -E @playform/remove

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

astro.config.ts

import deadLinks from "@playform/remove";

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

Getting started

The utility will now automatically remove all the deadlinks from your website and point to their origin.

Changelog

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