Skip to main content
0.0.0-dev.1: ???? (??-??-????)
Breaking changes
- linkrot now requires Quarto 1.11 or later.
Features
linkrot identifies broken external links in Quarto documents during rendering.
- Configurable options include:
fail-on-error: Whether to fail the build on broken links.
timeout: Set the timeout duration for link checks.
debug: Enable detailed logging for troubleshooting.
output-file: Specify a file to write the link check report.
skip-patterns: Define patterns for links to skip during checks.
- Uses the
curl command-line tool for robust link checking.
- Supports both HTTP and HTTPS links.
report-scope: project gathers every page’s broken links into one report, grouped by page and kept up to date as pages re-render. Reports and console output name the page each broken link is on.
Bug fixes
fail-on-error: true fails the build when a link is broken, so CI catches it.
- Link checks are sturdier: URLs are passed to
curl safely, timeout accepts fractional seconds, and repeated links are checked once.
Documentation
skip-patterns is documented as Lua patterns, with working examples.