Skip to content

Commit da45c87

Browse files
📚 DOCS: Fix typos (#366)
1 parent 87b16e2 commit da45c87

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In total, a token stream is:
6060
- On the top level - array of paired or single "block" tokens:
6161
- open/close for headers, lists, blockquotes, paragraphs, ...
6262
- codes, fenced blocks, horizontal rules, html blocks, inlines containers
63-
- Each inline token have a `.children` property with a nested token stream for inline content:
63+
- Each inline token has a `.children` property with a nested token stream for inline content:
6464
- open/close for strong, em, link, code, ...
6565
- text, line breaks
6666

@@ -81,7 +81,7 @@ Rules are functions, doing "magic" with parser `state` objects. A rule is associ
8181

8282
Rules are managed by names via [Ruler](https://markdown-it.github.io/markdown-it/#Ruler) instances and can be `enabled` / `disabled` from the [MarkdownIt](https://markdown-it.github.io/markdown-it/#MarkdownIt) methods.
8383

84-
You can note, that some rules have a `validation mode` - in this mode rules do not
84+
Note that some rules have a `validation mode` - in this mode rules do not
8585
modify the token stream, and only look ahead for the end of a token. It's one
8686
important design principle - a token stream is "write only" on block & inline parse stages.
8787

@@ -160,9 +160,9 @@ JSON/XML... You can even use it to generate AST.
160160

161161
## Summary
162162

163-
This was mentioned in [Data flow](md/data-flow), but let's repeat sequence again:
163+
This was mentioned in [Data flow](md/data-flow), but let's repeat the sequence again:
164164

165-
1. Blocks are parsed, and top level of token stream filled with block tokens.
165+
1. Blocks are parsed, and the top level of the token stream filled with block tokens.
166166
2. Content on inline containers is parsed, filling `.children` properties.
167167
3. Rendering happens.
168168

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 <executablebooks@gmail.com>.
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)