![]() ![]() For example, in the above case, you can also write the link as follows: (/subfolder/file2.html) That means you should use the output file path as absolute path. You can also use absolute path (path starts with /) to link to another file, but DocFX won't check its correctness for you and will keep it as-is in the output HTML. html).Ī file must be included in docfx.json to be processed by DocFX, so if you see a build warning about a broken link but the fileĪctually exists in your file system, go and check whether this file is included in docfx.json. ![]() ![]() You can use relative path to reference file2.md in file1.md: (subfolder/file2.md)ĭocFX converts it to a relative path in output folder structure: file2 You have a file1.md under root and a file2.md under subfolder/: / In DocFX, you can link to a file using its relative path in the source directory. In this document, you'll learn the functionalities DocFX provides for resolving file links and cross reference, which will help you to reference other files in an efficient way. This is especially common in API reference docs, for example, you may want to use System.String to link to the topic of String class, without knowing it's actually located in api/system/string.html, which is auto generated. What's more, there is also a common need to link to another file using a "semantic" name instead of its file path. Markdown spec doesn't have a clear definition of how this should be supported. When working with large documentation project that contains multiple files, it is often needed to link to another Markdown file using the relative path in the source directory. Or a relative url pointing to a local resource on the same server (for example, about.html). Here the url in the link could be either absolute url pointing to another website ( in the above example), Markdown provides a syntax to create hyperlinks.įor example, the following syntax: () ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |