Textualize / frogmouth

A Markdown browser for your terminal

Home Page:https://www.textualize.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

YAML front matter

minimaxir opened this issue · comments

YAML front matter is a common feature for static site/blog generators and Python documentation tools, but frogmouth handles it weirdly. Unclear if it's within scope.

The front matter for one of my blog posts in VS Code:

Screenshot 2023-04-30 at 2 10 50 PM

The front matter in frogmouth:

Screenshot 2023-04-30 at 2 05 12 PM

At this stage we're aiming to handle documents that conform to CommonMark, or thereabouts. But I can see that it would be handy to see about handling this too; I'll keep this in mind.

This should probably be something supported by the Textual Markdown widget.

@willmcgugan Yup, experimented with it briefly this morning and have it working; albeit by "ignoring" the front-matter for now; hence Textualize/textual#2440.

See also #20 for a more general take on this (eg: footnotes could be handy, etc).

Now that Textualize/textual#2803 is part of Textual it should be easy enough to pull in the relevant plugin and make use of it.

As of #96 frontmatter won't be displayed within the document view.