https://github.com/dashed/mathjax-lazyload
Delays loading of MathJax Tex elements
https://github.com/dashed/mathjax-lazyload
Last synced: 7 months ago
JSON representation
Delays loading of MathJax Tex elements
- Host: GitHub
- URL: https://github.com/dashed/mathjax-lazyload
- Owner: dashed
- License: mit
- Created: 2013-09-29T09:21:59.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-10-22T04:05:22.000Z (over 12 years ago)
- Last Synced: 2025-07-15T16:39:48.315Z (7 months ago)
- Language: JavaScript
- Homepage: http://dashed.github.io/mathjax-lazyload/
- Size: 523 KB
- Stars: 16
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
mathjax-lazyload
================
By default MathJax renders (typeset) all math elements on a page.
This can freeze the browser for a while especially if there are many math elments to render.
`mathjax-lazyload.js` delays typesetting of MathJax elements until it comes into view of the browser.
Install
=======
Download from the [project page](https://github.com/Dashed/mathjax-lazyload/).
Install with [Bower](http://bower.io/): `bower install mathjax-lazyload`
Prerequisites
=============
1. [jQuery](http://jquery.com/)
2. [MathJax](http://mathjax.org)
Usage
=====
`mathjax-lazyload.js` may be placed anywhere where it can properly execute.
The script will automatically detect MathJax and jQuery. This allows the possibility for MathJax and/or jQuery to be dynamically loaded.
```HTML
MathJax.Hub.Config({
skipStartupTypeset: true,
lazytex2jax: {
displayMath: [['$$','$$'], ['\\[','\\]']],
inlineMath: [['\\(','\\)']],
},
});
```
## MathJax Configuration
mathjax-lazyload always require the following configuration conditions to run:
1. `skipStartupTypeset: true`
2. `lazytex2jax` is a defined object
### lazytex2jax configuration
The `lazytex2jax` configuration property is **not** a native configuration property of MathJax. It is however a configuration property of **mathjax-lazyload**.
The `inlineMath` and `displayMath` properties of `lazytex2jax` are in the same format as it is in `tex2jax` (a configuration property of MathJax). See [tex2jax config options](http://docs.mathjax.org/en/latest/options/tex2jax.html).
The `lazytex2jax` configuration property needs to be manually defined by the user.
### lazytex2jax properties
* `inlineMath`
Array of pairs of strings that are to be used as in-line math delimiters. The first in each pair is the initial delimiter and the second is the terminal delimiter. You can have as many pairs as you want.
```
inlineMath: [ ['$','$'], ['\\(','\\)'] ]
```
* `displayMath`
Array of pairs of strings that are to be used as delimiters for displayed equations. The first in each pair is the initial delimiter and the second is the terminal delimiter. You can have as many pairs as you want.
```
displayMath: [ ['$$','$$'], ['\[','\]'] ]
```
Limitations
===========
1. MathJax's start typeset will need to be disabled because typesetting the page and converting math elements into a 'lazy state' will collide. Usually MathJax typesets the before mathjax-lazyload can do anything.
2. It isn't possible for mathjax-lazyload to automatically detect default math delimiters because configurations for these are loaded dynamically during typesetting. Since MathJax's startup typeset needs to be disabled (see above point), no extra configuration is loaded. Therefore users will need to manually tell mathjax-lazyload what kind of math delimiters to look for.
Changelog
=========
## 1.0.2 [Oct 2, 2013]
* Release mathjax-lazyload to bower. No official build changes, thus the build is still 1.0.1.
## 1.0.1 [Sep 29, 2013]
* Remove dependence on XRegExp (3rd party regex lib)
* Added more tags to avoid when finding MathJax elements to lazy load.
**Avoided tags:** image, code, audio, input, textarea, button
* Minor build script improvement
## 1.0.0 [Sep 29, 2013]
* First commit
License
=======
MIT-License