next-mdx-remote
Version:
utilities for loading mdx from any remote source as data, rather than as a local import
11 lines (10 loc) • 591 B
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { VFileCompatible } from 'vfile';
import type { MDXRemoteSerializeResult, SerializeOptions } from './types.js';
/**
* Parses and compiles the provided MDX string. Returns a result which can be passed into <MDXRemote /> to be rendered.
*/
export declare function serialize<TScope = Record<string, unknown>, TFrontmatter = Record<string, unknown>>(source: VFileCompatible, { scope, mdxOptions, parseFrontmatter, }?: SerializeOptions, rsc?: boolean): Promise<MDXRemoteSerializeResult<TScope, TFrontmatter>>;