码场相对链接到额外文件

Question

我想使用Yard从我的README中链接到另一个额外的文件。

例如，我有以下行：

    ...详细说明请看[这里](contributing.md)，了解如何做出贡献

我希望它能够链接到同一目录中的contributing.md文件。 我可以在我的.yardopts文件中包含额外的文件，并且它将像应该显示的那样出现在文件列表中。

然后我发现我可以使用yard DSL使链接工作：

    ...详细说明{file:contributing.md here}以了解如何做出贡献

但是，如果从Github阅读README，则此方法无效。我是否天真地希望两种方式都能实现？

有没有一种使用Yard在Markdown中链接到另一个.md额外文件的方法？

- hackyday

---

我也一直在试图解决这个问题，但是没有成功。 - jrochkind

Answer 1

我不确定您的意思是'如果README是从Github阅读的'。

以下内容在我的本地环境中有效

1. 我通过{file:my_file.md test}向README添加一个文件
2. 我通过--files命令行选项告诉yard有一个额外的文件。 “test”链接将显示在README中，例如：

bundle exec yard --files my_file.md

- Axe