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

docs: add lazy.nvim installation FAQ (#125)

Browse source 
## Problem

Users attempt to lazy-load diffs.nvim with `event`, `ft`, `lazy`, or
`keys` options, which interferes with the plugin's own `FileType`
autocmd registered at startup.

## Solution

Add a FAQ entry with a correct lazy.nvim snippet using `init` and a
note explaining that the plugin lazy-loads itself.
This commit is contained in:
Barrett Ruth 2026-02-15 18:55:54 -05:00 • committed by GitHub
parent 028ba5314e
commit a00993820f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -40,6 +40,22 @@ luarocks install diffs.nvim
## FAQ ## FAQ
**How do I install with lazy.nvim?**
```lua
{
'barrettruth/diffs.nvim',
init = function()
vim.g.diffs = {
...
}
end,
}
```
Do not lazy load `diffs.nvim` with `event`, `lazy`, `ft`, `config`, or `keys` to
control loading - `diffs.nvim` lazy-loads itself.
**Does diffs.nvim support vim-fugitive/Neogit?** **Does diffs.nvim support vim-fugitive/Neogit?**
Yes. Enable it in your config: Yes. Enable it in your config: