branch: elpa/treesit-fold
commit 399af3b42f53ce39e7a689a887c4320da5c6a765
Author: JenChieh <[email protected]>
Commit: JenChieh <[email protected]>
Add more doc
---
README.md | 28 +++++++++++++++++++++-------
1 file changed, 21 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 40fc6333ce..6b135289bc 100644
--- a/README.md
+++ b/README.md
@@ -31,10 +31,24 @@ then in Emacs:
## Usage
- | Commands | Description
|
-
|-----------------------------------|-----------------------------------------------------------------------------|
- | tree-sitter-fold-close | fold the current syntax node.
|
- | tree-sitter-fold-open | open all folds inside the current
syntax node. |
- | tree-sitter-fold-open-recursively | open the outmost fold of the current
syntax node. Keep the sub-folds close. |
- | tree-sitter-fold-close-all | close all foldable syntax nodes in the
current buffer. |
- | tree-sitter-fold-open-all | open all folded syntax nodes in the
current buffer. |
+| Commands | Description
|
+|-----------------------------------|-----------------------------------------------------------------------------|
+| tree-sitter-fold-close | fold the current syntax node.
|
+| tree-sitter-fold-open | open all folds inside the current syntax
node. |
+| tree-sitter-fold-open-recursively | open the outmost fold of the current
syntax node. Keep the sub-folds close. |
+| tree-sitter-fold-close-all | close all foldable syntax nodes in the
current buffer. |
+| tree-sitter-fold-open-all | open all folded syntax nodes in the
current buffer. |
+
+## Supported languages
+
+* Go
+* Nix
+* Python
+* R
+
+## Contribution
+
+Enable `tree-sitter-mode` first, then `tree-sitter-query-builder` is useful to
test
+out queries that determine what syntax nodes should be foldable and how to fold
+them.
[emacs-tree-sitter](https://ubolonton.github.io/emacs-tree-sitter/syntax-highlighting/queries/)
+has an excellent documentation on how to write `tree-sitter` queries.
