MathJax README

The project's README from github.com/mathjax/MathJax. As one markdown file: README.md.

MathJax

Beautiful math in all browsers

Note: MathJax code development is performed in the MathJax-src repository. This repository holds the packaged version of MathJax, along with the main issue tracker for MathJax bugs.

GitHub release version GitHub release version (v3) GitHub release version (v2) NPM version jsdelivr rank jsDelivr hits (npm) npm monthly downloads (full) npm total downloads

MathJax is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers, with built-in support for assistive technology like screen readers, including automatic speech generation and an expression explorer that can be used to investigate typeset mathematics on a more granular level than the complete expression. It requires no setup on the part of the user (no plugins to download or software to install), so the page author can write web documents that include mathematics and be confident that users will be able to view it naturally and easily. Simply include MathJax and some mathematics in a web page, and MathJax does the rest.

Some of the main features of MathJax include:

See http://www.mathjax.org/ for additional details about MathJax, and https://docs.mathjax.org for the MathJax documentation.

MathJax Components

MathJax uses files called components that contain the various MathJax modules that you can include in your web pages or access on a server through NodeJS. Some components combine all the pieces you need to run MathJax with one or more input formats and a particular output format, while other components are pieces that can be loaded on demand when needed, or by a configuration that specifies the pieces you want to combine in a custom way. For usage instructions, see the MathJax documentation.

Components provide a convenient packaging of MathJax's modules, but it is possible for you to form your own custom components, or to use MathJax's modules directly in a node application on a server. There are web examples showing how to use MathJax in web pages and how to build your own components, and node examples illustrating how to use components in node applications or call MathJax modules directly.

What's in this Repository

This repository contains only the component files for MathJax, not the source code for MathJax (which are available in a separate MathJax source repository). These component files are the ones served by the CDNs that offer MathJax to the web. In version 2, the files used on the web were also the source files for MathJax, but in version 3 and above, the source files are no longer on the CDN, as they are not what are run in the browser.

The components are ES6 format as CommonJS modules.

Installation and Use

Using MathJax components from a CDN on the web

If you are loading MathJax from a CDN into a web page, there is no need to install anything. Simply use a script tag that loads MathJax from the CDN. E.g.,

<script src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js" defer></script>

See the MathJax documentation and the MathJax Web Demos, and the MathJax Node Demos for more information.

Hosting your own copy of the MathJax Components

If you want to host MathJax from your own server, you can do so by installing the mathjax package using npm and moving the contents to an appropriate location on your server:

npm install mathjax@4
mv node_modules/mathjax <path-to-server-location>/mathjax

Alternatively, you can get the files via GitHub:

git clone https://github.com/mathjax/MathJax.git mathjax
mv mathjax <path-to-server-location>/mathjax

Then (in either case) you can use a script tag like the following:

<script src="<url-to-your-site>/mathjax/tex-chtml.js" defer></script>

where <url-to-your-site> is replaced by the URL to the location where you moved the MathJax files above.

See the documentation for details.

Using MathJax components in a node application

To use MathJax components in a node application, install the mathjax package:

npm install mathjax@4

Then import mathjax within your application and initialize it:

import MathJax from 'mathjax';
await MathJax.init({ ... });

where { ... } is the MathJax configuration you want to use. E.g., 

import MathJax from 'mathjax';
await MathJax.init({
  loader: {load: ['input/tex', 'output/svg']}
});
const svg = await MathJax.tex2svgPromise('\\frac{1}{x^2-1}', {display: true});
console.log(MathJax.startup.adaptor.serializeXML(svg));

Alternatively, in an ES5 node application, you can use

const MathJax = require('mathjax');
MathJax.init({ ... }).then(() => { ... });

where the first { ... } is a MathJax configuration, and the second { ... } is the code to run after MathJax has been loaded. E.g.

const MathJax = require('mathjax');
MathJax.init({
  loader: {load: ['input/tex', 'output/svg']}
}).then(() => {
  const svg = MathJax.tex2svg('\\frac{1}{x^2-1}', {display: true});
  console.log(MathJax.startup.adaptor.serializeXML(svg));
}).catch((err) => console.log(err.message));

Note: the technique in the two examples above is for node-based application only, not for browser applications. This method sets up an alternative DOM implementation, which you don't need in the browser, and it depends on node and the local file system in other ways. This setup will not work properly in the browser, even if you webpack it or use some other bundler.

