Question

我正在使用带有Markdown的YARDoc来记录我的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>中，并且列表被{{1}包围} element。

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>

如何在Markdown格式的YARD文档中插入项目符号（<li>）</li>

1 个答案: