Reveal.js Boilerplate

A simple and comfortable way to make a presentation

_{Made with ❤️ by w3tech & contributors}

❯ Why

Full configured reveal.js sample project with webpack and some awesome features:

Features

• Markdown & HTML Support Write your slides with the markdown or html language.
• Sass Define your styles with Sass.
• Github Deployment Run npm start deploy to deploy your builded presentation on th github pages.

❯ Table of Contents

• Getting Started
• Scripts and Tasks
• License

❯ Getting Started

Step 1: Set up the Development Environment

You need to set up your development environment before you can do anything.

Install Node.js and NPM

• on OSX use homebrew brew install node
• on Windows use chocolatey choco install nodejs

Install yarn globally

npm install yarn -g

Step 2: Serve your App

Go to the project dir and start your app with this npm script.

npm start

❯ Scripts and Tasks

All script are defined in the package-scripts.js file, but the most important ones are listed here.

Install

• Install all dependencies with yarn install

Serve

• Run npm start to serve your presentation locally

Deploy

• Run npm start deploy to deploy your presentation on the github pages.

❯ License

MIT