diff --git a/lib/antora-link-checker-extension.js b/lib/antora-link-checker-extension.js index 185f6433..a5aecf9f 100644 --- a/lib/antora-link-checker-extension.js +++ b/lib/antora-link-checker-extension.js @@ -1,3 +1,6 @@ +// This extension stops the Antora site generator from building the site after checking internal links (xrefs). +// As a result, the output is a list of broken links rather than a documentation site. + module.exports.register = (context) => { context.on('documentsConverted', () => { context.stop()