Skip to content

Commit 1298145

Browse files
Copilothuangyiirene
andcommitted
chore: add lychee.toml configuration and remove old markdown-link-check config
- Add lychee.toml with proper configuration for link checking - Remove outdated markdown-link-check-config.json - Update documentation references to use lychee.toml instead - Configure proper timeouts, retries, and exclusions Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 8a160a6 commit 1298145

4 files changed

Lines changed: 35 additions & 35 deletions

File tree

.github/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This directory contains all GitHub-specific configuration and automation for the
1818
│ └── check-links.yml # Documentation link validation
1919
├── dependabot.yml # Automated dependency updates
2020
├── labeler.yml # PR labeling rules
21-
├── markdown-link-check-config.json # Link checker config
2221
└── WORKFLOWS.md # Detailed workflow documentation
2322
```
2423

.github/WORKFLOWS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,11 @@ docs: update architecture guide
221221

222222
**Features:**
223223
- Checks all markdown files for broken links
224-
- Configurable via `.github/markdown-link-check-config.json`
224+
- Configurable via `lychee.toml` in repository root
225225
- Ignores localhost and internal anchors
226226
- Retries on 429 errors
227227

228-
**Configuration:** `.github/markdown-link-check-config.json`
228+
**Configuration:** `lychee.toml`
229229

230230
---
231231

@@ -292,7 +292,7 @@ To customize workflows:
292292
2. Update configuration files:
293293
- `.github/labeler.yml` - Label rules
294294
- `.github/dependabot.yml` - Dependency update settings
295-
- `.github/markdown-link-check-config.json` - Link checker settings
295+
- `lychee.toml` - Link checker settings (in repository root)
296296

297297
---
298298

.github/markdown-link-check-config.json

Lines changed: 0 additions & 31 deletions
This file was deleted.

lychee.toml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Lychee link checker configuration
2+
3+
# Exclude these patterns from checking
4+
exclude = [
5+
# Local development URLs
6+
"^http://localhost",
7+
"^https://localhost",
8+
9+
# Anchor links (internal page references)
10+
"^#",
11+
]
12+
13+
# HTTP request timeout in seconds
14+
timeout = 20
15+
16+
# Maximum number of retries
17+
max_retries = 3
18+
19+
# Retry on 429 (Too Many Requests)
20+
retry_wait_time = 2
21+
22+
# Accept these status codes as valid
23+
accept = [200, 201, 204, 206, 301, 302, 307, 308]
24+
25+
# User agent
26+
user_agent = "Mozilla/5.0 (compatible; lychee/0.21.0)"
27+
28+
# Maximum number of concurrent requests
29+
max_concurrency = 8
30+
31+
# Include verbosity in output
32+
verbose = true

0 commit comments

Comments
 (0)