Raneto icon indicating copy to clipboard operation
Raneto copied to clipboard

Implement YAML for meta instead of comment block

Open gilbitron opened this issue 10 years ago • 4 comments

gilbitron avatar Jun 03 '14 14:06 gilbitron

@gilbitron Where did you envision the YAML to live? Should we do a central YAML file per category and put all category, article, and sort metadata in there?

ryanlelek avatar Jan 31 '16 02:01 ryanlelek

I planned to implement YAML instead of the comment block at the top of pages. For example, instead of:

/*
Title: My Page Title
Description: Optional description for search engines
*/

you would have:

Title: My Page Title
Description: Optional description for search engines
---

The reason is so that it would be easier to add associated meta data later on. For example if we wanted to add tags:

Title: My Page Title
Description: Optional description for search engines
Tags:
  - Tag 1
  - Tag 2
  - Tag 3
---

gilbitron avatar Feb 01 '16 09:02 gilbitron

I would love this. The whole...

/*  
Title: Page Title  
Description: Page description here  
*/

...is hated by certain apps. Atom (atom.io) is one of them.

Are there any plans on moving to...

---
Title: Page Title
Description: Description goes here
---

...any time soon?

Atom even recognizes .md files as "GitHub Markdown," but doesn't display the files correctly (in text or markdown preview).

mikeack avatar Feb 22 '16 19:02 mikeack

It's a top priority for sure because it helps with compatibility as you mentioned and also paves the way for us removing the "sort" file we currently use to determine the order of articles.

Marking this as "up-for-grabs" so it's clear no one is specifically working on this yet. Note to Readers: If you'd like to work on this feature, let us know.

See Also: #36 #53 #55 #65 #66 #102 but don't be overwhelmed. Even partial solutions would be appreciated as PRs

ryanlelek avatar Feb 22 '16 19:02 ryanlelek