diff --git a/README.md b/README.md index 8bcdd1b0..c018645b 100644 --- a/README.md +++ b/README.md @@ -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:**