MathQuill

by Han, Jeanine, and Mary (maintainers@mathquill.com)

MathQuill is a web formula editor designed to make typing math easy and beautiful.

MathQuill GitHub Demo

The MathQuill demo is an self-contained in the subdirectory `examples/` in this repository.

example uses jquery-3.6.0.js - required for MathQuill is jquery 1.5.2++
css/mathquill.css generated MathQuill stylesheet
Symbola fonts in examplescss/fonts by George Douros

The MathQuill project is supported by its partners. We hold ourselves to a compassionate Code of Conduct.

MathQuill is resuming active development and we're committed to getting things running smoothly. Find a dusty corner? Let us know in Slack. (Prefer IRC? We're #mathquill on Freenode.)h

Installation and Build mathquill.js

The installation requires NodeJS to be installed on your system.

Fetching the Open Source Code

To fetch the source of mathquill call git clone https://github.com/mathquill/mathquill.git

Install dependencies

As usual run npm install in the mathquill folder

Run Make

If you run the make command in the mathquill folder, also the dependencies will be installed.

Getting Started

MathQuill has a simple interface. This brief example creates a MathQuill element and renders, then reads a given input:

var htmlElement = document.getElementById('some_id');
var config = {
  handlers: { edit: function(){ ... } },
  restrictMismatchedBrackets: true
};
var mathField = MQ.MathField(htmlElement, config);

mathField.latex('2^{\\frac{3}{2}}'); // Renders the given LaTeX in the MathQuill field
mathField.latex(); // => '2^{\\frac{3}{2}}'

Check out our Getting Started Guide for setup instructions and basic MathQuill usage.

Docs

Most documentation for MathQuill is located on ReadTheDocs.

Some older documentation still exists on the Wiki.

Open-Source License

The Source Code Form of MathQuill is subject to the terms of the Mozilla Public License, v. 2.0: http://mozilla.org/MPL/2.0/

The quick-and-dirty is you can do whatever if modifications to MathQuill are in public GitHub forks. (Other ways to publicize modifications are also fine, as are private use modifications. See also: MPL 2.0 FAQ)

niebert / mathquill