Is there a ClojureDocs API or not?


#1

What’s up with the ClojureDocs API? I can’t find any info about it, except some old traces, and the site https://api.clojuredocs.org is totally unresponsive.


#2

I am pretty sure no, but would love to hear otherwise: https://github.com/zk/clojuredocs/issues/86


#3

That issue was the main trace I found. :grinning:


#4

Is there some other resource with examples on how to use clojure functions?


#5

There is Grimoire at https://www.conj.io/ but realize that at least its initial set of examples were, I believe, copied from ClojureDocs some years ago. I do not know how much they have been modified or added to since then, but the commit log for the project might give some indication.

If you are looking for examples of functions as used across many actual open source Clojure projects there is https://crossclj.info/ but those are not tutorial-style examples, but in the context of the project’s code.


#6

Thanks! I am figuring on going beyond Calva’s ”look up docs/peek at, and go to, definitions” functionality and offer to load some example usages from ClojureDocs into a top level comment block in your editor. Because that is what I often do manually to explore what a function can do for me. Looks like conj.io could be a good alternative. Even if it is so far lacking the ”see also” sections that are so wonderfully helpful on ClojureDocs.

In my dream world the API would also have a way to contribute examples directly from the editor. Maybe some day.