Clojurians Log v2
Clojure programming
Channels
Apps
cljdoc
https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
Jakub Holý 2019-09-19T09:44:12.001500Z
I see that https://cljdoc.org/d/clj-http/clj-http/3.10.0 has no README b/c it is in .org, not .md/adoc. What is the recommended solution? Ask the project to export .md from .org? Or consider adding support for .org?
martinklepsch 2019-09-19T09:49:16.002900Z
Both I guess. Ideally we would support all kinds of formats but in practice that’s hard of course
Jakub Holý 2019-09-19T09:55:45.003900Z
I am looking at https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#basic-setup but do not see a description of where does cljdoc look for the readme file and what names / extensions it looks for, am I blind?
martinklepsch 2019-09-19T09:56:52.004500Z
It could be it’s not explicitly documented
martinklepsch 2019-09-19T09:57:11.004900Z
But look for derive-toc in the code
Jakub Holý 2019-09-19T09:57:37.005200Z
FYI I have opened https://github.com/dakrone/clj-http/issues/518
Jakub Holý 2019-09-19T10:10:16.005700Z
Thx, a PR to add info about README to the docs https://github.com/cljdoc/cljdoc/pull/352/files
Avichal 2019-09-21T10:23:18.005800Z
Looks good. Make sense to be explicit about the supported formats. Thanks 👍 Merge?
martinklepsch 2019-09-22T15:49:12.006Z
@avichalp sounds good! you have write access, so feel free to go ahead and merge
martinklepsch 2019-09-22T15:49:55.006200Z
did it myself now but don’t ask for permission 🙂
martinklepsch 2019-09-22T15:50:05.006400Z
If you think it’s good, it’s good!
Avichal 2019-09-22T17:59:12.006600Z
👍