kreuzberg/.lychee.toml at main · kreuzberg-dev/kreuzberg · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Configuration for the lychee link checker.
# https://github.com/lycheeverse/lychee

# root_dir for resolving root-relative links is set dynamically in
# `.task/tools/docs.yml` via `--root-dir "$PWD/docs"` — must be absolute,
# so we do not hardcode it here.

# Exclude common patterns that produce false positives
exclude = [
  # Localhost / loopback addresses
  "localhost",
  "127\\.0\\.0\\.1",
  "0\\.0\\.0\\.0",

  # Placeholder / example domains
  "example\\.com",
  "example\\.org",

  # Template variables (e.g. ${var}, {{ var }})
  "\\$\\{",
  "\\{\\{",

  # GitHub edit links (require auth)
  "github\\.com/.*/edit/",

  # GitHub raw links for new/renamed files (404 until pushed)
  "github\\.com/.*/raw/",

  # Docs site self-references (404 until deployed, or unreachable from CI)
  "kreuzberg\\.dev",

  # PyPI project pages (rate-limited)
  "pypi\\.org/project/",

  # crates.io (rate-limited)
  "crates\\.io/crates/",

  # npm (rate-limited)
  "npmjs\\.com/package/",
]

# Accept these HTTP status codes as valid
accept = [200, 204, 301, 302, 429]

# Connection timeout in seconds
timeout = 30

# Max retries per link
max_retries = 3

# Max concurrent requests
max_concurrency = 10

# Do not check email addresses
include_mail = false

# Do not require HTTPS
require_https = false

# Cache results to speed up repeated runs
cache = true