mathjax / mathjax-docs

MathJax documentation. Beautiful math in all browsers. Beautifully documented.

MathJax Documentation

Beautiful and accessible math in all browsers.

MathJax is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers, as well as server-side in node applications. It was designed with the goal of consolidating the recent advances in web technologies into a single, definitive, math-on-the-web platform supporting the major browsers and operating systems. It requires no setup on the part of the user (no plugins to download or software to install), so the page author can write web documents that include mathematics and be confident that users will be able to view it naturally and easily. Simply include MathJax and some mathematics in a web page, and MathJax does the rest.

See http://www.mathjax.org/ or https://github.com/mathjax/MathJax/ for additional details.

Beautiful documentation.

The MathJax installation and usage documentation is available in this repository. The documents are also available on the MathJax web site online at http://docs.mathjax.org. Please help us improve the documentation! You can use the editor feature on github to simplify this.

Community

The main MathJax website is https://www.mathjax.org, and it includes announcements and other important information. MathJax is maintained and distributed on GitHub at https://github.com/mathjax/MathJax, and the source code is housed at https://github.com/mathjax/MathJax-src. A user forum for asking questions and getting assistance is hosted at Google, and the bug tracker is hosted at GitHub:

Bug tracker: https://github.com/mathjax/MathJax/issues
MathJax-Users Group: https://groups.google.com/group/mathjax-users

Before reporting a bug, please check that it has not already been reported. Please use the bug tracker for reporting bugs rather than the help forum, and use the forum rather than the bug tracker for asking usage questions.

License

Just like MathJax, this documentation is license under Apache License, Version 2.0.

Copyright (c) 2009-2020 The MathJax Consortium

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

mathjax-docs's Issues

document mml2jax preview

Fixing http://docs.mathjax.org/en/latest/platforms/index.html

The moodle information is outdated. Perhaps we should have better links rather than this outdated information, e.g., http://docs.moodle.org/dev/Themes_overview.

More generally, the whole section "MJ on Web Platforms" section is out of date. Perhaps we could move it to the docs wiki.

add reference to TranslateWiki and MathJax-i18n...

...for people willing to translate MathJax. Also mention test/localization.html

Difficult to find out how to listen to errors that happen within MathJax

This makes MathJax a blackbox in any larger application. I added some examples which will hopefully help others to find this information in the docs through this pull-request:

#89

hub docs are missing `semantics` option in menuSettings

Document in http://docs.mathjax.org/en/latest/options/hub.html that semantics: true will decide whether ShowSource will have the original markup as annotation-xml.

document HTML-CSS webFont and SVG font options

Also as I said in mathjax/MathJax#641 (comment), it seems that one must set both availableFonts=[] and preferredFont=null to prevent local fonts to be used.

Add processRefs to tex2jax options page

This option is missing from the documentation.

Fix FAQ on IE compatibility

As per #53 (comment)

This is outdated and is now contra-indicated (this makes IE9+ slower). The current suggestion is IE=Edge. The text probably needs to be adjusted as well.

collection of readthedocs theme issues

Moving these from #32 (comment) to their own issue to track.

• left-hand sidebar, all the links from the home page appear, but not separated into their categories.
• the alphabetical list of LaTeX commands doesn't format well (in Safari) due to the bold monospaced font.

These have been reported upstream at readthedocs/sphinx_rtd_theme#120 and readthedocs/sphinx_rtd_theme#121 and

Other solutions: override the CSS, readthedocs/sphinx_rtd_theme#117

Fix dead links to mathjax.org

Closely related to mathjax/MathJax-website#6

