barrett/diffs.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 13

fix(doc): move hl documentation to the vimdoc

Browse source
This commit is contained in:
Barrett Ruth 2026-02-03 01:33:31 -05:00
parent 4a1d4ffb85
commit 2e5400f9c0
2 changed files with 13 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -40,26 +40,6 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim):
:help diffs.nvim
```
## Highlight Groups
diffs.nvim defines the following highlight groups. All use `default = true`, so
colorschemes can override them.
| Group | Purpose |
| ----------------- | -------------------------------------------------- |
| `DiffsAdd` | Background for `+` lines in fugitive unified diffs |
| `DiffsDelete` | Background for `-` lines in fugitive unified diffs |
| `DiffsAddNr` | Line number highlight for `+` lines |
| `DiffsDeleteNr` | Line number highlight for `-` lines |
| `DiffsDiffAdd` | Background-only `DiffAdd` for `&diff` windows |
| `DiffsDiffDelete` | Background-only `DiffDelete` for `&diff` windows |
| `DiffsDiffChange` | Background-only `DiffChange` for `&diff` windows |
| `DiffsDiffText` | Background-only `DiffText` for `&diff` windows |
By default, these are computed from your colorscheme's `DiffAdd`, `DiffDelete`,
`DiffChange`, `DiffText`, and `Normal` groups. To customize, define them in your
colorscheme before diffs.nvim loads, or link them to existing groups.
## Known Limitations
- Syntax "flashing": diffs.nvim hooks into the `FileType fugitive` event

21
doc/diffs.nvim.txt
View file

@ -194,8 +194,9 @@ To minimize the flash, use a low debounce value: >lua
==============================================================================
HIGHLIGHT GROUPS *diffs-highlights*
diffs.nvim defines custom highlight groups. All are set with `default = true`,
so colorschemes can override them by defining them first.
diffs.nvim defines custom highlight groups. Fugitive unified diff groups use
`default = true`, so colorschemes can override them. Diff mode groups are
always derived from the corresponding `Diff*` groups.
Fugitive unified diff highlights: ~
*DiffsAdd*
@ -215,20 +216,24 @@ Fugitive unified diff highlights: ~
`diffRemoved`, background from `DiffsDelete`.
Diff mode window highlights: ~
These are background-only variants used for |winhighlight| remapping in
`&diff` windows, allowing treesitter syntax to show through.
These are used for |winhighlight| remapping in `&diff` windows.
*DiffsDiffAdd*
DiffsDiffAdd Background-only version of `DiffAdd`.
DiffsDiffAdd Background-only. Derived from `DiffAdd` bg.
Treesitter provides foreground syntax highlighting.
*DiffsDiffDelete*
DiffsDiffDelete Background-only version of `DiffDelete`.
DiffsDiffDelete Foreground and background from `DiffDelete`.
Used for filler lines (`/////`) which have no real
code content to highlight.
*DiffsDiffChange*
DiffsDiffChange Background-only version of `DiffChange`.
DiffsDiffChange Background-only. Derived from `DiffChange` bg.
Treesitter provides foreground syntax highlighting.
*DiffsDiffText*
DiffsDiffText Background-only version of `DiffText`.
DiffsDiffText Background-only. Derived from `DiffText` bg.
Treesitter provides foreground syntax highlighting.
To customize these in your colorscheme: >lua
vim.api.nvim_set_hl(0, 'DiffsAdd', { bg = '#2e4a3a' })