diff options
| author | Thomas Vigouroux <tomvig38@gmail.com> | 2020-05-07 08:18:13 +0200 |
|---|---|---|
| committer | Thomas Vigouroux <tomvig38@gmail.com> | 2020-05-07 13:04:53 +0200 |
| commit | 703ccbec594219e0331c434ee57a0a48c92b280e (patch) | |
| tree | 15d220a3581f2ceb24ab4fac079bdd5560efe62f | |
| parent | feat: provide a statusline indicator (diff) | |
| download | nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.gz nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.bz2 nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.lz nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.xz nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.zst nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.zip | |
docs: add statusline indicator informations.
Also document newly added parsers by adding them in the readme.
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/nvim-treesitter.txt | 13 | ||||
| -rw-r--r-- | doc/tags | 2 |
3 files changed, 22 insertions, 1 deletions
@@ -135,6 +135,7 @@ Some of these features are : - [ ] Syntax based code folding - [x] Consistent syntax highlighting (the api is not quite stable yet) - [x] Cursor movement in node hierachy + - [x] Statusline indicator (`require'nvim-treesitter'.statusline(size)`) You can find the roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1). The roadmap and all features of this plugin are open to change, and any suggestion will be highly appreciated! @@ -166,6 +167,13 @@ List of currently supported languages: - [ ] julia - [ ] php - [ ] bash +- [ ] scala +- [ ] haskell +- [ ] toml +- [ ] vue +- [ ] elm +- [ ] yaml +- [ ] nix ## Troubleshooting Before doing anything run `:checkhealth nvim_treesitter`. This will help you find where the bug might come from. diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt index ceb834be1..084936bad 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: @@ -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()* |