From 49294bac318b406056d971f0a143f79a9f75ea93 Mon Sep 17 00:00:00 2001 From: Kyo Nagashima Date: Sun, 29 Jul 2018 17:04:56 +0900 Subject: [PATCH] Add un-doumented notes in options `???` is useless. They should be documented as well as other options. --- docs/USING_ADVANCED.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/USING_ADVANCED.md b/docs/USING_ADVANCED.md index 86d5e759fd..1b2b84b1aa 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -48,12 +48,12 @@ console.log(myMarked('I am using __markdown__.')); |headerPrefix|`string` |`''` |??? |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).| |highlight |`function`|`null` |??? |A function to highlight code blocks, see Asynchronous highlighting.| |langPrefix |`string` |`'language-'`|??? |A string to prefix the className in a `` block. Useful for syntax highlighting.| -|mangle |`boolean` |`true` |??? |??? | +|mangle |`boolean` |`true` |??? |If true, autolinked email address is escaped with HTML character references.| |pedantic |`boolean` |`false` |??? |If true, conform to the original `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides `gfm`.| |renderer |`object` |`new Renderer()`|???|An object containing functions to render tokens to HTML. See [extensibility](USING_PRO.md) for more details.| |sanitize |`boolean` |`false` |??? |If true, sanitize the HTML passed into `markdownString` with the `sanitizer` function.| |sanitizer |`function`|`null` |??? |A function to sanitize the HTML passed into `markdownString`.| -|silent |`boolean` |`false` |??? |??? | +|silent |`boolean` |`false` |??? |If true, the parser does not throw any exception.| |smartLists |`boolean` |`false` |??? |If true, use smarter list behavior than those found in `markdown.pl`.| |smartypants |`boolean` |`false` |??? |If true, use "smart" typographic punctuation for things like quotes and dashes.| |tables |`boolean` |`true` |??? |If true and `gfm` is true, use [GFM Tables extension](https://github.github.com/gfm/#tables-extension-).|