emacs-elpa-diffs
[Top][All Lists]
Advanced

[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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]