Skip to content
Get packs

Guide · Open source

How to use reveal.js: install, write slides and present

Updated · written with AI from the project's own documentation and checked against our catalogue data

reveal.js is an open source HTML presentation framework, licensed under MIT. You write each slide as part of a web page, and the finished deck runs in any browser, so you can present or share it without dedicated presentation software. This guide covers what it is, how to get the source, and the features the README highlights so you can start building slides.

reveal.jshakimel/reveal.js · ★ 72.5k · MIT

Quick start

  1. 1Clone the repository. Run git clone https://github.com/hakimel/reveal.js in your terminal to download the source.
  2. 2Read the installation guide. Open revealjs.com/installation and follow the build steps for the project.
  3. 3Review the demo. Look at revealjs.com/demo to see how a finished presentation is structured.
  4. 4Learn the markup. Use the documentation at revealjs.com/markup to write your slides.
  5. 5Add features as needed. Use Markdown slides, speaker notes, LaTeX math or code highlighting from the feature pages.
  6. 6Export or share. Use PDF export or share the HTML deck, which runs in any browser.

What reveal.js is and who it suits

reveal.js lets anyone with a web browser create presentations for free. Because slides are web pages, they can be styled with HTML, CSS and JavaScript and kept in version control like other project files.

It fits developers who already work with web technologies and want full control over design. It is less suited to people who want a drag-and-drop editor; the README points to Slides.com, a separate graphical editor by the same authors, for that.

  • Good fit: developers, teams that need code samples or math notation, and anyone wanting a free self-hosted alternative to a proprietary slide tool
  • Less suited: non-technical users who do not want to edit HTML or configuration files

Install reveal.js by cloning the repository

The README's install method is clone-and-build, and it lists no prerequisites. To get the source, clone the repository from GitHub. The README links to a full installation guide on revealjs.com for the steps after cloning.

  • Open a terminal and run the clone command below.
  • Follow the installation guide at revealjs.com/installation to build the project.
git clone https://github.com/hakimel/reveal.js

Know the main features before you write slides

The framework includes a set of features you can use inside a presentation. Each one has its own documentation page on revealjs.com.

  • Nested (vertical) slides
  • Markdown support for writing slide content
  • Auto-Animate between slides
  • PDF export
  • Speaker notes
  • LaTeX typesetting for math
  • Syntax highlighted code blocks
  • An extensive API for customization

Add speaker notes and export to PDF

Speaker notes are supported through the speaker view, documented at revealjs.com/speaker-view. PDF export is covered at revealjs.com/pdf-export. Check those pages for the exact steps, since the README only names the features.

Use the documentation and demo to learn the markup

The README links the live demo, the markup documentation and a paid video course. The demo at revealjs.com/demo shows the framework in use, and the documentation at revealjs.com/markup covers how to write slides. The README describes the course as paid but does not list its contents.

  • Live demo: revealjs.com/demo
  • Documentation: revealjs.com/markup
  • Paid video course: revealjs.com/course

What people use it for

  • Developer talks where slides include code samples with syntax highlighting
  • Technical presentations that need LaTeX math notation
  • Decks kept in a Git repository and reviewed like other source files
  • Presentations shared as a web page that runs in any browser

Frequently asked questions

Is reveal.js free to use?

reveal.js is licensed under MIT, and the README describes it as a way to create presentations for free. The Slides.com editor and the paid video course are separate products that the README mentions.

What does reveal.js require to install?

The README lists no prerequisites for its clone-and-build install method. It does state that setup assumes some web development familiarity.

How do I install reveal.js?

Clone the repository with git clone https://github.com/hakimel/reveal.js, then follow the installation guide at revealjs.com/installation to build it.

Does reveal.js support PDF export and speaker notes?

Yes, the README lists both PDF export and speaker notes as features. Details are on the revealjs.com pdf-export and speaker-view pages.

Is there a drag-and-drop alternative to reveal.js?

Yes. The README points to Slides.com, a graphical editor made by the same authors, for people who want a visual editor instead of writing HTML.

How does reveal.js compare to Marp, Slidev or Remark?

Marp, Slidev, Impress.js and Remark are comparable projects. The source does not compare them in detail, so review each project's documentation to decide which fits your workflow.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use reveal.js if you are comfortable with HTML, CSS or JavaScript and want free, self-hosted slides you can version and review like code. If you want a drag-and-drop editor or no web editing at all, pick Slides.com or another graphical tool instead.

Install options & downloads