diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2019-09-30 01:37:50 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2019-09-30 01:54:39 +0300 |
| commit | a960734e6f152d967405bde6e4718daf257043f0 (patch) | |
| tree | 4609e92ba7426684e65bc2107edbb1631a2245dc /README.md | |
| parent | add "Recurring decimals" (diff) | |
| download | jekyll-theme-a960734e6f152d967405bde6e4718daf257043f0.tar.gz jekyll-theme-a960734e6f152d967405bde6e4718daf257043f0.zip | |
work around GitHub limitations for MathJax support
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 21 insertions, 6 deletions
@@ -75,14 +75,29 @@ y = kx + b $$ ``` +[MathJax]: https://www.mathjax.org/ + +#### GitHub workarounds + MathJax version 3 is used, which is unsupported by Kramdown (which produces -`<script type="math/tex; ..."` tags, suitable for MathJax 2. +`<script type="math/tex; ..."` tags, suitable only for MathJax 2. This is why `math_engine` is set to `null` in _config.yml, making Kramdown -output block formulas wrapped in `$$` and inline formulas in `$` respectively. -MathJax is additionally customized to recognize `$` as an inline formula -delimiter in _includes/common/mathjax.html. - -[MathJax]: https://www.mathjax.org/ +output block formulas wrapped in `$$` and inline formulas in `$` respectively +([inside `<span class="kdmath">` elements][kramdown issue]). +Because if this, MathJax is additionally customized to recognize `$` as an +inline formula delimiter in _includes/common/mathjax.html. + +GitHub Pages [helpfully overrides] the `math_engine` setting in your +_config.yml, hardcoding it to `mathjax` instead of `null` (there's a related +[pull request]). +I couldn't find a better way than to override the setting in the markdown +document itself using + + {::options math_engine="+nil+" /} + +[kramdown issue]: https://github.com/gettalong/kramdown/issues/342 +[helpfully overrides]: https://help.github.com/en/articles/configuring-jekyll +[pull request]: https://github.com/github/pages-gem/pull/644 License ------- |