markdown-it-meta-yaml

Markdown-It plugin for parsing YAML front matter.

Parsing YAML-formatted metadata from markdown files and converting it into JSON-formatted data.

🥳 All YAML values are supported - powered by js-yaml

1---
2title: Hello Markdown
3date: 2023-03-25 12:00
4score: 1.8
5tags:
6  - frontend
7  - markdown
8---

👇🏻

1{
2  "title": "Hello Markdown",
3  "date": "2023-03-25 12:00",
4  "score": 1.8,
5  "tags": [
6    "frontend",
7    "markdown"
8  ]
9}

Usage

Use it as a plugin for markdown-it

1npm install markdown-it-meta-yaml

1import MarkdownIt from 'markdown-it'
2import markdownItMetaYaml from 'markdown-it-meta-yaml'
3
4const markdownIt = new MarkdownIt()
5markdownIt.use(markdownItMetaYaml, {
6  cb: (metaJSON, metaRaw) => console.log(metaJSON, metaRaw)
7})
8
9// metaJSON =>
10// {
11//   "title": "Hello Markdown",
12//   "date": "2023-03-25 12:00",
13//   "score": 1.8,  
14//   "tags": [
15//     "frontend",
16//     "markdown"
17//   ]
18// }
19
20// metaRaw =>
21// title: Hello Markdown
22// date: 2023-03-25 12:00
23// score: 1.8
24// tags:
25//   - frontend
26//   - markdown

License

MIT License © 2023 Kricsleo