Skip to content

README.md

Latest commit

 

History

History
65 lines (41 loc) · 3.21 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.21 KB

MathQuill

Roebling Developers

Overview

This is a fork of the MathQuill project. It adds support for some non-standard LaTeX behavior, such as objects (e.g MyVariable) and object properties (e.g Flow.rate.x). Identifiers are assigned new mq-identifier ... class names so that they can be syntax highlighted.

To rebuild the code after making a change, run make all in the root directory. You can then run an example in your browser by opening e.g examples/synonym.html. You need to re-run make all after any change in the library.

Before exporting the build to synonym-react-mathquill, make sure to run make basic also!

Changes

  • Added the _ character in parser.util.ts
  • Got rid of the special mq-f class
  • Commented out the SubscriptCommand
  • Added the parseSemanticTypes function in publicapi.ts
  • Extended unit brace detection to support VanillaSymbol and NonSymbolaSymbol nodes (e.g %, $) inside \left\{...\right\}, not just Letter and Digit

Original README

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

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

homepage demo

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.)

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)