From 4e3d20db6a7eec060100cc6db1a1509da5db2224 Mon Sep 17 00:00:00 2001 From: Julien Chaumond Date: Tue, 17 Mar 2020 13:56:37 -0400 Subject: [PATCH 1/3] Remove inaccurate proposition on GitHub GitHub does not, in fact, appear to break on a single line. --- 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 81df205b98..8e57be564c 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -43,7 +43,7 @@ console.log(marked(markdownString)); |Member |Type |Default |Since |Notes | |:-----------|:---------|:--------|:--------|:-------------| |baseUrl |`string` |`null` |0.3.9 |A prefix url for any relative link. | -|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break (copies GitHub). Requires `gfm` be `true`.| +|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break. Requires `gfm` be `true`.| |gfm |`boolean` |`true` |v0.2.1 |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` |`''` |v0.3.0 |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).| From 885d728a7299c70e32f57eee4400fd5ba117cb43 Mon Sep 17 00:00:00 2001 From: Julien Chaumond Date: Wed, 18 Mar 2020 22:25:53 -0400 Subject: [PATCH 2/3] Update docs/USING_ADVANCED.md Co-Authored-By: Steven --- 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 8e57be564c..af70c20c52 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -43,7 +43,7 @@ console.log(marked(markdownString)); |Member |Type |Default |Since |Notes | |:-----------|:---------|:--------|:--------|:-------------| |baseUrl |`string` |`null` |0.3.9 |A prefix url for any relative link. | -|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break. Requires `gfm` be `true`.| +|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break (copies GitHub comments). Requires `gfm` be `true`.| |gfm |`boolean` |`true` |v0.2.1 |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` |`''` |v0.3.0 |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).| From 9f2c0d16ee54646438d2d1baa0dffcfb334f95af Mon Sep 17 00:00:00 2001 From: Julien Chaumond Date: Wed, 18 Mar 2020 22:28:21 -0400 Subject: [PATCH 3/3] Update docs/USING_ADVANCED.md --- 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 af70c20c52..e958f5418f 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -43,7 +43,7 @@ console.log(marked(markdownString)); |Member |Type |Default |Since |Notes | |:-----------|:---------|:--------|:--------|:-------------| |baseUrl |`string` |`null` |0.3.9 |A prefix url for any relative link. | -|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break (copies GitHub comments). Requires `gfm` be `true`.| +|breaks |`boolean` |`false` |v0.2.7 |If true, add `
` on a single line break (copies GitHub behavior on comments, but not on rendered markdown files). Requires `gfm` be `true`.| |gfm |`boolean` |`true` |v0.2.1 |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` |`''` |v0.3.0 |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|