Skip to content

Commit e10c2f1

Browse files
authored
Merge pull request markedjs#1381 from UziTech/breaks-option
fix `breaks` option description
2 parents d895a37 + b9fe5f1 commit e10c2f1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/USING_ADVANCED.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ console.log(myMarked('I am using __markdown__.'));
4242
|Member |Type |Default |Since |Notes |
4343
|:-----------|:---------|:--------|:--------|:-------------|
4444
|baseUrl |`string` |`null` |??? |A prefix url for any relative link. |
45-
|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`.|
45+
|breaks |`boolean` |`false` |??? |If true, add `<br>` on a single line break (copies GitHub). Requires `gfm` be `true`.|
4646
|gfm |`boolean` |`true` |??? |If true, use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/).|
4747
|headerIds |`boolean` |`true` |v0.4.0 |If true, include an `id` attribute when emitting headings (h1, h2, h3, etc).|
4848
|headerPrefix|`string` |`''` |??? |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|

0 commit comments

Comments
 (0)