[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia c47576c 010/241: add configuration example
From: |
Stefan Monnier |
Subject: |
[elpa] externals/marginalia c47576c 010/241: add configuration example |
Date: |
Fri, 28 May 2021 20:48:46 -0400 (EDT) |
branch: externals/marginalia
commit c47576cf1a9a03af46722f8639647477c4ff9622
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
add configuration example
---
README.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/README.md b/README.md
index a17d30b..704c2a2 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,24 @@ The annotations are added based on the completion category.
Furthermore the package allows to associate completion categories to commands.
![marginalia-mode with
Selectrum](https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true)
+
+## Configuration
+
+~~~ elisp
+;; Enable richer annotations using the Marginalia package
+(use-package marginalia
+ ;; The :init configuration is always executed (Not lazy!)
+ :init t
+
+ ;; Must be in the :init section of use-package such that the mode gets
+ ;; enabled right away. Note that this forces loading the package.
+ (marginalia-mode)
+
+ ;; Enable richer annotations for M-x.
+ ;; Only keybindings are shown by default, in order to reduce noise for this
very common command.
+ ;; * marginalia-annotate-symbol: Annotate with the documentation string
+ ;; * marginalia-annotate-command-binding (default): Annotate only with the
keybinding
+ ;; * marginalia-annotate-command-full: Annotate with the keybinding and the
documentation string
+ ;; (setf (alist-get 'command marginalia-annotate-alist)
#'marginalia-annotate-command-full)
+)
+~~~
- [elpa] branch externals/marginalia created (now 529aee6), Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 84f0fde 002/241: add marginalia-command-annotate, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia eecc6e2 006/241: Get key binding active in next window instead of in the minibuffer, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 863e07b 004/241: experimental: remove selectrum-specifics (may not work out!), Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia e863b6c 007/241: Show key bindings from minibuffer-selected-window, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4780a6a 009/241: marginalia works with icomplete-vertical now!, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 237a620 001/241: initial prototype, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia c47576c 010/241: add configuration example,
Stefan Monnier <=
- [elpa] externals/marginalia a6dfb38 003/241: add todos, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia bdbbee2 005/241: add very basic readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 6077206 008/241: Ignore byte-compiled files, autoloads and *-pkg.el files, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 0c090f3 011/241: improve readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 80fa320 016/241: Introduce list of classifiers, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia ca21d30 029/241: fix typo in the readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 655f03b 035/241: introduce marginalia-annotators-(light|heavy), remove marginalia-set-command-annotator, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4cb6d2b 039/241: marginalia-annotate-file: add modes, user and group, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia ed74ca9 040/241: add marginalia-toggle-annotators, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 57b1176 051/241: marginalia-annotate-command-binding: only store the binding in the hash table, Stefan Monnier, 2021/05/28