diff options
| author | kiyan42 <yazdani.kiyan@protonmail.com> | 2020-04-28 12:32:01 +0200 |
|---|---|---|
| committer | kiyan42 <yazdani.kiyan@protonmail.com> | 2020-04-28 12:43:34 +0200 |
| commit | 475fc8988bf40d718c2b7473be3b77024afbf944 (patch) | |
| tree | a71859a1fd66440cbf28554c57d30197d309738a /doc | |
| parent | add documentation (diff) | |
| download | nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar.gz nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar.bz2 nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar.lz nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar.xz nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.tar.zst nvim-treesitter-475fc8988bf40d718c2b7473be3b77024afbf944.zip | |
add vim documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/nvim-treesitter.txt | 50 | ||||
| -rw-r--r-- | doc/tags | 11 |
2 files changed, 36 insertions, 25 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index 1fc986c71..798c5bfc1 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -2,10 +2,10 @@ 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 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* Install the parser for your language + > -:TSInstall {language} + :TSInstall {language} < To get a list of supported languages + > -:TSInstallInfo + :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 - } - } -} - + 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* +COMMANDS *nvim-treesitter-commands* -|:TSInstall| {language} *:TSInstall* +|:TSInstall| {language} *:TSInstall* 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 languages can be found at |:TSInstallInfo| -|:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll* +|:TSBufDisableAll| {module} [{language}] *:TSBufDisableAll* Disable {module} for the session 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 languages can be found at |:TSInstallInfo| -|:TSModuleInfo| [{module}] *:TSModuleInfo* +|:TSModuleInfo| [{module}] *:TSModuleInfo* List modules state for the current session. diff --git a/doc/tags b/doc/tags new file mode 100644 index 000000000..7d69206e3 --- /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* |
