Clojure, The Essential Reference is the most detailed API reference for Clojure’s standard library, to date.
This repo allows you to quickly jump to any documentation entry in the book using the popular API browser Dash.
For now, you must purchase the book’s .epub file, then use our script to convert
it to a Dash .docset file.
“[Clojure] documentation exists in many forms and is overall very valuable, but it is fragmented: jumping between all the different sources is time consuming, including the fact that searching the right place it’s not always obvious. One of the main goals of this book is to do that work on your behalf: bringing together all the valuable sources of information in a single accessible place.”
“We think this book is a perfect fit for the intermediate or seasoned Clojure programmer who wants to understand how a function (and ultimately Clojure) works.“
“It’s the hope of the authors that this book is going to be a de-facto reference to the standard library and it’s certainly our desire to provide the reader with one of the most comprehensive source of information about Clojure.”
- Every heading is indexed as a Docset “Section”.
- Every chapter has its own Docset page (most of the code in our script is for merging chapters split across files)
- Table of Contents sidebar for each chapter.
-
Buy the book, and download the epub file to
book.epub. -
Run with Clojure CLI:
clj -Mrun -
Import
docset/ClojureEssentialReference.docsetinto Dash under Preferences > Docsets.
An Emacs Integration is available for jumping to the web version of the book, or for reading the EPUB file inside your editor.
It provides an index of symbols referenced in the book along with all the URLs to the online version if you wish to browse/index those instead of the EPUB file.