Incorrect rendering of embedded API structure hover cards

[erickzhao]

[kaushik7kk]

Hello, @erickzhao ! I'm kinda new to Electron. Could you let me know how the hover cards are actually supposed to be rendered and if any extra input on the same will be further required?

[erickzhao]

Hi @kaushik7kk,

For example, see what the Point object is supposed to look like: https://www.electronjs.org/docs/latest/api/structures/point

For some reason, the document title is being rendered with a <header></header> portion and we apparently can't render it using the react-markdown library.

The component that we use to render this text is located here: https://github.com/electron/website/blob/main/src/components/APIStructurePreview.tsx

[erickzhao]

@kaushik7kk unfortunately it looks like I solved this one as part of a PR solving an unrelated bug. Thanks for writing in to ask about the issue, though!

[kaushik7kk]

Thanks for informing me @erickzhao . I'll catch up with the PR to get some more info on what fixed it.

[dsanders11]

Looks like one of the Docusaurus updates changed the rendering of the title there to be wrapped in a <header></header>. I believe we could fix it by adding header to this list of allowed elements, or it will be fixed once #690 is merged.

website/src/components/APIStructurePreview.tsx

Line 107 in fc2c6b5

allowedElements={['h1', 'ul', 'li', 'code', 'a', 'em']}