[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/kind-icon 724f1facb5: README: Use [!NOTE]
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/kind-icon 724f1facb5: README: Use [!NOTE] |
|
Date: |
Sat, 6 Jan 2024 15:58:02 -0500 (EST) |
branch: externals/kind-icon
commit 724f1facb580cd54057bdae1ee9942c385c8d92e
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: JD Smith <93749+jdtsmith@users.noreply.github.com>
README: Use [!NOTE]
---
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 87c73c92bf..5a467e5ee2 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,8 @@ The configuration defaults should work fine, but `kind-icon`
can be customized t
- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges. Otherwise, use text labels. Individual kind entries can also have
their icons disabled by removing the `:icon` property in the mapping (see
below). If `svg-lib` is unable to download a named icon and it is not cached
on disk, text labels for that kind will be used as a fallback.
- `kind-icon-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 :keyword value ...)` where `sym` is the
kind (a symbol), and `short-text` is the abbreviated text to display (if icons
are not used), both of which must be present. The rest of the list is a
property list with optional keys `:icon` and `:face`. The latter will be used
to set the text foreground and (possibly [...]
- > **_Update_**: As of kind-icon v0.2, additional keywords supported by
svg-lib can be utilized, including `:collection`, which allows the use of other
icon libraries. In recent svg-lib versions, these include vscode-icons. Please
note that **only monochrome icons are supported**; if you configure icons which
have hard-coded colors in the SVG file (as some vscode-icons do), they will not
be displayed correctly. If you want to switch the collection for _all_ icons,
add (e.g) `:collect [...]
+ >[!NOTE]
+ > As of kind-icon v0.2, additional keywords supported by svg-lib can be
utilized, including `:collection`, which allows the use of other icon
libraries. In recent svg-lib versions, these include vscode-icons. Please note
that **only monochrome icons are supported**; if you configure icons which have
hard-coded colors in the SVG file (as some vscode-icons do), they will not be
displayed correctly. If you want to switch the collection for _all_ icons,
add (e.g) `:collection "octicon"` [...]
- `kind-icon-default-face`: A face from which the icon 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
color 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.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/kind-icon 724f1facb5: README: Use [!NOTE],
ELPA Syncer <=