Add various configuration options to README
authorTing-Yu Lin <aethanyc@gmail.com>
Tue, 15 Oct 2013 15:07:40 +0000 (23:07 +0800)
committerTing-Yu Lin <aethanyc@gmail.com>
Thu, 17 Oct 2013 04:08:43 +0000 (12:08 +0800)
Also add a description about the solarized theme.

README.md
js/reveal.js

index 8e2cc1e7c0cba24ad18ab29d1caf8429e4d48746..2e302b72d950a4a1b62d2b14bee89c9ff58e7241 100644 (file)
--- 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:
 
index 777f4ab7074c7538b5a2ac430088592f890cf103..7748bf4711891e2d12893fc6d9c9db4923b910f0 100644 (file)
@@ -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