grunt-html2md

Transform HTML files to Markdown in a Grunt task

grunt-html2md

Transform HTML files to Markdown in a Grunt task

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

This plugin requires Grunt ~0.4 and handles the transformation via HTML to Markdown converter ~1.2.

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');

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 are passed to the to-markdown handler, please see https://github.com/domchristie/to-markdown for further details

Type: boolean

Default value: false

GitHub Flavoured Markdown

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: {
      src: [
        'src/*.html',
        'legacy/*.html'
      ]
    },
  },
})

Please refer to a GitHub blog post on how to create somewhat perfect pull request.

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.

Unit tests are done with Nodeunit.

npm install -g venus
  • 2015-05-05 v1.0.0 Updating dependencies and better file configuration
  • 2014-08-23 v0.1.2 Dependencies update and general code quality
  • 2013-12-20 v0.1.1 Linting with eslint instead of JSHint for better coverage
  • 2013-07-23 v0.1.0 Initial release

Copyright (c) Juga Paazmaya olavic@gmail.com

Licensed under the MIT license.