Embark: Emacs Mini-Buffer Actions Rooted in Keymaps

Table of Contents

• 1 Overview

  • 1.1 Acting on targets

  • 1.2 The default action on a target

  • 1.3 Working with sets of possible targets

    • 1.3.1 Selecting some targets to make an ad hoc candidate set
    • 1.3.2 ‘embark-live’ a live-updating variant of ‘embark-collect’

  • 1.4 Switching to a different command without losing what you’ve typed

• 2 Quick start

• 3 Advanced configuration

  • 3.1 Showing information about available targets and actions

  • 3.2 Selecting commands via completions instead of key bindings

    • 3.2.1 Selecting commands via completion outside of Embark

  • 3.3 Quitting the minibuffer after an action

  • 3.4 Recording acted-on minibuffer candidates in minibuffer history

  • 3.5 Running some setup after injecting the target

  • 3.6 Running hooks before, after or around an action

  • 3.7 Creating your own keymaps

  • 3.8 Defining actions for new categories of targets

    • 3.8.1 New minibuffer target example - tab-bar tabs
    • 3.8.2 New target example in regular buffers - short Wikipedia links

• 4 How does Embark call the actions?

  • 4.1 Non-interactive functions as actions

• 5 Embark, Marginalia and Consult

  • 5.1 Marginalia
  • 5.2 Consult

• 6 Related Packages

• 7 Resources

• 8 Contributions

• 9 Acknowledgments