This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/contrib/smex/README.md
2014-12-24 01:03:49 -05:00

52 lines
1.7 KiB
Markdown

# smex contribution layer for Spacemacs
![logo](img/smex.png)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
- [smex contribution layer for Spacemacs](#smex-contribution-layer-for-spacemacs)
- [Description](#description)
- [Install](#install)
- [Key bindings](#key-bindings)
- [`jk` on leader](#jk-on-leader)
<!-- markdown-toc end -->
## Description
This layer replaces `helm-M-x` by [smex][] which is built on top of `ido`.
`ido` can perform flex matching with the [flx-ido][] mode which is already
activated in the Spacemacs layer.
## Install
To use this contribution add it to your `~/.spacemacs`
```elisp
(setq-default dotspacemacs-configuration-layers '(smex)
"List of contribution to load."
)
```
## Key bindings
Key Binding | Description
--------------------|------------------------------------------------------------
<kbd>SPC :</kbd> | all Emacs commands (interactive functions)
<kbd>SPC m :</kbd> | current major mode commands
## `jk` on leader
The experimental feature [evil leader on `jk`][jk] is supported in this layer.
While the smex minibuffer is opened press quickly <kbd>jk</kbd> then:
Key Binding | Description
--------------------|------------------------------------------------------------
<kbd>g</kbd> | go to the definition of current command
<kbd>h d f</kbd> | describe the current command
<kbd>h w</kbd> | show the key binding for the current command
[smex]: https://github.com/nonsequitur/smex
[flx-ido]: https://github.com/lewang/flx
[jk]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#jk-to-trigger-evil-leader