Skip to content

Commit 9e0b68c

Browse files
authored
Add notes on security
1 parent 8b34031 commit 9e0b68c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

readme.md

+10
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ If no value is found, the algorithm checks the children of `node` and joins them
4545
> This is not a markdown to plain-text library.
4646
> Use [`strip-markdown`][strip-markdown] for that.
4747
48+
## Security
49+
50+
Use of `mdast-util-to-string` does not involve [**hast**][hast], user content,
51+
or change the tree, so there are no openings for
52+
[cross-site scripting (XSS)][xss] attacks.
53+
4854
## Related
4955

5056
* [`nlcst-to-string`](https://github.com/syntax-tree/nlcst-to-string)
@@ -113,3 +119,7 @@ abide by its terms.
113119
[node]: https://github.com/syntax-tree/mdast#nodes
114120

115121
[strip-markdown]: https://github.com/remarkjs/strip-markdown
122+
123+
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
124+
125+
[hast]: https://github.com/syntax-tree/hast

0 commit comments

Comments
 (0)