See the documentation and the MathJax Node Repository for more details.

Reducing the Size of the Components Directory

Since the MathJax package contains all the component files, so if you are only planning one use one configuration, you can reduce the size of the MathJax directory by removing unused components. For example, if you are using the tex-chtml.js component, then you can remove the tex-mml-chtml.js, tex-svg.js, tex-mml-svg.js, and the files ending in -nofont.js, which will save considerable space. Indeed, you should be able to remove everything other than tex-chtml.js, and the input/tex/extensions, adaptors, a11y, and sre directories. If you are using the results only on the web, you can remove adaptors as well. If you are using MathML input rather than TeX (e.g., mml-chtml.js rather than tex-chtml.js), then you can remove input/tex/extensions as well.

If you are using a font other than the default mathjax-newcm font in a node application, then you will need to install that font as well. E.g.,

npm install @mathjax/mathjax-stix2-font@4

to install the mathjax-stix2 font locally. On the web, MathJax will look for the font and its dynamic ranges on the cdn.jsdelivr.net CDN service, so if you want to use the font from your own server, you will need to configure the path to the font. For example:

MathJax = {
  loader: {
    paths: {
      'mathjax-stix2': '<url-to-your-server>/mathjax-stix2-font'
    }
  }
};

to set the location for the mathjax-stix2 font to a URL on your server.

The Component Files and Pull Requests

The contents of this repository are generated automatically, so you should not submit pull requests that modify this repository. If you wish to submit a modification to MathJax, you should make a pull request in the MathJax source repository.

MathJax Community

The main MathJax website is http://www.mathjax.org, and it includes announcements and other important information. A MathJax user forum for asking questions and getting assistance is hosted at Google, and the MathJax bug tracker is hosted at GitHub.

Before reporting a bug, please check that it has not already been reported. Also, please use the bug tracker (rather than the help forum) for reporting bugs, and use the user's forum (rather than the bug tracker) for questions about how to use MathJax.

MathJax Resources

MathJax (mathjax/MathJax)

Searching Database…

10.9K ·GitHub
MathJax
What is this?MathJax is an open-source JavaScript display engine that renders LaTeX, MathML, and AsciiMath notation in all modern browsers, with built-in support for assistive technology like screen readers.
Is this a library I add to my site, or something my visitors have to install?A JavaScript library the page author includes. Visitors need nothing at all — no plugins, extra fonts, or special setup, and it works in most browsers.
How do I put math on a page with it?Include MathJax in the page and write mathematics in it — MathJax finds and typesets the math on its own. For node use, install the mathjax package and initialize it with your configuration.
Do I need to install anything else to use it?Nothing for readers. A node application needs Node.js plus the mathjax npm package, which also pulls in the default mathjax-newcm font.
Does the node-based setup also work in browser apps?No — it sets up an alternative DOM implementation and depends on node and the local file system, so it fails in the browser even if you webpack it or use another bundler.
Who ends up using MathJax in practice?Anyone publishing math on the web — the project pitches itself as easy for authors, flexible for publishers, and extensible for developers, with an API for integration into other web applications.
What can screen-reader users do with the math it renders?Built in: automatic speech generation for expressions, plus an expression explorer that lets a user investigate the typeset math at a more granular level than the whole expression.
What input notations and output formats does it support?Input: LaTeX, MathML, and AsciiMath. Output: the packaged components include tex-chtml.js and tex-svg.js, so math can be rendered as HTML/CSS or as SVG.
Can I slim it down if I need only one configuration?Yes — remove the components you don't use. If you ship only tex-chtml.js, you can delete tex-mml-chtml.js, tex-svg.js, tex-mml-svg.js and the -nofont files, which saves considerable space.
Which font does it typeset with?The default is mathjax-newcm. Alternatives like mathjax-stix2 can be installed locally, and on the web MathJax fetches non-default fonts and their dynamic ranges from the cdn.jsdelivr.net CDN.
What are similar projects?KaTeX, DOMPurify, pretext, material, marked, pug, satori, lit
Which topics is it in?typesetting, latex, font, mathematics, typography, rendering, svg, accessibility, javascript-library, css, browser, html
Creator
mathjax
Size
159.1 MB
Stars
10.9K
Updated
CommitJul 03Release4.1.3Jul 03
Age
16y
Commits · 90 Days