如何将html文档与docfx链接

时间:2017-09-12 22:04:09

标签: docfx

我们目前正在使用docfx为我们的代码生成html文档。

我们还有其他链接到的html文档。

到目前为止,我已将其作为docfx.json文件中的资源部分包含在内,这样可行,但docfx会抱怨我指向它的任何链接,因为它不知道它。

在构建部分下添加html文件的工作量更少,因为docfx不知道如何处理它。

我也尝试创建一个xrefmap.yml文件来指向我现有的html,它似乎不喜欢有本地的相对引用。

2 个答案:

答案 0 :(得分:0)

  

到目前为止,我已将其作为docfx.json文件中的资源部分包含在内,这样可行,但docfx会抱怨我指向它的任何链接,因为它不知道它。

DocFX了解资源部分。您应该像[a resource](resource.html)一样引用它。

我怀疑您使用的是[a resource](resource.md),然后会记录警告,因为resource.md不存在。

答案 1 :(得分:0)

我错过了html内容的toc.yml文件。