From b9fe5f10befe9988e68955d61ef81b6a978eb897 Mon Sep 17 00:00:00 2001 From: Tony Brix Date: Tue, 27 Nov 2018 16:52:37 -0600 Subject: [PATCH] fix `breaks` option description --- docs/USING_ADVANCED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/USING_ADVANCED.md b/docs/USING_ADVANCED.md index 1b2b84b1aa..2c91fbec7f 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -42,7 +42,7 @@ console.log(myMarked('I am using __markdown__.')); |Member |Type |Default |Since |Notes | |:-----------|:---------|:--------|:--------|:-------------| |baseUrl |`string` |`null` |??? |A prefix url for any relative link. | -|breaks |`boolean` |`false` |??? |If true, 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`.| +|breaks |`boolean` |`false` |??? |If true, add `
` on a single line break (copies GitHub). Requires `gfm` be `true`.| |gfm |`boolean` |`true` |??? |If true, use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/).| |headerIds |`boolean` |`true` |v0.4.0 |If true, include an `id` attribute when emitting headings (h1, h2, h3, etc).| |headerPrefix|`string` |`''` |??? |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|