Making WordPress.org

Opened 7 years ago

Last modified 18 months ago

#3164 new enhancement

Plugin Readme Standard > Update Markdown formatting

Reported by: barryhughes's profile barry.hughes Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

The WordPress Plugin Readme Standard implies that readmes follow the Markdown rules detailed here (Daring Fireball).

However, that doesn't seem to be so (indented code blocks aren't respected, as an example). In #2655 (comment 2), though, it mentions that Markdown Extra is the library that is actually used.

If that's correct, can we swap out the Daring Fireball reference for the Markdown Extra one?

Change History (3)

#1 @SergeyBiryukov
7 years ago

  • Component changed from General to Plugin Directory

#2 @joostdevalk
7 years ago

This probably explains the issue in #2931 too.

#3 @zodiac1978
18 months ago

Updated link to readme.txt: https://wordpress.org/plugins/readme.txt

Still linking to https://daringfireball.net/projects/markdown/syntax

And as https://meta.trac.wordpress.org/ticket/2655 is still marked as maybelater we could add a note to the FAQ section that backticks are not possible here (or even better we finally fix this issue)

Note: See TracTickets for help on using tickets.