From bb522c6efd9a02e611014038566b15feb28da0c8 Mon Sep 17 00:00:00 2001 From: Morgan Richomme Date: Mon, 23 May 2016 14:40:54 +0200 Subject: Add framework for presentations Change-Id: I8ba24fb4b2a3a6c8d8c69f15a1fd9259aea4ab6c Signed-off-by: Morgan Richomme --- docs/com/.gitignore | 8 + docs/com/.travis.yml | 5 + docs/com/CONTRIBUTING.md | 23 + docs/com/Gruntfile.js | 172 + docs/com/LICENSE | 19 + docs/com/README.md | 1024 +++++ docs/com/bower.json | 27 + docs/com/css/print/paper.css | 202 + docs/com/css/print/pdf.css | 168 + docs/com/css/reveal.css | 1211 +++++ docs/com/css/reveal.scss | 1362 ++++++ docs/com/css/theme/OPNFV.css | 297 ++ docs/com/css/theme/README.md | 23 + docs/com/css/theme/beige.css | 273 ++ docs/com/css/theme/black.css | 269 ++ docs/com/css/theme/blood.css | 287 ++ docs/com/css/theme/league.css | 275 ++ docs/com/css/theme/moon.css | 273 ++ docs/com/css/theme/night.css | 267 ++ docs/com/css/theme/serif.css | 269 ++ docs/com/css/theme/simple.css | 269 ++ docs/com/css/theme/sky.css | 276 ++ docs/com/css/theme/solarized.css | 273 ++ docs/com/css/theme/source/beige.scss | 39 + docs/com/css/theme/source/black.scss | 49 + docs/com/css/theme/source/blood.scss | 79 + docs/com/css/theme/source/league.scss | 34 + docs/com/css/theme/source/moon.scss | 57 + docs/com/css/theme/source/night.scss | 35 + docs/com/css/theme/source/serif.scss | 35 + docs/com/css/theme/source/simple.scss | 38 + docs/com/css/theme/source/sky.scss | 46 + docs/com/css/theme/source/solarized.scss | 63 + docs/com/css/theme/source/white.scss | 49 + docs/com/css/theme/template/mixins.scss | 29 + docs/com/css/theme/template/settings.scss | 43 + docs/com/css/theme/template/theme.scss | 352 ++ docs/com/css/theme/white.css | 269 ++ docs/com/img/Functest-CI.png | Bin 0 -> 111010 bytes docs/com/img/LinuxFoundation.png | Bin 0 -> 11043 bytes docs/com/img/OPNFV.png | Bin 0 -> 24877 bytes docs/com/img/bandeau-bas.png | Bin 0 -> 14418 bytes docs/com/img/colorado.jpeg | Bin 0 -> 10160 bytes docs/com/img/colorado.png | Bin 0 -> 1953150 bytes docs/com/img/jiras.png | Bin 0 -> 31254 bytes docs/com/img/jiras2.png | Bin 0 -> 25214 bytes docs/com/img/leaf.png | Bin 0 -> 7919 bytes docs/com/img/logo-OPNFV.png | Bin 0 -> 2829 bytes docs/com/img/matrix.png | Bin 0 -> 50992 bytes docs/com/img/opnfv_how_to_functest1.png | Bin 0 -> 146621 bytes docs/com/img/reporting.png | Bin 0 -> 68292 bytes docs/com/img/teamSummitBerlin.png | Bin 0 -> 721113 bytes docs/com/img/title-bg.jpg | Bin 0 -> 46226 bytes docs/com/img/title-bg.png | Bin 0 -> 29675 bytes docs/com/img/wordle-opnfv2.png | Bin 0 -> 42431 bytes docs/com/js/reveal.js | 4619 ++++++++++++++++++++ docs/com/lib/css/zenburn.css | 115 + docs/com/lib/font/league-gothic/LICENSE | 2 + docs/com/lib/font/league-gothic/league-gothic.css | 10 + docs/com/lib/font/league-gothic/league-gothic.eot | Bin 0 -> 25696 bytes docs/com/lib/font/league-gothic/league-gothic.ttf | Bin 0 -> 64256 bytes docs/com/lib/font/league-gothic/league-gothic.woff | Bin 0 -> 30764 bytes docs/com/lib/font/source-sans-pro/LICENSE | 45 + .../source-sans-pro/source-sans-pro-italic.eot | Bin 0 -> 75720 bytes .../source-sans-pro/source-sans-pro-italic.ttf | Bin 0 -> 238084 bytes .../source-sans-pro/source-sans-pro-italic.woff | Bin 0 -> 98556 bytes .../source-sans-pro/source-sans-pro-regular.eot | Bin 0 -> 88070 bytes .../source-sans-pro/source-sans-pro-regular.ttf | Bin 0 -> 288008 bytes .../source-sans-pro/source-sans-pro-regular.woff | Bin 0 -> 114324 bytes .../source-sans-pro/source-sans-pro-semibold.eot | Bin 0 -> 89897 bytes .../source-sans-pro/source-sans-pro-semibold.ttf | Bin 0 -> 284640 bytes .../source-sans-pro/source-sans-pro-semibold.woff | Bin 0 -> 115648 bytes .../source-sans-pro-semibolditalic.eot | Bin 0 -> 75706 bytes .../source-sans-pro-semibolditalic.ttf | Bin 0 -> 240944 bytes .../source-sans-pro-semibolditalic.woff | Bin 0 -> 98816 bytes .../lib/font/source-sans-pro/source-sans-pro.css | 39 + docs/com/lib/js/classList.js | 2 + docs/com/lib/js/head.min.js | 8 + docs/com/lib/js/html5shiv.js | 7 + docs/com/package.json | 45 + docs/com/plugin/highlight/highlight.js | 31 + docs/com/plugin/markdown/example.html | 129 + docs/com/plugin/markdown/example.md | 31 + docs/com/plugin/markdown/markdown.js | 402 ++ docs/com/plugin/markdown/marked.js | 6 + docs/com/plugin/math/math.js | 67 + docs/com/plugin/multiplex/client.js | 13 + docs/com/plugin/multiplex/index.js | 56 + docs/com/plugin/multiplex/master.js | 31 + docs/com/plugin/notes-server/client.js | 60 + docs/com/plugin/notes-server/index.js | 64 + docs/com/plugin/notes-server/notes.html | 400 ++ docs/com/plugin/notes/notes.html | 407 ++ docs/com/plugin/notes/notes.js | 124 + docs/com/plugin/print-pdf/print-pdf.js | 48 + docs/com/plugin/remotes/remotes.js | 39 + docs/com/plugin/search/search.js | 196 + docs/com/plugin/zoom-js/zoom.js | 278 ++ docs/com/pres/index.template.html | 378 ++ docs/com/pres/summit-Berlin.html | 302 ++ docs/com/test/examples/assets/image1.png | Bin 0 -> 21991 bytes docs/com/test/examples/assets/image2.png | Bin 0 -> 10237 bytes docs/com/test/examples/barebones.html | 41 + docs/com/test/examples/embedded-media.html | 49 + docs/com/test/examples/math.html | 185 + docs/com/test/examples/slide-backgrounds.html | 144 + docs/com/test/examples/slide-transitions.html | 101 + docs/com/test/qunit-1.12.0.css | 244 ++ docs/com/test/qunit-1.12.0.js | 2212 ++++++++++ .../com/test/test-markdown-element-attributes.html | 134 + docs/com/test/test-markdown-element-attributes.js | 46 + docs/com/test/test-markdown-slide-attributes.html | 128 + docs/com/test/test-markdown-slide-attributes.js | 47 + docs/com/test/test-markdown.html | 52 + docs/com/test/test-markdown.js | 15 + docs/com/test/test-pdf.html | 83 + docs/com/test/test-pdf.js | 15 + docs/com/test/test.html | 86 + docs/com/test/test.js | 597 +++ 119 files changed, 20622 insertions(+) create mode 100755 docs/com/.gitignore create mode 100755 docs/com/.travis.yml create mode 100755 docs/com/CONTRIBUTING.md create mode 100755 docs/com/Gruntfile.js create mode 100755 docs/com/LICENSE create mode 100755 docs/com/README.md create mode 100755 docs/com/bower.json create mode 100755 docs/com/css/print/paper.css create mode 100755 docs/com/css/print/pdf.css create mode 100755 docs/com/css/reveal.css create mode 100755 docs/com/css/reveal.scss create mode 100755 docs/com/css/theme/OPNFV.css create mode 100755 docs/com/css/theme/README.md create mode 100755 docs/com/css/theme/beige.css create mode 100755 docs/com/css/theme/black.css create mode 100755 docs/com/css/theme/blood.css create mode 100755 docs/com/css/theme/league.css create mode 100755 docs/com/css/theme/moon.css create mode 100755 docs/com/css/theme/night.css create mode 100755 docs/com/css/theme/serif.css create mode 100755 docs/com/css/theme/simple.css create mode 100755 docs/com/css/theme/sky.css create mode 100755 docs/com/css/theme/solarized.css create mode 100755 docs/com/css/theme/source/beige.scss create mode 100755 docs/com/css/theme/source/black.scss create mode 100755 docs/com/css/theme/source/blood.scss create mode 100755 docs/com/css/theme/source/league.scss create mode 100755 docs/com/css/theme/source/moon.scss create mode 100755 docs/com/css/theme/source/night.scss create mode 100755 docs/com/css/theme/source/serif.scss create mode 100755 docs/com/css/theme/source/simple.scss create mode 100755 docs/com/css/theme/source/sky.scss create mode 100755 docs/com/css/theme/source/solarized.scss create mode 100755 docs/com/css/theme/source/white.scss create mode 100755 docs/com/css/theme/template/mixins.scss create mode 100755 docs/com/css/theme/template/settings.scss create mode 100755 docs/com/css/theme/template/theme.scss create mode 100755 docs/com/css/theme/white.css create mode 100644 docs/com/img/Functest-CI.png create mode 100755 docs/com/img/LinuxFoundation.png create mode 100755 docs/com/img/OPNFV.png create mode 100755 docs/com/img/bandeau-bas.png create mode 100644 docs/com/img/colorado.jpeg create mode 100644 docs/com/img/colorado.png create mode 100644 docs/com/img/jiras.png create mode 100644 docs/com/img/jiras2.png create mode 100755 docs/com/img/leaf.png create mode 100755 docs/com/img/logo-OPNFV.png create mode 100644 docs/com/img/matrix.png create mode 100644 docs/com/img/opnfv_how_to_functest1.png create mode 100644 docs/com/img/reporting.png create mode 100644 docs/com/img/teamSummitBerlin.png create mode 100644 docs/com/img/title-bg.jpg create mode 100755 docs/com/img/title-bg.png create mode 100644 docs/com/img/wordle-opnfv2.png create mode 100755 docs/com/js/reveal.js create mode 100755 docs/com/lib/css/zenburn.css create mode 100755 docs/com/lib/font/league-gothic/LICENSE create mode 100755 docs/com/lib/font/league-gothic/league-gothic.css create mode 100755 docs/com/lib/font/league-gothic/league-gothic.eot create mode 100755 docs/com/lib/font/league-gothic/league-gothic.ttf create mode 100755 docs/com/lib/font/league-gothic/league-gothic.woff create mode 100755 docs/com/lib/font/source-sans-pro/LICENSE create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-italic.eot create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-italic.ttf create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-italic.woff create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-regular.eot create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-regular.ttf create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-regular.woff create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibold.eot create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibold.ttf create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibold.woff create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff create mode 100755 docs/com/lib/font/source-sans-pro/source-sans-pro.css create mode 100755 docs/com/lib/js/classList.js create mode 100755 docs/com/lib/js/head.min.js create mode 100755 docs/com/lib/js/html5shiv.js create mode 100755 docs/com/package.json create mode 100755 docs/com/plugin/highlight/highlight.js create mode 100755 docs/com/plugin/markdown/example.html create mode 100755 docs/com/plugin/markdown/example.md create mode 100755 docs/com/plugin/markdown/markdown.js create mode 100755 docs/com/plugin/markdown/marked.js create mode 100755 docs/com/plugin/math/math.js create mode 100755 docs/com/plugin/multiplex/client.js create mode 100755 docs/com/plugin/multiplex/index.js create mode 100755 docs/com/plugin/multiplex/master.js create mode 100755 docs/com/plugin/notes-server/client.js create mode 100755 docs/com/plugin/notes-server/index.js create mode 100755 docs/com/plugin/notes-server/notes.html create mode 100755 docs/com/plugin/notes/notes.html create mode 100755 docs/com/plugin/notes/notes.js create mode 100755 docs/com/plugin/print-pdf/print-pdf.js create mode 100755 docs/com/plugin/remotes/remotes.js create mode 100755 docs/com/plugin/search/search.js create mode 100755 docs/com/plugin/zoom-js/zoom.js create mode 100755 docs/com/pres/index.template.html create mode 100755 docs/com/pres/summit-Berlin.html create mode 100755 docs/com/test/examples/assets/image1.png create mode 100755 docs/com/test/examples/assets/image2.png create mode 100755 docs/com/test/examples/barebones.html create mode 100755 docs/com/test/examples/embedded-media.html create mode 100755 docs/com/test/examples/math.html create mode 100755 docs/com/test/examples/slide-backgrounds.html create mode 100755 docs/com/test/examples/slide-transitions.html create mode 100755 docs/com/test/qunit-1.12.0.css create mode 100755 docs/com/test/qunit-1.12.0.js create mode 100755 docs/com/test/test-markdown-element-attributes.html create mode 100755 docs/com/test/test-markdown-element-attributes.js create mode 100755 docs/com/test/test-markdown-slide-attributes.html create mode 100755 docs/com/test/test-markdown-slide-attributes.js create mode 100755 docs/com/test/test-markdown.html create mode 100755 docs/com/test/test-markdown.js create mode 100755 docs/com/test/test-pdf.html create mode 100755 docs/com/test/test-pdf.js create mode 100755 docs/com/test/test.html create mode 100755 docs/com/test/test.js diff --git a/docs/com/.gitignore b/docs/com/.gitignore new file mode 100755 index 00000000..a5df3133 --- /dev/null +++ b/docs/com/.gitignore @@ -0,0 +1,8 @@ +.DS_Store +.svn +log/*.log +tmp/** +node_modules/ +.sass-cache +css/reveal.min.css +js/reveal.min.js diff --git a/docs/com/.travis.yml b/docs/com/.travis.yml new file mode 100755 index 00000000..264c6ecc --- /dev/null +++ b/docs/com/.travis.yml @@ -0,0 +1,5 @@ +language: node_js +node_js: + - 4.1.1 +before_script: + - npm install -g grunt-cli \ No newline at end of file diff --git a/docs/com/CONTRIBUTING.md b/docs/com/CONTRIBUTING.md new file mode 100755 index 00000000..c2091e88 --- /dev/null +++ b/docs/com/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## Contributing + +Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. + + +### Personal Support +If you have personal support or setup questions the best place to ask those are [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js). + + +### Bug Reports +When reporting a bug make sure to include information about which browser and operating system you are on as well as the necessary steps to reproduce the issue. If possible please include a link to a sample presentation where the bug can be tested. + + +### Pull Requests +- Should follow the coding style of the file you work in, most importantly: + - Tabs to indent + - Single-quoted strings +- Should be made towards the **dev branch** +- Should be submitted from a feature/topic branch (not your master) + + +### Plugins +Please do not submit plugins as pull requests. They should be maintained in their own separate repository. More information here: https://github.com/hakimel/reveal.js/wiki/Plugin-Guidelines diff --git a/docs/com/Gruntfile.js b/docs/com/Gruntfile.js new file mode 100755 index 00000000..a8518451 --- /dev/null +++ b/docs/com/Gruntfile.js @@ -0,0 +1,172 @@ +/* global module:false */ +module.exports = function(grunt) { + var port = grunt.option('port') || 8000; + var base = grunt.option('base') || '.'; + + // Project configuration + grunt.initConfig({ + pkg: grunt.file.readJSON('package.json'), + meta: { + banner: + '/*!\n' + + ' * reveal.js <%= pkg.version %> (<%= grunt.template.today("yyyy-mm-dd, HH:MM") %>)\n' + + ' * http://lab.hakim.se/reveal-js\n' + + ' * MIT licensed\n' + + ' *\n' + + ' * Copyright (C) 2015 Hakim El Hattab, http://hakim.se\n' + + ' */' + }, + + qunit: { + files: [ 'test/*.html' ] + }, + + uglify: { + options: { + banner: '<%= meta.banner %>\n' + }, + build: { + src: 'js/reveal.js', + dest: 'js/reveal.min.js' + } + }, + + sass: { + core: { + files: { + 'css/reveal.css': 'css/reveal.scss', + } + }, + themes: { + files: [ + { + expand: true, + cwd: 'css/theme/source', + src: ['*.scss'], + dest: 'css/theme', + ext: '.css' + } + ] + } + }, + + autoprefixer: { + dist: { + src: 'css/reveal.css' + } + }, + + cssmin: { + compress: { + files: { + 'css/reveal.min.css': [ 'css/reveal.css' ] + } + } + }, + + jshint: { + options: { + curly: false, + eqeqeq: true, + immed: true, + latedef: true, + newcap: true, + noarg: true, + sub: true, + undef: true, + eqnull: true, + browser: true, + expr: true, + globals: { + head: false, + module: false, + console: false, + unescape: false, + define: false, + exports: false + } + }, + files: [ 'Gruntfile.js', 'js/reveal.js' ] + }, + + connect: { + server: { + options: { + port: port, + base: base, + livereload: true, + open: true + } + } + }, + + zip: { + 'reveal-js-presentation.zip': [ + 'index.html', + 'css/**', + 'js/**', + 'lib/**', + 'images/**', + 'plugin/**' + ] + }, + + watch: { + options: { + livereload: true + }, + js: { + files: [ 'Gruntfile.js', 'js/reveal.js' ], + tasks: 'js' + }, + theme: { + files: [ 'css/theme/source/*.scss', 'css/theme/template/*.scss' ], + tasks: 'css-themes' + }, + css: { + files: [ 'css/reveal.scss' ], + tasks: 'css-core' + }, + html: { + files: [ 'index.html'] + } + } + + }); + + // Dependencies + grunt.loadNpmTasks( 'grunt-contrib-qunit' ); + grunt.loadNpmTasks( 'grunt-contrib-jshint' ); + grunt.loadNpmTasks( 'grunt-contrib-cssmin' ); + grunt.loadNpmTasks( 'grunt-contrib-uglify' ); + grunt.loadNpmTasks( 'grunt-contrib-watch' ); + grunt.loadNpmTasks( 'grunt-sass' ); + grunt.loadNpmTasks( 'grunt-contrib-connect' ); + grunt.loadNpmTasks( 'grunt-autoprefixer' ); + grunt.loadNpmTasks( 'grunt-zip' ); + + // Default task + grunt.registerTask( 'default', [ 'css', 'js' ] ); + + // JS task + grunt.registerTask( 'js', [ 'jshint', 'uglify', 'qunit' ] ); + + // Theme CSS + grunt.registerTask( 'css-themes', [ 'sass:themes' ] ); + + // Core framework CSS + grunt.registerTask( 'css-core', [ 'sass:core', 'autoprefixer', 'cssmin' ] ); + + // All CSS + grunt.registerTask( 'css', [ 'sass', 'autoprefixer', 'cssmin' ] ); + + // Package presentation to archive + grunt.registerTask( 'package', [ 'default', 'zip' ] ); + + // Serve presentation locally + grunt.registerTask( 'serve', [ 'connect', 'watch' ] ); + + // Run tests + grunt.registerTask( 'test', [ 'jshint', 'qunit' ] ); + +}; diff --git a/docs/com/LICENSE b/docs/com/LICENSE new file mode 100755 index 00000000..09623076 --- /dev/null +++ b/docs/com/LICENSE @@ -0,0 +1,19 @@ +Copyright (C) 2015 Hakim El Hattab, http://hakim.se + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/docs/com/README.md b/docs/com/README.md new file mode 100755 index 00000000..a5825494 --- /dev/null +++ b/docs/com/README.md @@ -0,0 +1,1024 @@ +# reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js) + +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 modern browser 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: +- [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer. +- [Changelog](https://github.com/hakimel/reveal.js/releases): 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. +- [Plugins](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware): A list of plugins that can be used to extend reveal.js. + +## Online Editor + +Presentations are written using HTML or Markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slides.com](http://slides.com). + + +## Instructions + +### Markup + +Markup hierarchy 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: + +```html +
+
+
Single Horizontal Slide
+
+
Vertical Slide 1
+
Vertical Slide 2
+
+
+
+``` + +### 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 ``` +
+``` + +#### 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. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file. + +When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup). + +```html +
+
+``` + +#### Element Attributes + +Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things. + +```html +
+ +
+``` + +#### Slide Attributes + +Special syntax (in html comment) is available for adding attributes to the slide `
` elements generated by your Markdown. + +```html +
+ +
+``` + + +### 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. + +```javascript +Reveal.initialize({ + + // Display controls in the bottom right corner + controls: true, + + // Display a presentation progress bar + progress: true, + + // Display the page number of the current slide + slideNumber: false, + + // 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, + + // Enables touch navigation on devices with touch input + touch: true, + + // Loop the presentation + loop: false, + + // Change the presentation direction to be RTL + rtl: false, + + // Turns fragments on and off globally + fragments: true, + + // Flags if the presentation is running in an embedded mode, + // i.e. contained within a limited portion of the screen + embedded: false, + + // Flags if we should show a help overlay when the questionmark + // key is pressed + help: true, + + // Flags if speaker notes should be visible to all viewers + showNotes: 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, + + // Stop auto-sliding after user input + autoSlideStoppable: true, + + // Enable slide navigation via mouse wheel + mouseWheel: false, + + // Hides the address bar on mobile devices + hideAddressBar: true, + + // Opens links in an iframe preview overlay + previewLinks: false, + + // Transition style + transition: 'default', // none/fade/slide/convex/concave/zoom + + // Transition speed + transitionSpeed: 'default', // default/fast/slow + + // Transition style for full page slide backgrounds + backgroundTransition: 'default', // none/fade/slide/convex/concave/zoom + + // Number of slides away from the current that are visible + viewDistance: 3, + + // Parallax background image + parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'" + + // Parallax background size + parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" + + // Amount to move parallax background (horizontal and vertical) on slide change + // Number, e.g. 100 + parallaxBackgroundHorizontal: '', + parallaxBackgroundVertical: '' + +}); +``` + + +The configuration can be updated after initialization using the ```configure``` method: + +```javascript +// Turn autoSlide off +Reveal.configure({ autoSlide: 0 }); + +// Start auto-sliding every 5s +Reveal.configure({ autoSlide: 5000 }); +``` + + +### 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: + +```javascript +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/marked.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 }, + + // Speaker notes + { src: 'plugin/notes/notes.js', async: true }, + + // Remote control your reveal.js presentation using a touch device + { src: 'plugin/remotes/remotes.js', async: true }, + + // MathJax + { src: 'plugin/math/math.js', async: true } + ] +}); +``` + +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 + + +### Ready Event + +A 'ready' event is fired when reveal.js has loaded all non-async dependencies and is ready to start navigating. To check if reveal.js is already 'ready' you can call `Reveal.isReady()`. + +```javascript +Reveal.addEventListener( 'ready', function( event ) { + // event.currentSlide, event.indexh, event.indexv +} ); +``` + + +### 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: + +```javascript +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.5 + +}); +``` + + +### Auto-sliding + +Presentations can be configured to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides: + +```javascript +// Slide every five seconds +Reveal.configure({ + autoSlide: 5000 +}); +``` +When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config. + +You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute: + +```html +
+

After 2 seconds the first fragment will be shown.

+

After 10 seconds the next fragment will be shown.

+

Now, the fragment is displayed for 2 seconds before the next slide is shown.

+
+``` + +Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired. + + +### Keyboard Bindings + +If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option: + +```javascript +Reveal.configure({ + keyboard: { + 13: 'next', // go to the next slide when the ENTER key is pressed + 27: function() {}, // do something custom when ESC is pressed + 32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding) + } +}); +``` + +### Touch Navigation + +You can swipe to navigate through a presentation on any touch-enabled device. Horizontal swipes change between horizontal slides, vertical swipes change between vertical slides. If you wish to disable this you can set the `touch` config option to false when initializing reveal.js. + +If there's some part of your content that needs to remain accessible to touch events you'll need to highlight this by adding a `data-prevent-swipe` attribute to the element. One common example where this is useful is elements that need to be scrolled. + + +### Lazy Loading + +When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the `viewDistance` configuration option. + +To enable lazy loading all you need to do is change your "src" attributes to "data-src" as shown below. This is supported for image, video, audio and iframe elements. Lazy loaded iframes will also unload when the containing slide is no longer visible. + +```html +
+ + + +
+``` + + +### API + +The ``Reveal`` object exposes a JavaScript API for controlling navigation and reading state: + +```javascript +// Navigation +Reveal.slide( indexh, indexv, indexf ); +Reveal.left(); +Reveal.right(); +Reveal.up(); +Reveal.down(); +Reveal.prev(); +Reveal.next(); +Reveal.prevFragment(); +Reveal.nextFragment(); + +// Toggle presentation states, optionally pass true/false to force on/off +Reveal.toggleOverview(); +Reveal.togglePause(); +Reveal.toggleAutoSlide(); + +// Change a config value at runtime +Reveal.configure({ controls: true }); + +// Returns the present configuration options +Reveal.getConfig(); + +// Fetch the current scale of the presentation +Reveal.getScale(); + +// Retrieves the previous and current slide elements +Reveal.getPreviousSlide(); +Reveal.getCurrentSlide(); + +Reveal.getIndices(); // { h: 0, v: 0 } } +Reveal.getProgress(); // 0-1 +Reveal.getTotalSlides(); + +// Returns the speaker notes for the current slide +Reveal.getSlideNotes(); + +// State checks +Reveal.isFirstSlide(); +Reveal.isLastSlide(); +Reveal.isOverview(); +Reveal.isPaused(); +Reveal.isAutoSliding(); +``` + +### Slide Changed Event + +A '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. + +```javascript +Reveal.addEventListener( 'slidechanged', function( event ) { + // event.previousSlide, event.currentSlide, event.indexh, event.indexv +} ); +``` + +### Presentation State + +The presentation's current state can be fetched by using the `getState` method. A state object contains all of the information required to put the presentation back as it was when `getState` was first called. Sort of like a snapshot. It's a simple object that can easily be stringified and persisted or sent over the wire. + +```javascript +Reveal.slide( 1 ); +// we're on slide 1 + +var state = Reveal.getState(); + +Reveal.slide( 3 ); +// we're on slide 3 + +Reveal.setState( state ); +// we're back on slide 1 +``` + +### Slide 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: + +```javascript +Reveal.addEventListener( 'somestate', function() { + // TODO: Sprinkle magic +}, false ); +``` + +### Slide Backgrounds + +Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page backgrounds outside of the slide area by adding a ```data-background``` attribute to your ```
``` elements. Four different types of backgrounds are supported: color, image, video and iframe. Below are a few examples. + +```html +
+

All CSS color formats are supported, like rgba() or hsl().

+
+
+

This slide will have a full-size background image.

+
+
+

This background image will be sized to 100px and repeated.

+
+
+

Video. Multiple sources can be defined using a comma separated list. Video will loop when the data-background-video-loop attribute is provided.

+
+
+

Embeds a web page as a background. Note that the page won't be interactive.

+
+``` + +Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition. + + +### Parallax Background + +If you want to use a parallax scrolling background, set the first two config properties below when initializing reveal.js (the other two are optional). + +```javascript +Reveal.initialize({ + + // Parallax background image + parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg" + + // Parallax background size + parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto) + + // Amount of pixels to move the parallax background per slide step, + // a value of 0 disables movement along the given axis + // These are optional, if they aren't specified they'll be calculated automatically + parallaxBackgroundHorizontal: 200, + parallaxBackgroundVertical: 50 + +}); +``` + +Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg¶llaxBackgroundSize=2100px%20900px). + + + +### Slide Transitions +The global presentation transition is set using the ```transition``` config value. You can override the global transition for a specific slide by using the ```data-transition``` attribute: + +```html +
+

This slide will override the presentation transition and zoom!

+
+ +
+

Choose from three transition speeds: default, fast or slow!

+
+``` + +You can also use different in and out transitions for the same slide: + +```html +
+ The train goes on … +
+
+ and on … +
+
+ and stops. +
+
+ (Passengers entering and leaving) +
+
+ And it starts again. +
+``` + + +Note that this does not work with the page and cube transitions. + + +### 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 (```
```): + +```html +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. + +```html + + + + + + +``` + + +### Fragments +Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/fragments + +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: + +```html +
+

grow

+

shrink

+

fade-out

+

visible only once

+

blue only once

+

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. + +```html +
+ + I'll fade in, then out + +
+``` + +The display order of fragments can be controlled using the ```data-fragment-index``` attribute. + +```html +
+

Appears last

+

Appears first

+

Appears second

+
+``` + +### Fragment events + +When a slide fragment is either shown or hidden reveal.js will dispatch an event. + +Some libraries, like MathJax (see #505), get confused by the initially hidden fragment elements. Often times this can be fixed by calling their update or render function from this callback. + +```javascript +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 + +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. When the `data-trim` attribute is present surrounding whitespace is automatically removed. + +```html +
+ 

+(def lazy-fib
+  (concat
+   [0 1]
+   ((fn rfib [a b]
+        (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
+
+
+``` + +### Slide number +If you would like to display the page number of the current slide you can do so using the ```slideNumber``` configuration value. + +```javascript +// Shows the slide number using default formatting +Reveal.configure({ slideNumber: true }); + +// Slide number formatting can be configured using these variables: +// h: current slide's horizontal index +// v: current slide's vertical index +// c: current slide index (flattened) +// t: total number of slides (flattened) +Reveal.configure({ slideNumber: 'c / t' }); + +``` + + +### Overview mode + +Press "Esc" or "o" keys 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: + +```javascript +Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } ); +Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } ); + +// Toggle the overview mode programmatically +Reveal.toggleOverview(); +``` + +### Fullscreen mode +Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode. + + +### Embedded media +Embedded HTML5 `