search

plumatic / dommy

A tiny ClojureScript DOM manipulation and event library
758 stars 74 forks source link

Prose documentation #92

Open okal opened 9 years ago

okal commented 9 years ago

Would it be possible to setup a help site, with examples, and detailed description of API functionality? I'd be happy to contribute to that, given the framework for it. I've only been writing Clojure/ClojureScript for about a week now, so I don't know if it's typical in the Clojure community to read the source code when you're getting started with a lib :smile:

jdeisenberg commented 9 years ago

I used Codox and Marginalia to generate documentation. It's here. Not a help site, to be sure, but at least it gives you the comments from the code to help with the API.

niwinz commented 9 years ago

Maybe something similar to this: http://funcool.github.io/cats/latest/ http://funcool.github.io/cats/latest/api/

codox and marginalia generates a very ugly output...