search

web-platform-dx / web-features

Exploring how to present Web platform features adoptability
Apache License 2.0
307 stars 51 forks source link

Support Markdown in name to produce text+HTML names #930

Open foolip opened 2 months ago

foolip commented 2 months ago

https://github.com/web-platform-dx/web-features/pull/935 shows what this would look like.

foolip commented 2 months ago

I have some doubts about this.

Would consumers really want to show a mix of prose and code?

There are cases where it's not obvious what the best use of <code> is:

foolip commented 2 months ago

There's a bunch of good discussion in https://github.com/web-platform-dx/web-features/pull/935, which I've now abandoned.

The most important thing is that nobody seems to really want <code> in feature names, but @captainbrosset would like a field with the name escaped as HTML.

captainbrosset commented 2 months ago

but @captainbrosset would like a field with the name escaped as HTML.

Yes, I think it'd be good if consumers (including myself) had access to a name that's safe to put in HTML without having to worry about it.

foolip commented 2 months ago

Providing that would be easy, and given the lack of interest (including my own) for marking up names with <code> I guess we can simply call it name_html and revisit later if we want more variants.