rachelatflatiron / vscode-reveal-slides-template

Reveal.JS Slides Template

This template repository will serve as a springboard for using markdown (mdx) to generate a RevealJS slideshow within the VS Code Text editor using the VSCode Reveal extension. You can publish the slideshow on GitHub pages by setting the publishing source to the main branch at the '/docs' directory.

The template will preconfigure the VSCode reveal extention to export the slide deck to the /docs directory so it will be published via GitHub pages.

Requirements

• Visual Studio Code is installed
• The VSCode Reveal Extension is installed and enabled

Usage:

1. Use this template repository to create a new repo for your deck
2. Clone the repository to your local machine
3. Open the repository in VSCode and edit the slides.md file
4. Click on the RevealJS icon in the Sidebar menu
5. Click on the 3rd icon (export) from the left to preview the slideshow in your browser
6. Click on the 1st icon (HTML5) from the left to export the deck to the /docs directory

Github Pages

1. Go to repo settings > Pages
2. Set branch to main > docs
3. Go back to main "code" tab...on bottom right is Environments > github-pages
4. Push to deploy