search

storybookjs / storybook

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation
https://storybook.js.org
MIT License
84.4k stars 9.28k forks source link

Angular: Compodoc character issues #15591

Closed dexster closed 3 years ago

dexster commented 3 years ago

Describe the bug Certain characters are not translated correctly. See image below of a Controls description. Screenshot 2021-07-14 at 23 10 00

This issue above is caused by an apostrophe in the jsdoc comment

This is because Compodoc does some parsing of the jsdoc when generating the description property. It also adds HTML tags to this description property

Compodoc 1.1.14 has a new property called rawdescription which does not encode characters or add HTML tags. The difference looks like this

Screenshot 2021-07-14 at 23 21 00

I propose we move from using the description property to the rawdescription property. I can make the change if you're happy to go ahead with this?

dexster commented 3 years ago

@shilman Is there someone who could give some feedback on this?

shilman commented 3 years ago

Thanks for the nudge @dexster -- sorry I missed this first time around.

That change sounds reasonable to me, and I think I wrote the original buggy code 😉

shilman commented 3 years ago

Zoinks!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.4.0-alpha.25 containing PR #15774 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb upgrade --prerelease