reveal.js README

The project's README from github.com/hakimel/reveal.js. As one markdown file: README.md.

reveal.js

Slides

reveal.js is an open source HTML presentation framework. It enables anyone with a web browser to create beautiful presentations for free. Check out the live demo at revealjs.com.

The framework comes with a powerful feature set including nested slides, Markdown support, Auto-Animate, PDF export, speaker notes, LaTeX typesetting, syntax highlighted code and an extensive API.


Want to create reveal.js presentation in a graphical editor? Try https://slides.com. It's made by the same people behind reveal.js.


Getting started


MIT licensed | Copyright ยฉ 2011-2026 Hakim El Hattab, https://hakim.se

reveal.js (hakimel/reveal.js)

Searching Databaseโ€ฆ

72.4K ยทGitHub
What is this?reveal.js is an open source HTML presentation framework that lets anyone with a web browser build slide decks instead of using PowerPoint or Keynote.
Is this a desktop app or a web framework I build slides with?It is a JavaScript/HTML library: you write your slides as HTML or Markdown and the framework renders them as an interactive presentation in the browser.
How do I get a presentation running?Clone or download the repo, run the dev server via npm (`npm run start`, which runs Vite), and edit the included index.html to write your slides.
Do I need a build tool to use it?The project uses Vite and TypeScript for building from source, but you can also just drop the compiled reveal.js files into a static HTML page without any build step.
Do I need a graphical editor, or is it all code?No, you write slides directly in HTML or Markdown; a hosted graphical editor exists separately if you prefer not to code your deck.
Where can I present with it?Anywhere there's a modern web browser, since the whole deck is just HTML/CSS/JS that can also be exported to PDF.
Can slides be written in Markdown instead of HTML?Yes, Markdown support is built in, so you can author slides in plain Markdown instead of hand-writing HTML.
What is Auto-Animate?It is a feature listed among the built-in capabilities that automatically animates matching elements between consecutive slides for smooth transitions.
Can I show math formulas in slides?Yes, LaTeX typesetting is included out of the box for rendering mathematical notation.
Does it support speaker notes?Yes, speaker notes are a built-in feature, letting presenters keep a separate notes view while presenting.
Creator
hakimel
Size
34.8 MB
Stars
72.4K
Age
15y
Commits ยท 90 Days