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

FR Produce valid metadata yaml #10

Open
blaggacao opened this issue May 14, 2020 · 2 comments
Open

FR Produce valid metadata yaml #10

blaggacao opened this issue May 14, 2020 · 2 comments

Comments

@blaggacao
Copy link

There might be a better alternative to the current DSL for the metadata

---
Categories:
 - foo
Tags:
 - bar
Created: ...
---

Title 
===

Benefits:

  • metadata is always good
    • eg. render a html static page with all notes classified according to metadata (like a blog post with tags and categories)

Cons:

  • (simple) migration needed

Would solve #4

@blaggacao blaggacao changed the title Produce valid metadata yaml FR Produce valid metadata yaml May 14, 2020
@rhysd
Copy link
Owner

rhysd commented May 15, 2020

I avoided YAML front matter because it is not a part of markdown (see commonmark spec to know the spec of markdown). It's original extension of some markdown implementation. Some markdown parser does not implement it.

@blaggacao
Copy link
Author

I understand and agree, on the other hand, this is still completely valid markdown:

---          (horizontal rule)
Categories:  (normal word)
 - foo       (bullet point list)
Tags:        (normal word)
 - bar       (bullet point list)
Created: ... (normal word)
---          (horizontal rule)

So maybe even by the measures of the spec compliance, this is just an alternative way to store metadata which happens to also be parseable form a (quite) wide variety of markdown enhancing tools.

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

2 participants