branch: externals/indent-bars
commit f486b9a4c81080de1dcaac88249dc5c0b0062ade
Author: JD Smith <93749+jdtsm...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
README: cleanup links
---
README.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 8b53976960..33b7d94d7e 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
This package provides indentation _guide bars_ in Emacs, enhanced by
tree-sitter:
- Uses stipple face properties with font-lock for fast performance.
-- Optional tree-sitter support, including _scope focus_, among [other
features](#tree-sitter).
+- Optional tree-sitter support, including _scope focus_, among [other
features](#tree-sitter-details).
- Supports either space or tab-based indentation.
- Bar appearance is _highly_ configurable: color, blending, width, position
within the character, vertical fill/blank pattern, even zigzag (see
[examples](examples.md)).
- Bars can have optional depth-based coloring, with a cyclical color palette
you can customize.
@@ -48,7 +48,7 @@ This package provides indentation _guide bars_ in Emacs,
enhanced by tree-sitter
- **I want completely unique indent guidebars so as to flex on my
colleagues!** <br>Check the [Examples](examples.md) for some ideas. The sky is
the limit (submit your examples).
- **I use Emacs on the terminal, you insensitive clod!** <br>`indent-bars`
will just work for you (though you don't get any fancy bar patterns).
- **I use graphical Emacs, but am an extreme minimalist. All my outfits are
gray. Including my socks.** <br>Maybe [this](examples.md#minimal) will suit
you? Otherwise, you can turn off the stipple and use old fashioned `│`
characters with [`indent-bars-prefer-character`](#character-display).
-- **I get too many bars inside function definitions and calls**: <br>You can
turn on `indent-bars-no-descend-lists` or even use [tree-sitter to
help](#tree-sitter).
+- **I get too many bars inside function definitions and calls**: <br>You can
turn on `indent-bars-no-descend-lists` or even use [tree-sitter to
help](#tree-sitter-details).
- **I want a bar in the very first column!**: <br>Set
`indent-bars-starting-column` to 0.
- **The current bar highlight is so fast, but it flashes too rapidly during
scrolling!** <br>Update to v0.2.2 or later and set
`indent-bars-depth-update-delay` to a comfortable number like 0.1s (0.075s is
the default). If you _like_ the crazy-fast updates, set this to 0.
- **I turned on treesitter support but nothing happened**: <br>You need to
configure `indent-bars-treesit-scope` (and possibly `wrap`) for your
language(s) of interest. [More info](#configuring-tree-sitter).
@@ -94,7 +94,7 @@ To clone with `use-package` and `straight`:
:hook ((python-base-mode yaml-mode) . indent-bars-mode))
```
-See [tree-sitter](#tree-sitter), and also the [Wiki
page](https://github.com/jdtsmith/indent-bars/wiki/indent%E2%80%90bars-config-Wiki#tree-sitter-config).
+See [tree-sitter](#tree-sitter-details), and also the [Wiki
page](https://github.com/jdtsmith/indent-bars/wiki/indent%E2%80%90bars-config-Wiki#tree-sitter-config).
## Compatibility
@@ -171,7 +171,9 @@ Custom variables affecting character-based bar display,
e.g. in the terminal:
- `indent-bars-no-stipple-char-font-weight`: Optional font weight to use for
the face displaying the no-stipple character.
- `indent-bars-unspecified-bg|fg-color`: Colors to use for the frame
background and default foreground when they are unspecified (e.g. in
terminals). If you intend to use `indent-bars` in the terminal, set to the
terminal background/foreground colors you use.
-## Treesitter
+## Tree-sitter
+
+For more information, check [the details](#tree-sitter-details).
### Main treesitter configuration variables
@@ -235,7 +237,7 @@ The easiest way to configure inheritance and unspecified
values in the `ts` vari
Experiment with these to see what you prefer.
-## Tree-sitter
+## Tree-sitter Details
`indent-bars` can optionally use tree-sitter in supported files to enable
several features:
