Issue #212 new

mathjax docs

Thomas Waldmann
repo owner created an issue

we have some instructions about using mathjax in our docs.

there are 2 issues with them: a) they require direct editing of wikiconfig.py and it is non-trivial to just add mathjax in your wikiconfig_editme.py (and inherit everything else from the main config)

b) it is unclear what html environment mathjax needs to trigger parsing its markup and rendering the formula. it somehow did not work within a normal moin wiki markup item in some cases. maybe there should be some more words about how to use it after installing.

Comments (3)

  1. Reimar Bauer

    a) yes, that will be solved by a real plugin.

    b) It needs the formular enclosed in $ characters. e.g. for inline use $ /alpha $

    if the formular takes more lines

    $
    \begin{aligned}
    \dot{x} & = \sigma(y-x) \\
    \dot{y} & = \rho x - y - xz \\
    \dot{z} & = -\beta z + xy
    \end{aligned}
    $
    

    The mathjax plugin works on the converted html. So it works in all contentype text items.

    I improve the docs with giving some examples.

  2. Thomas Waldmann reporter

    if this is a bigger issue and not soon to get fixed, another option is to just remove any reference to mathjax from our documentation and close this issue by doing that.

  3. Log in to comment