Skip to content

fabcontigiani/consult-vulpea

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 

Repository files navigation

consult-vulpea

MELPA

Use Consult in tandem with Vulpea.

Features

  • Live previews: When selecting notes via vulpea-find or vulpea-insert, get a live preview of the note file as you navigate through candidates.
  • Consult-powered grep/find: Use consult-vulpea-grep and consult-vulpea-find to search within your vulpea directories with live previews.

Installation

consult-vulpea is available on MELPA.

(use-package consult-vulpea
  :ensure t
  :after vulpea
  :config
  (consult-vulpea-mode 1))

Or install manually with M-x package-install RET consult-vulpea RET.

Doom Emacs

Add to packages.el:

(package! consult-vulpea)

Add to config.el:

(use-package! consult-vulpea
  :after vulpea
  :config
  (consult-vulpea-mode 1))

Important

Do not use :after consult — this can prevent the package from loading properly at startup.

Commands

Command Description
consult-vulpea-grep Search vulpea notes using ripgrep with live preview
consult-vulpea-find Find vulpea note files with live preview

Customization

Variable Default Description
consult-vulpea-grep-command consult-ripgrep Grep command to use (can also be consult-grep)
consult-vulpea-find-command consult-find Find command to use
consult-vulpea-preview-key consult-preview-key Key to trigger preview, defaults to consult's global setting

How it works

When consult-vulpea-mode is enabled, the package advises vulpea-select-from with a consult-powered replacement. This means all vulpea commands that use the note selection interface (like vulpea-find and vulpea-insert) automatically gain consult features.

Requirements

Related

License

GPL-3.0

About

Use Consult in tandem with Vulpea

Resources

License

Stars

Watchers

Forks

Contributors