Fork me on GitHub
#reagent
<
2020-11-13
>
adriel18:11:59

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?

adriel18:11:29

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.

Sven19:11:45

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 ""
 :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],'[,:as,io],'[clojure.edn,:as,edn]),(->,\"codox.edn\",io/resource,slurp,edn/read-string,c/generate-docs)"]}}}
clj -A:codox

adriel22:11:03

Thanks for this. I’ll check it out!

souenzzo02:11:50

also #workspaces (like devcards)