From 169837de5f9649ea41107030c148cd7f31615fb7 Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Mon, 30 Sep 2019 00:49:31 +0300
Subject: add MathJax support

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e57ab9f..67d35f2 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,30 @@ One easy workaround is to `wget` the website and convert the links:
 
     wget --convert-links --recursive http://localhost:4000/
 
+### Typesetting math
+
+[MathJax] can be used to typeset mathematics using LaTeX.
+To use MathJax, set `mathjax` to `true` in page's front matter.
+Then you can do things like this:
+
+```
+This is an inline formula: $$y = kx + b$$.
+This is a formula in a separate block:
+
+$$
+y = kx + b
+$$
+```
+
+MathJax version 3 is used, which is unsupported by Kramdown (which produces
+`<script type="math/tex; ..."` tags, suitable 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/
+
 License
 -------
 
-- 
cgit v1.2.3