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. 😉
Cool. Is it pulling information straight from a text file and then formatting it? Or is it stored elsewhere?
Hi Alex,
Would be great to know how you do this? Any tips/tutorials ?
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. 🙂
Hey Alex King,
Great help for us, thanx.