github / markup

Determines which markup library to use to render a content file (e.g. README) on GitHub
MIT License
5.86k stars 3.39k forks source link

Allow rendering HTML code blocks. #1812

Open RokeJulianLockhart opened 4 months ago

RokeJulianLockhart commented 4 months ago

When a preformatted block (a <pre> or ```) is intelligently considered to contain HTML, or (especially) when a fenced code block explicitly states that it contains HTML, like ```HTML, its content should render if it does not contain disallowed content (per https://github.com/gjtorikian/html-pipeline/blob/11cec3d43cab9f6beddd95bda40ad6ac654fe2f8/lib/html/pipeline/sanitization_filter.rb#L44-L95 ^1). If it contains disallowed code, ideally that code should be (with a notification) merely not executed. However, I would understand if the option to render were disallowed too, if that were too difficult to implement for a reason unbeknownst to me.

I want this because I frequently want to cite a section of a static website in issues so that I and the viewer don't have to view a limited-resolution screenshot. I can already include a code block containing HTML, but a viewer of the issue must manually duplicate it to a local file and execute it, which isn't safe for them, and is a nuisance for us both.

Precedent exists for this in how Mermaid content already is, as https://github.com/github/docs/blob/f8992bc56c56b19e26af839b8fd427824cc99473/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md#creating-mermaid-diagrams explains.

github-actions[bot] commented 2 months ago

Stale issue message

RokeJulianLockhart commented 2 months ago

https://github.com/github/markup/issues/1812#issuecomment-2283802410

@GitHub-Actions, https://github.com/github/markup/issues/1811#issuecomment-2283818005

github-actions[bot] commented 3 weeks ago

Stale issue message

RokeJulianLockhart commented 3 weeks ago

https://github.com/github/markup/issues/1812#issuecomment-2408953687

https://github.com/github/markup/issues/1811#issuecomment-2283818005