Skip to content

docs: add lychee config cleanup note for lint:links adopters #61

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
zeitlinger merged 3 commits into from
Mar 2, 2026
Merged

docs: add lychee config cleanup note for lint:links adopters #61

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be84e56
docs: add lychee config cleanup note for lint:links adopters
zeitlinger Feb 24, 2026
d65e3e8
fix: correct remap description per Copilot review
zeitlinger Feb 24, 2026
7cd990a
fix: wrap long line to satisfy editorconfig 100-char limit
zeitlinger Feb 24, 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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,26 @@ two patterns that affect ALL GitHub URLs (any repository):
Set `LYCHEE_SKIP_GITHUB_REMAPS=true` to disable all GitHub-specific
remaps as an escape hatch if they cause unexpected behavior.

**Lychee config cleanup:**

When adopting `lint:links`, you can remove the following entries
from your `lychee.toml` because flint handles them at runtime
via `--remap` arguments:

- **GitHub blob/fragment remap for
[lychee#1729](https://github.com/lycheeverse/lychee/issues/1729)**
— flint remaps fragment URLs to `raw.githubusercontent.com`
for the current PR's head branch, and strips line-number
anchors globally.
- **`#issuecomment-*` excludes** — flint strips the fragment
via remap so the issue/PR page is still checked.
- **`#L\d+` line-number excludes** — flint strips the fragment
via remap so the file is still checked.

Note: flint uses `--remap` (not `--exclude`) for these because
lychee's CLI `--exclude` flags override config file excludes
rather than merging with them.

**Environment variables:**

<!-- editorconfig-checker-disable -->
Expand Down