1+ # .github/lychee.toml
2+
3+ # ############################ Display #############################
4+ # Verbose program output
5+ # Accepts log level: "error", "warn", "info", "debug", "trace"
6+ verbose = " info"
7+
8+ # Don't show interactive progress bar while checking links.
9+ no_progress = false
10+
11+ # ############################ Cache ###############################
12+ # Enable link caching. This can be helpful to avoid checking the same links on
13+ # multiple runs.
14+ cache = true
15+
16+ # Discard all cached requests older than this duration.
17+ max_cache_age = " 1d"
18+
19+ # ############################ Runtime #############################
20+ # Maximum number of concurrent link checks.
21+ max_concurrency = 12
22+
23+ # Maximum number of allowed redirects.
24+ max_redirects = 10
25+
26+ # Maximum number of allowed retries before a link is declared dead.
27+ max_retries = 5
28+
29+ # ############################ Requests ############################
30+ # Website timeout from connect to response finished.
31+ timeout = 60
32+
33+ # Minimum wait time in seconds between retries of failed requests.
34+ retry_wait_time = 3
35+
36+ # Accept more status codes (follow redirects automatically)
37+ accept = [" 200..=204" , " 301..=308" , " 429" ]
38+
39+ # Avoid false fragment errors
40+ include_fragments = false
41+
42+ # Only test links with the given schemes (e.g. https).
43+ # Omit to check links with any other scheme.
44+ # At the moment, we support http, https, file, and mailto.
45+ scheme = [" https" ]
46+
47+ # When links are available using HTTPS, treat HTTP links as errors.
48+ require_https = false
49+
50+ # Fallback extensions to apply when a URL does not specify one.
51+ # This is common in documentation tools that cross-reference files without extensions.
52+ fallback_extensions = [" md" , " html" ]
53+
54+ # ############################ Exclusions ##########################
55+ # Check links inside `<code>` and `<pre>` blocks as well as Markdown code
56+ # blocks.
57+ include_verbatim = false
58+
59+ # Ignore case of paths when matching glob patterns.
60+ glob_ignore_case = false
61+
62+ # Exclude URLs and mail addresses from checking (supports regex).
63+ exclude = [
64+ ' ^mailto:' ,
65+ ' ^https?://localhost' ,
66+ ' ^https?://127\\.0\\.0\\.1' ,
67+ ' ^https://www\.linkedin\.com' ,
68+ ' ^https?://web\\.archive\\.org/web/'
69+ ]
70+
71+ # Exclude these filesystem paths from getting checked.
72+ exclude_path = [
73+ ' (^|/)node_modules/' ,
74+ ' (^|/)dist/' ,
75+ ' (^|/)bin/' ,
76+ ' \\.txt$' , # skip .txt extensions
77+ ' (^|/)test/' # skip directories named "test"
78+ ]
79+
80+ # URLs to check (supports regex). Has preference over all excludes.
81+ include = [' gist\.github\.com.*' ]
82+
83+ # Skip checking mail addresses
84+ include_mail = true
0 commit comments