Skip to content

Commit

Permalink
Merge pull request markedjs#1381 from UziTech/breaks-option
Browse files Browse the repository at this point in the history
fix `breaks` option description
  • Loading branch information
styfle committed Nov 28, 2018
2 parents d895a37 + b9fe5f1 commit e10c2f1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/USING_ADVANCED.md
Expand Up @@ -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 `<br>` 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).|
Expand Down

0 comments on commit e10c2f1

Please sign in to comment.