A markdown-it plugin to get markdown frontmatter
npm install @mdit-vue/plugin-frontmatter
A markdown-it plugin to get markdown frontmatter with gray-matter.
- Extracts frontmatter into markdown-it env.frontmatter.
- Allows providing default frontmatter via markdown-it env.frontmatter.
- Extracts markdown content without frontmatter into markdown-it env.content.
- Supports extracting rendered excerpt into markdown-it env.excerpt.
``sh`
npm i @mdit-vue/plugin-frontmatter
`ts
import { frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
import type { MarkdownItEnv } from '@mdit-vue/types';
import MarkdownIt from 'markdown-it';
const md = MarkdownIt({ html: true }).use(frontmatterPlugin, {
// options
grayMatterOptions: {
excerpt: true,
excerpt_separator: '',
},
});
const env: MarkdownItEnv = {};
const rendered = md.render(
\
---
title: foobar
---
Everything above more comment will be extracted as excerpt.
Things below more comment will not be included in the excerpt.,
env,
);
console.log(env.frontmatter);
console.log(env.content);
console.log(env.excerpt);
`
- Type: GrayMatterOptions
- Details:
Options of gray-matter.
- Type: boolean
- Default: true
Render the excerpt with markdown-it or not.
This option will only take effects when grayMatterOptions.excerpt is enabled (disabled by default) or grayMatterOptions.excerpt_separator` is set (undefined by default).