ruby - Yard 到额外文件的相对链接

Question

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

例如，我有以下几行:

...关于如何贡献的详细说明 [此处](contributing.md)

我希望这个链接到我的文件 contributing.md在同一个目录中。我可以在我的 .yardopts 文件中包含额外的文件，它会显示在文件列表中。

然后我发现我可以使用yard DSL来使链接正常工作:

...关于如何贡献的详细说明{file:contributing.md here}

但是，如果从 Github 读取自述文件，这将不起作用。我是否天真想要同时拥有它？

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

Answer 1

我不确定您所说的“是否正在从 Github 读取自述文件”是什么意思。
以下适用于我本地

我通过 {file:my_file.md test}

在自述文件中添加了一个文件

我通过 --files 命令行选项告诉 yard 有一个额外的文件。 “测试”的链接出现在自述文件中。例如以下方式:

bundle exec yard --files my_file.md