add vim documentation

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

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,11 +14,13 @@ 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
< <
@ -26,7 +28,6 @@ To get a list of supported languages
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 = {
@ -37,12 +38,11 @@ require'nvim-treesitter.configs'.setup {
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
} }
} }
} }
< <
============================================================================== ==============================================================================

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*