grunt-markdown-it-ext
Grunt Markdown-it Extended markdown-it (markdown parser) grunt plugin
Getting Started
This is a fork from the original package.
This plugin requires Grunt ~0.4.5
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-markdown-it-ext --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "markdown-it" task
Overview
In your project's Gruntfile, add a section named markdown-it
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.separator
Type: String
Default value: ', '
A string value that is used to do something with whatever.
options.punctuation
Type: String
Default value: '.'
A string value that is used to do something else with whatever else.
options.extensions
Type: Object
Default value: null
An object requiring a markdown-it plugin. eg. require('markdown-it-emoji')
options.bootstrap
Type: boolean
Default value: false
If set true, a <link>
tag pointing to MaxCDN's bootstrap files will be added.
options.docTitle
Type: String
Default value: Readme.md
Title to be shown at the readme.html
preview.
Usage Examples
Default Options
In this example, the default options are used to generate a basic Markdown preview.
grunt;
Custom Options
In this example, custom options are used to do generate a Markdown file with a custom title, bootstrap reset and unicode emoji support.
grunt;
Contributing
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.
Release History
- 0.2.4
- Added HTML Wrap
- Added Bootstrap support
- Added Custom title support
- 0.2.0 Initial fork