Skip to content

Commit

Permalink
feat(extras): Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cryptomilk committed Jan 12, 2024
1 parent 0423d27 commit 5dbd104
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions extras/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Extras
======

## Showcases

The directory `showcase` includes files for programming languages. The idea
is to have showcases to check treesitter or LSP support highlights all the
things correctly. If something is not working probably for a language please
contribute a showcase file!

## Reproducer

In order to report bugs there is a simple lua config to create a reproducer.
This makes it easier to fix bugs or add new features.

Note that the `on_highlights` callback can be used to implement support for new
plugins and you can provide a reproducer to show how it should look like.

First download the `repro.lua` file
[here](https://raw.githubusercontent.com/cryptomilk/nightcity.nvim/main/extras/repro.lua).
Modify it and run Neovim with:

nvim -u repro.lua

Once you've reproduced the bug or added the needed stuff to `on_highlights` zip
the `repro.lua` and `.repro` directory and upload it.

0 comments on commit 5dbd104

Please sign in to comment.