hteumeuleu / caniemail

Can I email… Support tables for HTML and CSS in emails.
https://www.caniemail.com
MIT License
798 stars 69 forks source link

Categorising features #232

Open husseinalhammad opened 2 years ago

husseinalhammad commented 2 years ago

It would be great if HTML/CSS features are categorised further to indicate whether a feature is good for accessibility/performance/etc. This is something I brought up in a discussion thread in a different project.

Examples:

Why

Categorising the features will allow us to see how each email client fares in these categories.

caniemail can at least add and maintain the categories, and a third party can make use of the JSON data.

Categories

Do these need to be pre-defined? Or can they be added arbitrarily?

"Accessibility" and "performance" are the obvious ones. What other categories can be added? Developer experience (e.g. CSS flex and grid)?

Jekyll categories

The category key is already used in _features to specify whether a feature is a CSS or a HTML feature.

Jekyll also has built-in support for tags so that's an option: https://jekyllrb.com/docs/posts/#tags-and-categories

husseinalhammad commented 2 years ago

The CONTRIBUTING.md now details which key to use and how to format multiple values:

tags: a list of tags separated by a space e.g. value1 value2 value3. A tag categorises a feature in terms of benefits such as accessibility and performance.

husseinalhammad commented 2 years ago

A tags page (https://www.caniemail.com/tags/) has been added by @hteumeuleu!

@hteumeuleu do you think it is possible to expand the clients page (https://www.caniemail.com/clients/) to list email clients support per tag?

Or is this out of scope? The data is available in JSON so it can be visualised off caniemail too.