aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index d24f438..4375933 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,7 @@ At the end of your page you need to initialize reveal by running the following c
```javascript
Reveal.initialize({
+
// Display controls in the bottom right corner
controls: true,
@@ -92,11 +93,41 @@ Reveal.initialize({
// Transition style
transition: 'default' // default/cube/page/concave/zoom/linear/fade/none
+
});
```
Note that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`.
+
+### 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.0
+
+});
+```
+
+
### 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:
@@ -239,6 +270,16 @@ Multiple fragments can be applied to the same element sequentially by wrapping i
</section>
```
+The display order of fragments can be controlled using the ```data-fragment-index``` attribute.
+
+```html
+<section>
+ <p class="fragment" data-fragment-index="3">Appears last</p>
+ <p class="fragment" data-fragment-index="1">Appears first</p>
+ <p class="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.
@@ -370,5 +411,5 @@ If you want to customise reveal.js without running grunt.js you can alter the HT
MIT licensed
-Copyright (C) 2011-2013 Hakim El Hattab, http://hakim.se
+Copyright (C) 2013 Hakim El Hattab, http://hakim.se