An Emacs package to register and create cheatsheets based on org-mode.
| Command | Title | Description | Source |
|---|---|---|---|
cheat/adoc | AsciiDoc | AsciiDoc + asciidoctor Syntax Quick Reference | github.com/asciidoctor/asciidoctorg.org |
cheat/es6 | ES2015+ | A quick overview of JavaScript features in ES2015 and beyond. | devhints.io/es6 |
cheat/emacs | Emacs | Small guide to emacs functions & shortcuts | thb.lt/emacs-cheatsheet |
cheat/go | go | Go-lang Cheatsheet | devhints.io/go |
cheat/jsdoc | JSDoc | JSDoc syntax overview | devhints.io/jsdoc |
cheat/magit | Magit | Magit Reference Card | github.com/magit/magit |
cheat/npm | Npm | Npm Cheatsheet | github.com/npm/npm |
cheat/org-syntax | Org mode syntax | Syntax overview of Org-Mode files | github.com/higham |
cheat/org | Org mode | Org-Mode Reference Card | orgmode.org |
cheat/python | python | Python Cheatsheet | devhints.io/python |
cheat/xpath | Xpath | Collection of XPath examples | devhints.io/xpath |
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--setup)
;; Or, if you have use-package & quelpa-use-package
(use-package cheat
:quelpa (cheat :fetcher github :repo "pbellon/cheat")
:config
(cheat--setup))You can change which set of cheatsheet is loaded by default by the package by changing cheat--categories value:
(setq cheat--categories '("JavaScript" "Emacs" "CLI"))You can see all available categories by calling cheat--list-categories interactive function.
Register your cheatsheets folds in the cheat--sheets-folders list:
(add-to-list 'cheat--sheets-folders "path/to/my/cheatsheets/")You can then update the loaded cheatsheets with the cheat--reload-sheets interactive function to see you new cheatsheets. See Cheatsheet template to see how to write new cheatsheets.
All sheets files must be located under a folder included in cheat--sheets-folders.
They must have an header like bellow:
#+TITLE: My title
#+COMMAND: mycommand
#+DESCRIPTION: Optional description
#+CATEGORY: Category
Make sure to have the Category of your new cheatsheet listed under cheat--categories & call cheat--reload-sheets to load it .
M-x RET cheat RET <command> RET | Open a cheatsheet having given <command>. Needs ivy to work |
M-x RET cheat/<command> RET | All cheatsheets have dedicated interactive functions, for instance cheat/adoc opens AsciiDoc cheatsheet. |
List all cheatsheets filtered by Loaded categories.
M-x RET cheat--list-sheets RET