| commit | 99c0a345ea0a51f17d536eb272379660ebea4e99 | [log] [tgz] |
|---|---|---|
| author | Han Seoul-Oh <laughinghan@gmail.com> | Thu Jun 23 02:54:30 2016 -0700 |
| committer | Han Seoul-Oh <laughinghan@gmail.com> | Thu Jun 23 11:20:36 2016 -0700 |
| tree | 2db7cdcf3238f72577e71fcd75eb34a4c8f8173f | |
| parent | 4e2a50f7dd54df06bcc7fc003c6df8cc87491224 [diff] |
Close #563: Add "ultra-bare-bones" quickstart.html In addition to being helpful to someone who just downloaded MathQuill for the first time, it makes it easy to sanity test release tarballs as packaged by `npm pack`. Considered putting it under test/, but it makes more sense in the root of a release package, and it's equally as helpful to someone who just `git clone`d MathQuill for the first time, so I think it's fine in the root of the repo.
by Han, Jeanine, and Mary (maintainers@mathquill.com)
MathQuill is a web formula editor designed to make typing math easy and beautiful.
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.)
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.
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)