Grunt task that generates Shower presentations from Markdown source.
npm install grunt-shower-markdowngrunt-shower-markdown:
npm install grunt-shower-markdown --save-dev
`
Add somewhere in your Gruntfile.js:
`javascript
grunt.loadNpmTasks('grunt-shower-markdown');
`
Add a section named shower into your Gruntfile.js file. See Parameters section below for details.
Parameters
$3
Title of presentation (used in tag).
$3
Path of source Markdown file.
$3
Path of result HTML file.
$3
Language of presentation.
$3
Path where theme of presentation is located.
$3
List of CSS files specific to your presentation.
$3
List of JavaScript files specific to your presentation.
$3
Hides progress bar when false.
$3
Any HTML to put before .
Config Example
` Some HTML javascript
`
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 markup
# Presentation Title
Author and any other content to show above slides.
!SLIDE #SlideID class1 class2
## Slide Title
!Image
- List item one
-? Two (delayed)
-? Three (delayed)
!SLIDE #Cover shoot
## Hello world!
!SLIDE
## Code example
`
@@concat@@: {
main: {
text: @@@'Hello world'@@@
}
}
?
Markdown extensions
grunt-shower-markdown uses GitHub flavored Markdown with some extenstions.
$3
If you want to delay display of list items, put after list marker:
`
`
- One
-? Two (delayed)
-? Three (delayed)
@@text@@
$3
You can highlight important parts of presentation using (important) and @@@text@@@ (very important):
`
`
@@concat@@: {
main: {
text: @@@'Hello world'@@@
}
}
License.md` file.
Release History
$3
* Grunt 0.4 support.
---
License
The MIT License, see the included