Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Update comment about GitHub breaks #1620

Merged
merged 3 commits into from Mar 19, 2020
Merged

[docs] Update comment about GitHub breaks #1620

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e3d20d
Remove inaccurate proposition on GitHub
julien-c Mar 17, 2020
885d728
Update docs/USING_ADVANCED.md
julien-c Mar 19, 2020
9f2c0d1
Update docs/USING_ADVANCED.md
julien-c Mar 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/USING_ADVANCED.md
View file
Open in desktop
Expand Up @@ -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 `<br>` on a single line break (copies GitHub). Requires `gfm` be `true`.|
|breaks |`boolean` |`false` |v0.2.7 |If true, add `<br>` on a single line break. Requires `gfm` be `true`.|
julien-c marked this conversation as resolved.
Show resolved Hide resolved
|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).|
Expand Down