diff --git a/contrib/auto-render/README.md b/contrib/auto-render/README.md index 49d9b77e9..eaf4edcc2 100644 --- a/contrib/auto-render/README.md +++ b/contrib/auto-render/README.md @@ -41,23 +41,24 @@ nodes inside this element and render the math in them. `options` is an optional object argument with the following keys: - - `delimiters`: This is a list of delimiters to look for math. Each delimiter - has three properties: +- `delimiters`: This is a list of delimiters to look for math. Each delimiter + has three properties: - - `left`: A string which starts the math expression (i.e. the left delimiter). - - `right`: A string which ends the math expression (i.e. the right delimiter). - - `display`: A boolean of whether the math in the expression should be - rendered in display mode or not. + - `left`: A string which starts the math expression (i.e. the left delimiter). + - `right`: A string which ends the math expression (i.e. the right delimiter). + - `display`: A boolean of whether the math in the expression should be + rendered in display mode or not. - The default value is: -```js -[ - {left: "$$", right: "$$", display: true}, - {left: "\\[", right: "\\]", display: true}, - {left: "\\(", right: "\\)", display: false} -] -``` + The default value is: + + ```js + [ + {left: "$$", right: "$$", display: true}, + {left: "\\[", right: "\\]", display: true}, + {left: "\\(", right: "\\)", display: false} + ] + ``` - - `ignoredTags`: This is a list of DOM node types to ignore when recursing - through. The default value is - `["script", "noscript", "style", "textarea", "pre", "code"]`. +- `ignoredTags`: This is a list of DOM node types to ignore when recursing + through. The default value is + `["script", "noscript", "style", "textarea", "pre", "code"]`.