<h1>nuxt-link-checker</h1>

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

Nuxt Link Checker is a collection of SEO focused link inspections for your Nuxt app.

By keeping your links in check, you can ensure that your site is discoverable and accessible to [search engine crawlers](https://nuxtseo.com/learn/controlling-crawlers) and your users.

New to SEO? Check out the [Controlling Web Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers) guide to learn more about why you might
need this module.

<p align="center">
<table>
<tbody>
<td align="center">
<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
</td>
</tbody>
</table>
</p>

## Features

- ✅ 15 SEO focused link inspections
- ✨ See live inspections right in your Nuxt App
- 🧙 Magically fix them in Nuxt Dev Tools
- 🚩 Generate reports on build (HTML, Markdown, JSON)
- 🪝 [ESLint plugin](https://nuxtseo.com/link-checker/guides/eslint) for instant feedback in your IDE

## Installation

Install `nuxt-link-checker` dependency to your project:

```bash
npx nuxi@latest module add link-checker
```

> [!TIP]
> Generate an Agent Skill for this package using [skilld](https://github.com/harlan-zw/skilld):
> ```bash
> npx skilld add nuxt-link-checker
> ```

💡 Link Checker catches broken links at build. For live site checks with indexing, Core Web Vitals and Search Console data in one place, see [Nuxt SEO Pro](https://nuxtseo.com/pro).

## Documentation

[📖 Read the full documentation](https://nuxtseo.com/link-checker/getting-started/installation) for more information.

## Sponsors

<p align="center">
  <a href="https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg">
    <img src='https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg' alt="Sponsors"/>
  </a>
</p>

## License

Licensed under the [MIT license](https://github.com/harlan-zw/nuxt-link-checker/blob/main/LICENSE.md).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nuxt-link-checker/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-link-checker

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-link-checker.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-link-checker

[license-src]: https://img.shields.io/github/license/harlan-zw/nuxt-link-checker.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/harlan-zw/nuxt-link-checker/blob/main/LICENSE.md

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com
