valkey-glide-docs/lychee.toml at main · valkey-io/valkey-glide-docs · 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
# lychee.toml

max_retries = 3
retry_wait_time = 10

# Exclude specific files from being scanned
exclude_path = [
    "dist/404.html",
    "dist/languages/java/api",
    "dist/languages/nodejs/api",
    "dist/languages/python/api",
]

# Exclude specific URLs/links (RegEx)
exclude = [
    # GitHub edit links
    'https://github\.com/valkey-io/valkey-glide-docs/edit/.*',

    # The repo is private so it will cause error.
    'https://github.com/valkey-io/valkey-glide-docs',

    # When adding a new page, it would not be live when Lychee checks the links.
    # It will return error, blocking both PR and deployment workflows.
    # We ignore the live URL to get around this. Also, any internal links should use absolute url which
    # are still checked by Lychee.
    'https://glide.valkey.io/.*',

    # API Documentation exclusions
    '.*/languages/java/api',
    '.*/languages/nodejs/api',
    '.*/languages/python/api',

    # Specific file link exclusion
    './dist/404.html'
]