https://github.com/nteract/mathjax-electron
:symbols::electron: A trimmed down version of the MathJax library for use with electron and modern browsers
https://github.com/nteract/mathjax-electron
Last synced: about 2 months ago
JSON representation
:symbols::electron: A trimmed down version of the MathJax library for use with electron and modern browsers
- Host: GitHub
- URL: https://github.com/nteract/mathjax-electron
- Owner: nteract
- License: mit
- Created: 2016-04-11T19:31:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T06:21:18.000Z (over 2 years ago)
- Last Synced: 2025-03-30T21:02:26.769Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 6.09 MB
- Stars: 28
- Watchers: 7
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mathjax-electron
A trimmed down version of the [MathJax](https://www.mathjax.org/) library for use with electron and modern browsers.
`mathjax-electron` allows you to render math inside your application while keeping the package size at a minimum. To achieve this we provide a preconfigured MathJax environment with only the necessary bits of the MathJax Library included.
The package size is ~1 MB compared to 66 MB for a full MathJax installation. If you need support for different output formats and legacy browsers try [`mathjax-node`](https://github.com/mathjax/MathJax-node).
## Installation
```bash
npm install mathjax-electron
```
## Usage
### Loading MathJax
Place the following line in the `` section of your document:
```html
```
Now you can use MathJax inside you application.
To trigger a rendering on a specific container, you can either use our helper module:
```javascript
const { typesetMath } = require("mathjax-electron");
const container = document.createElement("div");
container.innerHTML = "$$\\sum\\limits_{i=0}^{\\infty} \\frac{1}{n^2}$$";
typesetMath(container);
```
or the MathJax global:
```javascript
const container = document.createElement("div");
container.innerHTML = "$$\\sum\\limits_{i=0}^{\\infty} \\frac{1}{n^2}$$";
MathJax.Hub.Queue(["Typeset", MathJax.Hub, container]);
```
For more information about synchronizing your code, consult the [MathJax documentation](http://docs.mathjax.org/en/latest/advanced/synchronize.html).
### Loading MathJax Dynamically
To load MathJax dynamically, you can do:
```javascript
const { loadAndTypeset } = require("mathjax-electron");
const container = document.createElement("div");
container.innerHTML = "$$\\sum\\limits_{i=0}^{\\infty} \\frac{1}{n^2}$$";
loadAndTypeset(document, container);
```
If used for the first time it will initialize MathJax and trigger a rendering. After that it won't load MathJax again and only trigger the rendering.
### Manually Loading MathJax
For applications to manually loaded, or directly injected into the HTML, `mathjax-electron` exports the absolute path to load the configured MathJax Library.
```javascript
const { mathJaxPath } = require("mathjax-electron");
// /.../node_modules/mathjax-electron/MathJax-2.7.5/MathJax.js?config=nteract
```