search

GoogleChrome / webdev-infra

Apache License 2.0
37 stars 28 forks source link

New aside type: Tip #62

Open sofiayem opened 1 year ago

sofiayem commented 1 year ago

I sometimes feel like there's no note type to fit the content sentiment I put in the note. I'd like to request a new type: Tip (or maybe Hint?). It's neither important, not a warning (risk), nor a caution (potential pitfall). I'd caracterize the Tip as an easier or better way of doing things than the default or common.

Additionally, let's give the regular note a topic ('note') and an icon. Otherwise it's inconsistent. Regular note is for supplemental info.

Describe the solution you'd like A new note type: {% Aside 'tip' %}. Green? Pin icon? Or maybe the "Important" type should have a pin icon, and "Tip" - a light bulb. Additionally, a topic for the regular note: {% Aside 'note' %}. Blue. Note icon.

Describe alternatives you've considered Putting such info in the general note type. Kinda dull and inconsistent (without a topic and icon).

Additional context https://developer.chrome.com/docs/handbook/components/#asides

FYI @rachelandrew

AmySteam commented 1 year ago

@sofiayem +1, I have needed this when writing tutorials before.