Eliminate readme.txt in favor of just README.md #5807
Conversation
|
Plugin builds for 2f999e3 are ready 🛎️!
|
|
Ideally we'd rename |
westonruter
changed the title
And this works! I tested it on another plugin: https://johnblackbourn.com/readme-md-plugin-on-wordpress-org/#comment-43918 |
westonruter
force-pushed
the
eliminate/readme.txt
branch
from
fc6554e
to
e7a08ad
Compare
westonruter
force-pushed
the
eliminate/readme.txt
branch
from
e7a08ad
to
5ba8175
Compare
.dev-lib
Outdated
|
|
||
| README_MD_TITLE="AMP Plugin for WordPress" | ||
| ASSETS_DIR=wp-assets | ||
| # This is used by wp-dev-lib/scripts/check-diff.sh but the functionality is no longer used, so it could be removed. |
There was a problem hiding this comment.
This file could now be removed, along with the xwp/wp-dev-lib dependency since it's not being used anywhere else.
There was a problem hiding this comment.
This will require updating the Engineering Guidelines wiki page as well.
There was a problem hiding this comment.
|
|
||
| This official plugin from the AMP project enables AMP content publishing with WordPress in a way that is fully and seamlessly integrated with the standard mechanisms of the platform. | ||
|
|
||
| https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb |
There was a problem hiding this comment.
Would this be embeddable on wp.org? GitHub doesn't render it appropriately:
There was a problem hiding this comment.
Yes, see https://make.wordpress.org/core/2010/02/20/plugins-can-now-include-videos-in-their-readme-txt-files/
It previews as expected on https://wpreadme.com/
I've added videos like that before in readmes. Actually, wp-dev-lib supports that in transforming readme.txt to readme.md (at least in shortcode form):
It's unfortunate that the bare URL in the README.md here would not be rendered on GitHub, but it seems like an acceptable tradeoff.
There was a problem hiding this comment.
We could could contribute up to the WordPressdotorg\Plugin_Directory\Markdown class the ability to transform something more markdown-friendly into the bare URL that would be the YouTube embed.
For example, let's say that the README.md had this line:
[](https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb)This would be rendered on GitHub as:
But then the Markdown class could transform any such YouTube-linked images to unwrap top the bare URL:
https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb
Then on WordPress.org the oEmbed would render, whereas on GitHub there would be a poster image linked to the video on YouTube.
There was a problem hiding this comment.
That sounds like a great idea!
There was a problem hiding this comment.
Filed a ticket requesting this: https://meta.trac.wordpress.org/ticket/5582
Co-authored-by: Pierre Gordon <[email protected]>
Co-authored-by: Pierre Gordon <[email protected]>
Co-authored-by: Pierre Gordon <[email protected]>
Fixes #5791
wp-assetsto.wordpress-org.readme.txtin favor ofREADME.md.README.mdto have the required format for the WordPress Plugin Directory.logo.svgto go alongside the rasterized PNG logos.CONTRIBUTING.mdinstead ofcontributing.md).