diff options
| -rw-r--r-- | docs/change_log/release-2.1.md | 2 | ||||
| -rw-r--r-- | docs/extensions/admonition.md | 4 | ||||
| -rw-r--r-- | docs/extensions/api.md | 12 | ||||
| -rw-r--r-- | docs/reference.md | 2 |
4 files changed, 10 insertions, 10 deletions
diff --git a/docs/change_log/release-2.1.md b/docs/change_log/release-2.1.md index 5a8bdad..5b994d4 100644 --- a/docs/change_log/release-2.1.md +++ b/docs/change_log/release-2.1.md @@ -90,7 +90,7 @@ do a conversion. Methods on instances of the Markdown class that do not return results can now be changed allowing one to do `md.reset().convert(moretext)`. -The Markdown class was refactored so that a subclass could define it's own +The Markdown class was refactored so that a subclass could define its own `build_parser` method which would build a completely different parser. In other words, one could use the basic machinery in the markdown library to build a parser of a different markup language without the overhead of building diff --git a/docs/extensions/admonition.md b/docs/extensions/admonition.md index a6a8398..2d2634d 100644 --- a/docs/extensions/admonition.md +++ b/docs/extensions/admonition.md @@ -61,14 +61,14 @@ If you don't want a title, use a blank string `""`: ```md !!! important "" - This is a admonition box without a title. + This is an admonition box without a title. ``` results in: ```html <div class="admonition important"> -<p>This is a admonition box without a title.</p> +<p>This is an admonition box without a title.</p> </div> ``` diff --git a/docs/extensions/api.md b/docs/extensions/api.md index ad0d254..a110cef 100644 --- a/docs/extensions/api.md +++ b/docs/extensions/api.md @@ -172,7 +172,7 @@ does not appear to be a link, it returns `None` for the start and end boundary in order to communicate to the parser that no match was found. ```python - # Just a snippet of of the link's handleMatch + # Just a snippet of the link's handleMatch # method to illustrate new logic def handleMatch(self, m, data): text, index, handled = self.getText(data, m.end(0)) @@ -417,7 +417,7 @@ An instance of the **`BlockParser`** is found at `Markdown.parser`. method will generally only be used internally to recursively parse nested blocks of text. -While is is not recommended, an extension could subclass or completely replace +While it is not recommended, an extension could subclass or completely replace the `BlockParser`. The new class would have to provide the same public API. However, be aware that other extensions may expect the core parser provided and will not work with such a drastically different parser. @@ -756,7 +756,7 @@ For example: ```python import markdown -from path.to.module import MyExtention +from path.to.module import MyExtension md = markdown.Markdown(extensions=[MyExtension(option='value')]) ``` @@ -788,7 +788,7 @@ After a user installs your extension using the above script, they could then call the extension using the `myextension` string name like this: ```python -markdown.markdown(text, extensions=['myextention']) +markdown.markdown(text, extensions=['myextension']) ``` Note that if two or more entry points within the same group are assigned the @@ -808,13 +808,13 @@ be at the end of the name and be separated by a colon from the module. Therefore, if you were to import the class like this: ```python -from path.to.module import MyExtention +from path.to.module import MyExtension ``` Then the extension can be loaded as follows: ```python -markdown.markdown(text, extensions=['path.to.module:MyExtention']) +markdown.markdown(text, extensions=['path.to.module:MyExtension']) ``` You do not need to do anything special to support this feature. As long as your diff --git a/docs/reference.md b/docs/reference.md index 60c97eb..936d389 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -200,7 +200,7 @@ __lazy_ol__{: #lazy_ol }: 5. Oranges 6. Pears - By default markdown will ignore the fact the the first line started + By default markdown will ignore the fact that the first line started with item number "4" and the HTML list will start with a number "1". If `lazy_ol` is set to `False`, then markdown will output the following HTML: |