Validation

Usage

The file validation is based on Zod. When an invalid file is detected, it will throw an error immediately.

To customise the schemas, you have to install zod.

npm install zod

Now you can override or extend the default zod schemas by passing a validate options to the fromMap function.

Example

Extend the default frontmatter schema:

import { z } from 'zod'
 
const frontmatterSchema = defaultValidators.frontmatter.extend({
  preview: z.string().optional()
})
 
export default fromMap(map, {
  validate: {
    frontmatter: frontmatterSchema
  }
})

Typescript

Notice that the default type bindings of page and meta file won't be updated automatically, you should override it with declare.

declare module 'next-docs-mdx/types' {
  interface Frontmatter extends z.infer<typeof frontmatterSchema> {}
}