Yard相对链接到额外文件

Question

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

例如,我有以下行:

    ...detailed instructions [here](contributing.md) on how to contribute

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

那么我发现我可以使用码DSL来使链接工作:

    ...detailed instructions {file:contributing.md here} on how to contribute

但是,如果从Github读取README,这将不起作用.我想要两种方式都天真吗？

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

Answer 1

我不确定你所说的“如果从 Github 上读取自述文件”是什么意思。

以下内容适用于我本地

1. 我通过 {file:my_file.md test} 将文件添加到自述文件中
2. 我通过 --files 命令行选项告诉yard有一个额外的文件。“测试”的链接出现在自述文件中。例如通过以下方式：

bundle exec yard --files my_file.md