docs/lychee.toml at main · zuplo/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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    # Lychee configuration for Zuplo docs

    # Cache settings
    cache = true
    max_cache_age = "1d"

    # Network settings
    max_concurrency = 10
    timeout = 20
    max_retries = 2
    retry_wait_time = 2


    # Exclude private IPs
    exclude_all_private = true

    # Accept these status codes as valid
    accept = [200, 201, 202, 203, 204, 301, 302, 303, 307, 308, 429]

    # Exclude patterns
    exclude = [
        # Exclude Examples
        "https://my-service-a2ev-uc.a.run.app/",
        "portal.azure.com",
        "portal.zuplo.com",
        "dashboard.clerk.com",
        "https://app.amberflo.io/ingest",
        "auth0\\.com",
        "example\\.(com|org|net)",
        "https://zuplo.com/docs/400",
        "https://zuplo.com/docs/404",
        "https://zuplo.com/docs/500",
        "stackoverflow.com",
        "ecommerce-api.zuplo.io",
        "ecommerce-legacy.zuplo.io",
        "techdocs.akamai.com",
        "metric-api.newrelic.com",
        "log-api.newrelic.com",
        "https://openid.net/specs/openid-connect-core-1_0.html#UserInfo",
        "https://www.fastly.com/documentation/guides/concepts/edge-state/dynamic-config/#edge-dictionaries",

        "cdn.simpleicons.org",
        "github.com",
        "https://ui.shadcn.com/docs/components/callout",
        "platform.openai.com",
        "www.linkedin.com"
    ]

    exclude_path = [
        "\\.(md|txt)$",
    ]

    # Custom user agent
    user_agent = "Mozilla/5.0 (compatible; lychee/0.23.0)"

    # Headers to send with requests
    header = { "accept" = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }