Preserve inline code snippets in Table of Contents links

[karlcarstensen]

What version of starlight are you using?

0.35.2

What is your idea?

Currently, inline code does not show in TOC links. TOC titles should maintain inline code snippets.

Why is this feature necessary?

It would be wonderful if this was supported for visual consistency

Do you have examples of this feature in other projects?

This feature is currently supported by Docusaurus. You can see an example of this in use on the linked page. The text docusaurus.config.js is visually consistent in the Table of Contents and also in the headings on the page.
https://docusaurus.io/docs/configuration

Participation

• I am willing to submit a pull request for this feature.

[delucis]

Thanks for the suggestion! We currently depend on Astro’s headings feature, which is plain text only.

Are there any other formatting HTML elements you’d expect to be preserved from headings? Or only <code>?

[karlcarstensen]

Great question! <code> is the highest need item right now for my current project, but in thinking about it more, I would hope that eventually all HTML Formatting Elements would be supported. I could see all of them being useful to someone, and other tools do support them.