院子里，如何将图像包含在文档中？

Question

我想在院子生成的文档中包含图片，但无法在任何地方找到如何做到这一点...有谁知道怎么做？

Answer 1

您只需在文档中添加<img />标记：

 # Blah-blah 
 # 
 # <img src=img/1.png />
 # @param [String] blah
 # @return [String] blah
 def foo(bar) 

 end

Answer 2

使用rdoc-image:个链接：

# Gets foo.
#
# rdoc-image:img/1.png
def foo(bar)
  "foo"
end

由YARD呈现为

<p>Gets foo.</p>
<p><img src="img/1.png"></p>

rdoc-images:也适用于独立的*.rdoc个文件。

Answer 3

根据您的标记格式，您可能必须使用其他机制。例如，如果您使用Markdown，则语法为![Alt text](/path/to/img.jpg)。在RDoc中，img标记应该可以工作，但是您可以检查它们是否为此添加了特殊的标记语法。请注意，RDoc可能（不确定）不喜欢XHTML，你应该使用没有结尾/.