search

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
725 stars 177 forks source link

Is there an option to hide type reference links in table mode? #709

Closed vasco-cruz closed 3 weeks ago

vasco-cruz commented 1 month ago

What package is your question related to?

typedoc-plugin-markdown

What would you like to ask?

Hello, I'm a newer of Typedoc and Typedoc markdown.

I want to generate the documentation in table mode, but without links in the types, similar to how it appears in list mode. Is there a parameter for this?

List mode: image

Table mode: image

Thanks

tgreyuk commented 3 weeks ago

Currently if a reference type is resolved in the documentation a link will be created to it in a table and this can't currently be configured. The list mode in your example is a bit different as this has been configured with useCodeBlock which puts the entire declaration in a code block.

I am not sure there is a strong use case to introduce a new option to handle this specific behaviour.

vasco-cruz commented 3 weeks ago

Thank you very much for the information.

As a temporary solution, I found this workaround:

find ./typedoc/ -type f -exec sed -i 's/\[\(`.*`\)\](.*)/\1/g' {} \;

After generating the documentation, I remove all the links and leave only the type name.