Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[readme] add documentation #312

Merged
merged 1 commit into from
Apr 3, 2017
Merged

[readme] add documentation #312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The `start` method start (and restarts) mathjax-node. This allows reconfiguratio

**Note.** This is done automatically when `typeset` is first called (see below).

### `typset(options, callback)`
### `typeset(options, callback)`

The `typeset` method is the main method of mathjax-node. It expects a configuration object `input` and a `callback`.

Expand Down Expand Up @@ -140,6 +140,7 @@ The `result` object will contain (at most) the following structure:

```javascript
{
errors: // an array of MathJax error messages if any errors occurred
mml: // a string of MathML markup if requested
mmlNode: // a jsdom node of MathML markup if requested
html: // a string of HTML markup if requested
Expand All @@ -148,6 +149,8 @@ The `result` object will contain (at most) the following structure:
svg: // a string of SVG markup if requested
svgNode: // a jsdom node of SVG markup if requested
style: // a string of CSS inline style if SVG requested
height: // a string containing the height of the SVG output if SVG was requested
width: // a string containing the width of the SVG output if SVG was requested
speakText: // a string of speech text if requested

state: { // the state object (if useGlobalCache or equationNumbers is set)
Expand Down