| commit | 4332b0e97a92fb1362123a06b68fa49d9efb6f38 | [log] [tgz] |
|---|---|---|
| author | Han Seoul-Oh <laughinghan@gmail.com> | Mon Jun 20 17:47:10 2016 -0700 |
| committer | Han Seoul-Oh <laughinghan@gmail.com> | Thu Jun 23 11:20:36 2016 -0700 |
| tree | 48821b81dff9f7723aa03b0396b22284017e6ed1 | |
| parent | 4a0b7f6b4fc256444350898fa83fe4176ba604ae [diff] |
Makefile injects version string; add MathQuill.VERSION Also reformat JS and CSS files' header comments to look nice even with a variable-length version string (I considered using `printf` to pad up to a fixed width with spaces, but we don't want the `MathQuill.VERSION` string to have the spaces so there'd have to be two separate substitutions, and it's an unnecessary extra step anyway.) The BSD vs GNU feature inference we actually used to already do in the Makefile, that's where the reference is from: https://github.com/mathquill/mathquill/commit/33d764b9db416cfc319fc93f559e77348684cb69#diff-b67911656ef5d18c4ae36cb6741b7965L184 Finally, about the choice of `MathQuill.VERSION` rather than `MathQuill.version` or whatever, there's no clear consensus but `.VERSION` does appear to be the most common choice (also I like that it's all-caps since it's a compile-time constant): - Backbone.VERSION: http://stackoverflow.com/a/30386560/362030 - _.VERSION (Underscore.js): http://stackoverflow.com/a/26758978/362030 (also Lodash: https://lodash.com/docs#VERSION ) - Ember.VERSION: http://stackoverflow.com/a/33440288/362030 - recommended for Boostrap jQuery plugins: http://getbootstrap.com/javascript/#js-version-nums Some do use `.version`: - ko.version (Knockout.js): https://github.com/twbs/bootstrap/issues/16264#issue-67269734 - d3.version: https://github.com/d3/d3/wiki/API-Reference Odd ducks: - jQuery.fn.jquery: https://api.jquery.com/jquery-2/ - angular.version.full: http://stackoverflow.com/a/31604785/362030
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)