Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Grunt plugin to convert markdown with code snippets into html

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

grunt-markx

Grunt plugin for converting markdown and code into html

Getting Started

This plugin requires Grunt ~0.4.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-markx --save-dev

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

grunt.loadNpmTasks('grunt-markx');

The "markx" task

Overview

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

grunt.initConfig({
    markx: {
        input: {
            options: {
                template: 'example/layout.html',
                data: {
                    pageTitle: 'this is the page title'
                }
            },
            files: {
                'example/output.html': 'example/input.md'
            }
        }
    },
})

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

(Nothing yet)

Something went wrong with that request. Please try again.