Fork me on GitHub
#cljdoc
<
2019-09-19
>
Jakub Holý (HolyJak)09:09:12

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?

martinklepsch09:09:16

Both I guess. Ideally we would support all kinds of formats but in practice that’s hard of course

👍 4
Jakub Holý (HolyJak)09:09:45

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?

martinklepsch09:09:52

It could be it’s not explicitly documented

martinklepsch09:09:11

But look for derive-toc in the code

Avichal10:09:18

Looks good. Make sense to be explicit about the supported formats. Thanks 👍 Merge?

martinklepsch15:09:12

@U3ZPBUVJ7 sounds good! you have write access, so feel free to go ahead and merge

martinklepsch15:09:55

did it myself now but don’t ask for permission 🙂

martinklepsch15:09:05

If you think it’s good, it’s good!

👍 4