casraf/vim-matchup
1
0
Fork 0
mirror of https://github.com/chenasraf/vim-matchup.git synced 2026-05-17 17:38:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update matchup.txt with the content of README

Browse Source
This commit is contained in:
TheLeoP
2025-07-07 17:19:52 -05:00
parent bf56cac29d
commit 321045f727
1 changed files with 12 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
doc/matchup.txt
View File

@@ -272,35 +272,21 @@ important special cases.
*matchup-treesitter*
Tree-sitter integration~
Note: Currently this feature is possible in neovim only. Only the latest
version of neovim and nvim-treesitter is supported.
Note: Currently this feature is possible in Neovim only. Only the latest
stable version of Neovim is supported.
match-up has support for language syntax provided by tree-sitter. The list
of supported languages is available here. This feature requires manual
opt-in in your init.vim and requires nvim-treesitter to be installed. >
of supported languages is available here.
Plug 'nvim-treesitter/nvim-treesitter'
lua <<EOF
require'nvim-treesitter.configs'.setup {
matchup = {
enable = true, -- mandatory, false will disable the whole extension
disable = { "c", "ruby" }, -- optional, list of language that will be disabled
-- [options]
},
}
<
Beside enable and disable, the following options are available, all
defaulting to false:
*disable_virtual_text*
This feature is automatically enabled if you are using Neovim. And does not
require other plugins to work.
If true, do not use virtual text to highlight the virtual end of a
block, for languages without explicit end markers (e.g., Python).
*include_match_words*
If true, additionally include traditional vim regex matches for symbols.
The treesitter related configuration options share the prefix
`g:matchup_treesitter`. You can check them on `:h g:matchup_treesitter_enabled`
------------------------------------------------------------------------------
Highlighting matches~
To disable match highlighting at |startup|, use >
@@ -738,7 +724,7 @@ Module matchparen~
`MatchupStatusOffscreen()` can be used to get the text.
`'popup'`: Use a popup window (requires at least vim 8.1.1406) or
a floating window (in neovim) to show the off-screen match.
a floating window (in Neovim) to show the off-screen match.
scrolloff~
When enabled, off-screen matches will not be shown in the statusline while
@@ -768,7 +754,7 @@ Module matchparen~
Default: 0
border~
For floating window on neovim only: set to add a border. If the value
For floating window on Neovim only: set to add a border. If the value
is the integer 1, default borders are enabled. A list or string can
be specified as described in |nvim_open_win()|.
@@ -894,7 +880,7 @@ the function |timer_pause|, version 7.4.2180 and after.
*g:matchup_matchparen_end_sign*
(neovim only) Configure the virtual symbol shown for closeless matches in languages like
(Neovim only) Configure the virtual symbol shown for closeless matches in languages like
C++ and python.
if (true)
@@ -906,7 +892,7 @@ the function |timer_pause|, version 7.4.2180 and after.
*MatchupVirtualText*
(neovim only) You can also configure the color and style of the virtual text.
(Neovim only) You can also configure the color and style of the virtual text.
:hi MatchupVirtualText ctermbg=blue guibg=lightblue gui=italic