Comments (7)
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.
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.
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.
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.
@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.
All good, IIRC you had reported last time the export stopped working so glad this wasn't a regression. Thanks Andy!
from clojuredocs.
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)
- Minor typo in comment form docs HOT 1
- HTTPS is not forced HOT 1
- Search inside docstrings
- Voting on answers HOT 3
- Twitter icon broken on the homepage HOT 1
- Can't use search bar if width is under 768px.
- Html injection spam
- Missing vars in clojure.xml
- Need to update Kira logo HOT 1
- Link to core.match documentation similarly to link to core.async HOT 1
- Add tools.build doc
- Update ClojureDocs to v1.11 HOT 6
- Bad docstring for if
- Seach form hidden on clojure.string page
- 4clojure link is dead HOT 2
- Document the options to clojure.java.io.{reader,writer,input-stream,output-stream}
- DEFN podcast invitation
- ClojureScript support in docs and output? HOT 1
- Slow responses from the live site today HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from clojuredocs.