From 4a6dcc977f0997c721dc9c6f7a5bdc11d007934e Mon Sep 17 00:00:00 2001 From: Titus Date: Sat, 28 Mar 2020 09:27:53 +0100 Subject: [PATCH] Add deprecation note for `pedantic` mode Closes GH-470. Closes GH-477. Related-to GH-480. Reviewed-by: Christian Murphy --- packages/remark-parse/readme.md | 18 ++++-------------- packages/remark-stringify/readme.md | 7 ++++--- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/packages/remark-parse/readme.md b/packages/remark-parse/readme.md index ea975cb42..d8c1c85ca 100644 --- a/packages/remark-parse/readme.md +++ b/packages/remark-parse/readme.md @@ -175,20 +175,10 @@ referenced from inside other footnotes. ###### `options.pedantic` -Pedantic mode (`boolean`, default: `false`). - -```markdown -Check out some_file_name.txt -``` - -Turns on: - -* Emphasis (`_alpha_`) and importance (`__bravo__`) with underscores in words -* Unordered lists with different markers (`*`, `-`, `+`) -* If `commonmark` is also turned on, ordered lists with different markers - (`.`, `)`) -* And removes less spaces in list items (at most four, instead of the whole - indent) +⚠️ Pedantic was previously used to mimic old-style Markdown mode: no tables, no +fenced code, and with many bugs. +It’s currently still “working”, but please do not use it, it’ll be removed in +the future. ###### `options.blocks` diff --git a/packages/remark-stringify/readme.md b/packages/remark-stringify/readme.md index 63883c23f..401f17a6c 100644 --- a/packages/remark-stringify/readme.md +++ b/packages/remark-stringify/readme.md @@ -124,9 +124,10 @@ Stringify for CommonMark compatible Markdown (`boolean`, default: `false`). ###### `options.pedantic` -Stringify for pedantic compatible markdown (`boolean`, default: `false`). - -* Escape underscores in words +⚠️ Pedantic was previously used to mimic old-style Markdown mode: no tables, no +fenced code, and with many bugs. +It’s currently still “working”, but please do not use it, it’ll be removed in +the future. ###### `options.entities`