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

support YAML headers #352

Closed
brainchild0 opened this issue Oct 9, 2019 · 1 comment
Closed

support YAML headers #352

brainchild0 opened this issue Oct 9, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@brainchild0
Copy link

An emerging convention involves placing a YAML block at the head of a MarkDown document, to supply metadata that is part of the document but not correctly expressed in MarkDown. Some included fields affect how a document might be optimally displayed, such as title, subtitle, author, and date.

These blocks normally precede any other document content, and are delimited by lines consisting each of three or more dashes. MarkDown engines that do not handle this convention specifically, normally interpret the trailing sequence of dashes to make the preceding line into a level-2 header. The effect is unwanted display artifacts.

A growing number of MarkDown editors recognize this convention, either by merely suppressing regular MarkDown processing for the header, of by generating a display appropriate from the values in the header, such as the title.

I would suggest that Text might function better in a wider range of use cases if support of some such kind were available.

Jekyll and Pandoc are prominent examples of packages that utilize this convention, and their documentation explains the parsing rules.

@brainchild0 brainchild0 added the enhancement New feature or request label Oct 9, 2019
@juliusknorr
Copy link
Member

@brainchild0 Thanks for your feature request. This is a duplicate of #145

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

No branches or pull requests

2 participants