Skip to content

Commit 2fee1a1

Browse files
authored
Merge pull request #1171 from vsemozhetbyt/doc-marked-defaults
Complement options table in USING_ADVANCED.md
2 parents 05aa7f1 + ef1f8a4 commit 2fee1a1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/USING_ADVANCED.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ console.log(myMarked('I am using __markdown__.'));
4141

4242
|Member |Type |Notes |
4343
|:----------|:---------|:----------------------------------------------------------------------------------------------------------------------------|
44-
|highlight |`function`|A function to highlight code blocks. See also: <a href="#highlight">Asynchronous highlighting</a>. |
45-
|renderer |`object` |An object containing functions to render tokens to HTML. See [extensibility](https://github.com/markedjs/marked/blob/master/docs/USING_PRO.md) for more details. Default: `new Renderer()`|
46-
|pedantic |`boolean` |Conform to obscure parts of `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Default: `false`|
47-
|gfm |`boolean` |Use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/). |
48-
|tables |`boolean` |Use [GFM Tables extension](https://github.github.com/gfm/#tables-extension-). Requires `gfm` be `true`. |
49-
|breaks |`boolean` |Use GFM [hard](https://github.github.com/gfm/#hard-line-breaks) and [soft](https://github.github.com/gfm/#soft-line-breaks) line breaks. Requires `gfm` be `true`. Default: `false`|
50-
|sanitize |`boolean` |Ignore HTML passed into `markdownString` (sanitize the input). Default: `false` |
51-
|smartlists |`boolean` |Use smarter list behavior than those found in `markdown.pl`. Default: `true` |
52-
|smartypants|`boolean` |Use "smart" typographic punctuation for things like quotes and dashes. |
53-
|xhtml |`boolean` |Self-close the tags for void elements (&lt;br/&gt;, &lt;img/&gt;, etc.) with a "/" as required by XHTML. Default: `false` |
44+
|highlight |`function`|A function to highlight code blocks. See also: <a href="#highlight">Asynchronous highlighting</a>.|
45+
|renderer |`object` |An object containing functions to render tokens to HTML. See [extensibility](https://github.com/markedjs/marked/blob/master/docs/USING_PRO.md) for more details. Default: `new Renderer()`.|
46+
|pedantic |`boolean` |Conform to obscure parts of `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Default: `false`.|
47+
|gfm |`boolean` |Use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/). Default: `true`.|
48+
|tables |`boolean` |Use [GFM Tables extension](https://github.github.com/gfm/#tables-extension-). Requires `gfm` be `true`. Default: `true`.|
49+
|breaks |`boolean` |Use GFM [hard](https://github.github.com/gfm/#hard-line-breaks) and [soft](https://github.github.com/gfm/#soft-line-breaks) line breaks. Requires `gfm` be `true`. Default: `false`.|
50+
|sanitize |`boolean` |Ignore HTML passed into `markdownString` (sanitize the input). Default: `false`.|
51+
|smartlists |`boolean` |Use smarter list behavior than those found in `markdown.pl`. Default: `true`.|
52+
|smartypants|`boolean` |Use "smart" typographic punctuation for things like quotes and dashes. Default: `false`.|
53+
|xhtml |`boolean` |Self-close the tags for void elements (&lt;br/&gt;, &lt;img/&gt;, etc.) with a "/" as required by XHTML. Default: `false`.|
5454

5555
<h2 id="highlight">Asynchronous highlighting</h2>
5656

0 commit comments

Comments
 (0)