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 (
|
private _createPropertyTypeCell(apiItem: ApiItem): DocTableCell { |
). Maybe loop over the excerpt's tokens and create a link to the type from the canonicalReferences. However, this would require something like
getLinkFilenameForDeclarationReference(canonicalReference). Is this possible to implement / any ideas on this?
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?