mathjax-third-party-extensions

A collection of MathJax extensions provided by third-party contributors. This repository is mirrored on the MathJax CDN.

Contributing

We'd be thrilled to include your extension!

To add an extension, simply create a pull request. Please structure your contribution along the lines of existing extensions. In particular, make sure that

Create a subfolder
Add a README file with some basic information on the extension (see other extensions for inspiration)
Add a License.txt file. We require Apache-license-2 comaptible licenses.
The loadComplete call in your extension should be of the form [Contrib]/foldername/filename.js to work generically with a third party location in MathJax v2.4+.
Preferably, contribute both a packed (using uglify, YUI etc) as well as an unpacked version; the unpacked version should be placed under foldername/unpacked/ with a working loadComplete call.

Using third party extensions.

We host copy of the third-party extension repository on the MathJax CDN. This means anything you contribute here will be easily available to all MathJax CDN users.

Since MathJax v2.7, MathJax simplifies loading third party extensions: just prefix the extension name with [Contrib] and the relative path in this repository.

For example,

<script type="text/x-mathjax-config>
  MathJax.Hub.Config({
    extensions: ["tex2jax.js","[Contrib]/img/img.js"],
    jax: ["input/TeX","output/HTML-CSS"],
    tex2jax: {inlineMath: [["$","$"],["\\(","\\)"]]},
  });
</script>

would load the img extension.

If you are using MathJax v2.6 or below, you will need to define [Contrib] manually.

Either add

<script type="text/x-mathjax-config">
  MathJax.Ajax.config.path["Contrib"] = "//cdn.mathjax.org/mathjax/contrib";
</script>

or equivalently,

<script type="text/javascript">
  window.MathJax = {
    AuthorInit: function () {
            MathJax.Ajax.config.path["Contrib"] = "//cdn.mathjax.org/mathjax/contrib";
        }
  };
</script>

to your configuration. See also the documentation page on third party extensions and this repository.

Writing extensions

The MathJax documentation contains a tutorial on extension writing.

Afterwards, you might want to start by looking at some of the extensions here and the MathJax core extensions.

edwardt / mathjax-third-party-extensions Goto Github PK