Config

enabled

• Type: boolean
• Default: true

Whether to scan links.

skipInspections

• Type: string[]
• Default: []

An array of inspection names to skip.

See Link Checking Rules for a list of inspections.

fetchTimeout

• Type: number
• Default: 5000

How long to wait for a response before timing out.

report

• Type: { html?: boolean; markdown?: boolean; json?: boolean; publish?: boolean }
• Default: undefined

Reports to generate on build.

See the Generate Reports guide for more details.

showLiveInspections

• Type: boolean
• Default: true

Show inspections as they are run.

runOnBuild

• Type: boolean
• Default: true

Whether to run the link checker on build.

failOnError

• Type: boolean
• Default: true

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

excludeLinks

• Type: (string | RegExp)[]
• Default: [/^\/_.*$/]

Links to exclude from inspection. Supports exact matches, wildcard patterns (using radix3), and regular expressions.

Pattern Types:

• Exact match: /about
• Wildcard: /admin/** (all admin routes), /api/* (direct children only)
• RegExp: /^\/blog\/\d+$/ (blog posts with numeric IDs)
• External: https://example.com/**

Useful for routes that aren't prerendered but are known to be valid, or external links you don't want checked.

debug

• Type: boolean
• Default: false

Enable to see debug logs.

host

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

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

This is now handled by the nuxt-site-config module.

trailingSlash

• Type: boolean
• Default: false

Whether internal links should have a trailing slash or not.

This is now handled by the nuxt-site-config module.