grunt-md-process v0.0.1-beta

grunt-md-process

Overview

The main purpose of this Grunt plug-in is to provide a simple, but highly customizable and configurable HTML generator, using Markdown files as its base.

It is intended to be used as documentation tool that allows you to create HTML sites as complex as you wish: from separate, unrelated HTML files to a full-blown portal.

It uses Marked to process Markdown into HTML, Handlebars to connect the separate parts of the layout, YAML to add meta-information and Highlight.js to parse and prettify any code snippets.

Installation

Install the plug-in using:

npm install --save-dev grunt-md-process

Usage example

markdown: {
    dev: {
        options: {
            layout: {
                main: 'layout/main.handlebars'
            },
            partials: {
                header: 'partials/header.handlebars',
                sidenav: 'partials/sidenav.handlebars'
            }
        },
        files: [{
            expand: true,
            cwd: 'src/markdown/',
            src: ['**/*.md'],
            dest: 'dist/'
        }]
    }
}