benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-01 19:17:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: be more explicit about additional_vim_regex_highlighting (#1561)

Browse source
This commit is contained in:
Stephan Seitz 2021-07-14 01:08:57 +02:00 • committed by GitHub
parent b2008fcda1
commit 29113e6892
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -107,6 +107,11 @@ require'nvim-treesitter.configs'.setup {
highlight = { highlight = {
enable = true, -- false will disable the whole extension enable = true, -- false will disable the whole extension
disable = { "c", "rust" }, -- list of language that will be disabled disable = { "c", "rust" }, -- list of language that will be disabled
-- Setting this to true will run `:h syntax` and tree-sitter at the same time.
-- Set this to `true` if you depend on 'syntax' being enabled (like for indentation).
-- Using this option may slow down your editor, and you may see some duplicate highlights.
-- Instead of true it can also be a list of languages
additional_vim_regex_highlighting = false,
}, },
} }
EOF EOF
@ -225,6 +230,11 @@ require'nvim-treesitter.configs'.setup {
-- Highlight the @foo.bar capture group with the "Identifier" highlight group. -- Highlight the @foo.bar capture group with the "Identifier" highlight group.
["foo.bar"] = "Identifier", ["foo.bar"] = "Identifier",
}, },
-- Setting this to true will run `:h syntax` and tree-sitter at the same time.
-- Set this to `true` if you depend on 'syntax' being enabled (like for indentation).
-- Using this option may slow down your editor, and you may see some duplicate highlights.
-- Instead of true it can also be a list of languages
additional_vim_regex_highlighting = false,
}, },
} }
EOF EOF

4
doc/nvim-treesitter.txt
View file

@ -111,7 +111,7 @@ Supported options:
- disable: list of languages. - disable: list of languages.
- custom_captures: A map of user defined capture groups to highlight groups. - custom_captures: A map of user defined capture groups to highlight groups.
See |nvim-treesitter-query-extensions|. See |nvim-treesitter-query-extensions|.
- additional_vim_regex_highlighting: `true` or `false`, or a dictionary of languages. - additional_vim_regex_highlighting: `true` or `false`, or a list of languages.
Set this to `true` if you depend on 'syntax' being enabled Set this to `true` if you depend on 'syntax' being enabled
(like for indentation). Using this option may slow down your editor, (like for indentation). Using this option may slow down your editor,
and you may see some duplicate highlights. and you may see some duplicate highlights.
@ -126,6 +126,8 @@ Supported options:
-- Highlight the @foo.bar capture group with the "Identifier" highlight group. -- Highlight the @foo.bar capture group with the "Identifier" highlight group.
["foo.bar"] = "Identifier", ["foo.bar"] = "Identifier",
}, },
-- Setting this to true or a list of languages will run `:h syntax` and tree-sitter at the same time.
additional_vim_regex_highlighting = false,
}, },
} }
EOF EOF