Skip to content

Commit cf3d0a0

Browse files
authored
Merge pull request #1620 from julien-c/patch-1
[docs] Update comment about GitHub breaks
2 parents b8c5541 + 9f2c0d1 commit cf3d0a0

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
@@ -43,7 +43,7 @@ console.log(marked(markdownString));
4343
|Member |Type |Default |Since |Notes |
4444
|:-----------|:---------|:--------|:--------|:-------------|
4545
|baseUrl |`string` |`null` |0.3.9 |A prefix url for any relative link. |
46-
|breaks |`boolean` |`false` |v0.2.7 |If true, add `<br>` on a single line break (copies GitHub). Requires `gfm` be `true`.|
46+
|breaks |`boolean` |`false` |v0.2.7 |If true, add `<br>` on a single line break (copies GitHub behavior on comments, but not on rendered markdown files). Requires `gfm` be `true`.|
4747
|gfm |`boolean` |`true` |v0.2.1 |If true, use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/).|
4848
|headerIds |`boolean` |`true` |v0.4.0 |If true, include an `id` attribute when emitting headings (h1, h2, h3, etc).|
4949
|headerPrefix|`string` |`''` |v0.3.0 |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|

0 commit comments

Comments
 (0)