diff options
| -rw-r--r-- | doc/nvim-treesitter.txt | 90 | ||||
| -rw-r--r-- | doc/tags | 11 |
2 files changed, 101 insertions, 0 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt new file mode 100644 index 00000000..798c5bfc --- /dev/null +++ b/doc/nvim-treesitter.txt @@ -0,0 +1,90 @@ +*nvim-treesitter* + +Minimum version of neovim: nightly + +Authors: Yazdani Kiyan <yazdani.kiyan@protonmail.com>, Vigouroux Thomas <tomvig38@gmail.com> + +============================================================================== +INTRODUCTION *nvim-treesitter-intro* + +nvim-treesitter wraps the neovim treesitter api to provide functionnalities such +as highlighting and incremental selection, and a command to easily install parsers. + +============================================================================== +QUICK START *nvim-treesitter-quickstart* + +Install the parser for your language + +> + :TSInstall {language} +< + +To get a list of supported languages + +> + :TSInstallInfo +< + +By default, everything is disabled. To enable support for features, in your `init.vim`: + +> + lua <<EOF + require'nvim-treesitter.configs'.setup { + highlight = { + enable = true, -- false will disable the whole extension + disable = { 'c', 'rust' }, -- list of language that will be disabled + }, + textobj = { -- this enables incremental selection + enable = true, + disable = { 'cpp', 'lua' }, + keymaps = { -- mappings for visual selection + node_incremental = "<leader>e", -- "grn" by default, + scope_incremental = "<leader>f" -- "grc" by default + } + } + } +< + +============================================================================== +COMMANDS *nvim-treesitter-commands* + +|:TSInstall| {language} *:TSInstall* + +Download, compile and install a parser for {language} + +|:TSInstallInfo| *:TSInstallInfo* + +List informations about currently installed parsers + +|:TSBufEnable| {module} *:TSBufEnable* + +Enable {module} on the current buffer. +A list of modules can be found at |:TSModuleInfo| + +|:TSBufDisable| {module} *:TSBufDisable* + +Disable {module} on the current buffer +A list of modules can be found at |:TSModuleInfo| + +|:TSBufEnableAll| {module} [{language}] *:TSBufEnableAll* + +Enable {module} for the session +if {language} is specified, enable module for the session only for this +particular language. +A list of modules can be found at |:TSModuleInfo| +A list of languages can be found at |:TSInstallInfo| + +|:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll* + +Disable {module} for the session +if {language} is specified, disable module for the session only for this +particular language. +A list of modules can be found at |:TSModuleInfo| +A list of languages can be found at |:TSInstallInfo| + +|:TSModuleInfo| [{module}] *:TSModuleInfo* + +List modules state for the current session. + + vim:tw=78:ts=8:noet:ft=help:norl: + diff --git a/doc/tags b/doc/tags new file mode 100644 index 00000000..7d69206e --- /dev/null +++ b/doc/tags @@ -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* |