[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)
+```
- [nongnu] elpa/treesit-fold 70b2c79ff4 308/417: changelog, (continued)
- [nongnu] elpa/treesit-fold 70b2c79ff4 308/417: changelog, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 0627723e5f 368/417: Rename license with no ext, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold aa6146bc62 313/417: feat: Add Lisp support (#92), ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 9717243a85 347/417: feat: Add Tablegen support, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 44a237a329 359/417: fixed linting issues in parsers, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 757d2fab67 346/417: feat: Add ActionScript support, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 0b7eb8fb5b 410/417: typo, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold f66e2b8be9 417/417: perf: Wait for post command to render, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold ca1b5d701d 134/417: Update doc, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 86c3e73746 135/417: Add html summary parser, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 20f96511ef 137/417: Update doc,
ELPA Syncer <=
- [nongnu] elpa/treesit-fold 40163da28a 141/417: Update doc, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold f297d8a664 204/417: update, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 4f5ea58d8c 214/417: Update copyright year, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 5711d9f6d5 226/417: refactor(parsers): Place it in alphabetic order, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 443ba5106a 229/417: feat(ruby): Enhance Ruby parser (#26), ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 3b2e70db92 231/417: tests(test.yml): Add workflow_dispatch, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 0bae1476a4 242/417: chore: Changelog and styles (#38), ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 6178f3345c 193/417: update ci, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 095e093737 194/417: Remove unused shell entry, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold ec60327a20 195/417: chore(eask): info, ELPA Syncer, 2024/07/01