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

Update defaults to match CommonMark & Github conventions #425

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Update defaults to match CommonMark & Github conventions #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
21471d7
Update defaults to match Github conventions (closes #424)
zm-cttae Mar 4, 2023
d44d65a
Fix code fencing option typo for #425
zm-cttae Jul 6, 2023
d1f75b6
Revert `options.br` change: hard->soft break
zm-cttae Jul 20, 2023
f1e7828
Update tests
zm-cttae Jul 17, 2024
bb369b6
Fix test for level 1 setext
zm-cttae Oct 28, 2024
2535e90
Merge branch 'master' into feat-modernize-markdown-defaults
zm-cttae Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,16 @@ var turndownService = new TurndownService({ option: 'value' })

| Option | Valid values | Default |
| :-------------------- | :------------ | :------ |
| `headingStyle` | `setext` or `atx` | `setext` |
| `hr` | Any [Thematic break](http://spec.commonmark.org/0.27/#thematic-breaks) | `* * *` |
| `bulletListMarker` | `-`, `+`, or `*` | `*` |
| `codeBlockStyle` | `indented` or `fenced` | `indented` |
| `headingStyle` | `setext` or `atx` | `atx` |
| `hr` | Any [Thematic break](http://spec.commonmark.org/0.27/#thematic-breaks) | `---` |
| `bulletListMarker` | `-`, `+`, or `*` | `-` |
| `codeBlockStyle` | `indented` or `fenced` | `fenced` |
| `fence` | ` ``` ` or `~~~` | ` ``` ` |
| `emDelimiter` | `_` or `*` | `_` |
| `emDelimiter` | `_` or `*` | `*` |
| `strongDelimiter` | `**` or `__` | `**` |
| `linkStyle` | `inlined` or `referenced` | `inlined` |
| `linkReferenceStyle` | `full`, `collapsed`, or `shortcut` | `full` |
| `br` | ` ` or `\n` | ` ` |
| `preformattedCode` | `false` or [`true`](https://github.com/lucthev/collapse-whitespace/issues/16) | `false` |

### Advanced Options
Expand Down
10 changes: 5 additions & 5 deletions src/turndown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ export default function TurndownService (options) {

var defaults = {
rules: COMMONMARK_RULES,
headingStyle: 'setext',
hr: '* * *',
bulletListMarker: '*',
codeBlockStyle: 'indented',
headingStyle: 'atx',
hr: '---',
bulletListMarker: '-',
codeBlockStyle: 'fenced',
fence: '```',
emDelimiter: '_',
emDelimiter: '*',
strongDelimiter: '**',
linkStyle: 'inlined',
linkReferenceStyle: 'full',
Expand Down
Loading