• https://github.com/mathjax/MathJax-docs/blob/101c5f236ecae13e4bc5072a933ad62fab13a259/misc/articles.rst
• https://github.com/mathjax/MathJax-docs/blob/2acc3a9a45bbde830e8e3f4e7a695c6b9eb3a3d9/misc/browser-compatibility.rst
• https://github.com/mathjax/MathJax-docs/blob/101c5f236ecae13e4bc5072a933ad62fab13a259/misc/faq.rst
• https://github.com/mathjax/MathJax-docs/blob/2acc3a9a45bbde830e8e3f4e7a695c6b9eb3a3d9/options/MathMenu.rst
• https://github.com/mathjax/MathJax-docs/blob/0e8e32c7d3ccb5b5a18dc2b3ed1cfc66cd899c36/installation.rst
• https://github.com/mathjax/MathJax-docs/blob/2acc3a9a45bbde830e8e3f4e7a695c6b9eb3a3d9/upgrade.rst
• https://raw.githubusercontent.com/mathjax/MathJax-docs/9f851188f95171de037e30637a83b5af87dac829/start.rst
• https://github.com/mathjax/MathJax-docs/blob/d123fbbad9cd3e90265b26f71010fe294e9f549e/configuration.rst
• https://github.com/mathjax/MathJax-docs/blob/0049819dfc852f136910ab16f0cab4988fd5869d/tex.rst

meta: docs wiki to docs

Check the additions and the improvements.

Use this issue to keep track of those that can move up to the docs.

• Slimming-down guide
• Web-based editors
• Math-enabled screen-readers
• CDN FAQs

Adjustements to the start page

I would like to have http://docs.mathjax.org/en/latest/options/index.html#configuration-options-by-component on the front page. Here's a proposal

Basic Usage

• What is MathJax?
• Getting Started with MathJax
• Installing and Testing MathJax
• Loading and Configuring MathJax
• Common MathJax Configurations
• Using MathJax in Web Platforms
• MathJax TeX and LaTeX Support
• MathJax MathML Support
• MathJax AsciiMath Support
• MathJax Output Formats
• MathJax Localization
• MathJax Safe-mode
• The MathJax Community

MathJax Configuration Options

