Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#5582 closed enhancement (wontfix)

Facilitate embedded videos in for plugin directory page

Reported by: westonruter's profile westonruter Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:


I discovered recently that supports in addition to readme.txt. This is great since for a long time I've been using a script to convert the readme.txt into a for the sake of GitHub, but then excluding it from

Now I can avoid doing this and just have the one

Nevertheless, there is one thing that doesn't port over so well, and that is video. A plugin's readme may include a video via a bare oEmbed URL or shortcode and this is shown on the directory as a video embed. In the script I used, I'd take such a bare URL (for a YouTube video) in the readme.txt to have the poster image linked to the video. This would then have something acceptable for the markdown version on GitHub (which doesn't support video embeds) while also having the actual video embed on the plugin directory page.

What I did in the script is take any instance of the following in the readme.txt:


And convert it into the following in the

[![Play video on YouTube](](

But now that I can use the as the source of truth, I'd like the opposite to be supported.

My proposal: Extend WordPressdotorg\Plugin_Directory\Markdown::transform() to support matching any instance of linked poster images (to YouTube) and automatically transform them to bare URLs for oEmbed to kick in.

So given a that contained:

[![Play video on YouTube](](

This would get transformed into:

The same would go for other oEmbed providers in addition to YouTube.

The benefit here is that the on GitHub would not need to have an unsightly bare URL and could instead have a linked video poster image. See the AMP plugin's on GitHub for example:

Change History (3)

#1 @Otto42
3 years ago

No, is supported instead of readme.txt, but the formatting for the two remains identical.

You should still use a readme.txt for, and for GitHub, because of the differences in the formatting specifications.

#2 @westonruter
3 years ago

  • Resolution set to wontfix
  • Status changed from new to closed

OK, I've opted to generate the readme.txt from the at build time, doing various transformations as needed for formatting.

#3 @Otto42
3 years ago

Yeah, right now, limited markdown is supported (in either txt or md), but it's not quite the same as GitHub's markdown all the time. If at some point we decide to separate the two and use different types of markups for them, then this would make more sense then. But that's a bit more of a comprehensive thing to do.

Note: See TracTickets for help on using tickets.