Transform HTML files to Markdown in a Grunt task
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.eslintrc.json
.gitignore
.travis.yml
Gruntfile.js
ISSUE_TEMPLATE.md
LICENSE
README.md
package.json

README.md

grunt-html2md

Transform HTML files to Markdown in a Grunt task

Build Status Code Climate Dependency Status Built with Grunt Analytics

Getting Started

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

This plugin requires Grunt ~1.0 and Node.js version to be minimum of 6.9.5, which is the Long Term Support (LTS) version, and handles the transformation via HTML to Markdown converter ~3.0.

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

options.gfm

Type: boolean

Default value: false

GitHub Flavoured Markdown

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

Contributing

"A Beginner's Guide to Open Source: The Best Advice for Making your First Contribution".

Also there is a blog post about "45 Github Issues Dos and Don’ts".

Linting is done with ESLint and can be executed with npm run lint. There should be no errors appearing after any JavaScript file changes.

Testing

Unit tests are done with Nodeunit.

npm install
npm run lint
npm test

Version history

  • v2.0.0 (2017-07)
    • Minimum Node.js version lifted from 4.2.0 to 6.9.5
    • main property in package.json was pointing to a wrong file
  • v1.2.0 (2016-08-11)
    • Updating dependencies. Have you noticed it is now Grunt.js v1.0.0?
    • Use ESLint directly without the Grunt.js plugin
  • v1.1.0 (2016-02-15)
    • Updating dependencies
    • Minimum Node.js version supported is 4.2.0 (LTS)
  • v1.0.0 (2015-05-05)
    • Updating dependencies and better file configuration
  • v0.1.2 (2014-08-23)
    • Dependencies update and general code quality
  • v0.1.1 (2013-12-20)
    • Linting with eslint instead of JSHint for better coverage
  • v0.1.0 (2013-07-23)
    • Initial release

License

Copyright (c) Juga Paazmaya paazmaya@yahoo.com

Licensed under the MIT license.