-
Notifications
You must be signed in to change notification settings - Fork 381
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
8deee1b
Rename wp-assets directory to .wordpress-org
westonruter 9709e8f
Eliminate readme.txt in favor of updated readme.md
westonruter da64055
Add logo.svg
westonruter 2d60f29
Use uppercase convention for markdown files
westonruter 10f553c
Update references to contributing docs
westonruter c7fa6e4
Add video series and embedded video to readme
westonruter 5ba8175
Move the video up higher in the description
westonruter 83a28c8
Update verify-version-consistency for README.md
westonruter b8365e6
Rename logo.svg to icon.svg
westonruter eff0d13
Break up badge images onto separate lines
westonruter 69981df
Add missing trailing whitespace to add line break
westonruter 005b2d3
Remove extra spaces in tags
westonruter 9757dd9
Update title for engineering guide
westonruter 2f999e3
Remove unused wp-dev-lib
westonruter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Would this be embeddable on wp.org? GitHub doesn't render it appropriately:
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 transformingreadme.txt
toreadme.md
(at least in shortcode form):https://github.com/xwp/wp-dev-lib/blob/a62ccca94f9995f294e12d500c45856adff81e34/scripts/class-wordpress-readme-parser.php#L97-L99
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: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: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