当前位置：文江博客话题详情

yard，如何将图像包含到文档中？

发布于 2024-11-05 18:32:08 字数 57 浏览 5 评论 0原文

我想将图像包含在院子生成的文档中，但无法在任何地方找到如何执行此操作...有人知道如何执行此操作吗？

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

耀眼的星火 2024-11-12 18:32:08

您只需将标记添加到文档中即可：

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

 end

You can just add <img /> tag to your documentation:

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

 end

回复收藏 0 原文

凉月流沐 2024-11-12 18:32:08

使用 rdoc-image: links：

# 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 文件。

Use rdoc-image: links:

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

is rendered by YARD into

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

The rdoc-images: also works in standalone *.rdoc files.

回复收藏 0 原文

高速公鹿 2024-11-12 18:32:08

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

回复收藏 0 原文

~没有更多了~