Allow customizing the markdown parser #2075
Conversation
src/textual/widgets/_markdown.py
Outdated
| @@ -509,6 +514,7 @@ def __init__( | |||
| name: str | None = None, | |||
| id: str | None = None, | |||
| classes: str | None = None, | |||
| parser_factory: Callable[[], MarkdownIt] = default_parser_factory, | |||
There was a problem hiding this comment.
Can we make this None-able. When you need to construct the parser, check for None and create MarkdownIt("gfm-like").
This means we could drop the default_parser_factory function.
There was a problem hiding this comment.
I can rewrite it this way, sure.
Sorry for prematurely requesting your re-review.
src/textual/widgets/_markdown.py
Outdated
| @@ -799,6 +807,7 @@ def __init__( | |||
| name: str | None = None, | |||
| id: str | None = None, | |||
| classes: str | None = None, | |||
| parser_factory: Callable[[], MarkdownIt] = default_parser_factory, | |||
There was a problem hiding this comment.
Some comment as above. Let's make this None able.
For instance, code using Markdown might wish to create a markdown
parser that does not parse embedded HTML:
```py
def parser_factory():
parser = MarkdownIt("gfm-like")
parser.options["html"] = False
return parser
```
jepler
force-pushed
the
customize-markdown-parser
branch
from
0e5e92c
to
4c7e54f
Compare
|
OK -- rebased and now actually ready for re-review. Thank you for your time! |
src/textual/widgets/_markdown.py
Outdated
| @@ -509,6 +508,7 @@ def __init__( | |||
| name: str | None = None, | |||
| id: str | None = None, | |||
| classes: str | None = None, | |||
| parser_factory: Optional[Callable[[], MarkdownIt]] = None | |||
There was a problem hiding this comment.
Can you use | None here, just for consistency sake...
src/textual/widgets/_markdown.py
Outdated
| @@ -574,7 +576,7 @@ async def update(self, markdown: str) -> None: | |||
| """ | |||
| output: list[MarkdownBlock] = [] | |||
| stack: list[MarkdownBlock] = [] | |||
| parser = MarkdownIt("gfm-like") | |||
| parser = self._parser_factory() if self._parser_factory else MarkdownIt("gfm-like") | |||
There was a problem hiding this comment.
Can you make this an explicit is None check please.
|
Thanks again for the feedback. I've updated the PR once more. |
|
Test fail is unrelated to this change. Merging. |
|
Thank you! |
For instance, code using Markdown might wish to create a markdown parser that does not parse embedded HTML:
This is needed to properly render chatgpt's markdown; there are many "knobs" of MarkdownIt and users of the textual library may need to tune them to their needs.