diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 85 |
1 files changed, 69 insertions, 16 deletions
@@ -11,7 +11,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/ - [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. -## Slides +## 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://slid.es](http://slid.es). @@ -77,46 +77,62 @@ 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 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', // 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'" // Parallax background size - parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - - // Number of slides away from the current that are visible - viewDistance: 3, + parallaxBackgroundSize: '' // CSS syntax, e.g. "2100px 900px" }); @@ -202,6 +218,27 @@ Reveal.initialize({ }); ``` + +### Auto-sliding + +Presentations can be configure 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. Sliding is also 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 by using the ```data-autoslide``` attribute on individual sections: + +```html +<section data-autoslide="10000">This will remain on screen for 10 seconds</section> +``` + + ### Keyboard Bindings If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option: @@ -362,7 +399,7 @@ You can also add relative navigation links, similar to the built in reveal.js co ### 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/#/16 +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: @@ -496,6 +533,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: @@ -789,22 +827,22 @@ Some reveal.js features, like external markdown, require that presentations run 2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli) 4. Clone the reveal.js repository -``` -$ git clone git@github.com:hakimel/reveal.js.git +```sh +$ git clone https://github.com/hakimel/reveal.js.git ``` 5. Navigate to the reveal.js folder -``` +```sh $ cd reveal.js ``` 6. Install dependencies -``` +```sh $ npm install ``` 7. Serve the presentation and monitor source files for changes -``` +```sh $ grunt serve ``` @@ -820,6 +858,21 @@ You can change the port by using `grunt serve --port 8001`. - **lib/** All other third party assets (JavaScript, CSS, fonts) +### Contributing + +Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue. + +If you have personal support questions use [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js). + + +#### 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) + ## License |