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: 10000

How long to wait for a response before timing out.

report

• Type: { html?: boolean; markdown?: boolean; json?: boolean; storage?: string | CreateStorageOptions; publish?: boolean }
• Default: undefined

Reports to generate on build.

The storage option controls where report files are written. Provide a path relative to the Nuxt root or an unstorage options object. By default, reports are written to the .output directory.

See the Generate Reports guide for more details.

showLiveInspections

• Type: boolean
• Default: false

Show inspections as they are run in development. When enabled, link inspection results appear as squiggly underlines directly on the page.

runOnBuild

• Type: boolean
• Default: true

Whether to run the link checker on build.

failOnError

• Type: boolean
• Default: false

If set to true, the build will fail if the scanner finds any broken links.

excludeLinks

• Type: (string | RegExp)[]
• Default: [/^\/_/, /^\/llms(-[\w-]+)?\.txt$/]

Links to exclude from inspection. The module adds your entries to the defaults; they do not replace them. 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.

fetchRemoteUrls

• Type: boolean
• Default: false

Whether link checking should fetch remote (external) URLs. When enabled, the module checks if you are online before fetching. Disable this if you are working offline or want to skip external URL validation.

strictNuxtContentPaths

• Type: boolean
• Default: false

This option has no effect. Link Checker reads link sources from Nuxt Content page collections without it.

excludePages

• Type: (string | RegExp)[]
• Default: []

Pages to exclude from link checking entirely. When a page matches, none of its links will be inspected.

Supports the same pattern types as excludeLinks: exact strings, wildcards (using radix3), and regular expressions.

See the Exclude Pages guide for more details.

debug

• Type: boolean
• Default: false

Enable to see debug logs.