grunt-wp-readme-to-markdown

Converts WP readme.txt file to markdown (readme.md)

grunt-wp-readme-to-markdown

Converts WordPress readme.txt file to markdown (readme.md)

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-wp-readme-to-markdown --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wp-readme-to-markdown');

In your project's Gruntfile, add a section named wp_readme_to_markdown to the data object passed into grunt.initConfig().

grunt.initConfig({
  wp_readme_to_markdown: {
    your_target: {
      // Target-specific file lists go here. 
    },
  },
})

Type: String Default value: http://ps.w.org/{plugin}/assets/{screenshot}.png

The url used for the screenshot images. {plugin} is replaced by the plug-in name (as determined by the readme) and {screenshot} is replaced by screenshot-X where X is a number indexing the screenshots (starting from 1).

WordPress readme.txt should live in the root of your plug-in, so typical usage would be to set the source as readme.txt and the destination as readme.md.

grunt.initConfig({
  wp_readme_to_markdown: {
    your_target: {
        files: {
          'readme.md': 'readme.txt'
        },
    },
  },
})

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

  • Changed the default value of the screen short URL
  • Fix for the fact lines with colons are being parsed as if they were readme tags. Fixes #3. ). Thanks to @marcochiesi.

Add support for code blocks in WordPress readme (with caveat, see #7. )

Add screenshot_url option

Handle new lines in a "OS-agnostic" way. Fixes #4. Added unit tests Linted code

Fix bug where plug-in name has multiple spaces: replace all spaces with hypens.

Fixes bug where screenshots section is missing

Don't capture new lines when wrapping in asterisks.

Fixes bug with semicolon present in lists.

Ensure contributors, donate link, etc have their own line.

Initial release