dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
4.09k stars 866 forks source link

[Feature Request] dotnet API link to a specific version? #10040

Open bohyunjung opened 5 months ago

bohyunjung commented 5 months ago

Is your feature request related to a problem? Please describe.

I build markdown files (#10039) out of the Unity Package projects (#9719) and need the dotnet APIs to be linked to a specific version. (In my case that's netframework-4.8.1.)

That is

However I could not find the way to achieve this; so I wrote a post-processing logic which finds a pattern match, then replaces strings.

Describe the solution you'd like

I would love to have an option that specifies the version of the dotnet API version, which is simply gonna be a query parameter added to the generated URL (view=netframework-4.8.1)

OR making it possible to format the dotnet API URL string, in the manner of xref template rendering should be nice as well.

Additional context

Here's the docfx.json I use.

docfx.json ```json { "metadata": [ { "src": [ { "src": "..", "files": [ "**/*.cs" ] } ], "dest": "api", "globalNamespaceId": "Global", "allowCompilationErrors": true, "namespaceLayout": "flattened", "outputFormat": "markdown", "filter": "filterConfig.yml" } ] } ```
yufeih commented 4 months ago

We might be able to auto detect target version based on info in csproj or DLL.

bohyunjung commented 4 months ago

@yufeih That's a great idea. Specifying the version while leaving it auto-detected by default may still be handy.