[wp-meta] [Making WordPress.org] #4962: Use readme.md as fallback

Making WordPress.org noreply at wordpress.org
Thu Jan 16 20:20:59 UTC 2020


#4962: Use readme.md as fallback
------------------------------+------------------------
 Reporter:  renathoc          |       Owner:  (none)
     Type:  enhancement       |      Status:  closed
 Priority:  lowest            |   Milestone:
Component:  Plugin Directory  |  Resolution:  duplicate
 Keywords:                    |
------------------------------+------------------------

Comment (by SergeyBiryukov):

 Some context from comment:7:ticket:403:
 > Note that the format for both files is identical. If the readme.md
 exists, and readme.txt does not, then the readme.md will be used.
 Additionally, the readme.md is renamed to readme.txt before the official
 ZIP is built and released to sites.
 >
 > There are no plans to support GitHub flavored markdown. For this reason,
 we continue to recommend using the name "readme.txt" and not "readme.md",
 as they are unlikely to be of the same format. Additionally, GitHub uses
 the readme.md for entirely different purposes than the plugin directory
 does.

 Re: "the `readme.md` is renamed to `readme.txt` before the official ZIP is
 built", it doesn't look like that's still the case after the Plugin
 Directory overhaul in #1584, could not find any code for that at a glance.

 We could probably add a note along the lines of the comment above (that
 `readme.md` is supported but not recommended, and `readme.txt` is
 preferred) to these pages:
 * https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-
 txt-works/
 * https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/4962#comment:4>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list