GithubHelp home page GithubHelp logo

Comments (7)

llacom avatar llacom commented on June 4, 2024

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

from clojuredocs.

llacom avatar llacom commented on June 4, 2024

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

from clojuredocs.

jafingerhut avatar jafingerhut commented on June 4, 2024

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?

from clojuredocs.

zk avatar zk commented on June 4, 2024

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?

from clojuredocs.

jafingerhut avatar jafingerhut commented on June 4, 2024

@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.

from clojuredocs.

zk avatar zk commented on June 4, 2024

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

from clojuredocs.

matt-y avatar matt-y commented on June 4, 2024

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.

from clojuredocs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.