Idea: Add a downloadable static copy, for offline viewing

[pjlegato]

Would it be hard to autogenerate a purely static / no-server-required copy of the website? This would be very useful to have available locally on a development laptop for day to day use: it'd be faster than hitting the network, and available offline, too.

[llacom]

CIDER has clojuredocs lookup built-in, it also works offline. To do that, they create a daily export as an EDN file, maybe that's good enough for you?

https://github.com/clojure-emacs/clojuredocs-export-edn

[llacom]

I'm half-wrong, the EDN export actually only converts an official json export, more info here: https://metaredux.com/posts/2019/12/14/exporting-clojuredocs-as-edn.html https://clojuredocs.org/clojuredocs-export.json

[jafingerhut]

I downloaded a copy of this JSON file today, and the time stamp included within it appears to be from 2021-Mar-28: https://clojuredocs.org/clojuredocs-export.json

Is there some periodic process to write new versions of that file that might no longer be running periodically since that day?

[zk]

Hrm, so the export runs daily, just checked and the process seems to be up.

I took a look at the "created-at" top level property of the export and it's looking like it was created today (unix ts 1634489704114 is what I'm seeing). Where is the 2021-Mar-28 timestamp coming from?

[jafingerhut]

@zk Sorry, my mistake. I somehow flubbed up the curl command for downloading the JSON file, and had an old copy locally on my file system. I have downloaded the actual latest version from https://clojuredocs.org/clojuredocs-export.json available today, and its time stamp is 2021-Oct-17 as desired. Thanks.

[zk]

All good, IIRC you had reported last time the export stopped working so glad this wasn't a regression. Thanks Andy!

[matt-y]

I'm also interested in a static version of the documentation being provided as a compressed HTML download or a single page download. Using something like wget to produce a copy of the documentation in an "offline" format is a messy solution and results in html with serious readability issues. To address someone's earlier point of being able to use the clouredocs CIDER integration: this requires CIDER to be installed, as well as additional work on the part of the user.

What work would be required to generate a static / downloadable version of clojuredocs without search or other dynamic content such as social media badges and comments? I'd be happy to pitch in with any accessibility efforts such as offline docs for folks with unreliable internet access.

In the spirit of increased documentation accessibility, I've also opened an issue within the official clojure-site repo.

A static version of the docs with a static view of the comments on various entries would be a nice-to-have addition. Often those are quite helpful.