npm install -g generator-reveal
Make a new directory, and
cd into it:
mkdir my-new-project && cd $_
yo reveal and start building your presentation.
After all files are created you can view your slides with
Then, create further slides with
yo reveal:slide more-content. See below for available options. When you want to export your presentation to some static HTML server, you can type
grunt dist to have all your relevant files saved to the
Generates a Slide file.
yo reveal:slide "Slide Title"
Slide TitleThis is a new slide
And the slide filename will be added to your
In order to add vertical slides, you can nest an array inside
Sometimes you just want a slide with a background image. That's okay, a slide object does not need a filename.
yo reveal:slide "Slide Title" --markdown
## Slide TitleThis is a new slide
yo reveal:slide "Slide Title" --attributes
adds a slide
Object with an
attr key to your
slides/list.json file. Attributes will be passed to
section element containing the slide.
yo reveal:slide "Slide Title" --notes
Slide TitleThis is a new slidePut your speaker notes here.You can see them pressing 's'.
All three options maybe combined, e.g.
yo reveal:slide "Markdown Slide With Notes And Section-Attributes" --notes --attributes --markdown
If your presentation requires specific resources that you would like included
with your project, place them in the resources directory. These assets will be
included in the distribution and available for access at the path
With the help of Grunt Build Control,
generator-reveal can deploy your presentation to Github Pages easily. All you have to do is
If everything goes right,
grunt deploy will build and push your presentation to a gh-pages git branch. Just give it a couple of minutes, fire up a browser and go to http://username.github.io/repositoryname to see your brand new presentation.
To change the options of the whole presentation, such as the theme used,
transition effect etc. consult the
An important difference, though, is that you should not edit the
file directly as it gets overwritten as you add presentation content
whenever a new grunt build is triggered.
You should instead edit the
templates/_index.html file, which is used as a
template for the automatically generated
The generated presentation app includes the Highlight.js Syntax Themes as a dependency, allowing you to change the syntax theme.
The available syntax themes can be found in the
bower_components/highlightjs/styles folder. Selecting a new syntax theme can be done by changing the stylesheet reference in the
<!-- For syntax highlighting -->