Skip to content

Repository files navigation

The SimpleMathJax extension enables MathJax, a Javascript library, for typesetting TeX formula in MediaWiki inside math environments. It requires MediaWiki 1.43 or later.

https://www.mediawiki.org/wiki/Extension:SimpleMathJax

Installation

  • git clone in extensions directory
  • Using CDN is recommended. Because it's much faster than using local resources in most cases. ("the benefits of using a CDN")
$ git clone https://github.com/jmnote/SimpleMathJax.git
  • (Optional) If you want to use not CDN but local mathjax scripts, you can use git clone recursive, then set $wgSmjCdnEnabled = false (see $wgSmjCdnEnabled).
$ git clone --recursive https://github.com/jmnote/SimpleMathJax.git
  • LocalSettings.php
wfLoadExtension( 'SimpleMathJax' );

Optional Settings

Setting name Default value Description Custom value example
$wgSmjCdnEnabled true Whether to load MathJax from a CDN false
$wgSmjCdnVersion '4' MathJax version to load from the CDN '4.1.3'
$wgSmjScale 1 MathJax.chtml.scale 1.5
$wgSmjEnableMenu true MathJax.options.enableMenu false
$wgSmjDelimitersEnabled false Whether to also scan for bare delimiters (e.g. $...$) outside <math>/<chem> true
$wgSmjDelimitersInlineMath [] Inline math delimiter pairs [['$','$']]
$wgSmjDelimitersDisplayMath [] Display math delimiter pairs [['$$','$$']]
$wgSmjAllowedAttributes [] List of generic HTML attributes to carry over to the output <span> ['class', 'title']
$wgSmjIgnoreHtmlClass 'mathjax_ignore|comment|
diff-(context|
addedline|deletedline)'
MathJax.options.ignoreHtmlClass 'mathjax_ignore|comment|
diff-(context|
addedline|deletedline)|my_custom_class'
$wgSmjRevisionOverrides [] Switch the configuration according to the article's revision [['max'=>1048576,
'wgSmjScale'=>1.5]]

See docs/configuration.md for a detailed walkthrough of each setting, with usage examples. Upgrading from before 1.0.0? See the migration guide for what to change in your LocalSettings.php.

See docs/displaystyle.md for the <math display> rendering modes and examples.

Need to keep another extension (e.g. Lingo) from interfering with MathJax's rendering? See Hooks in the configuration guide for the SimpleMathJaxAttributes hook.

About

MediaWiki Extension SimpleMathJax

Topics

Resources

Stars

31 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages