clojure-emacs / cider

The Clojure Interactive Development Environment that Rocks for Emacs
https://cider.mx
GNU General Public License v3.0
3.55k stars 645 forks source link

Add examples from https://clojuredocs.org/ to `(cider-doc)`'s result buffer #3744

Open eval-exec opened 1 month ago

eval-exec commented 1 month ago

Is your feature request related to a problem? Please describe. I'm leaning clojure language now, and I like to learn clojure function's usage from https://clojuredocs.org, for example, when I put cursor in format, then I hit K(cider-doc), it will show: image But I think it would be more convinent if cider-doc can show examples from about https://clojuredocs.org/clojure.core/format image

(As clojure beginners, examples are very helpful for us)

Describe the solution you'd like

let cider download all examples from https://clojuredocs.org, and display examples under (cider-doc)'s result buffer

Describe alternatives you've considered None Additional context None

eval-exec commented 1 month ago

Hello, cider's developers, do you think this is a good idea?

eval-exec commented 1 month ago

I found this repo: https://github.com/clojure-emacs/clojuredocs-export-edn

All clojuredocs's exmaple are there.

yuhan0 commented 1 month ago

Are you aware of the command M-x cider-clojuredocs (C-c C-d C-c)?

Perhaps it would help discoverability to introduce a [View Clojuredocs] button in the *cider-doc* buffer when applicable, somewhere close to the existing "Also See" buttons.