grunt-html2md

Transform HTML files to Markdown

npm install grunt-html2md
5 downloads in the last week
8 downloads in the last month

grunt-html2md

Transform HTML files to Markdown in a Grunt task

Build Status Code Climate Dependency Status Bitdeli Badge Built with Grunt

Getting Started

This Grunt task plugin transforms the given HTML files to the Markdown format.

This plugin requires Grunt ~0.4.1 and is dependant of HTML to Markdown converter ~0.0.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-html2md --save-dev

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

grunt.loadNpmTasks('grunt-html2md');

The "html2md" task

Overview

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

grunt.initConfig({
  html2md: {
    your_target: {
      // Target-specific source file lists and/or file write options go here.
    },
  },
})

Options

Options are passed directly to grunt.file.write method.

options.encoding

Type: String Default value: 'utf8'

The file encoding used for saving the resulting Markdown files.

Usage Examples

Default Options

In this example, the default options are used, as there aren't any at the moment. All the files matching the src/*.html and legacy/*.html selectors will be used as HTML sources, which will be converted to Markdown files placed in the same folder as the given source file.

grunt.initConfig({
  html2md: {
    main: {
      options: {
        encoding: 'utf8'
      },
      src: [
        'src/*.html',
        'legacy/*.html'
      ]
    },
  },
})

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

  • 2013-12-20 v0.1.1 Linting with eslint instead of JSHint for better coverage
  • 2013-07-23 v0.1.0 Initial release

License

Copyright (c) 2013 Juga Paazmaya olavic@gmail.com

Licensed under the MIT license.

npm loves you