Strict builds
Four checks are set to fail rather than warn:
| Setting | Fails the build when |
|---|---|
onBrokenLinks | a link points at a page that does not exist |
onBrokenAnchors | a link points at a heading that does not exist |
markdown.hooks.onBrokenMarkdownLinks | a relative Markdown link resolves to nothing |
markdown.hooks.onBrokenMarkdownImages | an image is missing |
The alternative is a warning that scrolls past in a CI log and a published site with dead links.
To be more lenient during a migration:
export default createConfig({
title: 'voraus.example',
projectName: 'voraus-example',
config: { onBrokenLinks: 'warn' },
})