moinuddin14/DemoRevealJsPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star0

This is a demo revealjs

License

MIT license

0 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
css		css
js		js
lib		lib
plugin		plugin
test		test
.gitignore		.gitignore
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Gruntfile.js		Gruntfile.js
LICENSE		LICENSE
README.md		README.md
bower.json		bower.json
demo.html		demo.html
index.html		index.html
package.json		package.json

Repository files navigation

reveal.js

A framework for easily creating beautiful presentations using HTML.Check out the live demo.

reveal.js comes with a broad range of features includingnested slides,Markdown contents,PDF export,speaker notes and aJavaScript API. There's also a fully featured visual editor and platform for sharing reveal.js presentations atslides.com.

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 athttps://slides.com.

Instructions

Markup

Here's a barebones example of a fully working reveal.js presentation:

<html><head><linkrel="stylesheet"href="css/reveal.css"><linkrel="stylesheet"href="css/theme/white.css"></head><body><divclass="reveal"><divclass="slides"><section>Slide 1</section><section>Slide 2</section></div></div><scriptsrc="js/reveal.js"></script><script>Reveal.initialize();</script></body></html>

The presentation markup hierarchy needs to be.reveal > .slides > section where thesection represents one slide and can be repeated indefinitely. If you place multiplesection elements inside of anothersection they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and will be included in the horizontal sequence. For example:

<divclass="reveal"><divclass="slides"><section>Single Horizontal Slide</section><section><section>Vertical Slide 1</section><section>Vertical Slide 2</section></section></div></div>

Markdown

It's possible to write your slides using Markdown. To enable Markdown, add thedata-markdown attribute to your<section> elements and wrap the contents in a<textarea data-template> like the example below. You'll also need to add theplugin/markdown/marked.js andplugin/markdown/markdown.js scripts (in that order) to your HTML file.

This is based ondata-markdown fromPaul Irish modified to usemarked to supportGitHub Flavored Markdown. Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).

<sectiondata-markdown><textareadata-template>## Page titleA paragraph with some text and a [link](http://hakim.se).</textarea></section>

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: thedata-separator attribute defines a regular expression for horizontal slides (defaults to^\r?\n---\r?\n$, a newline-bounded horizontal rule) anddata-separator-vertical defines vertical slides (disabled by default). Thedata-separator-notes attribute is a regular expression for specifying the beginning of the current slide's speaker notes (defaults tonotes?:, so it will match both "note:" and "notes:"). Thedata-charset attribute is optional and specifies which charset to use when loading the external file.

When used locally, this feature requires that reveal.jsruns from a local web server. The following example customises all available options:

<sectiondata-markdown="example.md"data-separator="^\n\n\n"data-separator-vertical="^\n\n"data-separator-notes="^Note:"data-charset="iso-8859-15"><!--        Note that Windows uses `\r\n` instead of `\n` as its linefeed character.        For a regex that supports all operating systems, use `\r?\n` instead of `\n`.    --></section>

Element Attributes

Special syntax (through HTML comments) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.

<sectiondata-markdown><scripttype="text/template">-Item1<!--.element:class="fragment"data-fragment-index="2"-->-Item2<!--.element:class="fragment"data-fragment-index="1"--></script></section>

Slide Attributes

Special syntax (through HTML comments) is available for adding attributes to the slide<section> elements generated by your Markdown.

<sectiondata-markdown><scripttype="text/template"><!-- .slide: data-background="#ff0000" -->Markdowncontent</script></section>

Configuringmarked

We usemarked to parse Markdown. To customise marked's rendering, you can pass in options whenconfiguring Reveal:

