diff options
author | Bozhidar Batsov <bozhidar@batsov.com> | 2016-04-06 14:56:16 +0300 |
---|---|---|
committer | Bozhidar Batsov <bozhidar@batsov.com> | 2016-04-06 14:56:16 +0300 |
commit | b7bd72a1c1a8c207046b3c32719b6259f75fba9d (patch) | |
tree | 3ba7f32f5233c55e2ed731c6a50b96c1d10975f9 /doc | |
parent | 95b2dcf34d7425defafe2e3f51f5f04bc3172de0 (diff) |
Update the formatting of some keybindings
Diffstat (limited to 'doc')
-rw-r--r-- | doc/basic_usage.md | 4 | ||||
-rw-r--r-- | doc/extended_workflow.md | 5 | ||||
-rw-r--r-- | doc/troubleshooting.md | 11 |
3 files changed, 10 insertions, 10 deletions
diff --git a/doc/basic_usage.md b/doc/basic_usage.md index 503c3433..3e769ba9 100644 --- a/doc/basic_usage.md +++ b/doc/basic_usage.md @@ -124,8 +124,8 @@ get a list of the keybindings for `cider-mode`. An even better solution would be to install [which-key][], which will automatically show you a list of available keybindings as you start typing some -keys. This will simplify your interactions with CIDER quite a lot -(especially in the beginning). Here's what you'd see if you typed `C-c C-d` in a +keys. This will simplify your interactions with CIDER quite a lot (especially in +the beginning). Here's what you'd see if you typed <kbd>C-c C-d</kbd> in a Clojure buffer: ![CIDER which-key](images/cider-which-key.png) diff --git a/doc/extended_workflow.md b/doc/extended_workflow.md index 69f5374a..3bfd5b5d 100644 --- a/doc/extended_workflow.md +++ b/doc/extended_workflow.md @@ -6,7 +6,7 @@ something. ### Evaluating Clojure code in the minibuffer You can evaluate Clojure code in the minibuffer from pretty much everywhere -by using `M-x cider-read-and-eval` (bound in `cider-mode` buffers to `C-c C-:`). +by using `M-x cider-read-and-eval` (bound in `cider-mode` buffers to <kbd>C-c C-:</kbd>). `TAB` completion will work in the minibuffer, just as in a REPL/source buffer. You can also enable `eldoc-mode` in the minibuffer by adding the following to your @@ -222,7 +222,8 @@ executed. This is somewhat akin to one of the features of the Light Table editor. - To turn it on, issue `M-x cider-enlighten-mode`. -- To use it, evaluate your functions one at a time (e.g., use `C-M-x` or `C-x C-e`, because `C-c C-k` won't work). +- To use it, evaluate your functions one at a time (e.g., use <kbd>C-M-x</kbd> or +<kbd>C-x C-e</kbd>, because <kbd>C-c C-k</kbd> won't work). That's it! Once your code executes, the regular old buffer on the left will turn into the brilliant show of lights on the right. diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md index 72d0d122..4714ed62 100644 --- a/doc/troubleshooting.md +++ b/doc/troubleshooting.md @@ -16,7 +16,7 @@ using the debugger. To debug some command you need to do the following: -* Figure out the name of the command you want to debug (e.g. by using `C-h k` +* Figure out the name of the command you want to debug (e.g. by using <kbd>C-h k</kbd> to see which command is associated with some keybinding) * Find the source of the command (e.g. by using `M-x find-function RET function-name`) * Press <kbd>C-u C-M-x</kbd> while in the body of the function @@ -35,11 +35,10 @@ out the big guns. #### Debugging the REPL init -To debug CIDER's -REPL initialization it's a good idea to hook into one of its entry points. Add a -breakpoint to `cider-make-repl` (`C-u C-M-x`, while in its body). Next time you -start CIDER you'll be dropped in the debugger and you can step forward until you -find the problem. +To debug CIDER's REPL initialization it's a good idea to hook into one of its +entry points. Add a breakpoint to `cider-make-repl` (<kbd>C-u C-M-x</kbd>, while +in its body). Next time you start CIDER you'll be dropped in the debugger and +you can step forward until you find the problem. ### Missing `*nrepl-messages*` buffer |