isaacs / github

Just a place to track issues and feature requests that I have for github
2.21k stars 129 forks source link

Support asciinema casts #1221

Open waldyrious opened 6 years ago

waldyrious commented 6 years ago

In addition to supporting rich text rendering of various markup formats, listed here, GitHub currently also supports rich rendering of a bunch of binary files, such as images, STL files, PDF files, etc., as described here.

A recurring (and IMO growing) pattern on GitHub is projects using animated GIFs in README files and other documentation to illustrate installation or usage workflows. When these animations are of code editing, command-line interaction, or similar tasks, a nicer alternative would be to use asciinema casts. However, these are not rendered inline, which makes their use quite cumbersome.

Please add support for embedding of live asciinema casts in rich-text renderings of document files (markdown, etc.), or alternatively, rendering them as stand-alone files.

Mottie commented 6 years ago

Did you contact GitHub about this request? You may also want to open an issue in https://github.com/github/markup/ to start a discussion.

waldyrious commented 6 years ago

Did you contact GitHub about this request?

No, I haven't. I just wanted to put this out so that there'd be a public place for tracking this feature, which a direct contact wouldn't provide.

As for github/markup, I did look at that repo, but it seems to be related to the rich text rendering of lightweight markup languages, rather than to the rich embedding of non-textual content.