emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/treesit-fold 20f96511ef 137/417: Update doc


From: ELPA Syncer
Subject: [nongnu] elpa/treesit-fold 20f96511ef 137/417: Update doc
Date: Mon, 1 Jul 2024 10:02:19 -0400 (EDT)

branch: elpa/treesit-fold
commit 20f96511ef6d0bf1afda758eaec4511cdea2bc94
Author: Jen-Chieh <jcs090218@gmail.com>
Commit: Jen-Chieh <jcs090218@gmail.com>

    Update doc
---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index fecc653d2b..23e3f87240 100644
--- a/README.md
+++ b/README.md
@@ -67,3 +67,28 @@ Enable `tree-sitter-mode` first, then 
`tree-sitter-query-builder` is useful to t
 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.
+
+## Indicators Mode
+
+You can enable this manually by doing the folloiwng
+
+```
+M-x tree-sitter-fold-indicators-mode
+```
+
+To enable this automatically whenever `tree-sitter-mode' is enabled:
+
+```el
+(add-hook 'tree-sitter-after-on-hook #'tree-sitter-fold-indicators-mode)
+```
+
+## Summary
+
+This plugin automatically extract summary from the comment/document string,
+so you can have a nice way to peek what's inside the fold range.
+
+If you don't want this to happens, do: (Default is `t`)
+
+```el
+(setq tree-sitter-fold-summary-show nil)
+```



reply via email to

[Prev in Thread] Current Thread [Next in Thread]