[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/kind-icon eaeea12 12/51: Doc
From: |
ELPA Syncer |
Subject: |
[elpa] externals/kind-icon eaeea12 12/51: Doc |
Date: |
Wed, 17 Nov 2021 15:57:40 -0500 (EST) |
branch: externals/kind-icon
commit eaeea121e3036a3a837842d2b93821ba5b0cd8e3
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: JD Smith <93749+jdtsmith@users.noreply.github.com>
Doc
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 07447f3..13bfdf2 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-icon-mode`. E.g., to enable for the completion UI
[corfu](https://github.com/minad/corfu):
+Get it from melpa (TBD), which should install `svg-lib` as well if necessary.
Enable in any buffer with completion using `kind-icon-mode`. E.g., to enable
for the completion UI [corfu](https://github.com/minad/corfu):
```elisp
(use-package kind-icon ;package availability TBD
@@ -15,7 +15,9 @@ Get it from melpa (TBD). Enable in any buffer with
completion enabled using `ki
## Configuration
-Defaults should normally work fine, but some of the important configuration
variables include:
+### Variables
+
+The defaults should normally work fine, but some of the important
configuration variables include:
- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges.
@@ -27,3 +29,7 @@ Defaults should normally work fine, but some of the important
configuration vari
`: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.
+
+### Icons and Colors
+
+Check the [material icon library](https://materialdesignicons.com) for the SVG
icons you can use. All you need is the name of the icon! Icon colors are
matched by default to the default colors in programming modes (variables,
function names, etc.). If you don't like the default colors used to go along
with the icons, you can customize the associated face, or build your own. See
`M-x list-faces-display`. You can `M-x customize-group kind-icon` to update
the mapping.
- [elpa] externals/kind-icon 918eb89 06/51: Docs, (continued)
- [elpa] externals/kind-icon 918eb89 06/51: Docs, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 5a3b723 01/51: Initial commit, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon c8a43e5 02/51: Initial, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 4b066c6 03/51: Rename and remove corfu dependency, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 7f9ba65 04/51: Initial kind-prefix import, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon f96c6a4 08/51: Add provide, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 84e6654 10/51: doc cleanup, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 3b25b8d 27/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ffa75e7 21/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 01d76af 07/51: Make kind-prefix-reset-cache a command, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon eaeea12 12/51: Doc,
ELPA Syncer <=
- [elpa] externals/kind-icon 3b0c9c3 11/51: Renamed kind-icon, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 366232c 36/51: Quiet svg-lib-icon warning, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 9a20879 30/51: Use widget-value in customize preview, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 9098597 33/51: Update kinds to match LSP spec, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon fcfe9ea 14/51: kind-icon-formatted: 3 char-width icon/centered 1 or 2 char text, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 8d6fa99 46/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon b88e809 48/51: kind-formatter -> margin-formatters, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon f6de892 37/51: Remove add-variable-watcher in favor of custom :set, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 94ff0ac 13/51: customize interface for mappings, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon cfa3d73 38/51: Guard against network or other icon retrieval issues (text fallback), ELPA Syncer, 2021/11/17