markdown-it-front-matter.rs

一个用于处理 front matter 容器的 markdown-it 插件。

使用方法

let parser = &mut markdown_it::MarkdownIt::new();
markdown_it_front_matter::add(parser);
let ast  = parser.parse("---\nfoo: bar\n---\n");

print!("{:#?}", ast.children);
// [
//     Node {
//         children: [],
//         srcmap: Some(
//             (
//                 0,
//                 16,
//             ),
//         ),
//         ext: NodeExtSet(
//             {},
//         ),
//         attrs: [],
//         node_type: markdown_it_front_matter::FrontMatter,
//         node_value: FrontMatter {
//             content: "foo: bar\n",
//         },
//     },
// ]

有效的 front matter

基本上，有效的 front matter 是一个带有边界的区块

• 通过 三个 或 更多 的破折号表示：---
• 开启和关闭的边界必须具有相同数量的 破折号 字符
• 开启边界必须位于 markdown 字符串/文件的第一行
• 开启边界不能缩进

---
valid-front-matter: true
---