Skip to content

Commit 4a6dcc9

Browse files
authored
Add deprecation note for pedantic mode
Closes GH-470. Closes GH-477. Related-to GH-480. Reviewed-by: Christian Murphy <[email protected]>
1 parent a029045 commit 4a6dcc9

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

packages/remark-parse/readme.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -175,20 +175,10 @@ referenced from inside other footnotes.
175175

176176
###### `options.pedantic`
177177

178-
Pedantic mode (`boolean`, default: `false`).
179-
180-
```markdown
181-
Check out some_file_name.txt
182-
```
183-
184-
Turns on:
185-
186-
* Emphasis (`_alpha_`) and importance (`__bravo__`) with underscores in words
187-
* Unordered lists with different markers (`*`, `-`, `+`)
188-
* If `commonmark` is also turned on, ordered lists with different markers
189-
(`.`, `)`)
190-
* And removes less spaces in list items (at most four, instead of the whole
191-
indent)
178+
⚠️ Pedantic was previously used to mimic old-style Markdown mode: no tables, no
179+
fenced code, and with many bugs.
180+
It’s currently still “working”, but please do not use it, it’ll be removed in
181+
the future.
192182

193183
###### `options.blocks`
194184

packages/remark-stringify/readme.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,10 @@ Stringify for CommonMark compatible Markdown (`boolean`, default: `false`).
124124

125125
###### `options.pedantic`
126126

127-
Stringify for pedantic compatible markdown (`boolean`, default: `false`).
128-
129-
* Escape underscores in words
127+
⚠️ Pedantic was previously used to mimic old-style Markdown mode: no tables, no
128+
fenced code, and with many bugs.
129+
It’s currently still “working”, but please do not use it, it’ll be removed in
130+
the future.
130131

131132
###### `options.entities`
132133

0 commit comments

Comments
 (0)