Fork me on GitHub
#cljdoc
<
2020-09-30
>
Shantanu Kumar09:09:04

Hi, does cljdoc pick up (i.e. consider documentation) EDN files in the doc directory of projects?

martinklepsch09:09:55

Not really. What would you like to see being done with EDN files?

Shantanu Kumar10:09:55

@U050TNB9F These are sample EDN files for annotated reference. I can create markdown files out of them, but that’s manual work.

martinklepsch10:09:08

I see. So right now you’d need to wrap them in Markdown or Asciidoc. I’d be open to a contribution in the direction of allowing people to point to EDN files as articles though

dominicm11:09:20

You might be able to include them from asciidoc.

lread12:09:32

If I remember correctly, cljdoc does not support asciidoc includes... maybe due to some default safety settings... can have a look if there is real interest.

dominicm14:09:43

Ah, there'd be a bit of investigation to look at the tools available for protecting from include:/etc/passwd

lread15:09:36

Ah yeah… that makes sense.

dominicm16:09:51

Might be fine given that we literally execute clojure code anyway

martinklepsch19:09:58

We don’t do that for this part of the process, only for the actual source analysis. The ingestion of articles happens on the cljdoc server

dominicm19:09:21

Ah, in that case, need to be more careful :)

Shantanu Kumar15:10:33

FWIW I ended up linking to the EDN files from a markdown doc that is rendered by cljdoc, because Github renders EDN decently too.

lread20:09:44

A question… cljdoc https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#wikilinks only work from docstrings. Is there a reason why we don’t support wikilinks from articles? (for AsciiDoctor we’d have to use a different syntax, but it is possible).

martinklepsch20:09:12

Do you mean to link to namespaces/vars?

martinklepsch20:09:50

These links wouldn’t work on GitHub etc. and linking already is possible/practical with using CURRENT as version

martinklepsch20:09:31

So I think my main argument against this would be that it creates a poor experience on other platforms with only a mild improvement in the authoring experience

lread20:09:52

Fair enough. Tx!