reagent

A minimalistic ClojureScript interface to React.js http://reagent-project.github.io/
adriel 2020-11-13T18:04:59.207300Z

I’m looking into what solutions exist for automated documentation of reagent and/or even just plain clojurescript code. Is anyone out there aware of some existing projects that have solved this problem or are well-positioned to receive some contributions to add this functionality?

adriel 2020-11-13T18:06:29.207400Z

I’ve gotten [devcards](https://github.com/bhauman/devcards) going for component examples/diy documentation, but it would be nice to have an automated solution that could provide some basics… supported properties, etc.

Sven 2020-11-13T19:37:46.207900Z

https://github.com/weavejester/codox

Sven 2020-11-13T19:57:45.208500Z

Also, there is no Clojure CLI example in github so if you are using deps.edn then this should get you going quickly :) /resources/codox.edn

{:language :clojurescript
 :output-path "doc/codox"
 :source-uri "<https://github.com/.../blob/{version}/{filepath}#L{line}>"
 :metadata {:doc/format :markdown}
 :name "Example"
 :version "master"
 :description "Example app"}
/deps.edn
{:aliases {:codox     {:extra-deps  {codox {:mvn/version "0.10.7"}}
                       :main-opts   ["-e"
                                     "(require,'[codox.main,:as,c],'[<http://clojure.java.io|clojure.java.io>,:as,io],'[clojure.edn,:as,edn]),(-&gt;,\"codox.edn\",io/resource,slurp,edn/read-string,c/generate-docs)"]}}}
clj -A:codox

adriel 2020-11-13T22:01:03.208700Z

Thanks for this. I’ll check it out!