plugins/treesitter: update description

Added some more upfront details about the plugin's default settings.
Lots of people assume just enabling the plugin will give them the
behaviors of highlighting they expect, but the plugin does not default
this to be the case.
This commit is contained in:
Austin Horstman 2024-10-09 08:27:08 -05:00
parent e8c8f7f38c
commit 61ec39764f
No known key found for this signature in database

View file

@ -15,6 +15,12 @@ helpers.neovim-plugin.mkNeovimPlugin {
description = ''
Provides an interface to [tree-sitter]
> [!NOTE]
> This plugin defaults to all functionality disabled.
>
> Please explicitly enable the features you would like to use in `plugins.treesitter.settings`.
> For example, to enable syntax highlighting use the `plugins.treesitter.settings.highlight.enable` option.
### Installing tree-sitter grammars from Nixpkgs
By default, **all** available grammars packaged in the `nvim-treesitter` package are installed.