Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.25 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.25 KB

remark-meta

CI/CD Status MIT License stars

Remark plugin for making frontmatter metadata visible to other plugins.

This plugin requires remark-frontmatter. There are no visible changes to the output; this plugin is just to help other plugins by adding metadata to a VFile.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install remark-meta

Usage

import { unified } from 'unified'
import markdown from 'remark-parse'
import html from 'rehype-stringify'
import remark2rehype from 'remark-rehype'
import meta from 'remark-meta'

unified()
  .use(markdown)
  .use(meta)
  .use(remark2rehype)
  .use(html)

License

MIT © Alex Shaw