Ellerbach / docfx-companion-tools

A suite of tools, pipelines templates to take the very best of DocFX
MIT License
68 stars 19 forks source link

Added validation of root-reference with ~ #59

Closed mtirionMSFT closed 2 months ago

mtirionMSFT commented 2 months ago

DocFx supports the use of a ~ to reference the folder where the docfx.json resides. See documentation of DocFx. As we have no knowledge of that file in the DocLinkChecker, we assume that the docfx.json file is in the document root.

With this PR we added the support for the use of ~ to reference the documentation root folder, and we validate if the reference file exists. This test will fail of course if the docfx.json is in another directory.

This PR fixes #50.