Updated APi_Methods, Config, and README

Updated content and formatting.
4 files changed
tree: 67ad56e75d432942b726d68e247119dc45984f6f
  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)

Good news! We‘ve resumed active development and we’re committed to getting things running smoothly.
Find a dusty corner? Let us know.

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.

We'd love to hear from you-we love offering help and receiving feedback.

Getting Started

Check out our Getting Started Guide for instructions on how to get setup up with MathQuill and start using it.

MathQuill has a simple interface:

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}}'

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)