dotnet / dotnet/docfx

[Feature Request] Create links to external documentation sites like Newtonsoft.Json

Open
#9,060 1 comment 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Description of the problem/feature**
Im making a documentation page for a project and one of the parameters in a Method is a JArray object from the Newtonsoft.Json NuGet package. Normally if a type is refered to it will get linked to the microsoft docs if you click on the Text (for example a List will get linked to https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1). References are also made for classes that the programms define itself, for a example a Config or a Person class.

![image](https://github.com/dotnet/docfx/assets/61970072/d11c71a3-de01-4285-b4d8-c8e796e608b3)
in this image I can click on Config sends me to another page of my docs site, I can click on List, or string, which send me to the Microsoft docs, but I cant click on JArray to send me to Newtonsofts.Json documentation.

**Solution I would like:**
I'd like to be able to set links for types in a yaml file of some sort. For example id like to define that the class Newtonsoft.Json.JArray gets linked to https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JArray.htm

**considered alternatives**
Its possible this feature exists but I can't find a tutorial in docfxs documention. I found a similar issue already on StackOverflow (https://stackoverflow.com/questions/70602507/retrieve-docfx-metadata-from-nuget-packages) but it still wouldn't link the JArray class to any sort of documentation.

**Additional context**
I am new to docfx and haven't styled my template completly so please forgive me for it beeing a bit ugly in the screenshot

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.