[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/indent-bars af02883218 374/431: README improvements
From: |
ELPA Syncer |
Subject: |
[elpa] externals/indent-bars af02883218 374/431: README improvements |
Date: |
Mon, 16 Sep 2024 12:59:51 -0400 (EDT) |
branch: externals/indent-bars
commit af02883218f146c7c096d3b839c2ce66b1425f5d
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: JD Smith <93749+jdtsmith@users.noreply.github.com>
README improvements
---
README.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 05e66f7c58..0aea945685 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,7 @@ This package provides indentation _guide bars_ in Emacs,
enhanced by tree-sitter
- other minor improvements
- **v0.1**: Initial stipple-based indentation.
+
# FAQ's
- **I don't see anything/bars are garbled!** <br>While most do, not all
Emacsen support stipples; see [Compatibility](#compatibility).
@@ -59,6 +60,8 @@ This package provides indentation _guide bars_ in Emacs,
enhanced by tree-sitter
- **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).
- **How can I change the style of the out-of-scope bars?**: <br>Using an
[alternate set](#tree-sitter-alternate-styling-variables) of `ts-`
customizations.
- **What if I want out-of-scope text to have the default style, and in-scope
text to be special?** You want to set `indent-bars-ts-styling-scope` to
`'in-scope`.
+- **My treesitter scope makes no sense** A common mistake is adding too many
node types for your language to the `indent-bars-treesit-scope` variable.
Start small, with thing you _know_ you want (function, method, class, etc.).
+
# Install/config
@@ -200,7 +203,7 @@ By default, if tree-sitter and _scope focus_ are active
(`indent-bars-treesit-sc
To customize alternate bar appearance, use the parallel set of custom
variables with an `indent-bars-ts-` prefix. Each of these variables can be set
similarly to their default counterparts to _fully_ configure alternate bar
appearance, including color, depth highlighting, bar pattern, etc.
-You can interchange the role of in-scope and out-of-scope using
`indent-bars-ts-scope-styling`. This is useful if you prefer to have the
_default_ style (e.g. the bar style in non-tree-sitter-enabled buffers) match
the out-of-scope style within tree-sitter buffers (i.e. if you want to
_emphasize_ scope, not _de-emphasize_ out-of-scope).
+You can interchange the role of in-scope and out-of-scope using
`indent-bars-ts-styling-scope`. This is useful if you prefer to have the
_default_ style (e.g. the bar style in non-tree-sitter-enabled buffers) match
the out-of-scope style within tree-sitter buffers (i.e. if you want to
_emphasize_ scope, not _de-emphasize_ out-of-scope).
> [!NOTE]
> _Scope focus_ highlighting is completely independent of _current depth
> highlighting_, and you can style them separately, or enable one or the
> other, or both.
- [elpa] externals/indent-bars fb1a0d6d1a 239/431: Merge pull request #39 from oxcl/main, (continued)
- [elpa] externals/indent-bars fb1a0d6d1a 239/431: Merge pull request #39 from oxcl/main, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 5c06a2d47a 252/431: re-organize requires, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 06c9d7e380 274/431: TS scope update: use idle-timer instead, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 0d684be9eb 290/431: docs: custom vars doc improvmements, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 8787ebc872 300/431: Increase default TS out-of-scope color blend factor to 0.15, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 7c8d680619 348/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 29005e1bd0 317/431: Increase default color blend to 0.5, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 1a851b6503 345/431: remove ts-teardown hook function on teardown, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c12c740153 346/431: Bump version, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 0af707c007 338/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars af02883218 374/431: README improvements,
ELPA Syncer <=
- [elpa] externals/indent-bars f486b9a4c8 350/431: README: cleanup links, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars cbe88d5c7a 379/431: README: fix stray empty item, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 95592c1888 382/431: TS: improve Developer doc, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 74c08d82fd 356/431: Update depth highlight: guard against deleted buffer, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars a1b942dde5 354/431: ts font-lock forms: set/clear as local variables, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 2216793de8 381/431: Merge branch 'main' into dev, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars b72fa098d7 415/431: ts: improve developer commentary, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 9f507d72fa 394/431: indent-bars--fontify: correct return structure, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 0aab084248 019/431: Capitalize in custom tags, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 37f3102422 022/431: specify width-frac for row-data, ELPA Syncer, 2024/09/16