-
Notifications
You must be signed in to change notification settings - Fork 385
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Eliminate readme.txt in favor of just README.md #5807
Conversation
Plugin builds for 2f999e3 are ready 🛎️!
|
Ideally we'd rename |
And this works! I tested it on another plugin: https://johnblackbourn.com/readme-md-plugin-on-wordpress-org/#comment-43918 |
fc6554e
to
e7a08ad
Compare
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed in 2f999e3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will require updating the Engineering Guidelines wiki page as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
[![Play video on YouTube](https://i1.ytimg.com/vi/s52JNMT59s8/hqdefault.jpg)](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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds like a great idea!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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-assets
to.wordpress-org
.readme.txt
in favor ofREADME.md
.README.md
to have the required format for the WordPress Plugin Directory.logo.svg
to go alongside the rasterized PNG logos.CONTRIBUTING.md
instead ofcontributing.md
).