From 3c4006c14fa2fb8f7693708d1728da47f5b08b6c Mon Sep 17 00:00:00 2001 From: cbreeden Date: Thu, 12 May 2016 18:57:20 -0500 Subject: [PATCH] Updated Readme to include Syntax information --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 1b36e7b..49dcc91 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,17 @@ $$\begin{array}{c} \end{array}$$ ``` +## Syntax + +Math parsing in markdown is designed to agree with the conventions set by pandoc: + + Anything between two $ characters will be treated as TeX math. The opening $ must + have a non-space character immediately to its right, while the closing $ must + have a non-space character immediately to its left, and must not be followed + immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some + reason you need to enclose text in literal $ characters, backslash-escape them and + they won’t be treated as math delimiters. + ## Math Syntax Support KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of