Thanks to visit codestin.com
Credit goes to github.com

Skip to content

rzhade3/reveal-build-system

Repository files navigation

Reveal.js Build System

This is a build system for reveal.js that helps (i) create a presentation from a set of markdown files, and (ii) makes it easy to upgrade to the latest version of reveal.js.

Usage

In order to use this build system:

  1. Clone this repository locally with submodules:
git clone --recurse-submodules
# or if you have already cloned the repository without submodules:
git submodule update --init --recursive
  1. Create a new file inside the slides directory containing the content of your slide deck

  2. Run the build script:

npm run build

This will create a dist directory and a static directory. static contains all static files from Reveal.js necessary to run your presentation. dist contains the generated HTML files for your presentation.

Commit both of these to your repository. Congratulations, you should now be able to open up files in the dist folder to view your presentation!

Options

The build system allows you to set certain options for a certain slide deck using YAML frontmatter.

The following options are available:

  • title: The title of the presentation, this appears as the title of the HTML page.
  • theme: The theme to use for the presentation, this is the name of the theme as described in the reveal.js documentation.

About

Small build system to generate Reveal.js sites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published