grunt-gitdown

Run gitdown using grunt

Getting Started

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

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

grunt.loadNpmTasks('grunt-gitdown');

The "gitdown" task

Overview

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

grunt.initConfig({
  gitdown: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

See gitdown's documentation.

Usage Example

grunt.initConfig({
  gitdown: {
    files: {
      'README.md': '.gitdown/README.md'
    }
  }
})

Contributing

Follow the style guide.

Add unit tests for any new or changed functionality.

Submit a pull request.