NotAShelf/syntax-gaslighting.nvim
1
0
Fork 0
mirror of https://github.com/NotAShelf/syntax-gaslighting.nvim.git synced 2026-04-15 15:33:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: add demo

Browse source
This commit is contained in:
raf 2025-03-05 03:46:28 +03:00
commit de41349888
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
.github/assets/gaslight.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 108 KiB

18
README.md
View file

@ -1,10 +1,13 @@
# syntax-gaslighting.nvim # syntax-gaslighting.nvim
Gaslighting? That's not even a real word, you're crazy. <div align="center">
<p>Gaslighting? That's not even a real word, you're crazy.</p>
<img src=".github/assets/gaslight.png" alt="Syntax Gaslighting in action">
</div>
## Usage ## Usage
Use what? _Use what?_
Install with your favorite package manager (or Nix), then call the `setup` Install with your favorite package manager (or Nix), then call the `setup`
function. function.
@ -31,6 +34,7 @@ require("syntax-gaslighting").setup({
}, },
-- Option to merge user messages with the default ones (default: false) -- Option to merge user messages with the default ones (default: false)
-- If disabled, the messages table will override default messages.
merge_messages = true, -- Default is false merge_messages = true, -- Default is false
-- Highlight group for gaslighting messages (linked to Comment by default) -- Highlight group for gaslighting messages (linked to Comment by default)
@ -49,7 +53,9 @@ require("syntax-gaslighting").setup({
## License ## License
Based on the awesome [VSCode extension]: https://github.com/eNiiju/syntax-gaslighting
[VSCode extension](https://github.com/eNiiju/syntax-gaslighting) from [@eNiiju]: https://github.com/eNiiju
[@eNiiju](https://github.com/eNiiju). To remain compatible with the license,
syntax-gaslighting.nvim is licensed under the [MPL](./LICENSE) Based on the awesome [VSCode extension] by [@eNiiju]. To remain compatible with
the license, syntax-gaslighting.nvim is licensed under the [MPL 2.0](./LICENSE).
Please see the license file for more details.