Skip to content

Commit 5a1533f

Browse files
bbatsovbbatsov
committed
Move the cider-mode keybindings just after the mode's description
1 parent d43632d commit 5a1533f

File tree

1 file changed

+51
-56
lines changed

1 file changed

+51
-56
lines changed

‎README.md

Lines changed: 51 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ specific CIDER release.**
4848
- [Using cider-mode](#using-cider-mode)
4949
- [ClojureScript usage](#clojurescript-usage)
5050
- [Keyboard shortcuts](#keyboard-shortcuts)
51-
- [cider-mode](#cider-mode)
5251
- [cider-repl-mode](#cider-repl-mode)
5352
- [cider-macroexpansion-mode](#cider-macroexpansion-mode)
5453
- [cider-inspector-mode](#cider-inspector-mode)
@@ -366,9 +365,57 @@ In Clojure(Script) buffers the command `cider-connect` is bound to <kbd>C-c M-c<
366365

367366
CIDER comes with a handy minor mode called `cider-mode` (complementing
368367
`clojure-mode`) that allows you to evaluate code in your Clojure source
369-
files and load it directly in the REPL. A list of all
370-
available commands is available in the CIDER menu and in the following
371-
section of this manual.
368+
files and load it directly in the REPL. Here's a list of its keybindings:
369+
370+
Keyboard shortcut | Description
371+
-------------------------------------|-------------------------------
372+
<kbd>C-x C-e</kbd> <kbd>C-c C-e</kbd>| Evaluate the form preceding point and display the result in the echo area. If invoked with a prefix argument, insert the result into the current buffer.
373+
<kbd>C-c C-w</kbd> | Evaluate the form preceding point and replace it with its result.
374+
<kbd>C-c M-e</kbd> | Evaluate the form preceding point and output it result to the REPL buffer. If invoked with a prefix argument, takes you to the REPL buffer after being invoked.
375+
<kbd>C-c M-p</kbd> | Load the form preceding point in the REPL buffer.
376+
<kbd>C-c C-p</kbd> | Evaluate the form preceding point and pretty-print the result in a popup buffer.
377+
<kbd>C-c C-f</kbd> | Evaluate the top level form under point and pretty-print the result in a popup buffer.
378+
<kbd>C-M-x</kbd> <kbd>C-c C-c</kbd> | Evaluate the top level form under point and display the result in the echo area.
379+
<kbd>C-u C-M-x</kbd> <kbd>C-u C-c C-c</kbd> | Debug the top level form under point and walk through its evaluation
380+
<kbd>C-c C-r</kbd> | Evaluate the region and display the result in the echo area.
381+
<kbd>C-c C-b</kbd> | Interrupt any pending evaluations.
382+
<kbd>C-c C-m</kbd> | Invoke `macroexpand-1` on the form at point and display the result in a macroexpansion buffer. If invoked with a prefix argument, `macroexpand` is used instead of `macroexpand-1`.
383+
<kbd>C-c M-m</kbd> | Invoke `clojure.walk/macroexpand-all` on the form at point and display the result in a macroexpansion buffer.
384+
<kbd>C-c C-n</kbd> | Eval the ns form.
385+
<kbd>C-c M-n</kbd> | Switch the namespace of the REPL buffer to the namespace of the current buffer.
386+
<kbd>C-c C-z</kbd> | Switch to the relevant REPL buffer. Use a prefix argument to change the namespace of the REPL buffer to match the currently visited source file.
387+
<kbd>C-u C-u C-c C-z</kbd> | Switch to the REPL buffer based on a user prompt for a directory.
388+
<kbd>C-c M-z</kbd> | Load (eval) the current buffer and switch to the relevant REPL buffer. Use a prefix argument to change the namespace of the REPL buffer to match the currently visited source file.
389+
<kbd>C-c M-d</kbd> | Display default REPL connection details, including project directory name, buffer namespace, host and port.
390+
<kbd>C-c M-r</kbd> | Rotate and display the default nREPL connection.
391+
<kbd>C-c C-o</kbd> | Clear the last output in the REPL buffer. With a prefix argument it will clear the entire REPL buffer, leaving only a prompt. Useful if you're running the REPL buffer in a side by side buffer.
392+
<kbd>C-c C-k</kbd> | Load (eval) the current buffer.
393+
<kbd>C-c C-l</kbd> | Load (eval) a Clojure file.
394+
<kbd>C-c C-x</kbd> | Reload all modified files on the classpath. If invoked with a prefix argument, reload all files on the classpath. If invoked with a double prefix argument, clear the state of the namespace tracker before reloading.
395+
<kbd>C-c C-d d</kbd> | Display doc string for the symbol at point. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
396+
<kbd>C-c C-d j</kbd> | Display JavaDoc (in your default browser) for the symbol at point. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
397+
<kbd>C-c M-i</kbd> | Inspect expression. Will act on expression at point if present.
398+
<kbd>C-c M-t v</kbd> | Toggle var tracing.
399+
<kbd>C-c M-t n</kbd> | Toggle namespace tracing.
400+
<kbd>C-c C-u</kbd> | Undefine a symbol. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
401+
<kbd>C-c ,</kbd> | Run tests for namespace.
402+
<kbd>C-c C-,</kbd> | Re-run test failures/errors for namespace.
403+
<kbd>C-c M-,</kbd> | Run test at point.
404+
<kbd>C-c C-t</kbd> | Show the test report buffer.
405+
<kbd>M-.</kbd> | Jump to the definition of a symbol. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
406+
<kbd>C-c M-.</kbd> | Jump to the resource referenced by the string at point.
407+
<kbd>C-c C-.</kbd> | Jump to some namespace on the classpath.
408+
<kbd>M-,</kbd> | Return to your pre-jump location.
409+
<kbd>M-TAB</kbd> | Complete the symbol at point.
410+
<kbd>C-c C-d r</kbd> | Lookup symbol in Grimoire.
411+
<kbd>C-c C-d a</kbd> | Apropos search for functions/vars.
412+
<kbd>C-c C-d A</kbd> | Apropos search for documentation.
413+
<kbd>C-c C-q</kbd> | Quit the current nREPL connection. With a prefix argument it will quit all connections.
414+
415+
There's no need to memorize this list. In any Clojure buffer with `cider-mode`
416+
active you'll have a CIDER menu available, which lists all the most important
417+
commands and their keybindings. You can also invoke `C-h f RET cider-mode` to
418+
get a list of the keybindings for `cider-mode`.
372419

373420
### ClojureScript usage
374421

@@ -433,58 +480,6 @@ While you're in `clojure-mode`, `cider-jack-in` is bound for
433480
convenience to <kbd>C-c M-j</kbd> and `cider-connect` is bound to <kbd>C-c
434481
M-c</kbd>.
435482

436-
### cider-mode
437-
438-
Keyboard shortcut | Description
439-
-------------------------------------|-------------------------------
440-
<kbd>C-x C-e</kbd> <kbd>C-c C-e</kbd>| Evaluate the form preceding point and display the result in the echo area. If invoked with a prefix argument, insert the result into the current buffer.
441-
<kbd>C-c C-w</kbd> | Evaluate the form preceding point and replace it with its result.
442-
<kbd>C-c M-e</kbd> | Evaluate the form preceding point and output it result to the REPL buffer. If invoked with a prefix argument, takes you to the REPL buffer after being invoked.
443-
<kbd>C-c M-p</kbd> | Load the form preceding point in the REPL buffer.
444-
<kbd>C-c C-p</kbd> | Evaluate the form preceding point and pretty-print the result in a popup buffer.
445-
<kbd>C-c C-f</kbd> | Evaluate the top level form under point and pretty-print the result in a popup buffer.
446-
<kbd>C-M-x</kbd> <kbd>C-c C-c</kbd> | Evaluate the top level form under point and display the result in the echo area.
447-
<kbd>C-u C-M-x</kbd> <kbd>C-u C-c C-c</kbd> | Debug the top level form under point and walk through its evaluation
448-
<kbd>C-c C-r</kbd> | Evaluate the region and display the result in the echo area.
449-
<kbd>C-c C-b</kbd> | Interrupt any pending evaluations.
450-
<kbd>C-c C-m</kbd> | Invoke `macroexpand-1` on the form at point and display the result in a macroexpansion buffer. If invoked with a prefix argument, `macroexpand` is used instead of `macroexpand-1`.
451-
<kbd>C-c M-m</kbd> | Invoke `clojure.walk/macroexpand-all` on the form at point and display the result in a macroexpansion buffer.
452-
<kbd>C-c C-n</kbd> | Eval the ns form.
453-
<kbd>C-c M-n</kbd> | Switch the namespace of the REPL buffer to the namespace of the current buffer.
454-
<kbd>C-c C-z</kbd> | Switch to the relevant REPL buffer. Use a prefix argument to change the namespace of the REPL buffer to match the currently visited source file.
455-
<kbd>C-u C-u C-c C-z</kbd> | Switch to the REPL buffer based on a user prompt for a directory.
456-
<kbd>C-c M-z</kbd> | Load (eval) the current buffer and switch to the relevant REPL buffer. Use a prefix argument to change the namespace of the REPL buffer to match the currently visited source file.
457-
<kbd>C-c M-d</kbd> | Display default REPL connection details, including project directory name, buffer namespace, host and port.
458-
<kbd>C-c M-r</kbd> | Rotate and display the default nREPL connection.
459-
<kbd>C-c C-o</kbd> | Clear the last output in the REPL buffer. With a prefix argument it will clear the entire REPL buffer, leaving only a prompt. Useful if you're running the REPL buffer in a side by side buffer.
460-
<kbd>C-c C-k</kbd> | Load (eval) the current buffer.
461-
<kbd>C-c C-l</kbd> | Load (eval) a Clojure file.
462-
<kbd>C-c C-x</kbd> | Reload all modified files on the classpath. If invoked with a prefix argument, reload all files on the classpath. If invoked with a double prefix argument, clear the state of the namespace tracker before reloading.
463-
<kbd>C-c C-d d</kbd> | Display doc string for the symbol at point. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
464-
<kbd>C-c C-d j</kbd> | Display JavaDoc (in your default browser) for the symbol at point. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
465-
<kbd>C-c M-i</kbd> | Inspect expression. Will act on expression at point if present.
466-
<kbd>C-c M-t v</kbd> | Toggle var tracing.
467-
<kbd>C-c M-t n</kbd> | Toggle namespace tracing.
468-
<kbd>C-c C-u</kbd> | Undefine a symbol. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
469-
<kbd>C-c ,</kbd> | Run tests for namespace.
470-
<kbd>C-c C-,</kbd> | Re-run test failures/errors for namespace.
471-
<kbd>C-c M-,</kbd> | Run test at point.
472-
<kbd>C-c C-t</kbd> | Show the test report buffer.
473-
<kbd>M-.</kbd> | Jump to the definition of a symbol. If invoked with a prefix argument, or no symbol is found at point, prompt for a symbol.
474-
<kbd>C-c M-.</kbd> | Jump to the resource referenced by the string at point.
475-
<kbd>C-c C-.</kbd> | Jump to some namespace on the classpath.
476-
<kbd>M-,</kbd> | Return to your pre-jump location.
477-
<kbd>M-TAB</kbd> | Complete the symbol at point.
478-
<kbd>C-c C-d r</kbd> | Lookup symbol in Grimoire.
479-
<kbd>C-c C-d a</kbd> | Apropos search for functions/vars.
480-
<kbd>C-c C-d A</kbd> | Apropos search for documentation.
481-
<kbd>C-c C-q</kbd> | Quit the current nREPL connection. With a prefix argument it will quit all connections.
482-
483-
There's no need to memorize this list. In any Clojure buffer with `cider-mode`
484-
active you'll have a CIDER menu available, which lists all the most important
485-
commands and their keybindings. You can also invoke `C-h f RET cider-mode` to
486-
get a list of the keybindings for `cider-mode`.
487-
488483
### cider-repl-mode
489484

490485
Keyboard shortcut | Description

0 commit comments

Comments
 (0)