sindresorhus/refined-github

Add markdown syntax highlighting to GitHub comments/new issues/etc #4358

0xdevalias posted onGitHub

Currently when writing comments, new issues, etc on GitHub; there is no syntax highlighting in the various text areas. For short/simple comments/etc this is ok, but for much longer/more detailed comments (as I tend to write), and particularly when there are a lot of inline links, etc; the plain black/white text can end up all merging together and causing my eyes to glaze over.

It would be awesome if we could add some kind of markdown syntax highlighting to these areas (bonus points if it leverages existing styling/etc that already exists on GitHub to achieve it).

I haven't spent any time digging into the technicals of how this could be achieved in the simplest/most lightweight way yet.

While there is already the ability to set markdown as the code style in triple backtick code blocks, it's syntax highlighting seems rather minimal; so i'm not sure if leveraging the same styles would make any sense here (though it would be better than none at all)

eg.

## Markdown Syntax Highlighting!

It would be really great if there was markdown syntax highlighting here, as when there is a lot of text, it gets really hard to read and my eyes kind of glaze over.

[this is totally a valid link to something really long](https://github.com/sparkletown/sparkle/issues/778#often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths) and often [i might want to link to a couple](https://github.com/sparkletown/sparkle/issues/778#often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths) of different urls [in the same sentence](https://github.com/sparkletown/sparkle/issues/778#often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths) which just becomes [totally unreadable](https://github.com/sparkletown/sparkle/issues/778#often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths-often-with-really-long-url-paths)

From a quick google search, a few different potential libs/etc came up:

While these are 'real' urls, as required above, they probably aren't any more useful than the screenshots/etc provided:

I searched through the backlog issues and don't think this has been raised before, and I believe it would make sense as an addition to refined-github. While i'm pretty busy at the moment, and not deeply aware of the process for code contributions yet (haven't read the docs on it), this is a feature I would potentially be able to implement/help implement if it's likely to be desired/accepted/etc and someone can point me in the right direction.


Thank you for the detailed feature request, but due to the weight and complexity of integrating such a field with the existing editor (uploads, formatting buttons, etc) we can’t bring this into Refined GitHub. There are existing extensions for this as well

posted by fregante almost 4 years ago

@fregante Thats fair enough. Do you happen to know what existing extensions exist for it off hand?

posted by 0xdevalias almost 4 years ago

Fund this Issue

$0.00
Funded

Pull requests