@mdxvac/vfile-astro

Astro-enhanced VFile type, typing the astro.frontmatter property.

Content

• What is this?
• When should I use this?
• Install
• Use
  • Options

What is this?

This package just declares an ambient module vfile-astro.

When should I use this?

If you are working with Unified/Vite/Markdown files that have been preprocessed by Astro and contain frontmatter, then this declaration will give you a typed experience.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

1npm install -D @mdxvac/vfile-astro

Use

1import type { VFile } from 'vfile-astro';
2
3...
4  file.data.astro.frontmatter[property] = value;