https://github.com/w3tecch/reveal.js-boilerplate
A simple and comfortable way to make a presentation.
https://github.com/w3tecch/reveal.js-boilerplate
babel boilerplate presentation reveal-js sass webpack
Last synced: 6 months ago
JSON representation
A simple and comfortable way to make a presentation.
- Host: GitHub
- URL: https://github.com/w3tecch/reveal.js-boilerplate
- Owner: w3tecch
- Created: 2018-03-22T20:31:40.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T05:55:23.000Z (over 7 years ago)
- Last Synced: 2025-04-09T21:41:05.288Z (9 months ago)
- Topics: babel, boilerplate, presentation, reveal-js, sass, webpack
- Language: CSS
- Homepage: https://w3tecch.github.io/reveal.js-boilerplate
- Size: 14.9 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Reveal.js Boilerplate
A simple and comfortable way to make a presentation
Made with ❤️ by w3tech & contributors
## ❯ Why
Full configured [reveal.js](https://revealjs.com/) sample project with [webpack](https://webpack.js.org/) and some awesome features:
### Features
- **Markdown & HTML Support** Write your slides with the markdown or html language.
- **Sass** Define your styles with [Sass](https://sass-lang.com/).
- **Github Deployment** Run `npm start deploy` to deploy your builded presentation on th github pages.
## ❯ Table of Contents
- [Getting Started](#-getting-started)
- [Scripts and Tasks](#-scripts-and-tasks)
- [License](#-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](https://nodejs.org/en/download/)
- on OSX use [homebrew](http://brew.sh) `brew install node`
- on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
Install yarn globally
```bash
npm install yarn -g
```
### Step 2: Serve your App
Go to the project dir and start your app with this npm script.
```bash
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](/LICENSE)