Skip to content
A small utility to register & open cheatsheets in emacs
Emacs Lisp Shell Lua
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts
sheets
tests
.editorconfig
.gitignore
.gitmodules
Cask
README.org
cheat-lib.el
cheat-pkg.el
cheat.el
package.json

README.org

Cheat

A small utility to register and create cheatsheets based on org-mode.

Provided cheatsheets

  • Emacs
  • AsciiDoc
  • Org mode
  • Org mode syntax

Installation

The package has not yet been published to MELPA yet so you’ll have to install it manually or use quelpa.

(quelpa '(cheat :fetcher github :repo "pbellon/cheat"))
(require 'cheat)
(cheat/reload-sheets)

;; Or, if you have use-package & quelpa-use-package
(use-package
    :quelpa (cheat :fetcher github :repo "pbellon/cheat")
    :config
    (cheat/reload-sheets))

Usage

Open a cheatsheet

All cheatsheets are accessible through interactive functions their first list element preceded by the cheat/ prefix.

  • M-x RET cheat/adoc opens asciidoc cheatsheet
  • M-x RET cheat/org open org-mode cheatsheet
  • M-x RET cheat/org-syntax open org-mode syntax cheatsheet

Register a new cheatsheets folder

;; Register your cheatsheets in the cheat/sheets list
(add-to-list 'cheat/sheets-folders "path/to/my/cheatsheets/")
;; Launch initialization of the utility, it will create the ~cheat/custom~ interactive function.
(cheat/reload-sheets)

Adds a new cheatsheet file

All sheets files must be located under a folder included in cheat/sheets-folder. They must have an header like bellow:

#+TITLE: My title
#+COMMAND: mycommand
You can’t perform that action at this time.