{{ message }}

# Sommerregen / grav-plugin-mathjax

Switch branches/tags
Nothing to show
1 contributor

### Users who have contributed to this file

198 lines (127 sloc) 9.17 KB

This plugin allows you to include math formulas in your web pages, either using TeX and LaTeX notation, and/or as MathML.

MathJax is a plugin for Grav and integrates the MathJax library, a modern JavaScript-based LaTeX rendering solution for the Internet, into the site.

By default, MathJax source is loaded automatically from the Internet using the MathJax Content Delivery Network (CDN). This is a light-weight, "out-of-the-box" LaTeX rendering solution and you can still use a custom configuration if you need.

Alternatively, you can host the MathJax library (approximately 150MB) on your server located in your user/data/mathjax folder.

MathJax then renders mathematics inside the default delimiters. The default math delimiters are $$...$$ and \$...\$ for displayed mathematics, and $...$ and \$$...\$$ for inline mathematics. An example can be seen below:

Installing or updating the MathJax plugin can be done in one of two ways. Using the GPM (Grav Package Manager) installation method or (i.e. bin/gpm install mathjax) manual install or update method by downloading this plugin and extracting all plugin files to

user/plugins/mathjax


## Usage

Grav MathJax Plugin is a ready to use plugin. It works out-of-the-box and no further configuration is needed.

### Example

To produce the formula shown in the above screenshot, create a new Markdown document and copy and paste the code snippet from below. After saving the document and loading the page, you should see something to similar to the rendered output shown in the screenshot 😄.

The code to copy and paste is as follows:

---
title: Einstein Field Equations
---

The Einstein field equations (EFE) may be written in the form:

$R_{\mu \nu} - {1 \over 2} g_{\mu \nu}\,R + g_{\mu \nu} \Lambda = {8 \pi G \over c^4} T_{\mu \nu}$

...

#### Sign convention

The above form of the EFE is the standard established by _Misner, Thorne, and Wheeler_. The authors analyzed all conventions that exist and classified according to the following three signs (S1, S2, S3):

\begin{align} g_{\mu \nu} & = [S1] \times \operatorname{diag}(-1,+1,+1,+1) \6pt] {R^\mu}_{\alpha \beta \gamma} & = [S2] \times (\Gamma^\mu_{\alpha \gamma,\beta}-\Gamma^\mu_{\alpha \beta,\gamma}+\Gamma^\mu_{\sigma \beta}\Gamma^\sigma_{\gamma \alpha}-\Gamma^\mu_{\sigma \gamma}\Gamma^\sigma_{\beta \alpha}) \\[6pt] G_{\mu \nu} & = [S3] \times {8 \pi G \over c^4} T_{\mu \nu} \end{align} The third sign above is related to the choice of convention for the Ricci tensor: R_{\mu \nu}=[S2]\times [S3] \times {R^\alpha}_{\mu\alpha\nu} ... ### Config Defaults The MathJax plugin comes with some sensible default configuration, that are pretty self explanatory: # Global plugin configurations enabled: true # Set to false to disable this plugin completely active: true # Enable or disable this plugin for a page built_in_css: true # Use built-in CSS of the plugin built_in_js: true # Use built-in JS of the plugin weight: -5 # Set the weight (order of execution) # Default values for MathJax configuration delimiters: inline: # Inline delimiters '$$': '$$' # - MathJax/KaTeX '': '' # - LaTeX block: # Block delimiters '\[': '' # - MathJax/KaTeX '': ''            # - LaTeX

CDN:
enabled: true               # Use MathJax Content Delivery Network (CDN)
url: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML

If you need to change any value, then the best process is to copy the mathjax.yaml file into your users/config/plugins/ folder (create it if it doesn't exist), and then modify there. This will override the default settings.

If you want to alter the settings for one or only few pages, you can do so by adding page specific configurations into your page headers, e.g.

mathjax: false

to deactivate MathJax filter just for this page.

### Hosting the MathJax library on your server

The MathJax plugin allows you to either use the MathJax CDN (recommended) or to host the MathJax library on your server. For the latter case do the following:

2. Extract the contents to your Grav user/data/mathjax folder and make sure that the file mathjax.js is present in the above folder (and not in any sub-folders).
3. Copy the mathjax.yaml file into your users/config/plugins/ folder (create it if it doesn't exist), and finally set CDN.enabled: false.

### CSS Stylesheet Override

Something you might want to do is to override the look and feel of the math formulas, and with Grav it is super easy.

Copy the stylesheet assets/css/mathjax.css into the css folder of your custom theme, and add it to the list of CSS files.

user/themes/custom-theme/css/mathjax.css


After that set the built_in_css option of the MathJax plugin to false. That's it.

### JavaScript Override

Something you might want to do is to override the behavior of how MathJax will process your math formulas, and with Grav it is super easy.

Copy the javascript assets/js/mathjax.js into the js folder of your custom theme, and add it to the list of JS files

user/themes/custom-theme/js/mathjax.js


via {% do assets.addJs('theme://js/mathjax.js') %} i.e. in your base.html.twig file located in antimatter/templates/partials/.

After that set the built_in_js option of the MathJax plugin to false. That's it.

You can now edit, override and tweak it however you prefer. For all list of all options please consult the MathJax Documentation or the options for the tex2jax script. For a quick start, the simplest case you can consider is

window.MathJax = {
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
tex2jax: {
inlineMath: [ ['$','$'], ['\$$','\$$'] ],
processEscapes: true
}
};

### Twig Filter

MathJax provides a Twig filter to process MathJax inside contents. To do that, place the following line of code in the theme file you wish to add the MathJax plugin for:

{{ page.content|mathjax }}


## Contributing

You can contribute at any time! Before opening any issue, please search for existing issues and review the guidelines for contributing.