From: Ting-Yu Lin Date: Tue, 15 Oct 2013 15:07:40 +0000 (+0800) Subject: Add various configuration options to README X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=4bea9bc7a8ffd059d6847e5db09f53f883ddeb40;p=reveal.js.git Add various configuration options to README Also add a description about the solarized theme. --- diff --git a/README.md b/README.md index 8e2cc1e..2e302b7 100644 --- a/README.md +++ b/README.md @@ -77,21 +77,28 @@ Reveal.initialize({ // Enable keyboard shortcuts for navigation keyboard: true, - // Enable touch events for navigation - touch: 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, + // 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 @@ -103,14 +110,23 @@ Reveal.initialize({ // 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', // default/cube/page/concave/zoom/linear/fade/none // Transition speed transitionSpeed: 'default', // default/fast/slow - // Transition style for full page backgrounds - backgroundTransition: 'default' // default/linear/none + // Transition style for full page slide backgrounds + backgroundTransition: 'default', // default/linear/none + + // 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'" @@ -520,6 +536,7 @@ The framework comes with a few different themes included: - 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 replace **default** below with your desired theme name in index.html: diff --git a/js/reveal.js b/js/reveal.js index 777f4ab..7748bf4 100644 --- a/js/reveal.js +++ b/js/reveal.js @@ -44,7 +44,7 @@ var Reveal = (function(){ // Enable the slide overview mode overview: true, - // Vertical centring of slides + // Vertical centering of slides center: true, // Enables touch navigation on devices with touch input