Introduction
By default, links will be scanned when you run your build.
Generating Reports
To make working in a CI environment easier, you are able to generate a static report of the broken links.
There are two reports available: html
and markdown
.
To generate them, you can provide the report
option:
export default defineNuxtConfig({
linkChecker: {
report: {
// generate both a html and markdown report
html: true,
markdown: true,
}
},
})
The reports will be output in the following paths:
html
:./output/link-checker-report.html
markdown
:./output/link-checker-report.md
Did this page help you?