Skip to content

docs/lychee-external

Checks every external link over the network.

Part of the docs configuration, at the recommended level. It runs only when gspot check --only docs/lychee-external names it, per file. It runs lychee. It needs network access.

External links break over time; this check reports which ones did.

Update or remove the link, or exclude the URL pattern with a reason under docs.allowed_urls.

A link that returns HTTP 404 reports a broken destination. Replace the URL with a current one, or remove the link.

Turn it off for some files, or one of its lint rules, with a reason:

gspot ignore docs/lychee-external --paths "<glob>" --reason "<why>"
gspot ignore docs/lychee-external --rule <rule> --reason "<why>"