A remark plugin for converting frontmatter metadata into MDX exports
npm install remark-mdx-frontmatter



A remark plugin for converting frontmatter metadata into MDX exports
- Installation
- Usage
- API
- Options
- Compatibility
- License
This package depends on the AST output by
remark-frontmatter
``sh`
npm install remark-frontmatter remark-mdx-frontmatter
This remark plugin takes frontmatter content, and outputs it as JavaScript exports. Both YAML and
TOML frontmatter data are supported.
For example, given a file named example.mdx with the following contents:
`mdx
---
hello: frontmatter
---
Rest of document
`
The following script:
`js
import { readFile } from 'node:fs/promises'
import { compile } from '@mdx-js/mdx'
import remarkFrontmatter from 'remark-frontmatter'
import remarkMdxFrontmatter from 'remark-mdx-frontmatter'
const { value } = await compile(await readFile('example.mdx'), {
jsx: true,
remarkPlugins: [remarkFrontmatter, remarkMdxFrontmatter]
})
console.log(value)
`
Roughly yields:
`jsx
export const frontmatter = {
hello: 'frontmatter'
}
export default function MDXContent() {
return
Rest of document
API
The default export is a remark plugin.
$3
-
default: The default value to export if no frontmatter data is found. (Default: undefined).
- name: The identifier name of the variable the frontmatter data is assigned to. (Default:
frontmatter).
- parsers: A mapping A mapping of node types to parsers. Each key represents a frontmatter node
type. The value is a function that accepts the frontmatter data as a string, and returns the
parsed data. By default yaml nodes will be parsed using yaml
and toml nodes using toml.In addition it supports
unist-util-mdx-define`This project is compatible with Node.js 18 or greater.