Skip to content

Commit 0754b08

Browse files
Add great documentation
1 parent 2f055d9 commit 0754b08

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc/tags

doc/jack_in.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
*jack_in.txt* Automatic REPL starting for Vim
2+
3+
INTRODUCTION *jack_in*
4+
5+
Provides a couple of helper commands for "jacking" in to a Clojure REPL by
6+
auto-starting it. Highly inspired by CIDER.el's feature by the same name.
7+
8+
COMMANDS *jack_in-commands*
9+
10+
These run inside the directory vim is currently in. In the future it would be
11+
nice to run relative to the current file.
12+
13+
*jack_in-:Boot*
14+
:Boot [args] Start boot with CIDER-nrepl and Refactor-nrepl
15+
automatically injected. [args] is a list of tasks to
16+
run in boot. If not provided, |g:default_boot_task| is
17+
used instead.
18+
19+
*jack_in-:Lein*
20+
:Lein [args] Start lein with CIDER-nrepl and Refactor-nrepl
21+
automatically injected. [args] is a list of tasks to
22+
run in lein. If not provided, |g:default_lein_task| is
23+
used instead.
24+
25+
VARIABLES *jack_in-variables*
26+
27+
*g:default_boot_task* Control the default task to start boot with. Defaults
28+
to "repl"
29+
30+
*g:default_lein_task* Control the default task to start lein with. Defaults
31+
to "repl"
32+
33+
vim:tw=78:ts=8:ft=help:norl:

0 commit comments

Comments
 (0)