-
Notifications
You must be signed in to change notification settings - Fork 604
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[api-documenter] MarkdownDocumenter: Links to referenced types in type cells #1611
Comments
This problem is slightly complicated because we're halfway through a redesign of the declaration reference formalism. In the old model, API items were identified using TSDoc's The DocFX implementation was conveniently able to sidestep this part, because DocFX itself supports hyperlinking based on string IDs. I feel like we could achieve something similar by having @thorbenziemek I could help with setting up this mapping, if you're able to do the front-end work of emitting Markdown hyperlinks for each token. |
Thank you @octogonz for the clarification! From what I understand, implementing the Markdown part should be super easy, so I would be happy to help with that part ;). |
This fix was published with API Documenter 7.8.0 |
Is this a feature or a bug?
Please describe the actual behavior.
Types in generated Markdown documentation do not include links to type definitions automatically. For instance, in a class documentation, there is a column "Type" in the properties table, which in my case always only contains the plain name of the referenced type.
What is the expected behavior?
I would expect the mentioned type cells to include a link to the type definition, if applicable. From what I understand so far, this could be possible in the _createPropertyCell function (
rushstack/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
Line 805 in 589608e
getLinkFilenameForDeclarationReference(canonicalReference)
. Is this possible to implement / any ideas on this?The text was updated successfully, but these errors were encountered: