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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/consult 80604f4 3/3: Revert "README: Use subsections"


From: ELPA Syncer
Subject: [elpa] externals/consult 80604f4 3/3: Revert "README: Use subsections"
Date: Wed, 7 Jul 2021 05:57:08 -0400 (EDT)

branch: externals/consult
commit 80604f4b77b162b731d0ba1bf548f61abf264ee0
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Revert "README: Use subsections"
    
    This reverts commit 4550e7c4615ae8147606b7dc2f72f4fca2721e59.
---
 README.org | 145 +++++++++++++++++++++++++------------------------------------
 1 file changed, 60 insertions(+), 85 deletions(-)

diff --git a/README.org b/README.org
index 4af9142..4dd5d26 100644
--- a/README.org
+++ b/README.org
@@ -84,42 +84,32 @@ their descriptions.
    :properties:
    :description: Buffers, bookmarks and recent files
    :end:
-   #+cindex: virtual buffers
-
-*** =consult-buffer=
-    #+findex: consult-buffer
-    #+findex: consult-buffer-other-window
-    #+findex: consult-buffer-other-frame
-
-    =consult-buffer= (=-other-window=, =-other-frame=) are enhanced versions of
-    =switch-to-buffer= with support for virtual buffers. =consult-buffer= 
supports
-    live preview of buffers and narrowing to the virtual buffer types. You can
-    type =f SPC= in order to narrow to recent files. Ephemeral buffers can be
-    shown by pressing =SPC=.
-
-    Supported narrowing keys:
-    - b Buffers
-    - f Files (Requires =recentf-mode=)
-    - m Bookmarks
-    - p Project (only available if =consult-project-root-function= is
-      configured as shown in the [[#use-package-example][example 
configuration]]).
-    - Arbitrary [[#multiple-sources][other sources]] can be configured via 
=consult-buffer-sources=.
-
-*** =consult-recent-file=
-    #+findex: consult-recent-file
-
-    =consult-recent-file= selects from recent files with preview. You might 
prefer
-    the powerful =consult-buffer= instead, which can include recent files as a
-    virtual buffer source. Note that =recentf-mode= should be enabled in order 
to
-    track recent files.
-
-*** =consult-bookmark=
-    #+findex: consult-bookmark
-
-    =consult-bookmark= selects or creates bookmark. You might use the
-    powerful =consult-buffer= as an alternative, which can include a bookmark
-    virtual buffer source. Note that =consult-bookmark= supports preview of
-    bookmarks and narrowing to different bookmark types.
+ #+cindex: virtual buffers
+
+ #+findex: consult-buffer
+ #+findex: consult-buffer-other-window
+ #+findex: consult-buffer-other-frame
+ #+findex: consult-recent-file
+ #+findex: consult-bookmark
+ - =consult-buffer= (=-other-window=, =-other-frame=): Enhanced version
+   of =switch-to-buffer= with support for virtual buffers. Supports live 
preview
+   of buffers and narrowing to the virtual buffer types. You can type =f SPC= 
in
+   order to narrow to recent files. Ephemeral buffers can be shown by pressing
+   =SPC=. Supported narrowing keys:
+   - b Buffers
+   - f Files (Requires =recentf-mode=)
+   - m Bookmarks
+   - p Project (only available if =consult-project-root-function= is
+     configured as shown in the [[#use-package-example][example 
configuration]]).
+   - Arbitrary [[#multiple-sources][other sources]] can be configured via 
=consult-buffer-sources=.x
+ - =consult-bookmark=: Select or create bookmark. You might use the
+   powerful =consult-buffer= as an alternative, which can include a bookmark
+   virtual buffer source. But note that =consult-bookmark= supports preview of
+   bookmarks and narrowing.
+ - =consult-recent-file=: Select from recent files with preview.
+   You might prefer the powerful =consult-buffer= instead, which can include
+   recent files as a virtual buffer source. Note that =recentf-mode= should be
+   enabled in order to track recent files.
 
 ** Editing
    :properties:
@@ -287,78 +277,63 @@ their descriptions.
  #+findex: consult-flymake
  #+findex: consult-flycheck
  #+findex: consult-xref
-*** =consult-compile-error=: Jump to a compilation error. Supports live preview
+ - =consult-compile-error=: Jump to a compilation error. Supports live preview
    narrowing and and recursive editing.
-**** =consult-flymake=: Jump to flymake diagnostic. Supports live preview and
+ - =consult-flymake=: Jump to flymake diagnostic. Supports live preview and
    recursive editing. The command supports narrowing. Press =e SPC=, =w SPC=, 
=n
    SPC= to only show errors, warnings and notes respectively.
-***** =consult-flycheck=: Jump to flycheck error, similar to =consult-flymake=.
+ - =consult-flycheck=: Jump to flycheck error, similar to =consult-flymake=.
    This command requires the installation of the additional =consult-flycheck=
    package since the main =consult= package only depends on Emacs core
    components.
-****** =consult-xref=: Integration with xref. This function can be set as
+ - =consult-xref=: Integration with xref. This function can be set as
    as =xref-show-xrefs-function= and =xref-show-definitions-function=.
 
 ** Histories
    :properties:
    :description: Navigating histories
    :end:
-   #+cindex: history
-
-*** =consult-complex-command=
-    #+findex: consult-complex-command
-
-    Select a command from the =command-history=. This command is a 
=completing-read=
-    version of =repeat-complex-command= and can also be considered a 
replacement
-    for the =command-history= command from chistory.el.
-
-*** =consult-history=
-    #+findex: consult-history
-
-    Insert a string from the current buffer history. This command can be 
invoked
-    from the minibuffer. In that case the history stored in the
-    =minibuffer-history-variable= is used.
+ #+cindex: history
+
+ #+findex: consult-complex-command
+ #+findex: consult-history
+ - =consult-complex-command=: Select a command from the
+   =command-history=. This command is a =completing-read= version of
+   =repeat-complex-command= and can also be considered a replacement for
+   the =command-history= command from chistory.el.
+ - =consult-history=: Insert a string from the current buffer history.
+   This command can be invoked from the minibuffer. In that case the
+   history stored in the =minibuffer-history-variable= is used.
 
 ** Modes
    :properties:
    :description: Toggling minor modes and executing commands
    :end:
-   #+cindex: minor mode
-   #+cindex: major mode
-
-*** =consult-minor-mode-menu=
-    #+findex: consult-minor-mode-menu
-
-    Enable/disable minor mode. Supports
-    narrowing to on/off/local/global modes by pressing =i/o/l/g SPC=
-    respectively.
-
-*** =consult-mode-command=
-    #+findex: consult-mode-command
-
-    Run a command from the currently active minor
-    or major modes. Supports narrowing to local-minor/global-minor/major
-    mode via the keys =l/g/m=.
+ #+cindex: minor mode
+ #+cindex: major mode
+
+ #+findex: consult-minor-mode-menu
+ #+findex: consult-mode-command
+ - =consult-minor-mode-menu=: Enable/disable minor mode. Supports
+   narrowing to on/off/local/global modes by pressing =i/o/l/g SPC=
+   respectively.
+ - =consult-mode-command=: Run a command from the currently active minor
+   or major modes. Supports narrowing to local-minor/global-minor/major
+   mode via the keys =l/g/m=.
 
 ** Org Mode
    :properties:
    :description: Org-specific commands
    :end:
-   #+cindex: org
-
-*** =consult-org-heading=
-    #+findex: consult-org-heading
-
-    Similar to =consult-outline=, for Org
-    buffers. Supports narrowing by heading level, priority and TODO
-    state, as well as live preview and recursive editing.
-
-*** =consult-org-agenda=
-    #+findex: consult-org-agenda
 
-    Jump to an agenda heading. Supports
-    narrowing by heading level, priority and TODO state, as well as
-    live preview and recursive editing.
+ #+findex: consult-org-heading
+ #+findex: consult-org-agenda
+ - =consult-org-heading=: Similar to =consult-outline=, for Org
+   buffers. Supports narrowing by heading level, priority and TODO
+   state, as well as live preview and recursive editing.
+ - =consult-org-agenda=: Jump to an agenda heading. Supports
+   narrowing by heading level, priority and TODO state, as well as
+   live preview and recursive editing.
 
 ** Miscellaneous
    :properties:



reply via email to

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