Instant Cheatsheet instantly creates a cheatsheet for your project and its dependecies.
lein-instant-cheatsheet
to your Leiningen :plugins
lein instant-cheatsheet
Instant Cheatsheet spins up a Ring server at localhost:13370
and automatically reloads documentation whenever a Clojure file in your project changes.
Instant Cheatsheet has a few features that might just make it your go-to Clojure reference:
Instant Cheatsheet has a built-in filter bar at the top to search for matching symbols. A list of matching symbols and their namespaces appears on the left side of the screen; documentation for those symbols appear on the right.
You can also see documentation in a tooltip by hovering over symbols on the left, and you can see source code (if available) by hovering over the source
links on the right.
You can also search for examples from ClojureDocs by clicking the examples
link.
Instant Cheatsheet will automatically use the GET parameter q
as an initial value for the filter bar.
That means a request like http://localhost:13370/#?q=print
will automatically search for symbols containing print
.
Like Marginalia, Instant Cheatsheet parses docstrs as Markdown. Add examples, links, and more to your documentation!
Instant Cheatsheet also understands :emoji:
names à la GitHub or Slack. Emoji names like :yum:
will automatically be replaced with emoji images like :yum:.
You can create an Emacs function to search Instant Cheatsheet, and even bind it to a keyboard shortcut:
(defun instant-cheatsheet-search (search-term)
"Open a browser window and search Instant Clojure Cheatsheet for SEARCH-TERM."
(interactive (list (read-string "Search Instant Clojure Cheatsheet for: "
(when (symbol-at-point)
(let ((s (copy-sequence (symbol-name (symbol-at-point)))))
(set-text-properties 0 (length s) nil s)
s)))))
(browse-url (concat "http://localhost:13370/#?q=" (url-hexify-string search-term))))
(dolist (keymap (list clojure-mode-map cider-repl-mode-map))
(define-key keymap (kbd "<f12> i") #'instant-cheatsheet-search))
Hitting <f12> i
will prompt you for a search term and open a new browser tab with that term as the initial filter text.
2.2.2
(December 4th, 2017)
2.2.1
(Februrary 26th, 2016)
2.2.0
(Februrary 26th, 2016)
:emoji:
with the equivalent characters via js-emoji.2.1.5
(February 23rd, 2016)
2.1.4
(April 14th, 2015)
2.1.3
(April 1st, 2015)
:main
class defined2.1.1
(March 31st, 2015)
clojure.repl/source-fn
does not2.1.0
(March 30th, 2015)
2.0.0
(March 13th, 2015)
1.5.0
(Feb 4th, 2015)
1.0.0
(April 5th, 2013)
Instant Cheatsheet is inspired by other excellent Clojure cheatsheets like this one.
Instant Cheatsheet was built with Hiccup, Bootstrap, and AngularJS.
Can you improve this documentation? These fine people already did:
Cam Saül, Cam Saul, Cameron Saul & NDumaEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close