diff --git a/Gruntfile.js b/Gruntfile.js index 892469a..4df3181 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -17,7 +17,7 @@ module.exports = function(grunt) { // Tests will be added soon qunit: { - files: [ 'test/**/*.html' ] + files: [ 'test/*.html' ] }, uglify: { @@ -109,6 +109,7 @@ module.exports = function(grunt) { }); // Dependencies + grunt.loadNpmTasks( 'grunt-contrib-qunit' ); grunt.loadNpmTasks( 'grunt-contrib-jshint' ); grunt.loadNpmTasks( 'grunt-contrib-cssmin' ); grunt.loadNpmTasks( 'grunt-contrib-uglify' ); @@ -118,7 +119,7 @@ module.exports = function(grunt) { grunt.loadNpmTasks( 'grunt-zip' ); // Default task - grunt.registerTask( 'default', [ 'jshint', 'cssmin', 'uglify' ] ); + grunt.registerTask( 'default', [ 'jshint', 'cssmin', 'uglify', 'qunit' ] ); // Theme task grunt.registerTask( 'themes', [ 'sass' ] ); @@ -129,4 +130,7 @@ module.exports = function(grunt) { // Serve presentation locally grunt.registerTask( 'serve', [ 'connect', 'watch' ] ); + // Run tests + grunt.registerTask( 'test', [ 'jshint', 'qunit' ] ); + }; diff --git a/README.md b/README.md index 56d4dee..fd4254b 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,10 @@ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Iri #### 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. +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. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file. ```html -
+
``` ### Configuration @@ -100,9 +100,6 @@ Reveal.initialize({ // Enable slide navigation via mouse wheel mouseWheel: false, - // Apply a 3D roll to links on hover - rollingLinks: true, - // Transition style transition: 'default', // default/cube/page/concave/zoom/linear/fade/none @@ -110,7 +107,7 @@ Reveal.initialize({ transitionSpeed: 'default', // default/fast/slow // Transition style for full page backgrounds - backgroundTransition: 'default' // default/linear + backgroundTransition: 'default' // default/linear/none }); ``` @@ -153,7 +150,10 @@ Reveal.initialize({ { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }, // Remote control your reveal.js presentation using a touch device - { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } } + { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }, + + // MathJax + { src: 'plugin/math/math.js', async: true } ] }); ``` @@ -370,6 +370,8 @@ The display order of fragments can be controlled using the ```data-fragment-inde 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. + ```javascript Reveal.addEventListener( 'fragmentshown', function( event ) { // event.fragment = the fragment DOM element @@ -398,7 +400,7 @@ By default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/ ### Overview mode -Press "Esc" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides, +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: ```javascript @@ -414,7 +416,7 @@ Just press »F« on your keyboard to show your presentation in fullscreen mode. ### Embedded media -Embedded HTML5 `