document math plugin
This commit is contained in:
		
							
								
								
									
										36
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								README.md
									
									
									
									
									
								
							| @@ -150,7 +150,10 @@ Reveal.initialize({ | |||||||
| 		{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }, | 		{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }, | ||||||
|  |  | ||||||
| 		// Remote control your reveal.js presentation using a touch device | 		// 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 } | ||||||
| 	] | 	] | ||||||
| }); | }); | ||||||
| ``` | ``` | ||||||
| @@ -661,17 +664,44 @@ You can edit the following options: | |||||||
| Example configuration: | Example configuration: | ||||||
| ```js | ```js | ||||||
| Reveal.initialize({ | Reveal.initialize({ | ||||||
| 	// other options |  | ||||||
|  | 	// other dependencies... | ||||||
|  |  | ||||||
| 	leap: { | 	leap: { | ||||||
| 		naturalSwipe   : false,    // Invert swipe gestures | 		naturalSwipe   : false,    // Invert swipe gestures | ||||||
| 		pointerOpacity : 0.5,      // Set pointer opacity to 0.5 | 		pointerOpacity : 0.5,      // Set pointer opacity to 0.5 | ||||||
| 		pointerColor   : '#d80000' // Red pointer | 		pointerColor   : '#d80000' // Red pointer | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	// Optional libraries used to extend on reveal.js | 	dependencies: [ | ||||||
| 		{ src: 'plugin/leap/leap.js', async: true } | 		{ src: 'plugin/leap/leap.js', async: true } | ||||||
|  | 	] | ||||||
|  |  | ||||||
|  | }); | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## MathJax Plugin | ||||||
|  |  | ||||||
|  | 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). | ||||||
|  |  | ||||||
|  | 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: | ||||||
|  |  | ||||||
|  | ```js | ||||||
|  | Reveal.initialize({ | ||||||
|  |  | ||||||
|  | 	// other options ... | ||||||
|  |  | ||||||
|  | 	math: { | ||||||
|  | 		mathjax: 'http://cdn.mathjax.org/mathjax/latest/MathJax.js', | ||||||
|  |  | ||||||
|  | 		// See http://docs.mathjax.org/en/latest/config-files.html | ||||||
|  | 		config: 'TeX-AMS_HTML-full' | ||||||
|  | 	} | ||||||
|  |  | ||||||
|  | }); | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  |  | ||||||
| ## Installation | ## 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 as well as the development tasks needed to make changes to the source. | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user