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

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

[elpa] externals/indent-bars fd5a01d38e 155/431: Update README.md


From: ELPA Syncer
Subject: [elpa] externals/indent-bars fd5a01d38e 155/431: Update README.md
Date: Mon, 16 Sep 2024 12:59:23 -0400 (EDT)

branch: externals/indent-bars
commit fd5a01d38eef9bd6550b3fc05c5a1a8745a24c24
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>

    Update README.md
---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5064e4d6fd..0cd6278604 100644
--- a/README.md
+++ b/README.md
@@ -147,7 +147,13 @@ into this:
 
 **Note**: This requires Emacs 29 built with tree-sitter support, and the 
appropriate tree-sitter grammars installed for languages of interest.
 
-The easiest way to discover the node types of interest is to `M-x 
treesit-explore-mode`, highlight the beginning a line with too many bars, and 
look up in the tree for the names of obvious nodes.  Add these to 
`indent-bars-treesit-wrap` for the language of interest.
+### Configuring tree-sitter
+
+The main thing to do is configure `indent-bars-treesit-wrap` with the node 
types that lead to unwanted additional bars do their wrapping indentation 
behavior.  I recommend starting with the minimal possible set.  
+
+The easiest way to discover the node types of interest is to `M-x 
treesit-explore-mode`, then highlight the beginning of a line with too many 
bars, and look in the `treesitter explorer` buffer which pops up for the names 
of obvious nodes in the tree.  Add these types to `indent-bars-treesit-wrap` 
for the language of interest, then `M-x indent-bars-reset` and see how you did. 
 You can do something similar for 
`indent-bars-treesit-ignore-blank-lines-types` (which, please note, are 
configur [...]
+
+Please document good tree-sitter settings for other langauges in the 
[Wiki](https://github.com/jdtsmith/indent-bars/wiki/indent%E2%80%90bars-config-Wiki#tree-sitter-config).
 
 ## Display
 



reply via email to

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