WordPress.org

Making WordPress.org

Changeset 3444


Ignore:
Timestamp:
06/18/2016 03:59:45 PM (3 years ago)
Author:
samuelsidler
Message:

Plugin Directory Readme: Let's recommend Markdown for our format, since it works.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/readme.txt

    r3443 r3444  
    1 === Plugin Name ===
     1# Plugin Name
    22Contributors: (this should be a list of wordpress.org userid's)
    33Donate link: http://example.com/
     
    1010Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
    1111
    12 == Description ==
     12## Description
    1313
    1414This is the long description.  No limit, and you can use Markdown (as well as in the following sections).
     
    3737you put the stable version, in order to eliminate any doubt.
    3838
    39 == Frequently Asked Questions ==
     39## Frequently Asked Questions
    4040
    41 = A question that someone might have =
     41### A question that someone might have
    4242
    4343An answer to that question.
    4444
    45 = What about foo bar? =
     45### What about foo bar?
    4646
    4747Answer to foo bar dilemma.
    4848
    49 == Screenshots ==
     49## Screenshots
    5050
    51511. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
     
    55552. This is the second screen shot
    5656
    57 == Changelog ==
     57## Changelog
    5858
    59 = 1.0 =
     59### 1.0
    6060* A change since the previous version.
    6161* Another change.
    6262
    63 = 0.5 =
     63### 0.5
    6464* List versions from most recent at top to oldest at bottom.
    6565
    66 == Upgrade Notice ==
     66## Upgrade Notice
    6767
    68 = 1.0 =
     68### 1.0
    6969Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.
    7070
    71 = 0.5 =
     71### 0.5
    7272This version fixes a security related bug.  Upgrade immediately.
    7373
    74 == A brief Markdown Example ==
     74## A brief Markdown Example
    7575
    7676Ordered list:
Note: See TracChangeset for help on using the changeset viewer.