nuxt-link-checker

nuxt-link-checker

Improve your sites SEO by identifying and fixing link issues in your Nuxt 3 app.

Status: Early Access Please report any issues 🐛 Made possible by my Sponsor Program 💖 Follow me @harlan_zw 🐦 • Join Discord for help

ℹ️ Looking for a complete SEO solution? Check out nuxt-seo-kit.

Features

• ✅ Discover broken links - 404s and internal redirects
• 🕵️ Fail on build if broken links are found (optional)

Install

⚠️ The module is in early access and only works when pre-rendering.

npm install --save-dev nuxt-link-checker

# Using yarn
yarn add --dev nuxt-link-checker

Setup

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-link-checker',
  ],
})

To have routes scanned for broken links automatically, they need to be pre-rendered by Nitro.

export default defineNuxtConfig({
  nitro: {
    prerender: {
      crawlLinks: true,
      routes: [
        '/',
        // any URLs that can't be discovered by crawler
        '/my-hidden-url'
      ]
    }
  }
})

Set host (optional)

You'll need to provide the host of your site so that the crawler can resolve absolute URLs that may be internal.

export default defineNuxtConfig({
  // Recommended 
  runtimeConfig: {
    siteUrl: 'https://example.com',
  },
  // OR 
  sitemap: {
    host: 'https://example.com',
  },
})

Module Config

failOn404

• Type: boolean
• Default: true

If set to true, the build will fail if any broken links are found.

host

• Type: string
• Default: runtimeConfig.public.siteUrl || localhost
• Required: false

The host of your site. This is required to validate absolute URLs which may be internal.

trailingSlash

• Type: boolean
• Default: false

Whether internal links should have a trailing slash or not.

Sponsors

License

MIT License © 2022-PRESENT Harlan Wilton