commit 80c4ca7c7113e02625108ff5eed55281522e545c parent 5722b45633b0cea02be00f765a5633ddd79ea4cc Author: Beni Cherniavsky-Paskin <cben@users.sf.net> Date: Wed, 1 Oct 2014 18:58:26 +0300 Mention `\displaystyle` workaround in README until the question of display math API (#66) is decided either way... Diffstat:
| M | README.md | | | 8 | ++++++++ |
1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -39,6 +39,14 @@ var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}"); Make sure to include the CSS and font files, but there is no need to include the JavaScript. +These APIs default to inline math typesetting; for display math you can prepend `\displaystyle` ([#66](https://github.com/Khan/KaTeX/issues/66)): + +```js +katex.render("\\displaystyle " + formula, element); +// OR +var html = katex.renderToString("\\displaystyle " + formula); +``` + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md)