[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia 2a9df61 145/241: readme fixes
From: |
Stefan Monnier |
Subject: |
[elpa] externals/marginalia 2a9df61 145/241: readme fixes |
Date: |
Fri, 28 May 2021 20:49:15 -0400 (EDT) |
branch: externals/marginalia
commit 2a9df61ac8a46cfe7552b7765eb65999845dddea
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
readme fixes
---
README.org | 57 ++++++++++++++++++++++++++-------------------------------
1 file changed, 26 insertions(+), 31 deletions(-)
diff --git a/README.org b/README.org
index a4524de..62f0a32 100644
--- a/README.org
+++ b/README.org
@@ -1,9 +1,6 @@
* marginalia.el - Marginalia in the minibuffer
- :PROPERTIES:
- :CUSTOM_ID: marginalia.el---marginalia-in-the-minibuffer
- :END:
-[[https://melpa.org/#/marginalia][[[https://melpa.org/packages/marginalia-badge.svg]]]]
+[[https://melpa.org/#/marginalia][file:https://melpa.org/packages/marginalia-badge.svg]]
This package provides =marginalia-mode= which adds marginalia to the
minibuffer completions.
@@ -35,9 +32,6 @@ specified by the variable =marginalia-classifiers=.
[[https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true]]
** Configuration
- :PROPERTIES:
- :CUSTOM_ID: configuration
- :END:
It is recommended to use Marginalia together with either the
[[https://github.com/raxod502/selectrum][Selectrum]] or the
@@ -47,31 +41,32 @@ completion system. Furthermore Marginalia can be combined
with
[[https://github.com/minad/consult][Consult]], which provides many
useful commands.
-#+BEGIN_EXAMPLE
- ;; Enable richer annotations using the Marginalia package
- (use-package marginalia
- :bind (:map minibuffer-local-map
- ("C-M-a" . marginalia-cycle)
- ;; When using the Embark package, you can bind `marginalia-cycle'
as an Embark action!
- ;;:map embark-general-map
- ;; ("A" . marginalia-cycle)
- )
+#+BEGIN_SRC emacs-lisp
+;; Enable richer annotations using the Marginalia package
+(use-package marginalia
+ :bind (:map minibuffer-local-map
+ ("C-M-a" . marginalia-cycle)
+ ;; When using the Embark package, you can bind `marginalia-cycle' as
an Embark action!
+ ;;:map embark-general-map
+ ;; ("A" . marginalia-cycle)
+ )
- ;; The :init configuration is always executed (Not lazy!)
- :init
+ ;; The :init configuration is always executed (Not lazy!)
+ :init
- ;; 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)
+ ;; 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)
- ;; When using Selectrum, ensure that Selectrum is refreshed when cycling
annotations.
- (advice-add #'marginalia-cycle :after
- (lambda () (when (bound-and-true-p selectrum-mode)
(selectrum-exhibit))))
+ ;; When using Selectrum, ensure that Selectrum is refreshed when cycling
annotations.
+ (advice-add #'marginalia-cycle :after
+ (lambda () (when (bound-and-true-p selectrum-mode)
(selectrum-exhibit))))
- ;; Prefer richer, more heavy, annotations over the lighter default
variant.
- ;; E.g. M-x will show the documentation string additional to the
keybinding.
- ;; By default only the keybinding is shown as annotation.
- ;; Note that there is the command `marginalia-cycle' to
- ;; switch between the annotators.
- ;; (setq marginalia-annotators '(marginalia-annotators-heavy
marginalia-annotators-light nil)))
-#+END_EXAMPLE
+ ;; Prefer richer, more heavy, annotations over the lighter default variant.
+ ;; E.g. M-x will show the documentation string additional to the keybinding.
+ ;; By default only the keybinding is shown as annotation.
+ ;; Note that there is the command `marginalia-cycle' to
+ ;; switch between the annotators.
+ ;; (setq marginalia-annotators '(marginalia-annotators-heavy
marginalia-annotators-light nil))
+)
+#+END_SRC
- [elpa] externals/marginalia 659a550 081/241: show annotations even if no documentation is present, (continued)
- [elpa] externals/marginalia 659a550 081/241: show annotations even if no documentation is present, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 56ad689 094/241: modify marginalia-annotate-imenu regexp such that it works with consult narrowing, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia ac53a00 097/241: optimize marginalia--truncate, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 7743fd7 109/241: add marginalia-annotate-char, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 78f676e 122/241: marginalia-annotate-package: use package-desc-status, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 0c5521a 126/241: fix window context for Embark Occur, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia b75f43e 128/241: fix #34, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia e132638 134/241: marginalia-annotate-buffer: show remote indicator, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4d4f639 140/241: fix project file/buffer annotations for consult-buffer, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 5a644d8 143/241: abbreviate list-buffers-directory, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 2a9df61 145/241: readme fixes,
Stefan Monnier <=
- [elpa] externals/marginalia 51b6dbf 147/241: readme fixes, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 7d4f07f 146/241: add marginalia.texi, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia a2f9242 154/241: fix marginalia-annotate-bookmark for front context with newlines, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia d0c0005 166/241: update readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia fcf41c5 167/241: Version 0.2, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 5a00dcb 170/241: marginalia-annotate-consult-buffer: remove width, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia e15b8b2 174/241: readme: update marginalia keybinding, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 55bfd5f 176/241: do not unnecessarily use defsubst, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia dcdcd5d 179/241: consistently use \` and \' for regexps, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 51f7509 184/241: Fix #57 - protect marginalia--symbol-class equality check, Stefan Monnier, 2021/05/28