Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Grunt plugin to run cleaver and create slideshows
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

grunt-cleaver

Grunt plugin to run cleaver and create awesome slideshows from markdown.

Build Status Dependency Status NPM version

Update presentations, demos or walkthroughs as part of your build. Pro tip: use some other tools to dynamically generate the template before building the presentation.

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-cleaver --save-dev

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

grunt.loadNpmTasks('grunt-cleaver');

The "cleaver" task

Default Options

grunt.initConfig({
    cleaver: {
        build: {
            options: {

            },
            src: ['./test/main.md', './test/intro.md']
        }
    }
});

History

  • 0.3.0 - Updated cleaver to ~0.6.0
  • 0.2.0 - Updated cleaver to ~0.5.3
  • 0.1.0 - First release

Contributing

Contributions are very welcome, please create an Issue before doing something major.

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.

Bitdeli Badge

Something went wrong with that request. Please try again.