.lychee.toml

# Validate ordinary anchor fragments and text fragments to maximize coverage.
include_fragments = "full"

# Remembered results keep a repeated check from depending on every host being reachable. Transient
# failures are excluded, so a rate limited host is retried rather than remembered as broken.
cache = true
max_cache_age = "1d"
cache_exclude_status = ["429", "500..504"]

# A 429 means this checker is being throttled rather than that the link is gone.
# The success range is repeated because `accept` replaces the default rather than extending it.
accept = ["200..=299", "429"]

# Resolve directory URLs such as setup/required/ to their generated index.html.
# This is necessary because the deployed site uses directory URLs.
index_files = ["index.html"]

exclude = [
  # doxygen.nl returns 403/415 responses to automated link checks.
  '^https://www\.doxygen\.nl(/|$)',
  # Generated by the `repo` macro, which resolves every path against the working tree while
  # building. Checking them here would add network flakiness, and would fail for a path that a pull
  # request adds alongside the page documenting it.
  '^https://github\.com/DataDog/datadog-agent/(blob|tree)/',
]

# Zensical's 404 page uses root-relative URLs because it can be served at any
# missing path. Exclude that generated page because its links cannot be resolved
# against the local site directory without special root mapping.
# See https://github.com/zensical/zensical/issues/764.
exclude_path = ['^site(/|\\)404\.html$']