steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-15 07:32:23 -06:00
Code Issues Packages Projects Releases Wiki Activity
just-the-docs/docs/mathjax/index.md
Peter Mosses 7220197a1f Mathjax support added 
Mathjax config options added.
`compress_html` config option changed,
Mathjax script loaded by head when `page.mathjax` is truthy.
Documentation and test page added.
See also issue #198.
2019-08-31 23:19:03 +02:00

1.5 KiB
Raw Blame History

layout, title, nav_order, has_children, mathjax
layout title nav_order has_children mathjax
default Mathjax 8 true true

Mathjax

To use Mathjax on a just-the-docs page:

The default Mathjax options in _config.yml are:

compress_html:
  blanklines: true # required for Mathjax
mathjax:
  source: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML
  config: 'MathJax.Hub.Config({ TeX: { equationNumbers: { autoNumber: "AMS" } } })'

Here is an example:


\begin{align*}
  & \phi(x,y) = \phi \left(\sum_{i=1}^n x_ie_i, \sum_{j=1}^n y_je_j \right)
  = \sum_{i=1}^n \sum_{j=1}^n x_i y_j \phi(e_i, e_j) = \\
  & (x_1, \ldots, x_n) \left( \begin{array}{ccc}
      \phi(e_1, e_1) & \cdots & \phi(e_1, e_n) \\
      \vdots & \ddots & \vdots \\
      \phi(e_n, e_1) & \cdots & \phi(e_n, e_n)
    \end{array} \right)
  \left( \begin{array}{c}
      y_1 \\
      \vdots \\
      y_n
    \end{array} \right)
\end{align*}

For further examples, see this test page, adapted from a test in markdown-preview-plus.