vuejs/docs

Header `\*` markers showing up in render

jgaehring opened this issue ยท 3 comments

I don't think these are meant to appear in the final rendering of the docs pages, but the \* and \*\* markers used to denote composition and option APIs are showing up in the subject headings in some places. I went on a wild goose chase looking for the footnotes but finally realized it was how the headerMdPlugin "differentiate between Options-API-only and Composition-API-only sections" and so probably a bug. ๐Ÿ˜… It looks like whatever changes effect this were pushed to production somewhere between Apr 15 and Apr 24. I don't know if that means there might be other issues, like displaying the wrong content. I poked around in the commit history to see if there was something obvious. Maybe #2792, which touches headerMdPlugin, or a177175, which reverts it, but they were both merged on Apr 8 so that seems too early. 0beaed8, which "bumps vitepress from 1.1.0 to 1.1.3" a la dependabot #2808, seems more likely, since it was merged Apr 19 and headerMdPlugin depends on Vitepress's custom header anchors extension. But that's where I gave up.

Sorry if this is totally unhelpful and those asterisks are meant to be there!

@brc-dd I believe you have better context here than me, would you mind checking?

caused by vuejs/vitepress@469ff38...7ed5148. I'll see if we can do something in vitepress ๐Ÿ‘€

Wow, that was fast! ๐Ÿƒ โฑ๏ธ ๐Ÿ™Œ