2

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>囲み、リストを<ul>要素で囲みます。

4

2 に答える 2

5

テキストの最初の行とリストの先頭を区切る空白行が必要でした。

$ 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>
于 2013-05-14T07:24:00.287 に答える