patrick/KaTeX
1
0
Fork 0
mirror of https://github.com/Smaug123/KaTeX synced 2025-10-05 11:18:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small tweaks to documentation (#1527)

Browse Source
This commit is contained in:
Erik Demaine
2018-07-29 23:25:38 -04:00
committed by ylemkimon
parent a76c4b9a2f
commit c88fa70a62
10 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/options.md
View File

@@ -2,7 +2,7 @@
id: options
title: Options
---
You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are:
You can provide an object of options as the last argument to [`katex.render` and `katex.renderToString`](api.md). Available options are:
- `displayMode`: `boolean`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`)
- `throwOnError`: `boolean`. If `true` (the default), KaTeX will throw a `ParseError` when it encounters an unsupported command or invalid LaTeX. If `false`, KaTeX will render unsupported commands as text, and render invalid LaTeX as its source code with hover text giving the error, in the color given by `errorColor`.