From: Hakim El Hattab Date: Sun, 18 Aug 2013 18:43:04 +0000 (-0400) Subject: math plugin doc update X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=62049d1b6d1d2fcf298237a0f26864dd48fa00ab;p=reveal.js.git math plugin doc update --- diff --git a/README.md b/README.md index 7599d67..5a3d014 100644 --- a/README.md +++ b/README.md @@ -680,11 +680,13 @@ Reveal.initialize({ }); ``` -## MathJax Plugin +## 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 include it, append the following into the dependencies object to your ```Reveal.initialize()``` call: ```{ src: '../plugin/math/math.js', async: true }```. [Find our more about dependencies](#Dependencies). +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 include it, append the following into the ```Reveal.initialize()``` dependency list: ```{ src: 'plugin/math/math.js', async: true }```. [Find our more about dependencies](#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. Here's an example of how the plugin may be configured: +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({