Markdown: Sections missing in the rendering

[nkh]

50% of this file is missing in the rendering https://github.com/nkh/ftl/blob/main/config/ftl/man/ftl.md, all the other renderes I use renders the missing sections, the link above also shows a rendering.

[davep]

Thanks; given that this really comes down to how the Textual Markdown widget sees the file you point to, I've moved the issue to here.

[davep]

It's worth noting that if I drop the document linked above into the markdown-it online demo it appears to render fine. Initially this would suggest a bug in our Markdown handling.

[nkh]

here's a minimum markdown that doesn't work:

## General *ftl* Commands

        «?»             Show this man page 

[davep]

Nice job! Thanks. As minimal examples go it doesn't get better than that! 👍

[TomJGooding]

It looks like Textual parses fenced code blocks, but not code blocks created with indentation which have a different Token type.

Might be worth also taking issue #2676 into consideration for any changes to how the code blocks are parsed?

(Apologies for the broken up code below caused by the triple backticks!)

from markdown_it import MarkdownIt
from textual.app import App, ComposeResult
from textual.containers import Container
from textual.widgets import Footer, Markdown, TextLog

MARKDOWN_V1 = """
## General *ftl* Commands

        «?»             Show this man page
"""

MARKDOWN_V2 = """
## General *ftl* Commands

    «?»             Show this man page

"""


PARSER = MarkdownIt("gfm-like")


class MarkdownExampleApp(App):
    BINDINGS = [("space", "switch_markdown", "Switch Markdown")]
    CSS = """
    #sidebar {
        dock: left;
        width: 40;
    }

    TextLog {
        border: double $accent;
        height: 1fr;
    }
    """

    markdown_vers = MARKDOWN_V1

    def compose(self) -> ComposeResult:
        yield Markdown(self.markdown_vers)
        with Container(id="sidebar"):
            yield TextLog(id="markdown-it")
            yield TextLog(id="textual-md")
        yield Footer()

    def on_mount(self) -> None:
        self.update_logs()

    def action_switch_markdown(self) -> None:
        if self.markdown_vers == MARKDOWN_V1:
            self.markdown_vers = MARKDOWN_V2
        else:
            self.markdown_vers = MARKDOWN_V1

        markdown = self.query_one(Markdown)
        markdown.update(self.markdown_vers)

        self.update_logs()

    def update_logs(self) -> None:
        markdown_it_log = self.query_one("#markdown-it", TextLog)
        markdown_it_log.border_title = "markdown-it tokens"
        markdown_it_log.clear()
        markdown_it_log.write(PARSER.parse(self.markdown_vers))

        textual_md_log = self.query_one("#textual-md", TextLog)
        textual_md_log.border_title = "Textual markdown"
        textual_md_log.clear()
        markdown = self.query_one(Markdown)
        for child in markdown.walk_children():
            textual_md_log.write(child)


if __name__ == "__main__":
    app = MarkdownExampleApp()
    app.run()

[davep]

Thanks for diving in and checking this @TomJGooding, very helpful (good recollection of the other issue too). Looking like Markdown does need a bit more love soon (there's a couple or so Frogmouth issues that would benefit from Markdown being extended).

[willmcgugan]

Going to put this on the ToDo for next week.

[github-actions]

Don't forget to star the repository!

Follow @textualizeio for Textual updates.