Formatted READMEs

Posted in: WordPress, alexking.org

I’ve set up the README files for my WordPress plugins so they are formatted nicely now instead of the plain text representation that was there before.

For the curious, before and after.

In addition, the README links for each plugin on the plugins page will now show the README for the latest official release, even if I forget to update the link. :)

Hopefully better presentation will prompt folks to actually read the README when they have a problem; but I may be dreaming here. ;)

Popularity: 5% [?]

Posted January 3rd, 2007 @ 6:01 PM

4 Replies

  1. Dean adds this Comment:

    Cool. Is it pulling information straight from a text file and then formatting it? Or is it stored elsewhere?

    January 3rd, 2007 at 7:11 pm

  2. Ajay adds this Comment:

    Hi Alex,

    Would be great to know how you do this? Any tips/tutorials ?

    January 3rd, 2007 at 8:27 pm

  3. Alex adds this Comment:

    It works something like this:

    1. pull the README from svn.wp-plugins.org/plugin/trunk
    2. get the latest stable tag
    3. pull the README from the latest stable tag
    4. format and output

    I implemented this as a theme page rather than a plugin. Since my theme doesn’t work like a “normal” theme, it’s pretty much useless to anyone else.

    According to Mark Jaquith, who has made the official README validator (which also formats) code available here:

    http://svn.flatearth[...]ttic-readme/

    I am at least the 5th person to write code for this; following Matt, Mike Adams (whose version was adapted by Mark) and Owen Winkler. Unfortunately, I gave up and wrote my own mere days before the official validator was available (I wasn’t even smart enough use a real markdown script). Oh well. :)

    January 3rd, 2007 at 8:45 pm

  4. Neha adds this Comment:

    Hey Alex King,

    Great help for us, thanx.

    January 5th, 2007 at 12:53 am

Add a Comment

Please note: Use of a non-personal web site or blog in the field below and/or comments that are off-topic, personal attacks, or support requests will likely be removed at my discretion.

Note: This post is over a year and a half old. You may want to check later in this blog to see if there is new information relevant to your comment.

~stevenf: Wherein I Predict the Future » « DNS Change

About This Site

This is the personal web site of Alex King, an independent developer based in Denver, Colorado USA. More...


Crowd Favorite

Crowd Favorite is my software and web development business.

We build web applications, design and develop custom WordPress themes and plugins, and build custom sites using WordPress as a CMS.


I also have a tumblog that aggregates my online content from other services (Twitter, Flickr, del.icio.us. etc.).

Ads