Edits to Config and Contributing Guides
2 files changed
tree: 5cbedb6a6161a1dfe576fc010593e8a5e2b71556
  1. docs/
  2. script/
  3. src/
  4. test/
  5. .gitattributes
  6. .gitignore
  7. BUILDING
  8. CHANGELOG.md
  9. Makefile
  10. package.json
  11. README.md
README.md

MathQuill

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

MathQuill is a web formula editor designed to make typing math easy and beautiful. To view a demo, please view our website. The MathQuill project is currently supported by its partners. We are bound by a Code of Conduct.

MathQuill is actively developed and we‘re committed to getting things running smoothly. Find a dusty corner? Let us know. We’d love to hear from you.

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: myEditHandler},
  restrictMismatchedBrackets: true
};
var mathField = MQ.MathField(htmlElement, config);

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

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

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)