Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mykyta-shyrin/cheatsheet

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/mykyta-shyrin/cheatsheet
Owner: mykyta-shyrin
Created: 2015-11-25T20:12:40.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2017-11-03T02:54:08.000Z (about 7 years ago)
Last Synced: 2024-04-10T10:19:38.863Z (10 months ago)
Language: Emacs Lisp
Size: 26.4 KB
Stars: 88
Watchers: 4
Forks: 10
Open Issues: 5
Metadata Files:
- Readme: README.markdown

Awesome Lists containing this project

README

[![MELPA](https://melpa.org/packages/cheatsheet-badge.svg)](https://melpa.org/#/cheatsheet)

## Cheatsheet.el

Cheatsheet.el is a tool for creating your own Emacs cheatsheet.
Why I've created this plugin:
* I want to start using new plugin without learning keys - cheatsheet.el lets you to define keys you want to be able to find quickly
* I don't need to see all keys, defined in different keymaps
* I don't need to see all keys, defined in any plugin
* I want to write my own key description
* I want to see commands near the keys in my cheatsheet

All this problems can be solved using cheatsheet.el

![](https://github.com/darksmile/cheatsheet/blob/master/emacs-cheatsheet.png)

## Getting started
* Get cheatsheet.el
* Via [MELPA](https://melpa.org/#/cheatsheet)
* Manually download cheatsheet.el and set-up your load path.
[Find out more.](http://www.emacswiki.org/emacs/InstallingPackages)
* Load package - (require 'cheatsheet)
* Add your first cheat:
```elisp
(cheatsheet-add :group 'Common
:key "C-x C-c"
:description "leave Emacs.")
```
* Run `(cheatsheet-show)` and enjoy :-)

## Plugin API
# cheatsheet-add
Command to add a new cheat to your cheatsheet.
```elisp
(cheatsheet-add :group 'Common
:key "C-x C-c"
:description "leave Emacs.")
```

# cheatsheet-add-group
Command to add cheats to the same group.
```elisp
(cheatsheet-add-group 'Common
'(:key "C-x C-c" :description "leave Emacs")
'(:key "C-x C-f" :description "find file"))
```
# cheatsheet-get
Command to get current cheatsheet as list of groups, keeping defining order.
* Cheat is a plist that looks like this `[:group :key :description]`. `:group`, `:key`, `:description` are symbols or strings
* Group is a plist that looks like this `[:name :cheats]`. `:name` is a symbol or string, `:cheats` is a list of CHEATs
* Cheatsheet is a list of GROUPs - result of `cheatsheet-get` command

# cheatsheet-show
Show buffer with your cheatsheet. Can be closed via `C-q` key.

# Enjoy using cheatsheet.el

P.S. Thanks [@rmuslimov](https://github.com/rmuslimov) for code review and elisp help!