Skip to content

Fix link checker CI by excluding Fumadocs framework patterns #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hotlong merged 3 commits into from
Jan 28, 2026
Merged

Fix link checker CI by excluding Fumadocs framework patterns #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2871787
Initial plan
Copilot Jan 28, 2026
a74d2c8
Fix link checker by excluding Fumadocs meta.json files
Copilot Jan 28, 2026
d994649
Exclude Fumadocs relative file links from lychee checking
Copilot Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/check-links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ jobs:
# Use configuration file for path remapping and settings
args: >-
--config lychee.toml
--exclude-path '**/meta.json'
--exclude-path '**/meta.cn.json'
Comment on lines +29 to +30
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--exclude-path '**/meta.json' / --exclude-path '**/meta.cn.json' appear redundant with the current invocation because the inputs being scanned are only content/**/*.md, content/**/*.mdx, and README.md (so no meta*.json files are included). If the intent is to prevent lychee from parsing those JSON files, either remove these flags for clarity or broaden the input globs to include the JSON files and keep the excludes.

Suggested change
--exclude-path '**/meta.json'
--exclude-path '**/meta.cn.json'

Copilot uses AI. Check for mistakes.
'content/**/*.md'
'content/**/*.mdx'
'README.md'
Expand Down
4 changes: 4 additions & 0 deletions .lycheeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ https://x.com*

# Common false positives
mailto:*

# Fumadocs metadata files (not actual links)
**/meta.json
**/meta.cn.json
6 changes: 5 additions & 1 deletion lychee.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ exclude = [
"https://x.com*",

# Email links
"mailto:*"
"mailto:*",

# Fumadocs relative links (handled by framework at runtime)
# These are links like ./agent that resolve to .mdx files
"file://**/content/docs/**"
Comment on lines +57 to +59
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new exclude pattern file://**/content/docs/** is very broad and will match all file:// URLs under content/docs (including the remapped /docs/... links that this config is intended to validate). That likely disables internal doc link validation entirely and leaves only external HTTP/HTTPS checks. Consider narrowing this to only the problematic extensionless routes (e.g., links that don’t end with .md/.mdx) or adding a remap strategy that appends .mdx/.md for Fumadocs-style ./agent routes, so existing internal link checks remain effective.

Copilot uses AI. Check for mistakes.
]

# Cache results to speed up subsequent runs
Expand Down
Loading