An function component which renders the MDX content using JSX.

• @param props This value is be available as the named variable props inside the MDX component.
• @returns A JSX element. The meaning of this may depend on the project configuration. I.e. it could be a React, Preact, or Vuex element.

Create an esbuild plugin to compile MDX to JS.

esbuild takes care of turning modern JavaScript features into syntax that works wherever you want it to. With other integrations you might need to use Babel for this, but with esbuild that’s not needed. See esbuild’s docs for more info.

• @param options Configuration (optional).
• @return Plugin.

This function invokes the "esbuild" command-line tool for you. It returns a promise that either resolves with a "BuildResult" object or rejects with a "BuildFailure" object.

• Works in node: yes
• Works in browser: yes

Documentation: https://esbuild.github.io/api/#build

Create an esbuild plugin to compile MDX to JS.

esbuild takes care of turning modern JavaScript features into syntax that works wherever you want it to. With other integrations you might need to use Babel for this, but with esbuild that’s not needed. See esbuild’s docs for more info.

• @param options Configuration (optional).
• @return Plugin.

Plugin to compile MDX w/ rollup.

• @param options Configuration (optional).
• @return Rollup plugin.

A Rollup plugin for seamless integration between Rollup and Babel.

• @param options - Plugin options.
• @returns Plugin instance.

• @type {RollupOptions}

Plugin to compile MDX w/ rollup.

• @param options Configuration (optional).
• @return Rollup plugin.

A Rollup plugin for seamless integration between Rollup and Babel.

• @param options - Plugin options.
• @returns Plugin instance.

An array of file extensions that Babel should transpile. If you want to transpile TypeScript files with this plugin it's essential to include .ts and .tsx in this option.

• @default ['.js', '.jsx', '.es6', '.es', '.mjs']

• @type {RollupOptions}

• @type {Configuration}

Options affecting the normal modules (NormalModuleFactory).

An array of rules applied for modules.

Shortcut for resource.test.

Modifiers applied to the module when rule is matched.

Loader name.

Loader options.

Loader name.

Loader options.

• @type {Configuration}

Plugin to compile MDX w/ rollup.

• @param options Configuration (optional).
• @return Rollup plugin.

Type helper to make it easier to use vite.config.ts accepts a direct {@link UserConfig } object, or a function that returns it. The function receives a {@link ConfigEnv } object.

Type helper to make it easier to use vite.config.ts accepts a direct {@link UserConfig } object, or a function that returns it. The function receives a {@link ConfigEnv } object.

Array of vite plugins to use.

Plugin to compile MDX w/ rollup.

• @param options Configuration (optional).
• @return Rollup plugin.

Synchronously compile MDX to JS.

When possible please use the async compile.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Compiled file.

Plugin that tells Babel to use a different parser.

Parser that handles MDX with @mdx-js/mdx and passes other things through to the normal Babel parser.

• @param value
• @param options
• @returns

Parser that handles MDX with @mdx-js/mdx and passes other things through to the normal Babel parser.

• @param value
• @param options
• @returns

• @param value

• @param options

• @type {string | undefined}

• @param options

Correlate output AST nodes with their source filename. Useful when generating code and source maps from the ASTs of multiple input files.

• @param options

• @type {string | undefined}

Returns a Boolean value that indicates whether or not a pattern exists in a searched string.

• @param string String on which to perform the search.

• @type {string | undefined}

Synchronously compile MDX to JS.

When possible please use the async compile.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Compiled file.

• @param options

Correlate output AST nodes with their source filename. Useful when generating code and source maps from the ASTs of multiple input files.

List of recma plugins (optional).

A “recma” plugin is a unified plugin that runs on the estree (used by @mdx-js/mdx and much of the JS ecosystem but not Babel). This plugin defines 'estree-to-babel' as the compiler, which means that the resulting Babel tree is given back by compileSync.

• @type {Plugin<[], Program, unknown>}

Custom, non-string, compiled, representation.

This is used by unified to store non-string results. One example is when turning markdown into React nodes.

• @type {unknown}

Parse the provided code as an entire ECMAScript program.

• @param value

• @param options

A “recma” plugin is a unified plugin that runs on the estree (used by @mdx-js/mdx and much of the JS ecosystem but not Babel). This plugin defines 'estree-to-babel' as the compiler, which means that the resulting Babel tree is given back by compileSync.

• @type {Plugin<[], Program, unknown>}

• @param tree
• @returns

• @param tree
• @returns

• @param tree

• @param tree

Plugin that tells Babel to use a different parser.

Transforms the passed in code. Calling a callback with an object with the generated code, source map, and AST.

Filename for use in errors etc

Default: "unknown"

List of plugins to load and use

Default: []

Plugin that tells Babel to use a different parser.

The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.

The module exports two specific components:

• A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
• A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.

Example using the global console:

console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr

Example using the Console class:

const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err

• @see source

Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout

See util.format() for more information.

• @since v0.1.100

Use MDX with Next.js

Use MDX with Next.js

A webpack rule test to match files to treat as MDX.

• @default /.mdx$/
• @example // Support both .md and .mdx files. /.mdx?$/

The options to pass to MDX.

• @see https://mdxjs.com/packages/mdx/#api

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Place to import automatic JSX runtimes from (default: 'react'); when in the automatic runtime, this is used to define an import for Fragment, jsx, jsxDEV, and jsxs.

This component can display text, and change its style to make it colorful, bold, underline, italic or strikethrough.

Mount a component and render the output.

An function component which renders the MDX content using JSX.

• @param props This value is be available as the named variable props inside the MDX component.
• @returns A JSX element. The meaning of this may depend on the project configuration. I.e. it could be a React, Preact, or Vuex element.

Mount a component and render the output.

An function component which renders the MDX content using JSX.

• @param props This value is be available as the named variable props inside the MDX component.
• @returns A JSX element. The meaning of this may depend on the project configuration. I.e. it could be a React, Preact, or Vuex element.

This prop may be used to customize how certain components are rendered.

This component can display text, and change its style to make it colorful, bold, underline, italic or strikethrough.

Make the text bold.

This component can display text, and change its style to make it colorful, bold, underline, italic or strikethrough.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Place to import automatic JSX runtimes from (default: 'react'); when in the automatic runtime, this is used to define an import for Fragment, jsx, jsxDEV, and jsxs.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Place to import automatic JSX runtimes from (default: 'react'); when in the automatic runtime, this is used to define an import for Fragment, jsx, jsxDEV, and jsxs.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Place to import automatic JSX runtimes from (default: 'react'); when in the automatic runtime, this is used to define an import for Fragment, jsx, jsxDEV, and jsxs.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Compile MDX to JS.

• @param vfileCompatible MDX document to parse.
• @param compileOptions Compile configuration (optional).
• @return Promise to compiled file.

Place to import automatic JSX runtimes from (default: 'react'); when in the automatic runtime, this is used to define an import for Fragment, jsx, jsxDEV, and jsxs.