Merge pull request #567 from hakimel/dev
authorHakim El Hattab <hakim.elhattab@gmail.com>
Wed, 21 Aug 2013 03:14:22 +0000 (20:14 -0700)
committerHakim El Hattab <hakim.elhattab@gmail.com>
Wed, 21 Aug 2013 03:14:22 +0000 (20:14 -0700)
2.5.0

1  2 
README.md

diff --cc README.md
index 56d4dee4e7dacd81ffee7abc8a076237e76dff36,77b594c6066f873fe761a429906032de41044c5c..a97546c53f503ce8c548544133d68c45943dedb2
+++ b/README.md
@@@ -663,15 -700,46 +700,46 @@@ Reveal.initialize(
                naturalSwipe   : false,    // Invert swipe gestures
                pointerOpacity : 0.5,      // Set pointer opacity to 0.5
                pointerColor   : '#d80000' // Red pointer
-       }
+       },
+       dependencies: [
+               { src: 'plugin/leap/leap.js', async: true }
+       ]
+ });
+ ```
+ ## MathJax
+ If you want to display math equations in your presentation you can easily do so by including this plugin. The plugin is a very thin wrapper around the [MathJax](http://www.mathjax.org/) library. To use it you'll need to include it as a reveal.js dependency, [find our more about dependencies here](#dependencies).
+ The plugin defaults to using [LaTeX](http://en.wikipedia.org/wiki/LaTeX) but that can be adjusted through the ```math``` configuration object. Note that MathJax is loaded from a remote server. If you want to use it offline you'll need to download a copy of the library and adjust the ```mathjax``` configuration value. 
+ Below is an example of how the plugin can be configured. If you don't intend to change these values you do not need to include the ```math``` config object at all.
+ ```js
+ Reveal.initialize({
+       // other options ...
+       math: {
+               mathjax: 'http://cdn.mathjax.org/mathjax/latest/MathJax.js',
+               config: 'TeX-AMS_HTML-full'  // See http://docs.mathjax.org/en/latest/config-files.html
+       },
        
-       // Optional libraries used to extend on reveal.js
-       { src: 'plugin/leap/leap.js', async: true }
+       dependencies: [
+               { src: 'plugin/math/math.js', async: true }
+       ]
+ });
  ```
  
+ Read MathJax's documentation if you want [secure delivery](http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn) or serve [specific versons](http://docs.mathjax.org/en/latest/configuration.html#loading-mathjax-from-the-cdn) for stabilty.
  ## Installation
  
 -The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features as well as the development tasks needed to make changes to the source.
 +The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
  
  ### Basic setup