Showdown grunt plugin
Grunt plugin to convert Markdown documents into HTML using the showdown library.
This plugin requires Grunt
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-showdown --save-dev
The "showdown" task
In your project's Gruntfile, add a section named
showdown to the data object passed into
List of built-in showdown extensions in String format.
This list is directly passed to the showdown library.
List of custom showdown extensions which will be loaded as node modules and passed to the showdown converter.
In this example, the default options are used to convert markdown document with no extra showdown extension.
In this example, custom options are used to do convert markdown documents with built-in
plus a custom extension
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.
- 1.0.1 - Support cwd file option + unit tests
- 1.0.0 - Init project. Custom showdown extension support