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
689 stars 172 forks source link

Superfluous newlines in table column descriptions #591

Closed chris-pieri closed 1 month ago

chris-pieri commented 2 months ago

Hello 👋,

I'm using version: 4.0.0-next.55

I am able to render a table for my interface with the following headers Property, Type, Description.

Currently any property with a Default Value gets added on a new line in the description cell. Is it possible to instead add a Default Value header in between Type and Description?

tgreyuk commented 2 months ago

Defaults values now exposed in table. Both of the following will work in 4.0.0-next.56:

prop = 'propValue'
/**
 * @defaultValue 'propValue'
 * /
prop: string
chris-pieri commented 2 months ago

Thanks for making the update it's working now!

One nit picky thing, it looks like the <br /> tags are still being added in the description cell for the rows that have a default value (tested on version 4.0.0-next.60).

Sorry, I tried uploading images but my work laptop won't allow it 🤦‍♂️.

tgreyuk commented 2 months ago

@chris-pieri Thanks. Just to confirm you mean the extra space below the description?

Screenshot 2024-05-03 at 17 25 20
chris-pieri commented 2 months ago

Yes exactly, thanks

tgreyuk commented 1 month ago

fixed in typedoc-plugin-markdown@4.0.1

chris-pieri commented 1 month ago

Thank you looks great ! Congrats on 4.0 🎉