generator-reveal

Generator-reveal

A Yeoman generator for the Awesome Reveal.js presentation framework. http://lab.hakim.se/reveal-js/#/

Note: If you have problems with livereload on Mac OSX, you can comment line 42 of the Grunfile.js file.

middleware: function (connect) {
  return [
    //lrSnippet,
    mountFolder(connect, '.')
  ];
}

For additional info, follow Issue #5.

---

Usage

Install generator-reveal:

npm install generator-reveal

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run yo reveal:

yo reveal

After all files are created you can view your slides with grunt

grunt server

Generators

Available generators:

• reveal:slide

Slide

Generates a Slide file.

Example:

yo reveal:slide "Slide Title"

Produces slides/slide-title.html:

<section>
    <h2>Slide Title</h2>

    <p>This is a new slide</p>
</section>

And the slide filename will be added to your slides/list.json file.

[
    "index.md", 
    "slide-title.html"
]

Vertical Slides

In order to add vertical slides, you can nest an array inside slides/list.json

[
    "index.md",
    [
        "vertical-html.html",
        "vertical-markdown.md"
    ],
    [
        "vertical-html-2.html",
        "vertical-markdown-2.md"
    ],
    "the-end.md"
]

Options

Markdown

Invoked with --markdown

yo reveal:slide "Slide Title" --markdown

Produces slides/slide-title.md

## Slide Title

This is a new slide

Speaker Notes

Invoked with --notes

yo reveal:slide "Slide Title" --notes

Produces slides/slide-title.html:

<section>
    <h2>Slide Title</h2>

    <p>This is a new slide</p>
    
    <aside class="notes">
        Put your speaker notes here.
        You can see them pressing 's'.
    </aside>
</section>

For markdown, just add --markdown.

License

MIT License