From f83b76b488505720538a37b7b2bffc3c85771adb Mon Sep 17 00:00:00 2001 From: kiyan42 Date: Tue, 28 Apr 2020 12:22:11 +0200 Subject: add documentation --- doc/nvim-treesitter.txt | 90 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 doc/nvim-treesitter.txt (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt new file mode 100644 index 00000000..1fc986c7 --- /dev/null +++ b/doc/nvim-treesitter.txt @@ -0,0 +1,90 @@ +*nvim-treesitter* + +Minimum version of neovim: nightly + +Authors: Yazdani Kiyan , Vigouroux Thomas <@EMAIL?> + +============================================================================== +INTRODUCTION *nvim-treesitter* + +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 < Date: Tue, 28 Apr 2020 12:32:01 +0200 Subject: add vim documentation --- doc/nvim-treesitter.txt | 50 ++++++++++++++++++++++++------------------------- doc/tags | 11 +++++++++++ 2 files changed, 36 insertions(+), 25 deletions(-) create mode 100644 doc/tags (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index 1fc986c7..798c5bfc 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -2,10 +2,10 @@ Minimum version of neovim: nightly -Authors: Yazdani Kiyan , Vigouroux Thomas <@EMAIL?> +Authors: Yazdani Kiyan , Vigouroux Thomas ============================================================================== -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 < Date: Fri, 1 May 2020 12:26:57 +0200 Subject: update docs for ensure installed, move modules config in config.modules --- doc/nvim-treesitter.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index 798c5bfc..55ada159 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -41,7 +41,8 @@ By default, everything is disabled. To enable support for features, in your `ini node_incremental = "e", -- "grn" by default, scope_incremental = "f" -- "grc" by default } - } + }, + ensure_installed = 'all' -- can be one of 'all', 'language' or {'language1', 'language2' ... } } < -- cgit v1.2.3 From a33bccaaf0c69146dfe330feb52e05c975054468 Mon Sep 17 00:00:00 2001 From: Stephan Seitz Date: Sun, 3 May 2020 11:10:36 +0200 Subject: Add documentation for `node_movement`, rename: `textobj` -> `incremental_selection` --- doc/nvim-treesitter.txt | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index 55ada159..ceb834be 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -30,19 +30,29 @@ By default, everything is disabled. To enable support for features, in your `ini > lua < Date: Thu, 7 May 2020 08:18:13 +0200 Subject: docs: add statusline indicator informations. Also document newly added parsers by adding them in the readme. --- doc/nvim-treesitter.txt | 13 ++++++++++++- doc/tags | 2 ++ 2 files changed, 14 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index ceb834be..084936ba 100644 --- a/doc/nvim-treesitter.txt +++ b/doc/nvim-treesitter.txt @@ -97,5 +97,16 @@ A list of languages can be found at |:TSInstallInfo| List modules state for the current session. - vim:tw=78:ts=8:noet:ft=help:norl: +============================================================================== +FUNCTIONS~ + *nvim-treesitter-functions* + +|nvim_treesitter#statusline(size)| + *nvim_treesitter#statusline()* +Returns a string describing the current position in the syntax tree. This +could be used as a statusline indicator. +Note: The `size` argument is optionnal. When specified, the string will not be + longer than `size`. + + vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/tags b/doc/tags index 7d69206e..f712ecf0 100644 --- a/doc/tags +++ b/doc/tags @@ -7,5 +7,7 @@ :TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo* nvim-treesitter nvim-treesitter.txt /*nvim-treesitter* nvim-treesitter-commands nvim-treesitter.txt /*nvim-treesitter-commands* +nvim-treesitter-functions nvim-treesitter.txt /*nvim-treesitter-functions* nvim-treesitter-intro nvim-treesitter.txt /*nvim-treesitter-intro* nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart* +nvim_treesitter#statusline() nvim-treesitter.txt /*nvim_treesitter#statusline()* -- cgit v1.2.3