Reveal.initialize({// Options which are passed into marked// See https://github.com/chjj/marked#options-1markdown:{smartypants:true}});

Configuration

At the end of your page you need to initialize reveal by running the following code. Note that all configuration values are optional and will default to the values specified below.

Reveal.initialize({// Display presentation control arrowscontrols:true,// Help the user learn the controls by providing hints, for example by// bouncing the down arrow when they first encounter a vertical slidecontrolsTutorial:true,// Determines where controls appear, "edges" or "bottom-right"controlsLayout:'bottom-right',// Visibility rule for backwards navigation arrows; "faded", "hidden"// or "visible"controlsBackArrows:'faded',// Display a presentation progress barprogress:true,// Display the page number of the current slideslideNumber:false,// Push each slide change to the browser historyhistory:false,// Enable keyboard shortcuts for navigationkeyboard:true,// Enable the slide overview modeoverview:true,// Vertical centering of slidescenter:true,// Enables touch navigation on devices with touch inputtouch:true,// Loop the presentationloop:false,// Change the presentation direction to be RTLrtl:false,// Randomizes the order of slides each time the presentation loadsshuffle:false,// Turns fragments on and off globallyfragments:true,// Flags whether to include the current fragment in the URL,// so that reloading brings you to the same fragment positionfragmentInURL:false,// Flags if the presentation is running in an embedded mode,// i.e. contained within a limited portion of the screenembedded:false,// Flags if we should show a help overlay when the questionmark// key is pressedhelp:true,// Flags if speaker notes should be visible to all viewersshowNotes:false,// Global override for autoplaying embedded media (video/audio/iframe)// - null: Media will only autoplay if data-autoplay is present// - true: All media will autoplay, regardless of individual setting// - false: No media will autoplay, regardless of individual settingautoPlayMedia:null,// 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 slidesautoSlide:0,// Stop auto-sliding after user inputautoSlideStoppable:true,// Use this method for navigation when auto-slidingautoSlideMethod:Reveal.navigateNext,// Specify the average time in seconds that you think you will spend// presenting each slide. This is used to show a pacing timer in the// speaker viewdefaultTiming:120,// Enable slide navigation via mouse wheelmouseWheel:false,// Hides the address bar on mobile deviceshideAddressBar:true,// Opens links in an iframe preview overlay// Add `data-preview-link` and `data-preview-link="false"` to customise each link// individuallypreviewLinks:false,// Transition styletransition:'slide',// none/fade/slide/convex/concave/zoom// Transition speedtransitionSpeed:'default',// default/fast/slow// Transition style for full page slide backgroundsbackgroundTransition:'fade',// none/fade/slide/convex/concave/zoom// Number of slides away from the current that are visibleviewDistance:3,// Parallax background imageparallaxBackgroundImage:'',// e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"// Parallax background sizeparallaxBackgroundSize:'',// CSS syntax, e.g. "2100px 900px"// Number of pixels to move the parallax background per slide// - Calculated automatically unless specified// - Set to 0 to disable movement along an axisparallaxBackgroundHorizontal:null,parallaxBackgroundVertical:null,// The display mode that will be used to show slidesdisplay:'block'});

The configuration can be updated after initialization using theconfigure method:

// Turn autoSlide offReveal.configure({autoSlide:0});// Start auto-sliding every 5sReveal.configure({autoSlide:5000});

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 contentmargin:0.1,// Bounds for smallest/largest possible scale to apply to contentminScale:0.2,maxScale:1.5});

If you wish to disable this behavior and do your own scaling (e.g. using media queries), try these settings:

Reveal.initialize({// ...width:"100%",height:"100%",margin:0,minScale:1,maxScale:1});

Dependencies

Reveal.js doesn'trely 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 <section> 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 <code> 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},// 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

To load these dependencies, reveal.js requireshead.js(a script loading library) to be loaded before reveal.js.

Ready Event

Aready 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 callReveal.isReady().

Reveal.addEventListener('ready',function(event){// event.currentSlide, event.indexh, event.indexv});

Note that we also add a.ready class to the.reveal element so that you can hook into this with CSS.

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:

// Slide every five secondsReveal.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 specifyingautoSlideStoppable: false in your reveal.js config.

You can also override the slide duration for individual slides and fragments by using thedata-autoslide attribute:

<sectiondata-autoslide="2000"><p>After 2 seconds the first fragment will be shown.</p><pclass="fragment"data-autoslide="10000">After 10 seconds the next fragment will be shown.</p><pclass="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p></section>

To override the method used for navigation when auto-sliding, you can specify theautoSlideMethod setting. To only navigate along the top layer and ignore vertical slides, set this toReveal.navigateRight.

Whenever the auto-slide mode is resumed or paused theautoslideresumed andautoslidepaused events are fired.

Keyboard Bindings

If you're unhappy with any of the default keyboard bindings you can override them using thekeyboard config option:

Reveal.configure({keyboard:{13:'next',// go to the next slide when the ENTER key is pressed27:function(){},// do something custom when ESC is pressed32: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 thetouch 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 adata-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 theviewDistance configuration option.

To enable lazy loading all you need to do is change yoursrc attributes todata-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.

<section><imgdata-src="image.png"><iframedata-src="http://hakim.se"></iframe><video><sourcedata-src="video.webm"type="video/webm"/><sourcedata-src="video.mp4"type="video/mp4"/></video></section>

API

TheReveal object exposes a JavaScript API for controlling navigation and reading state:

// NavigationReveal.slide(indexh,indexv,indexf);Reveal.left();Reveal.right();Reveal.up();Reveal.down();Reveal.prev();Reveal.next();Reveal.prevFragment();Reveal.nextFragment();// Randomize the order of slidesReveal.shuffle();// Toggle presentation states, optionally pass true/false to force on/offReveal.toggleOverview();Reveal.togglePause();Reveal.toggleAutoSlide();// Shows a help overlay with keyboard shortcuts, optionally pass true/false// to force on/offReveal.toggleHelp();// Change a config value at runtimeReveal.configure({controls:true});// Returns the present configuration optionsReveal.getConfig();// Fetch the current scale of the presentationReveal.getScale();// Retrieves the previous and current slide elementsReveal.getPreviousSlide();Reveal.getCurrentSlide();Reveal.getIndices();// { h: 0, v: 0, f: 0 }Reveal.getSlidePastCount();Reveal.getProgress();// (0 == first slide, 1 == last slide)Reveal.getSlides();// Array of all slidesReveal.getTotalSlides();// Total number of slides// Returns the speaker notes for the current slideReveal.getSlideNotes();// State checksReveal.isFirstSlide();Reveal.isLastSlide();Reveal.isOverview();Reveal.isPaused();Reveal.isAutoSliding();

Custom Key Bindings

Custom key bindings can be added and removed using the following Javascript API. Custom key bindings will override the default keyboard bindings, but will in turn be overridden by the user defined bindings in thekeyboard config option.

Reveal.addKeyBinding(binding,callback);Reveal.removeKeyBinding(keyCode);

For example

// The binding parameter provides the following properties//      keyCode: the keycode for binding to the callback//          key: the key label to show in the help overlay//  description: the description of the action to show in the help overlayReveal.addKeyBinding({keyCode:84,key:'T',description:'Start timer'},function(){// start timer})// The binding parameter can also be a direct keycode without providing the help descriptionReveal.addKeyBinding(82,function(){// reset timer})

This allows plugins to add key bindings directly to Reveal so they can

make use of Reveal's pre-processing logic for key handling (for example, ignoring key presses when paused); and
be included in the help overlay (optional)

Slide Changed Event

Aslidechanged 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), 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});

Presentation State

The presentation's current state can be fetched by using thegetState method. A state object contains all of the information required to put the presentation back as it was whengetState 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.

Reveal.slide(1);// we're on slide 1varstate=Reveal.getState();Reveal.slide(3);// we're on slide 3Reveal.setState(state);// we're back on slide 1

Slide States

If you setdata-state="somestate" on a slide<section>, "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 #"auto" data-snippet-clipboard-copy-content="Reveal.addEventListener( 'somestate', function() {// TODO: Sprinkle magic}, false );">

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 adata-background attribute to your<section> elements. Four different types of backgrounds are supported: color, image, video and iframe.

Color Backgrounds

All CSS color formats are supported, including hex values, keywords,rgba() orhsl().

<sectiondata-background-color="#ff0000"><h2>Color</h2></section>

Image Backgrounds

By default, background images are resized to cover the full page. Available options:

Attribute	Default	Description
data-background-image		URL of the image to show. GIFs restart when the slide opens.
data-background-size	cover	Seebackground-size on MDN.
data-background-position	center	Seebackground-position on MDN.
data-background-repeat	no-repeat	Seebackground-repeat on MDN.
data-background-opacity	1	Opacity of the background image on a 0-1 scale. 0 is transparent and 1 is fully opaque.

<sectiondata-background-image="http://example.com/image.png"><h2>Image</h2></section><sectiondata-background-image="http://example.com/image.png"data-background-size="100px"data-background-repeat="repeat"><h2>This background image will be sized to 100px and repeated</h2></section>

Video Backgrounds

Automatically plays a full size video behind the slide.

Attribute	Default	Description
data-background-video		A single video source, or a comma separated list of video sources.
data-background-video-loop	false	Flags if the video should play repeatedly.
data-background-video-muted	false	Flags if the audio should be muted.
data-background-size	cover	Use`cover` for full screen and some cropping or`contain` for letterboxing.
data-background-opacity	1	Opacity of the background video on a 0-1 scale. 0 is transparent and 1 is fully opaque.

<sectiondata-background-video="https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.mp4,https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.webm"data-background-video-loopdata-background-video-muted><h2>Video</h2></section>

Iframe Backgrounds

Embeds a web page as a slide background that covers 100% of the reveal.js width and height. The iframe is in the background layer, behind your slides, and as such it's not possible to interact with it by default. To make your background interactive, you can add thedata-background-interactive attribute.

<sectiondata-background-iframe="https://slides.com"data-background-interactive><h2>Iframe</h2></section>

Background Transitions

Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passingbackgroundTransition: 'slide' to theReveal.initialize() call. Alternatively you can setdata-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 properties below when initializing reveal.js (the other two are optional).

Reveal.initialize({// Parallax background imageparallaxBackgroundImage:'',// e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"// Parallax background sizeparallaxBackgroundSize:'',// CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)// Number of pixels to move the parallax background per slide// - Calculated automatically unless specified// - Set to 0 to disable movement along an axisparallaxBackgroundHorizontal:200,parallaxBackgroundVertical:50});

Make sure that the background size is much bigger than screen size to allow for some scrolling.View example.

Slide Transitions

The global presentation transition is set using thetransition config value. You can override the global transition for a specific slide by using thedata-transition attribute:

<sectiondata-transition="zoom"><h2>This slide will override the presentation transition and zoom!</h2></section><sectiondata-transition-speed="fast"><h2>Choose from three transition speeds: default, fast or slow!</h2></section>

You can also use different in and out transitions for the same slide:

<sectiondata-transition="slide">    The train goes on …</section><sectiondata-transition="slide">    and on …</section><sectiondata-transition="slide-in fade-out">    and stops.</section><sectiondata-transition="fade-in slide-out">    (Passengers entering and leaving)</section><sectiondata-transition="slide">    And it starts again.</section>

You can choose fromnone,fade,slide,convex,concave andzoom.

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 (<section>):

<ahref="#/2/2">Link</a><ahref="#/some-slide">Link</a>

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 anenabled class when it's a valid navigation route based on the current slide.

<ahref="#"class="navigate-left"><ahref="#"class="navigate-right"><ahref="#"class="navigate-up"><ahref="#"class="navigate-down"><ahref="#"class="navigate-prev"><!-- Previous vertical or horizontal slide --><ahref="#"class="navigate-next"><!-- Next vertical or horizontal slide -->

Fragments

Fragments are used to highlight individual elements on a slide. Every element with the classfragment will be stepped through before moving on to the next slide. Here's an example:http://revealjs.com/#/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:

<section><pclass="fragment grow">grow</p><pclass="fragment shrink">shrink</p><pclass="fragment fade-out">fade-out</p><pclass="fragment fade-up">fade-up (also down, left and right!)</p><pclass="fragment fade-in-then-out">fades in, then out when we move to the next step</p><pclass="fragment fade-in-then-semi-out">fades in, then obfuscate when we move to the next step</p><pclass="fragment highlight-current-blue">blue only once</p><pclass="fragment highlight-red">highlight-red</p><pclass="fragment highlight-green">highlight-green</p><pclass="fragment highlight-blue">highlight-blue</p></section>

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.

<section><spanclass="fragment fade-in"><spanclass="fragment fade-out">I'll fade in, then out</span></span></section>

The display order of fragments can be controlled using thedata-fragment-index attribute.

<section><pclass="fragment"data-fragment-index="3">Appears last</p><pclass="fragment"data-fragment-index="1">Appears first</p><pclass="fragment"data-fragment-index="2">Appears second</p></section>

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.

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 withhighlight.js for code syntax highlighting. To enable syntax highlighting, you'll have to load the highlight plugin (plugin/highlight/highlight.js) and a highlight.js CSS theme (Reveal comes packaged with the zenburn theme:lib/css/zenburn.css).

Reveal.initialize({// More info https://github.com/hakimel/reveal.js#dependenciesdependencies:[{src:'plugin/highlight/highlight.js',async:true,callback:function(){hljs.initHighlightingOnLoad();}},]});

Below is an example with clojure code that will be syntax highlighted. When thedata-trim attribute is present, surrounding whitespace is automatically removed. HTML will be escaped by default. To avoid this, for example if you are using<mark> to call out a line of code, add thedata-noescape attribute to the<code> element.

<section><pre><codedata-trimdata-noescape>(def lazy-fib  (concat   [0 1]<mark>((fn rfib [a b]</mark>        (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))</code></pre></section>

Slide number

If you would like to display the page number of the current slide you can do so using theslideNumber andshowSlideNumber configuration values.

// Shows the slide number using default formattingReveal.configure({slideNumber:true});// Slide number formatting can be configured using these variables://  "h.v": horizontal . vertical slide number (default)//  "h/v": horizontal / vertical slide number//    "c": flattened slide number//  "c/t": flattened slide number / total slidesReveal.configure({slideNumber:'c/t'});// Control which views the slide number displays on using the "showSlideNumber" value://     "all": show on all views (default)// "speaker": only show slide numbers on speaker notes view//   "print": only show slide numbers when printing to PDFReveal.configure({showSlideNumber:'speaker'});

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:

Reveal.addEventListener('overviewshown',function(event){/* ... */});Reveal.addEventListener('overviewhidden',function(event){/* ... */});// Toggle the overview mode programmaticallyReveal.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

Adddata-autoplay to your media element if you want it to automatically start playing when the slide is shown:

<videodata-autoplaysrc="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>

If you want to enable or disable autoplay globally, for all embedded media, you can use theautoPlayMedia configuration option. If you set this totrue ALL media will autoplay regardless of individualdata-autoplay attributes. If you initialize withautoPlayMedia: false NO media will autoplay.

Note that embedded HTML5<video>/<audio> and YouTube/Vimeo iframes are automatically paused when you navigate away from a slide. This can be disabled by decorating your element with adata-ignore attribute.

Embedded iframes

reveal.js automatically pushes twopost messages to embedded iframes.slide:start when the slide containing the iframe is made visible andslide:stop when it is hidden.

Stretching elements

Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the.stretch class to an element as seen below:

<section><h2>This video will use up the remaining space on the slide</h2><videoclass="stretch"src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video></section>

Limitations:

Only direct descendants of a slide section can be stretched
Only one descendant per slide section can be stretched

postMessage API

The framework has a built-in postMessage API that can be used when communicating with a presentation inside of another window. Here's an example showing how you'd make a reveal.js instance in the given window proceed to slide 2:

<window>.postMessage( JSON.stringify({method:'slide',args:[2]}), '*' );

When reveal.js runs inside of an iframe it can optionally bubble all of its events to the parent. Bubbled events are stringified JSON with three fields: namespace, eventName and state. Here's how you subscribe to them from the parent window:

window.addEventListener('message',function(event){vardata=JSON.parse(event.data);if(data.namespace==='reveal'&&data.eventName==='slidechanged'){// Slide changed, see data.state for slide number}});

This cross-window messaging can be toggled on or off using configuration flags.

Reveal.initialize({// ...// Exposes the reveal.js API through window.postMessagepostMessage:true,// Dispatches all reveal.js events to the parent window through postMessagepostMessageEvents:false});

PDF Export

Presentations can be exported to PDF via a special print stylesheet. This feature requires that you useGoogle Chrome orChromium and to be serving the presentation from a webserver.Here's an example of an exported presentation that's been uploaded to SlideShare:http://www.slideshare.net/hakimel/revealjs-300.

Separate pages for fragments

Fragments are printed on separate slides by default. Meaning if you have a slide with three fragment steps, it will generate three separate slides where the fragments appear incrementally.

If you prefer printing all fragments in their visible states on the same slide you can set thepdfSeparateFragments config option to false.

Page size

Export dimensions are inferred from the configuredpresentation size. Slides that are too tall to fit within a single page will expand onto multiple pages. You can limit how many pages a slide may expand onto using thepdfMaxPagesPerSlide config option, for exampleReveal.configure({ pdfMaxPagesPerSlide: 1 }) ensures that no slide ever grows to more than one printed page.

Print stylesheet

To enable the PDF print capability in your presentation, the special print stylesheet at/css/print/pdf.css must be loaded. The default index.html file handles this for you whenprint-pdf is included in the query string. If you're using a different HTML template, you can add this to your HEAD:

<script>varlink=document.createElement('link');link.rel='stylesheet';link.type='text/css';link.href=window.location.search.match(/print-pdf/gi) ?'css/print/pdf.css' :'css/print/paper.css';document.getElementsByTagName('head')[0].appendChild(link);</script>

Instructions

Open your presentation withprint-pdf included in the query string i.e.http://localhost:8000/?print-pdf. You can test this withrevealjs.com?print-pdf.

If you want to includespeaker notes in your export, you can appendshowNotes=true to the query string:http://localhost:8000/?print-pdf&showNotes=true

Open the in-browser print dialog (CTRL/CMD+P).
Change theDestination setting toSave as PDF.
Change theLayout toLandscape.
Change theMargins toNone.
Enable theBackground graphics option.
ClickSave.

Alternatively you can use thedecktape project.

Theming

The framework comes with a few different themes included:

black: Black background, white text, blue links (default theme)
white: White background, black text, blue links
league: Gray background, white text, blue links (default theme for reveal.js < 3.0.0)
beige: Beige background, dark text, brown links
sky: Blue background, thin dark 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
solarized: Cream-colored background, dark green text, blue links

Each theme is available as a separate stylesheet. To change theme you will need to replaceblack below with your desired theme name in index.html:

<linkrel="stylesheet"href="css/theme/black.css"id="theme">

If you want to add a theme of your own see the instructions here:/css/theme/README.md.

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. Press the »S« key on your keyboard to open the notes window.

A speaker timer starts as soon as the speaker view is opened. You can reset it to 00:00:00 at any time by simply clicking/tapping on it.

Notes are defined by appending an<aside> element to a slide as seen below. You can add thedata-markdown attribute to the aside element if you prefer writing notes using Markdown.

Alternatively you can add your notes in adata-notes attribute on the slide. Like<section data-notes="Something important"></section>.

When used locally, this feature requires that reveal.jsruns from a local web server.

<section><h2>Some Slide</h2><asideclass="notes">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).</aside></section>

If you're using the external Markdown plugin, you can add notes with the help of a special delimiter:

<sectiondata-markdown="example.md"data-separator="^\n\n\n"data-separator-vertical="^\n\n"data-separator-notes="^Note:"></section># Title## Sub-titleHere is some content...Note:This will only display in the notes window.

Share and Print Speaker Notes

Notes are only visible to the speaker inside of the speaker view. If you wish to share your notes with others you can initialize reveal.js with theshowNotes configuration value set totrue. Notes will appear along the bottom of the presentations.

WhenshowNotes is enabled notes are also included when youexport to PDF. By default, notes are printed in a semi-transparent box on top of the slide. If you'd rather print them on a separate page after the slide, setshowNotes: "separate-page".

Speaker notes clock and timers

The speaker notes window will also show:

Time elapsed since the beginning of the presentation. If you hover the mouse above this section, a timer reset button will appear.
Current wall-clock time
(Optionally) a pacing timer which indicates whether the current pace of the presentation is on track for the right timing (shown in green), and if not, whether the presenter should speed up (shown in red) or has the luxury of slowing down (blue).

The pacing timer can be enabled by configuring by thedefaultTiming parameter in theReveal configuration block, which specifies the number of seconds per slide. 120 can be a reasonable rule of thumb. Timings can also be given per slide<section> by setting thedata-timing attribute. Both values are in numbers of seconds.

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:

InstallNode.js (4.0.0 or later)
Runnpm install
Runnode plugin/notes-server

Multiplexing

The multiplex plugin allows your audience to view the slides of the presentation you are controlling on their own phone, tablet or laptop. As the master presentation navigates the slides, all client presentations will update in real time. See a demo athttps://reveal-js-multiplex-ccjbegmaii.now.sh/.

The multiplex plugin needs the following 3 things to operate:

Master presentation that has control
Client presentations that follow the master
Socket.io server to broadcast events from the master to the clients

Master presentation

Served from a static file server accessible (preferably) only to the presenter. This need only be on your (the presenter's) computer. (It's safer to run the master presentation from your own computer, so if the venue's Internet goes down it doesn't stop the show.) An example would be to execute the following commands in the directory of your master presentation:

npm install node-static
static

If you want to use the speaker notes plugin with your master presentation then make sure you have the speaker notes plugin configured correctly along with the configuration shown below, then executenode plugin/notes-server in the directory of your master presentation. The configuration below will cause it to connect to the socket.io server as a master, as well as launch your speaker-notes/static-file server.

You can then access your master presentation athttp://localhost:1947

Example configuration:

Reveal.initialize({// other options...multiplex:{// Example values. To generate your own, see the socket.io server instructions.secret:'13652805320794272084',// Obtained from the socket.io server. Gives this (the master) control of the presentationid:'1ea875674b17ca76',// Obtained from socket.io serverurl:'https://reveal-js-multiplex-ccjbegmaii.now.sh'// Location of socket.io server},// Don't forget to add the dependenciesdependencies:[{src:'//cdn.socket.io/socket.io-1.3.5.js',async:true},{src:'plugin/multiplex/master.js',async:true},// and if you want speaker notes{src:'plugin/notes-server/client.js',async:true}// other dependencies...]});

Client presentation

Served from a publicly accessible static file server. Examples include: GitHub Pages, Amazon S3, Dreamhost, Akamai, etc. The more reliable, the better. Your audience can then access the client presentation viahttp://example.com/path/to/presentation/client/index.html, with the configuration below causing them to connect to the socket.io server as clients.

Example configuration:

Reveal.initialize({// other options...multiplex:{// Example values. To generate your own, see the socket.io server instructions.secret:null,// null so the clients do not have control of the master presentationid:'1ea875674b17ca76',// id, obtained from socket.io serverurl:'https://reveal-js-multiplex-ccjbegmaii.now.sh'// Location of socket.io server},// Don't forget to add the dependenciesdependencies:[{src:'//cdn.socket.io/socket.io-1.3.5.js',async:true},{src:'plugin/multiplex/client.js',async:true}// other dependencies...]});

Socket.io server

Server that receives theslideChanged events from the master presentation and broadcasts them out to the connected client presentations. This needs to be publicly accessible. You can run your own socket.io server with the commands:

npm install
node plugin/multiplex

Or you can use the socket.io server athttps://reveal-js-multiplex-ccjbegmaii.now.sh/.

You'll need to generate a unique secret and token pair for your master and client presentations. To do so, visithttp://example.com/token, wherehttp://example.com is the location of your socket.io server. Or if you're going to use the socket.io server athttps://reveal-js-multiplex-ccjbegmaii.now.sh/, visithttps://reveal-js-multiplex-ccjbegmaii.now.sh/token.

You are very welcome to point your presentations at the Socket.io server running athttps://reveal-js-multiplex-ccjbegmaii.now.sh/, but availability and stability are not guaranteed.

For anything mission critical I recommend you run your own server. The easiest way to do this is by installingnow. With that installed, deploying your own Multiplex server is as easy running the following command from the reveal.js folder:now plugin/multiplex.

socket.io server as file static server

The socket.io server can play the role of static file server for your client presentation, as in the example athttps://reveal-js-multiplex-ccjbegmaii.now.sh/. (Openhttps://reveal-js-multiplex-ccjbegmaii.now.sh/ in two browsers. Navigate through the slides on one, and the other will update to match.)

Example configuration:

Reveal.initialize({// other options...multiplex:{// Example values. To generate your own, see the socket.io server instructions.secret:null,// null so the clients do not have control of the master presentationid:'1ea875674b17ca76',// id, obtained from socket.io serverurl:'example.com:80'// Location of your socket.io server},// Don't forget to add the dependenciesdependencies:[{src:'//cdn.socket.io/socket.io-1.3.5.js',async:true},{src:'plugin/multiplex/client.js',async:true}// other dependencies...]

It can also play the role of static file server for your master presentation and client presentations at the same time (as long as you don't want to use speaker notes). (Openhttps://reveal-js-multiplex-ccjbegmaii.now.sh/ in two browsers. Navigate through the slides on one, and the other will update to match. Navigate through the slides on the second, and the first will update to match.) This is probably not desirable, because you don't want your audience to mess with your slides while you're presenting. ;)

Example configuration:

Reveal.initialize({// other options...multiplex:{// Example values. To generate your own, see the socket.io server instructions.secret:'13652805320794272084',// Obtained from the socket.io server. Gives this (the master) control of the presentationid:'1ea875674b17ca76',// Obtained from socket.io serverurl:'example.com:80'// Location of your socket.io server},// Don't forget to add the dependenciesdependencies:[{src:'//cdn.socket.io/socket.io-1.3.5.js',async:true},{src:'plugin/multiplex/master.js',async:true},{src:'plugin/multiplex/client.js',async:true}// other dependencies...]});

MathJax

If you want to display math equations in your presentation you can easily do so by including this plugin. The plugin is a very thin wrapper around theMathJax library. To use it you'll need to include it as a reveal.js dependency,find our more about dependencies here.

The plugin defaults to usingLaTeX but that can be adjusted through themath configuration object. Note that MathJax is loaded from a remote server. If you want to use it offline you'll need to download a copy of the library and adjust themathjax configuration value.

Below is an example of how the plugin can be configured. If you don't intend to change these values you do not need to include themath config object at all.

Reveal.initialize({// other options ...math:{mathjax:'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js',config:'TeX-AMS_HTML-full'// See http://docs.mathjax.org/en/latest/config-files.html},dependencies:[{src:'plugin/math/math.js',async:true}]});

Read MathJax's documentation if you needHTTPS delivery or serving ofspecific versions for stability.

Installation

Thebasic setup is for authoring presentations only. Thefull setup gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.

Basic setup

The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.

Download the latest version of reveal.js fromhttps://github.com/hakimel/reveal.js/releases
Unzip and replace the example contents in index.html with your own
Open index.html in a browser to view it

Full setup

Some reveal.js features, like external Markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.

InstallNode.js (4.0.0 or later)

Clone the reveal.js repository

$ git clone https://github.com/hakimel/reveal.js.git

Navigate to the reveal.js folder
```
$cd reveal.js
```
Install dependencies
```
$ npm install
```
Serve the presentation and monitor source files for changes
```
$ npm start
```
Openhttp://localhost:8000 to view your presentation
You can change the port by usingnpm start -- --port=8001.

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

MIT licensed

About

This is a demo revealjs

Releases

No releases published

Packages

No packages published

Movatterモバイル変換

License

moinuddin14/DemoRevealJs

Folders and files

Latest commit

History

Repository files navigation

reveal.js

Table of contents

More reading

Online Editor

Instructions

Markup

Markdown

External Markdown

Element Attributes

Slide Attributes

Configuringmarked

Configuration

Presentation Size

Dependencies

Ready Event

Auto-sliding

Keyboard Bindings

Touch Navigation

Lazy Loading

API

Custom Key Bindings

Slide Changed Event

Presentation State

Slide States

Slide Backgrounds

Color Backgrounds

Image Backgrounds

Video Backgrounds

Iframe Backgrounds

Background Transitions

Parallax Background

Slide Transitions

Internal links

Fragments

Fragment events

Code syntax highlighting

Slide number

Overview mode

Fullscreen mode

Embedded media

Embedded iframes

Stretching elements

postMessage API

PDF Export

Separate pages for fragments

Page size

Print stylesheet

Instructions

Theming

Speaker Notes

Share and Print Speaker Notes

Speaker notes clock and timers

Server Side Speaker Notes

Multiplexing

Master presentation

Client presentation

Socket.io server

socket.io server as file static server

MathJax

Installation

Basic setup

Full setup

Folder Structure

License

About

Resources

License

Stars

Watchers

Forks

Releases

Packages0

Languages

Packages