atc-react icon indicating copy to clipboard operation
atc-react copied to clipboard

Use YAML Frontmatter inside Markdown files

Open morallo opened this issue 4 years ago • 1 comments

Hello,

Considering that most of the content in atc-react is to be consumed by humans and mostly "document oriented", have you considered replacing YAML files with Markdown (.md) files that contain the YAML metadata as a Frontmatter header?

This way, the text of the files would be directly rendered in HTML by Github, including the YAML metadata as a table at the top. Currently the format is quite inflexible and does not fit, but maybe one day it will be possible to flag the files so that the table is rendered more beautifully (1 row per value, instead of 1 single row with a column per value).

Another potential benefit would be the use of the YAML variables in the markdown, following the Jekyll format.

I know it would be a significant change and I'm probably missing many downsides but that is why I create this issue :-)

morallo avatar Jul 27 '21 15:07 morallo

Relevant Github Issue for this: https://github.com/github/markup/issues/1490

morallo avatar Jul 27 '21 16:07 morallo