branch: externals/kind-icon
commit ba375629b390d670f929404cb9afc62f0710528f
Author: JD Smith <93749+jdtsm...@users.noreply.github.com>
Commit: JD Smith <93749+jdtsm...@users.noreply.github.com>
more docs
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 9881e24..d64c80c 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ This emacs package adds icon or text-based completion prefixes
based on the `:co
## Installation
-Get it from melpa (TBD). Enable in any buffer with completion enabled using
`kind-prefix-mode`, e.g., to enable for the completion UI
[corfu](https://github.com/minad/corfu):
+Get it from melpa (TBD). Enable in any buffer with completion enabled using
`kind-prefix-mode`. E.g., to enable for the completion UI
[corfu](https://github.com/minad/corfu):
```elisp
(use-package kind-prefix ;package availability TBD
@@ -17,13 +17,13 @@ Get it from melpa (TBD). Enable in any buffer with
completion enabled using `ki
Defaults should normally work fine, but some of the important configuration
variables include:
-`kind-prefix-use-icons`: If non-nil (the default), prefer icons for prefix
badges.
+- `kind-prefix-use-icons`: If non-nil (the default), prefer icons for prefix
badges.
-`kind-prefix-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `sym short-text plist` where `sym` is the kind (a symbol),
short-text is the abbreviated text to display (if icons are not used). The
`plist` is a property list with optional keys `:icon` and `:face`. The latter
will be used to set the text foreground and background colors on the badge.
The former is a string name from the [...]
+- `kind-prefix-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `sym short-text plist` where `sym` is the kind (a symbol),
short-text is the abbreviated text to display (if icons are not used). The
`plist` is a property list with optional keys `:icon` and `:face`. The latter
will be used to set the text foreground and background colors on the badge.
The former is a string name from th [...]
-`kind-prefix-default-face`: A face from which background color will be taken
and blended with the `:face` foreground color in the mapping table to create a
custom background color. If not set, the frame default background will be used
for this purpose. Similarly, the foreground color for this face, if set, will
be used if a `:face` foreground is missing from the mapping.
+- `kind-prefix-default-face`: A face from which background color will be taken
and blended with the `:face` foreground color in the mapping table to create a
custom background color. If not set, the frame default background will be used
for this purpose. Similarly, the foreground color for this face, if set, will
be used if a `:face` foreground is missing from the mapping.
-`kind-prefix-blend-frac`: The fractional blend between custom badge
+- `kind-prefix-blend-frac`: The fractional blend between custom badge
`:face` foreground and background (see above) color to use as a custom
background for each badge. A value of 0.0 simply replicates the
background color. Values should likely stay below 0.3 or so.
