Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Add a YAML FrontMatter metadata parser #41

Open
alfredbaudisch opened this issue Sep 23, 2021 · 2 comments · May be fixed by #57
Open

Add a YAML FrontMatter metadata parser #41

alfredbaudisch opened this issue Sep 23, 2021 · 2 comments · May be fixed by #57
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@alfredbaudisch
Copy link
Owner

alfredbaudisch commented Sep 23, 2021

Proposed Solution

  1. Parse YAML to Elixir, getting an Elixir map from the YAML FrontMatter string.
  2. Then, feed the resulting elixir map to the current ElixirMap parser, this way, there's no need to worry about the low level details

As an example, the JoplinNote parser also uses the ElixirMap parser. This way you don't need to worry about the inner details of what the YAML data contains, the validation is all done by ElixirMap and FileParser anyway.

Example markdown file

---
title: Elixir!
---

Content...
@alfredbaudisch alfredbaudisch added the enhancement New feature or request label Sep 23, 2021
@alfredbaudisch alfredbaudisch changed the title Add a YAML metadata parser Add a YAML FrontMatter metadata parser Sep 23, 2021
@alfredbaudisch alfredbaudisch added the good first issue Good for newcomers label Nov 9, 2021
@alfredbaudisch
Copy link
Owner Author

@rockchalkwushock Wanna tackle this one? I added the steps to the issue.

@rockchalkwushock
Copy link
Contributor

@alfredbaudisch yep I think I can tackle this pretty easily. I will review it more this afternoon and if I have any questions post them here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants