ruby - 如何在 Markdown 格式的 YARD 文档中插入项目符号 () 元素

Question

我正在使用 YARDoc使用 Markdown 来记录我的 Ruby 代码，并希望在方法的文档中有一个无序列表(HTML“项目符号”)。这是我到目前为止所拥有的:

$ cat file.rb
class Foo
  # Returns "foo", which consists of the letters:
  # * f
  # * o
  # * o
  def method; "foo"; end
end

我正在使用以下方法生成文档:

$ yard doc --markup markdown file.rb

但它不会生成 HTML 项目符号，它会将星号 ( * ) 视为文字字符。结果 doc/Foo.html文件包含:

<span class="summary_desc"><div class='inline'><p>Returns &quot;foo&quot;,
which consists of the letters:
* f
* o
* o.</p>
</div></span>

如何在 YARD 中使用 Markdown 插入 HTML 项目符号？我基本上希望以上输出中的每个字母都包含在 <li>...</li> 中, 以及被 <ul> 包围的列表元素。

Answer 1

我需要一个空行来分隔文本的第一行和列表的开头:

$ cat file.rb 
class Foo
  # Returns "foo", which consists of the letters:
  #
  # * f
  # * o
  # * o
  def method; "foo"; end
end

产生:

<div class="discussion">
  <p>Returns &quot;foo&quot;, which consists of the letters:</p>
  <ul>
    <li>f</li>
    <li>o</li>
    <li>o</li>
  </ul>
</div>