Install Nuxt Link Checker

Get started with Nuxt Link Checker by installing the dependency to your project.

Module Setup

bash

npx nuxi module add link-checker

bash

npm i nuxt-link-checker

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-og-image',
  ],
})

bash

yarn add nuxt-link-checker

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-og-image',
  ],
})

bash

pnpm i nuxt-link-checker

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-og-image',
  ],
})

bash

bun i nuxt-link-checker

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-og-image',
  ],
})

The Link Checker only works in development mode when the DevTools is open or when running nuxi build or nuxi generate.

Open up DevTools in your Nuxt app and navigate to the Link Checker tab.

To start seeing live inspections, navigate to a page with links and open the DevTools on the Link Checker tab.

It's recommended to use this module with Nuxt Sitemap so that your page links are automatically discovered.

Explore the documentation to learn more.

Did this page help you?

Introduction

Find and magically fix links that may be negatively effecting your Nuxt sites SEO.

Troubleshooting

Create minimal reproductions for Nuxt Link Checker or just experiment with the module.