README markdown shows as expected on Github but incorrectly on pub.dev

dart-lang / pub-dev

The pub.dev website

https://pub.dev

BSD 3-Clause "New" or "Revised" License

784 stars 147 forks source link

README markdown shows as expected on Github but incorrectly on pub.dev #7559

Open faithoflifedev opened 7 months ago

faithoflifedev commented 7 months ago

URL: https://pub.dev/packages/google_vision

On the page for the referenced package there is a table titled New Helper Methods the table has a number of cells in the Method Signature column that are missing data. When viewing the same table for the package on Github - README the data in these cells appears correctly.

pub.dev

github.com

Should it be assumed that README files should render the same on poth github.com and pub.dev?

isoos commented 7 months ago

Should it be assumed that README files should render the same on poth github.com and pub.dev?

We don't promise 1:1 rendering, but in general we strive to get similar output. In this case, this seems to be a combination of markdown rendering and HTML sanitization: the markdown output creates an unescaped <TagLikeItem> and our HTML sanitization removes it as invalid HTML tag.

Filed: https://github.com/dart-lang/markdown/issues/596