• Configuration Objects (http://docs.mathjax.org/en/latest/options/index.html)
• The core options
• The tex2jax preprocessor options
• The mml2jax preprocessor options
• The asciimath2jax preprocessor options
• The jsMath2jax preprocessor options
• The TeX input processor options
• The MathML input processor options
• The AsciiMath input processor options
• The HTML-CSS output processor options
• The NativeMML output processor options
• The SVG output processor options
• The MMLorHTML configuration options
• The MathMenu options
• The MathZoom options
• The MathEvents options
• The FontWarnings options
• The Safe options

...

Documentation for MathJax signals

I did not find any exhaustive list of signals that MathJax can send, except those mentioned in the MathJax startup sequence. We should probably add such a list in the user documentation.

Suggest <script async> everywhere

HTML5 async attribute is probably the right recommendation to make in the docs (and on mathjax.org). Non-HTML5 browser apparently ignore it so there's no risk.

Not a huge save but still worth it.

References.

• http://css-tricks.com/async-attribute-scripts-bottom/ (and the links at the top of that post)
• on blocking scripts vs inline scripts vs the new async attribute. https://www.igvita.com/2014/05/20/script-injected-async-scripts-considered-harmful/
  • see also https://chimera.labs.oreilly.com/books/1230000000545

mention Bower package in "Installing and Testing MathJax"

mention `unpacked` version in the docs

Via mathjax/MathJax#1155

Maybe in http://docs.mathjax.org/en/latest/installation.html#testing-your-installation ?

Move MathJax-in-use to docs

Add Extension writing tutorial

From https://github.com/mathjax/MathJax-docs/wiki/Tutorial-Extension-Authoring

Add documentation for ContentMML extension

There is none! Also, update the FAQ afterwards.

document third party extension repository for 2.4

See also mathjax/MathJax#737

prep 2.4 documentation

Follow our release policies.

document matchwebfonts extension

document AuthorInit/AuthorConfig

integrate content from www.mathjax.org

I've begun turning content from www.mathjax.org into drafts at https://github.com/mathjax/MathJax-docs/wiki/Docs.mathjax.org-improvements. I propose to integrate them into the docs, probably as a new section. This will help with the redesign of www.mathjax.org in the future.

Improve plain JS configuration method docs

Update configuration.rst and turn that part into its own section.

"dead" link in `config-files`

Second paragraph links to http://cdn.mathjax.org/mathjax/latest/config/ which used to give a directory listing way back when but doesn't anymore (because of our use of cloud storage providers).

I'd suggest to link to github instead; that also makes more sense to me. Will wait until we merge the current pull requests.

some restructuring

I finally figured out how to redirect latest to any branch (dark and hidden corner of the readthedocs dashboard...).

This means we can get rid of the complications of keeping the latest version branch in sync with master -- we'll configure readthedocs to present 2.3-latest at latest (and part of the release process will be to switch this at readthedocs).

For the above, we should get rid of the version warning for the latest version. But we may as well do that in general since we include canonical links to latest now which has cleared up the page rank (no more people coming from Google to the wrong version). (And while we're at it, we could switch to the new readthdocs theme.)

Add canonical link to `latest` version

See http://docs.readthedocs.org/en/latest/faq.html#can-i-make-search-engines-only-see-one-version-of-my-docs

Add an overview over font options

The supported fonts are listed in both output processors. Users want to find this information easily when they run into font issues (missing glyphs, etc). Let's create a page in the "Basic Usage" section.

Document the floats extension

It's missing?

fix asciimath link in start

http://docs.mathjax.org/en/latest/start.html uses a relative link for the asciimathml example. (I wasn't sure about the repository structure right now, so I didn't want to edit this in master. Will check before v2.4 comes out)

improve documentation on writing TeX macros

List of items as they come up

• in configuration block: writing a macro with optional arguments is not documented (tried to figure it ot at http://codepen.io/anon/pen/tgJqC)

epub3 reader overview

Like all resources, http://www.mathjax.org/resources/epub-readers/ should move to the docs.

start.rst links to fixed versions of samples

Reported on mathjax/MathJax#1146 (comment).

Not sure if sphinx can create links depending on the doc version; will investigate. If not, then I suggest we go with linking to latest (even if it means that older docs will link to newer samples).

Document resetEquationNumbers

The TeX input jax's resetEquationNumbers method needs to be added to the documentation.

document clearing listeners

See mathjax/MathJax#693

document CommonHTML in output.rst

As per suggestion from mathjax/MathJax#1037 (comment)

2.5 release work

• Update the https://github.com/mathjax/MathJax/wiki/Documentation-update-process
  • create 2.5 branch
  • merge 2.5 branch into master -- #83
  • Create What's New page
• CommomHTML work
  • document new CommonHTML output
  • document CHTML-Preview extension
  • update combined configuration page.
• document MathML extensions
  • Content MathML extension (in particular, customization)
  • mml3 extension
  • update MathML.rst -- #69
• Tweak Getting Started
• document handle-floats -- #84
• document attribute preservation -- mathjax/MathJax#860
• update whats-new with bugs that came in during the beta run
• document clearing listeners -- mathjax/MathJax#693 =>pushing this out of the release.

improving TeX documentation

How can we integrate http://www.onemathematicalcat.org/MathJaxDocumentation/TeXSyntax.htm into the docs?

document composer.json

document wikipedia-texvc extension

document matchFontHeight option

middle-button on doc pages

Latest chrome. By pressing the middle mouse button on a link opens the target page "in place". For browsers default behavior - in a new tab.

Unclear documentation organized. My case is simple - looking for code examples for the substitution in a web page.To find the information is necessary to read and view unnecessary things.

Indicate where MathJax's LaTeX is stricter

I remember that some of our commands are stricter. I think \mod is one of them (\mod{} works but \mod does not).

I would like to markup the TeX documentation to indicate those commands. @dpvc could you list them here?

Documenting won't fix bugs

As per discussion at mathjax/MathJax#732, I'm wondering if/how we document won't-fix bugs.

At the very least, I would like to start tracking them -- so this is a start.

document new menu items for MathML annotation in "Show Math As"

Document toMathML.js

It's mentioned in the combined configurations section but there's no documentation (except on the wiki, I suppose)

document viewport suggestions

See https://groups.google.com/d/msg/mathjax-users/CFhPmGixWWE/M8vflfqdCw0J

<meta name="viewport" content="width=device-width,minimum-scale=1.0, maximum-scale=1.0" />

Document noReflows option for HTML-CSS

noReflows:true is the default. Tells HTML-CSS to not make certain measurements (which cause reflows), thereby gaining speed. Can lead to minor issues in rendering quality.

Update mathml.rst

https://github.com/mathjax/MathJax-docs/blob/master/mathml.rst

It's out of date.