Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use YAML Frontmatter inside Markdown files #352

Open
morallo opened this issue Jul 27, 2021 · 1 comment
Open

Use YAML Frontmatter inside Markdown files #352

morallo opened this issue Jul 27, 2021 · 1 comment

Comments

@morallo
Copy link

morallo commented Jul 27, 2021

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
Copy link
Author

morallo commented Jul 27, 2021

Relevant Github Issue for this:
github/markup#1490

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant