WordPress.org

Making WordPress.org

Opened 5 years ago

Closed 4 years ago

Last modified 2 years ago

#403 closed enhancement (fixed)

Allow readme.md as well as readme.txt

Reported by: joostdevalk Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

Right now readme files always have to be .txt files. They're parsed, however, as markdown, and those of us maintaining our plugins on Github usually have a readme.md for GitHub. I think it'd make the most sense to allow plugins to have a readme.md file instead of a readme.txt file, so we don't need to maintain two.

My preference would be that if both exist, the .txt gets read, and otherwise the .md.

Would be happy to write the patch if someone points me in the right direction of where to find the source :)

Attachments (2)

class.bbpress-plugins-tracker.diff (591 bytes) - added by joostdevalk 5 years ago.
Parser patch
readme-parser-validator.diff (1.1 KB) - added by joostdevalk 5 years ago.
Validator patch

Download all attachments as: .zip

Change History (10)

#1 @dd32
5 years ago

For the most part, I believe the code is still very close to http://plugins-svn.bbpress.org/svn-browser/trunk/

@joostdevalk
5 years ago

Validator patch

#2 @joostdevalk
5 years ago

Hmm then I'm guessing it could be as easy as this.

#3 @Otto42
5 years ago

Github's flavor of markdown is very different than ours. In order for this to work, those differences would need to be outlined and handled by the parser appropriately. I don't think it'd be as easy as simply allowing a different filename.

#4 @joostdevalk
5 years ago

If I figure out the differences and write the patch you'll accept it though? And can I just patch the SVN browser indeed?

This ticket was mentioned in Slack in #meta by kraft. View the logs.


4 years ago

This ticket was mentioned in Slack in #core by lindsaymac. View the logs.


4 years ago

#7 @Otto42
4 years ago

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

This was actually added 9 months ago, in [dotorg:9654].

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.

This ticket was mentioned in Slack in #meta by clorith. View the logs.


2 years ago

Note: See TracTickets for help on using tickets.