File: ThirdParty.rst

package info (click to toggle)
mathjax-docs 2.7%2B20171212-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,100 kB
  • sloc: javascript: 28; sh: 22; python: 19; makefile: 8
file content (73 lines) | stat: -rw-r--r-- 2,316 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.. _ThirdParty:

***********************************
Third-party Extensions
***********************************

MathJax can load extensions (and configurations) from arbitrary locations. 
This allows authors and developers to easily integrate custom code.

Custom extension path configuration
----------------------------------------

Usually, third-party extensions have to be specified with their full 
paths (and matching ``loadComplete`` calls); this limits portability. To
simplify this process, the MathJax configuration can include (possibly 
multiple) third-party locations for easier reference.

To specify the URL, set ``MathJax.Ajax.config.path["Extra"]`` in your
configuration file, for example,

.. code-block:: javascript

    <script type="text/x-mathjax-config">
      MathJax.Ajax.config.path["Extra"] = "https://my.extra.com/mathjax/extra";
    </script>

or equivalently,

.. code-block:: javascript

    <script type="text/javascript">
      window.MathJax = {
        AuthorInit: function () {
              MathJax.Ajax.config.path["Extra"] = "https://my.extra.com/mathjax/extra";
            }
      };
    </script>

Configuring this path will allow you to load extensions using the ``[Extra]`` 
prefix. To continue the example, the following configuration would then load 
``http://my.extra.com/mathjax/extra/spiffy.js``.

.. code-block:: javascript

    MathJax.Hub.Config({
      extensions: ["[Extra]/spiffy.js"]
    });

Note that the extension's ``loadComplete`` call needs to match this path, 
i.e., ``spiffy.js`` should end with

.. code-block:: javascript

    MathJax.Ajax.loadComplete("[Extra]/spiffy.js");


MathJax Third-Party extension repository
----------------------------------------

We collect a list of third-party extensions on Github at `github.com/mathjax/MathJax-third-party-extensions 
<https://github.com/mathjax/MathJax-third-party-extensions>`_. This repository 
allows developers to publicize their custom extensions easily.

.. note:: 

    The mirrored copy on the MathJax CDN at `cdn.mathjax.org/mathjax/contrib/ 
    <//cdn.mathjax.org/mathjax/contrib/>`_ has been retired alongside the MathJax CDN.


.. note::

  You can disable the ``[Contrib]`` path by loading MathJax with 
  ``noContrib`` in the query string, e.g., ``MathJax.js?config=...&noContrib``