ruby - How can I insert a bullet (<li>) element in Markdown-formatted YARD documentation -
i using yardoc markdown document ruby code, , want have unordered list (html "bullets") in documentation method. here's have far:
$ cat file.rb class foo # returns "foo", consists of letters: # * f # * o # * o def method; "foo"; end end
and i'm generating documentation using:
$ yard doc --markup markdown file.rb
but not generate html bullets, treats asterisks (*
) literal characters. resulting doc/foo.html
file contains:
<span class="summary_desc"><div class='inline'><p>returns "foo", consists of letters: * f * o * o.</p> </div></span>
how can insert html bullets using markdown in yard? want each letter in above output wrapped in <li>...</li>
, , list surrounded <ul>
element.
i needed have blank line separating first line of text , start of list:
$ cat file.rb class foo # returns "foo", consists of letters: # # * f # * o # * o def method; "foo"; end end
which produces:
<div class="discussion"> <p>returns "foo", consists of letters:</p> <ul> <li>f</li> <li>o</li> <li>o</li> </ul> </div>
Comments
Post a Comment