Lemon's Talk Template

A reveal.js presentation template with Pug, Sass, and modern build tools. This template is designed to help you quickly create and customize your own reveal.js presentations using Pug for templating and Sass for styling

Prerequisites

You'll need Node.js (v18 or higher) and npm installed.

Getting Started

1. Click Use This Template to use this repo as a project template.
2. Clone your new repository locally
3. Run npm install to install dependencies
4. Run npm run setup to configure your project name and details
5. Run npm run update:reveal to copy reveal.js files
6. Run npm run dev to start the development server

Commands

• npm run dev - Start development server with live reload
• npm run build - Build all files for production
• npm run update:reveal - Update reveal.js files from node_modules to reveal/ folder
• npm test - Check for Sass errors

How do I edit the deck?

• Edit the pug/index.pug file to modify your slides. You can use Pug syntax to create sections, add content, and include mixins.
  • Strongly Recommended: Split your slides into multiple partials in the pug/partials/ directory and include them in index.pug for better organization.
  • Check out pug/partials/_mixins.pug for useful mixins like demo and iframe.
• Edit the global styles by editing scss/lemon.scss. You can add your own styles or override existing ones.
• Need help with demos? See demos/demos.md
• Edit js/reveal-config.js to customize reveal.js settings like transitions, controls, and plugins.
• Need additional reveal.js help? Check out the reveal.js documentation.

Updating reveal.js

When you want to update to the latest version of reveal.js:

1. Update the reveal.js dependency: npm update reveal.js
2. Copy the new files: npm run update:reveal
3. Commit the updated reveal/ folder to git