grunt-shower-markdown

Grunt task that generates Shower presentations from Markdown source.

Grunt task that generates Shower presentations from Markdown source

This plugin requires Grunt 0.4.

Install grunt-shower-markdown:

npm install grunt-shower-markdown --save-dev

Add somewhere in your Gruntfile.js:

grunt.loadNpmTasks('grunt-shower-markdown');

Add a section named shower into your Gruntfile.js file. See Parameters section below for details.

Title of presentation (used in <title> tag).

Path of source Markdown file.

Path of result HTML file.

Language of presentation.

Path where theme of presentation is located.

List of CSS files specific to your presentation.

List of JavaScript files specific to your presentation.

Hides progress bar when false.

Any HTML to put before </body>.

module.exports = function(grunt) {
    grunt.initConfig({
        shower: {
            index: {
                title: 'Test presentation',
                src: 'src/index.md',
                styles: 'src/styles.css'
                scripts: [
                    'libs/highlight.js',
                    'src/scripts.js'
                ]
            }
        },
        watch: {
            shower: {
                files: 'src/*',
                tasks: 'shower'
            }
        }
    });
    
    grunt.loadNpmTasks('grunt-shower-markdown');
    
    grunt.registerTask('default', 'shower');
};      
# Presentation Title
        
[Author](http://sapegin.me) and any other content to show above slides.

!SLIDE #SlideID class1 class2

## Slide Title

![Image](pictures/pic.png)

<p class="note">Some HTML</p>

- List item one
-? Two (delayed)
-? Three (delayed)

!SLIDE #Cover shoot

## Hello world!

!SLIDE

## Code example

```
@@concat@@: {
    main: {
        text: @@@'Hello world'@@@
    }
}
```

grunt-shower-markdown uses GitHub flavored Markdown with some extenstions.

If you want to delay display of list items, put ? after list marker:

- One
-? Two (delayed)
-? Three (delayed)

You can highlight important parts of presentation using @@text@@ (important) and @@@text@@@ (very important):

@@concat@@: {
    main: {
        text: @@@'Hello world'@@@
    }
}
  • Grunt 0.4 support.

The MIT License, see the included License.md file.