Offline Clojure docs

[David Pollak]

Folks,

Is there an offline package of Clojure docs (the full core.* api docs, cheat sheets, etc.)?

I'm traveling with intermittent Internet connectivity (I'm in China now and it's marginal but I'm going to the UP in Michigan where there's no Internet within 15 miles of where I'm staying).

With all the travel and flying and such, it'd be great to have all the docs without having to clone all the various source repositories.

Thanks for your help.

David

[guns]

On Mon 1 Jul 2013 at 07:44:17AM +0800, David Pollak wrote:

> Is there an offline package of Clojure docs (the full core.* api docs,
> cheat sheets, etc.)?

If you work with an editor with clojure REPL integration, you can
fashion your own cheat sheet.

I have a vim command that dumps a list of all public vars with arglists
(filtered by an optional pattern) into a scratch buffer like this:

;;; clojure.core {{{1

clojure.core/*1
clojure.core/*2
clojure.core/*3
…
clojure.core/xml-seq [root]
clojure.core/zero? [x]
clojure.core/zipmap [keys vals]

;;; clojure.core.protocols {{{1

…

Then I use the REPL commands in the buffer to look up docs, source, and
search vars with the editor. It's quite handy, and always up to date.

The funny {{{1 bits are fold markers that allow code folding by
namespace. A cheat sheet in org-mode format would be pretty nice for
emacs.

My apologies if you've already considered this. If you haven't, I hope
you find the suggestion useful.

guns

[Sean Corfield]

There are a couple of iPhone apps with Clojure docs:

https://itunes.apple.com/us/app/clojuredoc/id401479442?mt=8 <-- free,
hasn't been updated for ages, but this is what I use anyway

https://itunes.apple.com/us/app/clojure-bee-api-documentation/id524862532?mt=8
<-- $0.99, hasn't been updated in a year, no idea about this one

Sean

> --
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to clo...@googlegroups.com
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> clojure+u...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
> ---
> You received this message because you are subscribed to the Google Groups
> "Clojure" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to clojure+u...@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>



--
Sean A Corfield -- (904) 302-SEAN
An Architect's View -- http://corfield.org/
World Singles, LLC. -- http://worldsingles.com/

"Perfection is the enemy of the good."
-- Gustave Flaubert, French realist novelist (1821-1880)

[Mark Engelberg]

Download here:
https://github.com/clojure/clojure/tree/gh-pages

[David Pollak]

Thanks everyone for the super helpful suggestions!

On Mon, Jul 1, 2013 at 9:04 AM, Mark Engelberg <mark.en...@gmail.com> wrote:

Download here:
https://github.com/clojure/clojure/tree/gh-pages

[Erik Bakstad]

If you are a Mac user I highly recommend Dash it has all kinds of documentation available for download, and the search is very nice as well.

-Erik

[Tom Faulhaber]

It's easy to pull the autodoc documentation for offline use. You can either do this:

$ git clone https://github.com/clojure/clojure.git clojure-api

$ cd clojure-api

$ git checkout gh-pages

or you can just open "https://github.com/clojure/clojure/archive/gh-pages.zip" or pull the directory with 

$ curl  -L https://github.com/clojure/clojure/archive/gh-pages.tar.gz | tar tvzf -

The same method works for all the contrib docs (though there isn't a command that gets all the docs) and incanter as well.

HTH,

Tom

[Kelker Ryan]

wget -k -m http://clojure-doc.org/

wget -k -m http://clojuredocs.org/

 

06.07.2013, 12:59, "Tom Faulhaber" <tomfau...@gmail.com>:

--

[Tom Faulhaber]

Sorry, my second method should have been:

$ curl  -L https://github.com/clojure/clojure/archive/gh-pages.tar.gz | tar xvzf -

Enjoy!

Tom

[Lan Rogers]

Zeal is a Dash clone for linux/windows, and is api compatible with Dash docsets, hence would include the clojure docset. It's a little rough around the edges UI-wise but it gets the job done.