Skip to content

Commit 0c38172

Browse files
committed
add sanitize deprecation warnings to docs
1 parent 506704a commit 0c38172

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ These documentation pages are also rendered using marked 💯
2525

2626
<h2 id="usage">Usage</h2>
2727

28-
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML by default 🚨
28+
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML. Please use e.g. [DOMPurify](https://github.com/cure53/DOMPurify) to sanitize the HTML output! 🚨
2929

3030
**CLI**
3131

docs/USING_ADVANCED.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ console.log(marked(markdownString));
5151
|mangle |`boolean` |`true` |v0.3.4 |If true, autolinked email address is escaped with HTML character references.|
5252
|pedantic |`boolean` |`false` |v0.2.1 |If true, conform to the original `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides `gfm`.|
5353
|renderer |`object` |`new Renderer()`|v0.3.0|An object containing functions to render tokens to HTML. See [extensibility](USING_PRO.md) for more details.|
54-
|sanitize |`boolean` |`false` |v0.2.1 |If true, sanitize the HTML passed into `markdownString` with the `sanitizer` function.|
54+
|sanitize |`boolean` |`false` |v0.2.1 |If true, sanitize the HTML passed into `markdownString` with the `sanitizer` function.<br>**Warning**: This feature is deprecated and it should NOT be used as it cannot be considered as a security boundary. Please use e.g. [DOMPurify](https://github.com/cure53/DOMPurify) instead! |
5555
|sanitizer |`function`|`null` |v0.3.4 |A function to sanitize the HTML passed into `markdownString`.|
5656
|silent |`boolean` |`false` |v0.2.7 |If true, the parser does not throw any exception.|
5757
|smartLists |`boolean` |`false` |v0.2.8 |If true, use smarter list behavior than those found in `markdown.pl`.|

0 commit comments

Comments
 (0)