From 4dbc79fd68efdce74f122f56c82657b45abb2ed7 Mon Sep 17 00:00:00 2001 From: jbranchaud Date: Tue, 7 Apr 2015 08:40:18 -0500 Subject: [PATCH] Add Quick Clojure Docs as a clojure til. --- README.md | 1 + clojure/quick-clojure-docs.md | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 clojure/quick-clojure-docs.md diff --git a/README.md b/README.md index 2aec8af..d6303a9 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ smart people at [Hashrocket](http://hashrocket.com/). ### clojure +- [Quick Clojure Docs](clojure/quick-clojure-docs.md) - [Specify the Directory of a Shell Command](clojure/specify-the-directory-of-a-shell-command.md) - [Splitting On Whitespace](clojure/splitting-on-whitespace.md) - [Swap Two Items in a Vector](clojure/swap-two-items-in-a-vector.md) diff --git a/clojure/quick-clojure-docs.md b/clojure/quick-clojure-docs.md new file mode 100644 index 0000000..2aabb95 --- /dev/null +++ b/clojure/quick-clojure-docs.md @@ -0,0 +1,9 @@ +# Quick Clojure Docs + +Assuming you already have the +[`fireplace.vim`](https://github.com/tpope/vim-fireplace) plugin installed +and a repl running, you can quickly pull up the docs for any clojure +function. Navigate the cursor over the keyword in question and hit `K` in +normal mode. This will instruct `fireplace.vim` to use the `doc` function on +the symbol for that keyword. The docs associated with that keyword will be +displayed at the bottom of the window.