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

add vim documentation

Browse source
This commit is contained in:
kiyan42 2020-04-28 12:32:01 +02:00
parent f83b76b488
commit 475fc8988b
2 changed files with 36 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

50
doc/nvim-treesitter.txt
View file

@ -2,10 +2,10 @@
Minimum version of neovim: nightly Minimum version of neovim: nightly
Authors: Yazdani Kiyan <yazdani.kiyan@protonmail.com>, Vigouroux Thomas <@EMAIL?> Authors: Yazdani Kiyan <yazdani.kiyan@protonmail.com>, Vigouroux Thomas <tomvig38@gmail.com>
============================================================================== ==============================================================================
INTRODUCTION *nvim-treesitter* INTRODUCTION *nvim-treesitter-intro*
nvim-treesitter wraps the neovim treesitter api to provide functionnalities such nvim-treesitter wraps the neovim treesitter api to provide functionnalities such
as highlighting and incremental selection, and a command to easily install parsers. as highlighting and incremental selection, and a command to easily install parsers.
@ -14,41 +14,41 @@ as highlighting and incremental selection, and a command to easily install parse
QUICK START *nvim-treesitter-quickstart* QUICK START *nvim-treesitter-quickstart*
Install the parser for your language Install the parser for your language
> >
:TSInstall {language} :TSInstall {language}
< <
To get a list of supported languages To get a list of supported languages
> >
:TSInstallInfo :TSInstallInfo
< <
By default, everything is disabled. To enable support for features, in your `init.vim`: By default, everything is disabled. To enable support for features, in your `init.vim`:
> >
lua <<EOF
lua <<EOF require'nvim-treesitter.configs'.setup {
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 },
}, textobj = { -- this enables incremental selection
textobj = { -- this enables incremental selection enable = true,
enable = true, disable = { 'cpp', 'lua' },
disable = { 'cpp', 'lua' }, keymaps = { -- mappings for visual selection
keymaps = { -- mappings for visual selection node_incremental = "<leader>e", -- "grn" by default,
node_incremental = "<leader>e" -- "grn" by default, scope_incremental = "<leader>f" -- "grc" by default
scope_incremental = "<leader>f" -- "grc" by default }
} }
} }
}
< <
============================================================================== ==============================================================================
COMMANDS *nvim-treesitter-commands* COMMANDS *nvim-treesitter-commands*
|:TSInstall| {language} *:TSInstall* |:TSInstall| {language} *:TSInstall*
Download, compile and install a parser for {language} Download, compile and install a parser for {language}
@ -74,7 +74,7 @@ particular language.
A list of modules can be found at |:TSModuleInfo| A list of modules can be found at |:TSModuleInfo|
A list of languages can be found at |:TSInstallInfo| A list of languages can be found at |:TSInstallInfo|
|:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll* |:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll*
Disable {module} for the session Disable {module} for the session
if {language} is specified, disable module for the session only for this if {language} is specified, disable module for the session only for this
@ -82,7 +82,7 @@ particular language.
A list of modules can be found at |:TSModuleInfo| A list of modules can be found at |:TSModuleInfo|
A list of languages can be found at |:TSInstallInfo| A list of languages can be found at |:TSInstallInfo|
|:TSModuleInfo| [{module}] *:TSModuleInfo* |:TSModuleInfo| [{module}] *:TSModuleInfo*
List modules state for the current session. List modules state for the current session.

11
doc/tags Normal file
View file

@ -0,0 +1,11 @@
:TSBufDisable nvim-treesitter.txt /*:TSBufDisable*
:TSBufDisableAll nvim-treesitter.txt /*:TSBufDisableAll*
:TSBufEnable nvim-treesitter.txt /*:TSBufEnable*
:TSBufEnableAll nvim-treesitter.txt /*:TSBufEnableAll*
:TSInstall nvim-treesitter.txt /*:TSInstall*
:TSInstallInfo nvim-treesitter.txt /*:TSInstallInfo*
:TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo*
nvim-treesitter nvim-treesitter.txt /*nvim-treesitter*
nvim-treesitter-commands nvim-treesitter.txt /*nvim-treesitter-commands*
nvim-treesitter-intro nvim-treesitter.txt /*nvim-treesitter-intro*
nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart*