search

xyproto / splash

:ocean: Syntax highlight code embedded in HTML with a splash of color. Also includes the auto-updated Chroma style gallery.
https://xyproto.github.io/splash/docs/
BSD 3-Clause "New" or "Revised" License
29 stars 4 forks source link

Add comments to the longer examples #5

Closed CactiChameleon9 closed 1 year ago

CactiChameleon9 commented 1 year ago

It would be nice if the longer examples included some form of comment (so we can see what that looks like)

xyproto commented 1 year ago

I agree. Thanks for the feature request!

CactiChameleon9 commented 1 year ago

Thanks a lot for doing this, way more useful with comments :)

Sorry to nitpick - but the new longer examples are now quite long, which may be what you were after - but it does make it a little bit harder to compare if all the example doesn't all fit on a screen at once. On the other hand, it is more realistic to have a large bit of code covering the screen

xyproto commented 1 year ago

I agree. I shortened the long example code a bit. :+1:

xyproto commented 1 year ago

I also added you as collaborator, if other syntax highlighting related features should be missing from cmd/gendoc/example/main.go. The style gallery is updated automatically when the code is pushed, just so you know.

CactiChameleon9 commented 1 year ago

Hey, thanks a bunch! I like the overall look for the longer examples page better with the slightly-shorter but long examples

I have also never been added as a collaborator on gh before - so thats new. I have accepted, but I think it looks good to me