wiki:TracMathJaxPlugin

Version 5 (modified by kisielk, 4 years ago) (diff)

--

TracMathJaxPlugin

Description

A plugin for rendering math in Trac using MathJax. Unlike the TracMathPlugin, this plugin performs all rendering on the client side using web fonts.

See also: TracMathPlugin, LatexFormulaMacro, Trac2LatexPlugin, LatexMacro

Download and Source

Download the 0.2 release in zip, gz, or bz2 format.

For the latest changes, check out the source using Hg, or browse it on Bitbucket.

Installation

Unpack your download. Go to the top level directory of TracMathJax and type:

 $ python setup.py bdist_egg

This should create an egg file under the dist subdirectory of your current directory. Copy the egg to the plugins directory of your trac project. If you have any difficulties installing consult these trac plugin installation steps.

Next, download a copy of MathJax and unpack it on your server to a location readable by the web server.

Configuration

To activate the component, edit your project's trac.ini file to include:

 [components] 
 tracmathjax.* = enabled

You must also create a new section called [tracmathjax] and set the option mathjax_path to the absolute filesystem path where you unpacked MathJax:

[tracmathjax]
mathjax_path = /path/to/mathjax

For additional customization of the display output, see the MathJax documentation.

Bugs/Feature Requests

Existing bugs and feature requests for TracMathJaxPlugin are here.

If you have any issues, create a new ticket.

Example

To display math inline, enter LaTeX equation in between a pair of \( and \) brackets:

Here is an inline equation: \( y = x^2 \)

To display a block of math, either enter it between a pair of $$ characters:

Here is a block equation: $$ y = x^2 $$

or use the latex processor:

{{{
#!latex
y = x ^ 2
}}}

Release Notes

0.2

  • Fixed bugs with inline macro syntax (#8500)

0.1

  • Initial release

Author/Contributors

Author: kisielk
Maintainer: kisielk
Contributors: