Skip to content

Commit

Permalink
stringify: add deprecation note for entities options
Browse files Browse the repository at this point in the history
Closes GH-498.
  • Loading branch information
wooorm committed Jul 17, 2020
1 parent 4673f75 commit 4a49fbc
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions packages/remark-stringify/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,16 +141,9 @@ the future.

###### `options.entities`

How to serialize entities (`string` or `boolean`, default: `false`):

* `true` — Entities are generated for special HTML characters (`&` > `&`)
and non-ASCII characters (`©` > `©`).
If named entities are not (widely) supported, numbered character references
are used (`` > `’`)
* `'numbers'` — Numbered entities are generated (`&` > `&`) for special
HTML characters and non-ASCII characters
* `'escape'` — Special HTML characters are encoded (`&` > `&`, `` >
`’`), non-ASCII characters not (ö persists)
⚠️ `entities` was previously used, but included bugs.
It’s currently still “working”, but please do not use it, it’ll be removed in
the future.

###### `options.setext`

Expand Down

0 comments on commit 4a49fbc

Please sign in to comment.