From bd7d36cfe2e3a0a5e7d23acdf9defac959369b6d Mon Sep 17 00:00:00 2001 From: Igor Chubin Date: Sun, 5 Aug 2018 19:55:43 +0200 Subject: [PATCH] cheat.sh editors features list --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e428b90..25a4070 100644 --- a/README.md +++ b/README.md @@ -407,7 +407,9 @@ because you know what happens when you do. ## Editors integration -You can use *cheat.sh* directly from the editor (*Vim*, *Emacs* and *Visual Studio Code* are currently supported). +You can use *cheat.sh* directly from the editor +(*Emacs*, *Sublime*, *Vim*, and *Visual Studio Code* are currently supported; +not all features are supported by all plugins though; see below). Instead of opening your browser, googling, browsing Stack Overflow and eventually copying the code snippets you need into the clipboard and later pasting them into the editor, @@ -430,6 +432,19 @@ If you use some static analysis plugin such as *syntastic* (for Vim), you can us its warning and error messages as cheat.sh queries: place the cursor on the problem line and press `KE`: explanation for the warning will be opened in a new buffer. +Features supported by cheat.sh plugins for different editors: + +|Feature |Emacs|Sublime|Vim|VSCode| +|-------------------|-----|-------|---|------| +|Command queries |✓ |✓ |✓ |✓ | +|Queries from buffer| | |✓ |✓ | +|Toggle comments | | |✓ | | +|Prev/next answer | | |✓ | | +|Multiple answers | |✓ | | | +|Warnings as queries| | |✓ | | +|Session id | | |✓ | | +|-------------------|-----|-------|---|------| + ### Vim * [cheat.sh-vim](https://github.com/dbeniamine/cheat.sh-vim) — Vim support