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

Metadata at start of Markdown should be in standard YAML Front Matter (at least optionally) #877

Open
vorburger opened this issue Oct 28, 2023 · 0 comments

Comments

@vorburger
Copy link

vorburger commented Oct 28, 2023

The id: etc. "Metadata" documented here currently (quote) "must come before the title".

This is unusual by Markdown "standards" (as far as there is such a thing; I know!); typically such "headers" are put into "YAML Front Matter". Some other Markdown parsers can ignore it as text, but extract it for processing. GitHub (now) renders this "nicely", see https://github.blog/2013-09-27-viewing-yaml-metadata-in-your-documents/.

So instead of e.g. this:

id: my-codelab

# My Codelab

claat should, at least optionally (for backwards compability) support this:

---
id: my-codelab
---

# My Codelab

It currently doesn't, and fails, saying: codelab.md invalid metadata format, missing at least id: map[duration:0:02:00]

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