Skip to content
Yeoman generator for Reveal.js
JavaScript
Find file
Pull request Compare This branch is 15 commits ahead, 207 commits behind slara:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
app
slide
test
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
package.json

README.md

Generator-reveal

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

This fork adds support for deploying Reveal.js presentations to CouchDB / Cloudant. yo reveal asks questions about where your CouchDB instance lives, and which database to use, while grunt couch deploys to that instance.

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 -g git+https://github.com/garbados/generator-reveal.git

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:

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

Something went wrong with that request. Please try again.