/revealjs.com

The official reveal.js website and documentation

Primary LanguageJavaScript

Netlify Status

Fork Notice

This fork implements the docs-auto-animate-id-restart branch

revealjs.com

The official reveal.js website and docs. Contributions are welcome!

Installation

  1. Clone the repo

    $ git clone https://github.com/reveal/revealjs.com.git && cd revealjs.com
  2. Install dependencies

    $ npm install
  3. Start the development server

    $ npm start

The development server will automatically reload as you make changes.

Spell Check

There's a built-in task for spell checking.

$ npm test

Technologies

This site is built using Eleventy — a powerful but easy to use static site generator. It's styled with tailwindcss and the docs are written in Markdown.

Deploy

The site is hosted on Netlify and automatically deploys master when there are new commits.

We automatically generate our production build at deploy-time but it's also possible to do it manually with:

npm run production

Note

reveal.js is installed from the dev branch. If it gets stuck on an old version, remove the reveal.js entry from package.lock.json and rerun npm install.