typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
714 stars 176 forks source link

Option to suppress "Defined in" fields #400

Closed jpeterstewart closed 1 year ago

jpeterstewart commented 1 year ago

When a Docusaurus site holds documentation for multiple software components -- and the TypeScript files are imported from another project into a subfolder -- the "Defined in" field is not very useful. For one thing, the reader may not have access to the repository.

But the more serious problem is that the link goes to the Docusaurus project as a whole, not the project that the TypeScript files belong to! And since nearly every object on the website ends up with the same class, it's not easily fixed in CSS.

It would be really great if there was an option to suppress the "Defined in" fields!

tgreyuk commented 1 year ago

hello - you can use disableSources: true . Its a TypeDoc core option https://typedoc.org/guides/options/#disablesources

jpeterstewart commented 1 year ago

Great, thanks!