benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-16 02:10:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add statusline indicator informations.

Browse source 
Also document newly added parsers by adding them in the readme.
This commit is contained in:
Thomas Vigouroux 2020-05-07 08:18:13 +02:00
parent 7682a1a49f
commit 703ccbec59
3 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -135,6 +135,7 @@ Some of these features are :
- [ ] Syntax based code folding - [ ] Syntax based code folding
- [x] Consistent syntax highlighting (the api is not quite stable yet) - [x] Consistent syntax highlighting (the api is not quite stable yet)
- [x] Cursor movement in node hierachy - [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). 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! 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 - [ ] julia
- [ ] php - [ ] php
- [ ] bash - [ ] bash
- [ ] scala
- [ ] haskell
- [ ] toml
- [ ] vue
- [ ] elm
- [ ] yaml
- [ ] nix
## Troubleshooting ## Troubleshooting
Before doing anything run `:checkhealth nvim_treesitter`. This will help you find where the bug might come from. Before doing anything run `:checkhealth nvim_treesitter`. This will help you find where the bug might come from.

13
doc/nvim-treesitter.txt
View file

@ -97,5 +97,16 @@ A list of languages can be found at |:TSInstallInfo|
List modules state for the current session. 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:

2
doc/tags
View file

@ -7,5 +7,7 @@
:TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo* :TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo*
nvim-treesitter nvim-treesitter.txt /*nvim-treesitter* nvim-treesitter nvim-treesitter.txt /*nvim-treesitter*
nvim-treesitter-commands nvim-treesitter.txt /*nvim-treesitter-commands* 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-intro nvim-treesitter.txt /*nvim-treesitter-intro*
nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart* nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart*
nvim_treesitter#statusline() nvim-treesitter.txt /*nvim_treesitter#statusline()*