search

SassDoc / sassdoc

Release the docs!
http://sassdoc.com
MIT License
1.41k stars 56 forks source link

feature request (?): link to image #558

Open bencresty opened 3 years ago

bencresty commented 3 years ago

Hi,

First of all, just discovered SassDoc this week and I love how well it all looks! Thanks for all the hard work put into this!

One question I have is; is there a way to add a link to an image to show in the documentation? I'd like to show images of transition-graphs to a bunch of transition preset mixins, but after reading the full docs, I didn't find anything that looks like it's able to show an image into the docs. And a link is yet another click for the user, so I'd rather display an image directly on the mixins' page if possible.

So I'm looking for something like 

/// @image https://domain.org/link-to-image.jpg

Is it currently possible to do this? Or else, could you please consider adding this? It would make documentation a lot more graphical, especially because we're talking about sass here.

Thanks again for this handy tool!

pascalduez commented 3 years ago

Hi @bencresty,

you could add your own annotation and build your own theme to achieve this. I know it might sound like a lot of work, but shouldn't be, except if you want to customize everything.
I'm not against adding such annotation at that stage, but deciding on a default display that could satisfy all needs for such annotation might not be that trivial.
Leaving this issue open so we can collect interest.

bencresty commented 3 years ago

@pascalduez thanks for your reaction and hope there will be more interest. I think it would be a great addition. Keep up the great work!