commit | 19840b1efc706bb01f4b9c2ed2f69741b2de02c4 | [log] [tgz] |
---|---|---|
author | Han Seoul-Oh <laughinghan@gmail.com> | Tue May 10 04:24:19 2016 -0700 |
committer | Han Seoul-Oh <laughinghan@gmail.com> | Tue May 10 04:24:19 2016 -0700 |
tree | f74210fddaf94a409acad26f4c5a8204b9377426 | |
parent | 6f334dcbc36ea15af9552d9a11ed866502865973 [diff] |
Symlink instead of duplicating README.md and docs/index.md
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.
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.
Most documentation for MathQuill is located on ReadTheDocs.
Some older documentation still exists on the Wiki.
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)