PHPackages fwahlqvist/reveal.js - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. fwahlqvist/reveal.js ActiveLibrary fwahlqvist/reveal.js ==================== The HTML Presentation Framework 023JavaScript Since Apr 1Pushed 13y ago1 watchersCompare [ Source](https://github.com/fwahlqvist/reveal.js)[ Packagist](https://packagist.org/packages/fwahlqvist/reveal.js)[ RSS](/packages/fwahlqvist-revealjs/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependenciesVersions (1)Used By (0) reveal.js [![Build Status](https://camo.githubusercontent.com/ad73761cdf8a20e72d8118826f7a023bb22b0c03839d3d406fe3c35ab442626f/68747470733a2f2f7472617669732d63692e6f72672f68616b696d656c2f72657665616c2e6a732e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/hakimel/reveal.js) ============================================================================================================================================================================================================================================================================================ [](#revealjs-) A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/). reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere. #### More reading in the Wiki: [](#more-reading-in-the-wiki) - [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history. - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own! - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks. rvl.io ------ [](#rvlio) Slides are written using HTML or markdown but there's also an online editor for those of you who prefer a more traditional user interface. Give it a try at [www.rvl.io](http://www.rvl.io). Instructions ------------ [](#instructions) ### Markup [](#markup) Markup heirarchy needs to be ` ` where the `` represents one slide and can be repeated indefinitely. If you place multiple ``'s inside of another `` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and it will be included in the horizontal sequence. For example: ``` Single Horizontal Slide Vertical Slide 1 Vertical Slide 2 ``` ### Markdown [](#markdown) It's possible to write your slides using Markdown. To enable Markdown, add the `data-markdown` attribute to your `` elements and wrap the contents in a `` like the example below. This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) which in turn uses [showdown](https://github.com/coreyti/showdown/). Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks). ``` ## Page title A paragraph with some text and a [link](http://hakim.se). ``` #### External Markdown [](#external-markdown) You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file. ``` ``` ### Configuration [](#configuration) At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below. ``` Reveal.initialize({ // Display controls in the bottom right corner controls: true, // Display a presentation progress bar progress: true, // Push each slide change to the browser history history: false, // Enable keyboard shortcuts for navigation keyboard: true, // Enable the slide overview mode overview: true, // Vertical centering of slides center: true, // Loop the presentation loop: false, // Change the presentation direction to be RTL rtl: false, // Number of milliseconds between automatically proceeding to the // next slide, disabled when set to 0, this value can be overwritten // by using a data-autoslide attribute on your slides autoSlide: 0, // Enable slide navigation via mouse wheel mouseWheel: false, // Apply a 3D roll to links on hover rollingLinks: true, // Transition style transition: 'default' // default/cube/page/concave/zoom/linear/fade/none }); ``` Note that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`. The configuration can be updated after initialization using the `configure` method: ``` // Turn autoSlide off Reveal.configure({ autoSlide: 0 }); // Start auto-sliding every 5s Reveal.configure({ autoSlide: 5000 }); ``` ### Presentation Size [](#presentation-size) All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport. See below for a list of configuration options related to sizing, including default values: ``` Reveal.initialize({ ... // The "normal" size of the presentation, aspect ratio will be preserved // when the presentation is scaled to fit different resolutions. Can be // specified using percentage units. width: 960, height: 700, // Factor of the display size that should remain empty around the content margin: 0.1, // Bounds for smallest/largest possible scale to apply to content minScale: 0.2, maxScale: 1.0 }); ``` ### Dependencies [](#dependencies) Reveal.js doesn't *rely* on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example: ``` Reveal.initialize({ dependencies: [ // Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/ { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }, // Interpret Markdown in elements { src: 'plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, // Syntax highlight for elements { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }, // Zoom in and out with Alt+click { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } }, // Speaker notes { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }, // Remote control your reveal.js presentation using a touch device { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } } ] }); ``` You can add your own extensions using the same syntax. The following properties are available for each dependency object: - **src**: Path to the script to load - **async**: \[optional\] Flags if the script should load after reveal.js has started, defaults to false - **callback**: \[optional\] Function to execute when the script has loaded - **condition**: \[optional\] Function which must return true for the script to be loaded ### API [](#api) The `Reveal` class provides a minimal JavaScript API for controlling navigation and reading state: ``` // Navigation Reveal.slide( indexh, indexv, indexf ); Reveal.left(); Reveal.right(); Reveal.up(); Reveal.down(); Reveal.prev(); Reveal.next(); Reveal.prevFragment(); Reveal.nextFragment(); Reveal.toggleOverview(); // Retrieves the previous and current slide elements Reveal.getPreviousSlide(); Reveal.getCurrentSlide(); Reveal.getIndices(); // { h: 0, v: 0 } } ``` ### States [](#states) If you set `data-state="somestate"` on a slide ``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide. Furthermore you can also listen to these changes in state via JavaScript: ``` Reveal.addEventListener( 'somestate', function() { // TODO: Sprinkle magic }, false ); ``` ### Ready event [](#ready-event) The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating. ``` Reveal.addEventListener( 'ready', function( event ) { // event.currentSlide, event.indexh, event.indexv } ); ``` ### Slide change event [](#slide-change-event) An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes. Some libraries, like MathJax (see [\#226](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback. ``` Reveal.addEventListener( 'slidechanged', function( event ) { // event.previousSlide, event.currentSlide, event.indexh, event.indexv } ); ``` ### Internal links [](#internal-links) It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (``): ``` Link Link ``` You can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an `enabled` class when it's a valid navigation route based on the current slide. ``` ``` ### Fragments [](#fragments) Fragments are used to highlight individual elements on a slide. Every elmement with the class `fragment` will be stepped through before moving on to the next slide. Here's an example: The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment: ``` grow shrink roll-in fade-out highlight-red highlight-green highlight-blue ``` Multiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second. ``` I'll fade in, then out ``` The display order of fragments can be controlled using the `data-fragment-index` attribute. ``` Appears last Appears first Appears second ``` ### Fragment events [](#fragment-events) When a slide fragment is either shown or hidden reveal.js will dispatch an event. ``` Reveal.addEventListener( 'fragmentshown', function( event ) { // event.fragment = the fragment DOM element } ); Reveal.addEventListener( 'fragmenthidden', function( event ) { // event.fragment = the fragment DOM element } ); ``` ### Code syntax highlighting [](#code-syntax-highlighting) By default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/soft/highlight/en/) for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted: ``` (def lazy-fib (concat [0 1] ((fn rfib [a b] (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1))) ``` ### Overview mode [](#overview-mode) Press "Esc" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides, as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks: ``` Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } ); Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } ); // Toggle the overview mode programmatically Reveal.toggleOverview(); ``` ### Fullscreen mode [](#fullscreen-mode) Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode. PDF Export ---------- [](#pdf-export) Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome). Here's an example of an exported presentation that's been uploaded to SlideShare: . 1. Open your presentation with [css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css) included on the page. The default index HTML lets you add *print-pdf* anywhere in the query to include the stylesheet, for example: [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf). 2. Open the in-browser print dialog (CMD+P). 3. Change the **Destination** setting to **Save as PDF**. 4. Change the **Layout** to **Landscape**. 5. Change the **Margins** to **None**. 6. Click **Save**. [![Chrome Print Settings](https://camo.githubusercontent.com/b3b4ac496568c75684d75c648df5e496ba2e76ff6751b839dfb95ca59b8f572e/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f68616b696d2d7374617469632f72657665616c2d6a732f7064662d7072696e742d73657474696e67732e706e67)](https://camo.githubusercontent.com/b3b4ac496568c75684d75c648df5e496ba2e76ff6751b839dfb95ca59b8f572e/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f68616b696d2d7374617469632f72657665616c2d6a732f7064662d7072696e742d73657474696e67732e706e67) Speaker Notes ------------- [](#speaker-notes) reveal.js comes with a speaker notes plugin which can be used to present per-slide notes in a separate browser window. The notes window also gives you a preview of the next upcoming slide so it may be helpful even if you haven't written any notes. Append `?notes` to the presentation URL or press the 's' key on your keyboard to open the notes window. By default notes are written using standard HTML, see below, but you can add a `data-markdown` attribute to the `` to write them using Markdown. ``` Some Slide Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard). ``` Server Side Speaker Notes ------------------------- [](#server-side-speaker-notes) In some cases it can be desirable to run notes on a separate device from the one you're presenting on. The Node.js-based notes plugin lets you do this using the same note definitions as its client side counterpart. Include the required scripts by adding the following dependencies: ``` Reveal.initialize({ ... dependencies: [ { src: 'socket.io/socket.io.js', async: true }, { src: 'plugin/notes-server/client.js', async: true } ] }); ``` Then: 1. Install [Node.js](http://nodejs.org/) 2. Run `npm install` 3. Run `node plugin/notes-server` Multiplexing ------------ [](#multiplexing) The multiplex plugin allows your audience to view the slides on their own phone, tablet or laptop. As the master navigates the slides, all clients will update in real time. See a demo at [http://revealjs.jit.su/](http://revealjs.jit.su). Configuration is via the multiplex object in `Reveal.initialize`. To generate unique secret and token values, visit [revealjs.jit.su/token](revealjs.jit.su/token). Below is an example configuration with the multiplex plugin enabled: ``` Reveal.initialize({ ... // Generate a unique id and secret at revealjs.jit.su/token multiplex: { id: '', secret: '', url: 'revealjs.jit.su:80' }, dependencies: [ { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true }, { src: 'plugin/multiplex/client.js', async: true }, { src: 'plugin/multiplex/master.js', async: true }, ] }); ``` `multiplex.secret` should only be configured on those pages you wish to be able to control slide navigation for all clients. Multi-master configurations work, but if you don't wish your audience to be able to control your slides, set the secret to `null`. In this master/slave setup, you should create a publicly accessible page with secret set to `null`, and a protected page containing your secret. You are very welcome to use the socketio server running at reveal.jit.su, however availability and stability are not guaranteed. For anything mission critical I recommend you run your own server. It is simple to deploy to nodejitsu or run on your own environment. Theming ------- [](#theming) The framework comes with a few different themes included: - default: Gray background, white text, blue links - beige: Beige background, dark text, brown links - sky: Blue background, thin white text, blue links - night: Black background, thick white text, orange links - serif: Cappuccino background, gray text, brown links - simple: White background, black text, blue links Each theme is available as a separate stylesheet. To change theme you will need to replace **default** below with your desired theme name in index.html: ``` ``` If you want to add a theme of your own see the instructions here: [/css/theme/README.md](https://github.com/hakimel/reveal.js/blob/master/css/theme/README.md). Development Environment ----------------------- [](#development-environment) reveal.js is built using the task-based command line build tool [grunt.js](http://gruntjs.com) ([installation instructions](http://gruntjs.com/getting-started#installing-the-cli)). With Node.js and grunt.js installed, you need to start by running `npm install` in the reveal.js root. When the dependencies have been installed you should run `grunt watch` to start monitoring files for changes. If you want to customise reveal.js without running grunt.js you can alter the HTML to point to the uncompressed source files (css/reveal.css & js/reveal.js). ### Folder Structure [](#folder-structure) - **css/** Core styles without which the project does not function - **js/** Like above but for JavaScript - **plugin/** Components that have been developed as extensions to reveal.js - **lib/** All other third party assets (JavaScript, CSS, fonts) License ------- [](#license) MIT licensed Copyright (C) 2013 Hakim El Hattab, ### Health Score 22 — LowBetter than 22% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community20 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 79.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/cb5115ec3d601dfab3ef376b85d89ca2251bad97b2c84abe9d6c4af1b73222f1?d=identicon)[fwahlqvist@gmail.com](/maintainers/fwahlqvist@gmail.com) --- Top Contributors [![hakimel](https://avatars.githubusercontent.com/u/629429?v=4)](https://github.com/hakimel "hakimel (502 commits)")[![mischah](https://avatars.githubusercontent.com/u/441011?v=4)](https://github.com/mischah "mischah (28 commits)")[![davidbanham](https://avatars.githubusercontent.com/u/631832?v=4)](https://github.com/davidbanham "davidbanham (14 commits)")[![rmurphey](https://avatars.githubusercontent.com/u/58987?v=4)](https://github.com/rmurphey "rmurphey (12 commits)")[![dandv](https://avatars.githubusercontent.com/u/33569?v=4)](https://github.com/dandv "dandv (11 commits)")[![owenversteeg](https://avatars.githubusercontent.com/u/1836017?v=4)](https://github.com/owenversteeg "owenversteeg (9 commits)")[![asmod3us](https://avatars.githubusercontent.com/u/450168?v=4)](https://github.com/asmod3us "asmod3us (6 commits)")[![fwahlqvist](https://avatars.githubusercontent.com/u/551815?v=4)](https://github.com/fwahlqvist "fwahlqvist (4 commits)")[![nschonni](https://avatars.githubusercontent.com/u/1297909?v=4)](https://github.com/nschonni "nschonni (4 commits)")[![technicalpickles](https://avatars.githubusercontent.com/u/159?v=4)](https://github.com/technicalpickles "technicalpickles (4 commits)")[![akiersky](https://avatars.githubusercontent.com/u/1530504?v=4)](https://github.com/akiersky "akiersky (3 commits)")[![commadelimited](https://avatars.githubusercontent.com/u/563460?v=4)](https://github.com/commadelimited "commadelimited (3 commits)")[![danielmitd](https://avatars.githubusercontent.com/u/217588?v=4)](https://github.com/danielmitd "danielmitd (3 commits)")[![mahemoff](https://avatars.githubusercontent.com/u/55860?v=4)](https://github.com/mahemoff "mahemoff (3 commits)")[![webpro](https://avatars.githubusercontent.com/u/456426?v=4)](https://github.com/webpro "webpro (3 commits)")[![bleathem](https://avatars.githubusercontent.com/u/265649?v=4)](https://github.com/bleathem "bleathem (2 commits)")[![jaberg](https://avatars.githubusercontent.com/u/171276?v=4)](https://github.com/jaberg "jaberg (2 commits)")[![ob1](https://avatars.githubusercontent.com/u/811962?v=4)](https://github.com/ob1 "ob1 (2 commits)")[![olivierphi](https://avatars.githubusercontent.com/u/722388?v=4)](https://github.com/olivierphi "olivierphi (2 commits)")[![ericduran](https://avatars.githubusercontent.com/u/118016?v=4)](https://github.com/ericduran "ericduran (2 commits)") ### Embed Badge ![Health badge](/badges/fwahlqvist-revealjs/health.svg) ``` [![Health](https://phpackages.com/badges/fwahlqvist-revealjs/health.svg)](https://phpackages.com/packages/fwahlqvist-revealjs) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)