[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia 69442c2d94: README: Generate better info out
From: |
ELPA Syncer |
Subject: |
[elpa] externals/marginalia 69442c2d94: README: Generate better info output |
Date: |
Thu, 21 Jul 2022 17:57:58 -0400 (EDT) |
branch: externals/marginalia
commit 69442c2d9472b665f698f67426cd255f6c0620a3
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Generate better info output
---
README.org | 20 +++++++++-----------
1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index 75974ddd24..38a5e3c2ef 100644
--- a/README.org
+++ b/README.org
@@ -12,19 +12,15 @@
#+html: <a href="https://melpa.org/#/marginalia"><img alt="MELPA"
src="https://melpa.org/packages/marginalia-badge.svg"/></a>
#+html: <a href="https://stable.melpa.org/#/marginalia"><img alt="MELPA
Stable" src="https://stable.melpa.org/packages/marginalia-badge.svg"/></a>
-* Introduction
-
#+html: <img
src="https://upload.wikimedia.org/wikipedia/commons/4/4f/Marginalia_%285095211566%29.jpg"
align="right" width="30%">
-This package provides =marginalia-mode= which adds marginalia to the
-minibuffer completions.
-[[https://en.wikipedia.org/wiki/Marginalia][Marginalia]] are marks or
-annotations placed at the margin of the page of a book or in this case
-helpful colorful annotations placed at the margin of the minibuffer for
-your completion candidates. Marginalia can only add annotations to be
-displayed with the completion candidates. It cannot modify the
-appearance of the candidates themselves, which are shown as supplied by
-the original commands.
+This package provides =marginalia-mode= which adds marginalia to the minibuffer
+completions. [[https://en.wikipedia.org/wiki/Marginalia][Marginalia]] are
marks or annotations placed at the margin of the
+page of a book or in this case helpful colorful annotations placed at the
margin
+of the minibuffer for your completion candidates. Marginalia can only add
+annotations to be displayed with the completion candidates. It cannot modify
the
+appearance of the candidates themselves, which are shown as supplied by the
+original commands.
The annotations are added based on the completion category. For example
=find-file= reports the =file= category and =M-x= reports the =command=
category. You
@@ -33,6 +29,8 @@ with command =marginalia-cycle=.
#+html: <img
src="https://github.com/minad/marginalia/blob/screenshots/marginalia-mode.png?raw=true">
+#+toc: headlines 8
+
* Configuration
It is recommended to use Marginalia together with either the
[[https://github.com/minad/vertico][Vertico]],
[[https://github.com/protesilaos/mct][Mct]],
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/marginalia 69442c2d94: README: Generate better info output,
ELPA Syncer <=