A small utility to register and create cheatsheets based on org-mode.
- Org mode
- Org mode syntax
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))
Open a cheatsheet
All cheatsheets are accessible through interactive functions their first list element preceded by the
M-x RET cheat/adocopens asciidoc cheatsheet
M-x RET cheat/orgopen org-mode cheatsheet
M-x RET cheat/org-syntaxopen 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