Skip to content

Commit d9fbc6b

Browse files
committed
Fix some typos in the README.
1 parent fbf0752 commit d9fbc6b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ mkdocs serve
2424

2525
### Content
2626

27-
Most of it is in `docs/3/`, which is the documentation of the current major release. The core documentation directly in it, and module documentation in in a subfolder.
27+
Most of it is in `docs/3/`, which is the documentation of the current major release. The core documentation directly in it, and module documentation in a subfolder.
2828
Each module is documented by a YAML file, that is formatted by the MkDocs extension using `mkdocs_inspircd/templates/module.md.j2`.
2929
The data is also interpreted by the documentation to generate tables in the core documentation (eg. to provide a list of all commands of all modules).
3030

3131
`docs/4/` contains preparatory work for the next major release.
3232

3333
### MkDocs extension
3434

35-
`mkdocs_inspircd/` contains an extension for MkDocs, that does two things things:
35+
`mkdocs_inspircd/` contains an extension for MkDocs, that does two things:
3636

3737
#### Rendering module documentation
3838

@@ -42,12 +42,12 @@ This avoids inconsistencies, and easier changes in the structure; and to access
4242
To do this, the MkDocs extension implements [the `on_files` hook](https://www.mkdocs.org/dev-guide/plugins/#on_files), so MkDocs detects `.yml` files as source files (as if they were `.md`).
4343

4444
It also implements [the `on_page_read_source` hook](https://www.mkdocs.org/dev-guide/plugins/#on_page_read_source) to convert the YAML content to Markdown on the fly, because MkDocs tries to parse it.
45-
This is done simply by rending `mkdocs_inspircd/templates/module.md.j2` with the YAML content as context.
45+
This is done simply by rendering `mkdocs_inspircd/templates/module.md.j2` with the YAML content as context.
4646

4747
#### Jinja templating for Markdown
4848

4949
Some pages, like `docs/3/channel-modes.md`, use dynamic data to populate tables (eg. the table of all plugins' channel modes) without duplicating data from plugins.
50-
This is done by the [the `on_page_markdown` hook](https://www.mkdocs.org/dev-guide/plugins/#on_page_markdown), which is executed just before MkDocs parses renders Markdown.
50+
This is done by [the `on_page_markdown` hook](https://www.mkdocs.org/dev-guide/plugins/#on_page_markdown), which is executed just before MkDocs parses renders Markdown.
5151
This hook interprets Markdown documents as if they were Jinja templates, and passes them module data in the context; which produces the final Markdown document.
5252

5353
### License

0 commit comments

Comments
 (0)