search

tailwindlabs / heroicons

A set of free MIT-licensed high-quality SVG icons for UI development.
https://heroicons.com
MIT License
21.33k stars 1.28k forks source link

Add preview icon in JSDOC (react) #286

Closed fabien0102 closed 2 years ago

fabien0102 commented 3 years ago

Hi, Very nice icons library, just a little addition to improve the DX

47bf7f7b-eb4e-40ca-9a88-6ae39c5d0387

The trick is to add the svg as a base64 image inside a markdown image markup into the JSDoc. Doing this improve the searchability of every icons, since we can just see the icon in intellisense 😀

bradlc commented 2 years ago

Hey @fabien0102, this is a really neat idea, thanks for taking the time to put this together! On this occasion I think we're going to say no though, as we're reluctant to take on additional complexity in this project right now, and would prefer to keep the React/Vue packages as simple as possible. Really appreciate the suggestion though, I didn't even realise you could do that haha

fabien0102 commented 2 years ago

No problem, thanks for the feedback!