Skip to content

Commit 8077ce6

Browse files
docs: Correct typos
1. "prohibits some kind of links" should be "prohibits some kinds of links" 2. Reorganize "element `id` and `name`" to "`id` and `name` attributes" 3. Change "autogenerating" to "autogenerate" (i.e. "plugins that ... autogenerate header anchors")
1 parent e3900a8 commit 8077ce6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/security.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ from markdown_it import MarkdownIt
2525
MarkdownIt("js-default").render("*user-submitted* text")
2626
```
2727

28-
Note that even with the default configuration, `markdown-it-py` prohibits some kind of links which could be used for XSS:
28+
Note that even with the default configuration, `markdown-it-py` prohibits some kinds of links which could be used for XSS:
2929

3030
- `javascript:`, `vbscript:`
3131
- `file:`
@@ -37,8 +37,8 @@ If you find a security problem, please report it to <[email protected]>.
3737

3838
Usually, plugins operate with tokenized content, and that's enough to provide safe output.
3939

40-
But there is one non-evident case you should know - don't allow plugins to generate arbitrary element `id` and `name`.
40+
But there is one non-evident case you should know - don't allow plugins to generate arbitrary `id` and `name` attributes.
4141
If those depend on user input - always add prefixes to avoid DOM clobbering.
4242
See [discussion](https://github.com/markdown-it/markdown-it/issues/28) for details.
4343

44-
So, if you decide to use plugins that add extended class syntax or autogenerating header anchors - be careful.
44+
So, if you decide to use plugins that add extended class syntax or autogenerate header anchors - be careful.

0 commit comments

Comments
 (0)