Config
Configure the link checker module.
enabled
- Type:
boolean - Default:
true
Whether to scan links.
skipInspections
- Type:
string[] - Default:
[]
An array of inspection names to skip.
See Inspections 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; } - Default:
undefined
Reports to generate on build.
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[] - Default:
[]
An array of URLs to exclude from the check.
This can be useful if you have a route that is not pre-rendered, but you know it will be valid.
debug
- Type:
boolean - Default:
false
Enable to see debug logs.
host
Deprecated
- 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.
This is now handled by the nuxt-site-config module.
trailingSlash
Deprecated
- Type:
boolean - Default:
false
Whether internal links should have a trailing slash or not.
This is now handled by the nuxt-site-config module.