search

clojure / clojure-site

clojure.org site
https://clojure.org
Eclipse Public License 1.0
250 stars 271 forks source link

Make documentation available in a static offline format #637

Open matt-y opened 1 year ago

matt-y commented 1 year ago

I am interested in using the Clojure language documentation offline. Would it be possible to provide a static HTML version of the reference material listed below (and any other relevant materials) for offline usage? Languages such as Python provide static/offline documentation of the language and core libraries. Having access to documentation without a persistent internet connection would be beneficial for clojure users.

Additional formats such as PDF, EPUB, etc would also be a very nice thing to have on top of a static HTML version.

I opened this ticket because I was unable to find a downloadable version of the language documentation. If downloadable docs do exist, please link them below for future seekers and close this ticket.

thank you !

puredanger commented 1 year ago

This web site is statically built and you can build it yourself if you like using the instructions at https://github.com/clojure/clojure-site#building-the-site (and that's essentially the same process done during the site build, with some minor additions). I don't think it would be too hard to zip and publish that during the site build if that would be useful.

The API pages are separate - they are hosted on github pages and you can find them here: https://github.com/clojure/clojure/tree/gh-pages

puredanger commented 1 year ago

I spent a few minutes looking at this - it's definitely more work than I had expected. That is, it's easy to build, but difficult to build (right now) in a way that is self contained, css+js work, links work, etc. Unless there is some urgent need for this, I'm going to backlog this for now.