c3ef208282
## Description
This allow to type mdx option externaly
```js
/** @type {import('@next/mdx').NextMDXOptions} */
export const options = {}
```
## Bug
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)
## Feature
- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ]
[e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)
## Documentation / Examples
- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
33 lines
770 B
TypeScript
33 lines
770 B
TypeScript
/* eslint-disable */
|
|
import { NextConfig } from 'next'
|
|
import { CompileOptions } from '@mdx-js/mdx'
|
|
import { RuleSetConditionAbsolute } from 'webpack'
|
|
|
|
type WithMDX = (config: NextConfig) => NextConfig
|
|
|
|
export interface NextMDXOptions {
|
|
/**
|
|
* A webpack rule test to match files to treat as MDX.
|
|
*
|
|
* @default /\.mdx$/
|
|
* @example
|
|
* // Support both .md and .mdx files.
|
|
* /\.mdx?$/
|
|
*/
|
|
extension?: RuleSetConditionAbsolute
|
|
|
|
/**
|
|
* The options to pass to MDX.
|
|
*
|
|
* @see https://mdxjs.com/packages/mdx/#api
|
|
*/
|
|
options?: CompileOptions
|
|
}
|
|
|
|
/**
|
|
* Use [MDX](https://github.com/mdx-js/mdx) with [Next.js](https://github.com/vercel/next.js)
|
|
*/
|
|
declare function nextMDX(options?: NextMDXOptions): WithMDX
|
|
|
|
export = nextMDX
|
|
/* eslint=enable */
|