Convert HTML files to Markdown
__ /\ \__ __ _ __ __ __ ___\ \ ,_\ /'_ `\/\`'__\/\ \/\ \ /' _ `\ \ \/ /\ \L\ \ \ \/ \ \ \_\ \/\ \/\ \ \ \_ \ \____ \ \_\ \ \____/\ \_\ \_\ \__\ \/___L\ \/_/ \/___/ \/_/\/_/\/__/ /\____/ \_/__/ __ __ ___ __ /\ \ /\ \__ /\_ \ /\ \ \ \ \___\ \ ,_\ ___ ___\//\ \ ___ ___ \_\ \ \ \ _ `\ \ \/ /' __` __`\\ \ \ /' __` __`\ /'_` \ \ \ \ \ \ \ \_/\ \/\ \/\ \\_\ \_ __/\ \/\ \/\ \/\ \L\ \ \ \_\ \_\ \__\ \_\ \_\ \_\\____\\_\ \_\ \_\ \_\ \___,_\ \/_/\/_/\/__/\/_/\/_/\/_//____//_/\/_/\/_/\/_/\/__,_ /
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-html-md --save-dev
Run this task with the
grunt md command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Parse all links and images with absolute URLS.
file:// + current working directory
Resolve all relative links and images from this URL. This option is only applicable when the
absolute option is enabled.
Generate links using the inline style. For exampe;
Create Markdown files with the long file extension (i.e.
md:convert:src: 'path/to/*.html'options:output: 'path/to/dest'convertBase:src:'path/to/source.html''path/to/more/*.html'options:base: ''output: 'path/to/dest'absolute: true
output option is specified then the Markdown file will be created in the same directory as
the source file.
A lot of care has been put in to ensure html.md runs well on Windows. Unfortunately, one of the
dependencies of the jsdom library, which we depend on to emulate a DOM within the node.js
environment, does not build well on Windows systems since it's built using "native modules" that
are compiled during installation. Contextify, the inherited dependency in question, is used to
<script> contents safely in a sandbox environment and is required to properly parse DOM
objects into valid Markdown.
Fortunately, the author has documented some techniques to get it building on your Windows system in a Windows installation guide.
If you have any problems with this plugin or would like to see the changes currently in development you can do so here;
Take a look at code in
tasks/md.js to get a better understanding of what is going on.
If that doesn't help, feel free to follow me on Twitter, @neocotic.