branch: externals/marginalia commit 512991743b477ed600fbc4358d20cddfa7806020 Author: Daniel Mendler <m...@daniel-mendler.de> Commit: Daniel Mendler <m...@daniel-mendler.de>
fix readme --- README.org | 4 +++- marginalia.texi | 14 +++++++++----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.org b/README.org index be53c12..5875c67 100644 --- a/README.org +++ b/README.org @@ -8,6 +8,8 @@ [[https://melpa.org/#/marginalia][file:https://melpa.org/packages/marginalia-badge.svg]] +* Introduction + This package provides =marginalia-mode= which adds marginalia to the minibuffer completions. [[https://en.wikipedia.org/wiki/Marginalia][Marginalia]] are marks or @@ -37,7 +39,7 @@ specified by the variable =marginalia-classifiers=. #+CAPTION: marginalia-mode with Selectrum [[https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true]] -** Configuration +* Configuration It is recommended to use Marginalia together with either the [[https://github.com/raxod502/selectrum][Selectrum]] or the diff --git a/marginalia.texi b/marginalia.texi index bf05a5d..4f9f00a 100644 --- a/marginalia.texi +++ b/marginalia.texi @@ -24,6 +24,15 @@ @top marginalia.el - Marginalia in the minibuffer @uref{https://melpa.org/#/marginalia, file:https://melpa.org/packages/marginalia-badge.svg} +@end ifnottex + +@menu +* Introduction:: +* Configuration:: +@end menu + +@node Introduction +@chapter Introduction This package provides @samp{marginalia-mode} which adds marginalia to the minibuffer completions. @@ -52,11 +61,6 @@ category with the completion initiated by the command (see the variable specified by the variable @samp{marginalia-classifiers}. @uref{https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true} -@end ifnottex - -@menu -* Configuration:: -@end menu @node Configuration @chapter Configuration