ruby - 院子里，如何将图像包含到文档中？

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，您应该使用不带结尾的 /。