[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/indent-bars f986762207 328/431: Update README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/indent-bars f986762207 328/431: Update README.md |
Date: |
Mon, 16 Sep 2024 12:59:46 -0400 (EDT) |
branch: externals/indent-bars
commit f98676220704e53d714854952b088365904d0bad
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>
Update README.md
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 22ab6fb59c..8553473544 100644
--- a/README.md
+++ b/README.md
@@ -219,14 +219,6 @@ The easiest way to configure inheritance and unspecified
values in the `ts` vari
# Details and Caveats
-## Speed
-
-`indent-bars` was in part motivated by the inefficiency of older indentation
highlight modes, and is designed for speed. It uses stipples (fixed bitmap
patterns) and font lock for fast and efficient bar drawing — *faces on spaces*.
Highlighting the current indentation level is essentially free, since it works
by [filtered
remapping](https://www.gnu.org/software/emacs/manual/html_node/elisp/Face-Remapping.html)
the relevant face.
-
-The heaviest operations are **tree-sitter** support (especially scope
highlighting), and **blank-line highlighting**. If you experience any speed
issues, these are the first settings to experiment with. Using with tab-based
indentation is also slightly slower than with space-based.
-
-Both indentation-depth highlighting and current-tree-sitter-scope highlighting
are protected by timers to avoid unnecessary loads (e.g. when pixel-scrolling).
Note that indentation-depth highlighting is _very_ fast and can safely be set
to 0 seconds (though bars will then flash rapidly as you scroll). Tree-sitter
scope requires querying the tree-sitter core, which can be somewhat slower, so
be careful setting its timer too low.
-
## Indentation
`indent-bars` works with either space- or tab-based indentation. If possible,
prefer space indentation, as it is faster. Note that some modes explicitly
enable or disable `indent-tabs-mode`.
@@ -325,6 +317,14 @@ Note that in mixed gui/terminal sessions of the same Emacs
process, you need to
- Works equally for terminal and GUI.
- Works even for emacs ports which do not support or mis-handle stipple
display (see [Compatibility](#compatibility)).
+-
+## Speed
+
+`indent-bars` was in part motivated by the inefficiency of older indentation
highlight modes, and is designed for speed. It uses stipples (fixed bitmap
patterns) and font lock for fast and efficient bar drawing — *faces on spaces*.
Highlighting the current indentation level is essentially free, since it works
by [filtered
remapping](https://www.gnu.org/software/emacs/manual/html_node/elisp/Face-Remapping.html)
the relevant face.
+
+The heaviest operations are **tree-sitter** support (especially scope
highlighting), and **blank-line highlighting**. If you experience any speed
issues, these are the first settings to experiment with. Using with tab-based
indentation is also slightly slower than with space-based.
+
+Both indentation-depth highlighting and current-tree-sitter-scope highlighting
are protected by timers to avoid unnecessary loads (e.g. when pixel-scrolling).
Note that indentation-depth highlighting is _very_ fast and can safely be set
to 0 seconds (though bars will then flash rapidly as you scroll). Tree-sitter
scope requires querying the tree-sitter core, which can be somewhat slower, so
be careful setting its timer too low.
# Related Packages
- [elpa] externals/indent-bars 3ac1bd66a7 311/431: Update README.md, (continued)
- [elpa] externals/indent-bars 3ac1bd66a7 311/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c516788fe3 362/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 2d88129b2a 327/431: Add small menu to README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 8826105182 342/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 88010c2724 387/431: Initial efforts towards font-lock-free/managing bars, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars f64e33bf37 325/431: correctly test style tag string with #'equal, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars d84c654c22 320/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c6dab3309c 365/431: Remove superfluous :group from customs, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 6677c94823 352/431: use end marker for invalid range(s), ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars f7fb81c0d8 353/431: Major scope simplification: just invalid old ∪ new, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars f986762207 328/431: Update README.md,
ELPA Syncer <=
- [elpa] externals/indent-bars 34cecb96a4 358/431: Simplify developer note description for new simple font-lock method, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars adfab4df1e 359/431: styling-scope: new option to invert -ts- variable to apply in-scope, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars bcc1e69e1d 364/431: reset: leave indent-bars--styles alone for teardown, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 4c1b2d46e9 367/431: introduce ts-minor-mode for simplified setup, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 2d4dab01c6 377/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 5a3346b68c 386/431: Remove invalid-ranges, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 6f429915ad 369/431: Bump version, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 48d6b40489 405/431: README: tweak ts-language tip, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c8376cf437 416/431: Stipple compatibility update, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 1a88168837 389/431: indent-bars: refine jit-lock and extend region, ELPA Syncer, 2024/09/16