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

Idea: Switch to yaml frontmatter for metadata #101

Closed
Robert-MacWha opened this issue Jan 25, 2025 · 2 comments
Closed

Idea: Switch to yaml frontmatter for metadata #101

Robert-MacWha opened this issue Jan 25, 2025 · 2 comments

Comments

@Robert-MacWha
Copy link
Contributor

Yaml front matter is a standard way of embedding metadata into markdown documents. It's human-readable, easily parsable by code, and flexible. I'd recommend switching to yaml frontmatter for all future metadata & migrating the existing tags metadata into yaml frontmatter.

Github docs on yaml frontmatter: https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter

Reasons for changing are:

  • Standard across most static site generators (docusaurus, gitbooks)
  • Standard across most CMS' (decap)
  • Simpler to parse, making it easier to add metadata in the future
  • No harm to readability for non-technical users. It's slightly different, but no more complex:
Before After
tags: [SEAL/Initiative, Tag 2]
---
tags:
- SEAL/Initiative
- Tag 2
---

I can handle migrating existing documents & updating the tag processing scripts to handle frontmatter.

@Robert-MacWha
Copy link
Contributor Author

#102

@mattaereal
Copy link
Collaborator

Merged!

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