{"_id":"mathjax-node","_rev":"28-22e2b6b754f9f82c80d066b8d27ca8d4","name":"mathjax-node","time":{"modified":"2022-06-19T16:52:04.164Z","created":"2014-11-17T13:12:30.242Z","0.1.1":"2014-11-17T13:12:30.242Z","0.4.0":"2015-10-28T17:10:34.964Z","0.5.0-rc.1":"2016-02-15T11:05:48.504Z","0.5.0":"2016-02-15T11:24:58.375Z","0.5.1":"2016-02-22T10:23:52.937Z","0.5.2":"2016-11-30T08:13:39.608Z","1.0.0-beta.0":"2017-02-21T19:05:32.458Z","1.0.0":"2017-03-14T16:50:10.450Z","1.0.1":"2017-04-07T09:50:37.243Z","1.0.2":"2017-05-02T14:22:36.930Z","1.0.3":"2017-05-02T15:00:48.242Z","1.1.0":"2017-05-04T06:32:19.667Z","1.1.1":"2017-08-16T14:14:16.284Z","1.2.0-beta.0":"2017-08-23T06:57:07.297Z","1.2.0":"2017-08-23T07:22:23.812Z","1.2.1":"2017-09-26T07:30:18.223Z","1.3.0":"2017-12-29T16:27:54.586Z","2.0.0":"2018-02-06T00:50:10.123Z","2.0.1":"2018-02-06T21:10:54.814Z","2.1.0":"2018-03-20T13:02:43.278Z","2.1.1":"2018-06-05T13:35:48.321Z"},"maintainers":[{"email":"manager@mathjax.org","name":"mjadmin"}],"dist-tags":{"latest":"2.1.1"},"description":"API's for calling MathJax from node.js","readme":"# mathjax-node [](https://travis-ci.org/mathjax/MathJax-node)\n\nThis repository contains a library that provides an API to call [MathJax](https://github.com/mathjax/mathjax) from Node.js programs. The API converts individual math expressions (in any of MathJax's input formats) into HTML (with CSS), SVG, or MathML code.\n\nUse\n\n```\nnpm install mathjax-node\n```\n\nto install mathjax-node and its dependencies.\n\n**Note:**\nThe current version of mathjax-node requires Node.js v6 or later, and uses jsdom version 11.\n\n## Getting started\n\nmathjax-node provides a library, `./lib/main.js`. Below is a very minimal example for using it - the tests and the examples mentioned above provide more advanced examples.\n\n```javascript\n// a simple TeX-input example\nvar mjAPI = require(\"mathjax-node\");\nmjAPI.config({\n MathJax: {\n // traditional MathJax configuration\n }\n});\nmjAPI.start();\n\nvar yourMath = 'E = mc^2';\n\nmjAPI.typeset({\n math: yourMath,\n format: \"TeX\", // or \"inline-TeX\", \"MathML\"\n mml:true, // or svg:true, or html:true\n}, function (data) {\n if (!data.errors) {console.log(data.mml)}\n // will produce:\n // \n});\n```\n\n## Documentation\n\nmathjax-node exports three methods, `config`, `start`, `typeset`.\n\n### `config(options)`\n\nThe `config` method is used to set _global_ configuration options. Its default options are\n\n```javascript\n{\n displayMessages: false, // determines whether Message.Set() calls are logged\n displayErrors: true, // determines whether error messages are shown on the console\n undefinedCharError: false, // determines whether \"unknown characters\" (i.e., no glyph in the configured fonts) are saved in the error array\n extensions: '', // a convenience option to add MathJax extensions\n fontURL: 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/fonts/HTML-CSS', // for webfont urls in the CSS for HTML output\n paths: {}, // configures custom path variables (e.g., for third party extensions, cf. test/config-third-party-extensions.js)\n MathJax: { } // standard MathJax configuration options, see https://docs.mathjax.org for more detail.\n}\n```\n\n**Note.** Changes to these options require a restart of the API using the `start()` method (see below).\n\n### `start()`\n\nThe `start` method start (and restarts) mathjax-node. This allows reconfiguration.\n\n**Note.** This is done automatically when `typeset` is first called (see below).\n\n### `typeset(options[, callback])`\n\nThe `typeset` method is the main method of mathjax-node. It expects a configuration object `options` and optionally a callback.\n\nIf no `callback` is passed, it will return a Promise.\n\nOnce called, `typeset` can be called repeatedly and will optionally store information across calls (see `state` below).\n\nThe following are the default input options.\n\n```javascript\n{\n ex: 6, // ex-size in pixels\n width: 100, // width of container (in ex) for linebreaking and tags\n useFontCache: true, // use and