Fork me on GitHub
#cljdoc
<
2018-08-11
>
bbrinck21:08:01

Is there a trick to get cljdoc to format docstrings with newlines? My docs look like this: https://cljdoc.xyz/d/expound/expound/0.7.2-SNAPSHOT/api/expound.alpha#custom-printer for a docstring that uses newlines like this: https://github.com/bhb/expound/blob/master/src/expound/alpha.cljc#L873-L879

martinklepsch00:08:08

The summarized answer is : use markdown

martinklepsch00:08:43

cljdoc might eventually support plain text with a fixed width font but I think markdown is preferable and so it’s not a very high priority at this point

bbrinck00:08:39

Do you mean markdown within the docstring?

bbrinck00:08:51

ie I should be formatting those list items with - or * (or whatever the MD symbol for list items is)?

bbrinck00:08:41

I’ll give that a go. Thanks!

martinklepsch07:08:41

Yes exactly :) you can also use backticks :options to better highlight the option name