https://github.com/playform/remove
Remove 🪦
https://github.com/playform/remove
astro dead link performance playform remove
Last synced: 3 months ago
JSON representation
Remove 🪦
- Host: GitHub
- URL: https://github.com/playform/remove
- Owner: PlayForm
- License: cc0-1.0
- Created: 2023-08-10T12:41:23.000Z (almost 2 years ago)
- Default Branch: Current
- Last Pushed: 2025-04-15T17:24:02.000Z (3 months ago)
- Last Synced: 2025-04-15T23:16:17.374Z (3 months ago)
- Topics: astro, dead, link, performance, playform, remove
- Language: TypeScript
- Homepage: https://GitHub.Com/PlayForm/Remove
- Size: 1.4 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [@playform/remove] 🪦
This **[`Astro integration`][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:
```sh
npx astro add @playform/remove
```
Using Yarn:
```sh
yarn astro add @playform/remove
```
Using PNPM:
```sh
pnpx astro add @playform/remove
```
### Install dependencies manually
First, install the `@playform/remove` integration like so:
```sh
npm install -D -E @playform/remove
```
Then, apply this integration to your `astro.config.*` file using the
`integrations` property:
**`astro.config.ts`**
```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.
[@playform/remove]: HTTPS://NPMJS.Org/@playform/remove
[astro-integration]: HTTPS://docs.astro.build/en/guides/integrations-guide/
## Changelog
See [`CHANGELOG.md`](CHANGELOG.md) for a history of changes to this integration.