https://github.com/MiroHibler/sublime-keymaps

Find a keymap for... and show all enabled keymaps in a Cheat Sheet.
https://github.com/MiroHibler/sublime-keymaps

Last synced: 4 months ago
JSON representation

Find a keymap for... and show all enabled keymaps in a Cheat Sheet.

• Host: GitHub
• URL: https://github.com/MiroHibler/sublime-keymaps
• Owner: MiroHibler
• Created: 2013-09-08T18:51:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2020-02-25T15:15:06.000Z (almost 5 years ago)
• Last Synced: 2024-08-01T05:24:03.117Z (7 months ago)
• Language: Python
• Homepage:
• Size: 324 KB
• Stars: 143
• Watchers: 11
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
![](https://github.com/MiroHibler/sublime-keymaps/workflows/CI/badge.svg)

![](https://img.shields.io/packagecontrol/dt/Keymaps)

# Sublime Text Keymap Helper

Plugin for Sublime Text 3 that enables searching for keymaps by function as well as showing all enabled keymaps in a searchable color-coded Cheat Sheet.

## Features

* **NEW!** Search for keymaps by function

* Shows searchable color-coded Cheat Sheet (overview) of keymaps

* Open the keymap file to edit chosen keymap

## Usage

### Find a keymap for...

* Invoke via ⌃⌥? / CtrlAlt? (menu: `Tools` -> `Keymaps` -> `Find a keymap for...`)

* Start typing the function you need keymap for and - voilà!

* Additionaly, hit ⏎ to execute it!

![Find a keymap for...](https://raw.github.com/MiroHibler/sublime-keymaps/master/images/quick_panel.gif)

### Cheat Sheet

* Invoke via ⌃⌥\_ / CtrlAlt\_ (menu: `Tools` -> `Keymaps` -> `Cheat Sheet`)

* Use these commands to browse the Cheat Sheet and select an entry to open corresponding `.sublime-keymap` file and edit the keymap

⌃⌥⇧↓ / CtrlAlt⇧↓: **Navigate Forward**

⌃⌥⇧↑ / CtrlAlt⇧↑: **Navigate Backward**

⌃⌥⇧C / CtrlAlt⇧C: **Clear Selection**

⌃⌥⇧⏎ / CtrlAlt⇧⏎: **Open .sublime-keymap File For Editing**

or double-click _previously selected_ line while holding ⌃⌥ / CtrlAlt

Here's an example of possible output (OS X, truncated):

![Cheat Sheet](https://raw.github.com/MiroHibler/sublime-keymaps/master/images/cheat_sheet.png)

## How to install

*Warning:* If you experience problems or editor crashes please [file an issue](https://github.com/MiroHibler/sublime-keymaps/issues).

With [Package Control](http://wbond.net/sublime_packages/package_control):

1. Run “Package Control: Install Package” command, find and install `Keymaps` plugin.

2. Restart Sublime Text (recommended)

## Options

~~Mac~~ ALL users can now opt for pretty symbols instead of text for keys.

Go to `Preferences` -> `Settings - User` and add this to the file:

~~`"keymaps": { "show_osx_keys": true }`~~

`"keymaps": { "show_pretty_keys": true }`

## Acknowledgments

Inspired by [KeymapViewer](https://github.com/wwwjfy/KeymapViewer)

## Copyright and license

Copyright © 2013 @[MiroHibler](http://twitter.com/MiroHibler)

Licensed under the [**MIT**](http://miro.mit-license.org) license.